Initial public busybox upstream commit
[busybox4maemo] / 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 "libbb.h"
28
29 static const struct suffix_mult tail_suffixes[] = {
30         { "b", 512 },
31         { "k", 1024 },
32         { "m", 1024*1024 },
33         { }
34 };
35
36 struct globals {
37         bool status;
38 };
39 #define G (*(struct globals*)&bb_common_bufsiz1)
40
41 static void tail_xprint_header(const char *fmt, const char *filename)
42 {
43         if (fdprintf(STDOUT_FILENO, fmt, filename) < 0)
44                 bb_perror_nomsg_and_die();
45 }
46
47 static ssize_t tail_read(int fd, char *buf, size_t count)
48 {
49         ssize_t r;
50         off_t current;
51         struct stat sbuf;
52
53         /* (A good comment is missing here) */
54         current = lseek(fd, 0, SEEK_CUR);
55         /* /proc files report zero st_size, don't lseek them. */
56         if (fstat(fd, &sbuf) == 0 && sbuf.st_size)
57                 if (sbuf.st_size < current)
58                         lseek(fd, 0, SEEK_SET);
59
60         r = full_read(fd, buf, count);
61         if (r < 0) {
62                 bb_perror_msg(bb_msg_read_error);
63                 G.status = EXIT_FAILURE;
64         }
65
66         return r;
67 }
68
69 static const char header_fmt[] ALIGN1 = "\n==> %s <==\n";
70
71 static unsigned eat_num(const char *p)
72 {
73         if (*p == '-')
74                 p++;
75         else if (*p == '+') {
76                 p++;
77                 G.status = 1; /* mark that we saw "+" */
78         }
79         return xatou_sfx(p, tail_suffixes);
80 }
81
82 int tail_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
83 int tail_main(int argc, char **argv)
84 {
85         unsigned count = 10;
86         unsigned sleep_period = 1;
87         bool from_top;
88         int header_threshhold = 1;
89         const char *str_c, *str_n;
90
91         char *tailbuf;
92         size_t tailbufsize;
93         int taillen = 0;
94         int newlines_seen = 0;
95         int nfiles, nread, nwrite, seen, i, opt;
96
97         int *fds;
98         char *s, *buf;
99         const char *fmt;
100
101 #if ENABLE_INCLUDE_SUSv2 || ENABLE_FEATURE_FANCY_TAIL
102         /* Allow legacy syntax of an initial numeric option without -n. */
103         if (argv[1] && (argv[1][0] == '+' || argv[1][0] == '-')
104          && isdigit(argv[1][1])
105         ) {
106                 count = eat_num(&argv[1][1]);
107                 argv++;
108                 argc--;
109         }
110 #endif
111
112         USE_FEATURE_FANCY_TAIL(opt_complementary = "s+";) /* -s N */
113         opt = getopt32(argv, "fc:n:" USE_FEATURE_FANCY_TAIL("qs:v"),
114                         &str_c, &str_n USE_FEATURE_FANCY_TAIL(,&sleep_period));
115 #define FOLLOW (opt & 0x1)
116 #define COUNT_BYTES (opt & 0x2)
117         //if (opt & 0x1) // -f
118         if (opt & 0x2) count = eat_num(str_c); // -c
119         if (opt & 0x4) count = eat_num(str_n); // -n
120 #if ENABLE_FEATURE_FANCY_TAIL
121         if (opt & 0x8) header_threshhold = INT_MAX; // -q
122         if (opt & 0x20) header_threshhold = 0; // -v
123 #endif
124         argc -= optind;
125         argv += optind;
126         from_top = G.status; /* 1 if there was "-c +N" or "-n +N" */
127         G.status = EXIT_SUCCESS;
128
129         /* open all the files */
130         fds = xmalloc(sizeof(int) * (argc + 1));
131         if (!argv[0]) {
132                 struct stat statbuf;
133
134                 if (!fstat(STDIN_FILENO, &statbuf) && S_ISFIFO(statbuf.st_mode)) {
135                         opt &= ~1; /* clear FOLLOW */
136                 }
137                 *argv = (char *) bb_msg_standard_input;
138         }
139         nfiles = i = 0;
140         do {
141                 int fd = open_or_warn_stdin(argv[i]);
142                 if (fd < 0) {
143                         G.status = EXIT_FAILURE;
144                         continue;
145                 }
146                 fds[nfiles] = fd;
147                 argv[nfiles++] = argv[i];
148         } while (++i < argc);
149
150         if (!nfiles)
151                 bb_error_msg_and_die("no files");
152
153         /* prepare the buffer */
154         tailbufsize = BUFSIZ;
155         if (!from_top && COUNT_BYTES) {
156                 if (tailbufsize < count + BUFSIZ) {
157                         tailbufsize = count + BUFSIZ;
158                 }
159         }
160         tailbuf = xmalloc(tailbufsize);
161
162         /* tail the files */
163         fmt = header_fmt + 1;   /* Skip header leading newline on first output. */
164         i = 0;
165         do {
166                 if (nfiles > header_threshhold) {
167                         tail_xprint_header(fmt, argv[i]);
168                         fmt = header_fmt;
169                 }
170
171                 /* Optimizing count-bytes case if the file is seekable.
172                  * Beware of backing up too far.
173                  * Also we exclude files with size 0 (because of /proc/xxx) */
174                 if (COUNT_BYTES && !from_top) {
175                         off_t current = lseek(fds[i], 0, SEEK_END);
176                         if (current > 0) {
177                                 if (count == 0)
178                                         continue; /* showing zero lines is easy :) */
179                                 current -= count;
180                                 if (current < 0)
181                                         current = 0;
182                                 xlseek(fds[i], current, SEEK_SET);
183                                 bb_copyfd_size(fds[i], STDOUT_FILENO, count);
184                                 continue;
185                         }
186                 }
187
188                 buf = tailbuf;
189                 taillen = 0;
190                 seen = 1;
191                 newlines_seen = 0;
192                 while ((nread = tail_read(fds[i], buf, tailbufsize-taillen)) > 0) {
193                         if (from_top) {
194                                 nwrite = nread;
195                                 if (seen < count) {
196                                         if (COUNT_BYTES) {
197                                                 nwrite -= (count - seen);
198                                                 seen = count;
199                                         } else {
200                                                 s = buf;
201                                                 do {
202                                                         --nwrite;
203                                                         if (*s++ == '\n' && ++seen == count) {
204                                                                 break;
205                                                         }
206                                                 } while (nwrite);
207                                         }
208                                 }
209                                 xwrite(STDOUT_FILENO, buf + nread - nwrite, nwrite);
210                         } else if (count) {
211                                 if (COUNT_BYTES) {
212                                         taillen += nread;
213                                         if (taillen > count) {
214                                                 memmove(tailbuf, tailbuf + taillen - count, count);
215                                                 taillen = count;
216                                         }
217                                 } else {
218                                         int k = nread;
219                                         int newlines_in_buf = 0;
220
221                                         do { /* count '\n' in last read */
222                                                 k--;
223                                                 if (buf[k] == '\n') {
224                                                         newlines_in_buf++;
225                                                 }
226                                         } while (k);
227
228                                         if (newlines_seen + newlines_in_buf < count) {
229                                                 newlines_seen += newlines_in_buf;
230                                                 taillen += nread;
231                                         } else {
232                                                 int extra = (buf[nread-1] != '\n');
233
234                                                 k = newlines_seen + newlines_in_buf + extra - count;
235                                                 s = tailbuf;
236                                                 while (k) {
237                                                         if (*s == '\n') {
238                                                                 k--;
239                                                         }
240                                                         s++;
241                                                 }
242                                                 taillen += nread - (s - tailbuf);
243                                                 memmove(tailbuf, s, taillen);
244                                                 newlines_seen = count - extra;
245                                         }
246                                         if (tailbufsize < taillen + BUFSIZ) {
247                                                 tailbufsize = taillen + BUFSIZ;
248                                                 tailbuf = xrealloc(tailbuf, tailbufsize);
249                                         }
250                                 }
251                                 buf = tailbuf + taillen;
252                         }
253                 } /* while (tail_read() > 0) */
254                 if (!from_top) {
255                         xwrite(STDOUT_FILENO, tailbuf, taillen);
256                 }
257         } while (++i < nfiles);
258
259         buf = xrealloc(tailbuf, BUFSIZ);
260
261         fmt = NULL;
262
263         if (FOLLOW) while (1) {
264                 sleep(sleep_period);
265                 i = 0;
266                 do {
267                         if (nfiles > header_threshhold) {
268                                 fmt = header_fmt;
269                         }
270                         while ((nread = tail_read(fds[i], buf, BUFSIZ)) > 0) {
271                                 if (fmt) {
272                                         tail_xprint_header(fmt, argv[i]);
273                                         fmt = NULL;
274                                 }
275                                 xwrite(STDOUT_FILENO, buf, nread);
276                         }
277                 } while (++i < nfiles);
278         }
279         if (ENABLE_FEATURE_CLEAN_UP) {
280                 free(fds);
281         }
282         return G.status;
283 }