2 * Copyright (c) 1989, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 static const char copyright[] =
35 "@(#) Copyright (c) 1989, 1993, 1994\n\
36 The Regents of the University of California. All rights reserved.\n";
41 static char sccsid[] = "@(#)ls.c 8.5 (Berkeley) 4/2/94";
44 #include <sys/cdefs.h>
45 __FBSDID("$FreeBSD$");
47 #include <sys/param.h>
49 #include <sys/ioctl.h>
74 * Upward approximation of the maximum number of characters needed to
75 * represent a value of integral type t as a string, excluding the
76 * NUL terminator, with provision for a sign.
78 #define STRBUF_SIZEOF(t) (1 + CHAR_BIT * sizeof(t) / 3 + 1)
81 * MAKENINES(n) turns n into (10**n)-1. This is useful for converting a width
82 * into a number that wide in decimal.
83 * XXX: Overflows are not considered.
85 #define MAKENINES(n) \
89 /* Use a loop as all values of n are small. */ \
90 for (i = 1; n > 0; i *= 10) \
95 static void display(const FTSENT *, FTSENT *, int);
96 static int mastercmp(const FTSENT * const *, const FTSENT * const *);
97 static void traverse(int, char **, int);
99 static void (*printfcn)(const DISPLAY *);
100 static int (*sortfcn)(const FTSENT *, const FTSENT *);
102 long blocksize; /* block size units */
103 int termwidth = 80; /* default terminal width */
106 int f_accesstime; /* use time of last access */
107 int f_birthtime; /* use time of birth */
108 int f_flags; /* show flags associated with a file */
109 int f_humanval; /* show human-readable file sizes */
110 int f_inode; /* print inode */
111 static int f_kblocks; /* print size in kilobytes */
112 int f_label; /* show MAC label */
113 static int f_listdir; /* list actual directory, not contents */
114 static int f_listdot; /* list files beginning with . */
115 int f_longform; /* long listing format */
116 static int f_noautodot; /* do not automatically enable -A for root */
117 static int f_nofollow; /* don't follow symbolic link arguments */
118 int f_nonprint; /* show unprintables as ? */
119 static int f_nosort; /* don't sort output */
120 int f_notabs; /* don't use tab-separated multi-col output */
121 static int f_numericonly; /* don't convert uid/gid to name */
122 int f_octal; /* show unprintables as \xxx */
123 int f_octal_escape; /* like f_octal but use C escapes if possible */
124 static int f_recursive; /* ls subdirectories also */
125 static int f_reversesort; /* reverse whatever sort is used */
126 int f_samesort; /* sort time and name in same direction */
127 int f_sectime; /* print full time information */
128 static int f_singlecol; /* use single column output */
129 int f_size; /* list size in short listing */
130 static int f_sizesort;
131 int f_slash; /* similar to f_type, but only for dirs */
132 int f_sortacross; /* sort across rows, not down columns */
133 int f_statustime; /* use time of last mode change */
134 static int f_stream; /* stream the output, separate with commas */
135 int f_thousands; /* show file sizes with thousands separators */
136 char *f_timeformat; /* user-specified time format */
137 static int f_timesort; /* sort by time vice name */
138 int f_type; /* add type character for non-regular files */
139 static int f_whiteout; /* show whiteout entries */
142 int f_color; /* add type in color for non-regular files */
144 char *ansi_bgcol; /* ANSI sequence to set background colour */
145 char *ansi_fgcol; /* ANSI sequence to set foreground colour */
146 char *ansi_coloff; /* ANSI sequence to reset colours */
147 char *attrs_off; /* ANSI sequence to turn off attributes */
148 char *enter_bold; /* ANSI sequence to set color to bold mode */
154 main(int argc, char *argv[])
156 static char dot[] = ".", *dotav[] = {dot, NULL};
158 int ch, fts_options, notused;
161 char termcapbuf[1024]; /* termcap definition buffer */
162 char tcapbuf[512]; /* capability buffer */
166 (void)setlocale(LC_ALL, "");
168 /* Terminal defaults to -Cq, non-terminal defaults to -1. */
169 if (isatty(STDOUT_FILENO)) {
171 if ((p = getenv("COLUMNS")) != NULL && *p != '\0')
173 else if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &win) != -1 &&
175 termwidth = win.ws_col;
179 /* retrieve environment variable, in case of explicit -C */
180 p = getenv("COLUMNS");
185 fts_options = FTS_PHYSICAL;
186 if (getenv("LS_SAMESORT"))
188 while ((ch = getopt(argc, argv,
189 "1ABCD:FGHILPRSTUWXZabcdfghiklmnopqrstuwxy,")) != -1) {
192 * The -1, -C, -x and -l options all override each other so
193 * shell aliasing works right.
201 f_sortacross = f_longform = f_singlecol = 0;
213 /* The -c, -u, and -U options override each other. */
230 fts_options |= FTS_SEEDOT;
235 /* The -t and -S options override each other. */
244 /* Other flags. Please keep alphabetic. */
254 f_timeformat = optarg;
261 setenv("CLICOLOR", "", 1);
264 fts_options |= FTS_COMFOLLOW;
271 fts_options &= ~FTS_PHYSICAL;
272 fts_options |= FTS_LOGICAL;
276 fts_options &= ~FTS_COMFOLLOW;
277 fts_options &= ~FTS_LOGICAL;
278 fts_options |= FTS_PHYSICAL;
298 /* The -d option turns off the -R option. */
306 case 'g': /* Compatibility with 4.3BSD. */
360 /* Root is -A automatically unless -I. */
361 if (!f_listdot && getuid() == (uid_t)0 && !f_noautodot)
364 /* Enabling of colours is conditional on the environment. */
365 if (getenv("CLICOLOR") &&
366 (isatty(STDOUT_FILENO) || getenv("CLICOLOR_FORCE")))
368 if (tgetent(termcapbuf, getenv("TERM")) == 1) {
369 ansi_fgcol = tgetstr("AF", &bp);
370 ansi_bgcol = tgetstr("AB", &bp);
371 attrs_off = tgetstr("me", &bp);
372 enter_bold = tgetstr("md", &bp);
374 /* To switch colours off use 'op' if
375 * available, otherwise use 'oc', or
376 * don't do colours at all. */
377 ansi_coloff = tgetstr("op", &bp);
379 ansi_coloff = tgetstr("oc", &bp);
380 if (ansi_fgcol && ansi_bgcol && ansi_coloff)
384 warnx("color support not compiled in");
390 * We can't put tabs and color sequences together:
391 * column number will be incremented incorrectly
392 * for "stty oxtabs" mode.
395 (void)signal(SIGINT, colorquit);
396 (void)signal(SIGQUIT, colorquit);
397 parsecolors(getenv("LSCOLORS"));
402 * If not -F, -i, -l, -s, -S or -t options, don't require stat
403 * information, unless in color mode in which case we do
404 * need this to determine which colors to display.
406 if (!f_inode && !f_longform && !f_size && !f_timesort &&
407 !f_sizesort && !f_type
412 fts_options |= FTS_NOSTAT;
415 * If not -F, -P, -d or -l options, follow any symbolic links listed on
418 if (!f_nofollow && !f_longform && !f_listdir && (!f_type || f_slash))
419 fts_options |= FTS_COMFOLLOW;
422 * If -W, show whiteout entries
426 fts_options |= FTS_WHITEOUT;
429 /* If -i, -l or -s, figure out block size. */
430 if (f_inode || f_longform || f_size) {
434 (void)getbsize(¬used, &blocksize);
438 /* Select a sort function. */
440 if (!f_timesort && !f_sizesort)
441 sortfcn = revnamecmp;
443 sortfcn = revsizecmp;
444 else if (f_accesstime)
446 else if (f_birthtime)
447 sortfcn = revbirthcmp;
448 else if (f_statustime)
449 sortfcn = revstatcmp;
450 else /* Use modification time. */
453 if (!f_timesort && !f_sizesort)
457 else if (f_accesstime)
459 else if (f_birthtime)
461 else if (f_statustime)
463 else /* Use modification time. */
467 /* Select a print function. */
469 printfcn = printscol;
471 printfcn = printlong;
473 printfcn = printstream;
478 traverse(argc, argv, fts_options);
480 traverse(1, dotav, fts_options);
484 static int output; /* If anything output. */
487 * Traverse() walks the logical directory structure specified by the argv list
488 * in the order specified by the mastercmp() comparison function. During the
489 * traversal it passes linked lists of structures to display() which represent
490 * a superset (may be exact set) of the files to be displayed.
493 traverse(int argc, char *argv[], int options)
500 fts_open(argv, options, f_nosort ? NULL : mastercmp)) == NULL)
504 * We ignore errors from fts_children here since they will be
505 * replicated and signalled on the next call to fts_read() below.
507 chp = fts_children(ftsp, 0);
509 display(NULL, chp, options);
514 * If not recursing down this tree and don't need stat info, just get
517 ch_options = !f_recursive && !f_label &&
518 options & FTS_NOSTAT ? FTS_NAMEONLY : 0;
520 while ((p = fts_read(ftsp)) != NULL)
521 switch (p->fts_info) {
523 warnx("%s: directory causes a cycle", p->fts_name);
527 warnx("%s: %s", p->fts_path, strerror(p->fts_errno));
531 if (p->fts_level != FTS_ROOTLEVEL &&
532 p->fts_name[0] == '.' && !f_listdot)
536 * If already output something, put out a newline as
537 * a separator. If multiple arguments, precede each
538 * directory with its name.
542 (void)printname(p->fts_path);
544 } else if (argc > 1) {
545 (void)printname(p->fts_path);
549 chp = fts_children(ftsp, ch_options);
550 display(p, chp, options);
552 if (!f_recursive && chp != NULL)
553 (void)fts_set(ftsp, p, FTS_SKIP);
563 * Display() takes a linked list of FTSENT structures and passes the list
564 * along with any other necessary information to the print function. P
565 * points to the parent directory of the display list.
568 display(const FTSENT *p, FTSENT *list, int options)
577 u_long btotal, labelstrlen, maxlen, maxnlink;
583 size_t flen, ulen, glen;
585 int entries, needstats;
586 const char *user, *group;
587 char *flags, *labelstr = NULL;
588 char ngroup[STRBUF_SIZEOF(uid_t) + 1];
589 char nuser[STRBUF_SIZEOF(gid_t) + 1];
591 needstats = f_inode || f_longform || f_size;
594 initmax = getenv("LS_COLWIDTHS");
595 /* Fields match -lios order. New ones should be added at the end. */
596 maxlabelstr = maxblock = maxlen = maxnlink = 0;
597 maxuser = maxgroup = maxflags = maxsize = 0;
599 if (initmax != NULL && *initmax != '\0') {
600 char *initmax2, *jinitmax;
603 /* Fill-in "::" as "0:0:0" for the sake of scanf. */
604 jinitmax = malloc(strlen(initmax) * 2 + 2);
605 if (jinitmax == NULL)
609 strcpy(initmax2, "0:"), initmax2 += 2;
611 *initmax2++ = *initmax, *initmax2 = '\0';
612 for (initmax++; *initmax != '\0'; initmax++) {
613 if (initmax[-1] == ':' && initmax[0] == ':') {
615 *initmax2++ = initmax[0];
618 *initmax2++ = initmax[0];
622 if (initmax2[-1] == ':')
623 strcpy(initmax2, "0");
625 ninitmax = sscanf(jinitmax,
626 " %ju : %ld : %lu : %u : %u : %i : %jd : %lu : %lu ",
627 &maxinode, &maxblock, &maxnlink, &maxuser,
628 &maxgroup, &maxflags, &maxsize, &maxlen, &maxlabelstr);
675 for (cur = list, entries = 0; cur; cur = cur->fts_link) {
676 if (cur->fts_info == FTS_ERR || cur->fts_info == FTS_NS) {
678 cur->fts_name, strerror(cur->fts_errno));
679 cur->fts_number = NO_PRINT;
684 * P is NULL if list is the argv list, to which different rules
688 /* Directories will be displayed later. */
689 if (cur->fts_info == FTS_D && !f_listdir) {
690 cur->fts_number = NO_PRINT;
694 /* Only display dot file if -a/-A set. */
695 if (cur->fts_name[0] == '.' && !f_listdot) {
696 cur->fts_number = NO_PRINT;
700 if (cur->fts_namelen > maxlen)
701 maxlen = cur->fts_namelen;
702 if (f_octal || f_octal_escape) {
703 u_long t = len_octal(cur->fts_name, cur->fts_namelen);
710 if (sp->st_blocks > maxblock)
711 maxblock = sp->st_blocks;
712 if (sp->st_ino > maxinode)
713 maxinode = sp->st_ino;
714 if (sp->st_nlink > maxnlink)
715 maxnlink = sp->st_nlink;
716 if (sp->st_size > maxsize)
717 maxsize = sp->st_size;
719 btotal += sp->st_blocks;
722 (void)snprintf(nuser, sizeof(nuser),
724 (void)snprintf(ngroup, sizeof(ngroup),
729 user = user_from_uid(sp->st_uid, 0);
730 group = group_from_gid(sp->st_gid, 0);
732 if ((ulen = strlen(user)) > maxuser)
734 if ((glen = strlen(group)) > maxgroup)
737 flags = fflagstostr(sp->st_flags);
738 if (flags != NULL && *flags == '\0') {
743 err(1, "fflagstostr");
744 flen = strlen(flags);
745 if (flen > (size_t)maxflags)
751 char name[PATH_MAX + 1];
755 error = mac_prepare_file_label(&label);
757 warn("MAC label for %s/%s",
758 cur->fts_parent->fts_path,
763 if (cur->fts_level == FTS_ROOTLEVEL)
764 snprintf(name, sizeof(name),
765 "%s", cur->fts_name);
767 snprintf(name, sizeof(name),
768 "%s/%s", cur->fts_parent->
769 fts_accpath, cur->fts_name);
771 if (options & FTS_LOGICAL)
772 error = mac_get_file(name,
775 error = mac_get_link(name,
778 warn("MAC label for %s/%s",
779 cur->fts_parent->fts_path,
785 error = mac_to_text(label,
788 warn("MAC label for %s/%s",
789 cur->fts_parent->fts_path,
796 if (labelstr == NULL)
797 labelstr = strdup("-");
798 labelstrlen = strlen(labelstr);
799 if (labelstrlen > maxlabelstr)
800 maxlabelstr = labelstrlen;
804 if ((np = malloc(sizeof(NAMES) + labelstrlen +
805 ulen + glen + flen + 4)) == NULL)
808 np->user = &np->data[0];
809 (void)strcpy(np->user, user);
810 np->group = &np->data[ulen + 1];
811 (void)strcpy(np->group, group);
813 if (S_ISCHR(sp->st_mode) ||
814 S_ISBLK(sp->st_mode)) {
815 sizelen = snprintf(NULL, 0,
816 "%#jx", (uintmax_t)sp->st_rdev);
817 if (d.s_size < sizelen)
822 np->flags = &np->data[ulen + glen + 2];
823 (void)strcpy(np->flags, flags);
827 np->label = &np->data[ulen + glen + 2
828 + (f_flags ? flen + 1 : 0)];
829 (void)strcpy(np->label, labelstr);
832 cur->fts_pointer = np;
839 * If there are no entries to display, we normally stop right
840 * here. However, we must continue if we have to display the
841 * total block count. In this case, we display the total only
842 * on the second (p != NULL) pass.
844 if (!entries && (!(f_longform || f_size) || p == NULL))
852 d.s_block = snprintf(NULL, 0, "%lu", howmany(maxblock, blocksize));
853 d.s_flags = maxflags;
854 d.s_label = maxlabelstr;
855 d.s_group = maxgroup;
856 d.s_inode = snprintf(NULL, 0, "%ju", maxinode);
857 d.s_nlink = snprintf(NULL, 0, "%lu", maxnlink);
858 sizelen = f_humanval ? HUMANVALSTR_LEN :
859 snprintf(NULL, 0, "%ju", maxsize);
860 if (d.s_size < sizelen)
864 if (f_thousands) /* make space for commas */
865 d.s_size += (d.s_size - 1) / 3;
870 for (cur = list; cur; cur = cur->fts_link)
871 free(cur->fts_pointer);
875 * Ordering for mastercmp:
876 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories
877 * as larger than directories. Within either group, use the sort function.
878 * All other levels use the sort function. Error entries remain unsorted.
881 mastercmp(const FTSENT * const *a, const FTSENT * const *b)
885 a_info = (*a)->fts_info;
886 if (a_info == FTS_ERR)
888 b_info = (*b)->fts_info;
889 if (b_info == FTS_ERR)
892 if (a_info == FTS_NS || b_info == FTS_NS)
893 return (namecmp(*a, *b));
895 if (a_info != b_info &&
896 (*a)->fts_level == FTS_ROOTLEVEL && !f_listdir) {
902 return (sortfcn(*a, *b));