xref: /freebsd/sbin/dumpfs/dumpfs.c (revision 8e9740b62e950b40dcf7dbe729855be14450d40d)
1 /*
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2009 Robert N. M. Watson
5  * All rights reserved.
6  *
7  * This software was developed at the University of Cambridge Computer
8  * Laboratory with support from a grant from Google, Inc.
9  *
10  * Copyright (c) 2002 Networks Associates Technology, Inc.
11  * All rights reserved.
12  *
13  * This software was developed for the FreeBSD Project by Marshall
14  * Kirk McKusick and Network Associates Laboratories, the Security
15  * Research Division of Network Associates, Inc. under DARPA/SPAWAR
16  * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
17  * research program.
18  *
19  * Copyright (c) 1983, 1992, 1993
20  *	The Regents of the University of California.  All rights reserved.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the above copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. Neither the name of the University nor the names of its contributors
31  *    may be used to endorse or promote products derived from this software
32  *    without specific prior written permission.
33  *
34  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
35  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  */
46 
47 #ifndef lint
48 static const char copyright[] =
49 "@(#) Copyright (c) 1983, 1992, 1993\n\
50 	The Regents of the University of California.  All rights reserved.\n";
51 #endif /* not lint */
52 
53 #ifndef lint
54 #if 0
55 static char sccsid[] = "@(#)dumpfs.c	8.5 (Berkeley) 4/29/95";
56 #endif
57 static const char rcsid[] =
58   "$FreeBSD$";
59 #endif /* not lint */
60 
61 #include <sys/param.h>
62 #include <sys/time.h>
63 #include <sys/disklabel.h>
64 
65 #include <ufs/ufs/dinode.h>
66 #include <ufs/ffs/fs.h>
67 
68 #include <err.h>
69 #include <errno.h>
70 #include <fcntl.h>
71 #include <fstab.h>
72 #include <libufs.h>
73 #include <paths.h>
74 #include <stdint.h>
75 #include <stdio.h>
76 #include <stdlib.h>
77 #include <unistd.h>
78 
79 #define	afs	disk.d_fs
80 #define	acg	disk.d_cg
81 
82 static struct uufsd disk;
83 
84 static int	dumpfs(const char *, int);
85 static int	dumpfsid(void);
86 static int	dumpcg(void);
87 static int	dumpfreespace(const char *, int);
88 static void	dumpfreespacecg(int);
89 static int	marshal(const char *);
90 static void	pbits(void *, int);
91 static void	pblklist(void *, int, off_t, int);
92 static void	ufserr(const char *);
93 static void	usage(void) __dead2;
94 
95 int
96 main(int argc, char *argv[])
97 {
98 	const char *name;
99 	int ch, dofreespace, domarshal, dolabel, dosb, eval;
100 
101 	dofreespace = domarshal = dolabel = dosb = eval = 0;
102 
103 	while ((ch = getopt(argc, argv, "lfms")) != -1) {
104 		switch (ch) {
105 		case 'f':
106 			dofreespace++;
107 			break;
108 		case 'm':
109 			domarshal = 1;
110 			break;
111 		case 'l':
112 			dolabel = 1;
113 			break;
114 		case 's':
115 			dosb = 1;
116 			break;
117 		case '?':
118 		default:
119 			usage();
120 		}
121 	}
122 	argc -= optind;
123 	argv += optind;
124 
125 	if (argc < 1)
126 		usage();
127 	if (dofreespace && domarshal)
128 		usage();
129 	if (dofreespace > 2)
130 		usage();
131 
132 	while ((name = *argv++) != NULL) {
133 		if (ufs_disk_fillout(&disk, name) == -1) {
134 			ufserr(name);
135 			eval |= 1;
136 			continue;
137 		}
138 		if (dofreespace)
139 			eval |= dumpfreespace(name, dofreespace);
140 		else if (domarshal)
141 			eval |= marshal(name);
142 		else if (dolabel)
143 			eval |= dumpfsid();
144 		else
145 			eval |= dumpfs(name, dosb);
146 		ufs_disk_close(&disk);
147 	}
148 	exit(eval);
149 }
150 
151 static int
152 dumpfsid(void)
153 {
154 
155 	printf("%sufsid/%08x%08x\n", _PATH_DEV, afs.fs_id[0], afs.fs_id[1]);
156 	return 0;
157 }
158 
159 static int
160 dumpfs(const char *name, int dosb)
161 {
162 	time_t fstime, fsmtime;
163 	int64_t fssize;
164 	int32_t fsflags;
165 	int i;
166 
167 	switch (disk.d_ufs) {
168 	case 2:
169 		fssize = afs.fs_size;
170 		fstime = afs.fs_time;
171 		fsmtime = afs.fs_mtime;
172 		printf("magic\t%x (UFS2)\n", afs.fs_magic);
173 		printf("last mounted time\t%s", ctime(&fsmtime));
174 		printf("last modified time\t%s", ctime(&fstime));
175 		printf("superblock location\t%jd\tid\t[ %08x %08x ]\n",
176 		    (intmax_t)afs.fs_sblockloc, afs.fs_id[0], afs.fs_id[1]);
177 		printf("ncg\t%d\tsize\t%jd\tblocks\t%jd\n",
178 		    afs.fs_ncg, (intmax_t)fssize, (intmax_t)afs.fs_dsize);
179 		break;
180 	case 1:
181 		fssize = afs.fs_old_size;
182 		fstime = afs.fs_old_time;
183 		printf("magic\t%x (UFS1)\ttime\t%s",
184 		    afs.fs_magic, ctime(&fstime));
185 		printf("id\t[ %08x %08x ]\n", afs.fs_id[0], afs.fs_id[1]);
186 		printf("ncg\t%d\tsize\t%jd\tblocks\t%jd\n",
187 		    afs.fs_ncg, (intmax_t)fssize, (intmax_t)afs.fs_dsize);
188 		break;
189 	default:
190 		goto err;
191 	}
192 	printf("bsize\t%d\tshift\t%d\tmask\t0x%08x\n",
193 	    afs.fs_bsize, afs.fs_bshift, afs.fs_bmask);
194 	printf("fsize\t%d\tshift\t%d\tmask\t0x%08x\n",
195 	    afs.fs_fsize, afs.fs_fshift, afs.fs_fmask);
196 	printf("frag\t%d\tshift\t%d\tfsbtodb\t%d\n",
197 	    afs.fs_frag, afs.fs_fragshift, afs.fs_fsbtodb);
198 	printf("minfree\t%d%%\toptim\t%s\tsymlinklen %d\n",
199 	    afs.fs_minfree, afs.fs_optim == FS_OPTSPACE ? "space" : "time",
200 	    afs.fs_maxsymlinklen);
201 	switch (disk.d_ufs) {
202 	case 2:
203 		printf("%s %d\tmaxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
204 		    "maxbsize", afs.fs_maxbsize, afs.fs_maxbpg,
205 		    afs.fs_maxcontig, afs.fs_contigsumsize);
206 		printf("nbfree\t%jd\tndir\t%jd\tnifree\t%jd\tnffree\t%jd\n",
207 		    (intmax_t)afs.fs_cstotal.cs_nbfree,
208 		    (intmax_t)afs.fs_cstotal.cs_ndir,
209 		    (intmax_t)afs.fs_cstotal.cs_nifree,
210 		    (intmax_t)afs.fs_cstotal.cs_nffree);
211 		printf("bpg\t%d\tfpg\t%d\tipg\t%d\tunrefs\t%jd\n",
212 		    afs.fs_fpg / afs.fs_frag, afs.fs_fpg, afs.fs_ipg,
213 		    (intmax_t)afs.fs_unrefs);
214 		printf("nindir\t%d\tinopb\t%d\tmaxfilesize\t%ju\n",
215 		    afs.fs_nindir, afs.fs_inopb,
216 		    (uintmax_t)afs.fs_maxfilesize);
217 		printf("sbsize\t%d\tcgsize\t%d\tcsaddr\t%jd\tcssize\t%d\n",
218 		    afs.fs_sbsize, afs.fs_cgsize, (intmax_t)afs.fs_csaddr,
219 		    afs.fs_cssize);
220 		break;
221 	case 1:
222 		printf("maxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
223 		    afs.fs_maxbpg, afs.fs_maxcontig, afs.fs_contigsumsize);
224 		printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
225 		    afs.fs_old_cstotal.cs_nbfree, afs.fs_old_cstotal.cs_ndir,
226 		    afs.fs_old_cstotal.cs_nifree, afs.fs_old_cstotal.cs_nffree);
227 		printf("cpg\t%d\tbpg\t%d\tfpg\t%d\tipg\t%d\n",
228 		    afs.fs_old_cpg, afs.fs_fpg / afs.fs_frag, afs.fs_fpg,
229 		    afs.fs_ipg);
230 		printf("nindir\t%d\tinopb\t%d\tnspf\t%d\tmaxfilesize\t%ju\n",
231 		    afs.fs_nindir, afs.fs_inopb, afs.fs_old_nspf,
232 		    (uintmax_t)afs.fs_maxfilesize);
233 		printf("sbsize\t%d\tcgsize\t%d\tcgoffset %d\tcgmask\t0x%08x\n",
234 		    afs.fs_sbsize, afs.fs_cgsize, afs.fs_old_cgoffset,
235 		    afs.fs_old_cgmask);
236 		printf("csaddr\t%d\tcssize\t%d\n",
237 		    afs.fs_old_csaddr, afs.fs_cssize);
238 		printf("rotdelay %dms\trps\t%d\ttrackskew %d\tinterleave %d\n",
239 		    afs.fs_old_rotdelay, afs.fs_old_rps, afs.fs_old_trackskew,
240 		    afs.fs_old_interleave);
241 		printf("nsect\t%d\tnpsect\t%d\tspc\t%d\n",
242 		    afs.fs_old_nsect, afs.fs_old_npsect, afs.fs_old_spc);
243 		break;
244 	default:
245 		goto err;
246 	}
247 	printf("sblkno\t%d\tcblkno\t%d\tiblkno\t%d\tdblkno\t%d\n",
248 	    afs.fs_sblkno, afs.fs_cblkno, afs.fs_iblkno, afs.fs_dblkno);
249 	printf("cgrotor\t%d\tfmod\t%d\tronly\t%d\tclean\t%d\n",
250 	    afs.fs_cgrotor, afs.fs_fmod, afs.fs_ronly, afs.fs_clean);
251 	printf("metaspace %jd\tavgfpdir %d\tavgfilesize %d\n",
252 	    afs.fs_metaspace, afs.fs_avgfpdir, afs.fs_avgfilesize);
253 	printf("flags\t");
254 	if (afs.fs_old_flags & FS_FLAGS_UPDATED)
255 		fsflags = afs.fs_flags;
256 	else
257 		fsflags = afs.fs_old_flags;
258 	if (fsflags == 0)
259 		printf("none");
260 	if (fsflags & FS_UNCLEAN)
261 		printf("unclean ");
262 	if (fsflags & FS_DOSOFTDEP)
263 		printf("soft-updates%s ", (fsflags & FS_SUJ) ? "+journal" : "");
264 	if (fsflags & FS_NEEDSFSCK)
265 		printf("needs-fsck-run ");
266 	if (fsflags & FS_INDEXDIRS)
267 		printf("indexed-directories ");
268 	if (fsflags & FS_ACLS)
269 		printf("acls ");
270 	if (fsflags & FS_MULTILABEL)
271 		printf("multilabel ");
272 	if (fsflags & FS_GJOURNAL)
273 		printf("gjournal ");
274 	if (fsflags & FS_FLAGS_UPDATED)
275 		printf("fs_flags-expanded ");
276 	if (fsflags & FS_NFS4ACLS)
277 		printf("nfsv4acls ");
278 	if (fsflags & FS_TRIM)
279 		printf("trim ");
280 	fsflags &= ~(FS_UNCLEAN | FS_DOSOFTDEP | FS_NEEDSFSCK | FS_METACKHASH |
281 		     FS_ACLS | FS_MULTILABEL | FS_GJOURNAL | FS_FLAGS_UPDATED |
282 		     FS_NFS4ACLS | FS_SUJ | FS_TRIM | FS_INDEXDIRS);
283 	if (fsflags != 0)
284 		printf("unknown-flags (%#x)", fsflags);
285 	putchar('\n');
286 	if (afs.fs_flags & FS_METACKHASH) {
287 		printf("check hashes\t");
288 		fsflags = afs.fs_metackhash;
289 		if (fsflags == 0)
290 			printf("none");
291 		if (fsflags & CK_SUPERBLOCK)
292 			printf("superblock ");
293 		if (fsflags & CK_CYLGRP)
294 			printf("cylinder-groups ");
295 		if (fsflags & CK_INODE)
296 			printf("inodes ");
297 		if (fsflags & CK_INDIR)
298 			printf("indirect-blocks ");
299 		if (fsflags & CK_DIR)
300 			printf("directories ");
301 	}
302 	fsflags &= ~(CK_SUPERBLOCK | CK_CYLGRP | CK_INODE | CK_INDIR | CK_DIR);
303 	if (fsflags != 0)
304 		printf("unknown flags (%#x)", fsflags);
305 	putchar('\n');
306 	printf("fsmnt\t%s\n", afs.fs_fsmnt);
307 	printf("volname\t%s\tswuid\t%ju\tprovidersize\t%ju\n",
308 		afs.fs_volname, (uintmax_t)afs.fs_swuid,
309 		(uintmax_t)afs.fs_providersize);
310 	printf("\ncs[].cs_(nbfree,ndir,nifree,nffree):\n\t");
311 	afs.fs_csp = calloc(1, afs.fs_cssize);
312 	if (bread(&disk, fsbtodb(&afs, afs.fs_csaddr), afs.fs_csp, afs.fs_cssize) == -1)
313 		goto err;
314 	for (i = 0; i < afs.fs_ncg; i++) {
315 		struct csum *cs = &afs.fs_cs(&afs, i);
316 		if (i && i % 4 == 0)
317 			printf("\n\t");
318 		printf("(%d,%d,%d,%d) ",
319 		    cs->cs_nbfree, cs->cs_ndir, cs->cs_nifree, cs->cs_nffree);
320 	}
321 	printf("\n");
322 	if (fssize % afs.fs_fpg) {
323 		if (disk.d_ufs == 1)
324 			printf("cylinders in last group %d\n",
325 			    howmany(afs.fs_old_size % afs.fs_fpg,
326 			    afs.fs_old_spc / afs.fs_old_nspf));
327 		printf("blocks in last group %ld\n\n",
328 		    (long)((fssize % afs.fs_fpg) / afs.fs_frag));
329 	}
330 	if (dosb)
331 		return (0);
332 	while ((i = cgread(&disk)) != 0) {
333 		if (i == -1 || dumpcg())
334 			goto err;
335 	}
336 	return (0);
337 
338 err:	ufserr(name);
339 	return (1);
340 }
341 
342 static int
343 dumpcg(void)
344 {
345 	time_t cgtime;
346 	off_t cur;
347 	int i, j;
348 
349 	printf("\ncg %d:\n", disk.d_lcg);
350 	cur = fsbtodb(&afs, cgtod(&afs, disk.d_lcg)) * disk.d_bsize;
351 	switch (disk.d_ufs) {
352 	case 2:
353 		cgtime = acg.cg_time;
354 		printf("magic\t%x\ttell\t%jx\ttime\t%s",
355 		    acg.cg_magic, (intmax_t)cur, ctime(&cgtime));
356 		printf("cgx\t%d\tndblk\t%d\tniblk\t%d\tinitiblk %d\tunrefs %d\n",
357 		    acg.cg_cgx, acg.cg_ndblk, acg.cg_niblk, acg.cg_initediblk,
358 		    acg.cg_unrefs);
359 		break;
360 	case 1:
361 		cgtime = acg.cg_old_time;
362 		printf("magic\t%x\ttell\t%jx\ttime\t%s",
363 		    acg.cg_magic, (intmax_t)cur, ctime(&cgtime));
364 		printf("cgx\t%d\tncyl\t%d\tniblk\t%d\tndblk\t%d\n",
365 		    acg.cg_cgx, acg.cg_old_ncyl, acg.cg_old_niblk,
366 		    acg.cg_ndblk);
367 		break;
368 	default:
369 		break;
370 	}
371 	printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
372 	    acg.cg_cs.cs_nbfree, acg.cg_cs.cs_ndir,
373 	    acg.cg_cs.cs_nifree, acg.cg_cs.cs_nffree);
374 	printf("rotor\t%d\tirotor\t%d\tfrotor\t%d\nfrsum",
375 	    acg.cg_rotor, acg.cg_irotor, acg.cg_frotor);
376 	for (i = 1, j = 0; i < afs.fs_frag; i++) {
377 		printf("\t%d", acg.cg_frsum[i]);
378 		j += i * acg.cg_frsum[i];
379 	}
380 	printf("\nsum of frsum: %d", j);
381 	if (afs.fs_contigsumsize > 0) {
382 		for (i = 1; i < afs.fs_contigsumsize; i++) {
383 			if ((i - 1) % 8 == 0)
384 				printf("\nclusters %d-%d:", i,
385 				    MIN(afs.fs_contigsumsize - 1, i + 7));
386 			printf("\t%d", cg_clustersum(&acg)[i]);
387 		}
388 		printf("\nclusters size %d and over: %d\n",
389 		    afs.fs_contigsumsize,
390 		    cg_clustersum(&acg)[afs.fs_contigsumsize]);
391 		printf("clusters free:\t");
392 		pbits(cg_clustersfree(&acg), acg.cg_nclusterblks);
393 	} else
394 		printf("\n");
395 	printf("inodes used:\t");
396 	pbits(cg_inosused(&acg), afs.fs_ipg);
397 	printf("blks free:\t");
398 	pbits(cg_blksfree(&acg), afs.fs_fpg);
399 	return (0);
400 }
401 
402 static int
403 dumpfreespace(const char *name, int fflag)
404 {
405 	int i;
406 
407 	while ((i = cgread(&disk)) != 0) {
408 		if (i == -1)
409 			goto err;
410 		dumpfreespacecg(fflag);
411 	}
412 	return (0);
413 err:
414 	ufserr(name);
415 	return (1);
416 }
417 
418 static void
419 dumpfreespacecg(int fflag)
420 {
421 
422 	pblklist(cg_blksfree(&acg), afs.fs_fpg, disk.d_lcg * afs.fs_fpg,
423 	    fflag);
424 }
425 
426 static int
427 marshal(const char *name)
428 {
429 	struct fs *fs;
430 
431 	fs = &disk.d_fs;
432 
433 	printf("# newfs command for %s (%s)\n", name, disk.d_name);
434 	printf("newfs ");
435 	if (fs->fs_volname[0] != '\0')
436 		printf("-L %s ", fs->fs_volname);
437 	printf("-O %d ", disk.d_ufs);
438 	if (fs->fs_flags & FS_DOSOFTDEP)
439 		printf("-U ");
440 	printf("-a %d ", fs->fs_maxcontig);
441 	printf("-b %d ", fs->fs_bsize);
442 	/* -c is dumb */
443 	printf("-d %d ", fs->fs_maxbsize);
444 	printf("-e %d ", fs->fs_maxbpg);
445 	printf("-f %d ", fs->fs_fsize);
446 	printf("-g %d ", fs->fs_avgfilesize);
447 	printf("-h %d ", fs->fs_avgfpdir);
448 	printf("-i %jd ", fragroundup(fs, lblktosize(fs, fragstoblks(fs,
449 	    fs->fs_fpg)) / fs->fs_ipg));
450 	if (fs->fs_flags & FS_SUJ)
451 		printf("-j ");
452 	if (fs->fs_flags & FS_GJOURNAL)
453 		printf("-J ");
454 	printf("-k %jd ", fs->fs_metaspace);
455 	if (fs->fs_flags & FS_MULTILABEL)
456 		printf("-l ");
457 	printf("-m %d ", fs->fs_minfree);
458 	/* -n unimplemented */
459 	printf("-o ");
460 	switch (fs->fs_optim) {
461 	case FS_OPTSPACE:
462 		printf("space ");
463 		break;
464 	case FS_OPTTIME:
465 		printf("time ");
466 		break;
467 	default:
468 		printf("unknown ");
469 		break;
470 	}
471 	/* -p..r unimplemented */
472 	printf("-s %jd ", (intmax_t)fsbtodb(fs, fs->fs_size));
473 	if (fs->fs_flags & FS_TRIM)
474 		printf("-t ");
475 	printf("%s ", disk.d_name);
476 	printf("\n");
477 
478 	return 0;
479 }
480 
481 static void
482 pbits(void *vp, int max)
483 {
484 	int i;
485 	char *p;
486 	int count, j;
487 
488 	for (count = i = 0, p = vp; i < max; i++)
489 		if (isset(p, i)) {
490 			if (count)
491 				printf(",%s", count % 6 ? " " : "\n\t");
492 			count++;
493 			printf("%d", i);
494 			j = i;
495 			while ((i+1)<max && isset(p, i+1))
496 				i++;
497 			if (i != j)
498 				printf("-%d", i);
499 		}
500 	printf("\n");
501 }
502 
503 static void
504 pblklist(void *vp, int max, off_t offset, int fflag)
505 {
506 	int i, j;
507 	char *p;
508 
509 	for (i = 0, p = vp; i < max; i++) {
510 		if (isset(p, i)) {
511 			printf("%jd", (intmax_t)(i + offset));
512 			if (fflag < 2) {
513 				j = i;
514 				while ((i+1)<max && isset(p, i+1))
515 					i++;
516 				if (i != j)
517 					printf("-%jd", (intmax_t)(i + offset));
518 			}
519 			printf("\n");
520 		}
521 	}
522 }
523 
524 static void
525 ufserr(const char *name)
526 {
527 	if (disk.d_error != NULL)
528 		warnx("%s: %s", name, disk.d_error);
529 	else if (errno)
530 		warn("%s", name);
531 }
532 
533 static void
534 usage(void)
535 {
536 	(void)fprintf(stderr, "usage: dumpfs [-flm] filesys | device\n");
537 	exit(1);
538 }
539