uptime: be more generous about read_utmp failure
[coreutils.git] / src / ls.c
blob6299f817fed2159392b2f6f1403a9b4868567077
1 /* 'dir', 'vdir' and 'ls' directory listing programs for GNU.
2 Copyright (C) 1985-2023 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 /* If ls_mode is LS_MULTI_COL,
18 the multi-column format is the default regardless
19 of the type of output device.
20 This is for the 'dir' program.
22 If ls_mode is LS_LONG_FORMAT,
23 the long format is the default regardless of the
24 type of output device.
25 This is for the 'vdir' program.
27 If ls_mode is LS_LS,
28 the output format depends on whether the output
29 device is a terminal.
30 This is for the 'ls' program. */
32 /* Written by Richard Stallman and David MacKenzie. */
34 /* Color support by Peter Anvin <Peter.Anvin@linux.org> and Dennis
35 Flaherty <dennisf@denix.elk.miles.com> based on original patches by
36 Greg Lee <lee@uhunix.uhcc.hawaii.edu>. */
38 #include <config.h>
39 #include <sys/types.h>
41 #include <termios.h>
42 #if HAVE_STROPTS_H
43 # include <stropts.h>
44 #endif
45 #include <sys/ioctl.h>
47 #ifdef WINSIZE_IN_PTEM
48 # include <sys/stream.h>
49 # include <sys/ptem.h>
50 #endif
52 #include <stdio.h>
53 #include <setjmp.h>
54 #include <pwd.h>
55 #include <getopt.h>
56 #include <signal.h>
57 #include <selinux/selinux.h>
58 #include <wchar.h>
60 #if HAVE_LANGINFO_CODESET
61 # include <langinfo.h>
62 #endif
64 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
65 present. */
66 #ifndef SA_NOCLDSTOP
67 # define SA_NOCLDSTOP 0
68 # define sigprocmask(How, Set, Oset) /* empty */
69 # define sigset_t int
70 # if ! HAVE_SIGINTERRUPT
71 # define siginterrupt(sig, flag) /* empty */
72 # endif
73 #endif
75 /* NonStop circa 2011 lacks both SA_RESTART and siginterrupt, so don't
76 restart syscalls after a signal handler fires. This may cause
77 colors to get messed up on the screen if 'ls' is interrupted, but
78 that's the best we can do on such a platform. */
79 #ifndef SA_RESTART
80 # define SA_RESTART 0
81 #endif
83 #include "system.h"
84 #include <fnmatch.h>
86 #include "acl.h"
87 #include "argmatch.h"
88 #include "assure.h"
89 #include "c-strcase.h"
90 #include "dev-ino.h"
91 #include "filenamecat.h"
92 #include "hard-locale.h"
93 #include "hash.h"
94 #include "human.h"
95 #include "filemode.h"
96 #include "filevercmp.h"
97 #include "idcache.h"
98 #include "ls.h"
99 #include "mbswidth.h"
100 #include "mpsort.h"
101 #include "obstack.h"
102 #include "quote.h"
103 #include "smack.h"
104 #include "stat-size.h"
105 #include "stat-time.h"
106 #include "strftime.h"
107 #include "xdectoint.h"
108 #include "xstrtol.h"
109 #include "xstrtol-error.h"
110 #include "areadlink.h"
111 #include "mbsalign.h"
112 #include "dircolors.h"
113 #include "xgethostname.h"
114 #include "c-ctype.h"
115 #include "canonicalize.h"
116 #include "statx.h"
118 /* Include <sys/capability.h> last to avoid a clash of <sys/types.h>
119 include guards with some premature versions of libcap.
120 For more details, see <https://bugzilla.redhat.com/483548>. */
121 #ifdef HAVE_CAP
122 # include <sys/capability.h>
123 #endif
125 #define PROGRAM_NAME (ls_mode == LS_LS ? "ls" \
126 : (ls_mode == LS_MULTI_COL \
127 ? "dir" : "vdir"))
129 #define AUTHORS \
130 proper_name ("Richard M. Stallman"), \
131 proper_name ("David MacKenzie")
133 #define obstack_chunk_alloc malloc
134 #define obstack_chunk_free free
136 /* Unix-based readdir implementations have historically returned a dirent.d_ino
137 value that is sometimes not equal to the stat-obtained st_ino value for
138 that same entry. This error occurs for a readdir entry that refers
139 to a mount point. readdir's error is to return the inode number of
140 the underlying directory -- one that typically cannot be stat'ed, as
141 long as a file system is mounted on that directory. RELIABLE_D_INO
142 encapsulates whether we can use the more efficient approach of relying
143 on readdir-supplied d_ino values, or whether we must incur the cost of
144 calling stat or lstat to obtain each guaranteed-valid inode number. */
146 #ifndef READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
147 # define READDIR_LIES_ABOUT_MOUNTPOINT_D_INO 1
148 #endif
150 #if READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
151 # define RELIABLE_D_INO(dp) NOT_AN_INODE_NUMBER
152 #else
153 # define RELIABLE_D_INO(dp) D_INO (dp)
154 #endif
156 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
157 # define st_author st_uid
158 #endif
160 enum filetype
162 unknown,
163 fifo,
164 chardev,
165 directory,
166 blockdev,
167 normal,
168 symbolic_link,
169 sock,
170 whiteout,
171 arg_directory
174 /* Display letters and indicators for each filetype.
175 Keep these in sync with enum filetype. */
176 static char const filetype_letter[] = "?pcdb-lswd";
178 /* Ensure that filetype and filetype_letter have the same
179 number of elements. */
180 static_assert (sizeof filetype_letter - 1 == arg_directory + 1);
182 #define FILETYPE_INDICATORS \
184 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
185 C_LINK, C_SOCK, C_FILE, C_DIR \
188 enum acl_type
190 ACL_T_NONE,
191 ACL_T_LSM_CONTEXT_ONLY,
192 ACL_T_YES
195 struct fileinfo
197 /* The file name. */
198 char *name;
200 /* For symbolic link, name of the file linked to, otherwise zero. */
201 char *linkname;
203 /* For terminal hyperlinks. */
204 char *absolute_name;
206 struct stat stat;
208 enum filetype filetype;
210 /* For symbolic link and long listing, st_mode of file linked to, otherwise
211 zero. */
212 mode_t linkmode;
214 /* security context. */
215 char *scontext;
217 bool stat_ok;
219 /* For symbolic link and color printing, true if linked-to file
220 exists, otherwise false. */
221 bool linkok;
223 /* For long listings, true if the file has an access control list,
224 or a security context. */
225 enum acl_type acl_type;
227 /* For color listings, true if a regular file has capability info. */
228 bool has_capability;
230 /* Whether file name needs quoting. tri-state with -1 == unknown. */
231 int quoted;
233 /* Cached screen width (including quoting). */
234 size_t width;
237 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
239 /* Null is a valid character in a color indicator (think about Epson
240 printers, for example) so we have to use a length/buffer string
241 type. */
243 struct bin_str
245 size_t len; /* Number of bytes */
246 char const *string; /* Pointer to the same */
249 #if ! HAVE_TCGETPGRP
250 # define tcgetpgrp(Fd) 0
251 #endif
253 static size_t quote_name (char const *name,
254 struct quoting_options const *options,
255 int needs_general_quoting,
256 const struct bin_str *color,
257 bool allow_pad, struct obstack *stack,
258 char const *absolute_name);
259 static size_t quote_name_buf (char **inbuf, size_t bufsize, char *name,
260 struct quoting_options const *options,
261 int needs_general_quoting, size_t *width,
262 bool *pad);
263 static int decode_switches (int argc, char **argv);
264 static bool file_ignored (char const *name);
265 static uintmax_t gobble_file (char const *name, enum filetype type,
266 ino_t inode, bool command_line_arg,
267 char const *dirname);
268 static const struct bin_str * get_color_indicator (const struct fileinfo *f,
269 bool symlink_target);
270 static bool print_color_indicator (const struct bin_str *ind);
271 static void put_indicator (const struct bin_str *ind);
272 static void add_ignore_pattern (char const *pattern);
273 static void attach (char *dest, char const *dirname, char const *name);
274 static void clear_files (void);
275 static void extract_dirs_from_files (char const *dirname,
276 bool command_line_arg);
277 static void get_link_name (char const *filename, struct fileinfo *f,
278 bool command_line_arg);
279 static void indent (size_t from, size_t to);
280 static size_t calculate_columns (bool by_columns);
281 static void print_current_files (void);
282 static void print_dir (char const *name, char const *realname,
283 bool command_line_arg);
284 static size_t print_file_name_and_frills (const struct fileinfo *f,
285 size_t start_col);
286 static void print_horizontal (void);
287 static int format_user_width (uid_t u);
288 static int format_group_width (gid_t g);
289 static void print_long_format (const struct fileinfo *f);
290 static void print_many_per_line (void);
291 static size_t print_name_with_quoting (const struct fileinfo *f,
292 bool symlink_target,
293 struct obstack *stack,
294 size_t start_col);
295 static void prep_non_filename_text (void);
296 static bool print_type_indicator (bool stat_ok, mode_t mode,
297 enum filetype type);
298 static void print_with_separator (char sep);
299 static void queue_directory (char const *name, char const *realname,
300 bool command_line_arg);
301 static void sort_files (void);
302 static void parse_ls_color (void);
304 static int getenv_quoting_style (void);
306 static size_t quote_name_width (char const *name,
307 struct quoting_options const *options,
308 int needs_general_quoting);
310 /* Initial size of hash table.
311 Most hierarchies are likely to be shallower than this. */
312 enum { INITIAL_TABLE_SIZE = 30 };
314 /* The set of 'active' directories, from the current command-line argument
315 to the level in the hierarchy at which files are being listed.
316 A directory is represented by its device and inode numbers (struct dev_ino).
317 A directory is added to this set when ls begins listing it or its
318 entries, and it is removed from the set just after ls has finished
319 processing it. This set is used solely to detect loops, e.g., with
320 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
321 static Hash_table *active_dir_set;
323 #define LOOP_DETECT (!!active_dir_set)
325 /* The table of files in the current directory:
327 'cwd_file' points to a vector of 'struct fileinfo', one per file.
328 'cwd_n_alloc' is the number of elements space has been allocated for.
329 'cwd_n_used' is the number actually in use. */
331 /* Address of block containing the files that are described. */
332 static struct fileinfo *cwd_file;
334 /* Length of block that 'cwd_file' points to, measured in files. */
335 static size_t cwd_n_alloc;
337 /* Index of first unused slot in 'cwd_file'. */
338 static size_t cwd_n_used;
340 /* Whether files needs may need padding due to quoting. */
341 static bool cwd_some_quoted;
343 /* Whether quoting style _may_ add outer quotes,
344 and whether aligning those is useful. */
345 static bool align_variable_outer_quotes;
347 /* Vector of pointers to files, in proper sorted order, and the number
348 of entries allocated for it. */
349 static void **sorted_file;
350 static size_t sorted_file_alloc;
352 /* When true, in a color listing, color each symlink name according to the
353 type of file it points to. Otherwise, color them according to the 'ln'
354 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
355 regardless. This is set when 'ln=target' appears in LS_COLORS. */
357 static bool color_symlink_as_referent;
359 static char const *hostname;
361 /* Mode of appropriate file for coloring. */
362 static mode_t
363 file_or_link_mode (struct fileinfo const *file)
365 return (color_symlink_as_referent && file->linkok
366 ? file->linkmode : file->stat.st_mode);
370 /* Record of one pending directory waiting to be listed. */
372 struct pending
374 char *name;
375 /* If the directory is actually the file pointed to by a symbolic link we
376 were told to list, 'realname' will contain the name of the symbolic
377 link, otherwise zero. */
378 char *realname;
379 bool command_line_arg;
380 struct pending *next;
383 static struct pending *pending_dirs;
385 /* Current time in seconds and nanoseconds since 1970, updated as
386 needed when deciding whether a file is recent. */
388 static struct timespec current_time;
390 static bool print_scontext;
391 static char UNKNOWN_SECURITY_CONTEXT[] = "?";
393 /* Whether any of the files has an ACL. This affects the width of the
394 mode column. */
396 static bool any_has_acl;
398 /* The number of columns to use for columns containing inode numbers,
399 block sizes, link counts, owners, groups, authors, major device
400 numbers, minor device numbers, and file sizes, respectively. */
402 static int inode_number_width;
403 static int block_size_width;
404 static int nlink_width;
405 static int scontext_width;
406 static int owner_width;
407 static int group_width;
408 static int author_width;
409 static int major_device_number_width;
410 static int minor_device_number_width;
411 static int file_size_width;
413 /* Option flags */
415 /* long_format for lots of info, one per line.
416 one_per_line for just names, one per line.
417 many_per_line for just names, many per line, sorted vertically.
418 horizontal for just names, many per line, sorted horizontally.
419 with_commas for just names, many per line, separated by commas.
421 -l (and other options that imply -l), -1, -C, -x and -m control
422 this parameter. */
424 enum format
426 long_format, /* -l and other options that imply -l */
427 one_per_line, /* -1 */
428 many_per_line, /* -C */
429 horizontal, /* -x */
430 with_commas /* -m */
433 static enum format format;
435 /* 'full-iso' uses full ISO-style dates and times. 'long-iso' uses longer
436 ISO-style timestamps, though shorter than 'full-iso'. 'iso' uses shorter
437 ISO-style timestamps. 'locale' uses locale-dependent timestamps. */
438 enum time_style
440 full_iso_time_style, /* --time-style=full-iso */
441 long_iso_time_style, /* --time-style=long-iso */
442 iso_time_style, /* --time-style=iso */
443 locale_time_style /* --time-style=locale */
446 static char const *const time_style_args[] =
448 "full-iso", "long-iso", "iso", "locale", nullptr
450 static enum time_style const time_style_types[] =
452 full_iso_time_style, long_iso_time_style, iso_time_style,
453 locale_time_style
455 ARGMATCH_VERIFY (time_style_args, time_style_types);
457 /* Type of time to print or sort by. Controlled by -c and -u.
458 The values of each item of this enum are important since they are
459 used as indices in the sort functions array (see sort_files()). */
461 enum time_type
463 time_mtime = 0, /* default */
464 time_ctime, /* -c */
465 time_atime, /* -u */
466 time_btime, /* birth time */
467 time_numtypes /* the number of elements of this enum */
470 static enum time_type time_type;
472 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
473 The values of each item of this enum are important since they are
474 used as indices in the sort functions array (see sort_files()). */
476 enum sort_type
478 sort_name = 0, /* default */
479 sort_extension, /* -X */
480 sort_width,
481 sort_size, /* -S */
482 sort_version, /* -v */
483 sort_time, /* -t; must be second to last */
484 sort_none, /* -U; must be last */
485 sort_numtypes /* the number of elements of this enum */
488 static enum sort_type sort_type;
490 /* Direction of sort.
491 false means highest first if numeric,
492 lowest first if alphabetic;
493 these are the defaults.
494 true means the opposite order in each case. -r */
496 static bool sort_reverse;
498 /* True means to display owner information. -g turns this off. */
500 static bool print_owner = true;
502 /* True means to display author information. */
504 static bool print_author;
506 /* True means to display group information. -G and -o turn this off. */
508 static bool print_group = true;
510 /* True means print the user and group id's as numbers rather
511 than as names. -n */
513 static bool numeric_ids;
515 /* True means mention the size in blocks of each file. -s */
517 static bool print_block_size;
519 /* Human-readable options for output, when printing block counts. */
520 static int human_output_opts;
522 /* The units to use when printing block counts. */
523 static uintmax_t output_block_size;
525 /* Likewise, but for file sizes. */
526 static int file_human_output_opts;
527 static uintmax_t file_output_block_size = 1;
529 /* Follow the output with a special string. Using this format,
530 Emacs' dired mode starts up twice as fast, and can handle all
531 strange characters in file names. */
532 static bool dired;
534 /* 'none' means don't mention the type of files.
535 'slash' means mention directories only, with a '/'.
536 'file_type' means mention file types.
537 'classify' means mention file types and mark executables.
539 Controlled by -F, -p, and --indicator-style. */
541 enum indicator_style
543 none = 0, /* --indicator-style=none (default) */
544 slash, /* -p, --indicator-style=slash */
545 file_type, /* --indicator-style=file-type */
546 classify /* -F, --indicator-style=classify */
549 static enum indicator_style indicator_style;
551 /* Names of indicator styles. */
552 static char const *const indicator_style_args[] =
554 "none", "slash", "file-type", "classify", nullptr
556 static enum indicator_style const indicator_style_types[] =
558 none, slash, file_type, classify
560 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
562 /* True means use colors to mark types. Also define the different
563 colors as well as the stuff for the LS_COLORS environment variable.
564 The LS_COLORS variable is now in a termcap-like format. */
566 static bool print_with_color;
568 static bool print_hyperlink;
570 /* Whether we used any colors in the output so far. If so, we will
571 need to restore the default color later. If not, we will need to
572 call prep_non_filename_text before using color for the first time. */
574 static bool used_color = false;
576 enum when_type
578 when_never, /* 0: default or --color=never */
579 when_always, /* 1: --color=always */
580 when_if_tty /* 2: --color=tty */
583 enum Dereference_symlink
585 DEREF_UNDEFINED = 0, /* default */
586 DEREF_NEVER,
587 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
588 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
589 DEREF_ALWAYS /* -L */
592 enum indicator_no
594 C_LEFT, C_RIGHT, C_END, C_RESET, C_NORM, C_FILE, C_DIR, C_LINK,
595 C_FIFO, C_SOCK,
596 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
597 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE, C_CAP, C_MULTIHARDLINK,
598 C_CLR_TO_EOL
601 static char const *const indicator_name[]=
603 "lc", "rc", "ec", "rs", "no", "fi", "di", "ln", "pi", "so",
604 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
605 "ow", "tw", "ca", "mh", "cl", nullptr
608 struct color_ext_type
610 struct bin_str ext; /* The extension we're looking for */
611 struct bin_str seq; /* The sequence to output when we do */
612 bool exact_match; /* Whether to compare case insensitively */
613 struct color_ext_type *next; /* Next in list */
616 static struct bin_str color_indicator[] =
618 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
619 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
620 { 0, nullptr }, /* ec: End color (replaces lc+rs+rc) */
621 { LEN_STR_PAIR ("0") }, /* rs: Reset to ordinary colors */
622 { 0, nullptr }, /* no: Normal */
623 { 0, nullptr }, /* fi: File: default */
624 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
625 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
626 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
627 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
628 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
629 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
630 { 0, nullptr }, /* mi: Missing file: undefined */
631 { 0, nullptr }, /* or: Orphaned symlink: undefined */
632 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
633 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
634 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
635 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
636 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
637 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
638 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
639 { 0, nullptr }, /* ca: disabled by default */
640 { 0, nullptr }, /* mh: disabled by default */
641 { LEN_STR_PAIR ("\033[K") }, /* cl: clear to end of line */
644 /* A list mapping file extensions to corresponding display sequence. */
645 static struct color_ext_type *color_ext_list = nullptr;
647 /* Buffer for color sequences */
648 static char *color_buf;
650 /* True means to check for orphaned symbolic link, for displaying
651 colors, or to group symlink to directories with other dirs. */
653 static bool check_symlink_mode;
655 /* True means mention the inode number of each file. -i */
657 static bool print_inode;
659 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
660 other options that imply -l), and -L. */
662 static enum Dereference_symlink dereference;
664 /* True means when a directory is found, display info on its
665 contents. -R */
667 static bool recursive;
669 /* True means when an argument is a directory name, display info
670 on it itself. -d */
672 static bool immediate_dirs;
674 /* True means that directories are grouped before files. */
676 static bool directories_first;
678 /* Which files to ignore. */
680 static enum
682 /* Ignore files whose names start with '.', and files specified by
683 --hide and --ignore. */
684 IGNORE_DEFAULT = 0,
686 /* Ignore '.', '..', and files specified by --ignore. */
687 IGNORE_DOT_AND_DOTDOT,
689 /* Ignore only files specified by --ignore. */
690 IGNORE_MINIMAL
691 } ignore_mode;
693 /* A linked list of shell-style globbing patterns. If a non-argument
694 file name matches any of these patterns, it is ignored.
695 Controlled by -I. Multiple -I options accumulate.
696 The -B option adds '*~' and '.*~' to this list. */
698 struct ignore_pattern
700 char const *pattern;
701 struct ignore_pattern *next;
704 static struct ignore_pattern *ignore_patterns;
706 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
707 variable itself to be ignored. */
708 static struct ignore_pattern *hide_patterns;
710 /* True means output nongraphic chars in file names as '?'.
711 (-q, --hide-control-chars)
712 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
713 independent. The algorithm is: first, obey the quoting style to get a
714 string representing the file name; then, if qmark_funny_chars is set,
715 replace all nonprintable chars in that string with '?'. It's necessary
716 to replace nonprintable chars even in quoted strings, because we don't
717 want to mess up the terminal if control chars get sent to it, and some
718 quoting methods pass through control chars as-is. */
719 static bool qmark_funny_chars;
721 /* Quoting options for file and dir name output. */
723 static struct quoting_options *filename_quoting_options;
724 static struct quoting_options *dirname_quoting_options;
726 /* The number of chars per hardware tab stop. Setting this to zero
727 inhibits the use of TAB characters for separating columns. -T */
728 static size_t tabsize;
730 /* True means print each directory name before listing it. */
732 static bool print_dir_name;
734 /* The line length to use for breaking lines in many-per-line format.
735 Can be set with -w. If zero, there is no limit. */
737 static size_t line_length;
739 /* The local time zone rules, as per the TZ environment variable. */
741 static timezone_t localtz;
743 /* If true, the file listing format requires that stat be called on
744 each file. */
746 static bool format_needs_stat;
748 /* Similar to 'format_needs_stat', but set if only the file type is
749 needed. */
751 static bool format_needs_type;
753 /* An arbitrary limit on the number of bytes in a printed timestamp.
754 This is set to a relatively small value to avoid the need to worry
755 about denial-of-service attacks on servers that run "ls" on behalf
756 of remote clients. 1000 bytes should be enough for any practical
757 timestamp format. */
759 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
761 /* strftime formats for non-recent and recent files, respectively, in
762 -l output. */
764 static char const *long_time_format[2] =
766 /* strftime format for non-recent files (older than 6 months), in
767 -l output. This should contain the year, month and day (at
768 least), in an order that is understood by people in your
769 locale's territory. Please try to keep the number of used
770 screen columns small, because many people work in windows with
771 only 80 columns. But make this as wide as the other string
772 below, for recent files. */
773 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
774 so be wary of using variable width fields from the locale.
775 Note %b is handled specially by ls and aligned correctly.
776 Note also that specifying a width as in %5b is erroneous as strftime
777 will count bytes rather than characters in multibyte locales. */
778 N_("%b %e %Y"),
779 /* strftime format for recent files (younger than 6 months), in -l
780 output. This should contain the month, day and time (at
781 least), in an order that is understood by people in your
782 locale's territory. Please try to keep the number of used
783 screen columns small, because many people work in windows with
784 only 80 columns. But make this as wide as the other string
785 above, for non-recent files. */
786 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
787 so be wary of using variable width fields from the locale.
788 Note %b is handled specially by ls and aligned correctly.
789 Note also that specifying a width as in %5b is erroneous as strftime
790 will count bytes rather than characters in multibyte locales. */
791 N_("%b %e %H:%M")
794 /* The set of signals that are caught. */
796 static sigset_t caught_signals;
798 /* If nonzero, the value of the pending fatal signal. */
800 static sig_atomic_t volatile interrupt_signal;
802 /* A count of the number of pending stop signals that have been received. */
804 static sig_atomic_t volatile stop_signal_count;
806 /* Desired exit status. */
808 static int exit_status;
810 /* Exit statuses. */
811 enum
813 /* "ls" had a minor problem. E.g., while processing a directory,
814 ls obtained the name of an entry via readdir, yet was later
815 unable to stat that name. This happens when listing a directory
816 in which entries are actively being removed or renamed. */
817 LS_MINOR_PROBLEM = 1,
819 /* "ls" had more serious trouble (e.g., memory exhausted, invalid
820 option or failure to stat a command line argument. */
821 LS_FAILURE = 2
824 /* For long options that have no equivalent short option, use a
825 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
826 enum
828 AUTHOR_OPTION = CHAR_MAX + 1,
829 BLOCK_SIZE_OPTION,
830 COLOR_OPTION,
831 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
832 FILE_TYPE_INDICATOR_OPTION,
833 FORMAT_OPTION,
834 FULL_TIME_OPTION,
835 GROUP_DIRECTORIES_FIRST_OPTION,
836 HIDE_OPTION,
837 HYPERLINK_OPTION,
838 INDICATOR_STYLE_OPTION,
839 QUOTING_STYLE_OPTION,
840 SHOW_CONTROL_CHARS_OPTION,
841 SI_OPTION,
842 SORT_OPTION,
843 TIME_OPTION,
844 TIME_STYLE_OPTION,
845 ZERO_OPTION,
848 static struct option const long_options[] =
850 {"all", no_argument, nullptr, 'a'},
851 {"escape", no_argument, nullptr, 'b'},
852 {"directory", no_argument, nullptr, 'd'},
853 {"dired", no_argument, nullptr, 'D'},
854 {"full-time", no_argument, nullptr, FULL_TIME_OPTION},
855 {"group-directories-first", no_argument, nullptr,
856 GROUP_DIRECTORIES_FIRST_OPTION},
857 {"human-readable", no_argument, nullptr, 'h'},
858 {"inode", no_argument, nullptr, 'i'},
859 {"kibibytes", no_argument, nullptr, 'k'},
860 {"numeric-uid-gid", no_argument, nullptr, 'n'},
861 {"no-group", no_argument, nullptr, 'G'},
862 {"hide-control-chars", no_argument, nullptr, 'q'},
863 {"reverse", no_argument, nullptr, 'r'},
864 {"size", no_argument, nullptr, 's'},
865 {"width", required_argument, nullptr, 'w'},
866 {"almost-all", no_argument, nullptr, 'A'},
867 {"ignore-backups", no_argument, nullptr, 'B'},
868 {"classify", optional_argument, nullptr, 'F'},
869 {"file-type", no_argument, nullptr, FILE_TYPE_INDICATOR_OPTION},
870 {"si", no_argument, nullptr, SI_OPTION},
871 {"dereference-command-line", no_argument, nullptr, 'H'},
872 {"dereference-command-line-symlink-to-dir", no_argument, nullptr,
873 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
874 {"hide", required_argument, nullptr, HIDE_OPTION},
875 {"ignore", required_argument, nullptr, 'I'},
876 {"indicator-style", required_argument, nullptr, INDICATOR_STYLE_OPTION},
877 {"dereference", no_argument, nullptr, 'L'},
878 {"literal", no_argument, nullptr, 'N'},
879 {"quote-name", no_argument, nullptr, 'Q'},
880 {"quoting-style", required_argument, nullptr, QUOTING_STYLE_OPTION},
881 {"recursive", no_argument, nullptr, 'R'},
882 {"format", required_argument, nullptr, FORMAT_OPTION},
883 {"show-control-chars", no_argument, nullptr, SHOW_CONTROL_CHARS_OPTION},
884 {"sort", required_argument, nullptr, SORT_OPTION},
885 {"tabsize", required_argument, nullptr, 'T'},
886 {"time", required_argument, nullptr, TIME_OPTION},
887 {"time-style", required_argument, nullptr, TIME_STYLE_OPTION},
888 {"zero", no_argument, nullptr, ZERO_OPTION},
889 {"color", optional_argument, nullptr, COLOR_OPTION},
890 {"hyperlink", optional_argument, nullptr, HYPERLINK_OPTION},
891 {"block-size", required_argument, nullptr, BLOCK_SIZE_OPTION},
892 {"context", no_argument, 0, 'Z'},
893 {"author", no_argument, nullptr, AUTHOR_OPTION},
894 {GETOPT_HELP_OPTION_DECL},
895 {GETOPT_VERSION_OPTION_DECL},
896 {nullptr, 0, nullptr, 0}
899 static char const *const format_args[] =
901 "verbose", "long", "commas", "horizontal", "across",
902 "vertical", "single-column", nullptr
904 static enum format const format_types[] =
906 long_format, long_format, with_commas, horizontal, horizontal,
907 many_per_line, one_per_line
909 ARGMATCH_VERIFY (format_args, format_types);
911 static char const *const sort_args[] =
913 "none", "time", "size", "extension", "version", "width", nullptr
915 static enum sort_type const sort_types[] =
917 sort_none, sort_time, sort_size, sort_extension, sort_version, sort_width
919 ARGMATCH_VERIFY (sort_args, sort_types);
921 static char const *const time_args[] =
923 "atime", "access", "use",
924 "ctime", "status",
925 "mtime", "modification",
926 "birth", "creation",
927 nullptr
929 static enum time_type const time_types[] =
931 time_atime, time_atime, time_atime,
932 time_ctime, time_ctime,
933 time_mtime, time_mtime,
934 time_btime, time_btime,
936 ARGMATCH_VERIFY (time_args, time_types);
938 static char const *const when_args[] =
940 /* force and none are for compatibility with another color-ls version */
941 "always", "yes", "force",
942 "never", "no", "none",
943 "auto", "tty", "if-tty", nullptr
945 static enum when_type const when_types[] =
947 when_always, when_always, when_always,
948 when_never, when_never, when_never,
949 when_if_tty, when_if_tty, when_if_tty
951 ARGMATCH_VERIFY (when_args, when_types);
953 /* Information about filling a column. */
954 struct column_info
956 bool valid_len;
957 size_t line_len;
958 size_t *col_arr;
961 /* Array with information about column filledness. */
962 static struct column_info *column_info;
964 /* Maximum number of columns ever possible for this display. */
965 static size_t max_idx;
967 /* The minimum width of a column is 3: 1 character for the name and 2
968 for the separating white space. */
969 enum { MIN_COLUMN_WIDTH = 3 };
972 /* This zero-based index is for the --dired option. It is incremented
973 for each byte of output generated by this program so that the beginning
974 and ending indices (in that output) of every file name can be recorded
975 and later output themselves. */
976 static off_t dired_pos;
978 static void
979 dired_outbyte (char c)
981 dired_pos++;
982 putchar (c);
985 /* Output the buffer S, of length S_LEN, and increment DIRED_POS by S_LEN. */
986 static void
987 dired_outbuf (char const *s, size_t s_len)
989 dired_pos += s_len;
990 fwrite (s, sizeof *s, s_len, stdout);
993 /* Output the string S, and increment DIRED_POS by its length. */
994 static void
995 dired_outstring (char const *s)
997 dired_outbuf (s, strlen (s));
1000 static void
1001 dired_indent (void)
1003 if (dired)
1004 dired_outstring (" ");
1007 /* With --dired, store pairs of beginning and ending indices of file names. */
1008 static struct obstack dired_obstack;
1010 /* With --dired, store pairs of beginning and ending indices of any
1011 directory names that appear as headers (just before 'total' line)
1012 for lists of directory entries. Such directory names are seen when
1013 listing hierarchies using -R and when a directory is listed with at
1014 least one other command line argument. */
1015 static struct obstack subdired_obstack;
1017 /* Save the current index on the specified obstack, OBS. */
1018 static void
1019 push_current_dired_pos (struct obstack *obs)
1021 if (dired)
1022 obstack_grow (obs, &dired_pos, sizeof dired_pos);
1025 /* With -R, this stack is used to help detect directory cycles.
1026 The device/inode pairs on this stack mirror the pairs in the
1027 active_dir_set hash table. */
1028 static struct obstack dev_ino_obstack;
1030 /* Push a pair onto the device/inode stack. */
1031 static void
1032 dev_ino_push (dev_t dev, ino_t ino)
1034 void *vdi;
1035 struct dev_ino *di;
1036 int dev_ino_size = sizeof *di;
1037 obstack_blank (&dev_ino_obstack, dev_ino_size);
1038 vdi = obstack_next_free (&dev_ino_obstack);
1039 di = vdi;
1040 di--;
1041 di->st_dev = dev;
1042 di->st_ino = ino;
1045 /* Pop a dev/ino struct off the global dev_ino_obstack
1046 and return that struct. */
1047 static struct dev_ino
1048 dev_ino_pop (void)
1050 void *vdi;
1051 struct dev_ino *di;
1052 int dev_ino_size = sizeof *di;
1053 affirm (dev_ino_size <= obstack_object_size (&dev_ino_obstack));
1054 obstack_blank_fast (&dev_ino_obstack, -dev_ino_size);
1055 vdi = obstack_next_free (&dev_ino_obstack);
1056 di = vdi;
1057 return *di;
1060 static void
1061 assert_matching_dev_ino (char const *name, struct dev_ino di)
1063 MAYBE_UNUSED struct stat sb;
1064 assure (0 <= stat (name, &sb));
1065 assure (sb.st_dev == di.st_dev);
1066 assure (sb.st_ino == di.st_ino);
1069 static char eolbyte = '\n';
1071 /* Write to standard output PREFIX, followed by the quoting style and
1072 a space-separated list of the integers stored in OS all on one line. */
1074 static void
1075 dired_dump_obstack (char const *prefix, struct obstack *os)
1077 size_t n_pos;
1079 n_pos = obstack_object_size (os) / sizeof (dired_pos);
1080 if (n_pos > 0)
1082 off_t *pos = obstack_finish (os);
1083 fputs (prefix, stdout);
1084 for (size_t i = 0; i < n_pos; i++)
1086 intmax_t p = pos[i];
1087 printf (" %"PRIdMAX, p);
1089 putchar ('\n');
1093 /* Return the platform birthtime member of the stat structure,
1094 or fallback to the mtime member, which we have populated
1095 from the statx structure or reset to an invalid timestamp
1096 where birth time is not supported. */
1097 static struct timespec
1098 get_stat_btime (struct stat const *st)
1100 struct timespec btimespec;
1102 #if HAVE_STATX && defined STATX_INO
1103 btimespec = get_stat_mtime (st);
1104 #else
1105 btimespec = get_stat_birthtime (st);
1106 #endif
1108 return btimespec;
1111 #if HAVE_STATX && defined STATX_INO
1112 ATTRIBUTE_PURE
1113 static unsigned int
1114 time_type_to_statx (void)
1116 switch (time_type)
1118 case time_ctime:
1119 return STATX_CTIME;
1120 case time_mtime:
1121 return STATX_MTIME;
1122 case time_atime:
1123 return STATX_ATIME;
1124 case time_btime:
1125 return STATX_BTIME;
1126 default:
1127 unreachable ();
1129 return 0;
1132 ATTRIBUTE_PURE
1133 static unsigned int
1134 calc_req_mask (void)
1136 unsigned int mask = STATX_MODE;
1138 if (print_inode)
1139 mask |= STATX_INO;
1141 if (print_block_size)
1142 mask |= STATX_BLOCKS;
1144 if (format == long_format) {
1145 mask |= STATX_NLINK | STATX_SIZE | time_type_to_statx ();
1146 if (print_owner || print_author)
1147 mask |= STATX_UID;
1148 if (print_group)
1149 mask |= STATX_GID;
1152 switch (sort_type)
1154 case sort_none:
1155 case sort_name:
1156 case sort_version:
1157 case sort_extension:
1158 case sort_width:
1159 break;
1160 case sort_time:
1161 mask |= time_type_to_statx ();
1162 break;
1163 case sort_size:
1164 mask |= STATX_SIZE;
1165 break;
1166 default:
1167 unreachable ();
1170 return mask;
1173 static int
1174 do_statx (int fd, char const *name, struct stat *st, int flags,
1175 unsigned int mask)
1177 struct statx stx;
1178 bool want_btime = mask & STATX_BTIME;
1179 int ret = statx (fd, name, flags | AT_NO_AUTOMOUNT, mask, &stx);
1180 if (ret >= 0)
1182 statx_to_stat (&stx, st);
1183 /* Since we only need one timestamp type,
1184 store birth time in st_mtim. */
1185 if (want_btime)
1187 if (stx.stx_mask & STATX_BTIME)
1188 st->st_mtim = statx_timestamp_to_timespec (stx.stx_btime);
1189 else
1190 st->st_mtim.tv_sec = st->st_mtim.tv_nsec = -1;
1194 return ret;
1197 static int
1198 do_stat (char const *name, struct stat *st)
1200 return do_statx (AT_FDCWD, name, st, 0, calc_req_mask ());
1203 static int
1204 do_lstat (char const *name, struct stat *st)
1206 return do_statx (AT_FDCWD, name, st, AT_SYMLINK_NOFOLLOW, calc_req_mask ());
1209 static int
1210 stat_for_mode (char const *name, struct stat *st)
1212 return do_statx (AT_FDCWD, name, st, 0, STATX_MODE);
1215 /* dev+ino should be static, so no need to sync with backing store */
1216 static int
1217 stat_for_ino (char const *name, struct stat *st)
1219 return do_statx (AT_FDCWD, name, st, 0, STATX_INO);
1222 static int
1223 fstat_for_ino (int fd, struct stat *st)
1225 return do_statx (fd, "", st, AT_EMPTY_PATH, STATX_INO);
1227 #else
1228 static int
1229 do_stat (char const *name, struct stat *st)
1231 return stat (name, st);
1234 static int
1235 do_lstat (char const *name, struct stat *st)
1237 return lstat (name, st);
1240 static int
1241 stat_for_mode (char const *name, struct stat *st)
1243 return stat (name, st);
1246 static int
1247 stat_for_ino (char const *name, struct stat *st)
1249 return stat (name, st);
1252 static int
1253 fstat_for_ino (int fd, struct stat *st)
1255 return fstat (fd, st);
1257 #endif
1259 /* Return the address of the first plain %b spec in FMT, or nullptr if
1260 there is no such spec. %5b etc. do not match, so that user
1261 widths/flags are honored. */
1263 ATTRIBUTE_PURE
1264 static char const *
1265 first_percent_b (char const *fmt)
1267 for (; *fmt; fmt++)
1268 if (fmt[0] == '%')
1269 switch (fmt[1])
1271 case 'b': return fmt;
1272 case '%': fmt++; break;
1274 return nullptr;
1277 static char RFC3986[256];
1278 static void
1279 file_escape_init (void)
1281 for (int i = 0; i < 256; i++)
1282 RFC3986[i] |= c_isalnum (i) || i == '~' || i == '-' || i == '.' || i == '_';
1285 /* Read the abbreviated month names from the locale, to align them
1286 and to determine the max width of the field and to truncate names
1287 greater than our max allowed.
1288 Note even though this handles multibyte locales correctly
1289 it's not restricted to them as single byte locales can have
1290 variable width abbreviated months and also precomputing/caching
1291 the names was seen to increase the performance of ls significantly. */
1293 /* max number of display cells to use.
1294 As of 2018 the abmon for Arabic has entries with width 12.
1295 It doesn't make much sense to support wider than this
1296 and locales should aim for abmon entries of width <= 5. */
1297 enum { MAX_MON_WIDTH = 12 };
1298 /* abformat[RECENT][MON] is the format to use for timestamps with
1299 recentness RECENT and month MON. */
1300 enum { ABFORMAT_SIZE = 128 };
1301 static char abformat[2][12][ABFORMAT_SIZE];
1302 /* True if precomputed formats should be used. This can be false if
1303 nl_langinfo fails, if a format or month abbreviation is unusually
1304 long, or if a month abbreviation contains '%'. */
1305 static bool use_abformat;
1307 /* Store into ABMON the abbreviated month names, suitably aligned.
1308 Return true if successful. */
1310 static bool
1311 abmon_init (char abmon[12][ABFORMAT_SIZE])
1313 #ifndef HAVE_NL_LANGINFO
1314 return false;
1315 #else
1316 size_t required_mon_width = MAX_MON_WIDTH;
1317 size_t curr_max_width;
1320 curr_max_width = required_mon_width;
1321 required_mon_width = 0;
1322 for (int i = 0; i < 12; i++)
1324 size_t width = curr_max_width;
1325 char const *abbr = nl_langinfo (ABMON_1 + i);
1326 if (strchr (abbr, '%'))
1327 return false;
1328 mbs_align_t alignment = isdigit (to_uchar (*abbr))
1329 ? MBS_ALIGN_RIGHT : MBS_ALIGN_LEFT;
1330 size_t req = mbsalign (abbr, abmon[i], ABFORMAT_SIZE,
1331 &width, alignment, 0);
1332 if (! (req < ABFORMAT_SIZE))
1333 return false;
1334 required_mon_width = MAX (required_mon_width, width);
1337 while (curr_max_width > required_mon_width);
1339 return true;
1340 #endif
1343 /* Initialize ABFORMAT and USE_ABFORMAT. */
1345 static void
1346 abformat_init (void)
1348 char const *pb[2];
1349 for (int recent = 0; recent < 2; recent++)
1350 pb[recent] = first_percent_b (long_time_format[recent]);
1351 if (! (pb[0] || pb[1]))
1352 return;
1354 char abmon[12][ABFORMAT_SIZE];
1355 if (! abmon_init (abmon))
1356 return;
1358 for (int recent = 0; recent < 2; recent++)
1360 char const *fmt = long_time_format[recent];
1361 for (int i = 0; i < 12; i++)
1363 char *nfmt = abformat[recent][i];
1364 int nbytes;
1366 if (! pb[recent])
1367 nbytes = snprintf (nfmt, ABFORMAT_SIZE, "%s", fmt);
1368 else
1370 if (! (pb[recent] - fmt <= MIN (ABFORMAT_SIZE, INT_MAX)))
1371 return;
1372 int prefix_len = pb[recent] - fmt;
1373 nbytes = snprintf (nfmt, ABFORMAT_SIZE, "%.*s%s%s",
1374 prefix_len, fmt, abmon[i], pb[recent] + 2);
1377 if (! (0 <= nbytes && nbytes < ABFORMAT_SIZE))
1378 return;
1382 use_abformat = true;
1385 static size_t
1386 dev_ino_hash (void const *x, size_t table_size)
1388 struct dev_ino const *p = x;
1389 return (uintmax_t) p->st_ino % table_size;
1392 static bool
1393 dev_ino_compare (void const *x, void const *y)
1395 struct dev_ino const *a = x;
1396 struct dev_ino const *b = y;
1397 return SAME_INODE (*a, *b) ? true : false;
1400 static void
1401 dev_ino_free (void *x)
1403 free (x);
1406 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
1407 active directories. Return true if there is already a matching
1408 entry in the table. */
1410 static bool
1411 visit_dir (dev_t dev, ino_t ino)
1413 struct dev_ino *ent;
1414 struct dev_ino *ent_from_table;
1415 bool found_match;
1417 ent = xmalloc (sizeof *ent);
1418 ent->st_ino = ino;
1419 ent->st_dev = dev;
1421 /* Attempt to insert this entry into the table. */
1422 ent_from_table = hash_insert (active_dir_set, ent);
1424 if (ent_from_table == nullptr)
1426 /* Insertion failed due to lack of memory. */
1427 xalloc_die ();
1430 found_match = (ent_from_table != ent);
1432 if (found_match)
1434 /* ent was not inserted, so free it. */
1435 free (ent);
1438 return found_match;
1441 static void
1442 free_pending_ent (struct pending *p)
1444 free (p->name);
1445 free (p->realname);
1446 free (p);
1449 static bool
1450 is_colored (enum indicator_no type)
1452 size_t len = color_indicator[type].len;
1453 char const *s = color_indicator[type].string;
1454 return ! (len == 0
1455 || (len == 1 && STRNCMP_LIT (s, "0") == 0)
1456 || (len == 2 && STRNCMP_LIT (s, "00") == 0));
1459 static void
1460 restore_default_color (void)
1462 put_indicator (&color_indicator[C_LEFT]);
1463 put_indicator (&color_indicator[C_RIGHT]);
1466 static void
1467 set_normal_color (void)
1469 if (print_with_color && is_colored (C_NORM))
1471 put_indicator (&color_indicator[C_LEFT]);
1472 put_indicator (&color_indicator[C_NORM]);
1473 put_indicator (&color_indicator[C_RIGHT]);
1477 /* An ordinary signal was received; arrange for the program to exit. */
1479 static void
1480 sighandler (int sig)
1482 if (! SA_NOCLDSTOP)
1483 signal (sig, SIG_IGN);
1484 if (! interrupt_signal)
1485 interrupt_signal = sig;
1488 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1490 static void
1491 stophandler (int sig)
1493 if (! SA_NOCLDSTOP)
1494 signal (sig, stophandler);
1495 if (! interrupt_signal)
1496 stop_signal_count++;
1499 /* Process any pending signals. If signals are caught, this function
1500 should be called periodically. Ideally there should never be an
1501 unbounded amount of time when signals are not being processed.
1502 Signal handling can restore the default colors, so callers must
1503 immediately change colors after invoking this function. */
1505 static void
1506 process_signals (void)
1508 while (interrupt_signal || stop_signal_count)
1510 int sig;
1511 int stops;
1512 sigset_t oldset;
1514 if (used_color)
1515 restore_default_color ();
1516 fflush (stdout);
1518 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1520 /* Reload interrupt_signal and stop_signal_count, in case a new
1521 signal was handled before sigprocmask took effect. */
1522 sig = interrupt_signal;
1523 stops = stop_signal_count;
1525 /* SIGTSTP is special, since the application can receive that signal
1526 more than once. In this case, don't set the signal handler to the
1527 default. Instead, just raise the uncatchable SIGSTOP. */
1528 if (stops)
1530 stop_signal_count = stops - 1;
1531 sig = SIGSTOP;
1533 else
1534 signal (sig, SIG_DFL);
1536 /* Exit or suspend the program. */
1537 raise (sig);
1538 sigprocmask (SIG_SETMASK, &oldset, nullptr);
1540 /* If execution reaches here, then the program has been
1541 continued (after being suspended). */
1545 /* Setup signal handlers if INIT is true,
1546 otherwise restore to the default. */
1548 static void
1549 signal_setup (bool init)
1551 /* The signals that are trapped, and the number of such signals. */
1552 static int const sig[] =
1554 /* This one is handled specially. */
1555 SIGTSTP,
1557 /* The usual suspects. */
1558 SIGALRM, SIGHUP, SIGINT, SIGPIPE, SIGQUIT, SIGTERM,
1559 #ifdef SIGPOLL
1560 SIGPOLL,
1561 #endif
1562 #ifdef SIGPROF
1563 SIGPROF,
1564 #endif
1565 #ifdef SIGVTALRM
1566 SIGVTALRM,
1567 #endif
1568 #ifdef SIGXCPU
1569 SIGXCPU,
1570 #endif
1571 #ifdef SIGXFSZ
1572 SIGXFSZ,
1573 #endif
1575 enum { nsigs = ARRAY_CARDINALITY (sig) };
1577 #if ! SA_NOCLDSTOP
1578 static bool caught_sig[nsigs];
1579 #endif
1581 int j;
1583 if (init)
1585 #if SA_NOCLDSTOP
1586 struct sigaction act;
1588 sigemptyset (&caught_signals);
1589 for (j = 0; j < nsigs; j++)
1591 sigaction (sig[j], nullptr, &act);
1592 if (act.sa_handler != SIG_IGN)
1593 sigaddset (&caught_signals, sig[j]);
1596 act.sa_mask = caught_signals;
1597 act.sa_flags = SA_RESTART;
1599 for (j = 0; j < nsigs; j++)
1600 if (sigismember (&caught_signals, sig[j]))
1602 act.sa_handler = sig[j] == SIGTSTP ? stophandler : sighandler;
1603 sigaction (sig[j], &act, nullptr);
1605 #else
1606 for (j = 0; j < nsigs; j++)
1608 caught_sig[j] = (signal (sig[j], SIG_IGN) != SIG_IGN);
1609 if (caught_sig[j])
1611 signal (sig[j], sig[j] == SIGTSTP ? stophandler : sighandler);
1612 siginterrupt (sig[j], 0);
1615 #endif
1617 else /* restore. */
1619 #if SA_NOCLDSTOP
1620 for (j = 0; j < nsigs; j++)
1621 if (sigismember (&caught_signals, sig[j]))
1622 signal (sig[j], SIG_DFL);
1623 #else
1624 for (j = 0; j < nsigs; j++)
1625 if (caught_sig[j])
1626 signal (sig[j], SIG_DFL);
1627 #endif
1631 static void
1632 signal_init (void)
1634 signal_setup (true);
1637 static void
1638 signal_restore (void)
1640 signal_setup (false);
1644 main (int argc, char **argv)
1646 int i;
1647 struct pending *thispend;
1648 int n_files;
1650 initialize_main (&argc, &argv);
1651 set_program_name (argv[0]);
1652 setlocale (LC_ALL, "");
1653 bindtextdomain (PACKAGE, LOCALEDIR);
1654 textdomain (PACKAGE);
1656 initialize_exit_failure (LS_FAILURE);
1657 atexit (close_stdout);
1659 static_assert (ARRAY_CARDINALITY (color_indicator) + 1
1660 == ARRAY_CARDINALITY (indicator_name));
1662 exit_status = EXIT_SUCCESS;
1663 print_dir_name = true;
1664 pending_dirs = nullptr;
1666 current_time.tv_sec = TYPE_MINIMUM (time_t);
1667 current_time.tv_nsec = -1;
1669 i = decode_switches (argc, argv);
1671 if (print_with_color)
1672 parse_ls_color ();
1674 /* Test print_with_color again, because the call to parse_ls_color
1675 may have just reset it -- e.g., if LS_COLORS is invalid. */
1677 if (print_with_color)
1679 /* Don't use TAB characters in output. Some terminal
1680 emulators can't handle the combination of tabs and
1681 color codes on the same line. */
1682 tabsize = 0;
1685 if (directories_first)
1686 check_symlink_mode = true;
1687 else if (print_with_color)
1689 /* Avoid following symbolic links when possible. */
1690 if (is_colored (C_ORPHAN)
1691 || (is_colored (C_EXEC) && color_symlink_as_referent)
1692 || (is_colored (C_MISSING) && format == long_format))
1693 check_symlink_mode = true;
1696 if (dereference == DEREF_UNDEFINED)
1697 dereference = ((immediate_dirs
1698 || indicator_style == classify
1699 || format == long_format)
1700 ? DEREF_NEVER
1701 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR);
1703 /* When using -R, initialize a data structure we'll use to
1704 detect any directory cycles. */
1705 if (recursive)
1707 active_dir_set = hash_initialize (INITIAL_TABLE_SIZE, nullptr,
1708 dev_ino_hash,
1709 dev_ino_compare,
1710 dev_ino_free);
1711 if (active_dir_set == nullptr)
1712 xalloc_die ();
1714 obstack_init (&dev_ino_obstack);
1717 localtz = tzalloc (getenv ("TZ"));
1719 format_needs_stat = sort_type == sort_time || sort_type == sort_size
1720 || format == long_format
1721 || print_scontext
1722 || print_block_size;
1723 format_needs_type = (! format_needs_stat
1724 && (recursive
1725 || print_with_color
1726 || indicator_style != none
1727 || directories_first));
1729 if (dired)
1731 obstack_init (&dired_obstack);
1732 obstack_init (&subdired_obstack);
1735 if (print_hyperlink)
1737 file_escape_init ();
1739 hostname = xgethostname ();
1740 /* The hostname is generally ignored,
1741 so ignore failures obtaining it. */
1742 if (! hostname)
1743 hostname = "";
1746 cwd_n_alloc = 100;
1747 cwd_file = xnmalloc (cwd_n_alloc, sizeof *cwd_file);
1748 cwd_n_used = 0;
1750 clear_files ();
1752 n_files = argc - i;
1754 if (n_files <= 0)
1756 if (immediate_dirs)
1757 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1758 else
1759 queue_directory (".", nullptr, true);
1761 else
1763 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1764 while (i < argc);
1766 if (cwd_n_used)
1768 sort_files ();
1769 if (!immediate_dirs)
1770 extract_dirs_from_files (nullptr, true);
1771 /* 'cwd_n_used' might be zero now. */
1774 /* In the following if/else blocks, it is sufficient to test 'pending_dirs'
1775 (and not pending_dirs->name) because there may be no markers in the queue
1776 at this point. A marker may be enqueued when extract_dirs_from_files is
1777 called with a non-empty string or via print_dir. */
1778 if (cwd_n_used)
1780 print_current_files ();
1781 if (pending_dirs)
1782 dired_outbyte ('\n');
1784 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1785 print_dir_name = false;
1787 while (pending_dirs)
1789 thispend = pending_dirs;
1790 pending_dirs = pending_dirs->next;
1792 if (LOOP_DETECT)
1794 if (thispend->name == nullptr)
1796 /* thispend->name == nullptr means this is a marker entry
1797 indicating we've finished processing the directory.
1798 Use its dev/ino numbers to remove the corresponding
1799 entry from the active_dir_set hash table. */
1800 struct dev_ino di = dev_ino_pop ();
1801 struct dev_ino *found = hash_remove (active_dir_set, &di);
1802 if (false)
1803 assert_matching_dev_ino (thispend->realname, di);
1804 affirm (found);
1805 dev_ino_free (found);
1806 free_pending_ent (thispend);
1807 continue;
1811 print_dir (thispend->name, thispend->realname,
1812 thispend->command_line_arg);
1814 free_pending_ent (thispend);
1815 print_dir_name = true;
1818 if (print_with_color && used_color)
1820 int j;
1822 /* Skip the restore when it would be a no-op, i.e.,
1823 when left is "\033[" and right is "m". */
1824 if (!(color_indicator[C_LEFT].len == 2
1825 && memcmp (color_indicator[C_LEFT].string, "\033[", 2) == 0
1826 && color_indicator[C_RIGHT].len == 1
1827 && color_indicator[C_RIGHT].string[0] == 'm'))
1828 restore_default_color ();
1830 fflush (stdout);
1832 signal_restore ();
1834 /* Act on any signals that arrived before the default was restored.
1835 This can process signals out of order, but there doesn't seem to
1836 be an easy way to do them in order, and the order isn't that
1837 important anyway. */
1838 for (j = stop_signal_count; j; j--)
1839 raise (SIGSTOP);
1840 j = interrupt_signal;
1841 if (j)
1842 raise (j);
1845 if (dired)
1847 /* No need to free these since we're about to exit. */
1848 dired_dump_obstack ("//DIRED//", &dired_obstack);
1849 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1850 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1851 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1854 if (LOOP_DETECT)
1856 assure (hash_get_n_entries (active_dir_set) == 0);
1857 hash_free (active_dir_set);
1860 return exit_status;
1863 /* Return the line length indicated by the value given by SPEC, or -1
1864 if unsuccessful. 0 means no limit on line length. */
1866 static ptrdiff_t
1867 decode_line_length (char const *spec)
1869 uintmax_t val;
1871 /* Treat too-large values as if they were 0, which is
1872 effectively infinity. */
1873 switch (xstrtoumax (spec, nullptr, 0, &val, ""))
1875 case LONGINT_OK:
1876 return val <= MIN (PTRDIFF_MAX, SIZE_MAX) ? val : 0;
1878 case LONGINT_OVERFLOW:
1879 return 0;
1881 default:
1882 return -1;
1886 /* Return true if standard output is a tty, caching the result. */
1888 static bool
1889 stdout_isatty (void)
1891 static signed char out_tty = -1;
1892 if (out_tty < 0)
1893 out_tty = isatty (STDOUT_FILENO);
1894 assume (out_tty == 0 || out_tty == 1);
1895 return out_tty;
1898 /* Set all the option flags according to the switches specified.
1899 Return the index of the first non-option argument. */
1901 static int
1902 decode_switches (int argc, char **argv)
1904 char *time_style_option = nullptr;
1906 /* These variables are false or -1 unless a switch says otherwise. */
1907 bool kibibytes_specified = false;
1908 int format_opt = -1;
1909 int hide_control_chars_opt = -1;
1910 int quoting_style_opt = -1;
1911 int sort_opt = -1;
1912 ptrdiff_t tabsize_opt = -1;
1913 ptrdiff_t width_opt = -1;
1915 while (true)
1917 int oi = -1;
1918 int c = getopt_long (argc, argv,
1919 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1920 long_options, &oi);
1921 if (c == -1)
1922 break;
1924 switch (c)
1926 case 'a':
1927 ignore_mode = IGNORE_MINIMAL;
1928 break;
1930 case 'b':
1931 quoting_style_opt = escape_quoting_style;
1932 break;
1934 case 'c':
1935 time_type = time_ctime;
1936 break;
1938 case 'd':
1939 immediate_dirs = true;
1940 break;
1942 case 'f':
1943 /* Same as -a -U -1 --color=none --hyperlink=none,
1944 while disabling -s. */
1945 ignore_mode = IGNORE_MINIMAL;
1946 sort_opt = sort_none;
1947 if (format_opt == long_format)
1948 format_opt = -1;
1949 print_with_color = false;
1950 print_hyperlink = false;
1951 print_block_size = false;
1952 break;
1954 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1955 indicator_style = file_type;
1956 break;
1958 case 'g':
1959 format_opt = long_format;
1960 print_owner = false;
1961 break;
1963 case 'h':
1964 file_human_output_opts = human_output_opts =
1965 human_autoscale | human_SI | human_base_1024;
1966 file_output_block_size = output_block_size = 1;
1967 break;
1969 case 'i':
1970 print_inode = true;
1971 break;
1973 case 'k':
1974 kibibytes_specified = true;
1975 break;
1977 case 'l':
1978 format_opt = long_format;
1979 break;
1981 case 'm':
1982 format_opt = with_commas;
1983 break;
1985 case 'n':
1986 numeric_ids = true;
1987 format_opt = long_format;
1988 break;
1990 case 'o': /* Just like -l, but don't display group info. */
1991 format_opt = long_format;
1992 print_group = false;
1993 break;
1995 case 'p':
1996 indicator_style = slash;
1997 break;
1999 case 'q':
2000 hide_control_chars_opt = true;
2001 break;
2003 case 'r':
2004 sort_reverse = true;
2005 break;
2007 case 's':
2008 print_block_size = true;
2009 break;
2011 case 't':
2012 sort_opt = sort_time;
2013 break;
2015 case 'u':
2016 time_type = time_atime;
2017 break;
2019 case 'v':
2020 sort_opt = sort_version;
2021 break;
2023 case 'w':
2024 width_opt = decode_line_length (optarg);
2025 if (width_opt < 0)
2026 error (LS_FAILURE, 0, "%s: %s", _("invalid line width"),
2027 quote (optarg));
2028 break;
2030 case 'x':
2031 format_opt = horizontal;
2032 break;
2034 case 'A':
2035 ignore_mode = IGNORE_DOT_AND_DOTDOT;
2036 break;
2038 case 'B':
2039 add_ignore_pattern ("*~");
2040 add_ignore_pattern (".*~");
2041 break;
2043 case 'C':
2044 format_opt = many_per_line;
2045 break;
2047 case 'D':
2048 dired = true;
2049 break;
2051 case 'F':
2053 int i;
2054 if (optarg)
2055 i = XARGMATCH ("--classify", optarg, when_args, when_types);
2056 else
2057 /* Using --classify with no argument is equivalent to using
2058 --classify=always. */
2059 i = when_always;
2061 if (i == when_always || (i == when_if_tty && stdout_isatty ()))
2062 indicator_style = classify;
2063 break;
2066 case 'G': /* inhibit display of group info */
2067 print_group = false;
2068 break;
2070 case 'H':
2071 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
2072 break;
2074 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
2075 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
2076 break;
2078 case 'I':
2079 add_ignore_pattern (optarg);
2080 break;
2082 case 'L':
2083 dereference = DEREF_ALWAYS;
2084 break;
2086 case 'N':
2087 quoting_style_opt = literal_quoting_style;
2088 break;
2090 case 'Q':
2091 quoting_style_opt = c_quoting_style;
2092 break;
2094 case 'R':
2095 recursive = true;
2096 break;
2098 case 'S':
2099 sort_opt = sort_size;
2100 break;
2102 case 'T':
2103 tabsize_opt = xnumtoumax (optarg, 0, 0, MIN (PTRDIFF_MAX, SIZE_MAX),
2104 "", _("invalid tab size"), LS_FAILURE);
2105 break;
2107 case 'U':
2108 sort_opt = sort_none;
2109 break;
2111 case 'X':
2112 sort_opt = sort_extension;
2113 break;
2115 case '1':
2116 /* -1 has no effect after -l. */
2117 if (format_opt != long_format)
2118 format_opt = one_per_line;
2119 break;
2121 case AUTHOR_OPTION:
2122 print_author = true;
2123 break;
2125 case HIDE_OPTION:
2127 struct ignore_pattern *hide = xmalloc (sizeof *hide);
2128 hide->pattern = optarg;
2129 hide->next = hide_patterns;
2130 hide_patterns = hide;
2132 break;
2134 case SORT_OPTION:
2135 sort_opt = XARGMATCH ("--sort", optarg, sort_args, sort_types);
2136 break;
2138 case GROUP_DIRECTORIES_FIRST_OPTION:
2139 directories_first = true;
2140 break;
2142 case TIME_OPTION:
2143 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
2144 break;
2146 case FORMAT_OPTION:
2147 format_opt = XARGMATCH ("--format", optarg, format_args,
2148 format_types);
2149 break;
2151 case FULL_TIME_OPTION:
2152 format_opt = long_format;
2153 time_style_option = bad_cast ("full-iso");
2154 break;
2156 case COLOR_OPTION:
2158 int i;
2159 if (optarg)
2160 i = XARGMATCH ("--color", optarg, when_args, when_types);
2161 else
2162 /* Using --color with no argument is equivalent to using
2163 --color=always. */
2164 i = when_always;
2166 print_with_color = (i == when_always
2167 || (i == when_if_tty && stdout_isatty ()));
2168 break;
2171 case HYPERLINK_OPTION:
2173 int i;
2174 if (optarg)
2175 i = XARGMATCH ("--hyperlink", optarg, when_args, when_types);
2176 else
2177 /* Using --hyperlink with no argument is equivalent to using
2178 --hyperlink=always. */
2179 i = when_always;
2181 print_hyperlink = (i == when_always
2182 || (i == when_if_tty && stdout_isatty ()));
2183 break;
2186 case INDICATOR_STYLE_OPTION:
2187 indicator_style = XARGMATCH ("--indicator-style", optarg,
2188 indicator_style_args,
2189 indicator_style_types);
2190 break;
2192 case QUOTING_STYLE_OPTION:
2193 quoting_style_opt = XARGMATCH ("--quoting-style", optarg,
2194 quoting_style_args,
2195 quoting_style_vals);
2196 break;
2198 case TIME_STYLE_OPTION:
2199 time_style_option = optarg;
2200 break;
2202 case SHOW_CONTROL_CHARS_OPTION:
2203 hide_control_chars_opt = false;
2204 break;
2206 case BLOCK_SIZE_OPTION:
2208 enum strtol_error e = human_options (optarg, &human_output_opts,
2209 &output_block_size);
2210 if (e != LONGINT_OK)
2211 xstrtol_fatal (e, oi, 0, long_options, optarg);
2212 file_human_output_opts = human_output_opts;
2213 file_output_block_size = output_block_size;
2215 break;
2217 case SI_OPTION:
2218 file_human_output_opts = human_output_opts =
2219 human_autoscale | human_SI;
2220 file_output_block_size = output_block_size = 1;
2221 break;
2223 case 'Z':
2224 print_scontext = true;
2225 break;
2227 case ZERO_OPTION:
2228 eolbyte = 0;
2229 hide_control_chars_opt = false;
2230 if (format_opt != long_format)
2231 format_opt = one_per_line;
2232 print_with_color = false;
2233 quoting_style_opt = literal_quoting_style;
2234 break;
2236 case_GETOPT_HELP_CHAR;
2238 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
2240 default:
2241 usage (LS_FAILURE);
2245 if (! output_block_size)
2247 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
2248 human_options (ls_block_size,
2249 &human_output_opts, &output_block_size);
2250 if (ls_block_size || getenv ("BLOCK_SIZE"))
2252 file_human_output_opts = human_output_opts;
2253 file_output_block_size = output_block_size;
2255 if (kibibytes_specified)
2257 human_output_opts = 0;
2258 output_block_size = 1024;
2262 format = (0 <= format_opt ? format_opt
2263 : ls_mode == LS_LS ? (stdout_isatty ()
2264 ? many_per_line : one_per_line)
2265 : ls_mode == LS_MULTI_COL ? many_per_line
2266 : /* ls_mode == LS_LONG_FORMAT */ long_format);
2268 /* If the line length was not set by a switch but is needed to determine
2269 output, go to the work of obtaining it from the environment. */
2270 ptrdiff_t linelen = width_opt;
2271 if (format == many_per_line || format == horizontal || format == with_commas
2272 || print_with_color)
2274 #ifdef TIOCGWINSZ
2275 if (linelen < 0)
2277 /* Suppress bogus warning re comparing ws.ws_col to big integer. */
2278 # if 4 < __GNUC__ + (6 <= __GNUC_MINOR__)
2279 # pragma GCC diagnostic push
2280 # pragma GCC diagnostic ignored "-Wtype-limits"
2281 # endif
2282 struct winsize ws;
2283 if (stdout_isatty ()
2284 && 0 <= ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws)
2285 && 0 < ws.ws_col)
2286 linelen = ws.ws_col <= MIN (PTRDIFF_MAX, SIZE_MAX) ? ws.ws_col : 0;
2287 # if 4 < __GNUC__ + (6 <= __GNUC_MINOR__)
2288 # pragma GCC diagnostic pop
2289 # endif
2291 #endif
2292 if (linelen < 0)
2294 char const *p = getenv ("COLUMNS");
2295 if (p && *p)
2297 linelen = decode_line_length (p);
2298 if (linelen < 0)
2299 error (0, 0,
2300 _("ignoring invalid width"
2301 " in environment variable COLUMNS: %s"),
2302 quote (p));
2307 line_length = linelen < 0 ? 80 : linelen;
2309 /* Determine the max possible number of display columns. */
2310 max_idx = line_length / MIN_COLUMN_WIDTH;
2311 /* Account for first display column not having a separator,
2312 or line_lengths shorter than MIN_COLUMN_WIDTH. */
2313 max_idx += line_length % MIN_COLUMN_WIDTH != 0;
2315 if (format == many_per_line || format == horizontal || format == with_commas)
2317 if (0 <= tabsize_opt)
2318 tabsize = tabsize_opt;
2319 else
2321 tabsize = 8;
2322 char const *p = getenv ("TABSIZE");
2323 if (p)
2325 uintmax_t tmp;
2326 if (xstrtoumax (p, nullptr, 0, &tmp, "") == LONGINT_OK
2327 && tmp <= SIZE_MAX)
2328 tabsize = tmp;
2329 else
2330 error (0, 0,
2331 _("ignoring invalid tab size"
2332 " in environment variable TABSIZE: %s"),
2333 quote (p));
2338 qmark_funny_chars = (hide_control_chars_opt < 0
2339 ? ls_mode == LS_LS && stdout_isatty ()
2340 : hide_control_chars_opt);
2342 int qs = quoting_style_opt;
2343 if (qs < 0)
2344 qs = getenv_quoting_style ();
2345 if (qs < 0)
2346 qs = (ls_mode == LS_LS
2347 ? (stdout_isatty () ? shell_escape_quoting_style : -1)
2348 : escape_quoting_style);
2349 if (0 <= qs)
2350 set_quoting_style (nullptr, qs);
2351 qs = get_quoting_style (nullptr);
2352 align_variable_outer_quotes
2353 = ((format == long_format
2354 || ((format == many_per_line || format == horizontal) && line_length))
2355 && (qs == shell_quoting_style
2356 || qs == shell_escape_quoting_style
2357 || qs == c_maybe_quoting_style));
2358 filename_quoting_options = clone_quoting_options (nullptr);
2359 if (qs == escape_quoting_style)
2360 set_char_quoting (filename_quoting_options, ' ', 1);
2361 if (file_type <= indicator_style)
2363 char const *p;
2364 for (p = &"*=>@|"[indicator_style - file_type]; *p; p++)
2365 set_char_quoting (filename_quoting_options, *p, 1);
2368 dirname_quoting_options = clone_quoting_options (nullptr);
2369 set_char_quoting (dirname_quoting_options, ':', 1);
2371 /* --dired is meaningful only with --format=long (-l) and sans --hyperlink.
2372 Otherwise, ignore it. FIXME: warn about this?
2373 Alternatively, make --dired imply --format=long? */
2374 dired &= (format == long_format) & !print_hyperlink;
2376 if (eolbyte < dired)
2377 error (LS_FAILURE, 0, _("--dired and --zero are incompatible"));
2379 /* If -c or -u is specified and not -l (or any other option that implies -l),
2380 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
2381 The behavior of ls when using either -c or -u but with neither -l nor -t
2382 appears to be unspecified by POSIX. So, with GNU ls, '-u' alone means
2383 sort by atime (this is the one that's not specified by the POSIX spec),
2384 -lu means show atime and sort by name, -lut means show atime and sort
2385 by atime. */
2387 sort_type = (0 <= sort_opt ? sort_opt
2388 : (format != long_format
2389 && (time_type == time_ctime || time_type == time_atime
2390 || time_type == time_btime))
2391 ? sort_time : sort_name);
2393 if (format == long_format)
2395 char *style = time_style_option;
2396 static char const posix_prefix[] = "posix-";
2398 if (! style)
2399 if (! (style = getenv ("TIME_STYLE")))
2400 style = bad_cast ("locale");
2402 while (STREQ_LEN (style, posix_prefix, sizeof posix_prefix - 1))
2404 if (! hard_locale (LC_TIME))
2405 return optind;
2406 style += sizeof posix_prefix - 1;
2409 if (*style == '+')
2411 char *p0 = style + 1;
2412 char *p1 = strchr (p0, '\n');
2413 if (! p1)
2414 p1 = p0;
2415 else
2417 if (strchr (p1 + 1, '\n'))
2418 error (LS_FAILURE, 0, _("invalid time style format %s"),
2419 quote (p0));
2420 *p1++ = '\0';
2422 long_time_format[0] = p0;
2423 long_time_format[1] = p1;
2425 else
2427 ptrdiff_t res = argmatch (style, time_style_args,
2428 (char const *) time_style_types,
2429 sizeof (*time_style_types));
2430 if (res < 0)
2432 /* This whole block used to be a simple use of XARGMATCH.
2433 but that didn't print the "posix-"-prefixed variants or
2434 the "+"-prefixed format string option upon failure. */
2435 argmatch_invalid ("time style", style, res);
2437 /* The following is a manual expansion of argmatch_valid,
2438 but with the added "+ ..." description and the [posix-]
2439 prefixes prepended. Note that this simplification works
2440 only because all four existing time_style_types values
2441 are distinct. */
2442 fputs (_("Valid arguments are:\n"), stderr);
2443 char const *const *p = time_style_args;
2444 while (*p)
2445 fprintf (stderr, " - [posix-]%s\n", *p++);
2446 fputs (_(" - +FORMAT (e.g., +%H:%M) for a 'date'-style"
2447 " format\n"), stderr);
2448 usage (LS_FAILURE);
2450 switch (res)
2452 case full_iso_time_style:
2453 long_time_format[0] = long_time_format[1] =
2454 "%Y-%m-%d %H:%M:%S.%N %z";
2455 break;
2457 case long_iso_time_style:
2458 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
2459 break;
2461 case iso_time_style:
2462 long_time_format[0] = "%Y-%m-%d ";
2463 long_time_format[1] = "%m-%d %H:%M";
2464 break;
2466 case locale_time_style:
2467 if (hard_locale (LC_TIME))
2469 for (int i = 0; i < 2; i++)
2470 long_time_format[i] =
2471 dcgettext (nullptr, long_time_format[i], LC_TIME);
2476 abformat_init ();
2479 return optind;
2482 /* Parse a string as part of the LS_COLORS variable; this may involve
2483 decoding all kinds of escape characters. If equals_end is set an
2484 unescaped equal sign ends the string, otherwise only a : or \0
2485 does. Set *OUTPUT_COUNT to the number of bytes output. Return
2486 true if successful.
2488 The resulting string is *not* null-terminated, but may contain
2489 embedded nulls.
2491 Note that both dest and src are char **; on return they point to
2492 the first free byte after the array and the character that ended
2493 the input string, respectively. */
2495 static bool
2496 get_funky_string (char **dest, char const **src, bool equals_end,
2497 size_t *output_count)
2499 char num; /* For numerical codes */
2500 size_t count; /* Something to count with */
2501 enum {
2502 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
2503 } state;
2504 char const *p;
2505 char *q;
2507 p = *src; /* We don't want to double-indirect */
2508 q = *dest; /* the whole darn time. */
2510 count = 0; /* No characters counted in yet. */
2511 num = 0;
2513 state = ST_GND; /* Start in ground state. */
2514 while (state < ST_END)
2516 switch (state)
2518 case ST_GND: /* Ground state (no escapes) */
2519 switch (*p)
2521 case ':':
2522 case '\0':
2523 state = ST_END; /* End of string */
2524 break;
2525 case '\\':
2526 state = ST_BACKSLASH; /* Backslash escape sequence */
2527 ++p;
2528 break;
2529 case '^':
2530 state = ST_CARET; /* Caret escape */
2531 ++p;
2532 break;
2533 case '=':
2534 if (equals_end)
2536 state = ST_END; /* End */
2537 break;
2539 FALLTHROUGH;
2540 default:
2541 *(q++) = *(p++);
2542 ++count;
2543 break;
2545 break;
2547 case ST_BACKSLASH: /* Backslash escaped character */
2548 switch (*p)
2550 case '0':
2551 case '1':
2552 case '2':
2553 case '3':
2554 case '4':
2555 case '5':
2556 case '6':
2557 case '7':
2558 state = ST_OCTAL; /* Octal sequence */
2559 num = *p - '0';
2560 break;
2561 case 'x':
2562 case 'X':
2563 state = ST_HEX; /* Hex sequence */
2564 num = 0;
2565 break;
2566 case 'a': /* Bell */
2567 num = '\a';
2568 break;
2569 case 'b': /* Backspace */
2570 num = '\b';
2571 break;
2572 case 'e': /* Escape */
2573 num = 27;
2574 break;
2575 case 'f': /* Form feed */
2576 num = '\f';
2577 break;
2578 case 'n': /* Newline */
2579 num = '\n';
2580 break;
2581 case 'r': /* Carriage return */
2582 num = '\r';
2583 break;
2584 case 't': /* Tab */
2585 num = '\t';
2586 break;
2587 case 'v': /* Vtab */
2588 num = '\v';
2589 break;
2590 case '?': /* Delete */
2591 num = 127;
2592 break;
2593 case '_': /* Space */
2594 num = ' ';
2595 break;
2596 case '\0': /* End of string */
2597 state = ST_ERROR; /* Error! */
2598 break;
2599 default: /* Escaped character like \ ^ : = */
2600 num = *p;
2601 break;
2603 if (state == ST_BACKSLASH)
2605 *(q++) = num;
2606 ++count;
2607 state = ST_GND;
2609 ++p;
2610 break;
2612 case ST_OCTAL: /* Octal sequence */
2613 if (*p < '0' || *p > '7')
2615 *(q++) = num;
2616 ++count;
2617 state = ST_GND;
2619 else
2620 num = (num << 3) + (*(p++) - '0');
2621 break;
2623 case ST_HEX: /* Hex sequence */
2624 switch (*p)
2626 case '0':
2627 case '1':
2628 case '2':
2629 case '3':
2630 case '4':
2631 case '5':
2632 case '6':
2633 case '7':
2634 case '8':
2635 case '9':
2636 num = (num << 4) + (*(p++) - '0');
2637 break;
2638 case 'a':
2639 case 'b':
2640 case 'c':
2641 case 'd':
2642 case 'e':
2643 case 'f':
2644 num = (num << 4) + (*(p++) - 'a') + 10;
2645 break;
2646 case 'A':
2647 case 'B':
2648 case 'C':
2649 case 'D':
2650 case 'E':
2651 case 'F':
2652 num = (num << 4) + (*(p++) - 'A') + 10;
2653 break;
2654 default:
2655 *(q++) = num;
2656 ++count;
2657 state = ST_GND;
2658 break;
2660 break;
2662 case ST_CARET: /* Caret escape */
2663 state = ST_GND; /* Should be the next state... */
2664 if (*p >= '@' && *p <= '~')
2666 *(q++) = *(p++) & 037;
2667 ++count;
2669 else if (*p == '?')
2671 *(q++) = 127;
2672 ++count;
2674 else
2675 state = ST_ERROR;
2676 break;
2678 default:
2679 unreachable ();
2683 *dest = q;
2684 *src = p;
2685 *output_count = count;
2687 return state != ST_ERROR;
2690 enum parse_state
2692 PS_START = 1,
2693 PS_2,
2694 PS_3,
2695 PS_4,
2696 PS_DONE,
2697 PS_FAIL
2701 /* Check if the content of TERM is a valid name in dircolors. */
2703 static bool
2704 known_term_type (void)
2706 char const *term = getenv ("TERM");
2707 if (! term || ! *term)
2708 return false;
2710 char const *line = G_line;
2711 while (line - G_line < sizeof (G_line))
2713 if (STRNCMP_LIT (line, "TERM ") == 0)
2715 if (fnmatch (line + 5, term, 0) == 0)
2716 return true;
2718 line += strlen (line) + 1;
2721 return false;
2724 static void
2725 parse_ls_color (void)
2727 char const *p; /* Pointer to character being parsed */
2728 char *buf; /* color_buf buffer pointer */
2729 int ind_no; /* Indicator number */
2730 char label[3]; /* Indicator label */
2731 struct color_ext_type *ext; /* Extension we are working on */
2733 if ((p = getenv ("LS_COLORS")) == nullptr || *p == '\0')
2735 /* LS_COLORS takes precedence, but if that's not set then
2736 honor the COLORTERM and TERM env variables so that
2737 we only go with the internal ANSI color codes if the
2738 former is non empty or the latter is set to a known value. */
2739 char const *colorterm = getenv ("COLORTERM");
2740 if (! (colorterm && *colorterm) && ! known_term_type ())
2741 print_with_color = false;
2742 return;
2745 ext = nullptr;
2746 strcpy (label, "??");
2748 /* This is an overly conservative estimate, but any possible
2749 LS_COLORS string will *not* generate a color_buf longer than
2750 itself, so it is a safe way of allocating a buffer in
2751 advance. */
2752 buf = color_buf = xstrdup (p);
2754 enum parse_state state = PS_START;
2755 while (true)
2757 switch (state)
2759 case PS_START: /* First label character */
2760 switch (*p)
2762 case ':':
2763 ++p;
2764 break;
2766 case '*':
2767 /* Allocate new extension block and add to head of
2768 linked list (this way a later definition will
2769 override an earlier one, which can be useful for
2770 having terminal-specific defs override global). */
2772 ext = xmalloc (sizeof *ext);
2773 ext->next = color_ext_list;
2774 color_ext_list = ext;
2775 ext->exact_match = false;
2777 ++p;
2778 ext->ext.string = buf;
2780 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2781 ? PS_4 : PS_FAIL);
2782 break;
2784 case '\0':
2785 state = PS_DONE; /* Done! */
2786 goto done;
2788 default: /* Assume it is file type label */
2789 label[0] = *(p++);
2790 state = PS_2;
2791 break;
2793 break;
2795 case PS_2: /* Second label character */
2796 if (*p)
2798 label[1] = *(p++);
2799 state = PS_3;
2801 else
2802 state = PS_FAIL; /* Error */
2803 break;
2805 case PS_3: /* Equal sign after indicator label */
2806 state = PS_FAIL; /* Assume failure... */
2807 if (*(p++) == '=')/* It *should* be... */
2809 for (ind_no = 0; indicator_name[ind_no] != nullptr; ++ind_no)
2811 if (STREQ (label, indicator_name[ind_no]))
2813 color_indicator[ind_no].string = buf;
2814 state = (get_funky_string (&buf, &p, false,
2815 &color_indicator[ind_no].len)
2816 ? PS_START : PS_FAIL);
2817 break;
2820 if (state == PS_FAIL)
2821 error (0, 0, _("unrecognized prefix: %s"), quote (label));
2823 break;
2825 case PS_4: /* Equal sign after *.ext */
2826 if (*(p++) == '=')
2828 ext->seq.string = buf;
2829 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2830 ? PS_START : PS_FAIL);
2832 else
2833 state = PS_FAIL;
2834 break;
2836 case PS_FAIL:
2837 goto done;
2839 default:
2840 affirm (false);
2843 done:
2845 if (state == PS_FAIL)
2847 struct color_ext_type *e;
2848 struct color_ext_type *e2;
2850 error (0, 0,
2851 _("unparsable value for LS_COLORS environment variable"));
2852 free (color_buf);
2853 for (e = color_ext_list; e != nullptr; /* empty */)
2855 e2 = e;
2856 e = e->next;
2857 free (e2);
2859 print_with_color = false;
2861 else
2863 /* Postprocess list to set EXACT_MATCH on entries where there are
2864 different cased extensions with separate sequences defined.
2865 Also set ext.len to SIZE_MAX on any entries that can't
2866 match due to precedence, to avoid redundant string compares. */
2867 struct color_ext_type *e1;
2869 for (e1 = color_ext_list; e1 != nullptr; e1 = e1->next)
2871 struct color_ext_type *e2;
2872 bool case_ignored = false;
2874 for (e2 = e1->next; e2 != nullptr; e2 = e2->next)
2876 if (e2->ext.len < SIZE_MAX && e1->ext.len == e2->ext.len)
2878 if (memcmp (e1->ext.string, e2->ext.string, e1->ext.len) == 0)
2879 e2->ext.len = SIZE_MAX; /* Ignore */
2880 else if (c_strncasecmp (e1->ext.string, e2->ext.string,
2881 e1->ext.len) == 0)
2883 if (case_ignored)
2885 e2->ext.len = SIZE_MAX; /* Ignore */
2887 else if (e1->seq.len == e2->seq.len
2888 && memcmp (e1->seq.string, e2->seq.string,
2889 e1->seq.len) == 0)
2891 e2->ext.len = SIZE_MAX; /* Ignore */
2892 case_ignored = true; /* Ignore all subsequent */
2894 else
2896 e1->exact_match = true;
2897 e2->exact_match = true;
2905 if (color_indicator[C_LINK].len == 6
2906 && !STRNCMP_LIT (color_indicator[C_LINK].string, "target"))
2907 color_symlink_as_referent = true;
2910 /* Return the quoting style specified by the environment variable
2911 QUOTING_STYLE if set and valid, -1 otherwise. */
2913 static int
2914 getenv_quoting_style (void)
2916 char const *q_style = getenv ("QUOTING_STYLE");
2917 if (!q_style)
2918 return -1;
2919 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
2920 if (i < 0)
2922 error (0, 0,
2923 _("ignoring invalid value"
2924 " of environment variable QUOTING_STYLE: %s"),
2925 quote (q_style));
2926 return -1;
2928 return quoting_style_vals[i];
2931 /* Set the exit status to report a failure. If SERIOUS, it is a
2932 serious failure; otherwise, it is merely a minor problem. */
2934 static void
2935 set_exit_status (bool serious)
2937 if (serious)
2938 exit_status = LS_FAILURE;
2939 else if (exit_status == EXIT_SUCCESS)
2940 exit_status = LS_MINOR_PROBLEM;
2943 /* Assuming a failure is serious if SERIOUS, use the printf-style
2944 MESSAGE to report the failure to access a file named FILE. Assume
2945 errno is set appropriately for the failure. */
2947 static void
2948 file_failure (bool serious, char const *message, char const *file)
2950 error (0, errno, message, quoteaf (file));
2951 set_exit_status (serious);
2954 /* Request that the directory named NAME have its contents listed later.
2955 If REALNAME is nonzero, it will be used instead of NAME when the
2956 directory name is printed. This allows symbolic links to directories
2957 to be treated as regular directories but still be listed under their
2958 real names. NAME == nullptr is used to insert a marker entry for the
2959 directory named in REALNAME.
2960 If NAME is non-null, we use its dev/ino information to save
2961 a call to stat -- when doing a recursive (-R) traversal.
2962 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2964 static void
2965 queue_directory (char const *name, char const *realname, bool command_line_arg)
2967 struct pending *new = xmalloc (sizeof *new);
2968 new->realname = realname ? xstrdup (realname) : nullptr;
2969 new->name = name ? xstrdup (name) : nullptr;
2970 new->command_line_arg = command_line_arg;
2971 new->next = pending_dirs;
2972 pending_dirs = new;
2975 /* Read directory NAME, and list the files in it.
2976 If REALNAME is nonzero, print its name instead of NAME;
2977 this is used for symbolic links to directories.
2978 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2980 static void
2981 print_dir (char const *name, char const *realname, bool command_line_arg)
2983 DIR *dirp;
2984 struct dirent *next;
2985 uintmax_t total_blocks = 0;
2986 static bool first = true;
2988 errno = 0;
2989 dirp = opendir (name);
2990 if (!dirp)
2992 file_failure (command_line_arg, _("cannot open directory %s"), name);
2993 return;
2996 if (LOOP_DETECT)
2998 struct stat dir_stat;
2999 int fd = dirfd (dirp);
3001 /* If dirfd failed, endure the overhead of stat'ing by path */
3002 if ((0 <= fd
3003 ? fstat_for_ino (fd, &dir_stat)
3004 : stat_for_ino (name, &dir_stat)) < 0)
3006 file_failure (command_line_arg,
3007 _("cannot determine device and inode of %s"), name);
3008 closedir (dirp);
3009 return;
3012 /* If we've already visited this dev/inode pair, warn that
3013 we've found a loop, and do not process this directory. */
3014 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
3016 error (0, 0, _("%s: not listing already-listed directory"),
3017 quotef (name));
3018 closedir (dirp);
3019 set_exit_status (true);
3020 return;
3023 dev_ino_push (dir_stat.st_dev, dir_stat.st_ino);
3026 clear_files ();
3028 if (recursive || print_dir_name)
3030 if (!first)
3031 dired_outbyte ('\n');
3032 first = false;
3033 dired_indent ();
3035 char *absolute_name = nullptr;
3036 if (print_hyperlink)
3038 absolute_name = canonicalize_filename_mode (name, CAN_MISSING);
3039 if (! absolute_name)
3040 file_failure (command_line_arg,
3041 _("error canonicalizing %s"), name);
3043 quote_name (realname ? realname : name, dirname_quoting_options, -1,
3044 nullptr, true, &subdired_obstack, absolute_name);
3046 free (absolute_name);
3048 dired_outstring (":\n");
3051 /* Read the directory entries, and insert the subfiles into the 'cwd_file'
3052 table. */
3054 while (true)
3056 /* Set errno to zero so we can distinguish between a readdir failure
3057 and when readdir simply finds that there are no more entries. */
3058 errno = 0;
3059 next = readdir (dirp);
3060 if (next)
3062 if (! file_ignored (next->d_name))
3064 enum filetype type = unknown;
3066 #if HAVE_STRUCT_DIRENT_D_TYPE
3067 switch (next->d_type)
3069 case DT_BLK: type = blockdev; break;
3070 case DT_CHR: type = chardev; break;
3071 case DT_DIR: type = directory; break;
3072 case DT_FIFO: type = fifo; break;
3073 case DT_LNK: type = symbolic_link; break;
3074 case DT_REG: type = normal; break;
3075 case DT_SOCK: type = sock; break;
3076 # ifdef DT_WHT
3077 case DT_WHT: type = whiteout; break;
3078 # endif
3080 #endif
3081 total_blocks += gobble_file (next->d_name, type,
3082 RELIABLE_D_INO (next),
3083 false, name);
3085 /* In this narrow case, print out each name right away, so
3086 ls uses constant memory while processing the entries of
3087 this directory. Useful when there are many (millions)
3088 of entries in a directory. */
3089 if (format == one_per_line && sort_type == sort_none
3090 && !print_block_size && !recursive)
3092 /* We must call sort_files in spite of
3093 "sort_type == sort_none" for its initialization
3094 of the sorted_file vector. */
3095 sort_files ();
3096 print_current_files ();
3097 clear_files ();
3101 else if (errno != 0)
3103 file_failure (command_line_arg, _("reading directory %s"), name);
3104 if (errno != EOVERFLOW)
3105 break;
3107 else
3108 break;
3110 /* When processing a very large directory, and since we've inhibited
3111 interrupts, this loop would take so long that ls would be annoyingly
3112 uninterruptible. This ensures that it handles signals promptly. */
3113 process_signals ();
3116 if (closedir (dirp) != 0)
3118 file_failure (command_line_arg, _("closing directory %s"), name);
3119 /* Don't return; print whatever we got. */
3122 /* Sort the directory contents. */
3123 sort_files ();
3125 /* If any member files are subdirectories, perhaps they should have their
3126 contents listed rather than being mentioned here as files. */
3128 if (recursive)
3129 extract_dirs_from_files (name, false);
3131 if (format == long_format || print_block_size)
3133 char buf[LONGEST_HUMAN_READABLE + 3];
3134 char *p = human_readable (total_blocks, buf + 1, human_output_opts,
3135 ST_NBLOCKSIZE, output_block_size);
3136 char *pend = p + strlen (p);
3137 *--p = ' ';
3138 *pend++ = eolbyte;
3139 dired_indent ();
3140 dired_outstring (_("total"));
3141 dired_outbuf (p, pend - p);
3144 if (cwd_n_used)
3145 print_current_files ();
3148 /* Add 'pattern' to the list of patterns for which files that match are
3149 not listed. */
3151 static void
3152 add_ignore_pattern (char const *pattern)
3154 struct ignore_pattern *ignore;
3156 ignore = xmalloc (sizeof *ignore);
3157 ignore->pattern = pattern;
3158 /* Add it to the head of the linked list. */
3159 ignore->next = ignore_patterns;
3160 ignore_patterns = ignore;
3163 /* Return true if one of the PATTERNS matches FILE. */
3165 static bool
3166 patterns_match (struct ignore_pattern const *patterns, char const *file)
3168 struct ignore_pattern const *p;
3169 for (p = patterns; p; p = p->next)
3170 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
3171 return true;
3172 return false;
3175 /* Return true if FILE should be ignored. */
3177 static bool
3178 file_ignored (char const *name)
3180 return ((ignore_mode != IGNORE_MINIMAL
3181 && name[0] == '.'
3182 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
3183 || (ignore_mode == IGNORE_DEFAULT
3184 && patterns_match (hide_patterns, name))
3185 || patterns_match (ignore_patterns, name));
3188 /* POSIX requires that a file size be printed without a sign, even
3189 when negative. Assume the typical case where negative sizes are
3190 actually positive values that have wrapped around. */
3192 static uintmax_t
3193 unsigned_file_size (off_t size)
3195 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
3198 #ifdef HAVE_CAP
3199 /* Return true if NAME has a capability (see linux/capability.h) */
3200 static bool
3201 has_capability (char const *name)
3203 char *result;
3204 bool has_cap;
3206 cap_t cap_d = cap_get_file (name);
3207 if (cap_d == nullptr)
3208 return false;
3210 result = cap_to_text (cap_d, nullptr);
3211 cap_free (cap_d);
3212 if (!result)
3213 return false;
3215 /* check if human-readable capability string is empty */
3216 has_cap = !!*result;
3218 cap_free (result);
3219 return has_cap;
3221 #else
3222 static bool
3223 has_capability (MAYBE_UNUSED char const *name)
3225 errno = ENOTSUP;
3226 return false;
3228 #endif
3230 /* Enter and remove entries in the table 'cwd_file'. */
3232 static void
3233 free_ent (struct fileinfo *f)
3235 free (f->name);
3236 free (f->linkname);
3237 free (f->absolute_name);
3238 if (f->scontext != UNKNOWN_SECURITY_CONTEXT)
3240 if (is_smack_enabled ())
3241 free (f->scontext);
3242 else
3243 freecon (f->scontext);
3247 /* Empty the table of files. */
3248 static void
3249 clear_files (void)
3251 for (size_t i = 0; i < cwd_n_used; i++)
3253 struct fileinfo *f = sorted_file[i];
3254 free_ent (f);
3257 cwd_n_used = 0;
3258 cwd_some_quoted = false;
3259 any_has_acl = false;
3260 inode_number_width = 0;
3261 block_size_width = 0;
3262 nlink_width = 0;
3263 owner_width = 0;
3264 group_width = 0;
3265 author_width = 0;
3266 scontext_width = 0;
3267 major_device_number_width = 0;
3268 minor_device_number_width = 0;
3269 file_size_width = 0;
3272 /* Return true if ERR implies lack-of-support failure by a
3273 getxattr-calling function like getfilecon or file_has_acl. */
3274 static bool
3275 errno_unsupported (int err)
3277 return (err == EINVAL || err == ENOSYS || is_ENOTSUP (err));
3280 /* Cache *getfilecon failure, when it's trivial to do so.
3281 Like getfilecon/lgetfilecon, but when F's st_dev says it's doesn't
3282 support getting the security context, fail with ENOTSUP immediately. */
3283 static int
3284 getfilecon_cache (char const *file, struct fileinfo *f, bool deref)
3286 /* st_dev of the most recently processed device for which we've
3287 found that [l]getfilecon fails indicating lack of support. */
3288 static dev_t unsupported_device;
3290 if (f->stat.st_dev == unsupported_device)
3292 errno = ENOTSUP;
3293 return -1;
3295 int r = 0;
3296 #ifdef HAVE_SMACK
3297 if (is_smack_enabled ())
3298 r = smack_new_label_from_path (file, "security.SMACK64", deref,
3299 &f->scontext);
3300 else
3301 #endif
3302 r = (deref
3303 ? getfilecon (file, &f->scontext)
3304 : lgetfilecon (file, &f->scontext));
3305 if (r < 0 && errno_unsupported (errno))
3306 unsupported_device = f->stat.st_dev;
3307 return r;
3310 /* Cache file_has_acl failure, when it's trivial to do.
3311 Like file_has_acl, but when F's st_dev says it's on a file
3312 system lacking ACL support, return 0 with ENOTSUP immediately. */
3313 static int
3314 file_has_acl_cache (char const *file, struct fileinfo *f)
3316 /* st_dev of the most recently processed device for which we've
3317 found that file_has_acl fails indicating lack of support. */
3318 static dev_t unsupported_device;
3320 if (f->stat.st_dev == unsupported_device)
3322 errno = ENOTSUP;
3323 return 0;
3326 /* Zero errno so that we can distinguish between two 0-returning cases:
3327 "has-ACL-support, but only a default ACL" and "no ACL support". */
3328 errno = 0;
3329 int n = file_has_acl (file, &f->stat);
3330 if (n <= 0 && errno_unsupported (errno))
3331 unsupported_device = f->stat.st_dev;
3332 return n;
3335 /* Cache has_capability failure, when it's trivial to do.
3336 Like has_capability, but when F's st_dev says it's on a file
3337 system lacking capability support, return 0 with ENOTSUP immediately. */
3338 static bool
3339 has_capability_cache (char const *file, struct fileinfo *f)
3341 /* st_dev of the most recently processed device for which we've
3342 found that has_capability fails indicating lack of support. */
3343 static dev_t unsupported_device;
3345 if (f->stat.st_dev == unsupported_device)
3347 errno = ENOTSUP;
3348 return 0;
3351 bool b = has_capability (file);
3352 if ( !b && errno_unsupported (errno))
3353 unsupported_device = f->stat.st_dev;
3354 return b;
3357 static bool
3358 needs_quoting (char const *name)
3360 char test[2];
3361 size_t len = quotearg_buffer (test, sizeof test , name, -1,
3362 filename_quoting_options);
3363 return *name != *test || strlen (name) != len;
3366 /* Add a file to the current table of files.
3367 Verify that the file exists, and print an error message if it does not.
3368 Return the number of blocks that the file occupies. */
3369 static uintmax_t
3370 gobble_file (char const *name, enum filetype type, ino_t inode,
3371 bool command_line_arg, char const *dirname)
3373 uintmax_t blocks = 0;
3374 struct fileinfo *f;
3376 /* An inode value prior to gobble_file necessarily came from readdir,
3377 which is not used for command line arguments. */
3378 affirm (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
3380 if (cwd_n_used == cwd_n_alloc)
3382 cwd_file = xnrealloc (cwd_file, cwd_n_alloc, 2 * sizeof *cwd_file);
3383 cwd_n_alloc *= 2;
3386 f = &cwd_file[cwd_n_used];
3387 memset (f, '\0', sizeof *f);
3388 f->stat.st_ino = inode;
3389 f->filetype = type;
3391 f->quoted = -1;
3392 if ((! cwd_some_quoted) && align_variable_outer_quotes)
3394 /* Determine if any quoted for padding purposes. */
3395 f->quoted = needs_quoting (name);
3396 if (f->quoted)
3397 cwd_some_quoted = 1;
3400 if (command_line_arg
3401 || print_hyperlink
3402 || format_needs_stat
3403 /* When coloring a directory (we may know the type from
3404 direct.d_type), we have to stat it in order to indicate
3405 sticky and/or other-writable attributes. */
3406 || (type == directory && print_with_color
3407 && (is_colored (C_OTHER_WRITABLE)
3408 || is_colored (C_STICKY)
3409 || is_colored (C_STICKY_OTHER_WRITABLE)))
3410 /* When dereferencing symlinks, the inode and type must come from
3411 stat, but readdir provides the inode and type of lstat. */
3412 || ((print_inode || format_needs_type)
3413 && (type == symbolic_link || type == unknown)
3414 && (dereference == DEREF_ALWAYS
3415 || color_symlink_as_referent || check_symlink_mode))
3416 /* Command line dereferences are already taken care of by the above
3417 assertion that the inode number is not yet known. */
3418 || (print_inode && inode == NOT_AN_INODE_NUMBER)
3419 || (format_needs_type
3420 && (type == unknown || command_line_arg
3421 /* --indicator-style=classify (aka -F)
3422 requires that we stat each regular file
3423 to see if it's executable. */
3424 || (type == normal && (indicator_style == classify
3425 /* This is so that --color ends up
3426 highlighting files with these mode
3427 bits set even when options like -F are
3428 not specified. Note we do a redundant
3429 stat in the very unlikely case where
3430 C_CAP is set but not the others. */
3431 || (print_with_color
3432 && (is_colored (C_EXEC)
3433 || is_colored (C_SETUID)
3434 || is_colored (C_SETGID)
3435 || is_colored (C_CAP)))
3436 )))))
3439 /* Absolute name of this file. */
3440 char *full_name;
3441 bool do_deref;
3442 int err;
3444 if (name[0] == '/' || dirname[0] == 0)
3445 full_name = (char *) name;
3446 else
3448 full_name = alloca (strlen (name) + strlen (dirname) + 2);
3449 attach (full_name, dirname, name);
3452 if (print_hyperlink)
3454 f->absolute_name = canonicalize_filename_mode (full_name,
3455 CAN_MISSING);
3456 if (! f->absolute_name)
3457 file_failure (command_line_arg,
3458 _("error canonicalizing %s"), full_name);
3461 switch (dereference)
3463 case DEREF_ALWAYS:
3464 err = do_stat (full_name, &f->stat);
3465 do_deref = true;
3466 break;
3468 case DEREF_COMMAND_LINE_ARGUMENTS:
3469 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
3470 if (command_line_arg)
3472 bool need_lstat;
3473 err = do_stat (full_name, &f->stat);
3474 do_deref = true;
3476 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
3477 break;
3479 need_lstat = (err < 0
3480 ? (errno == ENOENT || errno == ELOOP)
3481 : ! S_ISDIR (f->stat.st_mode));
3482 if (!need_lstat)
3483 break;
3485 /* stat failed because of ENOENT || ELOOP, maybe indicating a
3486 non-traversable symlink. Or stat succeeded,
3487 FULL_NAME does not refer to a directory,
3488 and --dereference-command-line-symlink-to-dir is in effect.
3489 Fall through so that we call lstat instead. */
3491 FALLTHROUGH;
3493 default: /* DEREF_NEVER */
3494 err = do_lstat (full_name, &f->stat);
3495 do_deref = false;
3496 break;
3499 if (err != 0)
3501 /* Failure to stat a command line argument leads to
3502 an exit status of 2. For other files, stat failure
3503 provokes an exit status of 1. */
3504 file_failure (command_line_arg,
3505 _("cannot access %s"), full_name);
3507 f->scontext = UNKNOWN_SECURITY_CONTEXT;
3509 if (command_line_arg)
3510 return 0;
3512 f->name = xstrdup (name);
3513 cwd_n_used++;
3515 return 0;
3518 f->stat_ok = true;
3520 /* Note has_capability() adds around 30% runtime to 'ls --color' */
3521 if ((type == normal || S_ISREG (f->stat.st_mode))
3522 && print_with_color && is_colored (C_CAP))
3523 f->has_capability = has_capability_cache (full_name, f);
3525 if (format == long_format || print_scontext)
3527 bool have_scontext = false;
3528 bool have_acl = false;
3529 int attr_len = getfilecon_cache (full_name, f, do_deref);
3530 err = (attr_len < 0);
3532 if (err == 0)
3534 if (is_smack_enabled ())
3535 have_scontext = ! STREQ ("_", f->scontext);
3536 else
3537 have_scontext = ! STREQ ("unlabeled", f->scontext);
3539 else
3541 f->scontext = UNKNOWN_SECURITY_CONTEXT;
3543 /* When requesting security context information, don't make
3544 ls fail just because the file (even a command line argument)
3545 isn't on the right type of file system. I.e., a getfilecon
3546 failure isn't in the same class as a stat failure. */
3547 if (is_ENOTSUP (errno) || errno == ENODATA)
3548 err = 0;
3551 if (err == 0 && format == long_format)
3553 int n = file_has_acl_cache (full_name, f);
3554 err = (n < 0);
3555 have_acl = (0 < n);
3558 f->acl_type = (!have_scontext && !have_acl
3559 ? ACL_T_NONE
3560 : (have_scontext && !have_acl
3561 ? ACL_T_LSM_CONTEXT_ONLY
3562 : ACL_T_YES));
3563 any_has_acl |= f->acl_type != ACL_T_NONE;
3565 if (err)
3566 error (0, errno, "%s", quotef (full_name));
3569 if (S_ISLNK (f->stat.st_mode)
3570 && (format == long_format || check_symlink_mode))
3572 struct stat linkstats;
3574 get_link_name (full_name, f, command_line_arg);
3576 /* Use the slower quoting path for this entry, though
3577 don't update CWD_SOME_QUOTED since alignment not affected. */
3578 if (f->linkname && f->quoted == 0 && needs_quoting (f->linkname))
3579 f->quoted = -1;
3581 /* Avoid following symbolic links when possible, i.e., when
3582 they won't be traced and when no indicator is needed. */
3583 if (f->linkname
3584 && (file_type <= indicator_style || check_symlink_mode)
3585 && stat_for_mode (full_name, &linkstats) == 0)
3587 f->linkok = true;
3588 f->linkmode = linkstats.st_mode;
3592 if (S_ISLNK (f->stat.st_mode))
3593 f->filetype = symbolic_link;
3594 else if (S_ISDIR (f->stat.st_mode))
3596 if (command_line_arg && !immediate_dirs)
3597 f->filetype = arg_directory;
3598 else
3599 f->filetype = directory;
3601 else
3602 f->filetype = normal;
3604 blocks = ST_NBLOCKS (f->stat);
3605 if (format == long_format || print_block_size)
3607 char buf[LONGEST_HUMAN_READABLE + 1];
3608 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
3609 ST_NBLOCKSIZE, output_block_size),
3611 if (block_size_width < len)
3612 block_size_width = len;
3615 if (format == long_format)
3617 if (print_owner)
3619 int len = format_user_width (f->stat.st_uid);
3620 if (owner_width < len)
3621 owner_width = len;
3624 if (print_group)
3626 int len = format_group_width (f->stat.st_gid);
3627 if (group_width < len)
3628 group_width = len;
3631 if (print_author)
3633 int len = format_user_width (f->stat.st_author);
3634 if (author_width < len)
3635 author_width = len;
3639 if (print_scontext)
3641 int len = strlen (f->scontext);
3642 if (scontext_width < len)
3643 scontext_width = len;
3646 if (format == long_format)
3648 char b[INT_BUFSIZE_BOUND (uintmax_t)];
3649 int b_len = strlen (umaxtostr (f->stat.st_nlink, b));
3650 if (nlink_width < b_len)
3651 nlink_width = b_len;
3653 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
3655 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
3656 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
3657 if (major_device_number_width < len)
3658 major_device_number_width = len;
3659 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
3660 if (minor_device_number_width < len)
3661 minor_device_number_width = len;
3662 len = major_device_number_width + 2 + minor_device_number_width;
3663 if (file_size_width < len)
3664 file_size_width = len;
3666 else
3668 char buf[LONGEST_HUMAN_READABLE + 1];
3669 uintmax_t size = unsigned_file_size (f->stat.st_size);
3670 int len = mbswidth (human_readable (size, buf,
3671 file_human_output_opts,
3672 1, file_output_block_size),
3674 if (file_size_width < len)
3675 file_size_width = len;
3680 if (print_inode)
3682 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
3683 int len = strlen (umaxtostr (f->stat.st_ino, buf));
3684 if (inode_number_width < len)
3685 inode_number_width = len;
3688 f->name = xstrdup (name);
3689 cwd_n_used++;
3691 return blocks;
3694 /* Return true if F refers to a directory. */
3695 static bool
3696 is_directory (const struct fileinfo *f)
3698 return f->filetype == directory || f->filetype == arg_directory;
3701 /* Return true if F refers to a (symlinked) directory. */
3702 static bool
3703 is_linked_directory (const struct fileinfo *f)
3705 return f->filetype == directory || f->filetype == arg_directory
3706 || S_ISDIR (f->linkmode);
3709 /* Put the name of the file that FILENAME is a symbolic link to
3710 into the LINKNAME field of 'f'. COMMAND_LINE_ARG indicates whether
3711 FILENAME is a command-line argument. */
3713 static void
3714 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
3716 f->linkname = areadlink_with_size (filename, f->stat.st_size);
3717 if (f->linkname == nullptr)
3718 file_failure (command_line_arg, _("cannot read symbolic link %s"),
3719 filename);
3722 /* Return true if the last component of NAME is '.' or '..'
3723 This is so we don't try to recurse on '././././. ...' */
3725 static bool
3726 basename_is_dot_or_dotdot (char const *name)
3728 char const *base = last_component (name);
3729 return dot_or_dotdot (base);
3732 /* Remove any entries from CWD_FILE that are for directories,
3733 and queue them to be listed as directories instead.
3734 DIRNAME is the prefix to prepend to each dirname
3735 to make it correct relative to ls's working dir;
3736 if it is null, no prefix is needed and "." and ".." should not be ignored.
3737 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
3738 This is desirable when processing directories recursively. */
3740 static void
3741 extract_dirs_from_files (char const *dirname, bool command_line_arg)
3743 size_t i;
3744 size_t j;
3745 bool ignore_dot_and_dot_dot = (dirname != nullptr);
3747 if (dirname && LOOP_DETECT)
3749 /* Insert a marker entry first. When we dequeue this marker entry,
3750 we'll know that DIRNAME has been processed and may be removed
3751 from the set of active directories. */
3752 queue_directory (nullptr, dirname, false);
3755 /* Queue the directories last one first, because queueing reverses the
3756 order. */
3757 for (i = cwd_n_used; i-- != 0; )
3759 struct fileinfo *f = sorted_file[i];
3761 if (is_directory (f)
3762 && (! ignore_dot_and_dot_dot
3763 || ! basename_is_dot_or_dotdot (f->name)))
3765 if (!dirname || f->name[0] == '/')
3766 queue_directory (f->name, f->linkname, command_line_arg);
3767 else
3769 char *name = file_name_concat (dirname, f->name, nullptr);
3770 queue_directory (name, f->linkname, command_line_arg);
3771 free (name);
3773 if (f->filetype == arg_directory)
3774 free_ent (f);
3778 /* Now delete the directories from the table, compacting all the remaining
3779 entries. */
3781 for (i = 0, j = 0; i < cwd_n_used; i++)
3783 struct fileinfo *f = sorted_file[i];
3784 sorted_file[j] = f;
3785 j += (f->filetype != arg_directory);
3787 cwd_n_used = j;
3790 /* Use strcoll to compare strings in this locale. If an error occurs,
3791 report an error and longjmp to failed_strcoll. */
3793 static jmp_buf failed_strcoll;
3795 static int
3796 xstrcoll (char const *a, char const *b)
3798 int diff;
3799 errno = 0;
3800 diff = strcoll (a, b);
3801 if (errno)
3803 error (0, errno, _("cannot compare file names %s and %s"),
3804 quote_n (0, a), quote_n (1, b));
3805 set_exit_status (false);
3806 longjmp (failed_strcoll, 1);
3808 return diff;
3811 /* Comparison routines for sorting the files. */
3813 typedef void const *V;
3814 typedef int (*qsortFunc)(V a, V b);
3816 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants. */
3817 static int
3818 dirfirst_check (struct fileinfo const *a, struct fileinfo const *b,
3819 int (*cmp) (V, V))
3821 int diff = is_linked_directory (b) - is_linked_directory (a);
3822 return diff ? diff : cmp (a, b);
3825 /* Define the 8 different sort function variants required for each sortkey.
3826 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
3827 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
3828 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
3829 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
3830 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
3831 /* direct, non-dirfirst versions */ \
3832 static int xstrcoll_##key_name (V a, V b) \
3833 { return key_cmp_func (a, b, xstrcoll); } \
3834 ATTRIBUTE_PURE static int strcmp_##key_name (V a, V b) \
3835 { return key_cmp_func (a, b, strcmp); } \
3837 /* reverse, non-dirfirst versions */ \
3838 static int rev_xstrcoll_##key_name (V a, V b) \
3839 { return key_cmp_func (b, a, xstrcoll); } \
3840 ATTRIBUTE_PURE static int rev_strcmp_##key_name (V a, V b) \
3841 { return key_cmp_func (b, a, strcmp); } \
3843 /* direct, dirfirst versions */ \
3844 static int xstrcoll_df_##key_name (V a, V b) \
3845 { return dirfirst_check (a, b, xstrcoll_##key_name); } \
3846 ATTRIBUTE_PURE static int strcmp_df_##key_name (V a, V b) \
3847 { return dirfirst_check (a, b, strcmp_##key_name); } \
3849 /* reverse, dirfirst versions */ \
3850 static int rev_xstrcoll_df_##key_name (V a, V b) \
3851 { return dirfirst_check (a, b, rev_xstrcoll_##key_name); } \
3852 ATTRIBUTE_PURE static int rev_strcmp_df_##key_name (V a, V b) \
3853 { return dirfirst_check (a, b, rev_strcmp_##key_name); }
3855 static int
3856 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
3857 int (*cmp) (char const *, char const *))
3859 int diff = timespec_cmp (get_stat_ctime (&b->stat),
3860 get_stat_ctime (&a->stat));
3861 return diff ? diff : cmp (a->name, b->name);
3864 static int
3865 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
3866 int (*cmp) (char const *, char const *))
3868 int diff = timespec_cmp (get_stat_mtime (&b->stat),
3869 get_stat_mtime (&a->stat));
3870 return diff ? diff : cmp (a->name, b->name);
3873 static int
3874 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
3875 int (*cmp) (char const *, char const *))
3877 int diff = timespec_cmp (get_stat_atime (&b->stat),
3878 get_stat_atime (&a->stat));
3879 return diff ? diff : cmp (a->name, b->name);
3882 static int
3883 cmp_btime (struct fileinfo const *a, struct fileinfo const *b,
3884 int (*cmp) (char const *, char const *))
3886 int diff = timespec_cmp (get_stat_btime (&b->stat),
3887 get_stat_btime (&a->stat));
3888 return diff ? diff : cmp (a->name, b->name);
3891 static int
3892 off_cmp (off_t a, off_t b)
3894 return (a > b) - (a < b);
3897 static int
3898 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3899 int (*cmp) (char const *, char const *))
3901 int diff = off_cmp (b->stat.st_size, a->stat.st_size);
3902 return diff ? diff : cmp (a->name, b->name);
3905 static int
3906 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3907 int (*cmp) (char const *, char const *))
3909 return cmp (a->name, b->name);
3912 /* Compare file extensions. Files with no extension are 'smallest'.
3913 If extensions are the same, compare by file names instead. */
3915 static int
3916 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3917 int (*cmp) (char const *, char const *))
3919 char const *base1 = strrchr (a->name, '.');
3920 char const *base2 = strrchr (b->name, '.');
3921 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3922 return diff ? diff : cmp (a->name, b->name);
3925 /* Return the (cached) screen width,
3926 for the NAME associated with the passed fileinfo F. */
3928 static size_t
3929 fileinfo_name_width (struct fileinfo const *f)
3931 return f->width
3932 ? f->width
3933 : quote_name_width (f->name, filename_quoting_options, f->quoted);
3936 static int
3937 cmp_width (struct fileinfo const *a, struct fileinfo const *b,
3938 int (*cmp) (char const *, char const *))
3940 int diff = fileinfo_name_width (a) - fileinfo_name_width (b);
3941 return diff ? diff : cmp (a->name, b->name);
3944 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3945 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3946 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3947 DEFINE_SORT_FUNCTIONS (btime, cmp_btime)
3948 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3949 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3950 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3951 DEFINE_SORT_FUNCTIONS (width, cmp_width)
3953 /* Compare file versions.
3954 Unlike the other compare functions, cmp_version does not fail
3955 because filevercmp and strcmp do not fail; cmp_version uses strcmp
3956 instead of xstrcoll because filevercmp is locale-independent so
3957 strcmp is its appropriate secondary.
3959 All the other sort options need xstrcoll and strcmp variants,
3960 because they all use xstrcoll (either as the primary or secondary
3961 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3962 locale reasons. */
3963 static int
3964 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3966 int diff = filevercmp (a->name, b->name);
3967 return diff ? diff : strcmp (a->name, b->name);
3970 static int
3971 xstrcoll_version (V a, V b)
3973 return cmp_version (a, b);
3975 static int
3976 rev_xstrcoll_version (V a, V b)
3978 return cmp_version (b, a);
3980 static int
3981 xstrcoll_df_version (V a, V b)
3983 return dirfirst_check (a, b, xstrcoll_version);
3985 static int
3986 rev_xstrcoll_df_version (V a, V b)
3988 return dirfirst_check (a, b, rev_xstrcoll_version);
3992 /* We have 2^3 different variants for each sort-key function
3993 (for 3 independent sort modes).
3994 The function pointers stored in this array must be dereferenced as:
3996 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3998 Note that the order in which sort keys are listed in the function pointer
3999 array below is defined by the order of the elements in the time_type and
4000 sort_type enums! */
4002 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
4005 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
4006 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
4007 }, \
4009 { strcmp_##key_name, strcmp_df_##key_name }, \
4010 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
4014 static qsortFunc const sort_functions[][2][2][2] =
4016 LIST_SORTFUNCTION_VARIANTS (name),
4017 LIST_SORTFUNCTION_VARIANTS (extension),
4018 LIST_SORTFUNCTION_VARIANTS (width),
4019 LIST_SORTFUNCTION_VARIANTS (size),
4023 { xstrcoll_version, xstrcoll_df_version },
4024 { rev_xstrcoll_version, rev_xstrcoll_df_version },
4027 /* We use nullptr for the strcmp variants of version comparison
4028 since as explained in cmp_version definition, version comparison
4029 does not rely on xstrcoll, so it will never longjmp, and never
4030 need to try the strcmp fallback. */
4032 { nullptr, nullptr },
4033 { nullptr, nullptr },
4037 /* last are time sort functions */
4038 LIST_SORTFUNCTION_VARIANTS (mtime),
4039 LIST_SORTFUNCTION_VARIANTS (ctime),
4040 LIST_SORTFUNCTION_VARIANTS (atime),
4041 LIST_SORTFUNCTION_VARIANTS (btime)
4044 /* The number of sort keys is calculated as the sum of
4045 the number of elements in the sort_type enum (i.e., sort_numtypes)
4046 -2 because neither sort_time nor sort_none use entries themselves
4047 the number of elements in the time_type enum (i.e., time_numtypes)
4048 This is because when sort_type==sort_time, we have up to
4049 time_numtypes possible sort keys.
4051 This line verifies at compile-time that the array of sort functions has been
4052 initialized for all possible sort keys. */
4053 static_assert (ARRAY_CARDINALITY (sort_functions)
4054 == sort_numtypes - 2 + time_numtypes);
4056 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
4058 static void
4059 initialize_ordering_vector (void)
4061 for (size_t i = 0; i < cwd_n_used; i++)
4062 sorted_file[i] = &cwd_file[i];
4065 /* Cache values based on attributes global to all files. */
4067 static void
4068 update_current_files_info (void)
4070 /* Cache screen width of name, if needed multiple times. */
4071 if (sort_type == sort_width
4072 || (line_length && (format == many_per_line || format == horizontal)))
4074 size_t i;
4075 for (i = 0; i < cwd_n_used; i++)
4077 struct fileinfo *f = sorted_file[i];
4078 f->width = fileinfo_name_width (f);
4083 /* Sort the files now in the table. */
4085 static void
4086 sort_files (void)
4088 bool use_strcmp;
4090 if (sorted_file_alloc < cwd_n_used + cwd_n_used / 2)
4092 free (sorted_file);
4093 sorted_file = xnmalloc (cwd_n_used, 3 * sizeof *sorted_file);
4094 sorted_file_alloc = 3 * cwd_n_used;
4097 initialize_ordering_vector ();
4099 update_current_files_info ();
4101 if (sort_type == sort_none)
4102 return;
4104 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
4105 ignore strcoll failures, as a failing strcoll might be a
4106 comparison function that is not a total order, and if we ignored
4107 the failure this might cause qsort to dump core. */
4109 if (! setjmp (failed_strcoll))
4110 use_strcmp = false; /* strcoll() succeeded */
4111 else
4113 use_strcmp = true;
4114 affirm (sort_type != sort_version);
4115 initialize_ordering_vector ();
4118 /* When sort_type == sort_time, use time_type as subindex. */
4119 mpsort ((void const **) sorted_file, cwd_n_used,
4120 sort_functions[sort_type + (sort_type == sort_time ? time_type : 0)]
4121 [use_strcmp][sort_reverse]
4122 [directories_first]);
4125 /* List all the files now in the table. */
4127 static void
4128 print_current_files (void)
4130 size_t i;
4132 switch (format)
4134 case one_per_line:
4135 for (i = 0; i < cwd_n_used; i++)
4137 print_file_name_and_frills (sorted_file[i], 0);
4138 putchar (eolbyte);
4140 break;
4142 case many_per_line:
4143 if (! line_length)
4144 print_with_separator (' ');
4145 else
4146 print_many_per_line ();
4147 break;
4149 case horizontal:
4150 if (! line_length)
4151 print_with_separator (' ');
4152 else
4153 print_horizontal ();
4154 break;
4156 case with_commas:
4157 print_with_separator (',');
4158 break;
4160 case long_format:
4161 for (i = 0; i < cwd_n_used; i++)
4163 set_normal_color ();
4164 print_long_format (sorted_file[i]);
4165 dired_outbyte (eolbyte);
4167 break;
4171 /* Replace the first %b with precomputed aligned month names.
4172 Note on glibc-2.7 at least, this speeds up the whole 'ls -lU'
4173 process by around 17%, compared to letting strftime() handle the %b. */
4175 static size_t
4176 align_nstrftime (char *buf, size_t size, bool recent, struct tm const *tm,
4177 timezone_t tz, int ns)
4179 char const *nfmt = (use_abformat
4180 ? abformat[recent][tm->tm_mon]
4181 : long_time_format[recent]);
4182 return nstrftime (buf, size, nfmt, tm, tz, ns);
4185 /* Return the expected number of columns in a long-format timestamp,
4186 or zero if it cannot be calculated. */
4188 static int
4189 long_time_expected_width (void)
4191 static int width = -1;
4193 if (width < 0)
4195 time_t epoch = 0;
4196 struct tm tm;
4197 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
4199 /* In case you're wondering if localtime_rz can fail with an input time_t
4200 value of 0, let's just say it's very unlikely, but not inconceivable.
4201 The TZ environment variable would have to specify a time zone that
4202 is 2**31-1900 years or more ahead of UTC. This could happen only on
4203 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
4204 However, this is not possible with Solaris 10 or glibc-2.3.5, since
4205 their implementations limit the offset to 167:59 and 24:00, resp. */
4206 if (localtime_rz (localtz, &epoch, &tm))
4208 size_t len = align_nstrftime (buf, sizeof buf, false,
4209 &tm, localtz, 0);
4210 if (len != 0)
4211 width = mbsnwidth (buf, len, 0);
4214 if (width < 0)
4215 width = 0;
4218 return width;
4221 /* Print the user or group name NAME, with numeric id ID, using a
4222 print width of WIDTH columns. */
4224 static void
4225 format_user_or_group (char const *name, uintmax_t id, int width)
4227 if (name)
4229 int width_gap = width - mbswidth (name, 0);
4230 int pad = MAX (0, width_gap);
4231 dired_outstring (name);
4234 dired_outbyte (' ');
4235 while (pad--);
4237 else
4238 dired_pos += printf ("%*"PRIuMAX" ", width, id);
4241 /* Print the name or id of the user with id U, using a print width of
4242 WIDTH. */
4244 static void
4245 format_user (uid_t u, int width, bool stat_ok)
4247 format_user_or_group (! stat_ok ? "?" :
4248 (numeric_ids ? nullptr : getuser (u)), u, width);
4251 /* Likewise, for groups. */
4253 static void
4254 format_group (gid_t g, int width, bool stat_ok)
4256 format_user_or_group (! stat_ok ? "?" :
4257 (numeric_ids ? nullptr : getgroup (g)), g, width);
4260 /* Return the number of columns that format_user_or_group will print. */
4262 static int
4263 format_user_or_group_width (char const *name, uintmax_t id)
4265 if (name)
4267 int len = mbswidth (name, 0);
4268 return MAX (0, len);
4270 else
4271 return snprintf (nullptr, 0, "%"PRIuMAX, id);
4274 /* Return the number of columns that format_user will print. */
4276 static int
4277 format_user_width (uid_t u)
4279 return format_user_or_group_width (numeric_ids ? nullptr : getuser (u), u);
4282 /* Likewise, for groups. */
4284 static int
4285 format_group_width (gid_t g)
4287 return format_user_or_group_width (numeric_ids ? nullptr : getgroup (g), g);
4290 /* Return a pointer to a formatted version of F->stat.st_ino,
4291 possibly using buffer, which must be at least
4292 INT_BUFSIZE_BOUND (uintmax_t) bytes. */
4293 static char *
4294 format_inode (char buf[INT_BUFSIZE_BOUND (uintmax_t)],
4295 const struct fileinfo *f)
4297 return (f->stat_ok && f->stat.st_ino != NOT_AN_INODE_NUMBER
4298 ? umaxtostr (f->stat.st_ino, buf)
4299 : (char *) "?");
4302 /* Print information about F in long format. */
4303 static void
4304 print_long_format (const struct fileinfo *f)
4306 char modebuf[12];
4307 char buf
4308 [LONGEST_HUMAN_READABLE + 1 /* inode */
4309 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
4310 + sizeof (modebuf) - 1 + 1 /* mode string */
4311 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
4312 + LONGEST_HUMAN_READABLE + 2 /* major device number */
4313 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
4314 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
4316 size_t s;
4317 char *p;
4318 struct timespec when_timespec;
4319 struct tm when_local;
4320 bool btime_ok = true;
4322 /* Compute the mode string, except remove the trailing space if no
4323 file in this directory has an ACL or security context. */
4324 if (f->stat_ok)
4325 filemodestring (&f->stat, modebuf);
4326 else
4328 modebuf[0] = filetype_letter[f->filetype];
4329 memset (modebuf + 1, '?', 10);
4330 modebuf[11] = '\0';
4332 if (! any_has_acl)
4333 modebuf[10] = '\0';
4334 else if (f->acl_type == ACL_T_LSM_CONTEXT_ONLY)
4335 modebuf[10] = '.';
4336 else if (f->acl_type == ACL_T_YES)
4337 modebuf[10] = '+';
4339 switch (time_type)
4341 case time_ctime:
4342 when_timespec = get_stat_ctime (&f->stat);
4343 break;
4344 case time_mtime:
4345 when_timespec = get_stat_mtime (&f->stat);
4346 break;
4347 case time_atime:
4348 when_timespec = get_stat_atime (&f->stat);
4349 break;
4350 case time_btime:
4351 when_timespec = get_stat_btime (&f->stat);
4352 if (when_timespec.tv_sec == -1 && when_timespec.tv_nsec == -1)
4353 btime_ok = false;
4354 break;
4355 default:
4356 unreachable ();
4359 p = buf;
4361 if (print_inode)
4363 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
4364 p += sprintf (p, "%*s ", inode_number_width, format_inode (hbuf, f));
4367 if (print_block_size)
4369 char hbuf[LONGEST_HUMAN_READABLE + 1];
4370 char const *blocks =
4371 (! f->stat_ok
4372 ? "?"
4373 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
4374 ST_NBLOCKSIZE, output_block_size));
4375 int pad;
4376 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
4377 *p++ = ' ';
4378 while ((*p++ = *blocks++))
4379 continue;
4380 p[-1] = ' ';
4383 /* The last byte of the mode string is the POSIX
4384 "optional alternate access method flag". */
4386 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
4387 p += sprintf (p, "%s %*s ", modebuf, nlink_width,
4388 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
4391 dired_indent ();
4393 if (print_owner || print_group || print_author || print_scontext)
4395 dired_outbuf (buf, p - buf);
4397 if (print_owner)
4398 format_user (f->stat.st_uid, owner_width, f->stat_ok);
4400 if (print_group)
4401 format_group (f->stat.st_gid, group_width, f->stat_ok);
4403 if (print_author)
4404 format_user (f->stat.st_author, author_width, f->stat_ok);
4406 if (print_scontext)
4407 format_user_or_group (f->scontext, 0, scontext_width);
4409 p = buf;
4412 if (f->stat_ok
4413 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
4415 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
4416 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
4417 int blanks_width = (file_size_width
4418 - (major_device_number_width + 2
4419 + minor_device_number_width));
4420 p += sprintf (p, "%*s, %*s ",
4421 major_device_number_width + MAX (0, blanks_width),
4422 umaxtostr (major (f->stat.st_rdev), majorbuf),
4423 minor_device_number_width,
4424 umaxtostr (minor (f->stat.st_rdev), minorbuf));
4426 else
4428 char hbuf[LONGEST_HUMAN_READABLE + 1];
4429 char const *size =
4430 (! f->stat_ok
4431 ? "?"
4432 : human_readable (unsigned_file_size (f->stat.st_size),
4433 hbuf, file_human_output_opts, 1,
4434 file_output_block_size));
4435 int pad;
4436 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
4437 *p++ = ' ';
4438 while ((*p++ = *size++))
4439 continue;
4440 p[-1] = ' ';
4443 s = 0;
4444 *p = '\1';
4446 if (f->stat_ok && btime_ok
4447 && localtime_rz (localtz, &when_timespec.tv_sec, &when_local))
4449 struct timespec six_months_ago;
4450 bool recent;
4452 /* If the file appears to be in the future, update the current
4453 time, in case the file happens to have been modified since
4454 the last time we checked the clock. */
4455 if (timespec_cmp (current_time, when_timespec) < 0)
4456 gettime (&current_time);
4458 /* Consider a time to be recent if it is within the past six months.
4459 A Gregorian year has 365.2425 * 24 * 60 * 60 == 31556952 seconds
4460 on the average. Write this value as an integer constant to
4461 avoid floating point hassles. */
4462 six_months_ago.tv_sec = current_time.tv_sec - 31556952 / 2;
4463 six_months_ago.tv_nsec = current_time.tv_nsec;
4465 recent = (timespec_cmp (six_months_ago, when_timespec) < 0
4466 && timespec_cmp (when_timespec, current_time) < 0);
4468 /* We assume here that all time zones are offset from UTC by a
4469 whole number of seconds. */
4470 s = align_nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, recent,
4471 &when_local, localtz, when_timespec.tv_nsec);
4474 if (s || !*p)
4476 p += s;
4477 *p++ = ' ';
4479 else
4481 /* The time cannot be converted using the desired format, so
4482 print it as a huge integer number of seconds. */
4483 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
4484 p += sprintf (p, "%*s ", long_time_expected_width (),
4485 (! f->stat_ok || ! btime_ok
4486 ? "?"
4487 : timetostr (when_timespec.tv_sec, hbuf)));
4488 /* FIXME: (maybe) We discarded when_timespec.tv_nsec. */
4491 dired_outbuf (buf, p - buf);
4492 size_t w = print_name_with_quoting (f, false, &dired_obstack, p - buf);
4494 if (f->filetype == symbolic_link)
4496 if (f->linkname)
4498 dired_outstring (" -> ");
4499 print_name_with_quoting (f, true, nullptr, (p - buf) + w + 4);
4500 if (indicator_style != none)
4501 print_type_indicator (true, f->linkmode, unknown);
4504 else if (indicator_style != none)
4505 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4508 /* Write to *BUF a quoted representation of the file name NAME, if non-null,
4509 using OPTIONS to control quoting. *BUF is set to NAME if no quoting
4510 is required. *BUF is allocated if more space required (and the original
4511 *BUF is not deallocated).
4512 Store the number of screen columns occupied by NAME's quoted
4513 representation into WIDTH, if non-null.
4514 Store into PAD whether an initial space is needed for padding.
4515 Return the number of bytes in *BUF. */
4517 static size_t
4518 quote_name_buf (char **inbuf, size_t bufsize, char *name,
4519 struct quoting_options const *options,
4520 int needs_general_quoting, size_t *width, bool *pad)
4522 char *buf = *inbuf;
4523 size_t displayed_width IF_LINT ( = 0);
4524 size_t len = 0;
4525 bool quoted;
4527 enum quoting_style qs = get_quoting_style (options);
4528 bool needs_further_quoting = qmark_funny_chars
4529 && (qs == shell_quoting_style
4530 || qs == shell_always_quoting_style
4531 || qs == literal_quoting_style);
4533 if (needs_general_quoting != 0)
4535 len = quotearg_buffer (buf, bufsize, name, -1, options);
4536 if (bufsize <= len)
4538 buf = xmalloc (len + 1);
4539 quotearg_buffer (buf, len + 1, name, -1, options);
4542 quoted = (*name != *buf) || strlen (name) != len;
4544 else if (needs_further_quoting)
4546 len = strlen (name);
4547 if (bufsize <= len)
4548 buf = xmalloc (len + 1);
4549 memcpy (buf, name, len + 1);
4551 quoted = false;
4553 else
4555 len = strlen (name);
4556 buf = name;
4557 quoted = false;
4560 if (needs_further_quoting)
4562 if (MB_CUR_MAX > 1)
4564 char const *p = buf;
4565 char const *plimit = buf + len;
4566 char *q = buf;
4567 displayed_width = 0;
4569 while (p < plimit)
4570 switch (*p)
4572 case ' ': case '!': case '"': case '#': case '%':
4573 case '&': case '\'': case '(': case ')': case '*':
4574 case '+': case ',': case '-': case '.': case '/':
4575 case '0': case '1': case '2': case '3': case '4':
4576 case '5': case '6': case '7': case '8': case '9':
4577 case ':': case ';': case '<': case '=': case '>':
4578 case '?':
4579 case 'A': case 'B': case 'C': case 'D': case 'E':
4580 case 'F': case 'G': case 'H': case 'I': case 'J':
4581 case 'K': case 'L': case 'M': case 'N': case 'O':
4582 case 'P': case 'Q': case 'R': case 'S': case 'T':
4583 case 'U': case 'V': case 'W': case 'X': case 'Y':
4584 case 'Z':
4585 case '[': case '\\': case ']': case '^': case '_':
4586 case 'a': case 'b': case 'c': case 'd': case 'e':
4587 case 'f': case 'g': case 'h': case 'i': case 'j':
4588 case 'k': case 'l': case 'm': case 'n': case 'o':
4589 case 'p': case 'q': case 'r': case 's': case 't':
4590 case 'u': case 'v': case 'w': case 'x': case 'y':
4591 case 'z': case '{': case '|': case '}': case '~':
4592 /* These characters are printable ASCII characters. */
4593 *q++ = *p++;
4594 displayed_width += 1;
4595 break;
4596 default:
4597 /* If we have a multibyte sequence, copy it until we
4598 reach its end, replacing each non-printable multibyte
4599 character with a single question mark. */
4601 mbstate_t mbstate = { 0, };
4604 wchar_t wc;
4605 size_t bytes;
4606 int w;
4608 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
4610 if (bytes == (size_t) -1)
4612 /* An invalid multibyte sequence was
4613 encountered. Skip one input byte, and
4614 put a question mark. */
4615 p++;
4616 *q++ = '?';
4617 displayed_width += 1;
4618 break;
4621 if (bytes == (size_t) -2)
4623 /* An incomplete multibyte character
4624 at the end. Replace it entirely with
4625 a question mark. */
4626 p = plimit;
4627 *q++ = '?';
4628 displayed_width += 1;
4629 break;
4632 if (bytes == 0)
4633 /* A null wide character was encountered. */
4634 bytes = 1;
4636 w = wcwidth (wc);
4637 if (w >= 0)
4639 /* A printable multibyte character.
4640 Keep it. */
4641 for (; bytes > 0; --bytes)
4642 *q++ = *p++;
4643 displayed_width += w;
4645 else
4647 /* An unprintable multibyte character.
4648 Replace it entirely with a question
4649 mark. */
4650 p += bytes;
4651 *q++ = '?';
4652 displayed_width += 1;
4655 while (! mbsinit (&mbstate));
4657 break;
4660 /* The buffer may have shrunk. */
4661 len = q - buf;
4663 else
4665 char *p = buf;
4666 char const *plimit = buf + len;
4668 while (p < plimit)
4670 if (! isprint (to_uchar (*p)))
4671 *p = '?';
4672 p++;
4674 displayed_width = len;
4677 else if (width != nullptr)
4679 if (MB_CUR_MAX > 1)
4680 displayed_width = mbsnwidth (buf, len, 0);
4681 else
4683 char const *p = buf;
4684 char const *plimit = buf + len;
4686 displayed_width = 0;
4687 while (p < plimit)
4689 if (isprint (to_uchar (*p)))
4690 displayed_width++;
4691 p++;
4696 /* Set padding to better align quoted items,
4697 and also give a visual indication that quotes are
4698 not actually part of the name. */
4699 *pad = (align_variable_outer_quotes && cwd_some_quoted && ! quoted);
4701 if (width != nullptr)
4702 *width = displayed_width;
4704 *inbuf = buf;
4706 return len;
4709 static size_t
4710 quote_name_width (char const *name, struct quoting_options const *options,
4711 int needs_general_quoting)
4713 char smallbuf[BUFSIZ];
4714 char *buf = smallbuf;
4715 size_t width;
4716 bool pad;
4718 quote_name_buf (&buf, sizeof smallbuf, (char *) name, options,
4719 needs_general_quoting, &width, &pad);
4721 if (buf != smallbuf && buf != name)
4722 free (buf);
4724 width += pad;
4726 return width;
4729 /* %XX escape any input out of range as defined in RFC3986,
4730 and also if PATH, convert all path separators to '/'. */
4731 static char *
4732 file_escape (char const *str, bool path)
4734 char *esc = xnmalloc (3, strlen (str) + 1);
4735 char *p = esc;
4736 while (*str)
4738 if (path && ISSLASH (*str))
4740 *p++ = '/';
4741 str++;
4743 else if (RFC3986[to_uchar (*str)])
4744 *p++ = *str++;
4745 else
4746 p += sprintf (p, "%%%02x", to_uchar (*str++));
4748 *p = '\0';
4749 return esc;
4752 static size_t
4753 quote_name (char const *name, struct quoting_options const *options,
4754 int needs_general_quoting, const struct bin_str *color,
4755 bool allow_pad, struct obstack *stack, char const *absolute_name)
4757 char smallbuf[BUFSIZ];
4758 char *buf = smallbuf;
4759 size_t len;
4760 bool pad;
4762 len = quote_name_buf (&buf, sizeof smallbuf, (char *) name, options,
4763 needs_general_quoting, nullptr, &pad);
4765 if (pad && allow_pad)
4766 dired_outbyte (' ');
4768 if (color)
4769 print_color_indicator (color);
4771 /* If we're padding, then don't include the outer quotes in
4772 the --hyperlink, to improve the alignment of those links. */
4773 bool skip_quotes = false;
4775 if (absolute_name)
4777 if (align_variable_outer_quotes && cwd_some_quoted && ! pad)
4779 skip_quotes = true;
4780 putchar (*buf);
4782 char *h = file_escape (hostname, /* path= */ false);
4783 char *n = file_escape (absolute_name, /* path= */ true);
4784 /* TODO: It would be good to be able to define parameters
4785 to give hints to the terminal as how best to render the URI.
4786 For example since ls is outputting a dense block of URIs
4787 it would be best to not underline by default, and only
4788 do so upon hover etc. */
4789 printf ("\033]8;;file://%s%s%s\a", h, *n == '/' ? "" : "/", n);
4790 free (h);
4791 free (n);
4794 if (stack)
4795 push_current_dired_pos (stack);
4797 fwrite (buf + skip_quotes, 1, len - (skip_quotes * 2), stdout);
4799 dired_pos += len;
4801 if (stack)
4802 push_current_dired_pos (stack);
4804 if (absolute_name)
4806 fputs ("\033]8;;\a", stdout);
4807 if (skip_quotes)
4808 putchar (*(buf + len - 1));
4811 if (buf != smallbuf && buf != name)
4812 free (buf);
4814 return len + pad;
4817 static size_t
4818 print_name_with_quoting (const struct fileinfo *f,
4819 bool symlink_target,
4820 struct obstack *stack,
4821 size_t start_col)
4823 char const *name = symlink_target ? f->linkname : f->name;
4825 const struct bin_str *color
4826 = print_with_color ? get_color_indicator (f, symlink_target) : nullptr;
4828 bool used_color_this_time = (print_with_color
4829 && (color || is_colored (C_NORM)));
4831 size_t len = quote_name (name, filename_quoting_options, f->quoted,
4832 color, !symlink_target, stack, f->absolute_name);
4834 process_signals ();
4835 if (used_color_this_time)
4837 prep_non_filename_text ();
4839 /* We use the byte length rather than display width here as
4840 an optimization to avoid accurately calculating the width,
4841 because we only output the clear to EOL sequence if the name
4842 _might_ wrap to the next line. This may output a sequence
4843 unnecessarily in multi-byte locales for example,
4844 but in that case it's inconsequential to the output. */
4845 if (line_length
4846 && (start_col / line_length != (start_col + len - 1) / line_length))
4847 put_indicator (&color_indicator[C_CLR_TO_EOL]);
4850 return len;
4853 static void
4854 prep_non_filename_text (void)
4856 if (color_indicator[C_END].string != nullptr)
4857 put_indicator (&color_indicator[C_END]);
4858 else
4860 put_indicator (&color_indicator[C_LEFT]);
4861 put_indicator (&color_indicator[C_RESET]);
4862 put_indicator (&color_indicator[C_RIGHT]);
4866 /* Print the file name of 'f' with appropriate quoting.
4867 Also print file size, inode number, and filetype indicator character,
4868 as requested by switches. */
4870 static size_t
4871 print_file_name_and_frills (const struct fileinfo *f, size_t start_col)
4873 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4875 set_normal_color ();
4877 if (print_inode)
4878 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
4879 format_inode (buf, f));
4881 if (print_block_size)
4882 printf ("%*s ", format == with_commas ? 0 : block_size_width,
4883 ! f->stat_ok ? "?"
4884 : human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
4885 ST_NBLOCKSIZE, output_block_size));
4887 if (print_scontext)
4888 printf ("%*s ", format == with_commas ? 0 : scontext_width, f->scontext);
4890 size_t width = print_name_with_quoting (f, false, nullptr, start_col);
4892 if (indicator_style != none)
4893 width += print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4895 return width;
4898 /* Given these arguments describing a file, return the single-byte
4899 type indicator, or 0. */
4900 static char
4901 get_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4903 char c;
4905 if (stat_ok ? S_ISREG (mode) : type == normal)
4907 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
4908 c = '*';
4909 else
4910 c = 0;
4912 else
4914 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
4915 c = '/';
4916 else if (indicator_style == slash)
4917 c = 0;
4918 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
4919 c = '@';
4920 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
4921 c = '|';
4922 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
4923 c = '=';
4924 else if (stat_ok && S_ISDOOR (mode))
4925 c = '>';
4926 else
4927 c = 0;
4929 return c;
4932 static bool
4933 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4935 char c = get_type_indicator (stat_ok, mode, type);
4936 if (c)
4937 dired_outbyte (c);
4938 return !!c;
4941 /* Returns if color sequence was printed. */
4942 static bool
4943 print_color_indicator (const struct bin_str *ind)
4945 if (ind)
4947 /* Need to reset so not dealing with attribute combinations */
4948 if (is_colored (C_NORM))
4949 restore_default_color ();
4950 put_indicator (&color_indicator[C_LEFT]);
4951 put_indicator (ind);
4952 put_indicator (&color_indicator[C_RIGHT]);
4955 return ind != nullptr;
4958 /* Returns color indicator or nullptr if none. */
4959 ATTRIBUTE_PURE
4960 static const struct bin_str*
4961 get_color_indicator (const struct fileinfo *f, bool symlink_target)
4963 enum indicator_no type;
4964 struct color_ext_type *ext; /* Color extension */
4965 size_t len; /* Length of name */
4967 char const *name;
4968 mode_t mode;
4969 int linkok;
4970 if (symlink_target)
4972 name = f->linkname;
4973 mode = f->linkmode;
4974 linkok = f->linkok ? 0 : -1;
4976 else
4978 name = f->name;
4979 mode = file_or_link_mode (f);
4980 linkok = f->linkok;
4983 /* Is this a nonexistent file? If so, linkok == -1. */
4985 if (linkok == -1 && is_colored (C_MISSING))
4986 type = C_MISSING;
4987 else if (!f->stat_ok)
4989 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
4990 type = filetype_indicator[f->filetype];
4992 else
4994 if (S_ISREG (mode))
4996 type = C_FILE;
4998 if ((mode & S_ISUID) != 0 && is_colored (C_SETUID))
4999 type = C_SETUID;
5000 else if ((mode & S_ISGID) != 0 && is_colored (C_SETGID))
5001 type = C_SETGID;
5002 else if (is_colored (C_CAP) && f->has_capability)
5003 type = C_CAP;
5004 else if ((mode & S_IXUGO) != 0 && is_colored (C_EXEC))
5005 type = C_EXEC;
5006 else if ((1 < f->stat.st_nlink) && is_colored (C_MULTIHARDLINK))
5007 type = C_MULTIHARDLINK;
5009 else if (S_ISDIR (mode))
5011 type = C_DIR;
5013 if ((mode & S_ISVTX) && (mode & S_IWOTH)
5014 && is_colored (C_STICKY_OTHER_WRITABLE))
5015 type = C_STICKY_OTHER_WRITABLE;
5016 else if ((mode & S_IWOTH) != 0 && is_colored (C_OTHER_WRITABLE))
5017 type = C_OTHER_WRITABLE;
5018 else if ((mode & S_ISVTX) != 0 && is_colored (C_STICKY))
5019 type = C_STICKY;
5021 else if (S_ISLNK (mode))
5022 type = C_LINK;
5023 else if (S_ISFIFO (mode))
5024 type = C_FIFO;
5025 else if (S_ISSOCK (mode))
5026 type = C_SOCK;
5027 else if (S_ISBLK (mode))
5028 type = C_BLK;
5029 else if (S_ISCHR (mode))
5030 type = C_CHR;
5031 else if (S_ISDOOR (mode))
5032 type = C_DOOR;
5033 else
5035 /* Classify a file of some other type as C_ORPHAN. */
5036 type = C_ORPHAN;
5040 /* Check the file's suffix only if still classified as C_FILE. */
5041 ext = nullptr;
5042 if (type == C_FILE)
5044 /* Test if NAME has a recognized suffix. */
5046 len = strlen (name);
5047 name += len; /* Pointer to final \0. */
5048 for (ext = color_ext_list; ext != nullptr; ext = ext->next)
5050 if (ext->ext.len <= len)
5052 if (ext->exact_match)
5054 if (STREQ_LEN (name - ext->ext.len, ext->ext.string,
5055 ext->ext.len))
5056 break;
5058 else
5060 if (c_strncasecmp (name - ext->ext.len, ext->ext.string,
5061 ext->ext.len) == 0)
5062 break;
5068 /* Adjust the color for orphaned symlinks. */
5069 if (type == C_LINK && !linkok)
5071 if (color_symlink_as_referent || is_colored (C_ORPHAN))
5072 type = C_ORPHAN;
5075 const struct bin_str *const s
5076 = ext ? &(ext->seq) : &color_indicator[type];
5078 return s->string ? s : nullptr;
5081 /* Output a color indicator (which may contain nulls). */
5082 static void
5083 put_indicator (const struct bin_str *ind)
5085 if (! used_color)
5087 used_color = true;
5089 /* If the standard output is a controlling terminal, watch out
5090 for signals, so that the colors can be restored to the
5091 default state if "ls" is suspended or interrupted. */
5093 if (0 <= tcgetpgrp (STDOUT_FILENO))
5094 signal_init ();
5096 prep_non_filename_text ();
5099 fwrite (ind->string, ind->len, 1, stdout);
5102 static size_t
5103 length_of_file_name_and_frills (const struct fileinfo *f)
5105 size_t len = 0;
5106 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
5108 if (print_inode)
5109 len += 1 + (format == with_commas
5110 ? strlen (umaxtostr (f->stat.st_ino, buf))
5111 : inode_number_width);
5113 if (print_block_size)
5114 len += 1 + (format == with_commas
5115 ? strlen (! f->stat_ok ? "?"
5116 : human_readable (ST_NBLOCKS (f->stat), buf,
5117 human_output_opts, ST_NBLOCKSIZE,
5118 output_block_size))
5119 : block_size_width);
5121 if (print_scontext)
5122 len += 1 + (format == with_commas ? strlen (f->scontext) : scontext_width);
5124 len += fileinfo_name_width (f);
5126 if (indicator_style != none)
5128 char c = get_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
5129 len += (c != 0);
5132 return len;
5135 static void
5136 print_many_per_line (void)
5138 size_t row; /* Current row. */
5139 size_t cols = calculate_columns (true);
5140 struct column_info const *line_fmt = &column_info[cols - 1];
5142 /* Calculate the number of rows that will be in each column except possibly
5143 for a short column on the right. */
5144 size_t rows = cwd_n_used / cols + (cwd_n_used % cols != 0);
5146 for (row = 0; row < rows; row++)
5148 size_t col = 0;
5149 size_t filesno = row;
5150 size_t pos = 0;
5152 /* Print the next row. */
5153 while (true)
5155 struct fileinfo const *f = sorted_file[filesno];
5156 size_t name_length = length_of_file_name_and_frills (f);
5157 size_t max_name_length = line_fmt->col_arr[col++];
5158 print_file_name_and_frills (f, pos);
5160 filesno += rows;
5161 if (filesno >= cwd_n_used)
5162 break;
5164 indent (pos + name_length, pos + max_name_length);
5165 pos += max_name_length;
5167 putchar (eolbyte);
5171 static void
5172 print_horizontal (void)
5174 size_t filesno;
5175 size_t pos = 0;
5176 size_t cols = calculate_columns (false);
5177 struct column_info const *line_fmt = &column_info[cols - 1];
5178 struct fileinfo const *f = sorted_file[0];
5179 size_t name_length = length_of_file_name_and_frills (f);
5180 size_t max_name_length = line_fmt->col_arr[0];
5182 /* Print first entry. */
5183 print_file_name_and_frills (f, 0);
5185 /* Now the rest. */
5186 for (filesno = 1; filesno < cwd_n_used; ++filesno)
5188 size_t col = filesno % cols;
5190 if (col == 0)
5192 putchar (eolbyte);
5193 pos = 0;
5195 else
5197 indent (pos + name_length, pos + max_name_length);
5198 pos += max_name_length;
5201 f = sorted_file[filesno];
5202 print_file_name_and_frills (f, pos);
5204 name_length = length_of_file_name_and_frills (f);
5205 max_name_length = line_fmt->col_arr[col];
5207 putchar (eolbyte);
5210 /* Output name + SEP + ' '. */
5212 static void
5213 print_with_separator (char sep)
5215 size_t filesno;
5216 size_t pos = 0;
5218 for (filesno = 0; filesno < cwd_n_used; filesno++)
5220 struct fileinfo const *f = sorted_file[filesno];
5221 size_t len = line_length ? length_of_file_name_and_frills (f) : 0;
5223 if (filesno != 0)
5225 char separator;
5227 if (! line_length
5228 || ((pos + len + 2 < line_length)
5229 && (pos <= SIZE_MAX - len - 2)))
5231 pos += 2;
5232 separator = ' ';
5234 else
5236 pos = 0;
5237 separator = eolbyte;
5240 putchar (sep);
5241 putchar (separator);
5244 print_file_name_and_frills (f, pos);
5245 pos += len;
5247 putchar (eolbyte);
5250 /* Assuming cursor is at position FROM, indent up to position TO.
5251 Use a TAB character instead of two or more spaces whenever possible. */
5253 static void
5254 indent (size_t from, size_t to)
5256 while (from < to)
5258 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
5260 putchar ('\t');
5261 from += tabsize - from % tabsize;
5263 else
5265 putchar (' ');
5266 from++;
5271 /* Put DIRNAME/NAME into DEST, handling '.' and '/' properly. */
5272 /* FIXME: maybe remove this function someday. See about using a
5273 non-malloc'ing version of file_name_concat. */
5275 static void
5276 attach (char *dest, char const *dirname, char const *name)
5278 char const *dirnamep = dirname;
5280 /* Copy dirname if it is not ".". */
5281 if (dirname[0] != '.' || dirname[1] != 0)
5283 while (*dirnamep)
5284 *dest++ = *dirnamep++;
5285 /* Add '/' if 'dirname' doesn't already end with it. */
5286 if (dirnamep > dirname && dirnamep[-1] != '/')
5287 *dest++ = '/';
5289 while (*name)
5290 *dest++ = *name++;
5291 *dest = 0;
5294 /* Allocate enough column info suitable for the current number of
5295 files and display columns, and initialize the info to represent the
5296 narrowest possible columns. */
5298 static void
5299 init_column_info (size_t max_cols)
5301 size_t i;
5303 /* Currently allocated columns in column_info. */
5304 static size_t column_info_alloc;
5306 if (column_info_alloc < max_cols)
5308 size_t new_column_info_alloc;
5309 size_t *p;
5311 if (!max_idx || max_cols < max_idx / 2)
5313 /* The number of columns is far less than the display width
5314 allows. Grow the allocation, but only so that it's
5315 double the current requirements. If the display is
5316 extremely wide, this avoids allocating a lot of memory
5317 that is never needed. */
5318 column_info = xnrealloc (column_info, max_cols,
5319 2 * sizeof *column_info);
5320 new_column_info_alloc = 2 * max_cols;
5322 else
5324 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
5325 new_column_info_alloc = max_idx;
5328 /* Allocate the new size_t objects by computing the triangle
5329 formula n * (n + 1) / 2, except that we don't need to
5330 allocate the part of the triangle that we've already
5331 allocated. Check for address arithmetic overflow. */
5333 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
5334 size_t s = column_info_alloc + 1 + new_column_info_alloc;
5335 size_t t = s * column_info_growth;
5336 if (s < new_column_info_alloc || t / column_info_growth != s)
5337 xalloc_die ();
5338 p = xnmalloc (t / 2, sizeof *p);
5341 /* Grow the triangle by parceling out the cells just allocated. */
5342 for (i = column_info_alloc; i < new_column_info_alloc; i++)
5344 column_info[i].col_arr = p;
5345 p += i + 1;
5348 column_info_alloc = new_column_info_alloc;
5351 for (i = 0; i < max_cols; ++i)
5353 size_t j;
5355 column_info[i].valid_len = true;
5356 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
5357 for (j = 0; j <= i; ++j)
5358 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
5362 /* Calculate the number of columns needed to represent the current set
5363 of files in the current display width. */
5365 static size_t
5366 calculate_columns (bool by_columns)
5368 size_t filesno; /* Index into cwd_file. */
5369 size_t cols; /* Number of files across. */
5371 /* Normally the maximum number of columns is determined by the
5372 screen width. But if few files are available this might limit it
5373 as well. */
5374 size_t max_cols = 0 < max_idx && max_idx < cwd_n_used ? max_idx : cwd_n_used;
5376 init_column_info (max_cols);
5378 /* Compute the maximum number of possible columns. */
5379 for (filesno = 0; filesno < cwd_n_used; ++filesno)
5381 struct fileinfo const *f = sorted_file[filesno];
5382 size_t name_length = length_of_file_name_and_frills (f);
5384 for (size_t i = 0; i < max_cols; ++i)
5386 if (column_info[i].valid_len)
5388 size_t idx = (by_columns
5389 ? filesno / ((cwd_n_used + i) / (i + 1))
5390 : filesno % (i + 1));
5391 size_t real_length = name_length + (idx == i ? 0 : 2);
5393 if (column_info[i].col_arr[idx] < real_length)
5395 column_info[i].line_len += (real_length
5396 - column_info[i].col_arr[idx]);
5397 column_info[i].col_arr[idx] = real_length;
5398 column_info[i].valid_len = (column_info[i].line_len
5399 < line_length);
5405 /* Find maximum allowed columns. */
5406 for (cols = max_cols; 1 < cols; --cols)
5408 if (column_info[cols - 1].valid_len)
5409 break;
5412 return cols;
5415 void
5416 usage (int status)
5418 if (status != EXIT_SUCCESS)
5419 emit_try_help ();
5420 else
5422 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
5423 fputs (_("\
5424 List information about the FILEs (the current directory by default).\n\
5425 Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.\n\
5426 "), stdout);
5428 emit_mandatory_arg_note ();
5430 fputs (_("\
5431 -a, --all do not ignore entries starting with .\n\
5432 -A, --almost-all do not list implied . and ..\n\
5433 --author with -l, print the author of each file\n\
5434 -b, --escape print C-style escapes for nongraphic characters\n\
5435 "), stdout);
5436 fputs (_("\
5437 --block-size=SIZE with -l, scale sizes by SIZE when printing them;\n\
5438 e.g., '--block-size=M'; see SIZE format below\n\
5440 "), stdout);
5441 fputs (_("\
5442 -B, --ignore-backups do not list implied entries ending with ~\n\
5443 "), stdout);
5444 fputs (_("\
5445 -c with -lt: sort by, and show, ctime (time of last\n\
5446 change of file status information);\n\
5447 with -l: show ctime and sort by name;\n\
5448 otherwise: sort by ctime, newest first\n\
5450 "), stdout);
5451 fputs (_("\
5452 -C list entries by columns\n\
5453 --color[=WHEN] color the output WHEN; more info below\n\
5454 -d, --directory list directories themselves, not their contents\n\
5455 -D, --dired generate output designed for Emacs' dired mode\n\
5456 "), stdout);
5457 fputs (_("\
5458 -f list all entries in directory order\n\
5459 -F, --classify[=WHEN] append indicator (one of */=>@|) to entries WHEN\n\
5460 --file-type likewise, except do not append '*'\n\
5461 "), stdout);
5462 fputs (_("\
5463 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
5464 single-column -1, verbose -l, vertical -C\n\
5466 "), stdout);
5467 fputs (_("\
5468 --full-time like -l --time-style=full-iso\n\
5469 "), stdout);
5470 fputs (_("\
5471 -g like -l, but do not list owner\n\
5472 "), stdout);
5473 fputs (_("\
5474 --group-directories-first\n\
5475 group directories before files;\n\
5476 can be augmented with a --sort option, but any\n\
5477 use of --sort=none (-U) disables grouping\n\
5479 "), stdout);
5480 fputs (_("\
5481 -G, --no-group in a long listing, don't print group names\n\
5482 "), stdout);
5483 fputs (_("\
5484 -h, --human-readable with -l and -s, print sizes like 1K 234M 2G etc.\n\
5485 --si likewise, but use powers of 1000 not 1024\n\
5486 "), stdout);
5487 fputs (_("\
5488 -H, --dereference-command-line\n\
5489 follow symbolic links listed on the command line\n\
5490 "), stdout);
5491 fputs (_("\
5492 --dereference-command-line-symlink-to-dir\n\
5493 follow each command line symbolic link\n\
5494 that points to a directory\n\
5496 "), stdout);
5497 fputs (_("\
5498 --hide=PATTERN do not list implied entries matching shell PATTERN\
5500 (overridden by -a or -A)\n\
5502 "), stdout);
5503 fputs (_("\
5504 --hyperlink[=WHEN] hyperlink file names WHEN\n\
5505 "), stdout);
5506 fputs (_("\
5507 --indicator-style=WORD\n\
5508 append indicator with style WORD to entry names:\n\
5509 none (default), slash (-p),\n\
5510 file-type (--file-type), classify (-F)\n\
5512 "), stdout);
5513 fputs (_("\
5514 -i, --inode print the index number of each file\n\
5515 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\
5517 "), stdout);
5518 fputs (_("\
5519 -k, --kibibytes default to 1024-byte blocks for file system usage;\
5521 used only with -s and per directory totals\n\
5523 "), stdout);
5524 fputs (_("\
5525 -l use a long listing format\n\
5526 "), stdout);
5527 fputs (_("\
5528 -L, --dereference when showing file information for a symbolic\n\
5529 link, show information for the file the link\n\
5530 references rather than for the link itself\n\
5532 "), stdout);
5533 fputs (_("\
5534 -m fill width with a comma separated list of entries\
5536 "), stdout);
5537 fputs (_("\
5538 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
5539 -N, --literal print entry names without quoting\n\
5540 -o like -l, but do not list group information\n\
5541 -p, --indicator-style=slash\n\
5542 append / indicator to directories\n\
5543 "), stdout);
5544 fputs (_("\
5545 -q, --hide-control-chars print ? instead of nongraphic characters\n\
5546 "), stdout);
5547 fputs (_("\
5548 --show-control-chars show nongraphic characters as-is (the default,\n\
5549 unless program is 'ls' and output is a terminal)\
5552 "), stdout);
5553 fputs (_("\
5554 -Q, --quote-name enclose entry names in double quotes\n\
5555 "), stdout);
5556 fputs (_("\
5557 --quoting-style=WORD use quoting style WORD for entry names:\n\
5558 literal, locale, shell, shell-always,\n\
5559 shell-escape, shell-escape-always, c, escape\n\
5560 (overrides QUOTING_STYLE environment variable)\n\
5562 "), stdout);
5563 fputs (_("\
5564 -r, --reverse reverse order while sorting\n\
5565 -R, --recursive list subdirectories recursively\n\
5566 -s, --size print the allocated size of each file, in blocks\n\
5567 "), stdout);
5568 fputs (_("\
5569 -S sort by file size, largest first\n\
5570 "), stdout);
5571 fputs (_("\
5572 --sort=WORD sort by WORD instead of name: none (-U), size (-S)\
5573 ,\n\
5574 time (-t), version (-v), extension (-X), width\n\
5576 "), stdout);
5577 fputs (_("\
5578 --time=WORD select which timestamp used to display or sort;\n\
5579 access time (-u): atime, access, use;\n\
5580 metadata change time (-c): ctime, status;\n\
5581 modified time (default): mtime, modification;\n\
5582 birth time: birth, creation;\n\
5583 with -l, WORD determines which time to show;\n\
5584 with --sort=time, sort by WORD (newest first)\n\
5586 "), stdout);
5587 fputs (_("\
5588 --time-style=TIME_STYLE\n\
5589 time/date format with -l; see TIME_STYLE below\n\
5590 "), stdout);
5591 fputs (_("\
5592 -t sort by time, newest first; see --time\n\
5593 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
5594 "), stdout);
5595 fputs (_("\
5596 -u with -lt: sort by, and show, access time;\n\
5597 with -l: show access time and sort by name;\n\
5598 otherwise: sort by access time, newest first\n\
5600 "), stdout);
5601 fputs (_("\
5602 -U do not sort; list entries in directory order\n\
5603 "), stdout);
5604 fputs (_("\
5605 -v natural sort of (version) numbers within text\n\
5606 "), stdout);
5607 fputs (_("\
5608 -w, --width=COLS set output width to COLS. 0 means no limit\n\
5609 -x list entries by lines instead of by columns\n\
5610 -X sort alphabetically by entry extension\n\
5611 -Z, --context print any security context of each file\n\
5612 --zero end each output line with NUL, not newline\n\
5613 -1 list one file per line\n\
5614 "), stdout);
5615 fputs (HELP_OPTION_DESCRIPTION, stdout);
5616 fputs (VERSION_OPTION_DESCRIPTION, stdout);
5617 emit_size_note ();
5618 fputs (_("\
5620 The TIME_STYLE argument can be full-iso, long-iso, iso, locale, or +FORMAT.\n\
5621 FORMAT is interpreted like in date(1). If FORMAT is FORMAT1<newline>FORMAT2,\n\
5622 then FORMAT1 applies to non-recent files and FORMAT2 to recent files.\n\
5623 TIME_STYLE prefixed with 'posix-' takes effect only outside the POSIX locale.\n\
5624 Also the TIME_STYLE environment variable sets the default style to use.\n\
5625 "), stdout);
5626 fputs (_("\
5628 The WHEN argument defaults to 'always' and can also be 'auto' or 'never'.\n\
5629 "), stdout);
5630 fputs (_("\
5632 Using color to distinguish file types is disabled both by default and\n\
5633 with --color=never. With --color=auto, ls emits color codes only when\n\
5634 standard output is connected to a terminal. The LS_COLORS environment\n\
5635 variable can change the settings. Use the dircolors(1) command to set it.\n\
5636 "), stdout);
5637 fputs (_("\
5639 Exit status:\n\
5640 0 if OK,\n\
5641 1 if minor problems (e.g., cannot access subdirectory),\n\
5642 2 if serious trouble (e.g., cannot access command-line argument).\n\
5643 "), stdout);
5644 emit_ancillary_info (PROGRAM_NAME);
5646 exit (status);