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
32 * @(#) Copyright (c) 1989, 1993, 1994 The Regents of the University of California. All rights reserved.
33 * @(#)ls.c 8.5 (Berkeley) 4/2/94
34 * $FreeBSD: src/bin/ls/ls.c,v 1.63 2002/07/10 20:44:54 dillon Exp $
35 * $DragonFly: src/bin/ls/ls.c,v 1.9 2005/09/18 11:40:09 asmodai Exp $
38 #include <sys/types.h>
40 #include <sys/ioctl.h>
63 * Upward approximation of the maximum number of characters needed to
64 * represent a value of integral type t as a string, excluding the
65 * NUL terminator, with provision for a sign.
67 #define STRBUF_SIZEOF(t) (1 + CHAR_BIT * sizeof(t) / 3 + 1)
69 static void display(FTSENT *, FTSENT *);
70 static u_quad_t makenines(u_long);
71 static int mastercmp(const FTSENT **, const FTSENT **);
72 static void traverse(int, char **, int);
74 static void (*printfcn)(DISPLAY *);
75 static int (*sortfcn)(const FTSENT *, const FTSENT *);
77 long blocksize; /* block size units */
78 int termwidth = 80; /* default terminal width */
81 int f_accesstime; /* use time of last access */
82 int f_flags; /* show flags associated with a file */
83 int f_fsmid; /* show FSMID associated with a file */
84 int f_humanval; /* show human-readable file sizes */
85 int f_inode; /* print inode */
86 static int f_kblocks; /* print size in kilobytes */
87 static int f_listdir; /* list actual directory, not contents */
88 static int f_listdot; /* list files beginning with . */
89 int f_longform; /* long listing format */
90 int f_nonprint; /* show unprintables as ? */
91 static int f_nosort; /* don't sort output */
92 int f_notabs; /* don't use tab-separated multi-col output */
93 static int f_numericonly; /* don't convert uid/gid to name */
94 int f_octal; /* show unprintables as \xxx */
95 int f_octal_escape; /* like f_octal but use C escapes if possible */
96 static int f_recursive; /* ls subdirectories also */
97 static int f_reversesort; /* reverse whatever sort is used */
98 int f_sectime; /* print the real time for all files */
99 static int f_singlecol; /* use single column output */
100 int f_size; /* list size in short listing */
101 int f_slash; /* similar to f_type, but only for dirs */
102 int f_sortacross; /* sort across rows, not down columns */
103 int f_statustime; /* use time of last mode change */
104 static int f_stream; /* stream the output, separate with commas */
105 static int f_timesort; /* sort by time vice name */
106 int f_type; /* add type character for non-regular files */
107 static int f_whiteout; /* show whiteout entries */
109 int f_color; /* add type in color for non-regular files */
111 char *ansi_bgcol; /* ANSI sequence to set background colour */
112 char *ansi_fgcol; /* ANSI sequence to set foreground colour */
113 char *ansi_coloff; /* ANSI sequence to reset colours */
114 char *attrs_off; /* ANSI sequence to turn off attributes */
115 char *enter_bold; /* ANSI sequence to set color to bold mode */
121 main(int argc, char *argv[])
123 static char dot[] = ".", *dotav[] = {dot, NULL};
125 int ch, fts_options, notused;
128 char termcapbuf[1024]; /* termcap definition buffer */
129 char tcapbuf[512]; /* capability buffer */
133 setlocale(LC_ALL, "");
135 /* Terminal defaults to -Cq, non-terminal defaults to -1. */
136 if (isatty(STDOUT_FILENO)) {
138 if ((p = getenv("COLUMNS")) != NULL && *p != '\0')
140 else if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &win) != -1 &&
142 termwidth = win.ws_col;
146 /* retrieve environment variable, in case of explicit -C */
147 p = getenv("COLUMNS");
152 /* Root is -A automatically. */
156 fts_options = FTS_PHYSICAL;
157 while ((ch = getopt(argc, argv, "1ABCFGHLPRTWabcdfghiklmnopqrstuwxy"))
161 * The -1, -C, -x and -l options all override each other so
162 * shell aliasing works right.
175 f_sortacross = f_longform = f_singlecol = 0;
188 #ifdef _ST_FSMID_PRESENT_
192 /* The -c and -u options override each other. */
206 fts_options |= FTS_COMFOLLOW;
209 setenv("CLICOLOR", "", 1);
212 fts_options &= ~FTS_PHYSICAL;
213 fts_options |= FTS_LOGICAL;
216 fts_options &= ~FTS_COMFOLLOW;
217 fts_options &= ~FTS_LOGICAL;
218 fts_options |= FTS_PHYSICAL;
224 fts_options |= FTS_SEEDOT;
229 /* The -d option turns off the -R option. */
237 case 'g': /* Compatibility with 4.3BSD. */
301 /* Enabling of colours is conditional on the environment. */
302 if (getenv("CLICOLOR") &&
303 (isatty(STDOUT_FILENO) || getenv("CLICOLOR_FORCE")))
305 if (tgetent(termcapbuf, getenv("TERM")) == 1) {
306 ansi_fgcol = tgetstr("AF", &bp);
307 ansi_bgcol = tgetstr("AB", &bp);
308 attrs_off = tgetstr("me", &bp);
309 enter_bold = tgetstr("md", &bp);
311 /* To switch colours off use 'op' if
312 * available, otherwise use 'oc', or
313 * don't do colours at all. */
314 ansi_coloff = tgetstr("op", &bp);
316 ansi_coloff = tgetstr("oc", &bp);
317 if (ansi_fgcol && ansi_bgcol && ansi_coloff)
321 fprintf(stderr, "Color support not compiled in.\n");
327 * We can't put tabs and color sequences together:
328 * column number will be incremented incorrectly
329 * for "stty oxtabs" mode.
332 signal(SIGINT, colorquit);
333 signal(SIGQUIT, colorquit);
334 parsecolors(getenv("LSCOLORS"));
339 * If not -F, -i, -l, -s or -t options, don't require stat
340 * information, unless in color mode in which case we do
341 * need this to determine which colors to display.
343 if (!f_inode && !f_longform && !f_size && !f_timesort && !f_type
348 fts_options |= FTS_NOSTAT;
351 * If not -F, -d or -l options, follow any symbolic links listed on
354 if (!f_longform && !f_listdir && !f_type)
355 fts_options |= FTS_COMFOLLOW;
358 * If -W, show whiteout entries
362 fts_options |= FTS_WHITEOUT;
365 /* If -l or -s, figure out block size. */
366 if (f_longform || f_size) {
370 getbsize(¬used, &blocksize);
374 /* Select a sort function. */
377 sortfcn = revnamecmp;
378 else if (f_accesstime)
380 else if (f_statustime)
381 sortfcn = revstatcmp;
382 else /* Use modification time. */
387 else if (f_accesstime)
389 else if (f_statustime)
391 else /* Use modification time. */
395 /* Select a print function. */
397 printfcn = printscol;
399 printfcn = printlong;
401 printfcn = printstream;
406 traverse(argc, argv, fts_options);
408 traverse(1, dotav, fts_options);
412 static int output; /* If anything output. */
415 * Traverse() walks the logical directory structure specified by the argv list
416 * in the order specified by the mastercmp() comparison function. During the
417 * traversal it passes linked lists of structures to display() which represent
418 * a superset (may be exact set) of the files to be displayed.
421 traverse(int argc, char *argv[], int options)
428 fts_open(argv, options, f_nosort ? NULL : mastercmp)) == NULL)
431 display(NULL, fts_children(ftsp, 0));
436 * If not recursing down this tree and don't need stat info, just get
439 ch_options = !f_recursive && options & FTS_NOSTAT ? FTS_NAMEONLY : 0;
441 while ((p = fts_read(ftsp)) != NULL)
442 switch (p->fts_info) {
444 warnx("%s: directory causes a cycle", p->fts_name);
448 warnx("%s: %s", p->fts_name, strerror(p->fts_errno));
452 if (p->fts_level != FTS_ROOTLEVEL &&
453 p->fts_name[0] == '.' && !f_listdot)
457 * If already output something, put out a newline as
458 * a separator. If multiple arguments, precede each
459 * directory with its name.
463 printname(p->fts_path);
465 } else if (argc > 1) {
466 printname(p->fts_path);
470 chp = fts_children(ftsp, ch_options);
473 if (!f_recursive && chp != NULL)
474 fts_set(ftsp, p, FTS_SKIP);
484 * Display() takes a linked list of FTSENT structures and passes the list
485 * along with any other necessary information to the print function. P
486 * points to the parent directory of the display list.
489 display(FTSENT *p, FTSENT *list)
496 u_long btotal, maxblock, maxinode, maxlen, maxnlink;
497 int bcfile, maxflags;
500 size_t fsmidlen, flen, ulen, glen;
502 int entries, needstats;
503 const char *user, *group;
506 char buf[STRBUF_SIZEOF(u_quad_t) + 1];
507 char ngroup[STRBUF_SIZEOF(uid_t) + 1];
508 char nuser[STRBUF_SIZEOF(gid_t) + 1];
511 * If list is NULL there are two possibilities: that the parent
512 * directory p has no children, or that fts_children() returned an
513 * error. We ignore the error case since it will be replicated
514 * on the next call to fts_read() on the post-order visit to the
515 * directory p, and will be signaled in traverse().
520 needstats = f_inode || f_longform || f_size;
523 initmax = getenv("LS_COLWIDTHS");
524 /* Fields match -lios order. New ones should be added at the end. */
525 maxblock = maxinode = maxlen = maxnlink =
526 maxuser = maxgroup = maxflags = maxsize = 0;
527 if (initmax != NULL && *initmax != '\0') {
528 char *initmax2, *jinitmax;
531 /* Fill-in "::" as "0:0:0" for the sake of scanf. */
532 jinitmax = initmax2 = malloc(strlen(initmax) * 2 + 2);
533 if (jinitmax == NULL)
536 strcpy(initmax2, "0:"), initmax2 += 2;
538 *initmax2++ = *initmax, *initmax2 = '\0';
539 for (initmax++; *initmax != '\0'; initmax++) {
540 if (initmax[-1] == ':' && initmax[0] == ':') {
542 *initmax2++ = initmax[0];
545 *initmax2++ = initmax[0];
549 if (initmax2[-1] == ':')
550 strcpy(initmax2, "0");
552 ninitmax = sscanf(jinitmax,
553 " %lu : %lu : %lu : %i : %i : %i : %llu : %lu ",
554 &maxinode, &maxblock, &maxnlink, &maxuser,
555 &maxgroup, &maxflags, &maxsize, &maxlen);
590 maxinode = makenines(maxinode);
591 maxblock = makenines(maxblock);
592 maxnlink = makenines(maxnlink);
593 maxsize = makenines(maxsize);
598 for (cur = list, entries = 0; cur; cur = cur->fts_link) {
599 if (cur->fts_info == FTS_ERR || cur->fts_info == FTS_NS) {
601 cur->fts_name, strerror(cur->fts_errno));
602 cur->fts_number = NO_PRINT;
607 * P is NULL if list is the argv list, to which different rules
611 /* Directories will be displayed later. */
612 if (cur->fts_info == FTS_D && !f_listdir) {
613 cur->fts_number = NO_PRINT;
617 /* Only display dot file if -a/-A set. */
618 if (cur->fts_name[0] == '.' && !f_listdot) {
619 cur->fts_number = NO_PRINT;
623 if (cur->fts_namelen > maxlen)
624 maxlen = cur->fts_namelen;
625 if (f_octal || f_octal_escape) {
626 u_long t = len_octal(cur->fts_name, cur->fts_namelen);
633 if (sp->st_blocks > maxblock)
634 maxblock = sp->st_blocks;
635 if (sp->st_ino > maxinode)
636 maxinode = sp->st_ino;
637 if (sp->st_nlink > maxnlink)
638 maxnlink = sp->st_nlink;
639 if (sp->st_size > maxsize)
640 maxsize = sp->st_size;
642 btotal += sp->st_blocks;
645 snprintf(nuser, sizeof(nuser),
647 snprintf(ngroup, sizeof(ngroup),
652 user = user_from_uid(sp->st_uid, 0);
653 group = group_from_gid(sp->st_gid, 0);
655 if ((ulen = strlen(user)) > maxuser)
657 if ((glen = strlen(group)) > maxgroup)
660 flags = fflagstostr(sp->st_flags);
661 if (flags != NULL && *flags == '\0') {
666 err(1, "flagstostr");
667 flen = strlen(flags);
668 if (flen > (size_t)maxflags)
673 #ifdef _ST_FSMID_PRESENT_
675 fsmid = sp->st_fsmid;
685 if ((np = malloc(sizeof(NAMES) +
686 ulen + glen + flen + fsmidlen + 4)) == NULL)
689 np->user = &np->data[0];
690 strcpy(np->user, user);
691 np->group = &np->data[ulen + 1];
692 strcpy(np->group, group);
694 if (S_ISCHR(sp->st_mode) ||
695 S_ISBLK(sp->st_mode))
699 np->flags = &np->data[ulen + glen + 2];
700 strcpy(np->flags, flags);
703 #ifdef _ST_FSMID_PRESENT_
705 np->fsmid = np->data + ulen + glen + flen + 3;
706 snprintf(np->fsmid, fsmidlen + 1,
710 cur->fts_pointer = np;
725 snprintf(buf, sizeof(buf), "%lu", maxblock);
726 d.s_block = strlen(buf);
727 d.s_flags = maxflags;
728 d.s_group = maxgroup;
729 snprintf(buf, sizeof(buf), "%lu", maxinode);
730 d.s_inode = strlen(buf);
731 snprintf(buf, sizeof(buf), "%lu", maxnlink);
732 d.s_nlink = strlen(buf);
733 snprintf(buf, sizeof(buf), "%llu", maxsize);
734 d.s_size = strlen(buf);
741 for (cur = list; cur; cur = cur->fts_link)
742 free(cur->fts_pointer);
746 * Ordering for mastercmp:
747 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories
748 * as larger than directories. Within either group, use the sort function.
749 * All other levels use the sort function. Error entries remain unsorted.
752 mastercmp(const FTSENT **a, const FTSENT **b)
756 a_info = (*a)->fts_info;
757 if (a_info == FTS_ERR)
759 b_info = (*b)->fts_info;
760 if (b_info == FTS_ERR)
763 if (a_info == FTS_NS || b_info == FTS_NS)
764 return (namecmp(*a, *b));
766 if (a_info != b_info &&
767 (*a)->fts_level == FTS_ROOTLEVEL && !f_listdir) {
773 return (sortfcn(*a, *b));
777 * Makenines() returns (10**n)-1. This is useful for converting a width
778 * into a number that wide in decimal.
787 /* Use a loop instead of pow(), since all values of n are small. */
788 for (i = 0; i < n; i++)