2 * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
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>
20 * Write an array of buffers to a file descriptor.
22 * \param fd The file descriptor.
23 * \param iov Pointer to one or more buffers.
24 * \param iovcnt The number of buffers.
26 * EAGAIN/EWOULDBLOCK is not considered a fatal error condition. For example
27 * DCCP CCID3 has a sending wait queue which fills up and is emptied
28 * asynchronously. The EAGAIN case means that there is currently no space in
29 * the wait queue, but this can change at any moment.
31 * \return Negative on fatal errors, number of bytes written else.
33 * For blocking file descriptors, this function returns either the sum of all
34 * buffer sizes, or the error code of the fatal error that caused the last
37 * For nonblocking file descriptors there is a third possibility: Any positive
38 * return value less than the sum of the buffer sizes indicates that some bytes
39 * have been written but the next write would block.
41 * \sa writev(2), \ref xwrite().
43 int xwritev(int fd
, struct iovec
*iov
, int iovcnt
)
47 struct iovec saved_iov
, *curiov
;
52 while (i
< iovcnt
&& curiov
->iov_len
> 0) {
53 ssize_t ret
= writev(fd
, curiov
, iovcnt
- i
);
57 if (ret
< curiov
->iov_len
) {
58 curiov
->iov_base
+= ret
;
59 curiov
->iov_len
-= ret
;
62 ret
-= curiov
->iov_len
;
74 * The write() call was interrupted by a signal before
75 * any data was written. Try again.
78 if (errno
== EAGAIN
|| errno
== EWOULDBLOCK
)
80 * We don't consider this an error. Note that POSIX
81 * allows either error to be returned, and does not
82 * require these constants to have the same value.
86 return -ERRNO_TO_PARA_ERROR(errno
);
92 * Write a buffer to a file descriptor, re-writing on short writes.
94 * \param fd The file descriptor.
95 * \param buf The buffer to write.
96 * \param len The number of bytes to write.
98 * This is a simple wrapper for \ref xwritev().
100 * \return The return value of the underlying call to \ref xwritev().
102 int xwrite(int fd
, const char *buf
, size_t len
)
104 struct iovec iov
= {.iov_base
= (void *)buf
, .iov_len
= len
};
105 return xwritev(fd
, &iov
, 1);
109 * Write all data to a file descriptor.
111 * \param fd The file descriptor.
112 * \param buf The buffer to be sent.
113 * \param len The length of \a buf.
115 * This is like \ref xwrite() but returns \p -E_SHORT_WRITE if not
116 * all data could be written.
118 * \return Number of bytes written on success, negative error code else.
120 int write_all(int fd
, const char *buf
, size_t len
)
122 int ret
= xwrite(fd
, buf
, len
);
127 return -E_SHORT_WRITE
;
132 * Write a buffer given by a format string.
134 * \param fd The file descriptor.
135 * \param fmt A format string.
137 * \return The return value of the underlying call to \ref write_all().
139 __printf_2_3
int write_va_buffer(int fd
, const char *fmt
, ...)
146 ret
= xvasprintf(&msg
, fmt
, ap
);
148 ret
= write_all(fd
, msg
, ret
);
154 * Read from a non-blocking file descriptor into multiple buffers.
156 * \param fd The file descriptor to read from.
157 * \param iov Scatter/gather array used in readv().
158 * \param iovcnt Number of elements in \a iov.
159 * \param rfds An optional fd set pointer.
160 * \param num_bytes Result pointer. Contains the number of bytes read from \a fd.
162 * If \a rfds is not \p NULL and the (non-blocking) file descriptor \a fd is
163 * not set in \a rfds, this function returns early without doing anything.
164 * Otherwise The function tries to read up to \a sz bytes from \a fd, where \a
165 * sz is the sum of the lengths of all vectors in \a iov. As for xwrite(),
166 * \p EAGAIN is not considered an error condition. However, \p EOF is.
168 * \return Zero or a negative error code. If the underlying call to readv(2)
169 * returned zero (indicating an end of file condition) or failed for some
170 * reason other than \p EAGAIN, a negative error code is returned.
172 * In any case, \a num_bytes contains the number of bytes that have been
173 * successfully read from \a fd (zero if the first readv() call failed with
174 * EAGAIN). Note that even if the function returns negative, some data might
175 * have been read before the error occurred. In this case \a num_bytes is
178 * \sa \ref xwrite(), read(2), readv(2).
180 int readv_nonblock(int fd
, struct iovec
*iov
, int iovcnt
, fd_set
*rfds
,
187 * Avoid a shortcoming of select(): Reads from a non-blocking fd might
188 * return EAGAIN even if FD_ISSET() returns true. However, FD_ISSET()
189 * returning false definitely means that no data can currently be read.
190 * This is the common case, so it is worth to avoid the overhead of the
191 * read() system call in this case.
193 if (rfds
&& !FD_ISSET(fd
, rfds
))
196 for (i
= 0, j
= 0; i
< iovcnt
;) {
198 /* fix up the first iov */
199 assert(j
< iov
[i
].iov_len
);
200 iov
[i
].iov_base
+= j
;
202 ret
= readv(fd
, iov
+ i
, iovcnt
- i
);
203 iov
[i
].iov_base
-= j
;
211 return -ERRNO_TO_PARA_ERROR(errno
);
215 if (ret
< iov
[i
].iov_len
- j
) {
219 ret
-= iov
[i
].iov_len
- j
;
229 * Read from a non-blocking file descriptor into a single buffer.
231 * \param fd The file descriptor to read from.
232 * \param buf The buffer to read data to.
233 * \param sz The size of \a buf.
234 * \param rfds \see \ref readv_nonblock().
235 * \param num_bytes \see \ref readv_nonblock().
237 * This is a simple wrapper for readv_nonblock() which uses an iovec with a single
240 * \return The return value of the underlying call to readv_nonblock().
242 int read_nonblock(int fd
, void *buf
, size_t sz
, fd_set
*rfds
, size_t *num_bytes
)
244 struct iovec iov
= {.iov_base
= buf
, .iov_len
= sz
};
245 return readv_nonblock(fd
, &iov
, 1, rfds
, num_bytes
);
249 * Read a buffer and check its content for a pattern.
251 * \param fd The file descriptor to receive from.
252 * \param pattern The expected pattern.
253 * \param bufsize The size of the internal buffer.
254 * \param rfds Passed to read_nonblock().
256 * This function tries to read at most \a bufsize bytes from the non-blocking
257 * file descriptor \a fd. If at least \p strlen(\a pattern) bytes have been
258 * received, the beginning of the received buffer is compared with \a pattern,
261 * \return Positive if \a pattern was received, negative on errors, zero if no data
262 * was available to read.
264 * \sa \ref read_nonblock(), \sa strncasecmp(3).
266 int read_pattern(int fd
, const char *pattern
, size_t bufsize
, fd_set
*rfds
)
269 char *buf
= para_malloc(bufsize
+ 1);
270 int ret
= read_nonblock(fd
, buf
, bufsize
, rfds
, &n
);
278 ret
= -E_READ_PATTERN
;
279 len
= strlen(pattern
);
282 if (strncasecmp(buf
, pattern
, len
) != 0)
287 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
288 PARA_NOTICE_LOG("recvd %zu bytes: %s\n", n
, buf
);
295 * Check whether a file exists.
297 * \param fn The file name.
299 * \return Non-zero iff file exists.
301 int file_exists(const char *fn
)
305 return !stat(fn
, &statbuf
);
309 * Paraslash's wrapper for select(2).
311 * It calls select(2) (with no exceptfds) and starts over if select() was
312 * interrupted by a signal.
314 * \param n The highest-numbered descriptor in any of the two sets, plus 1.
315 * \param readfds fds that should be checked for readability.
316 * \param writefds fds that should be checked for writablility.
317 * \param timeout_tv upper bound on the amount of time elapsed before select()
320 * \return The return value of the underlying select() call on success, the
321 * negative system error code on errors.
323 * All arguments are passed verbatim to select(2).
324 * \sa select(2) select_tut(2).
326 int para_select(int n
, fd_set
*readfds
, fd_set
*writefds
,
327 struct timeval
*timeout_tv
)
331 ret
= select(n
, readfds
, writefds
, NULL
, timeout_tv
);
332 while (ret
< 0 && errno
== EINTR
);
334 return -ERRNO_TO_PARA_ERROR(errno
);
339 * Set a file descriptor to blocking mode.
341 * \param fd The file descriptor.
345 __must_check
int mark_fd_blocking(int fd
)
347 int flags
= fcntl(fd
, F_GETFL
);
349 return -ERRNO_TO_PARA_ERROR(errno
);
350 flags
= fcntl(fd
, F_SETFL
, ((long)flags
) & ~O_NONBLOCK
);
352 return -ERRNO_TO_PARA_ERROR(errno
);
357 * Set a file descriptor to non-blocking mode.
359 * \param fd The file descriptor.
363 __must_check
int mark_fd_nonblocking(int fd
)
365 int flags
= fcntl(fd
, F_GETFL
);
367 return -ERRNO_TO_PARA_ERROR(errno
);
368 flags
= fcntl(fd
, F_SETFL
, ((long)flags
) | O_NONBLOCK
);
370 return -ERRNO_TO_PARA_ERROR(errno
);
375 * Set a file descriptor in a fd_set.
377 * \param fd The file descriptor to be set.
378 * \param fds The file descriptor set.
379 * \param max_fileno Highest-numbered file descriptor.
381 * This wrapper for FD_SET() passes its first two arguments to \p FD_SET. Upon
382 * return, \a max_fileno contains the maximum of the old_value and \a fd.
386 void para_fd_set(int fd
, fd_set
*fds
, int *max_fileno
)
388 assert(fd
>= 0 && fd
< FD_SETSIZE
);
391 int flags
= fcntl(fd
, F_GETFL
);
392 if (!(flags
& O_NONBLOCK
)) {
393 PARA_EMERG_LOG("fd %d is a blocking file descriptor\n", fd
);
399 *max_fileno
= PARA_MAX(*max_fileno
, fd
);
403 * Paraslash's wrapper for fgets(3).
405 * \param line Pointer to the buffer to store the line.
406 * \param size The size of the buffer given by \a line.
407 * \param f The stream to read from.
409 * \return Unlike the standard fgets() function, an integer value
410 * is returned. On success, this function returns 1. On errors, -E_FGETS
411 * is returned. A zero return value indicates an end of file condition.
413 __must_check
int para_fgets(char *line
, int size
, FILE *f
)
416 if (fgets(line
, size
, f
))
422 if (errno
!= EINTR
) {
423 PARA_ERROR_LOG("%s\n", strerror(errno
));
431 * Paraslash's wrapper for mmap.
433 * \param length Number of bytes to mmap.
434 * \param prot Either PROT_NONE or the bitwise OR of one or more of
435 * PROT_EXEC PROT_READ PROT_WRITE.
436 * \param flags Exactly one of MAP_SHARED and MAP_PRIVATE.
437 * \param fd The file to mmap from.
438 * \param offset Mmap start.
439 * \param map Result pointer.
445 int para_mmap(size_t length
, int prot
, int flags
, int fd
, off_t offset
,
453 *m
= mmap(NULL
, length
, prot
, flags
, fd
, offset
);
454 if (*m
!= MAP_FAILED
)
458 return -ERRNO_TO_PARA_ERROR(errno
);
462 * Wrapper for the open(2) system call.
464 * \param path The filename.
465 * \param flags The usual open(2) flags.
466 * \param mode Specifies the permissions to use.
468 * The mode parameter must be specified when O_CREAT is in the flags, and is
471 * \return The file descriptor on success, negative on errors.
475 int para_open(const char *path
, int flags
, mode_t mode
)
477 int ret
= open(path
, flags
, mode
);
481 return -ERRNO_TO_PARA_ERROR(errno
);
485 * Wrapper for chdir(2).
487 * \param path The specified directory.
491 int para_chdir(const char *path
)
493 int ret
= chdir(path
);
497 return -ERRNO_TO_PARA_ERROR(errno
);
501 * Save the cwd and open a given directory.
503 * \param dirname Path to the directory to open.
504 * \param dir Result pointer.
505 * \param cwd File descriptor of the current working directory.
509 * Opening the current directory (".") and calling fchdir() to return is
510 * usually faster and more reliable than saving cwd in some buffer and calling
511 * chdir() afterwards.
513 * If \a cwd is not \p NULL "." is opened and the resulting file descriptor is
514 * stored in \a cwd. If the function returns success, and \a cwd is not \p
515 * NULL, the caller must close this file descriptor (probably after calling
518 * On errors, the function undos everything, so the caller needs neither close
519 * any files, nor change back to the original working directory.
524 static int para_opendir(const char *dirname
, DIR **dir
, int *cwd
)
530 ret
= para_open(".", O_RDONLY
, 0);
535 ret
= para_chdir(dirname
);
541 ret
= -ERRNO_TO_PARA_ERROR(errno
);
542 /* Ignore return value of fchdir() and close(). We're busted anyway. */
544 int __a_unused ret2
= fchdir(*cwd
); /* STFU, gcc */
553 * A wrapper for fchdir().
555 * \param fd An open file descriptor.
559 static int para_fchdir(int fd
)
562 return -ERRNO_TO_PARA_ERROR(errno
);
567 * A wrapper for mkdir(2).
569 * \param path Name of the directory to create.
570 * \param mode The permissions to use.
574 int para_mkdir(const char *path
, mode_t mode
)
576 if (!mkdir(path
, mode
))
578 return -ERRNO_TO_PARA_ERROR(errno
);
582 * Open a file and map it into memory.
584 * \param path Name of the regular file to map.
585 * \param open_mode Either \p O_RDONLY or \p O_RDWR.
586 * \param map On success, the mapping is returned here.
587 * \param size size of the mapping.
588 * \param fd_ptr The file descriptor of the mapping.
590 * If \a fd_ptr is \p NULL, the file descriptor resulting from the underlying
591 * open call is closed after mmap(). Otherwise the file is kept open and the
592 * file descriptor is returned in \a fd_ptr.
596 * \sa para_open(), mmap(2).
598 int mmap_full_file(const char *path
, int open_mode
, void **map
,
599 size_t *size
, int *fd_ptr
)
601 int fd
, ret
, mmap_prot
, mmap_flags
;
602 struct stat file_status
;
604 if (open_mode
== O_RDONLY
) {
605 mmap_prot
= PROT_READ
;
606 mmap_flags
= MAP_PRIVATE
;
608 mmap_prot
= PROT_READ
| PROT_WRITE
;
609 mmap_flags
= MAP_SHARED
;
611 ret
= para_open(path
, open_mode
, 0);
615 if (fstat(fd
, &file_status
) < 0) {
616 ret
= -ERRNO_TO_PARA_ERROR(errno
);
619 *size
= file_status
.st_size
;
621 * If the file is empty, *size is zero and mmap() would return EINVAL
622 * (Invalid argument). This error is common enough to spend an extra
623 * error code which explicitly states the problem.
629 * If fd refers to a directory, mmap() returns ENODEV (No such device),
630 * at least on Linux. "Is a directory" seems to be more to the point.
632 ret
= -ERRNO_TO_PARA_ERROR(EISDIR
);
633 if (S_ISDIR(file_status
.st_mode
))
636 ret
= para_mmap(*size
, mmap_prot
, mmap_flags
, fd
, 0, map
);
638 if (ret
< 0 || !fd_ptr
)
646 * A wrapper for munmap(2).
648 * \param start The start address of the memory mapping.
649 * \param length The size of the mapping.
653 * \sa munmap(2), mmap_full_file().
655 int para_munmap(void *start
, size_t length
)
661 if (munmap(start
, length
) >= 0)
664 PARA_ERROR_LOG("munmap (%p/%zu) failed: %s\n", start
, length
,
666 return -ERRNO_TO_PARA_ERROR(err
);
670 * Check a file descriptor for writability.
672 * \param fd The file descriptor.
674 * \return positive if fd is ready for writing, zero if it isn't, negative if
687 return para_select(fd
+ 1, NULL
, &wfds
, &tv
);
691 * Ensure that file descriptors 0, 1, and 2 are valid.
693 * Common approach that opens /dev/null until it gets a file descriptor greater
696 * \sa okir's Black Hats Manual.
698 void valid_fd_012(void)
701 int fd
= open("/dev/null", O_RDWR
);
712 * Traverse the given directory recursively.
714 * \param dirname The directory to traverse.
715 * \param func The function to call for each entry.
716 * \param private_data Pointer to an arbitrary data structure.
718 * For each regular file under \a dirname, the supplied function \a func is
719 * called. The full path of the regular file and the \a private_data pointer
720 * are passed to \a func. Directories for which the calling process has no
721 * permissions to change to are silently ignored.
725 int for_each_file_in_dir(const char *dirname
,
726 int (*func
)(const char *, void *), void *private_data
)
729 struct dirent
*entry
;
730 int cwd_fd
, ret2
, ret
= para_opendir(dirname
, &dir
, &cwd_fd
);
733 return ret
== -ERRNO_TO_PARA_ERROR(EACCES
)? 1 : ret
;
734 /* scan cwd recursively */
735 while ((entry
= readdir(dir
))) {
740 if (!strcmp(entry
->d_name
, "."))
742 if (!strcmp(entry
->d_name
, ".."))
744 if (lstat(entry
->d_name
, &s
) == -1)
747 if (!S_ISREG(m
) && !S_ISDIR(m
))
749 tmp
= make_message("%s/%s", dirname
, entry
->d_name
);
751 ret
= func(tmp
, private_data
);
758 ret
= for_each_file_in_dir(tmp
, func
, private_data
);
766 ret2
= para_fchdir(cwd_fd
);
767 if (ret2
< 0 && ret
>= 0)