2 * Copyright (C) 2006-2014 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file fd.c Helper functions for file descriptor handling. */
10 #include <sys/types.h>
22 * Write an array of buffers to a file descriptor.
24 * \param fd The file descriptor.
25 * \param iov Pointer to one or more buffers.
26 * \param iovcnt The number of buffers.
28 * EAGAIN/EWOULDBLOCK is not considered a fatal error condition. For example
29 * DCCP CCID3 has a sending wait queue which fills up and is emptied
30 * asynchronously. The EAGAIN case means that there is currently no space in
31 * the wait queue, but this can change at any moment.
33 * \return Negative on fatal errors, number of bytes written else.
35 * For blocking file descriptors, this function returns either the sum of all
36 * buffer sizes, or the error code of the fatal error that caused the last
39 * For nonblocking file descriptors there is a third possibility: Any positive
40 * return value less than the sum of the buffer sizes indicates that some bytes
41 * have been written but the next write would block.
43 * \sa writev(2), \ref xwrite().
45 int xwritev(int fd, struct iovec *iov, int iovcnt)
49 struct iovec saved_iov, *curiov;
54 while (i < iovcnt && curiov->iov_len > 0) {
55 ssize_t ret = writev(fd, curiov, iovcnt - i);
59 if (ret < curiov->iov_len) {
60 curiov->iov_base += ret;
61 curiov->iov_len -= ret;
64 ret -= curiov->iov_len;
76 * The write() call was interrupted by a signal before
77 * any data was written. Try again.
80 if (errno == EAGAIN || errno == EWOULDBLOCK)
82 * We don't consider this an error. Note that POSIX
83 * allows either error to be returned, and does not
84 * require these constants to have the same value.
88 return -ERRNO_TO_PARA_ERROR(errno);
94 * Write a buffer to a file descriptor, re-writing on short writes.
96 * \param fd The file descriptor.
97 * \param buf The buffer to write.
98 * \param len The number of bytes to write.
100 * This is a simple wrapper for \ref xwritev().
102 * \return The return value of the underlying call to \ref xwritev().
104 int xwrite(int fd, const char *buf, size_t len)
106 struct iovec iov = {.iov_base = (void *)buf, .iov_len = len};
107 return xwritev(fd, &iov, 1);
111 * Write all data to a file descriptor.
113 * \param fd The file descriptor.
114 * \param buf The buffer to be sent.
115 * \param len The length of \a buf.
117 * This is like \ref xwrite() but returns \p -E_SHORT_WRITE if not
118 * all data could be written.
120 * \return Number of bytes written on success, negative error code else.
122 int write_all(int fd, const char *buf, size_t len)
124 int ret = xwrite(fd, buf, len);
129 return -E_SHORT_WRITE;
134 * Write a buffer given by a format string.
136 * \param fd The file descriptor.
137 * \param fmt A format string.
139 * \return The return value of the underlying call to \ref write_all().
141 __printf_2_3 int write_va_buffer(int fd, const char *fmt, ...)
148 ret = xvasprintf(&msg, fmt, ap);
149 ret = write_all(fd, msg, ret);
155 * Read from a non-blocking file descriptor into multiple buffers.
157 * \param fd The file descriptor to read from.
158 * \param iov Scatter/gather array used in readv().
159 * \param iovcnt Number of elements in \a iov.
160 * \param rfds An optional fd set pointer.
161 * \param num_bytes Result pointer. Contains the number of bytes read from \a fd.
163 * If \a rfds is not \p NULL and the (non-blocking) file descriptor \a fd is
164 * not set in \a rfds, this function returns early without doing anything.
165 * Otherwise The function tries to read up to \a sz bytes from \a fd, where \a
166 * sz is the sum of the lengths of all vectors in \a iov. As for xwrite(),
167 * \p EAGAIN is not considered an error condition. However, \p EOF is.
169 * \return Zero or a negative error code. If the underlying call to readv(2)
170 * returned zero (indicating an end of file condition) or failed for some
171 * reason other than \p EAGAIN, a negative error code is returned.
173 * In any case, \a num_bytes contains the number of bytes that have been
174 * successfully read from \a fd (zero if the first readv() call failed with
175 * EAGAIN). Note that even if the function returns negative, some data might
176 * have been read before the error occurred. In this case \a num_bytes is
179 * \sa \ref xwrite(), read(2), readv(2).
181 int readv_nonblock(int fd, struct iovec *iov, int iovcnt, fd_set *rfds,
188 * Avoid a shortcoming of select(): Reads from a non-blocking fd might
189 * return EAGAIN even if FD_ISSET() returns true. However, FD_ISSET()
190 * returning false definitely means that no data can currently be read.
191 * This is the common case, so it is worth to avoid the overhead of the
192 * read() system call in this case.
194 if (rfds && !FD_ISSET(fd, rfds))
197 for (i = 0, j = 0; i < iovcnt;) {
199 /* fix up the first iov */
200 assert(j < iov[i].iov_len);
201 iov[i].iov_base += j;
203 ret = readv(fd, iov + i, iovcnt - i);
204 iov[i].iov_base -= j;
212 return -ERRNO_TO_PARA_ERROR(errno);
216 if (ret < iov[i].iov_len - j) {
220 ret -= iov[i].iov_len - j;
230 * Read from a non-blocking file descriptor into a single buffer.
232 * \param fd The file descriptor to read from.
233 * \param buf The buffer to read data to.
234 * \param sz The size of \a buf.
235 * \param rfds \see \ref readv_nonblock().
236 * \param num_bytes \see \ref readv_nonblock().
238 * This is a simple wrapper for readv_nonblock() which uses an iovec with a single
241 * \return The return value of the underlying call to readv_nonblock().
243 int read_nonblock(int fd, void *buf, size_t sz, fd_set *rfds, size_t *num_bytes)
245 struct iovec iov = {.iov_base = buf, .iov_len = sz};
246 return readv_nonblock(fd, &iov, 1, rfds, num_bytes);
250 * Read a buffer and check its content for a pattern.
252 * \param fd The file descriptor to receive from.
253 * \param pattern The expected pattern.
254 * \param bufsize The size of the internal buffer.
255 * \param rfds Passed to read_nonblock().
257 * This function tries to read at most \a bufsize bytes from the non-blocking
258 * file descriptor \a fd. If at least \p strlen(\a pattern) bytes have been
259 * received, the beginning of the received buffer is compared with \a pattern,
262 * \return Positive if \a pattern was received, negative on errors, zero if no data
263 * was available to read.
265 * \sa \ref read_nonblock(), \sa strncasecmp(3).
267 int read_pattern(int fd, const char *pattern, size_t bufsize, fd_set *rfds)
270 char *buf = para_malloc(bufsize + 1);
271 int ret = read_nonblock(fd, buf, bufsize, rfds, &n);
279 ret = -E_READ_PATTERN;
280 len = strlen(pattern);
283 if (strncasecmp(buf, pattern, len) != 0)
288 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
289 PARA_NOTICE_LOG("recvd %zu bytes: %s\n", n, buf);
296 * Check whether a file exists.
298 * \param fn The file name.
300 * \return Non-zero iff file exists.
302 int file_exists(const char *fn)
306 return !stat(fn, &statbuf);
310 * Paraslash's wrapper for select(2).
312 * It calls select(2) (with no exceptfds) and starts over if select() was
313 * interrupted by a signal.
315 * \param n The highest-numbered descriptor in any of the two sets, plus 1.
316 * \param readfds fds that should be checked for readability.
317 * \param writefds fds that should be checked for writablility.
318 * \param timeout_tv upper bound on the amount of time elapsed before select()
321 * \return The return value of the underlying select() call on success, the
322 * negative system error code on errors.
324 * All arguments are passed verbatim to select(2).
325 * \sa select(2) select_tut(2).
327 int para_select(int n, fd_set *readfds, fd_set *writefds,
328 struct timeval *timeout_tv)
332 ret = select(n, readfds, writefds, NULL, timeout_tv);
333 while (ret < 0 && errno == EINTR);
335 return -ERRNO_TO_PARA_ERROR(errno);
340 * Set a file descriptor to blocking mode.
342 * \param fd The file descriptor.
346 __must_check int mark_fd_blocking(int fd)
348 int flags = fcntl(fd, F_GETFL);
350 return -ERRNO_TO_PARA_ERROR(errno);
351 flags = fcntl(fd, F_SETFL, ((long)flags) & ~O_NONBLOCK);
353 return -ERRNO_TO_PARA_ERROR(errno);
358 * Set a file descriptor to non-blocking mode.
360 * \param fd The file descriptor.
364 __must_check int mark_fd_nonblocking(int fd)
366 int flags = fcntl(fd, F_GETFL);
368 return -ERRNO_TO_PARA_ERROR(errno);
369 flags = fcntl(fd, F_SETFL, ((long)flags) | O_NONBLOCK);
371 return -ERRNO_TO_PARA_ERROR(errno);
376 * Set a file descriptor in a fd_set.
378 * \param fd The file descriptor to be set.
379 * \param fds The file descriptor set.
380 * \param max_fileno Highest-numbered file descriptor.
382 * This wrapper for FD_SET() passes its first two arguments to \p FD_SET. Upon
383 * return, \a max_fileno contains the maximum of the old_value and \a fd.
387 void para_fd_set(int fd, fd_set *fds, int *max_fileno)
389 assert(fd >= 0 && fd < FD_SETSIZE);
392 int flags = fcntl(fd, F_GETFL);
393 if (!(flags & O_NONBLOCK)) {
394 PARA_EMERG_LOG("fd %d is a blocking file descriptor\n", fd);
400 *max_fileno = PARA_MAX(*max_fileno, fd);
404 * Paraslash's wrapper for fgets(3).
406 * \param line Pointer to the buffer to store the line.
407 * \param size The size of the buffer given by \a line.
408 * \param f The stream to read from.
410 * \return Unlike the standard fgets() function, an integer value
411 * is returned. On success, this function returns 1. On errors, -E_FGETS
412 * is returned. A zero return value indicates an end of file condition.
414 __must_check int para_fgets(char *line, int size, FILE *f)
417 if (fgets(line, size, f))
423 if (errno != EINTR) {
424 PARA_ERROR_LOG("%s\n", strerror(errno));
432 * Paraslash's wrapper for mmap.
434 * \param length Number of bytes to mmap.
435 * \param prot Either PROT_NONE or the bitwise OR of one or more of
436 * PROT_EXEC PROT_READ PROT_WRITE.
437 * \param flags Exactly one of MAP_SHARED and MAP_PRIVATE.
438 * \param fd The file to mmap from.
439 * \param offset Mmap start.
440 * \param map Result pointer.
446 int para_mmap(size_t length, int prot, int flags, int fd, off_t offset,
454 *m = mmap(NULL, length, prot, flags, fd, offset);
455 if (*m != MAP_FAILED)
459 return -ERRNO_TO_PARA_ERROR(errno);
463 * Wrapper for the open(2) system call.
465 * \param path The filename.
466 * \param flags The usual open(2) flags.
467 * \param mode Specifies the permissions to use.
469 * The mode parameter must be specified when O_CREAT is in the flags, and is
472 * \return The file descriptor on success, negative on errors.
476 int para_open(const char *path, int flags, mode_t mode)
478 int ret = open(path, flags, mode);
482 return -ERRNO_TO_PARA_ERROR(errno);
486 * Wrapper for chdir(2).
488 * \param path The specified directory.
492 int para_chdir(const char *path)
494 int ret = chdir(path);
498 return -ERRNO_TO_PARA_ERROR(errno);
502 * Save the cwd and open a given directory.
504 * \param dirname Path to the directory to open.
505 * \param dir Result pointer.
506 * \param cwd File descriptor of the current working directory.
510 * Opening the current directory (".") and calling fchdir() to return is
511 * usually faster and more reliable than saving cwd in some buffer and calling
512 * chdir() afterwards.
514 * If \a cwd is not \p NULL "." is opened and the resulting file descriptor is
515 * stored in \a cwd. If the function returns success, and \a cwd is not \p
516 * NULL, the caller must close this file descriptor (probably after calling
519 * On errors, the function undos everything, so the caller needs neither close
520 * any files, nor change back to the original working directory.
525 static int para_opendir(const char *dirname, DIR **dir, int *cwd)
531 ret = para_open(".", O_RDONLY, 0);
536 ret = para_chdir(dirname);
542 ret = -ERRNO_TO_PARA_ERROR(errno);
543 /* Ignore return value of fchdir() and close(). We're busted anyway. */
545 int __a_unused ret2 = fchdir(*cwd); /* STFU, gcc */
554 * A wrapper for fchdir().
556 * \param fd An open file descriptor.
560 static int para_fchdir(int fd)
563 return -ERRNO_TO_PARA_ERROR(errno);
568 * A wrapper for mkdir(2).
570 * \param path Name of the directory to create.
571 * \param mode The permissions to use.
575 int para_mkdir(const char *path, mode_t mode)
577 if (!mkdir(path, mode))
579 return -ERRNO_TO_PARA_ERROR(errno);
583 * Open a file and map it into memory.
585 * \param path Name of the regular file to map.
586 * \param open_mode Either \p O_RDONLY or \p O_RDWR.
587 * \param map On success, the mapping is returned here.
588 * \param size size of the mapping.
589 * \param fd_ptr The file descriptor of the mapping.
591 * If \a fd_ptr is \p NULL, the file descriptor resulting from the underlying
592 * open call is closed after mmap(). Otherwise the file is kept open and the
593 * file descriptor is returned in \a fd_ptr.
597 * \sa para_open(), mmap(2).
599 int mmap_full_file(const char *path, int open_mode, void **map,
600 size_t *size, int *fd_ptr)
602 int fd, ret, mmap_prot, mmap_flags;
603 struct stat file_status;
605 if (open_mode == O_RDONLY) {
606 mmap_prot = PROT_READ;
607 mmap_flags = MAP_PRIVATE;
609 mmap_prot = PROT_READ | PROT_WRITE;
610 mmap_flags = MAP_SHARED;
612 ret = para_open(path, open_mode, 0);
616 if (fstat(fd, &file_status) < 0) {
617 ret = -ERRNO_TO_PARA_ERROR(errno);
620 *size = file_status.st_size;
622 * If the file is empty, *size is zero and mmap() would return EINVAL
623 * (Invalid argument). This error is common enough to spend an extra
624 * error code which explicitly states the problem.
630 * If fd refers to a directory, mmap() returns ENODEV (No such device),
631 * at least on Linux. "Is a directory" seems to be more to the point.
633 ret = -ERRNO_TO_PARA_ERROR(EISDIR);
634 if (S_ISDIR(file_status.st_mode))
637 ret = para_mmap(*size, mmap_prot, mmap_flags, fd, 0, map);
639 if (ret < 0 || !fd_ptr)
647 * A wrapper for munmap(2).
649 * \param start The start address of the memory mapping.
650 * \param length The size of the mapping.
654 * \sa munmap(2), mmap_full_file().
656 int para_munmap(void *start, size_t length)
662 if (munmap(start, length) >= 0)
665 PARA_ERROR_LOG("munmap (%p/%zu) failed: %s\n", start, length,
667 return -ERRNO_TO_PARA_ERROR(err);
671 * Check a file descriptor for writability.
673 * \param fd The file descriptor.
675 * \return positive if fd is ready for writing, zero if it isn't, negative if
688 return para_select(fd + 1, NULL, &wfds, &tv);
692 * Ensure that file descriptors 0, 1, and 2 are valid.
694 * Common approach that opens /dev/null until it gets a file descriptor greater
697 * \sa okir's Black Hats Manual.
699 void valid_fd_012(void)
702 int fd = open("/dev/null", O_RDWR);
713 * Traverse the given directory recursively.
715 * \param dirname The directory to traverse.
716 * \param func The function to call for each entry.
717 * \param private_data Pointer to an arbitrary data structure.
719 * For each regular file under \a dirname, the supplied function \a func is
720 * called. The full path of the regular file and the \a private_data pointer
721 * are passed to \a func. Directories for which the calling process has no
722 * permissions to change to are silently ignored.
726 int for_each_file_in_dir(const char *dirname,
727 int (*func)(const char *, void *), void *private_data)
730 struct dirent *entry;
731 int cwd_fd, ret2, ret = para_opendir(dirname, &dir, &cwd_fd);
734 return ret == -ERRNO_TO_PARA_ERROR(EACCES)? 1 : ret;
735 /* scan cwd recursively */
736 while ((entry = readdir(dir))) {
741 if (!strcmp(entry->d_name, "."))
743 if (!strcmp(entry->d_name, ".."))
745 if (lstat(entry->d_name, &s) == -1)
748 if (!S_ISREG(m) && !S_ISDIR(m))
750 tmp = make_message("%s/%s", dirname, entry->d_name);
752 ret = func(tmp, private_data);
759 ret = for_each_file_in_dir(tmp, func, private_data);
767 ret2 = para_fchdir(cwd_fd);
768 if (ret2 < 0 && ret >= 0)