coreutils/tail.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini tail implementation for busybox
   4  *
   5  * Copyright (C) 2001 by Matt Kraai <kraai@alumni.carnegiemellon.edu>
   6  *
   7  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
   8  */
   9
  10 /* BB_AUDIT SUSv3 compliant (need fancy for -c) */
  11 /* BB_AUDIT GNU compatible -c, -q, and -v options in 'fancy' configuration. */
  12 /* http://www.opengroup.org/onlinepubs/007904975/utilities/tail.html */
  13
  14 /* Mar 16, 2003      Manuel Novoa III   (mjn3@codepoet.org)
  15  *
  16  * Pretty much rewritten to fix numerous bugs and reduce realloc() calls.
  17  * Bugs fixed (although I may have forgotten one or two... it was pretty bad)
  18  * 1) mixing printf/write without fflush()ing stdout
  19  * 2) no check that any open files are present
  20  * 3) optstring had -q taking an arg
  21  * 4) no error checking on write in some cases, and a warning even then
  22  * 5) q and s interaction bug
  23  * 6) no check for lseek error
  24  * 7) lseek attempted when count==0 even if arg was +0 (from top)
  25  */
  26
  27 #include "busybox.h"
  28
  29 static const struct suffix_mult tail_suffixes[] = {
  30         { "b", 512 },
  31         { "k", 1024 },
  32         { "m", 1048576 },
  33         { NULL, 0 }
  34 };
  35
  36 static int status;
  37
  38 static void tail_xbb_full_write(const char *buf, size_t len)
  39 {
  40         /* If we get a write error, there is really no sense in continuing. */
  41         if (full_write(STDOUT_FILENO, buf, len) < 0)
  42                 bb_perror_nomsg_and_die();
  43 }
  44
  45 static void tail_xprint_header(const char *fmt, const char *filename)
  46 {
  47 #if defined __GLIBC__
  48         if (dprintf(STDOUT_FILENO, fmt, filename) < 0) {
  49                 bb_perror_nomsg_and_die();
  50         }
  51 #else
  52         int hdr_len = strlen(fmt) + strlen(filename);
  53         char *hdr = xzalloc(hdr_len);
  54         sprintf(hdr, filename, filename);
  55         tail_xbb_full_write(hdr, hdr_len);
  56 #endif
  57 }
  58
  59 static ssize_t tail_read(int fd, char *buf, size_t count)
  60 {
  61         ssize_t r;
  62         off_t current,end;
  63         struct stat sbuf;
  64
  65         end = current = lseek(fd, 0, SEEK_CUR);
  66         if (!fstat(fd, &sbuf))
  67                 end = sbuf.st_size;
  68         lseek(fd, end < current ? 0 : current, SEEK_SET);
  69         if ((r = safe_read(fd, buf, count)) < 0) {
  70                 bb_perror_msg(bb_msg_read_error);
  71                 status = EXIT_FAILURE;
  72         }
  73
  74         return r;
  75 }
  76
  77 static const char tail_opts[] =
  78         "fn:c:"
  79 #if ENABLE_FEATURE_FANCY_TAIL
  80         "qs:v"
  81 #endif
  82         ;
  83
  84 static const char header_fmt[] = "\n==> %s <==\n";
  85
  86 int tail_main(int argc, char **argv)
  87 {
  88         long count = 10;
  89         unsigned sleep_period = 1;
  90         int from_top = 0;
  91         int follow = 0;
  92         int header_threshhold = 1;
  93         int count_bytes = 0;
  94
  95         char *tailbuf;
  96         size_t tailbufsize;
  97         int taillen = 0;
  98         int newline = 0;
  99
 100         int *fds, nfiles, nread, nwrite, seen, i, opt;
 101         char *s, *buf;
 102         const char *fmt;
 103
 104 #if !ENABLE_DEBUG_YANK_SUSv2 || ENABLE_FEATURE_FANCY_TAIL
 105         /* Allow legacy syntax of an initial numeric option without -n. */
 106         if (argc >= 2 && (argv[1][0] == '+' || argv[1][0] == '-')
 107          && isdigit(argv[1][1])
 108         ) {
 109                 optind = 2;
 110                 optarg = argv[1];
 111                 goto GET_COUNT;
 112         }
 113 #endif
 114
 115         while ((opt = getopt(argc, argv, tail_opts)) > 0) {
 116                 switch (opt) {
 117                         case 'f':
 118                                 follow = 1;
 119                                 break;
 120                         case 'c':
 121                                 count_bytes = 1;
 122                                 /* FALLS THROUGH */
 123                         case 'n':
 124 #if !ENABLE_DEBUG_YANK_SUSv2 || ENABLE_FEATURE_FANCY_TAIL
 125                         GET_COUNT:
 126 #endif
 127                                 count = xatol_sfx(optarg, tail_suffixes);
 128                                 /* Note: Leading whitespace is an error trapped above. */
 129                                 if (*optarg == '+') {
 130                                         from_top = 1;
 131                                 } else {
 132                                         from_top = 0;
 133                                 }
 134                                 if (count < 0) {
 135                                         count = -count;
 136                                 }
 137                                 break;
 138 #if ENABLE_FEATURE_FANCY_TAIL
 139                         case 'q':
 140                                 header_threshhold = INT_MAX;
 141                                 break;
 142                         case 's':
 143                                 sleep_period = xatou(optarg);
 144                                 break;
 145                         case 'v':
 146                                 header_threshhold = 0;
 147                                 break;
 148 #endif
 149                         default:
 150                                 bb_show_usage();
 151                 }
 152         }
 153
 154         /* open all the files */
 155         fds = xmalloc(sizeof(int) * (argc - optind + 1));
 156
 157         argv += optind;
 158         nfiles = i = 0;
 159
 160         if ((argc -= optind) == 0) {
 161                 struct stat statbuf;
 162
 163                 if (!fstat(STDIN_FILENO, &statbuf) && S_ISFIFO(statbuf.st_mode)) {
 164                         follow = 0;
 165                 }
 166                 /* --argv; */
 167                 *argv = (char *) bb_msg_standard_input;
 168                 goto DO_STDIN;
 169         }
 170
 171         do {
 172                 if (LONE_DASH(argv[i])) {
 173  DO_STDIN:
 174                         fds[nfiles] = STDIN_FILENO;
 175                 } else if ((fds[nfiles] = open(argv[i], O_RDONLY)) < 0) {
 176                         bb_perror_msg("%s", argv[i]);
 177                         status = EXIT_FAILURE;
 178                         continue;
 179                 }
 180                 argv[nfiles] = argv[i];
 181                 ++nfiles;
 182         } while (++i < argc);
 183
 184         if (!nfiles) {
 185                 bb_error_msg_and_die("no files");
 186         }
 187
 188         tailbufsize = BUFSIZ;
 189
 190         /* tail the files */
 191         if (from_top < count_bytes) {   /* Each is 0 or 1, so true iff 0 < 1. */
 192                 /* Hence, !from_top && count_bytes */
 193                 if (tailbufsize < count) {
 194                         tailbufsize = count + BUFSIZ;
 195                 }
 196         }
 197
 198         buf = tailbuf = xmalloc(tailbufsize);
 199
 200         fmt = header_fmt + 1;   /* Skip header leading newline on first output. */
 201         i = 0;
 202         do {
 203                 /* Be careful.  It would be possible to optimize the count-bytes
 204                  * case if the file is seekable.  If you do though, remember that
 205                  * starting file position may not be the beginning of the file.
 206                  * Beware of backing up too far.  See example in wc.c.
 207                  */
 208                 if ((!(count|from_top)) && (lseek(fds[i], 0, SEEK_END) >= 0)) {
 209                         continue;
 210                 }
 211
 212                 if (nfiles > header_threshhold) {
 213                         tail_xprint_header(fmt, argv[i]);
 214                         fmt = header_fmt;
 215                 }
 216
 217                 buf = tailbuf;
 218                 taillen = 0;
 219                 seen = 1;
 220                 newline = 0;
 221
 222                 while ((nread = tail_read(fds[i], buf, tailbufsize-taillen)) > 0) {
 223                         if (from_top) {
 224                                 nwrite = nread;
 225                                 if (seen < count) {
 226                                         if (count_bytes) {
 227                                                 nwrite -= (count - seen);
 228                                                 seen = count;
 229                                         } else {
 230                                                 s = buf;
 231                                                 do {
 232                                                         --nwrite;
 233                                                         if ((*s++ == '\n') && (++seen == count)) {
 234                                                                 break;
 235                                                         }
 236                                                 } while (nwrite);
 237                                         }
 238                                 }
 239                                 tail_xbb_full_write(buf + nread - nwrite, nwrite);
 240                         } else if (count) {
 241                                 if (count_bytes) {
 242                                         taillen += nread;
 243                                         if (taillen > count) {
 244                                                 memmove(tailbuf, tailbuf + taillen - count, count);
 245                                                 taillen = count;
 246                                         }
 247                                 } else {
 248                                         int k = nread;
 249                                         int nbuf = 0;
 250
 251                                         while (k) {
 252                                                 --k;
 253                                                 if (buf[k] == '\n') {
 254                                                         ++nbuf;
 255                                                 }
 256                                         }
 257
 258                                         if (newline + nbuf < count) {
 259                                                 newline += nbuf;
 260                                                 taillen += nread;
 261
 262                                         } else {
 263                                                 int extra = 0;
 264                                                 if (buf[nread-1] != '\n') {
 265                                                         extra = 1;
 266                                                 }
 267
 268                                                 k = newline + nbuf + extra - count;
 269                                                 s = tailbuf;
 270                                                 while (k) {
 271                                                         if (*s == '\n') {
 272                                                                 --k;
 273                                                         }
 274                                                         ++s;
 275                                                 }
 276
 277                                                 taillen += nread - (s - tailbuf);
 278                                                 memmove(tailbuf, s, taillen);
 279                                                 newline = count - extra;
 280                                         }
 281                                         if (tailbufsize < taillen + BUFSIZ) {
 282                                                 tailbufsize = taillen + BUFSIZ;
 283                                                 tailbuf = xrealloc(tailbuf, tailbufsize);
 284                                         }
 285                                 }
 286                                 buf = tailbuf + taillen;
 287                         }
 288                 }
 289
 290                 if (!from_top) {
 291                         tail_xbb_full_write(tailbuf, taillen);
 292                 }
 293
 294                 taillen = 0;
 295         } while (++i < nfiles);
 296
 297         buf = xrealloc(tailbuf, BUFSIZ);
 298
 299         fmt = NULL;
 300
 301         while (follow) {
 302                 sleep(sleep_period);
 303                 i = 0;
 304                 do {
 305                         if (nfiles > header_threshhold) {
 306                                 fmt = header_fmt;
 307                         }
 308                         while ((nread = tail_read(fds[i], buf, sizeof(buf))) > 0) {
 309                                 if (fmt) {
 310                                         tail_xprint_header(fmt, argv[i]);
 311                                         fmt = NULL;
 312                                 }
 313                                 tail_xbb_full_write(buf, nread);
 314                         }
 315                 } while (++i < nfiles);
 316         }
 317
 318         return status;
 319 }