fd.c

   1 /* Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 /** \file fd.c Helper functions for file descriptor handling. */
   4
   5 #include <regex.h>
   6 #include <sys/types.h>
   7 #include <dirent.h>
   8 #include <sys/mman.h>
   9
  10 #include "para.h"
  11 #include "error.h"
  12 #include "string.h"
  13 #include "fd.h"
  14
  15 /**
  16  * Change the name or location of a file.
  17  *
  18  * \param oldpath File to be moved.
  19  * \param newpath Destination.
  20  *
  21  * This is just a simple wrapper for the rename(2) system call which returns a
  22  * paraslash error code and prints an error message on failure.
  23  *
  24  * \return Standard.
  25  *
  26  * \sa rename(2).
  27  */
  28 int xrename(const char *oldpath, const char *newpath)
  29 {
  30         int ret = rename(oldpath, newpath);
  31
  32         if (ret >= 0)
  33                 return 1;
  34         ret = -ERRNO_TO_PARA_ERROR(errno);
  35         PARA_ERROR_LOG("failed to rename %s -> %s\n", oldpath, newpath);
  36         return ret;
  37 }
  38
  39 /**
  40  * Write an array of buffers, handling non-fatal errors.
  41  *
  42  * \param fd The file descriptor to write to.
  43  * \param iov Pointer to one or more buffers.
  44  * \param iovcnt The number of buffers.
  45  *
  46  * EAGAIN, EWOULDBLOCK and EINTR are not considered error conditions. If a
  47  * write operation fails with EAGAIN or EWOULDBLOCK, the number of bytes that
  48  * have been written so far is returned. In the EINTR case the operation is
  49  * retried. Short writes are handled by issuing a subsequent write operation
  50  * for the remaining part.
  51  *
  52  * \return Negative on fatal errors, number of bytes written else.
  53  *
  54  * For blocking file descriptors, this function returns either the sum of all
  55  * buffer sizes or a negative error code which indicates the fatal error that
  56  * caused a write call to fail.
  57  *
  58  * For nonblocking file descriptors there is a third possibility: Any
  59  * non-negative return value less than the sum of the buffer sizes indicates
  60  * that a write operation returned EAGAIN/EWOULDBLOCK.
  61  *
  62  * \sa writev(2), \ref xwrite().
  63  */
  64 int xwritev(int fd, struct iovec *iov, int iovcnt)
  65 {
  66         size_t written = 0;
  67         int i;
  68         struct iovec saved_iov, *curiov;
  69
  70         i = 0;
  71         curiov = iov;
  72         saved_iov = *curiov;
  73         while (i < iovcnt && curiov->iov_len > 0) {
  74                 ssize_t ret = writev(fd, curiov, iovcnt - i);
  75                 if (ret >= 0) {
  76                         written += ret;
  77                         while (ret > 0) {
  78                                 if (ret < curiov->iov_len) {
  79                                         curiov->iov_base += ret;
  80                                         curiov->iov_len -= ret;
  81                                         break;
  82                                 }
  83                                 ret -= curiov->iov_len;
  84                                 *curiov = saved_iov;
  85                                 i++;
  86                                 if (i >= iovcnt)
  87                                         return written;
  88                                 curiov++;
  89                                 saved_iov = *curiov;
  90                         }
  91                         continue;
  92                 }
  93                 if (errno == EINTR)
  94                         /*
  95                          * The write() call was interrupted by a signal before
  96                          * any data was written. Try again.
  97                          */
  98                         continue;
  99                 if (errno == EAGAIN || errno == EWOULDBLOCK)
 100                         /*
 101                          * We don't consider this an error. Note that POSIX
 102                          * allows either error to be returned, and does not
 103                          * require these constants to have the same value.
 104                          */
 105                         return written;
 106                 /* fatal error */
 107                 return -ERRNO_TO_PARA_ERROR(errno);
 108         }
 109         return written;
 110 }
 111
 112 /**
 113  * Write a buffer to a file descriptor, re-writing on short writes.
 114  *
 115  * \param fd The file descriptor.
 116  * \param buf The buffer to write.
 117  * \param len The number of bytes to write.
 118  *
 119  * This is a simple wrapper for \ref xwritev().
 120  *
 121  * \return The return value of the underlying call to \ref xwritev().
 122  */
 123 int xwrite(int fd, const char *buf, size_t len)
 124 {
 125         struct iovec iov = {.iov_base = (void *)buf, .iov_len = len};
 126         return xwritev(fd, &iov, 1);
 127 }
 128
 129 /**
 130  * Write to a file descriptor, fail on short writes.
 131  *
 132  * \param fd The file descriptor.
 133  * \param buf The buffer to be written.
 134  * \param len The length of the buffer.
 135  *
 136  * For blocking file descriptors this function behaves identical to \ref
 137  * xwrite(). For non-blocking file descriptors it returns -E_SHORT_WRITE
 138  * (rather than a value less than len) if not all data could be written.
 139  *
 140  * \return Number of bytes written on success, negative error code else.
 141  */
 142 int write_all(int fd, const char *buf, size_t len)
 143 {
 144         int ret = xwrite(fd, buf, len);
 145
 146         if (ret < 0)
 147                 return ret;
 148         if (ret != len)
 149                 return -E_SHORT_WRITE;
 150         return ret;
 151 }
 152
 153 /**
 154  * A fprintf-like function for raw file descriptors.
 155  *
 156  * This function creates a string buffer according to the given format and
 157  * writes this buffer to a file descriptor.
 158  *
 159  * \param fd The file descriptor.
 160  * \param fmt A format string.
 161  *
 162  * The difference to fprintf(3) is that the first argument is a file
 163  * descriptor, not a FILE pointer. This function does not rely on stdio.
 164  *
 165  * \return The return value of the underlying call to \ref write_all().
 166  *
 167  * \sa fprintf(3), \ref xvasprintf().
 168  */
 169 __printf_2_3 int write_va_buffer(int fd, const char *fmt, ...)
 170 {
 171         char *msg;
 172         int ret;
 173         va_list ap;
 174
 175         va_start(ap, fmt);
 176         ret = xvasprintf(&msg, fmt, ap);
 177         va_end(ap);
 178         ret = write_all(fd, msg, ret);
 179         free(msg);
 180         return ret;
 181 }
 182
 183 /**
 184  * Read from a non-blocking file descriptor into multiple buffers.
 185  *
 186  * \param fd The file descriptor to read from.
 187  * \param iov Scatter/gather array used in readv().
 188  * \param iovcnt Number of elements in \a iov.
 189  * \param num_bytes Result pointer. Contains the number of bytes read from \a fd.
 190  *
 191  * This function tries to read up to sz bytes from fd, where sz is the sum of
 192  * the lengths of all vectors in iov. Like \ref xwrite(), EAGAIN and EINTR are
 193  * not considered error conditions. However, EOF is.
 194  *
 195  * \return Zero or a negative error code. If the underlying call to readv(2)
 196  * returned zero (indicating an end of file condition) or failed for some
 197  * reason other than EAGAIN or EINTR, a negative error code is returned.
 198  *
 199  * In any case, \a num_bytes contains the number of bytes that have been
 200  * successfully read from \a fd (zero if the first readv() call failed with
 201  * EAGAIN). Note that even if the function returns negative, some data might
 202  * have been read before the error occurred. In this case \a num_bytes is
 203  * positive.
 204  *
 205  * \sa \ref xwrite(), read(2), readv(2).
 206  */
 207 int readv_nonblock(int fd, struct iovec *iov, int iovcnt, size_t *num_bytes)
 208 {
 209         int ret, i, j;
 210
 211         *num_bytes = 0;
 212         for (i = 0, j = 0; i < iovcnt;) {
 213                 /* fix up the first iov */
 214                 assert(j < iov[i].iov_len);
 215                 iov[i].iov_base += j;
 216                 iov[i].iov_len -= j;
 217                 ret = readv(fd, iov + i, iovcnt - i);
 218                 iov[i].iov_base -= j;
 219                 iov[i].iov_len += j;
 220
 221                 if (ret == 0)
 222                         return -E_EOF;
 223                 if (ret < 0) {
 224                         if (errno == EAGAIN || errno == EINTR)
 225                                 return 0;
 226                         return -ERRNO_TO_PARA_ERROR(errno);
 227                 }
 228                 *num_bytes += ret;
 229                 while (ret > 0) {
 230                         if (ret < iov[i].iov_len - j) {
 231                                 j += ret;
 232                                 break;
 233                         }
 234                         ret -= iov[i].iov_len - j;
 235                         j = 0;
 236                         if (++i >= iovcnt)
 237                                 break;
 238                 }
 239         }
 240         return 0;
 241 }
 242
 243 /**
 244  * Read from a non-blocking file descriptor into a single buffer.
 245  *
 246  * \param fd The file descriptor to read from.
 247  * \param buf The buffer to read data to.
 248  * \param sz The size of \a buf.
 249  * \param num_bytes \see \ref readv_nonblock().
 250  *
 251  * This is a simple wrapper for readv_nonblock() which uses an iovec with a single
 252  * buffer.
 253  *
 254  * \return The return value of the underlying call to readv_nonblock().
 255  */
 256 int read_nonblock(int fd, void *buf, size_t sz, size_t *num_bytes)
 257 {
 258         struct iovec iov = {.iov_base = buf, .iov_len = sz};
 259         return readv_nonblock(fd, &iov, 1, num_bytes);
 260 }
 261
 262 /**
 263  * Read a buffer and compare its contents to a string, ignoring case.
 264  *
 265  * \param fd The file descriptor to read from.
 266  * \param expectation The expected string to compare to.
 267  *
 268  * The given file descriptor is expected to be in non-blocking mode. The string
 269  * comparison is performed using strncasecmp(3).
 270  *
 271  * \return Zero if no data was available, positive if a buffer was read whose
 272  * contents compare as equal to the expected string, negative otherwise.
 273  * Possible errors: (a) not enough data was read, (b) the buffer contents
 274  * compared as non-equal, (c) a read error occurred. In the first two cases,
 275  * -E_READ_PATTERN is returned. In the read error case the (negative) return
 276  * value of the underlying call to \ref read_nonblock() is returned.
 277  */
 278 int read_and_compare(int fd, const char *expectation)
 279 {
 280         size_t n, len = strlen(expectation);
 281         char *buf = alloc(len + 1);
 282         int ret = read_nonblock(fd, buf, len, &n);
 283
 284         if (ret < 0)
 285                 goto out;
 286         buf[n] = '\0';
 287         ret = 0;
 288         if (n == 0)
 289                 goto out;
 290         ret = -E_READ_PATTERN;
 291         if (n < len)
 292                 goto out;
 293         if (strncasecmp(buf, expectation, len) != 0)
 294                 goto out;
 295         ret = 1;
 296 out:
 297         free(buf);
 298         return ret;
 299 }
 300
 301 /**
 302  * Set a file descriptor to blocking mode.
 303  *
 304  * \param fd The file descriptor.
 305  *
 306  * \return Standard.
 307  */
 308 __must_check int mark_fd_blocking(int fd)
 309 {
 310         int flags = fcntl(fd, F_GETFL);
 311         if (flags < 0)
 312                 return -ERRNO_TO_PARA_ERROR(errno);
 313         flags = fcntl(fd, F_SETFL, ((long)flags) & ~O_NONBLOCK);
 314         if (flags < 0)
 315                 return -ERRNO_TO_PARA_ERROR(errno);
 316         return 1;
 317 }
 318
 319 /**
 320  * Set a file descriptor to non-blocking mode.
 321  *
 322  * \param fd The file descriptor.
 323  *
 324  * \return Standard.
 325  */
 326 __must_check int mark_fd_nonblocking(int fd)
 327 {
 328         int flags = fcntl(fd, F_GETFL);
 329         if (flags < 0)
 330                 return -ERRNO_TO_PARA_ERROR(errno);
 331         flags = fcntl(fd, F_SETFL, ((long)flags) | O_NONBLOCK);
 332         if (flags < 0)
 333                 return -ERRNO_TO_PARA_ERROR(errno);
 334         return 1;
 335 }
 336
 337 /**
 338  * Paraslash's wrapper for mmap.
 339  *
 340  * \param length Number of bytes to mmap.
 341  * \param prot Either PROT_NONE or the bitwise OR of one or more of
 342  * PROT_EXEC PROT_READ PROT_WRITE.
 343  * \param flags Exactly one of MAP_SHARED and MAP_PRIVATE.
 344  * \param fd The file to mmap from.
 345  * \param map Result pointer.
 346  *
 347  * \return Standard.
 348  *
 349  * \sa mmap(2).
 350  */
 351 int para_mmap(size_t length, int prot, int flags, int fd, void *map)
 352 {
 353         void **m = map;
 354
 355         errno = EINVAL;
 356         if (!length)
 357                 goto err;
 358         *m = mmap(NULL, length, prot, flags, fd, (off_t)0);
 359         if (*m != MAP_FAILED)
 360                 return 1;
 361 err:
 362         *m = NULL;
 363         return -ERRNO_TO_PARA_ERROR(errno);
 364 }
 365
 366 /**
 367  * Wrapper for the open(2) system call.
 368  *
 369  * \param path The filename.
 370  * \param flags The usual open(2) flags.
 371  * \param mode Specifies the permissions to use.
 372  *
 373  * The mode parameter must be specified when O_CREAT is in the flags, and is
 374  * ignored otherwise.
 375  *
 376  * \return The file descriptor on success, negative on errors.
 377  *
 378  * \sa open(2).
 379  */
 380 int para_open(const char *path, int flags, mode_t mode)
 381 {
 382         int ret = open(path, flags, mode);
 383
 384         if (ret >= 0)
 385                 return ret;
 386         return -ERRNO_TO_PARA_ERROR(errno);
 387 }
 388
 389 /**
 390  * Save the cwd and open a given directory.
 391  *
 392  * \param dirname Path to the directory to open.
 393  * \param dir Result pointer.
 394  * \param cwd File descriptor of the current working directory.
 395  *
 396  * \return Standard.
 397  *
 398  * Opening the current directory (".") and calling fchdir() to return is
 399  * usually faster and more reliable than saving cwd in some buffer and calling
 400  * chdir() afterwards.
 401  *
 402  * If \a cwd is not \p NULL "." is opened and the resulting file descriptor is
 403  * stored in \a cwd. If the function returns success, and \a cwd is not \p
 404  * NULL, the caller must close this file descriptor (probably after calling
 405  * fchdir(*cwd)).
 406  *
 407  * On errors, the function undos everything, so the caller needs neither close
 408  * any files, nor change back to the original working directory.
 409  *
 410  * \sa getcwd(3).
 411  *
 412  */
 413 static int para_opendir(const char *dirname, DIR **dir, int *cwd)
 414 {
 415         int ret;
 416
 417         *dir = NULL;
 418         if (cwd) {
 419                 ret = para_open(".", O_RDONLY, 0);
 420                 if (ret < 0)
 421                         return ret;
 422                 *cwd = ret;
 423         }
 424         if (chdir(dirname) != 0) {
 425                 ret = -ERRNO_TO_PARA_ERROR(errno);
 426                 goto close_cwd;
 427         }
 428         *dir = opendir(".");
 429         if (*dir)
 430                 return 1;
 431         ret = -ERRNO_TO_PARA_ERROR(errno);
 432         /* Ignore return value of fchdir() and close(). We're busted anyway. */
 433         if (cwd) {
 434                 int __a_unused ret2 = fchdir(*cwd); /* STFU, gcc */
 435         }
 436 close_cwd:
 437         if (cwd)
 438                 close(*cwd);
 439         return ret;
 440 }
 441
 442 /**
 443  * A wrapper for mkdir(2).
 444  *
 445  * \param path Name of the directory to create.
 446  * \param mode The permissions to use.
 447  *
 448  * \return Standard.
 449  */
 450 int para_mkdir(const char *path, mode_t mode)
 451 {
 452         if (!mkdir(path, mode))
 453                 return 1;
 454         return -ERRNO_TO_PARA_ERROR(errno);
 455 }
 456
 457 /**
 458  * Open a file and map it into memory.
 459  *
 460  * \param path Name of the regular file to map.
 461  * \param open_mode Either \p O_RDONLY or \p O_RDWR.
 462  * \param map On success, the mapping is returned here.
 463  * \param size size of the mapping.
 464  * \param fd_ptr The file descriptor of the mapping.
 465  *
 466  * If \a fd_ptr is \p NULL, the file descriptor resulting from the underlying
 467  * open call is closed after mmap().  Otherwise the file is kept open and the
 468  * file descriptor is returned in \a fd_ptr.
 469  *
 470  * \return Standard.
 471  *
 472  * \sa para_open(), mmap(2).
 473  */
 474 int mmap_full_file(const char *path, int open_mode, void **map,
 475                 size_t *size, int *fd_ptr)
 476 {
 477         int fd, ret, mmap_prot, mmap_flags;
 478         struct stat file_status;
 479
 480         if (open_mode == O_RDONLY) {
 481                 mmap_prot = PROT_READ;
 482                 mmap_flags = MAP_PRIVATE;
 483         } else {
 484                 mmap_prot = PROT_READ | PROT_WRITE;
 485                 mmap_flags = MAP_SHARED;
 486         }
 487         ret = para_open(path, open_mode, 0);
 488         if (ret < 0)
 489                 return ret;
 490         fd = ret;
 491         if (fstat(fd, &file_status) < 0) {
 492                 ret = -ERRNO_TO_PARA_ERROR(errno);
 493                 goto out;
 494         }
 495         *size = file_status.st_size;
 496         /*
 497          * If the file is empty, *size is zero and mmap() would return EINVAL
 498          * (Invalid argument). This error is common enough to spend an extra
 499          * error code which explicitly states the problem.
 500          */
 501         ret = -E_EMPTY;
 502         if (*size == 0)
 503                 goto out;
 504         /*
 505          * If fd refers to a directory, mmap() returns ENODEV (No such device),
 506          * at least on Linux. "Is a directory" seems to be more to the point.
 507          */
 508         ret = -ERRNO_TO_PARA_ERROR(EISDIR);
 509         if (S_ISDIR(file_status.st_mode))
 510                 goto out;
 511
 512         ret = para_mmap(*size, mmap_prot, mmap_flags, fd, map);
 513 out:
 514         if (ret < 0 || !fd_ptr)
 515                 close(fd);
 516         else
 517                 *fd_ptr = fd;
 518         return ret;
 519 }
 520
 521 /**
 522  * A wrapper for munmap(2).
 523  *
 524  * \param start The start address of the memory mapping.
 525  * \param length The size of the mapping.
 526  *
 527  * If NULL is passed as the start address, the length value is ignored and the
 528  * function does nothing.
 529  *
 530  * \return Zero if NULL was passed, one if the memory area was successfully
 531  * unmapped, a negative error code otherwise.
 532  *
 533  * \sa munmap(2), \ref mmap_full_file().
 534  */
 535 int para_munmap(void *start, size_t length)
 536 {
 537         if (!start)
 538                 return 0;
 539         if (munmap(start, length) >= 0)
 540                 return 1;
 541         return -ERRNO_TO_PARA_ERROR(errno);
 542 }
 543
 544 /**
 545  * Simple wrapper for poll(2).
 546  *
 547  * It calls poll(2) and starts over if the call was interrupted by a signal.
 548  *
 549  * \param fds See poll(2).
 550  * \param nfds See poll(2).
 551  * \param timeout See poll(2).
 552  *
 553  * \return The return value of the underlying poll() call on success, the
 554  * negative paraslash error code on errors.
 555  *
 556  * All arguments are passed verbatim to poll(2).
 557  */
 558 int xpoll(struct pollfd *fds, nfds_t nfds, int timeout)
 559 {
 560         int ret;
 561
 562         do
 563                 ret = poll(fds, nfds, timeout);
 564         while (ret < 0 && errno == EINTR);
 565         return ret < 0? -ERRNO_TO_PARA_ERROR(errno) : ret;
 566 }
 567
 568 /**
 569  * Check a file descriptor for readability.
 570  *
 571  * \param fd The file descriptor.
 572  *
 573  * \return positive if fd is ready for reading, zero if it isn't, negative if
 574  * an error occurred.
 575  *
 576  * \sa \ref write_ok().
 577  */
 578 int read_ok(int fd)
 579 {
 580         struct pollfd pfd = {.fd = fd, .events = POLLIN};
 581         int ret = xpoll(&pfd, 1, 0);
 582         return ret < 0? ret : pfd.revents & POLLIN;
 583 }
 584
 585 /**
 586  * Check a file descriptor for writability.
 587  *
 588  * \param fd The file descriptor.
 589  *
 590  * \return positive if fd is ready for writing, zero if it isn't, negative if
 591  * an error occurred.
 592  *
 593  * \sa \ref read_ok().
 594  */
 595 int write_ok(int fd)
 596 {
 597         struct pollfd pfd = {.fd = fd, .events = POLLOUT};
 598         int ret = xpoll(&pfd, 1, 0);
 599         return ret < 0? ret : pfd.revents & POLLOUT;
 600 }
 601
 602 /**
 603  * Ensure that file descriptors 0, 1, and 2 are valid.
 604  *
 605  * Common approach that opens /dev/null until it gets a file descriptor greater
 606  * than two.
 607  */
 608 void valid_fd_012(void)
 609 {
 610         while (1) {
 611                 int fd = open("/dev/null", O_RDWR);
 612                 if (fd < 0)
 613                         exit(EXIT_FAILURE);
 614                 if (fd > 2) {
 615                         close(fd);
 616                         break;
 617                 }
 618         }
 619 }
 620
 621 /**
 622  * Traverse the given directory recursively.
 623  *
 624  * \param dirname The directory to traverse.
 625  * \param func The function to call for each entry.
 626  * \param private_data Pointer to an arbitrary data structure.
 627  *
 628  * For each regular file under \a dirname, the supplied function \a func is
 629  * called.  The full path of the regular file and the \a private_data pointer
 630  * are passed to \a func. Directories for which the calling process has no
 631  * permissions to change to are silently ignored.
 632  *
 633  * \return Standard.
 634  */
 635 int for_each_file_in_dir(const char *dirname,
 636                 int (*func)(const char *, void *), void *private_data)
 637 {
 638         DIR *dir;
 639         struct dirent *entry;
 640         int cwd_fd, ret = para_opendir(dirname, &dir, &cwd_fd);
 641
 642         if (ret < 0)
 643                 return ret == -ERRNO_TO_PARA_ERROR(EACCES)? 1 : ret;
 644         /* scan cwd recursively */
 645         while ((entry = readdir(dir))) {
 646                 mode_t m;
 647                 char *tmp;
 648                 struct stat s;
 649
 650                 if (!strcmp(entry->d_name, "."))
 651                         continue;
 652                 if (!strcmp(entry->d_name, ".."))
 653                         continue;
 654                 if (lstat(entry->d_name, &s) == -1)
 655                         continue;
 656                 m = s.st_mode;
 657                 if (!S_ISREG(m) && !S_ISDIR(m))
 658                         continue;
 659                 tmp = make_message("%s/%s", dirname, entry->d_name);
 660                 if (!S_ISDIR(m)) {
 661                         ret = func(tmp, private_data);
 662                         free(tmp);
 663                         if (ret < 0)
 664                                 goto out;
 665                         continue;
 666                 }
 667                 /* directory */
 668                 ret = for_each_file_in_dir(tmp, func, private_data);
 669                 free(tmp);
 670                 if (ret < 0)
 671                         goto out;
 672         }
 673         ret = 1;
 674 out:
 675         closedir(dir);
 676         if (fchdir(cwd_fd) < 0 && ret >= 0)
 677                 ret = -ERRNO_TO_PARA_ERROR(errno);
 678         close(cwd_fd);
 679         return ret;
 680 }