*: remove "Options:" string from help texts
[oweals/busybox.git] / coreutils / du.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Mini du implementation for busybox
4  *
5  * Copyright (C) 1999,2000,2001 by Lineo, inc. and John Beppu
6  * Copyright (C) 1999,2000,2001 by John Beppu <beppu@codepoet.org>
7  * Copyright (C) 2002  Edward Betts <edward@debian.org>
8  *
9  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
10  */
11
12 /* BB_AUDIT SUSv3 compliant (unless default blocksize set to 1k) */
13 /* http://www.opengroup.org/onlinepubs/007904975/utilities/du.html */
14
15 /* Mar 16, 2003      Manuel Novoa III   (mjn3@codepoet.org)
16  *
17  * Mostly rewritten for SUSv3 compliance and to fix bugs/defects.
18  * 1) Added support for SUSv3 -a, -H, -L, gnu -c, and (busybox) -d options.
19  *    The -d option allows setting of max depth (similar to gnu --max-depth).
20  * 2) Fixed incorrect size calculations for links and directories, especially
21  *    when errors occurred.  Calculates sizes should now match gnu du output.
22  * 3) Added error checking of output.
23  * 4) Fixed busybox bug #1284 involving long overflow with human_readable.
24  */
25
26 //usage:#define du_trivial_usage
27 //usage:       "[-aHLdclsx" IF_FEATURE_HUMAN_READABLE("hm") "k] [FILE]..."
28 //usage:#define du_full_usage "\n\n"
29 //usage:       "Summarize disk space used for each FILE and/or directory.\n"
30 //usage:       "Disk space is printed in units of "
31 //usage:        IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("1024")
32 //usage:        IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K("512")
33 //usage:       " bytes.\n"
34 //usage:     "\n        -a      Show file sizes too"
35 //usage:     "\n        -L      Follow all symlinks"
36 //usage:     "\n        -H      Follow symlinks on command line"
37 //usage:     "\n        -d N    Limit output to directories (and files with -a) of depth < N"
38 //usage:     "\n        -c      Show grand total"
39 //usage:     "\n        -l      Count sizes many times if hard linked"
40 //usage:     "\n        -s      Display only a total for each argument"
41 //usage:     "\n        -x      Skip directories on different filesystems"
42 //usage:        IF_FEATURE_HUMAN_READABLE(
43 //usage:     "\n        -h      Sizes in human readable format (e.g., 1K 243M 2G )"
44 //usage:     "\n        -m      Sizes in megabytes"
45 //usage:        )
46 //usage:     "\n        -k      Sizes in kilobytes"
47 //usage:                        IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(" (default)")
48 //usage:
49 //usage:#define du_example_usage
50 //usage:       "$ du\n"
51 //usage:       "16      ./CVS\n"
52 //usage:       "12      ./kernel-patches/CVS\n"
53 //usage:       "80      ./kernel-patches\n"
54 //usage:       "12      ./tests/CVS\n"
55 //usage:       "36      ./tests\n"
56 //usage:       "12      ./scripts/CVS\n"
57 //usage:       "16      ./scripts\n"
58 //usage:       "12      ./docs/CVS\n"
59 //usage:       "104     ./docs\n"
60 //usage:       "2417    .\n"
61
62 #include "libbb.h"
63
64 enum {
65         OPT_a_files_too    = (1 << 0),
66         OPT_H_follow_links = (1 << 1),
67         OPT_k_kbytes       = (1 << 2),
68         OPT_L_follow_links = (1 << 3),
69         OPT_s_total_norecurse = (1 << 4),
70         OPT_x_one_FS       = (1 << 5),
71         OPT_d_maxdepth     = (1 << 6),
72         OPT_l_hardlinks    = (1 << 7),
73         OPT_c_total        = (1 << 8),
74         OPT_h_for_humans   = (1 << 9),
75         OPT_m_mbytes       = (1 << 10),
76 };
77
78 struct globals {
79 #if ENABLE_FEATURE_HUMAN_READABLE
80         unsigned long disp_hr;
81 #else
82         unsigned disp_k;
83 #endif
84         int max_print_depth;
85         bool status;
86         int slink_depth;
87         int du_depth;
88         dev_t dir_dev;
89 } FIX_ALIASING;
90 #define G (*(struct globals*)&bb_common_bufsiz1)
91
92
93 static void print(unsigned long size, const char *filename)
94 {
95         /* TODO - May not want to defer error checking here. */
96 #if ENABLE_FEATURE_HUMAN_READABLE
97         printf("%s\t%s\n",
98                         /* size x 512 / G.disp_hr, show one fractional,
99                          * use suffixes if G.disp_hr == 0 */
100                         make_human_readable_str(size, 512, G.disp_hr),
101                         filename);
102 #else
103         if (G.disp_k) {
104                 size++;
105                 size >>= 1;
106         }
107         printf("%lu\t%s\n", size, filename);
108 #endif
109 }
110
111 /* tiny recursive du */
112 static unsigned long du(const char *filename)
113 {
114         struct stat statbuf;
115         unsigned long sum;
116
117         if (lstat(filename, &statbuf) != 0) {
118                 bb_simple_perror_msg(filename);
119                 G.status = EXIT_FAILURE;
120                 return 0;
121         }
122
123         if (option_mask32 & OPT_x_one_FS) {
124                 if (G.du_depth == 0) {
125                         G.dir_dev = statbuf.st_dev;
126                 } else if (G.dir_dev != statbuf.st_dev) {
127                         return 0;
128                 }
129         }
130
131         sum = statbuf.st_blocks;
132
133         if (S_ISLNK(statbuf.st_mode)) {
134                 if (G.slink_depth > G.du_depth) { /* -H or -L */
135                         if (stat(filename, &statbuf) != 0) {
136                                 bb_simple_perror_msg(filename);
137                                 G.status = EXIT_FAILURE;
138                                 return 0;
139                         }
140                         sum = statbuf.st_blocks;
141                         if (G.slink_depth == 1) {
142                                 /* Convert -H to -L */
143                                 G.slink_depth = INT_MAX;
144                         }
145                 }
146         }
147
148         if (!(option_mask32 & OPT_l_hardlinks)
149          && statbuf.st_nlink > 1
150         ) {
151                 /* Add files/directories with links only once */
152                 if (is_in_ino_dev_hashtable(&statbuf)) {
153                         return 0;
154                 }
155                 add_to_ino_dev_hashtable(&statbuf, NULL);
156         }
157
158         if (S_ISDIR(statbuf.st_mode)) {
159                 DIR *dir;
160                 struct dirent *entry;
161                 char *newfile;
162
163                 dir = warn_opendir(filename);
164                 if (!dir) {
165                         G.status = EXIT_FAILURE;
166                         return sum;
167                 }
168
169                 while ((entry = readdir(dir))) {
170                         newfile = concat_subpath_file(filename, entry->d_name);
171                         if (newfile == NULL)
172                                 continue;
173                         ++G.du_depth;
174                         sum += du(newfile);
175                         --G.du_depth;
176                         free(newfile);
177                 }
178                 closedir(dir);
179         } else {
180                 if (!(option_mask32 & OPT_a_files_too) && G.du_depth != 0)
181                         return sum;
182         }
183         if (G.du_depth <= G.max_print_depth) {
184                 print(sum, filename);
185         }
186         return sum;
187 }
188
189 int du_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
190 int du_main(int argc UNUSED_PARAM, char **argv)
191 {
192         unsigned long total;
193         int slink_depth_save;
194         unsigned opt;
195
196 #if ENABLE_FEATURE_HUMAN_READABLE
197         IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(G.disp_hr = 1024;)
198         IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(G.disp_hr = 512;)
199         if (getenv("POSIXLY_CORRECT"))  /* TODO - a new libbb function? */
200                 G.disp_hr = 512;
201 #else
202         IF_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(G.disp_k = 1;)
203         /* IF_NOT_FEATURE_DU_DEFAULT_BLOCKSIZE_1K(G.disp_k = 0;) - G is pre-zeroed */
204 #endif
205         G.max_print_depth = INT_MAX;
206
207         /* Note: SUSv3 specifies that -a and -s options cannot be used together
208          * in strictly conforming applications.  However, it also says that some
209          * du implementations may produce output when -a and -s are used together.
210          * gnu du exits with an error code in this case.  We choose to simply
211          * ignore -a.  This is consistent with -s being equivalent to -d 0.
212          */
213 #if ENABLE_FEATURE_HUMAN_READABLE
214         opt_complementary = "h-km:k-hm:m-hk:H-L:L-H:s-d:d-s:d+";
215         opt = getopt32(argv, "aHkLsx" "d:" "lc" "hm", &G.max_print_depth);
216         argv += optind;
217         if (opt & OPT_h_for_humans) {
218                 G.disp_hr = 0;
219         }
220         if (opt & OPT_m_mbytes) {
221                 G.disp_hr = 1024*1024;
222         }
223         if (opt & OPT_k_kbytes) {
224                 G.disp_hr = 1024;
225         }
226 #else
227         opt_complementary = "H-L:L-H:s-d:d-s:d+";
228         opt = getopt32(argv, "aHkLsx" "d:" "lc", &G.max_print_depth);
229         argv += optind;
230 #if !ENABLE_FEATURE_DU_DEFAULT_BLOCKSIZE_1K
231         if (opt & OPT_k_kbytes) {
232                 G.disp_k = 1;
233         }
234 #endif
235 #endif
236         if (opt & OPT_H_follow_links) {
237                 G.slink_depth = 1;
238         }
239         if (opt & OPT_L_follow_links) {
240                 G.slink_depth = INT_MAX;
241         }
242         if (opt & OPT_s_total_norecurse) {
243                 G.max_print_depth = 0;
244         }
245
246         /* go through remaining args (if any) */
247         if (!*argv) {
248                 *--argv = (char*)".";
249                 if (G.slink_depth == 1) {
250                         G.slink_depth = 0;
251                 }
252         }
253
254         slink_depth_save = G.slink_depth;
255         total = 0;
256         do {
257                 total += du(*argv);
258                 /* otherwise du /dir /dir won't show /dir twice: */
259                 reset_ino_dev_hashtable();
260                 G.slink_depth = slink_depth_save;
261         } while (*++argv);
262
263         if (opt & OPT_c_total)
264                 print(total, "total");
265
266         fflush_stdout_and_exit(G.status);
267 }