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 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 static const char copyright
[] =
39 "@(#) Copyright (c) 1989, 1993, 1994\n\
40 The Regents of the University of California. All rights reserved.\n";
45 static char sccsid
[] = "@(#)ls.c 8.5 (Berkeley) 4/2/94";
48 #include <sys/cdefs.h>
49 __RCSID("$FreeBSD: src/bin/ls/ls.c,v 1.66 2002/09/21 01:28:36 wollman Exp $");
51 #include <sys/types.h>
53 #include <sys/ioctl.h>
72 #include <get_compat.h>
74 #define COMPAT_MODE(a,b) (1)
75 #endif /* __APPLE__ */
80 * Upward approximation of the maximum number of characters needed to
81 * represent a value of integral type t as a string, excluding the
82 * NUL terminator, with provision for a sign.
84 #define STRBUF_SIZEOF(t) (1 + CHAR_BIT * sizeof(t) / 3 + 1)
86 static void display(FTSENT
*, FTSENT
*);
87 static u_quad_t
makenines(u_long
);
88 static int mastercmp(const FTSENT
* const *, const FTSENT
* const *);
89 static void traverse(int, char **, int);
91 static void (*printfcn
)(DISPLAY
*);
92 static int (*sortfcn
)(const FTSENT
*, const FTSENT
*);
94 long blocksize
; /* block size units */
95 int termwidth
= 80; /* default terminal width */
98 int f_accesstime
; /* use time of last access */
99 int f_flags
; /* show flags associated with a file */
100 int f_humanval
; /* show human-readable file sizes */
101 int f_inode
; /* print inode */
102 static int f_kblocks
; /* print size in kilobytes */
103 static int f_listdir
; /* list actual directory, not contents */
104 static int f_listdot
; /* list files beginning with . */
105 int f_longform
; /* long listing format */
106 int f_nonprint
; /* show unprintables as ? */
107 static int f_nosort
; /* don't sort output */
108 int f_notabs
; /* don't use tab-separated multi-col output */
109 static int f_numericonly
; /* don't convert uid/gid to name */
110 int f_octal
; /* show unprintables as \xxx */
111 int f_octal_escape
; /* like f_octal but use C escapes if possible */
112 static int f_recursive
; /* ls subdirectories also */
113 static int f_reversesort
; /* reverse whatever sort is used */
114 int f_sectime
; /* print the real time for all files */
115 static int f_singlecol
; /* use single column output */
116 int f_size
; /* list size in short listing */
117 int f_slash
; /* similar to f_type, but only for dirs */
118 int f_sortacross
; /* sort across rows, not down columns */
119 int f_statustime
; /* use time of last mode change */
120 int f_stream
; /* stream the output, separate with commas */
121 static int f_timesort
; /* sort by time vice name */
122 static int f_sizesort
; /* sort by size */
123 int f_type
; /* add type character for non-regular files */
124 static int f_whiteout
; /* show whiteout entries */
125 int f_acl
; /* show ACLs in long listing */
126 int f_group
; /* show group */
128 int f_color
; /* add type in color for non-regular files */
130 char *ansi_bgcol
; /* ANSI sequence to set background colour */
131 char *ansi_fgcol
; /* ANSI sequence to set foreground colour */
132 char *ansi_coloff
; /* ANSI sequence to reset colours */
133 char *attrs_off
; /* ANSI sequence to turn off attributes */
134 char *enter_bold
; /* ANSI sequence to set color to bold mode */
140 main(int argc
, char *argv
[])
142 static char dot
[] = ".", *dotav
[] = {dot
, NULL
};
144 int ch
, fts_options
, notused
;
147 char termcapbuf
[1024]; /* termcap definition buffer */
148 char tcapbuf
[512]; /* capability buffer */
152 (void)setlocale(LC_ALL
, "");
154 /* Terminal defaults to -Cq, non-terminal defaults to -1. */
155 if (isatty(STDOUT_FILENO
)) {
157 if ((p
= getenv("COLUMNS")) != NULL
&& *p
!= '\0')
159 else if (ioctl(STDOUT_FILENO
, TIOCGWINSZ
, &win
) != -1 &&
161 termwidth
= win
.ws_col
;
165 /* retrieve environment variable, in case of explicit -C */
166 p
= getenv("COLUMNS");
171 /* Root is -A automatically. */
175 fts_options
= FTS_PHYSICAL
;
176 while ((ch
= getopt(argc
, argv
, "1ABCFGHLPRSTWabcdefghiklmnopqrstuvwx"))
180 * The -1, -C, -x and -l options all override each other so
181 * shell aliasing works right.
194 f_sortacross
= f_longform
= f_singlecol
= 0;
206 /* The -c and -u options override each other. */
220 fts_options
|= FTS_COMFOLLOW
;
223 setenv("CLICOLOR", "", 1);
226 fts_options
&= ~FTS_PHYSICAL
;
227 fts_options
|= FTS_LOGICAL
;
230 fts_options
&= ~FTS_COMFOLLOW
;
231 fts_options
&= ~FTS_LOGICAL
;
232 fts_options
|= FTS_PHYSICAL
;
238 fts_options
|= FTS_SEEDOT
;
243 /* The -d option turns off the -R option. */
251 case 'g': /* Compatibility with Unix03 */
252 if (COMPAT_MODE("bin/ls", "Unix2003")) {
292 /* Darwin 1.4.1 compatibility */
308 /* Darwin 1.4.1 compatibility */
332 /* Enabling of colours is conditional on the environment. */
333 if (getenv("CLICOLOR") &&
334 (isatty(STDOUT_FILENO
) || getenv("CLICOLOR_FORCE")))
336 if (tgetent(termcapbuf
, getenv("TERM")) == 1) {
337 ansi_fgcol
= tgetstr("AF", &bp
);
338 ansi_bgcol
= tgetstr("AB", &bp
);
339 attrs_off
= tgetstr("me", &bp
);
340 enter_bold
= tgetstr("md", &bp
);
342 /* To switch colours off use 'op' if
343 * available, otherwise use 'oc', or
344 * don't do colours at all. */
345 ansi_coloff
= tgetstr("op", &bp
);
347 ansi_coloff
= tgetstr("oc", &bp
);
348 if (ansi_fgcol
&& ansi_bgcol
&& ansi_coloff
)
352 (void)fprintf(stderr
, "Color support not compiled in.\n");
358 * We can't put tabs and color sequences together:
359 * column number will be incremented incorrectly
360 * for "stty oxtabs" mode.
363 (void)signal(SIGINT
, colorquit
);
364 (void)signal(SIGQUIT
, colorquit
);
365 parsecolors(getenv("LSCOLORS"));
370 * If not -F, -i, -l, -s or -t options, don't require stat
371 * information, unless in color mode in which case we do
372 * need this to determine which colors to display.
374 if (!f_inode
&& !f_longform
&& !f_size
&& !f_timesort
&& !f_type
&& !f_sizesort
379 fts_options
|= FTS_NOSTAT
;
382 * If not -F, -d or -l options, follow any symbolic links listed on
385 if (!f_longform
&& !f_listdir
&& !f_type
)
386 fts_options
|= FTS_COMFOLLOW
;
389 * If -W, show whiteout entries
393 fts_options
|= FTS_WHITEOUT
;
396 /* If -l or -s, figure out block size. */
397 if (f_longform
|| f_size
) {
401 (void)getbsize(¬used
, &blocksize
);
405 /* Select a sort function. */
408 sortfcn
= revsizecmp
;
409 else if (!f_timesort
)
410 sortfcn
= revnamecmp
;
411 else if (f_accesstime
)
413 else if (f_statustime
)
414 sortfcn
= revstatcmp
;
415 else /* Use modification time. */
420 else if (!f_timesort
)
422 else if (f_accesstime
)
424 else if (f_statustime
)
426 else /* Use modification time. */
430 /* Select a print function. */
432 printfcn
= printscol
;
434 printfcn
= printlong
;
436 printfcn
= printstream
;
441 traverse(argc
, argv
, fts_options
);
443 traverse(1, dotav
, fts_options
);
447 static int output
; /* If anything output. */
450 * Traverse() walks the logical directory structure specified by the argv list
451 * in the order specified by the mastercmp() comparison function. During the
452 * traversal it passes linked lists of structures to display() which represent
453 * a superset (may be exact set) of the files to be displayed.
456 traverse(int argc
, char *argv
[], int options
)
463 fts_open(argv
, options
, f_nosort ? NULL
: mastercmp
)) == NULL
)
466 display(NULL
, fts_children(ftsp
, 0));
471 * If not recursing down this tree and don't need stat info, just get
474 ch_options
= !f_recursive
&& options
& FTS_NOSTAT ? FTS_NAMEONLY
: 0;
476 while ((p
= fts_read(ftsp
)) != NULL
)
477 switch (p
->fts_info
) {
479 warnx("%s: directory causes a cycle", p
->fts_name
);
483 warnx("%s: %s", p
->fts_name
, strerror(p
->fts_errno
));
487 if (p
->fts_level
!= FTS_ROOTLEVEL
&&
488 p
->fts_name
[0] == '.' && !f_listdot
)
492 * If already output something, put out a newline as
493 * a separator. If multiple arguments, precede each
494 * directory with its name.
497 (void)printf("\n%s:\n", p
->fts_path
);
499 (void)printf("%s:\n", p
->fts_path
);
502 chp
= fts_children(ftsp
, ch_options
);
505 if (!f_recursive
&& chp
!= NULL
)
506 (void)fts_set(ftsp
, p
, FTS_SKIP
);
516 * Display() takes a linked list of FTSENT structures and passes the list
517 * along with any other necessary information to the print function. P
518 * points to the parent directory of the display list.
521 display(FTSENT
*p
, FTSENT
*list
)
528 u_int64_t btotal
, maxblock
;
529 u_long lattrlen
, maxinode
, maxlen
, maxnlink
, maxlattr
;
530 int bcfile
, maxflags
;
533 size_t flen
, ulen
, glen
;
535 int entries
, needstats
;
536 const char *user
, *group
;
537 char *flags
, *lattr
= NULL
;
538 char buf
[STRBUF_SIZEOF(u_quad_t
) + 1];
539 char ngroup
[STRBUF_SIZEOF(uid_t
) + 1];
540 char nuser
[STRBUF_SIZEOF(gid_t
) + 1];
543 * If list is NULL there are two possibilities: that the parent
544 * directory p has no children, or that fts_children() returned an
545 * error. We ignore the error case since it will be replicated
546 * on the next call to fts_read() on the post-order visit to the
547 * directory p, and will be signaled in traverse().
552 needstats
= f_inode
|| f_longform
|| f_size
;
555 initmax
= getenv("LS_COLWIDTHS");
556 /* Fields match -lios order. New ones should be added at the end. */
557 maxlattr
= maxblock
= maxinode
= maxlen
= maxnlink
=
558 maxuser
= maxgroup
= maxflags
= maxsize
= 0;
559 if (initmax
!= NULL
&& *initmax
!= '\0') {
560 char *initmax2
, *jinitmax
;
563 /* Fill-in "::" as "0:0:0" for the sake of scanf. */
564 jinitmax
= initmax2
= malloc(strlen(initmax
) * 2 + 2);
565 if (jinitmax
== NULL
)
568 strcpy(initmax2
, "0:"), initmax2
+= 2;
570 *initmax2
++ = *initmax
, *initmax2
= '\0';
571 for (initmax
++; *initmax
!= '\0'; initmax
++) {
572 if (initmax
[-1] == ':' && initmax
[0] == ':') {
574 *initmax2
++ = initmax
[0];
577 *initmax2
++ = initmax
[0];
581 if (initmax2
[-1] == ':')
582 strcpy(initmax2
, "0");
584 ninitmax
= sscanf(jinitmax
,
585 " %lu : %qu : %lu : %i : %i : %i : %qu : %lu : %lu ",
586 &maxinode
, &maxblock
, &maxnlink
, &maxuser
,
587 &maxgroup
, &maxflags
, &maxsize
, &maxlen
, &maxlattr
);
625 maxinode
= makenines(maxinode
);
626 maxblock
= makenines(maxblock
);
627 maxnlink
= makenines(maxnlink
);
628 maxsize
= makenines(maxsize
);
632 for (cur
= list
, entries
= 0; cur
; cur
= cur
->fts_link
) {
633 if (cur
->fts_info
== FTS_ERR
|| cur
->fts_info
== FTS_NS
) {
635 cur
->fts_name
, strerror(cur
->fts_errno
));
636 cur
->fts_number
= NO_PRINT
;
641 * P is NULL if list is the argv list, to which different rules
645 /* Directories will be displayed later. */
646 if (cur
->fts_info
== FTS_D
&& !f_listdir
) {
647 cur
->fts_number
= NO_PRINT
;
651 /* Only display dot file if -a/-A set. */
652 if (cur
->fts_name
[0] == '.' && !f_listdot
) {
653 cur
->fts_number
= NO_PRINT
;
657 if (cur
->fts_namelen
> maxlen
)
658 maxlen
= cur
->fts_namelen
;
659 if (f_octal
|| f_octal_escape
) {
660 u_long t
= len_octal(cur
->fts_name
, cur
->fts_namelen
);
667 if (sp
->st_blocks
> maxblock
)
668 maxblock
= sp
->st_blocks
;
669 if (sp
->st_ino
> maxinode
)
670 maxinode
= sp
->st_ino
;
671 if (sp
->st_nlink
> maxnlink
)
672 maxnlink
= sp
->st_nlink
;
673 if (sp
->st_size
> maxsize
)
674 maxsize
= sp
->st_size
;
676 btotal
+= sp
->st_blocks
;
679 (void)snprintf(nuser
, sizeof(nuser
),
681 (void)snprintf(ngroup
, sizeof(ngroup
),
686 user
= user_from_uid(sp
->st_uid
, 0);
687 group
= group_from_gid(sp
->st_gid
, 0);
689 if ((ulen
= strlen(user
)) > maxuser
)
691 if ((glen
= strlen(group
)) > maxgroup
)
694 flags
= fflagstostr(sp
->st_flags
);
695 if (flags
!= NULL
&& *flags
== '\0') {
700 err(1, "fflagstostr");
701 flen
= strlen(flags
);
702 if (flen
> (size_t)maxflags
)
709 if ((np
= malloc(sizeof(NAMES
) + lattrlen
+
710 ulen
+ glen
+ flen
+ 4)) == NULL
)
713 np
->user
= &np
->data
[0];
714 (void)strcpy(np
->user
, user
);
715 np
->group
= &np
->data
[ulen
+ 1];
716 (void)strcpy(np
->group
, group
);
718 if (S_ISCHR(sp
->st_mode
) ||
719 S_ISBLK(sp
->st_mode
))
723 np
->flags
= &np
->data
[ulen
+ glen
+ 2];
724 (void)strcpy(np
->flags
, flags
);
727 cur
->fts_pointer
= np
;
742 (void)snprintf(buf
, sizeof(buf
), "%qu", (u_int64_t
)maxblock
);
743 d
.s_block
= strlen(buf
);
744 d
.s_flags
= maxflags
;
745 d
.s_lattr
= maxlattr
;
746 d
.s_group
= maxgroup
;
747 (void)snprintf(buf
, sizeof(buf
), "%lu", maxinode
);
748 d
.s_inode
= strlen(buf
);
749 (void)snprintf(buf
, sizeof(buf
), "%lu", maxnlink
);
750 d
.s_nlink
= strlen(buf
);
751 (void)snprintf(buf
, sizeof(buf
), "%qu", (u_int64_t
)maxsize
);
752 d
.s_size
= strlen(buf
);
759 for (cur
= list
; cur
; cur
= cur
->fts_link
)
760 free(cur
->fts_pointer
);
764 * Ordering for mastercmp:
765 * If ordering the argv (fts_level = FTS_ROOTLEVEL) return non-directories
766 * as larger than directories. Within either group, use the sort function.
767 * All other levels use the sort function. Error entries remain unsorted.
770 mastercmp(const FTSENT
* const *a
, const FTSENT
* const *b
)
774 a_info
= (*a
)->fts_info
;
775 if (a_info
== FTS_ERR
)
777 b_info
= (*b
)->fts_info
;
778 if (b_info
== FTS_ERR
)
781 if (a_info
== FTS_NS
|| b_info
== FTS_NS
)
782 return (namecmp(*a
, *b
));
784 if (a_info
!= b_info
&&
785 (*a
)->fts_level
== FTS_ROOTLEVEL
&& !f_listdir
) {
791 return (sortfcn(*a
, *b
));
795 * Makenines() returns (10**n)-1. This is useful for converting a width
796 * into a number that wide in decimal.
805 /* Use a loop instead of pow(), since all values of n are small. */
806 for (i
= 0; i
< n
; i
++)