libbb/read.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Utility routines.
   4  *
   5  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
   6  *
   7  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
   8  */
   9
  10 #include "libbb.h"
  11
  12 ssize_t safe_read(int fd, void *buf, size_t count)
  13 {
  14         ssize_t n;
  15
  16         do {
  17                 n = read(fd, buf, count);
  18         } while (n < 0 && errno == EINTR);
  19
  20         return n;
  21 }
  22
  23 /* Suppose that you are a shell. You start child processes.
  24  * They work and eventually exit. You want to get user input.
  25  * You read stdin. But what happens if last child switched
  26  * its stdin into O_NONBLOCK mode?
  27  *
  28  * *** SURPRISE! It will affect the parent too! ***
  29  * *** BIG SURPRISE! It stays even after child exits! ***
  30  *
  31  * This is a design bug in UNIX API.
  32  *      fcntl(0, F_SETFL, fcntl(0, F_GETFL, 0) | O_NONBLOCK);
  33  * will set nonblocking mode not only on _your_ stdin, but
  34  * also on stdin of your parent, etc.
  35  *
  36  * In general,
  37  *      fd2 = dup(fd1);
  38  *      fcntl(fd2, F_SETFL, fcntl(fd2, F_GETFL, 0) | O_NONBLOCK);
  39  * sets both fd1 and fd2 to O_NONBLOCK. This includes cases
  40  * where duping is done implicitly by fork() etc.
  41  *
  42  * We need
  43  *      fcntl(fd2, F_SETFD, fcntl(fd2, F_GETFD, 0) | O_NONBLOCK);
  44  * (note SETFD, not SETFL!) but such thing doesn't exist.
  45  *
  46  * Alternatively, we need nonblocking_read(fd, ...) which doesn't
  47  * require O_NONBLOCK dance at all. Actually, it exists:
  48  *      n = recv(fd, buf, len, MSG_DONTWAIT);
  49  *      "MSG_DONTWAIT:
  50  *      Enables non-blocking operation; if the operation
  51  *      would block, EAGAIN is returned."
  52  * but recv() works only for sockets!
  53  *
  54  * So far I don't see any good solution, I can only propose
  55  * that affected readers should be careful and use this routine,
  56  * which detects EAGAIN and uses poll() to wait on the fd.
  57  * Thankfully, poll() doesn't care about O_NONBLOCK flag.
  58  */
  59 ssize_t nonblock_safe_read(int fd, void *buf, size_t count)
  60 {
  61         struct pollfd pfd[1];
  62         ssize_t n;
  63
  64         while (1) {
  65                 n = safe_read(fd, buf, count);
  66                 if (n >= 0 || errno != EAGAIN)
  67                         return n;
  68                 /* fd is in O_NONBLOCK mode. Wait using poll and repeat */
  69                 pfd[0].fd = fd;
  70                 pfd[0].events = POLLIN;
  71                 safe_poll(pfd, 1, -1);
  72         }
  73 }
  74
  75 /*
  76  * Read all of the supplied buffer from a file.
  77  * This does multiple reads as necessary.
  78  * Returns the amount read, or -1 on an error.
  79  * A short read is returned on an end of file.
  80  */
  81 ssize_t full_read(int fd, void *buf, size_t len)
  82 {
  83         ssize_t cc;
  84         ssize_t total;
  85
  86         total = 0;
  87
  88         while (len) {
  89                 cc = safe_read(fd, buf, len);
  90
  91                 if (cc < 0)
  92                         return cc;      /* read() returns -1 on failure. */
  93                 if (cc == 0)
  94                         break;
  95                 buf = ((char *)buf) + cc;
  96                 total += cc;
  97                 len -= cc;
  98         }
  99
 100         return total;
 101 }
 102
 103 // Die with an error message if we can't read the entire buffer.
 104 void xread(int fd, void *buf, size_t count)
 105 {
 106         if (count) {
 107                 ssize_t size = full_read(fd, buf, count);
 108                 if (size != count)
 109                         bb_error_msg_and_die("short read");
 110         }
 111 }
 112
 113 // Die with an error message if we can't read one character.
 114 unsigned char xread_char(int fd)
 115 {
 116         char tmp;
 117         xread(fd, &tmp, 1);
 118         return tmp;
 119 }
 120
 121 // Read one line a-la fgets. Works only on seekable streams
 122 char *reads(int fd, char *buffer, size_t size)
 123 {
 124         char *p;
 125
 126         if (size < 2)
 127                 return NULL;
 128         size = full_read(fd, buffer, size-1);
 129         if ((ssize_t)size <= 0)
 130                 return NULL;
 131
 132         buffer[size] = '\0';
 133         p = strchr(buffer, '\n');
 134         if (p) {
 135                 off_t offset;
 136                 *p++ = '\0';
 137                 // avoid incorrect (unsigned) widening
 138                 offset = (off_t)(p-buffer) - (off_t)size;
 139                 // set fd position right after '\n'
 140                 if (offset && lseek(fd, offset, SEEK_CUR) == (off_t)-1)
 141                         return NULL;
 142         }
 143         return buffer;
 144 }
 145
 146 // Read one line a-la fgets. Reads byte-by-byte.
 147 // Useful when it is important to not read ahead.
 148 // Bytes are appended to pfx (which must be malloced, or NULL).
 149 char *xmalloc_reads(int fd, char *buf)
 150 {
 151         char *p;
 152         int sz = buf ? strlen(buf) : 0;
 153
 154         goto jump_in;
 155         while (1) {
 156                 if (p - buf == sz) {
 157  jump_in:
 158                         buf = xrealloc(buf, sz + 128);
 159                         p = buf + sz;
 160                         sz += 128;
 161                 }
 162                 /* nonblock_safe_read() because we are used by e.g. shells */
 163                 if (nonblock_safe_read(fd, p, 1) != 1) { /* EOF/error */
 164                         if (p == buf) {
 165                                 /* we read nothing [and buf was NULL initially] */
 166                                 free(buf);
 167                                 return NULL;
 168                         }
 169                         break;
 170                 }
 171                 if (*p == '\n')
 172                         break;
 173                 p++;
 174         }
 175         *p++ = '\0';
 176         return xrealloc(buf, p - buf);
 177 }
 178
 179 ssize_t read_close(int fd, void *buf, size_t size)
 180 {
 181         /*int e;*/
 182         size = full_read(fd, buf, size);
 183         /*e = errno;*/
 184         close(fd);
 185         /*errno = e;*/
 186         return size;
 187 }
 188
 189 ssize_t open_read_close(const char *filename, void *buf, size_t size)
 190 {
 191         int fd = open(filename, O_RDONLY);
 192         if (fd < 0)
 193                 return fd;
 194         return read_close(fd, buf, size);
 195 }
 196
 197 // Read (potentially big) files in one go. File size is estimated by
 198 // lseek to end.
 199 void *xmalloc_open_read_close(const char *filename, size_t *sizep)
 200 {
 201         char *buf;
 202         size_t size = sizep ? *sizep : INT_MAX;
 203         int fd;
 204         off_t len;
 205
 206         fd = xopen(filename, O_RDONLY);
 207         /* /proc/N/stat files report len 0 here */
 208         /* In order to make such files readable, we add small const */
 209         len = xlseek(fd, 0, SEEK_END) | 0x3ff; /* + up to 1k */
 210         xlseek(fd, 0, SEEK_SET);
 211         if (len < size)
 212                 size = len;
 213         buf = xmalloc(size + 1);
 214         size = read_close(fd, buf, size);
 215         if ((ssize_t)size < 0)
 216                 bb_perror_msg_and_die("'%s'", filename);
 217         xrealloc(buf, size + 1);
 218         buf[size] = '\0';
 219         if (sizep)
 220                 *sizep = size;
 221         return buf;
 222 }