2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1989, 1993, 1994
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 static const char copyright[] =
37 "@(#) Copyright (c) 1989, 1993, 1994\n\
38 The Regents of the University of California. All rights reserved.\n";
43 static char sccsid[] = "@(#)ls.c 8.5 (Berkeley) 4/2/94";
46 #include <sys/cdefs.h>
47 __FBSDID("$FreeBSD$");
49 #include <sys/param.h>
51 #include <sys/ioctl.h>
79 * Upward approximation of the maximum number of characters needed to
80 * represent a value of integral type t as a string, excluding the
81 * NUL terminator, with provision for a sign.
83 #define STRBUF_SIZEOF(t) (1 + CHAR_BIT * sizeof(t) / 3 + 1)
86 * MAKENINES(n) turns n into (10**n)-1. This is useful for converting a width
87 * into a number that wide in decimal.
88 * XXX: Overflows are not considered.
90 #define MAKENINES(n) \
94 /* Use a loop as all values of n are small. */ \
95 for (__i = 1; n > 0; __i *= 10) \
100 static void display(const FTSENT *, FTSENT *, int);
101 static int mastercmp(const FTSENT * const *, const FTSENT * const *);
102 static void traverse(int, char **, int);
104 #define COLOR_OPT (CHAR_MAX + 1)
106 static const struct option long_opts[] =
108 {"color", optional_argument, NULL, COLOR_OPT},
109 {NULL, no_argument, NULL, 0}
112 static void (*printfcn)(const DISPLAY *);
113 static int (*sortfcn)(const FTSENT *, const FTSENT *);
115 long blocksize; /* block size units */
116 int termwidth = 80; /* default terminal width */
119 int f_accesstime; /* use time of last access */
120 int f_birthtime; /* use time of birth */
121 int f_flags; /* show flags associated with a file */
122 int f_humanval; /* show human-readable file sizes */
123 int f_inode; /* print inode */
124 static int f_kblocks; /* print size in kilobytes */
125 int f_label; /* show MAC label */
126 static int f_listdir; /* list actual directory, not contents */
127 static int f_listdot; /* list files beginning with . */
128 int f_longform; /* long listing format */
129 static int f_noautodot; /* do not automatically enable -A for root */
130 static int f_nofollow; /* don't follow symbolic link arguments */
131 int f_nonprint; /* show unprintables as ? */
132 static int f_nosort; /* don't sort output */
133 int f_notabs; /* don't use tab-separated multi-col output */
134 static int f_numericonly; /* don't convert uid/gid to name */
135 int f_octal; /* show unprintables as \xxx */
136 int f_octal_escape; /* like f_octal but use C escapes if possible */
137 static int f_recursive; /* ls subdirectories also */
138 static int f_reversesort; /* reverse whatever sort is used */
139 int f_samesort; /* sort time and name in same direction */
140 int f_sectime; /* print full time information */
141 static int f_singlecol; /* use single column output */
142 int f_size; /* list size in short listing */
143 static int f_sizesort;
144 int f_slash; /* similar to f_type, but only for dirs */
145 int f_sortacross; /* sort across rows, not down columns */
146 int f_statustime; /* use time of last mode change */
147 static int f_stream; /* stream the output, separate with commas */
148 int f_thousands; /* show file sizes with thousands separators */
149 char *f_timeformat; /* user-specified time format */
150 static int f_timesort; /* sort by time vice name */
151 int f_type; /* add type character for non-regular files */
152 static int f_whiteout; /* show whiteout entries */
154 int colorflag = COLORFLAG_NEVER; /* passed in colorflag */
155 int f_color; /* add type in color for non-regular files */
156 bool explicitansi; /* Explicit ANSI sequences, no termcap(5) */
157 char *ansi_bgcol; /* ANSI sequence to set background colour */
158 char *ansi_fgcol; /* ANSI sequence to set foreground colour */
159 char *ansi_coloff; /* ANSI sequence to reset colours */
160 char *attrs_off; /* ANSI sequence to turn off attributes */
161 char *enter_bold; /* ANSI sequence to set color to bold mode */
162 char *enter_underline; /* ANSI sequence to enter underline mode */
168 do_color_from_env(void)
174 p = getenv("CLICOLOR");
177 * COLORTERM is the more standard name for this variable. We'll
178 * honor it as long as it's both set and not empty.
180 p = getenv("COLORTERM");
181 if (p != NULL && *p != '\0')
187 (isatty(STDOUT_FILENO) || getenv("CLICOLOR_FORCE")));
195 if (colorflag == COLORFLAG_NEVER)
197 else if (colorflag == COLORFLAG_ALWAYS)
200 return (do_color_from_env());
205 do_color_always(const char *term)
208 return (strcmp(term, "always") == 0 || strcmp(term, "yes") == 0 ||
209 strcmp(term, "force") == 0);
213 do_color_never(const char *term)
216 return (strcmp(term, "never") == 0 || strcmp(term, "no") == 0 ||
217 strcmp(term, "none") == 0);
221 do_color_auto(const char *term)
224 return (strcmp(term, "auto") == 0 || strcmp(term, "tty") == 0 ||
225 strcmp(term, "if-tty") == 0);
230 main(int argc, char *argv[])
232 static char dot[] = ".", *dotav[] = {dot, NULL};
234 int ch, fts_options, notused;
236 const char *errstr = NULL;
238 char termcapbuf[1024]; /* termcap definition buffer */
239 char tcapbuf[512]; /* capability buffer */
240 char *bp = tcapbuf, *term;
243 (void)setlocale(LC_ALL, "");
245 /* Terminal defaults to -Cq, non-terminal defaults to -1. */
246 if (isatty(STDOUT_FILENO)) {
248 if ((p = getenv("COLUMNS")) != NULL && *p != '\0')
249 termwidth = strtonum(p, 0, INT_MAX, &errstr);
250 else if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &win) != -1 &&
252 termwidth = win.ws_col;
256 /* retrieve environment variable, in case of explicit -C */
257 p = getenv("COLUMNS");
259 termwidth = strtonum(p, 0, INT_MAX, &errstr);
265 fts_options = FTS_PHYSICAL;
266 if (getenv("LS_SAMESORT"))
270 * For historical compatibility, we'll use our autodetection if CLICOLOR
274 if (getenv("CLICOLOR"))
275 colorflag = COLORFLAG_AUTO;
277 while ((ch = getopt_long(argc, argv,
278 "+1ABCD:FGHILPRSTUWXZabcdfghiklmnopqrstuwxy,", long_opts,
282 * The -1, -C, -x and -l options all override each other so
283 * shell aliasing works right.
291 f_sortacross = f_longform = f_singlecol = 0;
303 /* The -c, -u, and -U options override each other. */
323 fts_options |= FTS_SEEDOT;
328 /* The -t and -S options override each other. */
337 /* Other flags. Please keep alphabetic. */
347 f_timeformat = optarg;
355 * We both set CLICOLOR here and set colorflag to
356 * COLORFLAG_AUTO, because -G should not force color if
357 * stdout isn't a tty.
359 setenv("CLICOLOR", "", 1);
361 colorflag = COLORFLAG_AUTO;
365 fts_options |= FTS_COMFOLLOW;
372 fts_options &= ~FTS_PHYSICAL;
373 fts_options |= FTS_LOGICAL;
377 fts_options &= ~FTS_COMFOLLOW;
378 fts_options &= ~FTS_LOGICAL;
379 fts_options |= FTS_PHYSICAL;
399 /* The -d option turns off the -R option. */
404 case 'g': /* Compatibility with 4.3BSD. */
452 if (optarg == NULL || do_color_always(optarg))
453 colorflag = COLORFLAG_ALWAYS;
454 else if (do_color_auto(optarg))
455 colorflag = COLORFLAG_AUTO;
456 else if (do_color_never(optarg))
457 colorflag = COLORFLAG_NEVER;
459 errx(2, "unsupported --color value '%s' (must be always, auto, or never)",
463 warnx("color support not compiled in");
473 /* Root is -A automatically unless -I. */
474 if (!f_listdot && getuid() == (uid_t)0 && !f_noautodot)
478 * Enabling of colours is conditional on the environment in conjunction
479 * with the --color and -G arguments, if supplied.
483 if ((term = getenv("TERM")) != NULL &&
484 tgetent(termcapbuf, term) == 1) {
485 ansi_fgcol = tgetstr("AF", &bp);
486 ansi_bgcol = tgetstr("AB", &bp);
487 attrs_off = tgetstr("me", &bp);
488 enter_bold = tgetstr("md", &bp);
489 enter_underline = tgetstr("us", &bp);
491 /* To switch colours off use 'op' if
492 * available, otherwise use 'oc', or
493 * don't do colours at all. */
494 ansi_coloff = tgetstr("op", &bp);
496 ansi_coloff = tgetstr("oc", &bp);
497 if (ansi_fgcol && ansi_bgcol && ansi_coloff)
499 } else if (colorflag == COLORFLAG_ALWAYS) {
501 * If we're *always* doing color but we don't have
502 * a functional TERM supplied, we'll fallback to
503 * outputting raw ANSI sequences.
514 * We can't put tabs and color sequences together:
515 * column number will be incremented incorrectly
516 * for "stty oxtabs" mode.
519 (void)signal(SIGINT, colorquit);
520 (void)signal(SIGQUIT, colorquit);
521 parsecolors(getenv("LSCOLORS"));
526 * If not -F, -i, -l, -s, -S or -t options, don't require stat
527 * information, unless in color mode in which case we do
528 * need this to determine which colors to display.
530 if (!f_inode && !f_longform && !f_size && !f_timesort &&
531 !f_sizesort && !f_type
536 fts_options |= FTS_NOSTAT;
539 * If not -F, -P, -d or -l options, follow any symbolic links listed on
540 * the command line, unless in color mode in which case we need to
541 * distinguish file type for a symbolic link itself and its target.
543 if (!f_nofollow && !f_longform && !f_listdir && (!f_type || f_slash)
548 fts_options |= FTS_COMFOLLOW;
551 * If -W, show whiteout entries
555 fts_options |= FTS_WHITEOUT;
558 /* If -i, -l or -s, figure out block size. */
559 if (f_inode || f_longform || f_size) {
563 (void)getbsize(¬used, &blocksize);
567 /* Select a sort function. */
569 if (!f_timesort && !f_sizesort)
570 sortfcn = revnamecmp;
572 sortfcn = revsizecmp;
573 else if (f_accesstime)
575 else if (f_birthtime)
576 sortfcn = revbirthcmp;
577 else if (f_statustime)
578 sortfcn = revstatcmp;
579 else /* Use modification time. */
582 if (!f_timesort && !f_sizesort)
586 else if (f_accesstime)
588 else if (f_birthtime)
590 else if (f_statustime)
592 else /* Use modification time. */
596 /* Select a print function. */
598 printfcn = printscol;
600 printfcn = printlong;
602 printfcn = printstream;
607 traverse(argc, argv, fts_options);
609 traverse(1, dotav, fts_options);
613 static int output; /* If anything output. */
616 * Traverse() walks the logical directory structure specified by the argv list
617 * in the order specified by the mastercmp() comparison function. During the
618 * traversal it passes linked lists of structures to display() which represent
619 * a superset (may be exact set) of the files to be displayed.
622 traverse(int argc, char *argv[], int options)
629 fts_open(argv, options, f_nosort ? NULL : mastercmp)) == NULL)
633 * We ignore errors from fts_children here since they will be
634 * replicated and signalled on the next call to fts_read() below.
636 chp = fts_children(ftsp, 0);
638 display(NULL, chp, options);
643 * If not recursing down this tree and don't need stat info, just get
646 ch_options = !f_recursive && !f_label &&
647 options & FTS_NOSTAT ? FTS_NAMEONLY : 0;
649 while (errno = 0, (p = fts_read(ftsp)) != NULL)
650 switch (p->fts_info) {
652 warnx("%s: directory causes a cycle", p->fts_name);
656 warnx("%s: %s", p->fts_path, strerror(p->fts_errno));
660 if (p->fts_level != FTS_ROOTLEVEL &&
661 p->fts_name[0] == '.' && !f_listdot)
665 * If already output something, put out a newline as
666 * a separator. If multiple arguments, precede each
667 * directory with its name.
671 (void)printname(p->fts_path);
673 } else if (argc > 1) {
674 (void)printname(p->fts_path);
678 chp = fts_children(ftsp, ch_options);
679 display(p, chp, options);
681 if (!f_recursive && chp != NULL)
682 (void)fts_set(ftsp, p, FTS_SKIP);
692 * Display() takes a linked list of FTSENT structures and passes the list
693 * along with any other necessary information to the print function. P
694 * points to the parent directory of the display list.
697 display(const FTSENT *p, FTSENT *list, int options)
706 u_long btotal, labelstrlen, maxlen, maxnlink;
712 size_t flen, ulen, glen;
714 int entries, needstats;
715 const char *user, *group;
716 char *flags, *labelstr = NULL;
717 char ngroup[STRBUF_SIZEOF(uid_t) + 1];
718 char nuser[STRBUF_SIZEOF(gid_t) + 1];
722 needstats = f_inode || f_longform || f_size;
726 #define LS_COLWIDTHS_FIELDS 9
727 initmax = getenv("LS_COLWIDTHS");
729 for (i = 0 ; i < LS_COLWIDTHS_FIELDS; i++)
732 if (initmax != NULL) {
735 for (i = 0; i < LS_COLWIDTHS_FIELDS && *initmax != '\0'; i++) {
736 if (*initmax == ':') {
739 width[i] = strtoul(initmax, &endp, 10);
741 while (isspace(*initmax))
748 if (i < LS_COLWIDTHS_FIELDS)
755 /* Fields match -lios order. New ones should be added at the end. */
764 maxlabelstr = width[8];
774 for (cur = list, entries = 0; cur; cur = cur->fts_link) {
775 if (cur->fts_info == FTS_ERR || cur->fts_info == FTS_NS) {
777 cur->fts_name, strerror(cur->fts_errno));
778 cur->fts_number = NO_PRINT;
783 * P is NULL if list is the argv list, to which different rules
787 /* Directories will be displayed later. */
788 if (cur->fts_info == FTS_D && !f_listdir) {
789 cur->fts_number = NO_PRINT;
793 /* Only display dot file if -a/-A set. */
794 if (cur->fts_name[0] == '.' && !f_listdot) {
795 cur->fts_number = NO_PRINT;
799 if (cur->fts_namelen > maxlen)
800 maxlen = cur->fts_namelen;
801 if (f_octal || f_octal_escape) {
802 u_long t = len_octal(cur->fts_name, cur->fts_namelen);
809 if (sp->st_blocks > maxblock)
810 maxblock = sp->st_blocks;
811 if (sp->st_ino > maxinode)
812 maxinode = sp->st_ino;
813 if (sp->st_nlink > maxnlink)
814 maxnlink = sp->st_nlink;
815 if (sp->st_size > maxsize)
816 maxsize = sp->st_size;
818 btotal += sp->st_blocks;
821 (void)snprintf(nuser, sizeof(nuser),
823 (void)snprintf(ngroup, sizeof(ngroup),
828 user = user_from_uid(sp->st_uid, 0);
830 * user_from_uid(..., 0) only returns
831 * NULL in OOM conditions. We could
832 * format the uid here, but (1) in
833 * general ls(1) exits on OOM, and (2)
834 * there is another allocation/exit
835 * path directly below, which will
836 * likely exit anyway.
839 err(1, "user_from_uid");
840 group = group_from_gid(sp->st_gid, 0);
843 err(1, "group_from_gid");
845 if ((ulen = strlen(user)) > maxuser)
847 if ((glen = strlen(group)) > maxgroup)
850 flags = fflagstostr(sp->st_flags);
851 if (flags != NULL && *flags == '\0') {
856 err(1, "fflagstostr");
857 flen = strlen(flags);
858 if (flen > (size_t)maxflags)
864 char name[PATH_MAX + 1];
868 error = mac_prepare_file_label(&label);
870 warn("MAC label for %s/%s",
871 cur->fts_parent->fts_path,
876 if (cur->fts_level == FTS_ROOTLEVEL)
877 snprintf(name, sizeof(name),
878 "%s", cur->fts_name);
880 snprintf(name, sizeof(name),
881 "%s/%s", cur->fts_parent->
882 fts_accpath, cur->fts_name);
884 if (options & FTS_LOGICAL)
885 error = mac_get_file(name,
888 error = mac_get_link(name,
891 warn("MAC label for %s/%s",
892 cur->fts_parent->fts_path,
898 error = mac_to_text(label,
901 warn("MAC label for %s/%s",
902 cur->fts_parent->fts_path,
909 if (labelstr == NULL)
910 labelstr = strdup("-");
911 labelstrlen = strlen(labelstr);
912 if (labelstrlen > maxlabelstr)
913 maxlabelstr = labelstrlen;
917 if ((np = malloc(sizeof(NAMES) + labelstrlen +
918 ulen + glen + flen + 4)) == NULL)
921 np->user = &np->data[0];
922 (void)strcpy(np->user, user);
923 np->group = &np->data[ulen + 1];
924 (void)strcpy(np->group, group);
926 if (S_ISCHR(sp->st_mode) ||
927 S_ISBLK(sp->st_mode)) {
928 sizelen = snprintf(NULL, 0,
929 "%#jx", (uintmax_t)sp->st_rdev);
930 if (d.s_size < sizelen)
935 np->flags = &np->data[ulen + glen + 2];
936 (void)strcpy(np->flags, flags);
940 np->label = &np->data[ulen + glen + 2
941 + (f_flags ? flen + 1 : 0)];
942 (void)strcpy(np->label, labelstr);
945 cur->fts_pointer = np;
952 * If there are no entries to display, we normally stop right
953 * here. However, we must continue if we have to display the
954 * total block count. In this case, we display the total only
955 * on the second (p != NULL) pass.
957 if (!entries && (!(f_longform || f_size) || p == NULL))
965 d.s_block = snprintf(NULL, 0, "%lu", howmany(maxblock, blocksize));
966 d.s_flags = maxflags;
967 d.s_label = maxlabelstr;
968 d.s_group = maxgroup;
969 d.s_inode = snprintf(NULL, 0, "%ju", maxinode);
970 d.s_nlink = snprintf(NULL, 0, "%lu", maxnlink);
971 sizelen = f_humanval ? HUMANVALSTR_LEN :
972 snprintf(NULL, 0, "%ju", maxsize);
973 if (d.s_size < sizelen)
977 if (f_thousands) /* make space for commas */
978 d.s_size += (d.s_size - 1) / 3;
983 for (cur = list; cur; cur = cur->fts_link)
984 free(cur->fts_pointer);
988 * Ordering for mastercmp:
989 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories
990 * as larger than directories. Within either group, use the sort function.
991 * All other levels use the sort function. Error entries remain unsorted.
994 mastercmp(const FTSENT * const *a, const FTSENT * const *b)
998 a_info = (*a)->fts_info;
999 if (a_info == FTS_ERR)
1001 b_info = (*b)->fts_info;
1002 if (b_info == FTS_ERR)
1005 if (a_info == FTS_NS || b_info == FTS_NS)
1006 return (namecmp(*a, *b));
1008 if (a_info != b_info &&
1009 (*a)->fts_level == FTS_ROOTLEVEL && !f_listdir) {
1010 if (a_info == FTS_D)
1012 if (b_info == FTS_D)
1015 return (sortfcn(*a, *b));