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 static int f_verssort; /* sort names using strverscmp(3) rather than strcoll(3) */
140 int f_samesort; /* sort time and name in same direction */
141 int f_sectime; /* print full time information */
142 static int f_singlecol; /* use single column output */
143 int f_size; /* list size in short listing */
144 static int f_sizesort;
145 int f_slash; /* similar to f_type, but only for dirs */
146 int f_sortacross; /* sort across rows, not down columns */
147 int f_statustime; /* use time of last mode change */
148 static int f_stream; /* stream the output, separate with commas */
149 int f_thousands; /* show file sizes with thousands separators */
150 char *f_timeformat; /* user-specified time format */
151 static int f_timesort; /* sort by time vice name */
152 int f_type; /* add type character for non-regular files */
153 static int f_whiteout; /* show whiteout entries */
155 int colorflag = COLORFLAG_NEVER; /* passed in colorflag */
156 int f_color; /* add type in color for non-regular files */
157 bool explicitansi; /* Explicit ANSI sequences, no termcap(5) */
158 char *ansi_bgcol; /* ANSI sequence to set background colour */
159 char *ansi_fgcol; /* ANSI sequence to set foreground colour */
160 char *ansi_coloff; /* ANSI sequence to reset colours */
161 char *attrs_off; /* ANSI sequence to turn off attributes */
162 char *enter_bold; /* ANSI sequence to set color to bold mode */
163 char *enter_underline; /* ANSI sequence to enter underline mode */
169 do_color_from_env(void)
175 p = getenv("CLICOLOR");
178 * COLORTERM is the more standard name for this variable. We'll
179 * honor it as long as it's both set and not empty.
181 p = getenv("COLORTERM");
182 if (p != NULL && *p != '\0')
188 (isatty(STDOUT_FILENO) || getenv("CLICOLOR_FORCE")));
196 if (colorflag == COLORFLAG_NEVER)
198 else if (colorflag == COLORFLAG_ALWAYS)
201 return (do_color_from_env());
206 do_color_always(const char *term)
209 return (strcmp(term, "always") == 0 || strcmp(term, "yes") == 0 ||
210 strcmp(term, "force") == 0);
214 do_color_never(const char *term)
217 return (strcmp(term, "never") == 0 || strcmp(term, "no") == 0 ||
218 strcmp(term, "none") == 0);
222 do_color_auto(const char *term)
225 return (strcmp(term, "auto") == 0 || strcmp(term, "tty") == 0 ||
226 strcmp(term, "if-tty") == 0);
231 main(int argc, char *argv[])
233 static char dot[] = ".", *dotav[] = {dot, NULL};
235 int ch, fts_options, notused;
237 const char *errstr = NULL;
239 char termcapbuf[1024]; /* termcap definition buffer */
240 char tcapbuf[512]; /* capability buffer */
241 char *bp = tcapbuf, *term;
244 (void)setlocale(LC_ALL, "");
246 /* Terminal defaults to -Cq, non-terminal defaults to -1. */
247 if (isatty(STDOUT_FILENO)) {
249 if ((p = getenv("COLUMNS")) != NULL && *p != '\0')
250 termwidth = strtonum(p, 0, INT_MAX, &errstr);
251 else if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &win) != -1 &&
253 termwidth = win.ws_col;
257 /* retrieve environment variable, in case of explicit -C */
258 p = getenv("COLUMNS");
260 termwidth = strtonum(p, 0, INT_MAX, &errstr);
266 fts_options = FTS_PHYSICAL;
267 if (getenv("LS_SAMESORT"))
271 * For historical compatibility, we'll use our autodetection if CLICOLOR
275 if (getenv("CLICOLOR"))
276 colorflag = COLORFLAG_AUTO;
278 while ((ch = getopt_long(argc, argv,
279 "+1ABCD:FGHILPRSTUWXZabcdfghiklmnopqrstuvwxy,", long_opts,
283 * The -1, -C, -x and -l options all override each other so
284 * shell aliasing works right.
292 f_sortacross = f_longform = f_singlecol = 0;
304 /* The -c, -u, and -U options override each other. */
324 fts_options |= FTS_SEEDOT;
329 /* The -t and -S options override each other. */
338 /* Other flags. Please keep alphabetic. */
348 f_timeformat = optarg;
356 * We both set CLICOLOR here and set colorflag to
357 * COLORFLAG_AUTO, because -G should not force color if
358 * stdout isn't a tty.
360 setenv("CLICOLOR", "", 1);
362 colorflag = COLORFLAG_AUTO;
366 fts_options |= FTS_COMFOLLOW;
373 fts_options &= ~FTS_PHYSICAL;
374 fts_options |= FTS_LOGICAL;
378 fts_options &= ~FTS_COMFOLLOW;
379 fts_options &= ~FTS_LOGICAL;
380 fts_options |= FTS_PHYSICAL;
400 /* The -d option turns off the -R option. */
405 case 'g': /* Compatibility with 4.3BSD. */
456 if (optarg == NULL || do_color_always(optarg))
457 colorflag = COLORFLAG_ALWAYS;
458 else if (do_color_auto(optarg))
459 colorflag = COLORFLAG_AUTO;
460 else if (do_color_never(optarg))
461 colorflag = COLORFLAG_NEVER;
463 errx(2, "unsupported --color value '%s' (must be always, auto, or never)",
467 warnx("color support not compiled in");
477 /* Root is -A automatically unless -I. */
478 if (!f_listdot && getuid() == (uid_t)0 && !f_noautodot)
482 * Enabling of colours is conditional on the environment in conjunction
483 * with the --color and -G arguments, if supplied.
487 if ((term = getenv("TERM")) != NULL &&
488 tgetent(termcapbuf, term) == 1) {
489 ansi_fgcol = tgetstr("AF", &bp);
490 ansi_bgcol = tgetstr("AB", &bp);
491 attrs_off = tgetstr("me", &bp);
492 enter_bold = tgetstr("md", &bp);
493 enter_underline = tgetstr("us", &bp);
495 /* To switch colours off use 'op' if
496 * available, otherwise use 'oc', or
497 * don't do colours at all. */
498 ansi_coloff = tgetstr("op", &bp);
500 ansi_coloff = tgetstr("oc", &bp);
501 if (ansi_fgcol && ansi_bgcol && ansi_coloff)
503 } else if (colorflag == COLORFLAG_ALWAYS) {
505 * If we're *always* doing color but we don't have
506 * a functional TERM supplied, we'll fallback to
507 * outputting raw ANSI sequences.
518 * We can't put tabs and color sequences together:
519 * column number will be incremented incorrectly
520 * for "stty oxtabs" mode.
523 (void)signal(SIGINT, colorquit);
524 (void)signal(SIGQUIT, colorquit);
525 parsecolors(getenv("LSCOLORS"));
530 * If not -F, -i, -l, -s, -S or -t options, don't require stat
531 * information, unless in color mode in which case we do
532 * need this to determine which colors to display.
534 if (!f_inode && !f_longform && !f_size && !f_timesort &&
535 !f_sizesort && !f_type
540 fts_options |= FTS_NOSTAT;
543 * If not -F, -P, -d or -l options, follow any symbolic links listed on
544 * the command line, unless in color mode in which case we need to
545 * distinguish file type for a symbolic link itself and its target.
547 if (!f_nofollow && !f_longform && !f_listdir && (!f_type || f_slash)
552 fts_options |= FTS_COMFOLLOW;
555 * If -W, show whiteout entries
559 fts_options |= FTS_WHITEOUT;
562 /* If -i, -l or -s, figure out block size. */
563 if (f_inode || f_longform || f_size) {
567 (void)getbsize(¬used, &blocksize);
571 /* Select a sort function. */
574 sortfcn = revsizecmp;
576 sortfcn = revverscmp;
577 else if (!f_timesort)
578 sortfcn = revnamecmp;
579 else if (f_accesstime)
581 else if (f_birthtime)
582 sortfcn = revbirthcmp;
583 else if (f_statustime)
584 sortfcn = revstatcmp;
585 else /* Use modification time. */
592 else if (!f_timesort)
594 else if (f_accesstime)
596 else if (f_birthtime)
598 else if (f_statustime)
600 else /* Use modification time. */
604 /* Select a print function. */
606 printfcn = printscol;
608 printfcn = printlong;
610 printfcn = printstream;
615 traverse(argc, argv, fts_options);
617 traverse(1, dotav, fts_options);
621 static int output; /* If anything output. */
624 * Traverse() walks the logical directory structure specified by the argv list
625 * in the order specified by the mastercmp() comparison function. During the
626 * traversal it passes linked lists of structures to display() which represent
627 * a superset (may be exact set) of the files to be displayed.
630 traverse(int argc, char *argv[], int options)
637 fts_open(argv, options, f_nosort ? NULL : mastercmp)) == NULL)
641 * We ignore errors from fts_children here since they will be
642 * replicated and signalled on the next call to fts_read() below.
644 chp = fts_children(ftsp, 0);
646 display(NULL, chp, options);
651 * If not recursing down this tree and don't need stat info, just get
654 ch_options = !f_recursive && !f_label &&
655 options & FTS_NOSTAT ? FTS_NAMEONLY : 0;
657 while (errno = 0, (p = fts_read(ftsp)) != NULL)
658 switch (p->fts_info) {
660 warnx("%s: directory causes a cycle", p->fts_name);
664 warnx("%s: %s", p->fts_path, strerror(p->fts_errno));
668 if (p->fts_level != FTS_ROOTLEVEL &&
669 p->fts_name[0] == '.' && !f_listdot)
673 * If already output something, put out a newline as
674 * a separator. If multiple arguments, precede each
675 * directory with its name.
679 (void)printname(p->fts_path);
681 } else if (argc > 1) {
682 (void)printname(p->fts_path);
686 chp = fts_children(ftsp, ch_options);
687 display(p, chp, options);
689 if (!f_recursive && chp != NULL)
690 (void)fts_set(ftsp, p, FTS_SKIP);
700 * Display() takes a linked list of FTSENT structures and passes the list
701 * along with any other necessary information to the print function. P
702 * points to the parent directory of the display list.
705 display(const FTSENT *p, FTSENT *list, int options)
714 u_long btotal, labelstrlen, maxlen, maxnlink;
720 size_t flen, ulen, glen;
722 int entries, needstats;
723 const char *user, *group;
724 char *flags, *labelstr = NULL;
725 char ngroup[STRBUF_SIZEOF(uid_t) + 1];
726 char nuser[STRBUF_SIZEOF(gid_t) + 1];
730 needstats = f_inode || f_longform || f_size;
734 #define LS_COLWIDTHS_FIELDS 9
735 initmax = getenv("LS_COLWIDTHS");
737 for (i = 0 ; i < LS_COLWIDTHS_FIELDS; i++)
740 if (initmax != NULL) {
743 for (i = 0; i < LS_COLWIDTHS_FIELDS && *initmax != '\0'; i++) {
744 if (*initmax == ':') {
747 width[i] = strtoul(initmax, &endp, 10);
749 while (isspace(*initmax))
756 if (i < LS_COLWIDTHS_FIELDS)
763 /* Fields match -lios order. New ones should be added at the end. */
772 maxlabelstr = width[8];
782 for (cur = list, entries = 0; cur; cur = cur->fts_link) {
783 if (cur->fts_info == FTS_ERR || cur->fts_info == FTS_NS) {
785 cur->fts_name, strerror(cur->fts_errno));
786 cur->fts_number = NO_PRINT;
791 * P is NULL if list is the argv list, to which different rules
795 /* Directories will be displayed later. */
796 if (cur->fts_info == FTS_D && !f_listdir) {
797 cur->fts_number = NO_PRINT;
801 /* Only display dot file if -a/-A set. */
802 if (cur->fts_name[0] == '.' && !f_listdot) {
803 cur->fts_number = NO_PRINT;
807 if (cur->fts_namelen > maxlen)
808 maxlen = cur->fts_namelen;
809 if (f_octal || f_octal_escape) {
810 u_long t = len_octal(cur->fts_name, cur->fts_namelen);
817 if (sp->st_blocks > maxblock)
818 maxblock = sp->st_blocks;
819 if (sp->st_ino > maxinode)
820 maxinode = sp->st_ino;
821 if (sp->st_nlink > maxnlink)
822 maxnlink = sp->st_nlink;
823 if (sp->st_size > maxsize)
824 maxsize = sp->st_size;
826 btotal += sp->st_blocks;
829 (void)snprintf(nuser, sizeof(nuser),
831 (void)snprintf(ngroup, sizeof(ngroup),
836 user = user_from_uid(sp->st_uid, 0);
838 * user_from_uid(..., 0) only returns
839 * NULL in OOM conditions. We could
840 * format the uid here, but (1) in
841 * general ls(1) exits on OOM, and (2)
842 * there is another allocation/exit
843 * path directly below, which will
844 * likely exit anyway.
847 err(1, "user_from_uid");
848 group = group_from_gid(sp->st_gid, 0);
851 err(1, "group_from_gid");
853 if ((ulen = strlen(user)) > maxuser)
855 if ((glen = strlen(group)) > maxgroup)
858 flags = fflagstostr(sp->st_flags);
859 if (flags != NULL && *flags == '\0') {
864 err(1, "fflagstostr");
865 flen = strlen(flags);
866 if (flen > (size_t)maxflags)
872 char name[PATH_MAX + 1];
876 error = mac_prepare_file_label(&label);
878 warn("MAC label for %s/%s",
879 cur->fts_parent->fts_path,
884 if (cur->fts_level == FTS_ROOTLEVEL)
885 snprintf(name, sizeof(name),
886 "%s", cur->fts_name);
888 snprintf(name, sizeof(name),
889 "%s/%s", cur->fts_parent->
890 fts_accpath, cur->fts_name);
892 if (options & FTS_LOGICAL)
893 error = mac_get_file(name,
896 error = mac_get_link(name,
899 warn("MAC label for %s/%s",
900 cur->fts_parent->fts_path,
906 error = mac_to_text(label,
909 warn("MAC label for %s/%s",
910 cur->fts_parent->fts_path,
917 if (labelstr == NULL)
918 labelstr = strdup("-");
919 labelstrlen = strlen(labelstr);
920 if (labelstrlen > maxlabelstr)
921 maxlabelstr = labelstrlen;
925 if ((np = malloc(sizeof(NAMES) + labelstrlen +
926 ulen + glen + flen + 4)) == NULL)
929 np->user = &np->data[0];
930 (void)strcpy(np->user, user);
931 np->group = &np->data[ulen + 1];
932 (void)strcpy(np->group, group);
934 if (S_ISCHR(sp->st_mode) ||
935 S_ISBLK(sp->st_mode)) {
936 sizelen = snprintf(NULL, 0,
937 "%#jx", (uintmax_t)sp->st_rdev);
938 if (d.s_size < sizelen)
943 np->flags = &np->data[ulen + glen + 2];
944 (void)strcpy(np->flags, flags);
948 np->label = &np->data[ulen + glen + 2
949 + (f_flags ? flen + 1 : 0)];
950 (void)strcpy(np->label, labelstr);
953 cur->fts_pointer = np;
960 * If there are no entries to display, we normally stop right
961 * here. However, we must continue if we have to display the
962 * total block count. In this case, we display the total only
963 * on the second (p != NULL) pass.
965 if (!entries && (!(f_longform || f_size) || p == NULL))
973 d.s_block = snprintf(NULL, 0, "%lu", howmany(maxblock, blocksize));
974 d.s_flags = maxflags;
975 d.s_label = maxlabelstr;
976 d.s_group = maxgroup;
977 d.s_inode = snprintf(NULL, 0, "%ju", maxinode);
978 d.s_nlink = snprintf(NULL, 0, "%lu", maxnlink);
979 sizelen = f_humanval ? HUMANVALSTR_LEN :
980 snprintf(NULL, 0, "%ju", maxsize);
981 if (d.s_size < sizelen)
985 if (f_thousands) /* make space for commas */
986 d.s_size += (d.s_size - 1) / 3;
991 for (cur = list; cur; cur = cur->fts_link)
992 free(cur->fts_pointer);
996 * Ordering for mastercmp:
997 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories
998 * as larger than directories. Within either group, use the sort function.
999 * All other levels use the sort function. Error entries remain unsorted.
1002 mastercmp(const FTSENT * const *a, const FTSENT * const *b)
1006 a_info = (*a)->fts_info;
1007 if (a_info == FTS_ERR)
1009 b_info = (*b)->fts_info;
1010 if (b_info == FTS_ERR)
1013 if (a_info == FTS_NS || b_info == FTS_NS)
1014 return (namecmp(*a, *b));
1016 if (a_info != b_info &&
1017 (*a)->fts_level == FTS_ROOTLEVEL && !f_listdir) {
1018 if (a_info == FTS_D)
1020 if (b_info == FTS_D)
1023 return (sortfcn(*a, *b));