1 /* tail -- output the last part of file(s)
2 Copyright (C) 1989-2024 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <https://www.gnu.org/licenses/>. */
17 /* Can display any amount of data, unlike the Unix version, which uses
18 a fixed size buffer and therefore can only deliver a limited number
21 Original version by Paul Rubin <phr@ocf.berkeley.edu>.
22 Extensions by David MacKenzie <djm@gnu.ai.mit.edu>.
23 tail -f for multiple files by Ian Lance Taylor <ian@airs.com>.
24 inotify back-end by Giuseppe Scrivano <gscrivano@gnu.org>. */
30 #include <sys/types.h>
36 #include "cl-strtod.h"
42 #include "safe-read.h"
43 #include "stat-size.h"
44 #include "stat-time.h"
45 #include "xbinary-io.h"
46 #include "xdectoint.h"
47 #include "xnanosleep.h"
54 # include <sys/inotify.h>
57 /* Linux can optimize the handling of local files. */
58 #if defined __linux__ || defined __ANDROID__
60 # include "fs-is-local.h"
61 # if HAVE_SYS_STATFS_H
62 # include <sys/statfs.h>
68 /* The official name of this program (e.g., no 'g' prefix). */
69 #define PROGRAM_NAME "tail"
72 proper_name ("Paul Rubin"), \
73 proper_name ("David MacKenzie"), \
74 proper_name ("Ian Lance Taylor"), \
75 proper_name ("Jim Meyering")
77 /* Number of items to tail. */
78 #define DEFAULT_N_LINES 10
80 /* Special values for dump_remainder's N_BYTES parameter. */
81 #define COPY_TO_EOF UINTMAX_MAX
82 #define COPY_A_BUFFER (UINTMAX_MAX - 1)
84 /* FIXME: make Follow_name the default? */
85 #define DEFAULT_FOLLOW_MODE Follow_descriptor
89 /* Follow the name of each file: if the file is renamed, try to reopen
90 that name and track the end of the new file if/when it's recreated.
91 This is useful for tracking logs that are occasionally rotated. */
94 /* Follow each descriptor obtained upon opening a file.
95 That means we'll continue to follow the end of a file even after
96 it has been renamed or unlinked. */
100 /* The types of files for which tail works. */
101 #define IS_TAILABLE_FILE_TYPE(Mode) \
102 (S_ISREG (Mode) || S_ISFIFO (Mode) || S_ISSOCK (Mode) || S_ISCHR (Mode))
104 static char const *const follow_mode_string
[] =
106 "descriptor", "name", nullptr
109 static enum Follow_mode
const follow_mode_map
[] =
111 Follow_descriptor
, Follow_name
,
116 /* The actual file name, or "-" for stdin. */
119 /* Attributes of the file the last time we checked. */
121 struct timespec mtime
;
126 /* The specified name initially referred to a directory or some other
127 type for which tail isn't meaningful. Unlike for a permission problem
128 (tailable, below) once this is set, the name is not checked ever again. */
131 /* See the description of fremote. */
134 /* A file is tailable if it exists, is readable, and is of type
135 IS_TAILABLE_FILE_TYPE. */
138 /* File descriptor on which the file is open; -1 if it's not open. */
141 /* The value of errno seen last time we checked this file. */
144 /* 1 if O_NONBLOCK is clear, 0 if set, -1 if not known. */
148 /* The watch descriptor used by inotify. */
151 /* The parent directory watch descriptor. It is used only
152 * when Follow_name is used. */
155 /* Offset in NAME of the basename part. */
156 size_t basename_start
;
159 /* See description of DEFAULT_MAX_N_... below. */
160 uintmax_t n_unchanged_stats
;
163 /* Keep trying to open a file even if it is inaccessible when tail starts
164 or if it becomes inaccessible later -- useful only with -f. */
165 static bool reopen_inaccessible_files
;
167 /* If true, interpret the numeric argument as the number of lines.
168 Otherwise, interpret it as the number of bytes. */
169 static bool count_lines
;
171 /* Whether we follow the name of each file or the file descriptor
172 that is initially associated with each name. */
173 static enum Follow_mode follow_mode
= Follow_descriptor
;
175 /* If true, read from the ends of all specified files until killed. */
178 /* If true, monitor output so we exit if pipe reader terminates. */
179 static bool monitor_output
;
181 /* If true, count from start of file instead of end. */
182 static bool from_start
;
184 /* If true, print filename headers. */
185 static bool print_headers
;
187 /* Character to split lines by. */
188 static char line_end
;
190 /* When to print the filename banners. */
193 multiple_files
, always
, never
196 /* When tailing a file by name, if there have been this many consecutive
197 iterations for which the file has not changed, then open/fstat
198 the file to determine if that file name is still associated with the
199 same device/inode-number pair as before. This option is meaningful only
200 when following by name. --max-unchanged-stats=N */
201 #define DEFAULT_MAX_N_UNCHANGED_STATS_BETWEEN_OPENS 5
202 static uintmax_t max_n_unchanged_stats_between_opens
=
203 DEFAULT_MAX_N_UNCHANGED_STATS_BETWEEN_OPENS
;
205 /* The process IDs of the processes to watch (those writing the followed
206 files, or perhaps other processes the user cares about). */
207 static int nbpids
= 0;
208 static pid_t
* pids
= nullptr;
209 static idx_t pids_alloc
;
211 /* Used to determine the buffer size when scanning backwards in a file. */
212 static idx_t page_size
;
214 /* True if we have ever read standard input. */
215 static bool have_read_stdin
;
217 /* If nonzero, skip the is-regular-file test used to determine whether
218 to use the lseek optimization. Instead, use the more general (and
219 more expensive) code unconditionally. Intended solely for testing. */
220 static bool presume_input_pipe
;
222 /* If nonzero then don't use inotify even if available. */
223 static bool disable_inotify
;
225 /* For long options that have no equivalent short option, use a
226 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
229 RETRY_OPTION
= CHAR_MAX
+ 1,
230 MAX_UNCHANGED_STATS_OPTION
,
232 PRESUME_INPUT_PIPE_OPTION
,
234 DISABLE_INOTIFY_OPTION
237 static struct option
const long_options
[] =
239 {"bytes", required_argument
, nullptr, 'c'},
240 {"follow", optional_argument
, nullptr, LONG_FOLLOW_OPTION
},
241 {"lines", required_argument
, nullptr, 'n'},
242 {"max-unchanged-stats", required_argument
, nullptr,
243 MAX_UNCHANGED_STATS_OPTION
},
244 {"-disable-inotify", no_argument
, nullptr,
245 DISABLE_INOTIFY_OPTION
}, /* do not document */
246 {"pid", required_argument
, nullptr, PID_OPTION
},
247 {"-presume-input-pipe", no_argument
, nullptr,
248 PRESUME_INPUT_PIPE_OPTION
}, /* do not document */
249 {"quiet", no_argument
, nullptr, 'q'},
250 {"retry", no_argument
, nullptr, RETRY_OPTION
},
251 {"silent", no_argument
, nullptr, 'q'},
252 {"sleep-interval", required_argument
, nullptr, 's'},
253 {"verbose", no_argument
, nullptr, 'v'},
254 {"zero-terminated", no_argument
, nullptr, 'z'},
255 {GETOPT_HELP_OPTION_DECL
},
256 {GETOPT_VERSION_OPTION_DECL
},
257 {nullptr, 0, nullptr, 0}
263 if (status
!= EXIT_SUCCESS
)
268 Usage: %s [OPTION]... [FILE]...\n\
272 Print the last %d lines of each FILE to standard output.\n\
273 With more than one FILE, precede each with a header giving the file name.\n\
274 "), DEFAULT_N_LINES
);
277 emit_mandatory_arg_note ();
280 -c, --bytes=[+]NUM output the last NUM bytes; or use -c +NUM to\n\
281 output starting with byte NUM of each file\n\
284 -f, --follow[={name|descriptor}]\n\
285 output appended data as the file grows;\n\
286 an absent option argument means 'descriptor'\n\
287 -F same as --follow=name --retry\n\
290 -n, --lines=[+]NUM output the last NUM lines, instead of the last %d;\n\
291 or use -n +NUM to skip NUM-1 lines at the start\n\
296 --max-unchanged-stats=N\n\
297 with --follow=name, reopen a FILE which has not\n\
298 changed size after N (default %d) iterations\n\
299 to see if it has been unlinked or renamed\n\
300 (this is the usual case of rotated log files);\n\
301 with inotify, this option is rarely useful\n\
303 DEFAULT_MAX_N_UNCHANGED_STATS_BETWEEN_OPENS
306 --pid=PID with -f, terminate after process ID, PID dies;\n\
307 can be repeated to watch multiple processes\n\
308 -q, --quiet, --silent never output headers giving file names\n\
309 --retry keep trying to open a file if it is inaccessible\n\
312 -s, --sleep-interval=N with -f, sleep for approximately N seconds\n\
313 (default 1.0) between iterations;\n\
314 with inotify and --pid=P, check process P at\n\
315 least once every N seconds\n\
316 -v, --verbose always output headers giving file names\n\
319 -z, --zero-terminated line delimiter is NUL, not newline\n\
321 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
322 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
325 NUM may have a multiplier suffix:\n\
326 b 512, kB 1000, K 1024, MB 1000*1000, M 1024*1024,\n\
327 GB 1000*1000*1000, G 1024*1024*1024, and so on for T, P, E, Z, Y, R, Q.\n\
328 Binary prefixes can be used, too: KiB=K, MiB=M, and so on.\n\
332 With --follow (-f), tail defaults to following the file descriptor, which\n\
333 means that even if a tail'ed file is renamed, tail will continue to track\n\
334 its end. This default behavior is not desirable when you really want to\n\
335 track the actual name of the file, not the file descriptor (e.g., log\n\
336 rotation). Use --follow=name in that case. That causes tail to track the\n\
337 named file in a way that accommodates renaming, removal and creation.\n\
339 emit_ancillary_info (PROGRAM_NAME
);
344 /* Ensure exit, either with SIGPIPE or EXIT_FAILURE status. */
352 /* If the output has gone away, then terminate
353 as we would if we had written to this output. */
355 check_output_alive (void)
357 if (! monitor_output
)
360 if (iopoll (-1, STDOUT_FILENO
, false) == IOPOLL_BROKEN_OUTPUT
)
364 MAYBE_UNUSED
static bool
365 valid_file_spec (struct File_spec
const *f
)
367 /* Exactly one of the following subexpressions must be true. */
368 return ((f
->fd
== -1) ^ (f
->errnum
== 0));
372 pretty_name (struct File_spec
const *f
)
374 return (STREQ (f
->name
, "-") ? _("standard input") : f
->name
);
377 /* Record a file F with descriptor FD, size SIZE, status ST, and
378 blocking status BLOCKING. */
381 record_open_fd (struct File_spec
*f
, int fd
,
382 off_t size
, struct stat
const *st
,
387 f
->mtime
= get_stat_mtime (st
);
390 f
->mode
= st
->st_mode
;
391 f
->blocking
= blocking
;
392 f
->n_unchanged_stats
= 0;
396 /* Close the file with descriptor FD and name FILENAME. */
399 close_fd (int fd
, char const *filename
)
401 if (fd
!= -1 && fd
!= STDIN_FILENO
&& close (fd
))
403 error (0, errno
, _("closing %s (fd=%d)"), quoteaf (filename
), fd
);
408 write_header (char const *pretty_filename
)
410 static bool first_file
= true;
412 printf ("%s==> %s <==\n", (first_file
? "" : "\n"), pretty_filename
);
416 /* Write N_BYTES from BUFFER to stdout.
417 Exit immediately on error with a single diagnostic. */
420 xwrite_stdout (char const *buffer
, size_t n_bytes
)
422 if (n_bytes
> 0 && fwrite (buffer
, 1, n_bytes
, stdout
) < n_bytes
)
424 clearerr (stdout
); /* To avoid redundant close_stdout diagnostic. */
425 error (EXIT_FAILURE
, errno
, _("error writing %s"),
426 quoteaf ("standard output"));
430 /* Read and output N_BYTES of file PRETTY_FILENAME starting at the current
431 position in FD. If N_BYTES is COPY_TO_EOF, then copy until end of file.
432 If N_BYTES is COPY_A_BUFFER, then copy at most one buffer's worth.
433 Return the number of bytes read from the file. */
436 dump_remainder (bool want_header
, char const *pretty_filename
, int fd
,
440 uintmax_t n_remaining
= n_bytes
;
446 size_t n
= MIN (n_remaining
, BUFSIZ
);
447 size_t bytes_read
= safe_read (fd
, buffer
, n
);
448 if (bytes_read
== SAFE_READ_ERROR
)
451 error (EXIT_FAILURE
, errno
, _("error reading %s"),
452 quoteaf (pretty_filename
));
459 write_header (pretty_filename
);
462 xwrite_stdout (buffer
, bytes_read
);
463 n_written
+= bytes_read
;
464 if (n_bytes
!= COPY_TO_EOF
)
466 n_remaining
-= bytes_read
;
467 if (n_remaining
== 0 || n_bytes
== COPY_A_BUFFER
)
475 /* Call lseek with the specified arguments, where file descriptor FD
476 corresponds to the file, FILENAME.
477 Give a diagnostic and exit nonzero if lseek fails.
478 Otherwise, return the resulting offset. */
481 xlseek (int fd
, off_t offset
, int whence
, char const *filename
)
483 off_t new_offset
= lseek (fd
, offset
, whence
);
491 error (EXIT_FAILURE
, errno
, _("%s: cannot seek to offset %jd"),
492 quotef (filename
), (intmax_t) offset
);
495 error (EXIT_FAILURE
, errno
, _("%s: cannot seek to relative offset %jd"),
496 quotef (filename
), (intmax_t) offset
);
499 error (EXIT_FAILURE
, errno
,
500 _("%s: cannot seek to end-relative offset %jd"),
501 quotef (filename
), (intmax_t) offset
);
508 /* Print the last N_LINES lines from the end of file FD.
509 Go backward through the file, reading 'BUFSIZ' bytes at a time (except
510 probably the first), until we hit the start of the file or have
511 read NUMBER newlines.
512 START_POS is the starting position of the read pointer for the file
513 associated with FD (may be nonzero).
514 END_POS is the file offset of EOF (one larger than offset of last byte).
515 Return true if successful. */
518 file_lines (char const *pretty_filename
, int fd
, struct stat
const *sb
,
519 uintmax_t n_lines
, off_t start_pos
, off_t end_pos
,
524 blksize_t bufsize
= BUFSIZ
;
531 /* Be careful with files with sizes that are a multiple of the page size,
532 as on /proc or /sys file systems these files accept seeking to within
533 the file, but then return no data when read. So use a buffer that's
534 at least PAGE_SIZE to avoid seeking within such files.
536 We could also indirectly use a large enough buffer through io_blksize()
537 however this would be less efficient in the common case, as it would
538 generally pick a larger buffer size, resulting in reading more data
539 from the end of the file. */
540 affirm (S_ISREG (sb
->st_mode
));
541 if (sb
->st_size
% page_size
== 0)
542 bufsize
= MAX (BUFSIZ
, page_size
);
544 buffer
= xmalloc (bufsize
);
546 /* Set 'bytes_read' to the size of the last, probably partial, buffer;
547 0 < 'bytes_read' <= 'bufsize'. */
548 bytes_read
= (pos
- start_pos
) % bufsize
;
550 bytes_read
= bufsize
;
551 /* Make 'pos' a multiple of 'bufsize' (0 if the file is short), so that all
552 reads will be on block boundaries, which might increase efficiency. */
554 xlseek (fd
, pos
, SEEK_SET
, pretty_filename
);
555 bytes_read
= safe_read (fd
, buffer
, bytes_read
);
556 if (bytes_read
== SAFE_READ_ERROR
)
558 error (0, errno
, _("error reading %s"), quoteaf (pretty_filename
));
562 *read_pos
= pos
+ bytes_read
;
564 /* Count the incomplete line on files that don't end with a newline. */
565 if (bytes_read
&& buffer
[bytes_read
- 1] != line_end
)
570 /* Scan backward, counting the newlines in this bufferfull. */
572 size_t n
= bytes_read
;
576 nl
= memrchr (buffer
, line_end
, n
);
582 /* If this newline isn't the last character in the buffer,
583 output the part that is after it. */
584 xwrite_stdout (nl
+ 1, bytes_read
- (n
+ 1));
585 *read_pos
+= dump_remainder (false, pretty_filename
, fd
,
586 end_pos
- (pos
+ bytes_read
));
591 /* Not enough newlines in that bufferfull. */
592 if (pos
== start_pos
)
594 /* Not enough lines in the file; print everything from
595 start_pos to the end. */
596 xlseek (fd
, start_pos
, SEEK_SET
, pretty_filename
);
597 *read_pos
= start_pos
+ dump_remainder (false, pretty_filename
, fd
,
602 xlseek (fd
, pos
, SEEK_SET
, pretty_filename
);
604 bytes_read
= safe_read (fd
, buffer
, bufsize
);
605 if (bytes_read
== SAFE_READ_ERROR
)
607 error (0, errno
, _("error reading %s"), quoteaf (pretty_filename
));
612 *read_pos
= pos
+ bytes_read
;
614 while (bytes_read
> 0);
621 /* Print the last N_LINES lines from the end of the standard input,
622 open for reading as pipe FD.
623 Buffer the text as a linked list of LBUFFERs, adding them as needed.
624 Return true if successful. */
627 pipe_lines (char const *pretty_filename
, int fd
, uintmax_t n_lines
,
635 struct linebuffer
*next
;
637 typedef struct linebuffer LBUFFER
;
638 LBUFFER
*first
, *last
, *tmp
;
639 size_t total_lines
= 0; /* Total number of newlines in all buffers. */
641 size_t n_read
; /* Size in bytes of most recent read */
643 first
= last
= xmalloc (sizeof (LBUFFER
));
644 first
->nbytes
= first
->nlines
= 0;
645 first
->next
= nullptr;
646 tmp
= xmalloc (sizeof (LBUFFER
));
648 /* Input is always read into a fresh buffer. */
651 n_read
= safe_read (fd
, tmp
->buffer
, BUFSIZ
);
652 if (n_read
== 0 || n_read
== SAFE_READ_ERROR
)
654 tmp
->nbytes
= n_read
;
659 /* Count the number of newlines just read. */
661 char const *buffer_end
= tmp
->buffer
+ n_read
;
662 char const *p
= tmp
->buffer
;
663 while ((p
= memchr (p
, line_end
, buffer_end
- p
)))
669 total_lines
+= tmp
->nlines
;
671 /* If there is enough room in the last buffer read, just append the new
672 one to it. This is because when reading from a pipe, 'n_read' can
673 often be very small. */
674 if (tmp
->nbytes
+ last
->nbytes
< BUFSIZ
)
676 memcpy (&last
->buffer
[last
->nbytes
], tmp
->buffer
, tmp
->nbytes
);
677 last
->nbytes
+= tmp
->nbytes
;
678 last
->nlines
+= tmp
->nlines
;
682 /* If there's not enough room, link the new buffer onto the end of
683 the list, then either free up the oldest buffer for the next
684 read if that would leave enough lines, or else malloc a new one.
685 Some compaction mechanism is possible but probably not
687 last
= last
->next
= tmp
;
688 if (total_lines
- first
->nlines
> n_lines
)
691 total_lines
-= first
->nlines
;
695 tmp
= xmalloc (sizeof (LBUFFER
));
701 if (n_read
== SAFE_READ_ERROR
)
703 error (0, errno
, _("error reading %s"), quoteaf (pretty_filename
));
708 /* If the file is empty, then bail out. */
709 if (last
->nbytes
== 0)
712 /* This prevents a core dump when the pipe contains no newlines. */
716 /* Count the incomplete line on files that don't end with a newline. */
717 if (last
->buffer
[last
->nbytes
- 1] != line_end
)
723 /* Run through the list, printing lines. First, skip over unneeded
725 for (tmp
= first
; total_lines
- tmp
->nlines
> n_lines
; tmp
= tmp
->next
)
726 total_lines
-= tmp
->nlines
;
728 /* Find the correct beginning, then print the rest of the file. */
730 char const *beg
= tmp
->buffer
;
731 char const *buffer_end
= tmp
->buffer
+ tmp
->nbytes
;
732 if (total_lines
> n_lines
)
734 /* Skip 'total_lines' - 'n_lines' newlines. We made sure that
735 'total_lines' - 'n_lines' <= 'tmp->nlines'. */
737 for (j
= total_lines
- n_lines
; j
; --j
)
739 beg
= rawmemchr (beg
, line_end
);
744 xwrite_stdout (beg
, buffer_end
- beg
);
747 for (tmp
= tmp
->next
; tmp
; tmp
= tmp
->next
)
748 xwrite_stdout (tmp
->buffer
, tmp
->nbytes
);
760 /* Print the last N_BYTES characters from the end of FD.
761 Work even if the input is a pipe.
762 This is a stripped down version of pipe_lines.
763 Return true if successful. */
766 pipe_bytes (char const *pretty_filename
, int fd
, uintmax_t n_bytes
,
773 struct charbuffer
*next
;
775 typedef struct charbuffer CBUFFER
;
776 CBUFFER
*first
, *last
, *tmp
;
777 size_t i
; /* Index into buffers. */
778 size_t total_bytes
= 0; /* Total characters in all buffers. */
782 first
= last
= xmalloc (sizeof (CBUFFER
));
784 first
->next
= nullptr;
785 tmp
= xmalloc (sizeof (CBUFFER
));
787 /* Input is always read into a fresh buffer. */
790 n_read
= safe_read (fd
, tmp
->buffer
, BUFSIZ
);
791 if (n_read
== 0 || n_read
== SAFE_READ_ERROR
)
794 tmp
->nbytes
= n_read
;
797 total_bytes
+= tmp
->nbytes
;
798 /* If there is enough room in the last buffer read, just append the new
799 one to it. This is because when reading from a pipe, 'nbytes' can
800 often be very small. */
801 if (tmp
->nbytes
+ last
->nbytes
< BUFSIZ
)
803 memcpy (&last
->buffer
[last
->nbytes
], tmp
->buffer
, tmp
->nbytes
);
804 last
->nbytes
+= tmp
->nbytes
;
808 /* If there's not enough room, link the new buffer onto the end of
809 the list, then either free up the oldest buffer for the next
810 read if that would leave enough characters, or else malloc a new
811 one. Some compaction mechanism is possible but probably not
813 last
= last
->next
= tmp
;
814 if (total_bytes
- first
->nbytes
> n_bytes
)
817 total_bytes
-= first
->nbytes
;
822 tmp
= xmalloc (sizeof (CBUFFER
));
829 if (n_read
== SAFE_READ_ERROR
)
831 error (0, errno
, _("error reading %s"), quoteaf (pretty_filename
));
836 /* Run through the list, printing characters. First, skip over unneeded
838 for (tmp
= first
; total_bytes
- tmp
->nbytes
> n_bytes
; tmp
= tmp
->next
)
839 total_bytes
-= tmp
->nbytes
;
841 /* Find the correct beginning, then print the rest of the file.
842 We made sure that 'total_bytes' - 'n_bytes' <= 'tmp->nbytes'. */
843 if (total_bytes
> n_bytes
)
844 i
= total_bytes
- n_bytes
;
847 xwrite_stdout (&tmp
->buffer
[i
], tmp
->nbytes
- i
);
849 for (tmp
= tmp
->next
; tmp
; tmp
= tmp
->next
)
850 xwrite_stdout (tmp
->buffer
, tmp
->nbytes
);
862 /* Skip N_BYTES characters from the start of pipe FD, and print
863 any extra characters that were read beyond that.
864 Return 1 on error, 0 if ok, -1 if EOF. */
867 start_bytes (char const *pretty_filename
, int fd
, uintmax_t n_bytes
,
874 size_t bytes_read
= safe_read (fd
, buffer
, BUFSIZ
);
877 if (bytes_read
== SAFE_READ_ERROR
)
879 error (0, errno
, _("error reading %s"), quoteaf (pretty_filename
));
882 *read_pos
+= bytes_read
;
883 if (bytes_read
<= n_bytes
)
884 n_bytes
-= bytes_read
;
887 size_t n_remaining
= bytes_read
- n_bytes
;
888 /* Print extra characters if there are any. */
889 xwrite_stdout (&buffer
[n_bytes
], n_remaining
);
897 /* Skip N_LINES lines at the start of file or pipe FD, and print
898 any extra characters that were read beyond that.
899 Return 1 on error, 0 if ok, -1 if EOF. */
902 start_lines (char const *pretty_filename
, int fd
, uintmax_t n_lines
,
911 size_t bytes_read
= safe_read (fd
, buffer
, BUFSIZ
);
912 if (bytes_read
== 0) /* EOF */
914 if (bytes_read
== SAFE_READ_ERROR
) /* error */
916 error (0, errno
, _("error reading %s"), quoteaf (pretty_filename
));
920 char *buffer_end
= buffer
+ bytes_read
;
922 *read_pos
+= bytes_read
;
925 while ((p
= memchr (p
, line_end
, buffer_end
- p
)))
931 xwrite_stdout (p
, buffer_end
- p
);
938 /* Return false when FD is open on a file residing on a local file system.
939 If fstatfs fails, give a diagnostic and return true.
940 If fstatfs cannot be called, return true. */
942 fremote (int fd
, char const *name
)
944 bool remote
= true; /* be conservative (poll by default). */
946 #if HAVE_FSTATFS && HAVE_STRUCT_STATFS_F_TYPE \
947 && (defined __linux__ || defined __ANDROID__)
949 int err
= fstatfs (fd
, &buf
);
952 /* On at least linux-2.6.38, fstatfs fails with ENOSYS when FD
953 is open on a pipe. Treat that like a remote file. */
955 error (0, errno
, _("cannot determine location of %s. "
956 "reverting to polling"), quoteaf (name
));
960 /* Treat unrecognized file systems as "remote", so caller polls.
961 Note README-release has instructions for syncing the internal
962 list with the latest Linux kernel file system constants. */
963 remote
= is_local_fs_type (buf
.f_type
) <= 0;
970 /* open/fstat F->name and handle changes. */
972 recheck (struct File_spec
*f
, bool blocking
)
974 struct stat new_stats
;
976 bool is_stdin
= (STREQ (f
->name
, "-"));
977 bool was_tailable
= f
->tailable
;
978 int prev_errnum
= f
->errnum
;
982 : open (f
->name
, O_RDONLY
| (blocking
? 0 : O_NONBLOCK
)));
984 affirm (valid_file_spec (f
));
986 /* If the open fails because the file doesn't exist,
987 then mark the file as not tailable. */
988 f
->tailable
= !(reopen_inaccessible_files
&& fd
== -1);
990 if (! disable_inotify
&& ! lstat (f
->name
, &new_stats
)
991 && S_ISLNK (new_stats
.st_mode
))
993 /* Diagnose the edge case where a regular file is changed
994 to a symlink. We avoid inotify with symlinks since
995 it's awkward to match between symlink name and target. */
1000 error (0, 0, _("%s has been replaced with an untailable symbolic link"),
1001 quoteaf (pretty_name (f
)));
1003 else if (fd
== -1 || fstat (fd
, &new_stats
) < 0)
1011 /* FIXME-maybe: detect the case in which the file first becomes
1012 unreadable (perms), and later becomes readable again and can
1013 be seen to be the same file (dev/ino). Otherwise, tail prints
1014 the entire contents of the file when it becomes readable. */
1015 error (0, f
->errnum
, _("%s has become inaccessible"),
1016 quoteaf (pretty_name (f
)));
1020 /* say nothing... it's still not tailable */
1023 else if (prev_errnum
!= errno
)
1024 error (0, errno
, "%s", quotef (pretty_name (f
)));
1026 else if (!IS_TAILABLE_FILE_TYPE (new_stats
.st_mode
))
1030 f
->tailable
= false;
1031 f
->ignore
= ! (reopen_inaccessible_files
&& follow_mode
== Follow_name
);
1032 if (was_tailable
|| prev_errnum
!= f
->errnum
)
1033 error (0, 0, _("%s has been replaced with an untailable file%s"),
1034 quoteaf (pretty_name (f
)),
1035 f
->ignore
? _("; giving up on this name") : "");
1037 else if ((f
->remote
= fremote (fd
, pretty_name (f
))) && ! disable_inotify
)
1041 error (0, 0, _("%s has been replaced with an untailable remote file"),
1042 quoteaf (pretty_name (f
)));
1054 close_fd (fd
, pretty_name (f
));
1055 close_fd (f
->fd
, pretty_name (f
));
1058 else if (prev_errnum
&& prev_errnum
!= ENOENT
)
1061 affirm (f
->fd
== -1);
1062 error (0, 0, _("%s has become accessible"), quoteaf (pretty_name (f
)));
1064 else if (f
->fd
== -1)
1066 /* A new file even when inodes haven't changed as <dev,inode>
1067 pairs can be reused, and we know the file was missing
1068 on the previous iteration. Note this also means the file
1069 is redisplayed in --follow=name mode if renamed away from
1070 and back to a monitored name. */
1074 _("%s has appeared; following new file"),
1075 quoteaf (pretty_name (f
)));
1077 else if (f
->ino
!= new_stats
.st_ino
|| f
->dev
!= new_stats
.st_dev
)
1079 /* File has been replaced (e.g., via log rotation) --
1080 tail the new one. */
1084 _("%s has been replaced; following new file"),
1085 quoteaf (pretty_name (f
)));
1087 /* Close the old one. */
1088 close_fd (f
->fd
, pretty_name (f
));
1093 /* No changes detected, so close new fd. */
1094 close_fd (fd
, pretty_name (f
));
1097 /* FIXME: When a log is rotated, daemons tend to log to the
1098 old file descriptor until the new file is present and
1099 the daemon is sent a signal. Therefore tail may miss entries
1100 being written to the old file. Perhaps we should keep
1101 the older file open and continue to monitor it until
1102 data is written to a new file. */
1105 /* Start at the beginning of the file. */
1106 record_open_fd (f
, fd
, 0, &new_stats
, (is_stdin
? -1 : blocking
));
1107 if (S_ISREG (new_stats
.st_mode
))
1108 xlseek (fd
, 0, SEEK_SET
, pretty_name (f
));
1112 /* Return true if any of the N_FILES files in F are live, i.e., have
1113 open file descriptors, or should be checked again (see --retry).
1114 When following descriptors, checking should only continue when any
1115 of the files is not yet ignored. */
1118 any_live_files (const struct File_spec
*f
, size_t n_files
)
1120 /* In inotify mode, ignore may be set for files
1121 which may later be replaced with new files.
1122 So always consider files live in -F mode. */
1123 if (reopen_inaccessible_files
&& follow_mode
== Follow_name
)
1126 for (size_t i
= 0; i
< n_files
; i
++)
1132 if (! f
[i
].ignore
&& reopen_inaccessible_files
)
1140 /* Determine whether all watched writers are dead.
1141 Returns true only if all processes' states can be determined,
1142 and all processes no longer exist. */
1145 writers_are_dead (void)
1150 for (int i
= 0; i
< nbpids
; i
++)
1152 if (kill (pids
[i
], 0) == 0 || errno
== EPERM
)
1159 /* Tail N_FILES files forever, or until killed.
1160 The pertinent information for each file is stored in an entry of F.
1161 Loop over each of them, doing an fstat to see if they have changed size,
1162 and an occasional open/fstat to see if any dev/ino pair has changed.
1163 If none of them have changed size in one iteration, sleep for a
1164 while and try again. Continue until the user interrupts us. */
1167 tail_forever (struct File_spec
*f
, size_t n_files
, double sleep_interval
)
1169 /* Use blocking I/O as an optimization, when it's easy. */
1170 bool blocking
= (!nbpids
&& follow_mode
== Follow_descriptor
1171 && n_files
== 1 && f
[0].fd
!= -1 && ! S_ISREG (f
[0].mode
));
1173 bool writers_dead
= false;
1180 bool any_input
= false;
1182 for (i
= 0; i
< n_files
; i
++)
1188 uintmax_t bytes_read
;
1195 recheck (&f
[i
], blocking
);
1200 name
= pretty_name (&f
[i
]);
1203 if (f
[i
].blocking
!= blocking
)
1205 int old_flags
= fcntl (fd
, F_GETFL
);
1206 int new_flags
= old_flags
| (blocking
? 0 : O_NONBLOCK
);
1208 || (new_flags
!= old_flags
1209 && fcntl (fd
, F_SETFL
, new_flags
) == -1))
1211 /* Don't update f[i].blocking if fcntl fails. */
1212 if (S_ISREG (f
[i
].mode
) && errno
== EPERM
)
1214 /* This happens when using tail -f on a file with
1215 the append-only attribute. */
1218 error (EXIT_FAILURE
, errno
,
1219 _("%s: cannot change nonblocking mode"),
1223 f
[i
].blocking
= blocking
;
1226 bool read_unchanged
= false;
1229 if (fstat (fd
, &stats
) != 0)
1232 f
[i
].errnum
= errno
;
1233 error (0, errno
, "%s", quotef (name
));
1234 close (fd
); /* ignore failure */
1238 if (f
[i
].mode
== stats
.st_mode
1239 && (! S_ISREG (stats
.st_mode
) || f
[i
].size
== stats
.st_size
)
1240 && timespec_cmp (f
[i
].mtime
, get_stat_mtime (&stats
)) == 0)
1242 if ((max_n_unchanged_stats_between_opens
1243 <= f
[i
].n_unchanged_stats
++)
1244 && follow_mode
== Follow_name
)
1246 recheck (&f
[i
], f
[i
].blocking
);
1247 f
[i
].n_unchanged_stats
= 0;
1249 if (fd
!= f
[i
].fd
|| S_ISREG (stats
.st_mode
) || 1 < n_files
)
1252 read_unchanged
= true;
1255 affirm (fd
== f
[i
].fd
);
1257 /* This file has changed. Print out what we can, and
1258 then keep looping. */
1260 f
[i
].mtime
= get_stat_mtime (&stats
);
1261 f
[i
].mode
= stats
.st_mode
;
1264 if (! read_unchanged
)
1265 f
[i
].n_unchanged_stats
= 0;
1267 /* XXX: This is only a heuristic, as the file may have also
1268 been truncated and written to if st_size >= size
1269 (in which case we ignore new data <= size). */
1270 if (S_ISREG (mode
) && stats
.st_size
< f
[i
].size
)
1272 error (0, 0, _("%s: file truncated"), quotef (name
));
1273 /* Assume the file was truncated to 0,
1274 and therefore output all "new" data. */
1275 xlseek (fd
, 0, SEEK_SET
, name
);
1282 write_header (name
);
1287 /* Don't read more than st_size on networked file systems
1288 because it was seen on glusterfs at least, that st_size
1289 may be smaller than the data read on a _subsequent_ stat call. */
1290 uintmax_t bytes_to_read
;
1292 bytes_to_read
= COPY_A_BUFFER
;
1293 else if (S_ISREG (mode
) && f
[i
].remote
)
1294 bytes_to_read
= stats
.st_size
- f
[i
].size
;
1296 bytes_to_read
= COPY_TO_EOF
;
1298 bytes_read
= dump_remainder (false, name
, fd
, bytes_to_read
);
1300 if (read_unchanged
&& bytes_read
)
1301 f
[i
].n_unchanged_stats
= 0;
1303 any_input
|= (bytes_read
!= 0);
1304 f
[i
].size
+= bytes_read
;
1307 if (! any_live_files (f
, n_files
))
1309 error (0, 0, _("no files remaining"));
1313 if ((!any_input
|| blocking
) && fflush (stdout
) != 0)
1316 check_output_alive ();
1318 /* If nothing was read, sleep and/or check for dead writers. */
1324 /* Once the writer is dead, read the files once more to
1325 avoid a race condition. */
1326 writers_dead
= writers_are_dead ();
1328 if (!writers_dead
&& xnanosleep (sleep_interval
))
1329 error (EXIT_FAILURE
, errno
, _("cannot read realtime clock"));
1337 /* Return true if any of the N_FILES files in F is remote, i.e., has
1338 an open file descriptor and is on a network file system. */
1341 any_remote_file (const struct File_spec
*f
, size_t n_files
)
1343 for (size_t i
= 0; i
< n_files
; i
++)
1344 if (0 <= f
[i
].fd
&& f
[i
].remote
)
1349 /* Return true if any of the N_FILES files in F is non remote, i.e., has
1350 an open file descriptor and is not on a network file system. */
1353 any_non_remote_file (const struct File_spec
*f
, size_t n_files
)
1355 for (size_t i
= 0; i
< n_files
; i
++)
1356 if (0 <= f
[i
].fd
&& ! f
[i
].remote
)
1361 /* Return true if any of the N_FILES files in F is a symlink.
1362 Note we don't worry about the edge case where "-" exists,
1363 since that will have the same consequences for inotify,
1364 which is the only context this function is currently used. */
1367 any_symlinks (const struct File_spec
*f
, size_t n_files
)
1370 for (size_t i
= 0; i
< n_files
; i
++)
1371 if (lstat (f
[i
].name
, &st
) == 0 && S_ISLNK (st
.st_mode
))
1376 /* Return true if any of the N_FILES files in F is not
1377 a regular file or fifo. This is used to avoid adding inotify
1378 watches on a device file for example, which inotify
1379 will accept, but not give any events for. */
1382 any_non_regular_fifo (const struct File_spec
*f
, size_t n_files
)
1384 for (size_t i
= 0; i
< n_files
; i
++)
1385 if (0 <= f
[i
].fd
&& ! S_ISREG (f
[i
].mode
) && ! S_ISFIFO (f
[i
].mode
))
1390 /* Return true if any of the N_FILES files in F represents
1391 stdin and is tailable. */
1394 tailable_stdin (const struct File_spec
*f
, size_t n_files
)
1396 for (size_t i
= 0; i
< n_files
; i
++)
1397 if (!f
[i
].ignore
&& STREQ (f
[i
].name
, "-"))
1403 wd_hasher (const void *entry
, size_t tabsize
)
1405 const struct File_spec
*spec
= entry
;
1406 return spec
->wd
% tabsize
;
1410 wd_comparator (const void *e1
, const void *e2
)
1412 const struct File_spec
*spec1
= e1
;
1413 const struct File_spec
*spec2
= e2
;
1414 return spec1
->wd
== spec2
->wd
;
1417 /* Output (new) data for FSPEC->fd.
1418 PREV_FSPEC records the last File_spec for which we output. */
1420 check_fspec (struct File_spec
*fspec
, struct File_spec
**prev_fspec
)
1425 if (fspec
->fd
== -1)
1428 name
= pretty_name (fspec
);
1430 if (fstat (fspec
->fd
, &stats
) != 0)
1432 fspec
->errnum
= errno
;
1433 close_fd (fspec
->fd
, name
);
1438 /* XXX: This is only a heuristic, as the file may have also
1439 been truncated and written to if st_size >= size
1440 (in which case we ignore new data <= size).
1441 Though in the inotify case it's more likely we'll get
1442 separate events for truncate() and write(). */
1443 if (S_ISREG (fspec
->mode
) && stats
.st_size
< fspec
->size
)
1445 error (0, 0, _("%s: file truncated"), quotef (name
));
1446 xlseek (fspec
->fd
, 0, SEEK_SET
, name
);
1449 else if (S_ISREG (fspec
->mode
) && stats
.st_size
== fspec
->size
1450 && timespec_cmp (fspec
->mtime
, get_stat_mtime (&stats
)) == 0)
1453 bool want_header
= print_headers
&& (fspec
!= *prev_fspec
);
1455 uintmax_t bytes_read
= dump_remainder (want_header
, name
, fspec
->fd
,
1457 fspec
->size
+= bytes_read
;
1461 *prev_fspec
= fspec
;
1462 if (fflush (stdout
) != 0)
1467 /* Attempt to tail N_FILES files forever, or until killed.
1468 Check modifications using the inotify events system.
1469 Exit if finished or on fatal error; return to revert to polling. */
1471 tail_forever_inotify (int wd
, struct File_spec
*f
, size_t n_files
,
1472 double sleep_interval
, Hash_table
**wd_to_namep
)
1474 # if TAIL_TEST_SLEEP
1475 /* Delay between open() and inotify_add_watch()
1476 to help trigger different cases. */
1477 xnanosleep (1000000);
1479 unsigned int max_realloc
= 3;
1481 /* Map an inotify watch descriptor to the name of the file it's watching. */
1482 Hash_table
*wd_to_name
;
1484 bool found_watchable_file
= false;
1485 bool tailed_but_unwatchable
= false;
1486 bool found_unwatchable_dir
= false;
1487 bool no_inotify_resources
= false;
1488 bool writers_dead
= false;
1489 struct File_spec
*prev_fspec
;
1492 size_t evbuf_off
= 0;
1495 wd_to_name
= hash_initialize (n_files
, nullptr, wd_hasher
, wd_comparator
,
1499 *wd_to_namep
= wd_to_name
;
1501 /* The events mask used with inotify on files (not directories). */
1502 uint32_t inotify_wd_mask
= IN_MODIFY
;
1503 /* TODO: Perhaps monitor these events in Follow_descriptor mode also,
1504 to tag reported file names with "deleted", "moved" etc. */
1505 if (follow_mode
== Follow_name
)
1506 inotify_wd_mask
|= (IN_ATTRIB
| IN_DELETE_SELF
| IN_MOVE_SELF
);
1508 /* Add an inotify watch for each watched file. If -F is specified then watch
1509 its parent directory too, in this way when they re-appear we can add them
1510 again to the watch list. */
1512 for (i
= 0; i
< n_files
; i
++)
1516 size_t fnlen
= strlen (f
[i
].name
);
1522 if (follow_mode
== Follow_name
)
1524 size_t dirlen
= dir_len (f
[i
].name
);
1525 char prev
= f
[i
].name
[dirlen
];
1526 f
[i
].basename_start
= last_component (f
[i
].name
) - f
[i
].name
;
1528 f
[i
].name
[dirlen
] = '\0';
1530 /* It's fine to add the same directory more than once.
1531 In that case the same watch descriptor is returned. */
1532 f
[i
].parent_wd
= inotify_add_watch (wd
, dirlen
? f
[i
].name
: ".",
1533 (IN_CREATE
| IN_DELETE
1534 | IN_MOVED_TO
| IN_ATTRIB
1537 f
[i
].name
[dirlen
] = prev
;
1539 if (f
[i
].parent_wd
< 0)
1541 if (errno
!= ENOSPC
) /* suppress confusing error. */
1542 error (0, errno
, _("cannot watch parent directory of %s"),
1543 quoteaf (f
[i
].name
));
1545 error (0, 0, _("inotify resources exhausted"));
1546 found_unwatchable_dir
= true;
1547 /* We revert to polling below. Note invalid uses
1548 of the inotify API will still be diagnosed. */
1553 f
[i
].wd
= inotify_add_watch (wd
, f
[i
].name
, inotify_wd_mask
);
1557 if (f
[i
].fd
!= -1) /* already tailed. */
1558 tailed_but_unwatchable
= true;
1559 if (errno
== ENOSPC
|| errno
== ENOMEM
)
1561 no_inotify_resources
= true;
1562 error (0, 0, _("inotify resources exhausted"));
1565 else if (errno
!= f
[i
].errnum
)
1566 error (0, errno
, _("cannot watch %s"), quoteaf (f
[i
].name
));
1570 if (hash_insert (wd_to_name
, &(f
[i
])) == nullptr)
1573 found_watchable_file
= true;
1577 /* Linux kernel 2.6.24 at least has a bug where eventually, ENOSPC is always
1578 returned by inotify_add_watch. In any case we should revert to polling
1579 when there are no inotify resources. Also a specified directory may not
1580 be currently present or accessible, so revert to polling. Also an already
1581 tailed but unwatchable due rename/unlink race, should also revert. */
1582 if (no_inotify_resources
|| found_unwatchable_dir
1583 || (follow_mode
== Follow_descriptor
&& tailed_but_unwatchable
))
1585 if (follow_mode
== Follow_descriptor
&& !found_watchable_file
)
1586 exit (EXIT_FAILURE
);
1588 prev_fspec
= &(f
[n_files
- 1]);
1590 /* Check files again. New files or data can be available since last time we
1591 checked and before they are watched by inotify. */
1592 for (i
= 0; i
< n_files
; i
++)
1596 /* check for new files. */
1597 if (follow_mode
== Follow_name
)
1598 recheck (&(f
[i
]), false);
1599 else if (f
[i
].fd
!= -1)
1601 /* If the file was replaced in the small window since we tailed,
1602 then assume the watch is on the wrong item (different to
1603 that we've already produced output for), and so revert to
1604 polling the original descriptor. */
1607 if (stat (f
[i
].name
, &stats
) == 0
1608 && (f
[i
].dev
!= stats
.st_dev
|| f
[i
].ino
!= stats
.st_ino
))
1610 error (0, errno
, _("%s was replaced"),
1611 quoteaf (pretty_name (&(f
[i
]))));
1616 /* check for new data. */
1617 check_fspec (&f
[i
], &prev_fspec
);
1621 evlen
+= sizeof (struct inotify_event
) + 1;
1622 evbuf
= xmalloc (evlen
);
1624 /* Wait for inotify events and handle them. Events on directories
1625 ensure that watched files can be re-added when following by name.
1626 This loop blocks on the 'safe_read' call until a new event is notified.
1627 But when --pid=P is specified, tail usually waits via poll. */
1630 struct File_spec
*fspec
;
1631 struct inotify_event
*ev
;
1634 /* When following by name without --retry, and the last file has
1635 been unlinked or renamed-away, diagnose it and return. */
1636 if (follow_mode
== Follow_name
1637 && ! reopen_inaccessible_files
1638 && hash_get_n_entries (wd_to_name
) == 0)
1639 error (EXIT_FAILURE
, 0, _("no files remaining"));
1641 if (len
<= evbuf_off
)
1643 /* Poll for inotify events. When watching a PID, ensure
1644 that a read from WD will not block indefinitely.
1645 If MONITOR_OUTPUT, also poll for a broken output pipe. */
1648 struct pollfd pfd
[2];
1651 /* How many ms to wait for changes. -1 means wait forever. */
1657 exit (EXIT_SUCCESS
);
1659 writers_dead
= writers_are_dead ();
1661 if (writers_dead
|| sleep_interval
<= 0)
1663 else if (sleep_interval
< INT_MAX
/ 1000 - 1)
1665 /* delay = ceil (sleep_interval * 1000), sans libm. */
1666 double ddelay
= sleep_interval
* 1000;
1668 delay
+= delay
< ddelay
;
1673 pfd
[0].events
= POLLIN
;
1674 pfd
[1].fd
= STDOUT_FILENO
;
1675 pfd
[1].events
= pfd
[1].revents
= 0;
1676 file_change
= poll (pfd
, monitor_output
+ 1, delay
);
1678 while (file_change
== 0);
1680 if (file_change
< 0)
1681 error (EXIT_FAILURE
, errno
,
1682 _("error waiting for inotify and output events"));
1686 len
= safe_read (wd
, evbuf
, evlen
);
1689 /* For kernels prior to 2.6.21, read returns 0 when the buffer
1691 if ((len
== 0 || (len
== SAFE_READ_ERROR
&& errno
== EINVAL
))
1696 evbuf
= xrealloc (evbuf
, evlen
);
1700 if (len
== 0 || len
== SAFE_READ_ERROR
)
1701 error (EXIT_FAILURE
, errno
, _("error reading inotify event"));
1704 void_ev
= evbuf
+ evbuf_off
;
1706 evbuf_off
+= sizeof (*ev
) + ev
->len
;
1708 /* If a directory is deleted, IN_DELETE_SELF is emitted
1709 with ev->name of length 0.
1710 We need to catch it, otherwise it would wait forever,
1711 as wd for directory becomes inactive. Revert to polling now. */
1712 if ((ev
->mask
& IN_DELETE_SELF
) && ! ev
->len
)
1714 for (i
= 0; i
< n_files
; i
++)
1716 if (ev
->wd
== f
[i
].parent_wd
)
1719 _("directory containing watched file was removed"));
1725 if (ev
->len
) /* event on ev->name in watched directory. */
1728 for (j
= 0; j
< n_files
; j
++)
1730 /* With N=hundreds of frequently-changing files, this O(N^2)
1731 process might be a problem. FIXME: use a hash table? */
1732 if (f
[j
].parent_wd
== ev
->wd
1733 && STREQ (ev
->name
, f
[j
].name
+ f
[j
].basename_start
))
1737 /* It is not a watched file. */
1744 bool deleting
= !! (ev
->mask
& IN_DELETE
);
1748 /* Adding the same inode again will look up any existing wd. */
1749 new_wd
= inotify_add_watch (wd
, f
[j
].name
, inotify_wd_mask
);
1752 if (! deleting
&& new_wd
< 0)
1754 if (errno
== ENOSPC
|| errno
== ENOMEM
)
1756 error (0, 0, _("inotify resources exhausted"));
1757 return; /* revert to polling. */
1761 /* Can get ENOENT for a dangling symlink for example. */
1762 error (0, errno
, _("cannot watch %s"), quoteaf (f
[j
].name
));
1764 /* We'll continue below after removing the existing watch. */
1767 /* This will be false if only attributes of file change. */
1769 new_watch
= (! deleting
) && (fspec
->wd
< 0 || new_wd
!= fspec
->wd
);
1775 inotify_rm_watch (wd
, fspec
->wd
);
1776 hash_remove (wd_to_name
, fspec
);
1784 /* If the file was moved then inotify will use the source file wd
1785 for the destination file. Make sure the key is not present in
1787 struct File_spec
*prev
= hash_remove (wd_to_name
, fspec
);
1788 if (prev
&& prev
!= fspec
)
1790 if (follow_mode
== Follow_name
)
1791 recheck (prev
, false);
1793 close_fd (prev
->fd
, pretty_name (prev
));
1796 if (hash_insert (wd_to_name
, fspec
) == nullptr)
1800 if (follow_mode
== Follow_name
)
1801 recheck (fspec
, false);
1805 struct File_spec key
;
1807 fspec
= hash_lookup (wd_to_name
, &key
);
1813 if (ev
->mask
& (IN_ATTRIB
| IN_DELETE
| IN_DELETE_SELF
| IN_MOVE_SELF
))
1815 /* Note for IN_MOVE_SELF (the file we're watching has
1816 been clobbered via a rename) we leave the watch
1817 in place since it may still be part of the set
1818 of watched names. */
1819 if (ev
->mask
& IN_DELETE_SELF
)
1821 inotify_rm_watch (wd
, fspec
->wd
);
1822 hash_remove (wd_to_name
, fspec
);
1825 /* Note we get IN_ATTRIB for unlink() as st_nlink decrements.
1826 The usual path is a close() done in recheck() triggers
1827 an IN_DELETE_SELF event as the inode is removed.
1828 However sometimes open() will succeed as even though
1829 st_nlink is decremented, the dentry (cache) is not updated.
1830 Thus we depend on the IN_DELETE event on the directory
1831 to trigger processing for the removed file. */
1833 recheck (fspec
, false);
1837 check_fspec (fspec
, &prev_fspec
);
1842 /* Output the last N_BYTES bytes of file FILENAME open for reading in FD.
1843 Return true if successful. */
1846 tail_bytes (char const *pretty_filename
, int fd
, uintmax_t n_bytes
,
1847 uintmax_t *read_pos
)
1851 if (fstat (fd
, &stats
))
1853 error (0, errno
, _("cannot fstat %s"), quoteaf (pretty_filename
));
1859 if (! presume_input_pipe
&& n_bytes
<= OFF_T_MAX
1860 && ((S_ISREG (stats
.st_mode
)
1861 && xlseek (fd
, n_bytes
, SEEK_CUR
, pretty_filename
) >= 0)
1862 || lseek (fd
, n_bytes
, SEEK_CUR
) != -1))
1863 *read_pos
+= n_bytes
;
1866 int t
= start_bytes (pretty_filename
, fd
, n_bytes
, read_pos
);
1870 n_bytes
= COPY_TO_EOF
;
1875 off_t current_pos
= -1;
1876 bool copy_from_current_pos
= false;
1878 if (! presume_input_pipe
&& n_bytes
<= OFF_T_MAX
)
1880 if (usable_st_size (&stats
))
1882 /* Use st_size only if it's so large that this is
1883 probably not a /proc or similar file, where st_size
1885 end_pos
= stats
.st_size
;
1886 off_t smallish_size
= STP_BLKSIZE (&stats
);
1887 copy_from_current_pos
= smallish_size
< end_pos
;
1891 current_pos
= lseek (fd
, -n_bytes
, SEEK_END
);
1892 copy_from_current_pos
= current_pos
!= -1;
1893 if (copy_from_current_pos
)
1894 end_pos
= current_pos
+ n_bytes
;
1897 if (! copy_from_current_pos
)
1898 return pipe_bytes (pretty_filename
, fd
, n_bytes
, read_pos
);
1899 if (current_pos
== -1)
1900 current_pos
= xlseek (fd
, 0, SEEK_CUR
, pretty_filename
);
1901 if (current_pos
< end_pos
)
1903 off_t bytes_remaining
= end_pos
- current_pos
;
1905 if (n_bytes
< bytes_remaining
)
1907 current_pos
= end_pos
- n_bytes
;
1908 xlseek (fd
, current_pos
, SEEK_SET
, pretty_filename
);
1911 *read_pos
= current_pos
;
1914 *read_pos
+= dump_remainder (false, pretty_filename
, fd
, n_bytes
);
1918 /* Output the last N_LINES lines of file FILENAME open for reading in FD.
1919 Return true if successful. */
1922 tail_lines (char const *pretty_filename
, int fd
, uintmax_t n_lines
,
1923 uintmax_t *read_pos
)
1927 if (fstat (fd
, &stats
))
1929 error (0, errno
, _("cannot fstat %s"), quoteaf (pretty_filename
));
1935 int t
= start_lines (pretty_filename
, fd
, n_lines
, read_pos
);
1938 *read_pos
+= dump_remainder (false, pretty_filename
, fd
, COPY_TO_EOF
);
1942 off_t start_pos
= -1;
1945 /* Use file_lines only if FD refers to a regular file for
1946 which lseek (... SEEK_END) works. */
1947 if ( ! presume_input_pipe
1948 && S_ISREG (stats
.st_mode
)
1949 && (start_pos
= lseek (fd
, 0, SEEK_CUR
)) != -1
1950 && start_pos
< (end_pos
= lseek (fd
, 0, SEEK_END
)))
1952 *read_pos
= end_pos
;
1954 && ! file_lines (pretty_filename
, fd
, &stats
, n_lines
,
1955 start_pos
, end_pos
, read_pos
))
1960 /* Under very unlikely circumstances, it is possible to reach
1961 this point after positioning the file pointer to end of file
1962 via the 'lseek (...SEEK_END)' above. In that case, reposition
1963 the file pointer back to start_pos before calling pipe_lines. */
1964 if (start_pos
!= -1)
1965 xlseek (fd
, start_pos
, SEEK_SET
, pretty_filename
);
1967 return pipe_lines (pretty_filename
, fd
, n_lines
, read_pos
);
1973 /* Display the last N_UNITS units of file FILENAME, open for reading
1974 via FD. Set *READ_POS to the position of the input stream pointer.
1975 *READ_POS is usually the number of bytes read and corresponds to an
1976 offset from the beginning of a file. However, it may be larger than
1977 OFF_T_MAX (as for an input pipe), and may also be larger than the
1978 number of bytes read (when an input pointer is initially not at
1979 beginning of file), and may be far greater than the number of bytes
1980 actually read for an input file that is seekable.
1981 Return true if successful. */
1984 tail (char const *filename
, int fd
, uintmax_t n_units
,
1985 uintmax_t *read_pos
)
1989 return tail_lines (filename
, fd
, n_units
, read_pos
);
1991 return tail_bytes (filename
, fd
, n_units
, read_pos
);
1994 /* Display the last N_UNITS units of the file described by F.
1995 Return true if successful. */
1998 tail_file (struct File_spec
*f
, uintmax_t n_units
)
2003 bool is_stdin
= (STREQ (f
->name
, "-"));
2007 have_read_stdin
= true;
2009 xset_binary_mode (STDIN_FILENO
, O_BINARY
);
2012 fd
= open (f
->name
, O_RDONLY
| O_BINARY
);
2014 f
->tailable
= !(reopen_inaccessible_files
&& fd
== -1);
2022 f
->ignore
= ! reopen_inaccessible_files
;
2026 error (0, errno
, _("cannot open %s for reading"),
2027 quoteaf (pretty_name (f
)));
2035 write_header (pretty_name (f
));
2036 ok
= tail (pretty_name (f
), fd
, n_units
, &read_pos
);
2042 /* Before the tail function provided 'read_pos', there was
2043 a race condition described in the URL below. This sleep
2044 call made the window big enough to exercise the problem. */
2048 if (fstat (fd
, &stats
) < 0)
2052 error (0, errno
, _("error reading %s"),
2053 quoteaf (pretty_name (f
)));
2055 else if (!IS_TAILABLE_FILE_TYPE (stats
.st_mode
))
2059 f
->tailable
= false;
2060 f
->ignore
= ! reopen_inaccessible_files
;
2061 error (0, 0, _("%s: cannot follow end of this type of file%s"),
2062 quotef (pretty_name (f
)),
2063 f
->ignore
? _("; giving up on this name") : "");
2068 f
->ignore
= ! reopen_inaccessible_files
;
2069 close_fd (fd
, pretty_name (f
));
2074 /* Note: we must use read_pos here, not stats.st_size,
2075 to avoid a race condition described by Ken Raeburn:
2076 https://lists.gnu.org/r/bug-textutils/2003-05/msg00007.html */
2077 record_open_fd (f
, fd
, read_pos
, &stats
, (is_stdin
? -1 : 1));
2078 f
->remote
= fremote (fd
, pretty_name (f
));
2083 if (!is_stdin
&& close (fd
))
2085 error (0, errno
, _("error reading %s"),
2086 quoteaf (pretty_name (f
)));
2095 /* If obsolete usage is allowed, and the command line arguments are of
2096 the obsolete form and the option string is well-formed, set
2097 *N_UNITS, the globals COUNT_LINES, FOREVER, and FROM_START, and
2098 return true. If the command line arguments are obviously incorrect
2099 (e.g., because obsolete usage is not allowed and the arguments are
2100 incorrect for non-obsolete usage), report an error and exit.
2101 Otherwise, return false and don't modify any parameter or global
2105 parse_obsolete_option (int argc
, char * const *argv
, uintmax_t *n_units
)
2108 char const *n_string
;
2109 char const *n_string_end
;
2110 int default_count
= DEFAULT_N_LINES
;
2112 bool t_count_lines
= true;
2113 bool t_forever
= false;
2115 /* With the obsolete form, there is one option string and at most
2116 one file argument. Watch out for "-" and "--", though. */
2118 || (argc
== 3 && ! (argv
[2][0] == '-' && argv
[2][1]))
2119 || (3 <= argc
&& argc
<= 4 && STREQ (argv
[2], "--"))))
2122 int posix_ver
= posix2_version ();
2123 bool obsolete_usage
= posix_ver
< 200112;
2124 bool traditional_usage
= obsolete_usage
|| 200809 <= posix_ver
;
2133 /* Leading "+" is a file name in the standard form. */
2134 if (!traditional_usage
)
2137 t_from_start
= true;
2141 /* In the non-obsolete form, "-" is standard input and "-c"
2142 requires an option-argument. The obsolete multidigit options
2143 are supported as a GNU extension even when conforming to
2144 POSIX 1003.1-2001 or later, so don't complain about them. */
2145 if (!obsolete_usage
&& !p
[p
[0] == 'c'])
2148 t_from_start
= false;
2153 while (ISDIGIT (*p
))
2159 case 'b': default_count
*= 512; FALLTHROUGH
;
2160 case 'c': t_count_lines
= false; FALLTHROUGH
;
2161 case 'l': p
++; break;
2173 if (n_string
== n_string_end
)
2174 *n_units
= default_count
;
2175 else if ((xstrtoumax (n_string
, nullptr, 10, n_units
, "b")
2176 & ~LONGINT_INVALID_SUFFIX_CHAR
)
2178 error (EXIT_FAILURE
, errno
, "%s: %s", _("invalid number"),
2182 from_start
= t_from_start
;
2183 count_lines
= t_count_lines
;
2184 forever
= t_forever
;
2190 parse_options (int argc
, char **argv
,
2191 uintmax_t *n_units
, enum header_mode
*header_mode
,
2192 double *sleep_interval
)
2196 while ((c
= getopt_long (argc
, argv
, "c:n:fFqs:vz0123456789",
2197 long_options
, nullptr))
2204 follow_mode
= Follow_name
;
2205 reopen_inaccessible_files
= true;
2210 count_lines
= (c
== 'n');
2213 else if (*optarg
== '-')
2216 *n_units
= xdectoumax (optarg
, 0, UINTMAX_MAX
, "bkKmMGTPEZYRQ0",
2218 ? _("invalid number of lines")
2219 : _("invalid number of bytes"), 0);
2223 case LONG_FOLLOW_OPTION
:
2225 if (optarg
== nullptr)
2226 follow_mode
= DEFAULT_FOLLOW_MODE
;
2228 follow_mode
= XARGMATCH ("--follow", optarg
,
2229 follow_mode_string
, follow_mode_map
);
2233 reopen_inaccessible_files
= true;
2236 case MAX_UNCHANGED_STATS_OPTION
:
2237 /* --max-unchanged-stats=N */
2238 max_n_unchanged_stats_between_opens
=
2239 xdectoumax (optarg
, 0, UINTMAX_MAX
, "",
2240 _("invalid maximum number of unchanged stats between opens"), 0);
2243 case DISABLE_INOTIFY_OPTION
:
2244 disable_inotify
= true;
2248 if (nbpids
== pids_alloc
)
2249 pids
= xpalloc (pids
, &pids_alloc
, 1,
2250 MIN (INT_MAX
, PTRDIFF_MAX
), sizeof *pids
);
2251 pids
[nbpids
++] = xdectoumax (optarg
, 0, PID_T_MAX
, "",
2252 _("invalid PID"), 0);
2255 case PRESUME_INPUT_PIPE_OPTION
:
2256 presume_input_pipe
= true;
2260 *header_mode
= never
;
2266 if (! (xstrtod (optarg
, nullptr, &s
, cl_strtod
) && 0 <= s
))
2267 error (EXIT_FAILURE
, 0,
2268 _("invalid number of seconds: %s"), quote (optarg
));
2269 *sleep_interval
= s
;
2274 *header_mode
= always
;
2281 case_GETOPT_HELP_CHAR
;
2283 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
2285 case '0': case '1': case '2': case '3': case '4':
2286 case '5': case '6': case '7': case '8': case '9':
2287 error (EXIT_FAILURE
, 0, _("option used in invalid context -- %c"), c
);
2290 usage (EXIT_FAILURE
);
2294 if (reopen_inaccessible_files
)
2298 reopen_inaccessible_files
= false;
2299 error (0, 0, _("warning: --retry ignored; --retry is useful"
2300 " only when following"));
2302 else if (follow_mode
== Follow_descriptor
)
2303 error (0, 0, _("warning: --retry only effective for the initial open"));
2306 if (nbpids
&& !forever
)
2308 _("warning: PID ignored; --pid=PID is useful only when following"));
2309 else if (nbpids
&& kill (pids
[0], 0) != 0 && errno
== ENOSYS
)
2311 error (0, 0, _("warning: --pid=PID is not supported on this system"));
2317 /* Mark as '.ignore'd each member of F that corresponds to a
2318 pipe or fifo, and return the number of non-ignored members. */
2320 ignore_fifo_and_pipe (struct File_spec
*f
, size_t n_files
)
2322 /* When there is no FILE operand and stdin is a pipe or FIFO
2323 POSIX requires that tail ignore the -f option.
2324 Since we allow multiple FILE operands, we extend that to say: with -f,
2325 ignore any "-" operand that corresponds to a pipe or FIFO. */
2326 size_t n_viable
= 0;
2328 for (size_t i
= 0; i
< n_files
; i
++)
2330 bool is_a_fifo_or_pipe
=
2331 (STREQ (f
[i
].name
, "-")
2334 && (S_ISFIFO (f
[i
].mode
)
2335 || (HAVE_FIFO_PIPES
!= 1 && isapipe (f
[i
].fd
))));
2336 if (is_a_fifo_or_pipe
)
2349 main (int argc
, char **argv
)
2351 enum header_mode header_mode
= multiple_files
;
2353 /* If from_start, the number of items to skip before printing; otherwise,
2354 the number of items at the end of the file to print. Although the type
2355 is signed, the value is never negative. */
2356 uintmax_t n_units
= DEFAULT_N_LINES
;
2359 struct File_spec
*F
;
2361 bool obsolete_option
;
2363 /* The number of seconds to sleep between iterations.
2364 During one iteration, every file name or descriptor is checked to
2365 see if it has changed. */
2366 double sleep_interval
= 1.0;
2368 initialize_main (&argc
, &argv
);
2369 set_program_name (argv
[0]);
2370 setlocale (LC_ALL
, "");
2371 bindtextdomain (PACKAGE
, LOCALEDIR
);
2372 textdomain (PACKAGE
);
2374 atexit (close_stdout
);
2376 page_size
= getpagesize ();
2378 have_read_stdin
= false;
2381 forever
= from_start
= print_headers
= false;
2383 obsolete_option
= parse_obsolete_option (argc
, argv
, &n_units
);
2384 argc
-= obsolete_option
;
2385 argv
+= obsolete_option
;
2386 parse_options (argc
, argv
, &n_units
, &header_mode
, &sleep_interval
);
2388 /* To start printing with item N_UNITS from the start of the file, skip
2389 N_UNITS - 1 items. 'tail -n +0' is actually meaningless, but for Unix
2390 compatibility it's treated the same as 'tail -n +1'. */
2399 n_files
= argc
- optind
;
2400 file
= argv
+ optind
;
2404 static char *dummy_stdin
= (char *) "-";
2406 file
= &dummy_stdin
;
2410 bool found_hyphen
= false;
2412 for (i
= 0; i
< n_files
; i
++)
2413 if (STREQ (file
[i
], "-"))
2414 found_hyphen
= true;
2416 /* When following by name, there must be a name. */
2417 if (found_hyphen
&& follow_mode
== Follow_name
)
2418 error (EXIT_FAILURE
, 0, _("cannot follow %s by name"), quoteaf ("-"));
2420 /* When following forever, and not using simple blocking, warn if
2421 any file is '-' as the stats() used to check for input are ineffective.
2422 This is only a warning, since tail's output (before a failing seek,
2423 and that from any non-stdin files) might still be useful. */
2424 if (forever
&& found_hyphen
)
2426 struct stat in_stat
;
2427 bool blocking_stdin
;
2428 blocking_stdin
= (!nbpids
&& follow_mode
== Follow_descriptor
2429 && n_files
== 1 && ! fstat (STDIN_FILENO
, &in_stat
)
2430 && ! S_ISREG (in_stat
.st_mode
));
2432 if (! blocking_stdin
&& isatty (STDIN_FILENO
))
2433 error (0, 0, _("warning: following standard input"
2434 " indefinitely is ineffective"));
2438 /* Don't read anything if we'll never output anything. */
2439 if (! n_units
&& ! forever
&& ! from_start
)
2440 return EXIT_SUCCESS
;
2442 F
= xnmalloc (n_files
, sizeof *F
);
2443 for (i
= 0; i
< n_files
; i
++)
2444 F
[i
].name
= file
[i
];
2446 if (header_mode
== always
2447 || (header_mode
== multiple_files
&& n_files
> 1))
2448 print_headers
= true;
2450 xset_binary_mode (STDOUT_FILENO
, O_BINARY
);
2452 for (i
= 0; i
< n_files
; i
++)
2453 ok
&= tail_file (&F
[i
], n_units
);
2455 if (forever
&& ignore_fifo_and_pipe (F
, n_files
))
2457 /* If stdout is a fifo or pipe, then monitor it
2458 so that we exit if the reader goes away. */
2459 struct stat out_stat
;
2460 if (fstat (STDOUT_FILENO
, &out_stat
) < 0)
2461 error (EXIT_FAILURE
, errno
, _("standard output"));
2462 monitor_output
= (S_ISFIFO (out_stat
.st_mode
)
2463 || (HAVE_FIFO_PIPES
!= 1 && isapipe (STDOUT_FILENO
)));
2466 /* tailable_stdin() checks if the user specifies stdin via "-",
2467 or implicitly by providing no arguments. If so, we won't use inotify.
2468 Technically, on systems with a working /dev/stdin, we *could*,
2469 but would it be worth it? Verifying that it's a real device
2470 and hooked up to stdin is not trivial, while reverting to
2471 non-inotify-based tail_forever is easy and portable.
2473 any_remote_file() checks if the user has specified any
2474 files that reside on remote file systems. inotify is not used
2475 in this case because it would miss any updates to the file
2476 that were not initiated from the local system.
2478 any_non_remote_file() checks if the user has specified any
2479 files that don't reside on remote file systems. inotify is not used
2480 if there are no open files, as we can't determine if those file
2481 will be on a remote file system.
2483 any_symlinks() checks if the user has specified any symbolic links.
2484 inotify is not used in this case because it returns updated _targets_
2485 which would not match the specified names. If we tried to always
2486 use the target names, then we would miss changes to the symlink itself.
2488 ok is false when one of the files specified could not be opened for
2489 reading. In this case and when following by descriptor,
2490 tail_forever_inotify() cannot be used (in its current implementation).
2492 FIXME: inotify doesn't give any notification when a new
2493 (remote) file or directory is mounted on top a watched file.
2494 When follow_mode == Follow_name we would ideally like to detect that.
2495 Note if there is a change to the original file then we'll
2496 recheck it and follow the new file, or ignore it if the
2497 file has changed to being remote.
2499 FIXME-maybe: inotify has a watch descriptor per inode, and hence with
2500 our current hash implementation will only --follow data for one
2501 of the names when multiple hardlinked files are specified, or
2502 for one name when a name is specified multiple times. */
2503 if (!disable_inotify
&& (tailable_stdin (F
, n_files
)
2504 || any_remote_file (F
, n_files
)
2505 || ! any_non_remote_file (F
, n_files
)
2506 || any_symlinks (F
, n_files
)
2507 || any_non_regular_fifo (F
, n_files
)
2508 || (!ok
&& follow_mode
== Follow_descriptor
)))
2509 disable_inotify
= true;
2511 if (!disable_inotify
)
2513 int wd
= inotify_init ();
2516 /* Flush any output from tail_file, now, since
2517 tail_forever_inotify flushes only after writing,
2518 not before reading. */
2519 if (fflush (stdout
) != 0)
2523 tail_forever_inotify (wd
, F
, n_files
, sleep_interval
, &ht
);
2528 error (0, errno
, _("inotify cannot be used, reverting to polling"));
2531 disable_inotify
= true;
2532 tail_forever (F
, n_files
, sleep_interval
);
2535 if (have_read_stdin
&& close (STDIN_FILENO
) < 0)
2536 error (EXIT_FAILURE
, errno
, "-");
2537 main_exit (ok
? EXIT_SUCCESS
: EXIT_FAILURE
);