command.c: Document return value of handle_connect().
[paraslash.git] / 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 to a file descriptor.
41  *
42  * \param fd The file descriptor.
43  * \param iov Pointer to one or more buffers.
44  * \param iovcnt The number of buffers.
45  *
46  * EAGAIN/EWOULDBLOCK is not considered a fatal error condition. For example
47  * DCCP CCID3 has a sending wait queue which fills up and is emptied
48  * asynchronously. The EAGAIN case means that there is currently no space in
49  * the wait queue, but this can change at any moment.
50  *
51  * \return Negative on fatal errors, number of bytes written else.
52  *
53  * For blocking file descriptors, this function returns either the sum of all
54  * buffer sizes, or the error code of the fatal error that caused the last
55  * write call to fail.
56  *
57  * For nonblocking file descriptors there is a third possibility: Any positive
58  * return value less than the sum of the buffer sizes indicates that some bytes
59  * have been written but the next write would block.
60  *
61  * \sa writev(2), \ref xwrite().
62  */
63 int xwritev(int fd, struct iovec *iov, int iovcnt)
64 {
65         size_t written = 0;
66         int i;
67         struct iovec saved_iov, *curiov;
68
69         i = 0;
70         curiov = iov;
71         saved_iov = *curiov;
72         while (i < iovcnt && curiov->iov_len > 0) {
73                 ssize_t ret = writev(fd, curiov, iovcnt - i);
74                 if (ret >= 0) {
75                         written += ret;
76                         while (ret > 0) {
77                                 if (ret < curiov->iov_len) {
78                                         curiov->iov_base += ret;
79                                         curiov->iov_len -= ret;
80                                         break;
81                                 }
82                                 ret -= curiov->iov_len;
83                                 *curiov = saved_iov;
84                                 i++;
85                                 if (i >= iovcnt)
86                                         return written;
87                                 curiov++;
88                                 saved_iov = *curiov;
89                         }
90                         continue;
91                 }
92                 if (errno == EINTR)
93                         /*
94                          * The write() call was interrupted by a signal before
95                          * any data was written. Try again.
96                          */
97                         continue;
98                 if (errno == EAGAIN || errno == EWOULDBLOCK)
99                         /*
100                          * We don't consider this an error. Note that POSIX
101                          * allows either error to be returned, and does not
102                          * require these constants to have the same value.
103                          */
104                         return written;
105                 /* fatal error */
106                 return -ERRNO_TO_PARA_ERROR(errno);
107         }
108         return written;
109 }
110
111 /**
112  * Write a buffer to a file descriptor, re-writing on short writes.
113  *
114  * \param fd The file descriptor.
115  * \param buf The buffer to write.
116  * \param len The number of bytes to write.
117  *
118  * This is a simple wrapper for \ref xwritev().
119  *
120  * \return The return value of the underlying call to \ref xwritev().
121  */
122 int xwrite(int fd, const char *buf, size_t len)
123 {
124         struct iovec iov = {.iov_base = (void *)buf, .iov_len = len};
125         return xwritev(fd, &iov, 1);
126 }
127
128 /**
129  * Write all data to a file descriptor.
130  *
131  * \param fd The file descriptor.
132  * \param buf The buffer to be sent.
133  * \param len The length of \a buf.
134  *
135  * This is like \ref xwrite() but returns \p -E_SHORT_WRITE if not
136  * all data could be written.
137  *
138  * \return Number of bytes written on success, negative error code else.
139  */
140 int write_all(int fd, const char *buf, size_t len)
141 {
142         int ret = xwrite(fd, buf, len);
143
144         if (ret < 0)
145                 return ret;
146         if (ret != len)
147                 return -E_SHORT_WRITE;
148         return ret;
149 }
150
151 /**
152  * Write a buffer given by a format string.
153  *
154  * \param fd The file descriptor.
155  * \param fmt A format string.
156  *
157  * \return The return value of the underlying call to \ref write_all().
158  */
159 __printf_2_3 int write_va_buffer(int fd, const char *fmt, ...)
160 {
161         char *msg;
162         int ret;
163         va_list ap;
164
165         va_start(ap, fmt);
166         ret = xvasprintf(&msg, fmt, ap);
167         va_end(ap);
168         ret = write_all(fd, msg, ret);
169         free(msg);
170         return ret;
171 }
172
173 /**
174  * Read from a non-blocking file descriptor into multiple buffers.
175  *
176  * \param fd The file descriptor to read from.
177  * \param iov Scatter/gather array used in readv().
178  * \param iovcnt Number of elements in \a iov.
179  * \param rfds An optional fd set pointer.
180  * \param num_bytes Result pointer. Contains the number of bytes read from \a fd.
181  *
182  * If \a rfds is not \p NULL and the (non-blocking) file descriptor \a fd is
183  * not set in \a rfds, this function returns early without doing anything.
184  * Otherwise The function tries to read up to \a sz bytes from \a fd, where \a
185  * sz is the sum of the lengths of all vectors in \a iov. As for xwrite(),
186  * \p EAGAIN is not considered an error condition. However, \p EOF is.
187  *
188  * \return Zero or a negative error code. If the underlying call to readv(2)
189  * returned zero (indicating an end of file condition) or failed for some
190  * reason other than \p EAGAIN, a negative error code is returned.
191  *
192  * In any case, \a num_bytes contains the number of bytes that have been
193  * successfully read from \a fd (zero if the first readv() call failed with
194  * EAGAIN). Note that even if the function returns negative, some data might
195  * have been read before the error occurred. In this case \a num_bytes is
196  * positive.
197  *
198  * \sa \ref xwrite(), read(2), readv(2).
199  */
200 int readv_nonblock(int fd, struct iovec *iov, int iovcnt, fd_set *rfds,
201                 size_t *num_bytes)
202 {
203         int ret, i, j;
204
205         *num_bytes = 0;
206         /*
207          * Avoid a shortcoming of select(): Reads from a non-blocking fd might
208          * return EAGAIN even if FD_ISSET() returns true. However, FD_ISSET()
209          * returning false definitely means that no data can currently be read.
210          * This is the common case, so it is worth to avoid the overhead of the
211          * read() system call in this case.
212          */
213         if (rfds && !FD_ISSET(fd, rfds))
214                 return 0;
215
216         for (i = 0, j = 0; i < iovcnt;) {
217
218                 /* fix up the first iov */
219                 assert(j < iov[i].iov_len);
220                 iov[i].iov_base += j;
221                 iov[i].iov_len -= j;
222                 ret = readv(fd, iov + i, iovcnt - i);
223                 iov[i].iov_base -= j;
224                 iov[i].iov_len += j;
225
226                 if (ret == 0)
227                         return -E_EOF;
228                 if (ret < 0) {
229                         if (errno == EAGAIN)
230                                 return 0;
231                         return -ERRNO_TO_PARA_ERROR(errno);
232                 }
233                 *num_bytes += ret;
234                 while (ret > 0) {
235                         if (ret < iov[i].iov_len - j) {
236                                 j += ret;
237                                 break;
238                         }
239                         ret -= iov[i].iov_len - j;
240                         j = 0;
241                         if (++i >= iovcnt)
242                                 break;
243                 }
244         }
245         return 0;
246 }
247
248 /**
249  * Read from a non-blocking file descriptor into a single buffer.
250  *
251  * \param fd The file descriptor to read from.
252  * \param buf The buffer to read data to.
253  * \param sz The size of \a buf.
254  * \param rfds \see \ref readv_nonblock().
255  * \param num_bytes \see \ref readv_nonblock().
256  *
257  * This is a simple wrapper for readv_nonblock() which uses an iovec with a single
258  * buffer.
259  *
260  * \return The return value of the underlying call to readv_nonblock().
261  */
262 int read_nonblock(int fd, void *buf, size_t sz, fd_set *rfds, size_t *num_bytes)
263 {
264         struct iovec iov = {.iov_base = buf, .iov_len = sz};
265         return readv_nonblock(fd, &iov, 1, rfds, num_bytes);
266 }
267
268 /**
269  * Read a buffer and check its content for a pattern.
270  *
271  * \param fd The file descriptor to receive from.
272  * \param pattern The expected pattern.
273  * \param bufsize The size of the internal buffer.
274  * \param rfds Passed to read_nonblock().
275  *
276  * This function tries to read at most \a bufsize bytes from the non-blocking
277  * file descriptor \a fd. If at least \p strlen(\a pattern) bytes have been
278  * received, the beginning of the received buffer is compared with \a pattern,
279  * ignoring case.
280  *
281  * \return Positive if \a pattern was received, negative on errors, zero if no data
282  * was available to read.
283  *
284  * \sa \ref read_nonblock(), \sa strncasecmp(3).
285  */
286 int read_pattern(int fd, const char *pattern, size_t bufsize, fd_set *rfds)
287 {
288         size_t n, len;
289         char *buf = para_malloc(bufsize + 1);
290         int ret = read_nonblock(fd, buf, bufsize, rfds, &n);
291
292         buf[n] = '\0';
293         if (ret < 0)
294                 goto out;
295         ret = 0;
296         if (n == 0)
297                 goto out;
298         ret = -E_READ_PATTERN;
299         len = strlen(pattern);
300         if (n < len)
301                 goto out;
302         if (strncasecmp(buf, pattern, len) != 0)
303                 goto out;
304         ret = 1;
305 out:
306         if (ret < 0) {
307                 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
308                 PARA_NOTICE_LOG("recvd %zu bytes: %s\n", n, buf);
309         }
310         free(buf);
311         return ret;
312 }
313
314 /**
315  * Check whether a file exists.
316  *
317  * \param fn The file name.
318  *
319  * \return True iff file exists.
320  */
321 bool file_exists(const char *fn)
322 {
323         struct stat statbuf;
324
325         return !stat(fn, &statbuf);
326 }
327
328 /**
329  * Paraslash's wrapper for select(2).
330  *
331  * It calls select(2) (with no exceptfds) and starts over if select() was
332  * interrupted by a signal.
333  *
334  * \param n The highest-numbered descriptor in any of the two sets, plus 1.
335  * \param readfds fds that should be checked for readability.
336  * \param writefds fds that should be checked for writablility.
337  * \param timeout_tv upper bound on the amount of time elapsed before select()
338  * returns.
339  *
340  * \return The return value of the underlying select() call on success, the
341  * negative system error code on errors.
342  *
343  * All arguments are passed verbatim to select(2).
344  * \sa select(2) select_tut(2).
345  */
346 int para_select(int n, fd_set *readfds, fd_set *writefds,
347                 struct timeval *timeout_tv)
348 {
349         int ret;
350         do
351                 ret = select(n, readfds, writefds, NULL, timeout_tv);
352         while (ret < 0 && errno == EINTR);
353         if (ret < 0)
354                 return -ERRNO_TO_PARA_ERROR(errno);
355         return ret;
356 }
357
358 /**
359  * Set a file descriptor to blocking mode.
360  *
361  * \param fd The file descriptor.
362  *
363  * \return Standard.
364  */
365 __must_check int mark_fd_blocking(int fd)
366 {
367         int flags = fcntl(fd, F_GETFL);
368         if (flags < 0)
369                 return -ERRNO_TO_PARA_ERROR(errno);
370         flags = fcntl(fd, F_SETFL, ((long)flags) & ~O_NONBLOCK);
371         if (flags < 0)
372                 return -ERRNO_TO_PARA_ERROR(errno);
373         return 1;
374 }
375
376 /**
377  * Set a file descriptor to non-blocking mode.
378  *
379  * \param fd The file descriptor.
380  *
381  * \return Standard.
382  */
383 __must_check int mark_fd_nonblocking(int fd)
384 {
385         int flags = fcntl(fd, F_GETFL);
386         if (flags < 0)
387                 return -ERRNO_TO_PARA_ERROR(errno);
388         flags = fcntl(fd, F_SETFL, ((long)flags) | O_NONBLOCK);
389         if (flags < 0)
390                 return -ERRNO_TO_PARA_ERROR(errno);
391         return 1;
392 }
393
394 /**
395  * Set a file descriptor in a fd_set.
396  *
397  * \param fd The file descriptor to be set.
398  * \param fds The file descriptor set.
399  * \param max_fileno Highest-numbered file descriptor.
400  *
401  * This wrapper for FD_SET() passes its first two arguments to \p FD_SET. Upon
402  * return, \a max_fileno contains the maximum of the old_value and \a fd.
403  *
404  * \sa \ref para_select.
405 */
406 void para_fd_set(int fd, fd_set *fds, int *max_fileno)
407 {
408         assert(fd >= 0 && fd < FD_SETSIZE);
409 #if 0
410         {
411                 int flags = fcntl(fd, F_GETFL);
412                 if (!(flags & O_NONBLOCK)) {
413                         PARA_EMERG_LOG("fd %d is a blocking file descriptor\n", fd);
414                         exit(EXIT_FAILURE);
415                 }
416         }
417 #endif
418         FD_SET(fd, fds);
419         *max_fileno = PARA_MAX(*max_fileno, fd);
420 }
421
422 /**
423  * Paraslash's wrapper for mmap.
424  *
425  * \param length Number of bytes to mmap.
426  * \param prot Either PROT_NONE or the bitwise OR of one or more of
427  * PROT_EXEC PROT_READ PROT_WRITE.
428  * \param flags Exactly one of MAP_SHARED and MAP_PRIVATE.
429  * \param fd The file to mmap from.
430  * \param map Result pointer.
431  *
432  * \return Standard.
433  *
434  * \sa mmap(2).
435  */
436 int para_mmap(size_t length, int prot, int flags, int fd, void *map)
437 {
438         void **m = map;
439
440         errno = EINVAL;
441         if (!length)
442                 goto err;
443         *m = mmap(NULL, length, prot, flags, fd, (off_t)0);
444         if (*m != MAP_FAILED)
445                 return 1;
446 err:
447         *m = NULL;
448         return -ERRNO_TO_PARA_ERROR(errno);
449 }
450
451 /**
452  * Wrapper for the open(2) system call.
453  *
454  * \param path The filename.
455  * \param flags The usual open(2) flags.
456  * \param mode Specifies the permissions to use.
457  *
458  * The mode parameter must be specified when O_CREAT is in the flags, and is
459  * ignored otherwise.
460  *
461  * \return The file descriptor on success, negative on errors.
462  *
463  * \sa open(2).
464  */
465 int para_open(const char *path, int flags, mode_t mode)
466 {
467         int ret = open(path, flags, mode);
468
469         if (ret >= 0)
470                 return ret;
471         return -ERRNO_TO_PARA_ERROR(errno);
472 }
473
474 /**
475  * Wrapper for chdir(2).
476  *
477  * \param path The specified directory.
478  *
479  * \return Standard.
480  */
481 int para_chdir(const char *path)
482 {
483         int ret = chdir(path);
484
485         if (ret >= 0)
486                 return 1;
487         return -ERRNO_TO_PARA_ERROR(errno);
488 }
489
490 /**
491  * Save the cwd and open a given directory.
492  *
493  * \param dirname Path to the directory to open.
494  * \param dir Result pointer.
495  * \param cwd File descriptor of the current working directory.
496  *
497  * \return Standard.
498  *
499  * Opening the current directory (".") and calling fchdir() to return is
500  * usually faster and more reliable than saving cwd in some buffer and calling
501  * chdir() afterwards.
502  *
503  * If \a cwd is not \p NULL "." is opened and the resulting file descriptor is
504  * stored in \a cwd. If the function returns success, and \a cwd is not \p
505  * NULL, the caller must close this file descriptor (probably after calling
506  * fchdir(*cwd)).
507  *
508  * On errors, the function undos everything, so the caller needs neither close
509  * any files, nor change back to the original working directory.
510  *
511  * \sa getcwd(3).
512  *
513  */
514 static int para_opendir(const char *dirname, DIR **dir, int *cwd)
515 {
516         int ret;
517
518         *dir = NULL;
519         if (cwd) {
520                 ret = para_open(".", O_RDONLY, 0);
521                 if (ret < 0)
522                         return ret;
523                 *cwd = ret;
524         }
525         ret = para_chdir(dirname);
526         if (ret < 0)
527                 goto close_cwd;
528         *dir = opendir(".");
529         if (*dir)
530                 return 1;
531         ret = -ERRNO_TO_PARA_ERROR(errno);
532         /* Ignore return value of fchdir() and close(). We're busted anyway. */
533         if (cwd) {
534                 int __a_unused ret2 = fchdir(*cwd); /* STFU, gcc */
535         }
536 close_cwd:
537         if (cwd)
538                 close(*cwd);
539         return ret;
540 }
541
542 /**
543  * A wrapper for mkdir(2).
544  *
545  * \param path Name of the directory to create.
546  * \param mode The permissions to use.
547  *
548  * \return Standard.
549  */
550 int para_mkdir(const char *path, mode_t mode)
551 {
552         if (!mkdir(path, mode))
553                 return 1;
554         return -ERRNO_TO_PARA_ERROR(errno);
555 }
556
557 /**
558  * Open a file and map it into memory.
559  *
560  * \param path Name of the regular file to map.
561  * \param open_mode Either \p O_RDONLY or \p O_RDWR.
562  * \param map On success, the mapping is returned here.
563  * \param size size of the mapping.
564  * \param fd_ptr The file descriptor of the mapping.
565  *
566  * If \a fd_ptr is \p NULL, the file descriptor resulting from the underlying
567  * open call is closed after mmap().  Otherwise the file is kept open and the
568  * file descriptor is returned in \a fd_ptr.
569  *
570  * \return Standard.
571  *
572  * \sa para_open(), mmap(2).
573  */
574 int mmap_full_file(const char *path, int open_mode, void **map,
575                 size_t *size, int *fd_ptr)
576 {
577         int fd, ret, mmap_prot, mmap_flags;
578         struct stat file_status;
579
580         if (open_mode == O_RDONLY) {
581                 mmap_prot = PROT_READ;
582                 mmap_flags = MAP_PRIVATE;
583         } else {
584                 mmap_prot = PROT_READ | PROT_WRITE;
585                 mmap_flags = MAP_SHARED;
586         }
587         ret = para_open(path, open_mode, 0);
588         if (ret < 0)
589                 return ret;
590         fd = ret;
591         if (fstat(fd, &file_status) < 0) {
592                 ret = -ERRNO_TO_PARA_ERROR(errno);
593                 goto out;
594         }
595         *size = file_status.st_size;
596         /*
597          * If the file is empty, *size is zero and mmap() would return EINVAL
598          * (Invalid argument). This error is common enough to spend an extra
599          * error code which explicitly states the problem.
600          */
601         ret = -E_EMPTY;
602         if (*size == 0)
603                 goto out;
604         /*
605          * If fd refers to a directory, mmap() returns ENODEV (No such device),
606          * at least on Linux. "Is a directory" seems to be more to the point.
607          */
608         ret = -ERRNO_TO_PARA_ERROR(EISDIR);
609         if (S_ISDIR(file_status.st_mode))
610                 goto out;
611
612         ret = para_mmap(*size, mmap_prot, mmap_flags, fd, map);
613 out:
614         if (ret < 0 || !fd_ptr)
615                 close(fd);
616         else
617                 *fd_ptr = fd;
618         return ret;
619 }
620
621 /**
622  * A wrapper for munmap(2).
623  *
624  * \param start The start address of the memory mapping.
625  * \param length The size of the mapping.
626  *
627  * \return Standard.
628  *
629  * \sa munmap(2), \ref mmap_full_file().
630  */
631 int para_munmap(void *start, size_t length)
632 {
633         int err;
634
635         if (!start)
636                 return 0;
637         if (munmap(start, length) >= 0)
638                 return 1;
639         err = errno;
640         PARA_ERROR_LOG("munmap (%p/%zu) failed: %s\n", start, length,
641                 strerror(err));
642         return -ERRNO_TO_PARA_ERROR(err);
643 }
644
645 /**
646  * Check a file descriptor for writability.
647  *
648  * \param fd The file descriptor.
649  *
650  * \return positive if fd is ready for writing, zero if it isn't, negative if
651  * an error occurred.
652  */
653
654 int write_ok(int fd)
655 {
656         struct timeval tv;
657         fd_set wfds;
658
659         FD_ZERO(&wfds);
660         FD_SET(fd, &wfds);
661         tv.tv_sec = 0;
662         tv.tv_usec = 0;
663         return para_select(fd + 1, NULL, &wfds, &tv);
664 }
665
666 /**
667  * Ensure that file descriptors 0, 1, and 2 are valid.
668  *
669  * Common approach that opens /dev/null until it gets a file descriptor greater
670  * than two.
671  */
672 void valid_fd_012(void)
673 {
674         while (1) {
675                 int fd = open("/dev/null", O_RDWR);
676                 if (fd < 0)
677                         exit(EXIT_FAILURE);
678                 if (fd > 2) {
679                         close(fd);
680                         break;
681                 }
682         }
683 }
684
685 /**
686  * Traverse the given directory recursively.
687  *
688  * \param dirname The directory to traverse.
689  * \param func The function to call for each entry.
690  * \param private_data Pointer to an arbitrary data structure.
691  *
692  * For each regular file under \a dirname, the supplied function \a func is
693  * called.  The full path of the regular file and the \a private_data pointer
694  * are passed to \a func. Directories for which the calling process has no
695  * permissions to change to are silently ignored.
696  *
697  * \return Standard.
698  */
699 int for_each_file_in_dir(const char *dirname,
700                 int (*func)(const char *, void *), void *private_data)
701 {
702         DIR *dir;
703         struct dirent *entry;
704         int cwd_fd, ret = para_opendir(dirname, &dir, &cwd_fd);
705
706         if (ret < 0)
707                 return ret == -ERRNO_TO_PARA_ERROR(EACCES)? 1 : ret;
708         /* scan cwd recursively */
709         while ((entry = readdir(dir))) {
710                 mode_t m;
711                 char *tmp;
712                 struct stat s;
713
714                 if (!strcmp(entry->d_name, "."))
715                         continue;
716                 if (!strcmp(entry->d_name, ".."))
717                         continue;
718                 if (lstat(entry->d_name, &s) == -1)
719                         continue;
720                 m = s.st_mode;
721                 if (!S_ISREG(m) && !S_ISDIR(m))
722                         continue;
723                 tmp = make_message("%s/%s", dirname, entry->d_name);
724                 if (!S_ISDIR(m)) {
725                         ret = func(tmp, private_data);
726                         free(tmp);
727                         if (ret < 0)
728                                 goto out;
729                         continue;
730                 }
731                 /* directory */
732                 ret = for_each_file_in_dir(tmp, func, private_data);
733                 free(tmp);
734                 if (ret < 0)
735                         goto out;
736         }
737         ret = 1;
738 out:
739         closedir(dir);
740         if (fchdir(cwd_fd) < 0 && ret >= 0)
741                 ret = -ERRNO_TO_PARA_ERROR(errno);
742         close(cwd_fd);
743         return ret;
744 }