xref: /netbsd-src/bin/df/df.c (revision 7fa608457b817eca6e0977b37f758ae064f3c99c)
1 /*	$NetBSD: df.c,v 1.76 2007/07/17 20:03:10 christos Exp $ */
2 
3 /*
4  * Copyright (c) 1980, 1990, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  * (c) UNIX System Laboratories, Inc.
7  * All or some portions of this file are derived from material licensed
8  * to the University of California by American Telephone and Telegraph
9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10  * the permission of UNIX System Laboratories, Inc.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. 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.
23  *
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
34  * SUCH DAMAGE.
35  */
36 
37 #include <sys/cdefs.h>
38 #ifndef lint
39 __COPYRIGHT(
40 "@(#) Copyright (c) 1980, 1990, 1993, 1994\n\
41 	The Regents of the University of California.  All rights reserved.\n");
42 #endif /* not lint */
43 
44 #ifndef lint
45 #if 0
46 static char sccsid[] = "@(#)df.c	8.7 (Berkeley) 4/2/94";
47 #else
48 __RCSID("$NetBSD: df.c,v 1.76 2007/07/17 20:03:10 christos Exp $");
49 #endif
50 #endif /* not lint */
51 
52 #include <sys/param.h>
53 #include <sys/stat.h>
54 #include <sys/mount.h>
55 
56 #include <assert.h>
57 #include <err.h>
58 #include <errno.h>
59 #include <fcntl.h>
60 #include <util.h>
61 #include <stdio.h>
62 #include <stdlib.h>
63 #include <string.h>
64 #include <unistd.h>
65 
66 extern char *strpct(u_long, u_long, u_int);
67 
68 int	 main(int, char *[]);
69 int	 bread(off_t, void *, int);
70 char	*getmntpt(char *);
71 void	 prtstat(struct statvfs *, int);
72 int	 selected(const char *, size_t);
73 void	 maketypelist(char *);
74 long	 regetmntinfo(struct statvfs **, long);
75 void	 usage(void);
76 void	 prthumanval(int64_t, const char *);
77 void	 prthuman(struct statvfs *, int64_t, int64_t);
78 const char *
79 	strpct64(uint64_t, uint64_t, u_int);
80 
81 int	aflag, gflag, hflag, iflag, lflag, nflag, Pflag;
82 long	usize = 0;
83 char	**typelist = NULL;
84 
85 int
86 main(int argc, char *argv[])
87 {
88 	struct stat stbuf;
89 	struct statvfs *mntbuf;
90 	long mntsize;
91 	int ch, i, maxwidth, width;
92 	char *mntpt;
93 
94 	while ((ch = getopt(argc, argv, "aGghiklmnPt:")) != -1)
95 		switch (ch) {
96 		case 'a':
97 			aflag = 1;
98 			break;
99 		case 'G':
100 			hflag = 0;
101 			usize = 1024 * 1024 * 1024;
102 			break;
103 		case 'g':
104 			gflag = 1;
105 			break;
106 		case 'h':
107 			hflag = 1;
108 			usize = 0;
109 			break;
110 		case 'i':
111 			iflag = 1;
112 			break;
113 		case 'k':
114 			hflag = 0;
115 			usize = 1024;
116 			break;
117 		case 'l':
118 			lflag = 1;
119 			break;
120 		case 'm':
121 			hflag = 0;
122 			usize = 1024 * 1024;
123 			break;
124 		case 'n':
125 			nflag = 1;
126 			break;
127 		case 'P':
128 			Pflag = 1;
129 			break;
130 		case 't':
131 			if (typelist != NULL)
132 				errx(1, "only one -t option may be specified.");
133 			maketypelist(optarg);
134 			break;
135 		case '?':
136 		default:
137 			usage();
138 		}
139 
140 	if (gflag && (Pflag || iflag))
141 		errx(1, "only one of -g and -P or -i may be specified");
142 	if (Pflag && iflag)
143 		errx(1, "only one of -P and -i may be specified");
144 	if (Pflag && (hflag || (usize != 1024 && usize != 512)))
145 		errx(1, "non-standard block size incompatible with -P");
146 
147 	argc -= optind;
148 	argv += optind;
149 
150 	mntsize = getmntinfo(&mntbuf, MNT_NOWAIT);
151 	if (mntsize == 0)
152 		err(1, "retrieving information on mounted file systems");
153 
154 	if (*argv == NULL) {
155 		mntsize = regetmntinfo(&mntbuf, mntsize);
156 	} else {
157 		if ((mntbuf = malloc(argc * sizeof(*mntbuf))) == NULL)
158 			err(1, "can't allocate statvfs array");
159 		mntsize = 0;
160 		for (; *argv != NULL; argv++) {
161 			if (stat(*argv, &stbuf) < 0) {
162 				if ((mntpt = getmntpt(*argv)) == 0) {
163 					warn("%s", *argv);
164 					continue;
165 				}
166 			} else if (S_ISBLK(stbuf.st_mode)) {
167 				if ((mntpt = getmntpt(*argv)) == 0)
168 					mntpt = *argv;
169 			} else
170 				mntpt = *argv;
171 			/*
172 			 * Statfs does not take a `wait' flag, so we cannot
173 			 * implement nflag here.
174 			 */
175 			if (!statvfs(mntpt, &mntbuf[mntsize]))
176 				if (lflag &&
177 				    (mntbuf[mntsize].f_flag & MNT_LOCAL) == 0)
178 					warnx("Warning: %s is not a local %s",
179 					    *argv, "file system");
180 				else if
181 				    (!selected(mntbuf[mntsize].f_fstypename,
182 					sizeof(mntbuf[mntsize].f_fstypename)))
183 					warnx("Warning: %s mounted as a %s %s",
184 					    *argv,
185 					    mntbuf[mntsize].f_fstypename,
186 					    "file system");
187 				else
188 					++mntsize;
189 			else
190 				warn("%s", *argv);
191 		}
192 	}
193 
194 	maxwidth = 0;
195 	for (i = 0; i < mntsize; i++) {
196 		width = strlen(mntbuf[i].f_mntfromname);
197 		if (width > maxwidth)
198 			maxwidth = width;
199 	}
200 	for (i = 0; i < mntsize; i++)
201 		prtstat(&mntbuf[i], maxwidth);
202 	exit(0);
203 	/* NOTREACHED */
204 }
205 
206 char *
207 getmntpt(char *name)
208 {
209 	long mntsize, i;
210 	struct statvfs *mntbuf;
211 
212 	mntsize = getmntinfo(&mntbuf, MNT_NOWAIT);
213 	for (i = 0; i < mntsize; i++) {
214 		if (!strcmp(mntbuf[i].f_mntfromname, name))
215 			return (mntbuf[i].f_mntonname);
216 	}
217 	return (0);
218 }
219 
220 static enum { IN_LIST, NOT_IN_LIST } which;
221 
222 int
223 selected(const char *type, size_t len)
224 {
225 	char **av;
226 
227 	/* If no type specified, it's always selected. */
228 	if (typelist == NULL)
229 		return (1);
230 	for (av = typelist; *av != NULL; ++av)
231 		if (!strncmp(type, *av, len))
232 			return (which == IN_LIST ? 1 : 0);
233 	return (which == IN_LIST ? 0 : 1);
234 }
235 
236 void
237 maketypelist(char *fslist)
238 {
239 	int i;
240 	char *nextcp, **av;
241 
242 	if ((fslist == NULL) || (fslist[0] == '\0'))
243 		errx(1, "empty type list");
244 
245 	/*
246 	 * XXX
247 	 * Note: the syntax is "noxxx,yyy" for no xxx's and
248 	 * no yyy's, not the more intuitive "noyyy,noyyy".
249 	 */
250 	if (fslist[0] == 'n' && fslist[1] == 'o') {
251 		fslist += 2;
252 		which = NOT_IN_LIST;
253 	} else
254 		which = IN_LIST;
255 
256 	/* Count the number of types. */
257 	for (i = 1, nextcp = fslist;
258 	    (nextcp = strchr(nextcp, ',')) != NULL; i++)
259 		++nextcp;
260 
261 	/* Build an array of that many types. */
262 	if ((av = typelist = malloc((i + 1) * sizeof(char *))) == NULL)
263 		err(1, "can't allocate type array");
264 	av[0] = fslist;
265 	for (i = 1, nextcp = fslist;
266 	    (nextcp = strchr(nextcp, ',')) != NULL; i++) {
267 		*nextcp = '\0';
268 		av[i] = ++nextcp;
269 	}
270 	/* Terminate the array. */
271 	av[i] = NULL;
272 }
273 
274 /*
275  * Make a pass over the filesystem info in ``mntbuf'' filtering out
276  * filesystem types not in ``fsmask'' and possibly re-stating to get
277  * current (not cached) info.  Returns the new count of valid statvfs bufs.
278  */
279 long
280 regetmntinfo(struct statvfs **mntbufp, long mntsize)
281 {
282 	int i, j;
283 	struct statvfs *mntbuf;
284 
285 	if (!lflag && typelist == NULL && aflag)
286 		return (nflag ? mntsize : getmntinfo(mntbufp, MNT_WAIT));
287 
288 	mntbuf = *mntbufp;
289 	j = 0;
290 	for (i = 0; i < mntsize; i++) {
291 		if (!aflag && (mntbuf[i].f_flag & MNT_IGNORE) != 0)
292 			continue;
293 		if (lflag && (mntbuf[i].f_flag & MNT_LOCAL) == 0)
294 			continue;
295 		if (!selected(mntbuf[i].f_fstypename,
296 		    sizeof(mntbuf[i].f_fstypename)))
297 			continue;
298 		if (nflag)
299 			mntbuf[j] = mntbuf[i];
300 		else {
301 			struct statvfs layerbuf = mntbuf[i];
302 			(void)statvfs(mntbuf[i].f_mntonname, &mntbuf[j]);
303 			/*
304 			 * If the FS name changed, then new data is for
305 			 * a different layer and we don't want it.
306 			 */
307 			if (memcmp(layerbuf.f_mntfromname,
308 			    mntbuf[j].f_mntfromname, MNAMELEN))
309 				mntbuf[j] = layerbuf;
310 		}
311 		j++;
312 	}
313 	return (j);
314 }
315 
316 void
317 prthumanval(int64_t bytes, const char *pad)
318 {
319 	char buf[6];
320 
321 	humanize_number(buf, sizeof(buf) - (bytes < 0 ? 0 : 1),
322 	    bytes, "", HN_AUTOSCALE,
323 	    HN_B | HN_NOSPACE | HN_DECIMAL);
324 
325 	(void)printf("%s %6s", pad, buf);
326 }
327 
328 void
329 prthuman(struct statvfs *sfsp, int64_t used, int64_t bavail)
330 {
331 
332 	prthumanval(sfsp->f_blocks * sfsp->f_frsize, "   ");
333 	prthumanval(used * sfsp->f_frsize, "    ");
334 	prthumanval(bavail * sfsp->f_frsize, "    ");
335 }
336 
337 /*
338  * Convert statvfs returned filesystem size into BLOCKSIZE units.
339  * Attempts to avoid overflow for large filesystems.
340  */
341 #define fsbtoblk(num, fsbs, bs)					\
342 	(((fsbs) != 0 && (fsbs) < (bs)) ?			\
343 	    (int64_t)(num) / (int64_t)((bs) / (fsbs)) :		\
344 	    (int64_t)(num) * ((fsbs) / (bs)))
345 
346 /*
347  * Print out status about a filesystem.
348  */
349 void
350 prtstat(struct statvfs *sfsp, int maxwidth)
351 {
352 	static long blocksize;
353 	static int headerlen, timesthrough;
354 	static const char *header;
355 	static const char full[] = "100%";
356 	static const char empty[] = "  0%";
357 	int64_t used, availblks, inodes;
358 	int64_t bavail;
359 
360 	if (gflag) {
361 		/*
362 		 * From SunOS-5.6:
363 		 *
364 		 * /var               (/dev/dsk/c0t0d0s3 ):         8192 block size          1024 frag size
365 		 *   984242 total blocks     860692 free blocks   859708 available         249984 total files
366 		 *   248691 free files      8388611 filesys id
367 		 *      ufs fstype       0x00000004 flag             255 filename length
368 		 *
369 		 */
370 		(void)printf("%10s (%-12s): %7ld block size %12ld frag size\n",
371 		    sfsp->f_mntonname, sfsp->f_mntfromname,
372 		    sfsp->f_iosize,	/* On UFS/FFS systems this is
373 					 * also called the "optimal
374 					 * transfer block size" but it
375 					 * is of course the file
376 					 * system's block size too.
377 					 */
378 		    sfsp->f_bsize);	/* not so surprisingly the
379 					 * "fundamental file system
380 					 * block size" is the frag
381 					 * size.
382 					 */
383 		(void)printf("%10" PRId64 " total blocks %10" PRId64
384 		    " free blocks  %10" PRId64 " available\n",
385 		    (uint64_t)sfsp->f_blocks, (uint64_t)sfsp->f_bfree,
386 		    (uint64_t)sfsp->f_bavail);
387 		(void)printf("%10" PRId64 " total files  %10" PRId64
388 		    " free files %12lx filesys id\n",
389 		    (uint64_t)sfsp->f_ffree, (uint64_t)sfsp->f_files,
390 		    sfsp->f_fsid);
391 		(void)printf("%10s fstype  %#15lx flag  %17ld filename "
392 		    "length\n", sfsp->f_fstypename, sfsp->f_flag,
393 		    sfsp->f_namemax);
394 		(void)printf("%10lu owner %17" PRId64 " syncwrites %12" PRId64
395 		    " asyncwrites\n\n", (unsigned long)sfsp->f_owner,
396 		    sfsp->f_syncwrites, sfsp->f_asyncwrites);
397 
398 		/*
399 		 * a concession by the structured programming police to the
400 		 * indentation police....
401 		 */
402 		return;
403 	}
404 	if (maxwidth < 12)
405 		maxwidth = 12;
406 	if (++timesthrough == 1) {
407 		switch (blocksize = usize) {
408 		case 1024:
409 			header = Pflag ? "1024-blocks" : "1K-blocks";
410 			headerlen = strlen(header);
411 			break;
412 		case 1024 * 1024:
413 			header = "1M-blocks";
414 			headerlen = strlen(header);
415 			break;
416 		case 1024 * 1024 * 1024:
417 			header = "1G-blocks";
418 			headerlen = strlen(header);
419 			break;
420 		default:
421 			if (hflag) {
422 				header = "Size";
423 				headerlen = strlen(header);
424 			} else
425 				header = getbsize(&headerlen, &blocksize);
426 			break;
427 		}
428 		if (Pflag) {
429 			/*
430 			 * either:
431 			 *  "Filesystem 1024-blocks Used Available Capacity Mounted on\n"
432 			 * or:
433 			 *  "Filesystem 512-blocks Used Available Capacity Mounted on\n"
434 			 */
435 			(void)printf("Filesystem %s Used Available Capacity "
436 			    "Mounted on\n", header);
437 		} else {
438 			(void)printf("%-*.*s %s       Used      Avail %%Cap",
439 			    maxwidth - (headerlen - 9),
440 			    maxwidth - (headerlen - 9),
441 			    "Filesystem", header);
442 			if (iflag)
443 				(void)printf("    iUsed   iAvail %%iCap");
444 			(void)printf(" Mounted on\n");
445 		}
446 	}
447 	used = sfsp->f_blocks - sfsp->f_bfree;
448 	bavail = sfsp->f_bfree - sfsp->f_bresvd;
449 	availblks = bavail + used;
450 	if (Pflag) {
451 		assert(hflag == 0);
452 		assert(blocksize > 0);
453 		/*
454 		 * "%s %d %d %d %s %s\n", <file system name>, <total space>,
455 		 * <space used>, <space free>, <percentage used>,
456 		 * <file system root>
457 		 */
458 		(void)printf("%s %" PRId64 " %" PRId64 " %" PRId64 " %s %s\n",
459 		    sfsp->f_mntfromname,
460 		    fsbtoblk(sfsp->f_blocks, sfsp->f_bsize, blocksize),
461 		    fsbtoblk(used, sfsp->f_bsize, blocksize),
462 		    fsbtoblk(sfsp->f_bavail, sfsp->f_bsize, blocksize),
463 		    availblks == 0 ? full : strpct64((uint64_t) used,
464 		    (uint64_t) availblks, 0), sfsp->f_mntonname);
465 		/*
466 		 * another concession by the structured programming police to
467 		 * the indentation police....
468 		 *
469 		 * Note iflag cannot be set when Pflag is set.
470 		 */
471 		return;
472 	}
473 
474 	(void)printf("%-*.*s", maxwidth, maxwidth, sfsp->f_mntfromname);
475 
476 	if (hflag)
477 		prthuman(sfsp, used, bavail);
478 	else
479 		(void)printf("%10" PRId64 " %10" PRId64 " %10" PRId64,
480 		    fsbtoblk(sfsp->f_blocks, sfsp->f_frsize, blocksize),
481 		    fsbtoblk(used, sfsp->f_frsize, blocksize),
482 		    fsbtoblk(bavail, sfsp->f_frsize, blocksize));
483 	(void)printf(" %4s",
484 	    availblks == 0 ? full :
485 	    /* We know that these values are never negative */
486 	    strpct64((uint64_t)used, (uint64_t)availblks, 0));
487 	if (iflag) {
488 		inodes = sfsp->f_files;
489 		used = inodes - sfsp->f_ffree;
490 		(void)printf(" %8ld %8ld %4s",
491 		    (u_long)used, (u_long)sfsp->f_ffree,
492 		    inodes == 0 ? (used == 0 ? empty : full) :
493 		    strpct64((uint64_t)used, (uint64_t)inodes, 0));
494 	}
495 	(void)printf(" %s\n", sfsp->f_mntonname);
496 }
497 
498 void
499 usage(void)
500 {
501 
502 	(void)fprintf(stderr,
503 	    "Usage: %s [-aGgln] [-hkm|-ihkm|-Pk] [-t type] [file | "
504 	    "file_system ...]\n",
505 	    getprogname());
506 	exit(1);
507 	/* NOTREACHED */
508 }
509 
510 const char *
511 strpct64(uint64_t numerator, uint64_t denominator, u_int digits)
512 {
513 
514 	while (denominator > ULONG_MAX) {
515 		numerator >>= 1;
516 		denominator >>= 1;
517 	}
518 	return (strpct((u_long)numerator, (u_long)denominator, digits));
519 }
520