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>
76 * Upward approximation of the maximum number of characters needed to
77 * represent a value of integral type t as a string, excluding the
78 * NUL terminator, with provision for a sign.
80 #define STRBUF_SIZEOF(t) (1 + CHAR_BIT * sizeof(t) / 3 + 1)
83 * MAKENINES(n) turns n into (10**n)-1. This is useful for converting a width
84 * into a number that wide in decimal.
85 * XXX: Overflows are not considered.
87 #define MAKENINES(n) \
91 /* Use a loop as all values of n are small. */ \
92 for (i = 1; n > 0; i *= 10) \
97 static void display(const FTSENT *, FTSENT *, int);
98 static int mastercmp(const FTSENT * const *, const FTSENT * const *);
99 static void traverse(int, char **, int);
101 static void (*printfcn)(const DISPLAY *);
102 static int (*sortfcn)(const FTSENT *, const FTSENT *);
104 long blocksize; /* block size units */
105 int termwidth = 80; /* default terminal width */
108 int f_accesstime; /* use time of last access */
109 int f_birthtime; /* use time of birth */
110 int f_flags; /* show flags associated with a file */
111 int f_humanval; /* show human-readable file sizes */
112 int f_inode; /* print inode */
113 static int f_kblocks; /* print size in kilobytes */
114 int f_label; /* show MAC label */
115 static int f_listdir; /* list actual directory, not contents */
116 static int f_listdot; /* list files beginning with . */
117 int f_longform; /* long listing format */
118 static int f_noautodot; /* do not automatically enable -A for root */
119 static int f_nofollow; /* don't follow symbolic link arguments */
120 int f_nonprint; /* show unprintables as ? */
121 static int f_nosort; /* don't sort output */
122 int f_notabs; /* don't use tab-separated multi-col output */
123 static int f_numericonly; /* don't convert uid/gid to name */
124 int f_octal; /* show unprintables as \xxx */
125 int f_octal_escape; /* like f_octal but use C escapes if possible */
126 static int f_recursive; /* ls subdirectories also */
127 static int f_reversesort; /* reverse whatever sort is used */
128 int f_samesort; /* sort time and name in same direction */
129 int f_sectime; /* print full time information */
130 static int f_singlecol; /* use single column output */
131 int f_size; /* list size in short listing */
132 static int f_sizesort;
133 int f_slash; /* similar to f_type, but only for dirs */
134 int f_sortacross; /* sort across rows, not down columns */
135 int f_statustime; /* use time of last mode change */
136 static int f_stream; /* stream the output, separate with commas */
137 int f_thousands; /* show file sizes with thousands separators */
138 char *f_timeformat; /* user-specified time format */
139 static int f_timesort; /* sort by time vice name */
140 int f_type; /* add type character for non-regular files */
141 static int f_whiteout; /* show whiteout entries */
144 int f_color; /* add type in color for non-regular files */
146 char *ansi_bgcol; /* ANSI sequence to set background colour */
147 char *ansi_fgcol; /* ANSI sequence to set foreground colour */
148 char *ansi_coloff; /* ANSI sequence to reset colours */
149 char *attrs_off; /* ANSI sequence to turn off attributes */
150 char *enter_bold; /* ANSI sequence to set color to bold mode */
156 main(int argc, char *argv[])
158 static char dot[] = ".", *dotav[] = {dot, NULL};
160 int ch, fts_options, notused;
162 const char *errstr = NULL;
164 char termcapbuf[1024]; /* termcap definition buffer */
165 char tcapbuf[512]; /* capability buffer */
169 (void)setlocale(LC_ALL, "");
171 /* Terminal defaults to -Cq, non-terminal defaults to -1. */
172 if (isatty(STDOUT_FILENO)) {
174 if ((p = getenv("COLUMNS")) != NULL && *p != '\0')
175 termwidth = strtonum(p, 0, INT_MAX, &errstr);
176 else if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &win) != -1 &&
178 termwidth = win.ws_col;
182 /* retrieve environment variable, in case of explicit -C */
183 p = getenv("COLUMNS");
185 termwidth = strtonum(p, 0, INT_MAX, &errstr);
191 fts_options = FTS_PHYSICAL;
192 if (getenv("LS_SAMESORT"))
194 while ((ch = getopt(argc, argv,
195 "1ABCD:FGHILPRSTUWXZabcdfghiklmnopqrstuwxy,")) != -1) {
198 * The -1, -C, -x and -l options all override each other so
199 * shell aliasing works right.
207 f_sortacross = f_longform = f_singlecol = 0;
219 /* The -c, -u, and -U options override each other. */
239 fts_options |= FTS_SEEDOT;
244 /* The -t and -S options override each other. */
253 /* Other flags. Please keep alphabetic. */
263 f_timeformat = optarg;
270 setenv("CLICOLOR", "", 1);
273 fts_options |= FTS_COMFOLLOW;
280 fts_options &= ~FTS_PHYSICAL;
281 fts_options |= FTS_LOGICAL;
285 fts_options &= ~FTS_COMFOLLOW;
286 fts_options &= ~FTS_LOGICAL;
287 fts_options |= FTS_PHYSICAL;
307 /* The -d option turns off the -R option. */
312 case 'g': /* Compatibility with 4.3BSD. */
366 /* Root is -A automatically unless -I. */
367 if (!f_listdot && getuid() == (uid_t)0 && !f_noautodot)
370 /* Enabling of colours is conditional on the environment. */
371 if (getenv("CLICOLOR") &&
372 (isatty(STDOUT_FILENO) || getenv("CLICOLOR_FORCE")))
374 if (tgetent(termcapbuf, getenv("TERM")) == 1) {
375 ansi_fgcol = tgetstr("AF", &bp);
376 ansi_bgcol = tgetstr("AB", &bp);
377 attrs_off = tgetstr("me", &bp);
378 enter_bold = tgetstr("md", &bp);
380 /* To switch colours off use 'op' if
381 * available, otherwise use 'oc', or
382 * don't do colours at all. */
383 ansi_coloff = tgetstr("op", &bp);
385 ansi_coloff = tgetstr("oc", &bp);
386 if (ansi_fgcol && ansi_bgcol && ansi_coloff)
390 warnx("color support not compiled in");
396 * We can't put tabs and color sequences together:
397 * column number will be incremented incorrectly
398 * for "stty oxtabs" mode.
401 (void)signal(SIGINT, colorquit);
402 (void)signal(SIGQUIT, colorquit);
403 parsecolors(getenv("LSCOLORS"));
408 * If not -F, -i, -l, -s, -S or -t options, don't require stat
409 * information, unless in color mode in which case we do
410 * need this to determine which colors to display.
412 if (!f_inode && !f_longform && !f_size && !f_timesort &&
413 !f_sizesort && !f_type
418 fts_options |= FTS_NOSTAT;
421 * If not -F, -P, -d or -l options, follow any symbolic links listed on
422 * the command line, unless in color mode in which case we need to
423 * distinguish file type for a symbolic link itself and its target.
425 if (!f_nofollow && !f_longform && !f_listdir && (!f_type || f_slash)
430 fts_options |= FTS_COMFOLLOW;
433 * If -W, show whiteout entries
437 fts_options |= FTS_WHITEOUT;
440 /* If -i, -l or -s, figure out block size. */
441 if (f_inode || f_longform || f_size) {
445 (void)getbsize(¬used, &blocksize);
449 /* Select a sort function. */
451 if (!f_timesort && !f_sizesort)
452 sortfcn = revnamecmp;
454 sortfcn = revsizecmp;
455 else if (f_accesstime)
457 else if (f_birthtime)
458 sortfcn = revbirthcmp;
459 else if (f_statustime)
460 sortfcn = revstatcmp;
461 else /* Use modification time. */
464 if (!f_timesort && !f_sizesort)
468 else if (f_accesstime)
470 else if (f_birthtime)
472 else if (f_statustime)
474 else /* Use modification time. */
478 /* Select a print function. */
480 printfcn = printscol;
482 printfcn = printlong;
484 printfcn = printstream;
489 traverse(argc, argv, fts_options);
491 traverse(1, dotav, fts_options);
495 static int output; /* If anything output. */
498 * Traverse() walks the logical directory structure specified by the argv list
499 * in the order specified by the mastercmp() comparison function. During the
500 * traversal it passes linked lists of structures to display() which represent
501 * a superset (may be exact set) of the files to be displayed.
504 traverse(int argc, char *argv[], int options)
511 fts_open(argv, options, f_nosort ? NULL : mastercmp)) == NULL)
515 * We ignore errors from fts_children here since they will be
516 * replicated and signalled on the next call to fts_read() below.
518 chp = fts_children(ftsp, 0);
520 display(NULL, chp, options);
525 * If not recursing down this tree and don't need stat info, just get
528 ch_options = !f_recursive && !f_label &&
529 options & FTS_NOSTAT ? FTS_NAMEONLY : 0;
531 while ((p = fts_read(ftsp)) != NULL)
532 switch (p->fts_info) {
534 warnx("%s: directory causes a cycle", p->fts_name);
538 warnx("%s: %s", p->fts_path, strerror(p->fts_errno));
542 if (p->fts_level != FTS_ROOTLEVEL &&
543 p->fts_name[0] == '.' && !f_listdot)
547 * If already output something, put out a newline as
548 * a separator. If multiple arguments, precede each
549 * directory with its name.
553 (void)printname(p->fts_path);
555 } else if (argc > 1) {
556 (void)printname(p->fts_path);
560 chp = fts_children(ftsp, ch_options);
561 display(p, chp, options);
563 if (!f_recursive && chp != NULL)
564 (void)fts_set(ftsp, p, FTS_SKIP);
574 * Display() takes a linked list of FTSENT structures and passes the list
575 * along with any other necessary information to the print function. P
576 * points to the parent directory of the display list.
579 display(const FTSENT *p, FTSENT *list, int options)
588 u_long btotal, labelstrlen, maxlen, maxnlink;
594 size_t flen, ulen, glen;
596 int entries, needstats;
597 const char *user, *group;
598 char *flags, *labelstr = NULL;
599 char ngroup[STRBUF_SIZEOF(uid_t) + 1];
600 char nuser[STRBUF_SIZEOF(gid_t) + 1];
602 needstats = f_inode || f_longform || f_size;
605 initmax = getenv("LS_COLWIDTHS");
606 /* Fields match -lios order. New ones should be added at the end. */
607 maxlabelstr = maxblock = maxlen = maxnlink = 0;
608 maxuser = maxgroup = maxflags = maxsize = 0;
610 if (initmax != NULL && *initmax != '\0') {
611 char *initmax2, *jinitmax;
614 /* Fill-in "::" as "0:0:0" for the sake of scanf. */
615 jinitmax = malloc(strlen(initmax) * 2 + 2);
616 if (jinitmax == NULL)
620 strcpy(initmax2, "0:"), initmax2 += 2;
622 *initmax2++ = *initmax, *initmax2 = '\0';
623 for (initmax++; *initmax != '\0'; initmax++) {
624 if (initmax[-1] == ':' && initmax[0] == ':') {
626 *initmax2++ = initmax[0];
629 *initmax2++ = initmax[0];
633 if (initmax2[-1] == ':')
634 strcpy(initmax2, "0");
636 ninitmax = sscanf(jinitmax,
637 " %ju : %ld : %lu : %u : %u : %i : %jd : %lu : %lu ",
638 &maxinode, &maxblock, &maxnlink, &maxuser,
639 &maxgroup, &maxflags, &maxsize, &maxlen, &maxlabelstr);
686 for (cur = list, entries = 0; cur; cur = cur->fts_link) {
687 if (cur->fts_info == FTS_ERR || cur->fts_info == FTS_NS) {
689 cur->fts_name, strerror(cur->fts_errno));
690 cur->fts_number = NO_PRINT;
695 * P is NULL if list is the argv list, to which different rules
699 /* Directories will be displayed later. */
700 if (cur->fts_info == FTS_D && !f_listdir) {
701 cur->fts_number = NO_PRINT;
705 /* Only display dot file if -a/-A set. */
706 if (cur->fts_name[0] == '.' && !f_listdot) {
707 cur->fts_number = NO_PRINT;
711 if (cur->fts_namelen > maxlen)
712 maxlen = cur->fts_namelen;
713 if (f_octal || f_octal_escape) {
714 u_long t = len_octal(cur->fts_name, cur->fts_namelen);
721 if (sp->st_blocks > maxblock)
722 maxblock = sp->st_blocks;
723 if (sp->st_ino > maxinode)
724 maxinode = sp->st_ino;
725 if (sp->st_nlink > maxnlink)
726 maxnlink = sp->st_nlink;
727 if (sp->st_size > maxsize)
728 maxsize = sp->st_size;
730 btotal += sp->st_blocks;
733 (void)snprintf(nuser, sizeof(nuser),
735 (void)snprintf(ngroup, sizeof(ngroup),
740 user = user_from_uid(sp->st_uid, 0);
741 group = group_from_gid(sp->st_gid, 0);
743 if ((ulen = strlen(user)) > maxuser)
745 if ((glen = strlen(group)) > maxgroup)
748 flags = fflagstostr(sp->st_flags);
749 if (flags != NULL && *flags == '\0') {
754 err(1, "fflagstostr");
755 flen = strlen(flags);
756 if (flen > (size_t)maxflags)
762 char name[PATH_MAX + 1];
766 error = mac_prepare_file_label(&label);
768 warn("MAC label for %s/%s",
769 cur->fts_parent->fts_path,
774 if (cur->fts_level == FTS_ROOTLEVEL)
775 snprintf(name, sizeof(name),
776 "%s", cur->fts_name);
778 snprintf(name, sizeof(name),
779 "%s/%s", cur->fts_parent->
780 fts_accpath, cur->fts_name);
782 if (options & FTS_LOGICAL)
783 error = mac_get_file(name,
786 error = mac_get_link(name,
789 warn("MAC label for %s/%s",
790 cur->fts_parent->fts_path,
796 error = mac_to_text(label,
799 warn("MAC label for %s/%s",
800 cur->fts_parent->fts_path,
807 if (labelstr == NULL)
808 labelstr = strdup("-");
809 labelstrlen = strlen(labelstr);
810 if (labelstrlen > maxlabelstr)
811 maxlabelstr = labelstrlen;
815 if ((np = malloc(sizeof(NAMES) + labelstrlen +
816 ulen + glen + flen + 4)) == NULL)
819 np->user = &np->data[0];
820 (void)strcpy(np->user, user);
821 np->group = &np->data[ulen + 1];
822 (void)strcpy(np->group, group);
824 if (S_ISCHR(sp->st_mode) ||
825 S_ISBLK(sp->st_mode)) {
826 sizelen = snprintf(NULL, 0,
827 "%#jx", (uintmax_t)sp->st_rdev);
828 if (d.s_size < sizelen)
833 np->flags = &np->data[ulen + glen + 2];
834 (void)strcpy(np->flags, flags);
838 np->label = &np->data[ulen + glen + 2
839 + (f_flags ? flen + 1 : 0)];
840 (void)strcpy(np->label, labelstr);
843 cur->fts_pointer = np;
850 * If there are no entries to display, we normally stop right
851 * here. However, we must continue if we have to display the
852 * total block count. In this case, we display the total only
853 * on the second (p != NULL) pass.
855 if (!entries && (!(f_longform || f_size) || p == NULL))
863 d.s_block = snprintf(NULL, 0, "%lu", howmany(maxblock, blocksize));
864 d.s_flags = maxflags;
865 d.s_label = maxlabelstr;
866 d.s_group = maxgroup;
867 d.s_inode = snprintf(NULL, 0, "%ju", maxinode);
868 d.s_nlink = snprintf(NULL, 0, "%lu", maxnlink);
869 sizelen = f_humanval ? HUMANVALSTR_LEN :
870 snprintf(NULL, 0, "%ju", maxsize);
871 if (d.s_size < sizelen)
875 if (f_thousands) /* make space for commas */
876 d.s_size += (d.s_size - 1) / 3;
881 for (cur = list; cur; cur = cur->fts_link)
882 free(cur->fts_pointer);
886 * Ordering for mastercmp:
887 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories
888 * as larger than directories. Within either group, use the sort function.
889 * All other levels use the sort function. Error entries remain unsorted.
892 mastercmp(const FTSENT * const *a, const FTSENT * const *b)
896 a_info = (*a)->fts_info;
897 if (a_info == FTS_ERR)
899 b_info = (*b)->fts_info;
900 if (b_info == FTS_ERR)
903 if (a_info == FTS_NS || b_info == FTS_NS)
904 return (namecmp(*a, *b));
906 if (a_info != b_info &&
907 (*a)->fts_level == FTS_ROOTLEVEL && !f_listdir) {
913 return (sortfcn(*a, *b));