fd.c

   1 /*
   2  * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file fd.c Helper functions for file descriptor handling. */
   8
   9 #include <regex.h>
  10 #include <sys/types.h>
  11 #include <dirent.h>
  12 #include <sys/mman.h>
  13 #include <fcntl.h>
  14 #include <sys/uio.h>
  15
  16 #include "para.h"
  17 #include "error.h"
  18 #include "string.h"
  19 #include "fd.h"
  20
  21 /**
  22  * Write a buffer to a file descriptor, re-write on short writes.
  23  *
  24  * \param fd The file descriptor.
  25  * \param buf The buffer to be sent.
  26  * \param len The length of \a buf.
  27  *
  28  * \return Standard. In any case, the number of bytes that have been written is
  29  * stored in \a len.
  30  */
  31 int write_all(int fd, const char *buf, size_t *len)
  32 {
  33         size_t total = *len;
  34
  35         assert(total);
  36         *len = 0;
  37         while (*len < total) {
  38                 int ret = write(fd, buf + *len, total - *len);
  39                 if (ret == -1)
  40                         return -ERRNO_TO_PARA_ERROR(errno);
  41                 *len += ret;
  42         }
  43         return 1;
  44 }
  45
  46 /**
  47  * Write a buffer to a non-blocking file descriptor.
  48  *
  49  * \param fd The file descriptor.
  50  * \param buf the buffer to write.
  51  * \param len the number of bytes of \a buf.
  52  * \param max_bytes_per_write Do not write more than that many bytes at once.
  53  *
  54  * If \a max_bytes_per_write is non-zero, do not send more than that many bytes
  55  * per write().
  56  *
  57  * EAGAIN is not considered an error condition.  For example CCID3 has a
  58  * sending wait queue which fills up and is emptied asynchronously. The EAGAIN
  59  * case means that there is currently no space in the wait queue, but this can
  60  * change at any moment.
  61  *
  62  * \return Negative on errors, number of bytes written else.
  63  */
  64 int write_nonblock(int fd, const char *buf, size_t len,
  65                 size_t max_bytes_per_write)
  66 {
  67         size_t written = 0;
  68         int ret = 0;
  69
  70         while (written < len) {
  71                 size_t num = len - written;
  72
  73                 if (max_bytes_per_write && max_bytes_per_write < num)
  74                         num = max_bytes_per_write;
  75                 ret = write(fd, buf + written, num);
  76                 if (ret < 0 && errno == EAGAIN)
  77                         return written;
  78                 if (ret < 0)
  79                         return -ERRNO_TO_PARA_ERROR(errno);
  80                 written += ret;
  81         }
  82         return written;
  83 }
  84
  85 /**
  86  * Read from a non-blocking file descriptor into multiple buffers.
  87  *
  88  * \param fd The file descriptor to read from.
  89  * \param iov Scatter/gather array used in readv().
  90  * \param iovcnt Number of elements in \a iov.
  91  * \param rfds An optional fd set pointer.
  92  * \param num_bytes Result pointer. Contains the number of bytes read from \a fd.
  93  *
  94  * If \a rfds is not \p NULL and the (non-blocking) file descriptor \a fd is
  95  * not set in \a rfds, this function returns early without doing anything.
  96  * Otherwise The function tries to read up to \a sz bytes from \a fd. As for
  97  * write_nonblock(), EAGAIN is not considered an error condition. However, EOF
  98  * is.
  99  *
 100  * \return Zero or a negative error code. If the underlying call to readv(2)
 101  * returned zero (indicating an end of file condition) or failed for some
 102  * reason other than \p EAGAIN, a negative return value is returned.
 103  *
 104  * In any case, \a num_bytes contains the number of bytes that have been
 105  * successfully read from \a fd (zero if the first readv() call failed with
 106  * EAGAIN). Note that even if the function returns negative, some data might
 107  * have been read before the error occured. In this case \a num_bytes is
 108  * positive.
 109  *
 110  * \sa \ref write_nonblock(), read(2), readv(2).
 111  */
 112 int readv_nonblock(int fd, struct iovec *iov, int iovcnt, fd_set *rfds,
 113                 size_t *num_bytes)
 114 {
 115         int ret, i, j;
 116
 117         *num_bytes = 0;
 118         /*
 119          * Avoid a shortcoming of select(): Reads from a non-blocking fd might
 120          * return EAGAIN even if FD_ISSET() returns true. However, FD_ISSET()
 121          * returning false definitely means that no data can currently be read.
 122          * This is the common case, so it is worth to avoid the overhead of the
 123          * read() system call in this case.
 124          */
 125         if (rfds && !FD_ISSET(fd, rfds))
 126                 return 0;
 127
 128         for (i = 0, j = 0; i < iovcnt;) {
 129
 130                 /* fix up the first iov */
 131                 assert(j < iov[i].iov_len);
 132                 iov[i].iov_base += j;
 133                 iov[i].iov_len -= j;
 134                 ret = readv(fd, iov + i, iovcnt - i);
 135                 iov[i].iov_base -= j;
 136                 iov[i].iov_len += j;
 137
 138                 if (ret == 0)
 139                         return -E_EOF;
 140                 if (ret < 0) {
 141                         if (errno == EAGAIN)
 142                                 return 0;
 143                         return -ERRNO_TO_PARA_ERROR(errno);
 144                 }
 145                 *num_bytes += ret;
 146                 while (ret > 0) {
 147                         if (ret < iov[i].iov_len - j) {
 148                                 j += ret;
 149                                 break;
 150                         }
 151                         ret -= iov[i].iov_len - j;
 152                         j = 0;
 153                         if (++i >= iovcnt)
 154                                 break;
 155                 }
 156         }
 157         return 0;
 158 }
 159
 160 /**
 161  * Read from a non-blocking file descriptor into a single buffer.
 162  *
 163  * \param fd The file descriptor to read from.
 164  * \param buf The buffer to read data to.
 165  * \param sz The size of \a buf.
 166  * \param rfds \see \ref readv_nonblock().
 167  * \param num_bytes \see \ref readv_nonblock().
 168  *
 169  * This is a simple wrapper for readv_nonblock() which uses an iovec with a single
 170  * buffer.
 171  *
 172  * \return The return value of the underlying call to readv_nonblock().
 173  */
 174 int read_nonblock(int fd, void *buf, size_t sz, fd_set *rfds, size_t *num_bytes)
 175 {
 176         struct iovec iov = {.iov_base = buf, .iov_len = sz};
 177         return readv_nonblock(fd, &iov, 1, rfds, num_bytes);
 178 }
 179
 180 /**
 181  * Check whether a file exists.
 182  *
 183  * \param fn The file name.
 184  *
 185  * \return Non-zero iff file exists.
 186  */
 187 int file_exists(const char *fn)
 188 {
 189         struct stat statbuf;
 190
 191         return !stat(fn, &statbuf);
 192 }
 193
 194 /**
 195  * Paraslash's wrapper for select(2).
 196  *
 197  * It calls select(2) (with no exceptfds) and starts over if select() was
 198  * interrupted by a signal.
 199  *
 200  * \param n The highest-numbered descriptor in any of the two sets, plus 1.
 201  * \param readfds fds that should be checked for readability.
 202  * \param writefds fds that should be checked for writablility.
 203  * \param timeout_tv upper bound on the amount of time elapsed before select()
 204  * returns.
 205  *
 206  * \return The return value of the underlying select() call on success, the
 207  * negative system error code on errors.
 208  *
 209  * All arguments are passed verbatim to select(2).
 210  * \sa select(2) select_tut(2).
 211  */
 212 int para_select(int n, fd_set *readfds, fd_set *writefds,
 213                 struct timeval *timeout_tv)
 214 {
 215         int ret;
 216         do
 217                 ret = select(n, readfds, writefds, NULL, timeout_tv);
 218         while (ret < 0 && errno == EINTR);
 219         if (ret < 0)
 220                 return -ERRNO_TO_PARA_ERROR(errno);
 221         return ret;
 222 }
 223
 224 /**
 225  * Set a file descriptor to blocking mode.
 226  *
 227  * \param fd The file descriptor.
 228  *
 229  * \return Standard.
 230  */
 231 __must_check int mark_fd_blocking(int fd)
 232 {
 233         int flags = fcntl(fd, F_GETFL);
 234         if (flags < 0)
 235                 return -ERRNO_TO_PARA_ERROR(errno);
 236         flags = fcntl(fd, F_SETFL, ((long)flags) & ~O_NONBLOCK);
 237         if (flags < 0)
 238                 return -ERRNO_TO_PARA_ERROR(errno);
 239         return 1;
 240 }
 241
 242 /**
 243  * Set a file descriptor to non-blocking mode.
 244  *
 245  * \param fd The file descriptor.
 246  *
 247  * \return Standard.
 248  */
 249 __must_check int mark_fd_nonblocking(int fd)
 250 {
 251         int flags = fcntl(fd, F_GETFL);
 252         if (flags < 0)
 253                 return -ERRNO_TO_PARA_ERROR(errno);
 254         flags = fcntl(fd, F_SETFL, ((long)flags) | O_NONBLOCK);
 255         if (flags < 0)
 256                 return -ERRNO_TO_PARA_ERROR(errno);
 257         return 1;
 258 }
 259
 260 /**
 261  * Set a file descriptor in a fd_set.
 262  *
 263  * \param fd The file descriptor to be set.
 264  * \param fds The file descriptor set.
 265  * \param max_fileno Highest-numbered file descriptor.
 266  *
 267  * This wrapper for FD_SET() passes its first two arguments to \p FD_SET. Upon
 268  * return, \a max_fileno contains the maximum of the old_value and \a fd.
 269  *
 270  * \sa para_select.
 271 */
 272 void para_fd_set(int fd, fd_set *fds, int *max_fileno)
 273 {
 274         assert(fd >= 0 && fd < FD_SETSIZE);
 275 #if 0
 276         {
 277                 int flags = fcntl(fd, F_GETFL);
 278                 if (!(flags & O_NONBLOCK)) {
 279                         PARA_EMERG_LOG("fd %d is a blocking file descriptor\n", fd);
 280                         exit(EXIT_FAILURE);
 281                 }
 282         }
 283 #endif
 284         FD_SET(fd, fds);
 285         *max_fileno = PARA_MAX(*max_fileno, fd);
 286 }
 287
 288 /**
 289  * Paraslash's wrapper for fgets(3).
 290  *
 291  * \param line Pointer to the buffer to store the line.
 292  * \param size The size of the buffer given by \a line.
 293  * \param f The stream to read from.
 294  *
 295  * \return Unlike the standard fgets() function, an integer value
 296  * is returned. On success, this function returns 1. On errors, -E_FGETS
 297  * is returned. A zero return value indicates an end of file condition.
 298  */
 299 __must_check int para_fgets(char *line, int size, FILE *f)
 300 {
 301 again:
 302         if (fgets(line, size, f))
 303                 return 1;
 304         if (feof(f))
 305                 return 0;
 306         if (!ferror(f))
 307                 return -E_FGETS;
 308         if (errno != EINTR) {
 309                 PARA_ERROR_LOG("%s\n", strerror(errno));
 310                 return -E_FGETS;
 311         }
 312         clearerr(f);
 313         goto again;
 314 }
 315
 316 /**
 317  * Paraslash's wrapper for mmap.
 318  *
 319  * \param length Number of bytes to mmap.
 320  * \param prot Either PROT_NONE or the bitwise OR of one or more of
 321  * PROT_EXEC PROT_READ PROT_WRITE.
 322  * \param flags Exactly one of MAP_SHARED and MAP_PRIVATE.
 323  * \param fd The file to mmap from.
 324  * \param offset Mmap start.
 325  * \param map Result pointer.
 326  *
 327  * \return Standard.
 328  *
 329  * \sa mmap(2).
 330  */
 331 int para_mmap(size_t length, int prot, int flags, int fd, off_t offset,
 332                 void *map)
 333 {
 334         void **m = map;
 335
 336         errno = EINVAL;
 337         if (!length)
 338                 goto err;
 339         *m = mmap(NULL, length, prot, flags, fd, offset);
 340         if (*m != MAP_FAILED)
 341                 return 1;
 342 err:
 343         *m = NULL;
 344         return -ERRNO_TO_PARA_ERROR(errno);
 345 }
 346
 347 /**
 348  * Wrapper for the open(2) system call.
 349  *
 350  * \param path The filename.
 351  * \param flags The usual open(2) flags.
 352  * \param mode Specifies the permissions to use.
 353  *
 354  * The mode parameter must be specified when O_CREAT is in the flags, and is
 355  * ignored otherwise.
 356  *
 357  * \return The file descriptor on success, negative on errors.
 358  *
 359  * \sa open(2).
 360  */
 361 int para_open(const char *path, int flags, mode_t mode)
 362 {
 363         int ret = open(path, flags, mode);
 364
 365         if (ret >= 0)
 366                 return ret;
 367         return -ERRNO_TO_PARA_ERROR(errno);
 368 }
 369
 370 /**
 371  * Wrapper for chdir(2).
 372  *
 373  * \param path The specified directory.
 374  *
 375  * \return Standard.
 376  */
 377 int para_chdir(const char *path)
 378 {
 379         int ret = chdir(path);
 380
 381         if (ret >= 0)
 382                 return 1;
 383         return -ERRNO_TO_PARA_ERROR(errno);
 384 }
 385
 386 /**
 387  * Save the cwd and open a given directory.
 388  *
 389  * \param dirname Path to the directory to open.
 390  * \param dir Result pointer.
 391  * \param cwd File descriptor of the current working directory.
 392  *
 393  * \return Standard.
 394  *
 395  * Opening the current directory (".") and calling fchdir() to return is
 396  * usually faster and more reliable than saving cwd in some buffer and calling
 397  * chdir() afterwards.
 398  *
 399  * If \a cwd is not \p NULL "." is opened and the resulting file descriptor is
 400  * stored in \a cwd. If the function returns success, and \a cwd is not \p
 401  * NULL, the caller must close this file descriptor (probably after calling
 402  * fchdir(*cwd)).
 403  *
 404  * On errors, the function undos everything, so the caller needs neither close
 405  * any files, nor change back to the original working directory.
 406  *
 407  * \sa getcwd(3).
 408  *
 409  */
 410 int para_opendir(const char *dirname, DIR **dir, int *cwd)
 411 {
 412         int ret;
 413
 414         if (cwd) {
 415                 ret = para_open(".", O_RDONLY, 0);
 416                 if (ret < 0)
 417                         return ret;
 418                 *cwd = ret;
 419         }
 420         ret = para_chdir(dirname);
 421         if (ret < 0)
 422                 goto close_cwd;
 423         *dir = opendir(".");
 424         if (*dir)
 425                 return 1;
 426         ret = -ERRNO_TO_PARA_ERROR(errno);
 427         /* Ignore return value of fchdir() and close(). We're busted anyway. */
 428         if (cwd) {
 429                 int __a_unused ret2 = fchdir(*cwd); /* STFU, gcc */
 430         }
 431 close_cwd:
 432         if (cwd)
 433                 close(*cwd);
 434         return ret;
 435 }
 436
 437 /**
 438  * A wrapper for fchdir().
 439  *
 440  * \param fd An open file descriptor.
 441  *
 442  * \return Standard.
 443  */
 444 int para_fchdir(int fd)
 445 {
 446         if (fchdir(fd) < 0)
 447                 return -ERRNO_TO_PARA_ERROR(errno);
 448         return 1;
 449 }
 450
 451 /**
 452  * A wrapper for mkdir(2).
 453  *
 454  * \param path Name of the directory to create.
 455  * \param mode The permissions to use.
 456  *
 457  * \return Standard.
 458  */
 459 int para_mkdir(const char *path, mode_t mode)
 460 {
 461         if (!mkdir(path, mode))
 462                 return 1;
 463         return -ERRNO_TO_PARA_ERROR(errno);
 464 }
 465
 466 /**
 467  * Open a file and map it into memory.
 468  *
 469  * \param path Name of the regular file to map.
 470  * \param open_mode Either \p O_RDONLY or \p O_RDWR.
 471  * \param map On success, the mapping is returned here.
 472  * \param size size of the mapping.
 473  * \param fd_ptr The file descriptor of the mapping.
 474  *
 475  * If \a fd_ptr is \p NULL, the file descriptor resulting from the underlying
 476  * open call is closed after mmap().  Otherwise the file is kept open and the
 477  * file descriptor is returned in \a fd_ptr.
 478  *
 479  * \return Standard.
 480  *
 481  * \sa para_open(), mmap(2).
 482  */
 483 int mmap_full_file(const char *path, int open_mode, void **map,
 484                 size_t *size, int *fd_ptr)
 485 {
 486         int fd, ret, mmap_prot, mmap_flags;
 487         struct stat file_status;
 488
 489         if (open_mode == O_RDONLY) {
 490                 mmap_prot = PROT_READ;
 491                 mmap_flags = MAP_PRIVATE;
 492         } else {
 493                 mmap_prot = PROT_READ | PROT_WRITE;
 494                 mmap_flags = MAP_SHARED;
 495         }
 496         ret = para_open(path, open_mode, 0);
 497         if (ret < 0)
 498                 return ret;
 499         fd = ret;
 500         if (fstat(fd, &file_status) < 0) {
 501                 ret = -ERRNO_TO_PARA_ERROR(errno);
 502                 goto out;
 503         }
 504         *size = file_status.st_size;
 505         ret = para_mmap(*size, mmap_prot, mmap_flags, fd, 0, map);
 506 out:
 507         if (ret < 0 || !fd_ptr)
 508                 close(fd);
 509         else
 510                 *fd_ptr = fd;
 511         return ret;
 512 }
 513
 514 /**
 515  * A wrapper for munmap(2).
 516  *
 517  * \param start The start address of the memory mapping.
 518  * \param length The size of the mapping.
 519  *
 520  * \return Standard.
 521  *
 522  * \sa munmap(2), mmap_full_file().
 523  */
 524 int para_munmap(void *start, size_t length)
 525 {
 526         int err;
 527         if (munmap(start, length) >= 0)
 528                 return 1;
 529         err = errno;
 530         PARA_ERROR_LOG("munmap (%p/%zu) failed: %s\n", start, length,
 531                 strerror(err));
 532         return -ERRNO_TO_PARA_ERROR(err);
 533 }
 534
 535 /**
 536  * Check a file descriptor for writability.
 537  *
 538  * \param fd The file descriptor.
 539  *
 540  * \return positive if fd is ready for writing, zero if it isn't, negative if
 541  * an error occurred.
 542  */
 543
 544 int write_ok(int fd)
 545 {
 546         struct timeval tv;
 547         fd_set wfds;
 548
 549         FD_ZERO(&wfds);
 550         FD_SET(fd, &wfds);
 551         tv.tv_sec = 0;
 552         tv.tv_usec = 0;
 553         return para_select(fd + 1, NULL, &wfds, &tv);
 554 }
 555
 556 /**
 557  * Ensure that file descriptors 0, 1, and 2 are valid.
 558  *
 559  * Common approach that opens /dev/null until it gets a file descriptor greater
 560  * than two.
 561  *
 562  * \sa okir's Black Hats Manual.
 563  */
 564 void valid_fd_012(void)
 565 {
 566         while (1) {
 567                 int fd = open("/dev/null", O_RDWR);
 568                 if (fd < 0)
 569                         exit(EXIT_FAILURE);
 570                 if (fd > 2) {
 571                         close(fd);
 572                         break;
 573                 }
 574         }
 575 }
 576
 577 /**
 578  * Traverse the given directory recursively.
 579  *
 580  * \param dirname The directory to traverse.
 581  * \param func The function to call for each entry.
 582  * \param private_data Pointer to an arbitrary data structure.
 583  *
 584  * For each regular file under \a dirname, the supplied function \a func is
 585  * called.  The full path of the regular file and the \a private_data pointer
 586  * are passed to \a func. Directories for which the calling process has no
 587  * permissions to change to are silently ignored.
 588  *
 589  * \return Standard.
 590  */
 591 int for_each_file_in_dir(const char *dirname,
 592                 int (*func)(const char *, void *), void *private_data)
 593 {
 594         DIR *dir;
 595         struct dirent *entry;
 596         int cwd_fd, ret2, ret = para_opendir(dirname, &dir, &cwd_fd);
 597
 598         if (ret < 0)
 599                 return ret == -ERRNO_TO_PARA_ERROR(EACCES)? 1 : ret;
 600         /* scan cwd recursively */
 601         while ((entry = readdir(dir))) {
 602                 mode_t m;
 603                 char *tmp;
 604                 struct stat s;
 605
 606                 if (!strcmp(entry->d_name, "."))
 607                         continue;
 608                 if (!strcmp(entry->d_name, ".."))
 609                         continue;
 610                 if (lstat(entry->d_name, &s) == -1)
 611                         continue;
 612                 m = s.st_mode;
 613                 if (!S_ISREG(m) && !S_ISDIR(m))
 614                         continue;
 615                 tmp = make_message("%s/%s", dirname, entry->d_name);
 616                 if (!S_ISDIR(m)) {
 617                         ret = func(tmp, private_data);
 618                         free(tmp);
 619                         if (ret < 0)
 620                                 goto out;
 621                         continue;
 622                 }
 623                 /* directory */
 624                 ret = for_each_file_in_dir(tmp, func, private_data);
 625                 free(tmp);
 626                 if (ret < 0)
 627                         goto out;
 628         }
 629         ret = 1;
 630 out:
 631         closedir(dir);
 632         ret2 = para_fchdir(cwd_fd);
 633         if (ret2 < 0 && ret >= 0)
 634                 ret = ret2;
 635         close(cwd_fd);
 636         return ret;
 637 }