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 FAST_FUNC 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 FAST_FUNC 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 FAST_FUNC 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                         if (total) {
  93                                 /* we already have some! */
  94                                 /* user can do another read to know the error code */
  95                                 return total;
  96                         }
  97                         return cc; /* read() returns -1 on failure. */
  98                 }
  99                 if (cc == 0)
 100                         break;
 101                 buf = ((char *)buf) + cc;
 102                 total += cc;
 103                 len -= cc;
 104         }
 105
 106         return total;
 107 }
 108
 109 /* Die with an error message if we can't read the entire buffer. */
 110 void FAST_FUNC xread(int fd, void *buf, size_t count)
 111 {
 112         if (count) {
 113                 ssize_t size = full_read(fd, buf, count);
 114                 if ((size_t)size != count)
 115                         bb_error_msg_and_die("short read");
 116         }
 117 }
 118
 119 /* Die with an error message if we can't read one character. */
 120 unsigned char FAST_FUNC xread_char(int fd)
 121 {
 122         char tmp;
 123         xread(fd, &tmp, 1);
 124         return tmp;
 125 }
 126
 127 /* Read one line a-la fgets. Works only on seekable streams */
 128 char* FAST_FUNC reads(int fd, char *buffer, size_t size)
 129 {
 130         char *p;
 131
 132         if (size < 2)
 133                 return NULL;
 134         size = full_read(fd, buffer, size-1);
 135         if ((ssize_t)size <= 0)
 136                 return NULL;
 137
 138         buffer[size] = '\0';
 139         p = strchr(buffer, '\n');
 140         if (p) {
 141                 off_t offset;
 142                 *p++ = '\0';
 143                 /* avoid incorrect (unsigned) widening */
 144                 offset = (off_t)(p - buffer) - (off_t)size;
 145                 /* set fd position right after '\n' */
 146                 if (offset && lseek(fd, offset, SEEK_CUR) == (off_t)-1)
 147                         return NULL;
 148         }
 149         return buffer;
 150 }
 151
 152 // Reads one line a-la fgets (but doesn't save terminating '\n').
 153 // Reads byte-by-byte. Useful when it is important to not read ahead.
 154 // Bytes are appended to pfx (which must be malloced, or NULL).
 155 char* FAST_FUNC xmalloc_reads(int fd, char *buf, size_t *maxsz_p)
 156 {
 157         char *p;
 158         size_t sz = buf ? strlen(buf) : 0;
 159         size_t maxsz = maxsz_p ? *maxsz_p : MAXINT(size_t);
 160
 161         goto jump_in;
 162         while (sz < maxsz) {
 163                 if ((size_t)(p - buf) == sz) {
 164  jump_in:
 165                         buf = xrealloc(buf, sz + 128);
 166                         p = buf + sz;
 167                         sz += 128;
 168                 }
 169                 /* nonblock_safe_read() because we are used by e.g. shells */
 170                 if (nonblock_safe_read(fd, p, 1) != 1) { /* EOF/error */
 171                         if (p == buf) { /* we read nothing */
 172                                 free(buf);
 173                                 return NULL;
 174                         }
 175                         break;
 176                 }
 177                 if (*p == '\n')
 178                         break;
 179                 p++;
 180         }
 181         *p = '\0';
 182         if (maxsz_p)
 183                 *maxsz_p  = p - buf;
 184         p++;
 185         return xrealloc(buf, p - buf);
 186 }
 187
 188 ssize_t FAST_FUNC read_close(int fd, void *buf, size_t size)
 189 {
 190         /*int e;*/
 191         size = full_read(fd, buf, size);
 192         /*e = errno;*/
 193         close(fd);
 194         /*errno = e;*/
 195         return size;
 196 }
 197
 198 ssize_t FAST_FUNC open_read_close(const char *filename, void *buf, size_t size)
 199 {
 200         int fd = open(filename, O_RDONLY);
 201         if (fd < 0)
 202                 return fd;
 203         return read_close(fd, buf, size);
 204 }
 205
 206
 207 // Read (potentially big) files in one go. File size is estimated
 208 // by stat. Extra '\0' byte is appended.
 209 void* FAST_FUNC xmalloc_read(int fd, size_t *sizep)
 210 {
 211         char *buf;
 212         size_t size, rd_size, total;
 213         off_t to_read;
 214         struct stat st;
 215
 216         to_read = sizep ? *sizep : MAXINT(ssize_t); /* max to read */
 217
 218         /* Estimate file size */
 219         st.st_size = 0; /* in case fstat fails, assume 0 */
 220         fstat(fd, &st);
 221         /* /proc/N/stat files report st_size 0 */
 222         /* In order to make such files readable, we add small const */
 223         size = (st.st_size | 0x3ff) + 1;
 224
 225         total = 0;
 226         buf = NULL;
 227         while (1) {
 228                 if (to_read < size)
 229                         size = to_read;
 230                 buf = xrealloc(buf, total + size + 1);
 231                 rd_size = full_read(fd, buf + total, size);
 232                 if ((ssize_t)rd_size < 0) { /* error */
 233                         free(buf);
 234                         return NULL;
 235                 }
 236                 total += rd_size;
 237                 if (rd_size < size) /* EOF */
 238                         break;
 239                 to_read -= rd_size;
 240                 if (to_read <= 0)
 241                         break;
 242                 /* grow by 1/8, but in [1k..64k] bounds */
 243                 size = ((total / 8) | 0x3ff) + 1;
 244                 if (size > 64*1024)
 245                         size = 64*1024;
 246         }
 247         xrealloc(buf, total + 1);
 248         buf[total] = '\0';
 249
 250         if (sizep)
 251                 *sizep = total;
 252         return buf;
 253 }
 254
 255 #ifdef USING_LSEEK_TO_GET_SIZE
 256 /* Alternatively, file size can be obtained by lseek to the end.
 257  * The code is slightly bigger. Retained in case fstat approach
 258  * will not work for some weird cases (/proc, block devices, etc).
 259  * (NB: lseek also can fail to work for some weird files) */
 260
 261 // Read (potentially big) files in one go. File size is estimated by
 262 // lseek to end.
 263 void* FAST_FUNC xmalloc_open_read_close(const char *filename, size_t *sizep)
 264 {
 265         char *buf;
 266         size_t size;
 267         int fd;
 268         off_t len;
 269
 270         fd = open(filename, O_RDONLY);
 271         if (fd < 0)
 272                 return NULL;
 273
 274         /* /proc/N/stat files report len 0 here */
 275         /* In order to make such files readable, we add small const */
 276         size = 0x3ff; /* read only 1k on unseekable files */
 277         len = lseek(fd, 0, SEEK_END) | 0x3ff; /* + up to 1k */
 278         if (len != (off_t)-1) {
 279                 xlseek(fd, 0, SEEK_SET);
 280                 size = sizep ? *sizep : INT_MAX;
 281                 if (len < size)
 282                         size = len;
 283         }
 284
 285         buf = xmalloc(size + 1);
 286         size = read_close(fd, buf, size);
 287         if ((ssize_t)size < 0) {
 288                 free(buf);
 289                 return NULL;
 290         }
 291         xrealloc(buf, size + 1);
 292         buf[size] = '\0';
 293
 294         if (sizep)
 295                 *sizep = size;
 296         return buf;
 297 }
 298 #endif
 299
 300 // Read (potentially big) files in one go. File size is estimated
 301 // by stat.
 302 void* FAST_FUNC xmalloc_open_read_close(const char *filename, size_t *sizep)
 303 {
 304         char *buf;
 305         int fd;
 306
 307         fd = open(filename, O_RDONLY);
 308         if (fd < 0)
 309                 return NULL;
 310
 311         buf = xmalloc_read(fd, sizep);
 312         close(fd);
 313         return buf;
 314 }
 315
 316 void* FAST_FUNC xmalloc_xopen_read_close(const char *filename, size_t *sizep)
 317 {
 318         void *buf = xmalloc_open_read_close(filename, sizep);
 319         if (!buf)
 320                 bb_perror_msg_and_die("can't read '%s'", filename);
 321         return buf;
 322 }