xref: /freebsd/sbin/dumpfs/dumpfs.c (revision cbd1e83154af8bae3daa3919bb2746d587436515)
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_blank(&disk, name) == -1) {
134 			ufserr(name);
135 			eval |= 1;
136 			continue;
137 		}
138 		disk.d_lookupflags |= UFS_NOHASHFAIL;
139 		if (sbread(&disk) == -1) {
140 			ufserr(name);
141 			eval |= 1;
142 			continue;
143 		}
144 		if (dofreespace)
145 			eval |= dumpfreespace(name, dofreespace);
146 		else if (domarshal)
147 			eval |= marshal(name);
148 		else if (dolabel)
149 			eval |= dumpfsid();
150 		else
151 			eval |= dumpfs(name, dosb);
152 		ufs_disk_close(&disk);
153 	}
154 	exit(eval);
155 }
156 
157 static int
158 dumpfsid(void)
159 {
160 
161 	printf("%sufsid/%08x%08x\n", _PATH_DEV, afs.fs_id[0], afs.fs_id[1]);
162 	return 0;
163 }
164 
165 static int
166 dumpfs(const char *name, int dosb)
167 {
168 	time_t fstime, fsmtime;
169 	int64_t fssize;
170 	int32_t fsflags;
171 	int i;
172 
173 	switch (disk.d_ufs) {
174 	case 2:
175 		fssize = afs.fs_size;
176 		fstime = afs.fs_time;
177 		fsmtime = afs.fs_mtime;
178 		printf("magic\t%x (UFS2)\n", afs.fs_magic);
179 		printf("last mounted time\t%s", ctime(&fsmtime));
180 		printf("last modified time\t%s", ctime(&fstime));
181 		printf("superblock location\t%jd\tid\t[ %08x %08x ]\n",
182 		    (intmax_t)afs.fs_sblockloc, afs.fs_id[0], afs.fs_id[1]);
183 		printf("ncg\t%d\tsize\t%jd\tblocks\t%jd\n",
184 		    afs.fs_ncg, (intmax_t)fssize, (intmax_t)afs.fs_dsize);
185 		break;
186 	case 1:
187 		fssize = afs.fs_old_size;
188 		fstime = afs.fs_old_time;
189 		printf("magic\t%x (UFS1)\ttime\t%s",
190 		    afs.fs_magic, ctime(&fstime));
191 		printf("id\t[ %08x %08x ]\n", afs.fs_id[0], afs.fs_id[1]);
192 		printf("ncg\t%d\tsize\t%jd\tblocks\t%jd\n",
193 		    afs.fs_ncg, (intmax_t)fssize, (intmax_t)afs.fs_dsize);
194 		break;
195 	default:
196 		goto err;
197 	}
198 	printf("bsize\t%d\tshift\t%d\tmask\t0x%08x\n",
199 	    afs.fs_bsize, afs.fs_bshift, afs.fs_bmask);
200 	printf("fsize\t%d\tshift\t%d\tmask\t0x%08x\n",
201 	    afs.fs_fsize, afs.fs_fshift, afs.fs_fmask);
202 	printf("frag\t%d\tshift\t%d\tfsbtodb\t%d\n",
203 	    afs.fs_frag, afs.fs_fragshift, afs.fs_fsbtodb);
204 	printf("minfree\t%d%%\toptim\t%s\tsymlinklen %d\n",
205 	    afs.fs_minfree, afs.fs_optim == FS_OPTSPACE ? "space" : "time",
206 	    afs.fs_maxsymlinklen);
207 	switch (disk.d_ufs) {
208 	case 2:
209 		printf("%s %d\tmaxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
210 		    "maxbsize", afs.fs_maxbsize, afs.fs_maxbpg,
211 		    afs.fs_maxcontig, afs.fs_contigsumsize);
212 		printf("nbfree\t%jd\tndir\t%jd\tnifree\t%jd\tnffree\t%jd\n",
213 		    (intmax_t)afs.fs_cstotal.cs_nbfree,
214 		    (intmax_t)afs.fs_cstotal.cs_ndir,
215 		    (intmax_t)afs.fs_cstotal.cs_nifree,
216 		    (intmax_t)afs.fs_cstotal.cs_nffree);
217 		printf("bpg\t%d\tfpg\t%d\tipg\t%d\tunrefs\t%jd\n",
218 		    afs.fs_fpg / afs.fs_frag, afs.fs_fpg, afs.fs_ipg,
219 		    (intmax_t)afs.fs_unrefs);
220 		printf("nindir\t%d\tinopb\t%d\tmaxfilesize\t%ju\n",
221 		    afs.fs_nindir, afs.fs_inopb,
222 		    (uintmax_t)afs.fs_maxfilesize);
223 		printf("sbsize\t%d\tcgsize\t%d\tcsaddr\t%jd\tcssize\t%d\n",
224 		    afs.fs_sbsize, afs.fs_cgsize, (intmax_t)afs.fs_csaddr,
225 		    afs.fs_cssize);
226 		break;
227 	case 1:
228 		printf("maxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
229 		    afs.fs_maxbpg, afs.fs_maxcontig, afs.fs_contigsumsize);
230 		printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
231 		    afs.fs_old_cstotal.cs_nbfree, afs.fs_old_cstotal.cs_ndir,
232 		    afs.fs_old_cstotal.cs_nifree, afs.fs_old_cstotal.cs_nffree);
233 		printf("cpg\t%d\tbpg\t%d\tfpg\t%d\tipg\t%d\n",
234 		    afs.fs_old_cpg, afs.fs_fpg / afs.fs_frag, afs.fs_fpg,
235 		    afs.fs_ipg);
236 		printf("nindir\t%d\tinopb\t%d\tnspf\t%d\tmaxfilesize\t%ju\n",
237 		    afs.fs_nindir, afs.fs_inopb, afs.fs_old_nspf,
238 		    (uintmax_t)afs.fs_maxfilesize);
239 		printf("sbsize\t%d\tcgsize\t%d\tcgoffset %d\tcgmask\t0x%08x\n",
240 		    afs.fs_sbsize, afs.fs_cgsize, afs.fs_old_cgoffset,
241 		    afs.fs_old_cgmask);
242 		printf("csaddr\t%jd\tcssize\t%d\n",
243 		    (intmax_t)afs.fs_csaddr, afs.fs_cssize);
244 		printf("rotdelay %dms\trps\t%d\ttrackskew %d\tinterleave %d\n",
245 		    afs.fs_old_rotdelay, afs.fs_old_rps, afs.fs_old_trackskew,
246 		    afs.fs_old_interleave);
247 		printf("nsect\t%d\tnpsect\t%d\tspc\t%d\n",
248 		    afs.fs_old_nsect, afs.fs_old_npsect, afs.fs_old_spc);
249 		break;
250 	default:
251 		goto err;
252 	}
253 	printf("sblkno\t%d\tcblkno\t%d\tiblkno\t%d\tdblkno\t%d\n",
254 	    afs.fs_sblkno, afs.fs_cblkno, afs.fs_iblkno, afs.fs_dblkno);
255 	printf("cgrotor\t%d\tfmod\t%d\tronly\t%d\tclean\t%d\n",
256 	    afs.fs_cgrotor, afs.fs_fmod, afs.fs_ronly, afs.fs_clean);
257 	printf("metaspace %jd\tavgfpdir %d\tavgfilesize %d\n",
258 	    afs.fs_metaspace, afs.fs_avgfpdir, afs.fs_avgfilesize);
259 	printf("flags\t");
260 	if (afs.fs_old_flags & FS_FLAGS_UPDATED)
261 		fsflags = afs.fs_flags;
262 	else
263 		fsflags = afs.fs_old_flags;
264 	if (fsflags == 0)
265 		printf("none");
266 	if (fsflags & FS_UNCLEAN)
267 		printf("unclean ");
268 	if (fsflags & FS_DOSOFTDEP)
269 		printf("soft-updates%s ", (fsflags & FS_SUJ) ? "+journal" : "");
270 	if (fsflags & FS_NEEDSFSCK)
271 		printf("needs-fsck-run ");
272 	if (fsflags & FS_INDEXDIRS)
273 		printf("indexed-directories ");
274 	if (fsflags & FS_ACLS)
275 		printf("acls ");
276 	if (fsflags & FS_MULTILABEL)
277 		printf("multilabel ");
278 	if (fsflags & FS_GJOURNAL)
279 		printf("gjournal ");
280 	if (fsflags & FS_FLAGS_UPDATED)
281 		printf("fs_flags-expanded ");
282 	if (fsflags & FS_NFS4ACLS)
283 		printf("nfsv4acls ");
284 	if (fsflags & FS_TRIM)
285 		printf("trim ");
286 	fsflags &= ~(FS_UNCLEAN | FS_DOSOFTDEP | FS_NEEDSFSCK | FS_METACKHASH |
287 		     FS_ACLS | FS_MULTILABEL | FS_GJOURNAL | FS_FLAGS_UPDATED |
288 		     FS_NFS4ACLS | FS_SUJ | FS_TRIM | FS_INDEXDIRS);
289 	if (fsflags != 0)
290 		printf("unknown-flags (%#x)", fsflags);
291 	putchar('\n');
292 	if (afs.fs_flags & FS_METACKHASH) {
293 		printf("check hashes\t");
294 		fsflags = afs.fs_metackhash;
295 		if (fsflags == 0)
296 			printf("none");
297 		if (fsflags & CK_SUPERBLOCK)
298 			printf("superblock ");
299 		if (fsflags & CK_CYLGRP)
300 			printf("cylinder-groups ");
301 		if (fsflags & CK_INODE)
302 			printf("inodes ");
303 		if (fsflags & CK_INDIR)
304 			printf("indirect-blocks ");
305 		if (fsflags & CK_DIR)
306 			printf("directories ");
307 	}
308 	fsflags &= ~(CK_SUPERBLOCK | CK_CYLGRP | CK_INODE | CK_INDIR | CK_DIR);
309 	if (fsflags != 0)
310 		printf("unknown flags (%#x)", fsflags);
311 	putchar('\n');
312 	printf("fsmnt\t%s\n", afs.fs_fsmnt);
313 	printf("volname\t%s\tswuid\t%ju\tprovidersize\t%ju\n",
314 		afs.fs_volname, (uintmax_t)afs.fs_swuid,
315 		(uintmax_t)afs.fs_providersize);
316 	printf("\ncs[].cs_(nbfree,ndir,nifree,nffree):\n\t");
317 	for (i = 0; i < afs.fs_ncg; i++) {
318 		struct csum *cs = &afs.fs_cs(&afs, i);
319 		if (i && i % 4 == 0)
320 			printf("\n\t");
321 		printf("(%d,%d,%d,%d) ",
322 		    cs->cs_nbfree, cs->cs_ndir, cs->cs_nifree, cs->cs_nffree);
323 	}
324 	printf("\n");
325 	if (fssize % afs.fs_fpg) {
326 		if (disk.d_ufs == 1)
327 			printf("cylinders in last group %d\n",
328 			    howmany(afs.fs_old_size % afs.fs_fpg,
329 			    afs.fs_old_spc / afs.fs_old_nspf));
330 		printf("blocks in last group %ld\n\n",
331 		    (long)((fssize % afs.fs_fpg) / afs.fs_frag));
332 	}
333 	if (dosb)
334 		return (0);
335 	while ((i = cgread(&disk)) != 0) {
336 		if (i == -1 || dumpcg())
337 			goto err;
338 	}
339 	return (0);
340 
341 err:	ufserr(name);
342 	return (1);
343 }
344 
345 static int
346 dumpcg(void)
347 {
348 	time_t cgtime;
349 	off_t cur;
350 	int i, j;
351 
352 	printf("\ncg %d:\n", disk.d_lcg);
353 	cur = fsbtodb(&afs, cgtod(&afs, disk.d_lcg)) * disk.d_bsize;
354 	switch (disk.d_ufs) {
355 	case 2:
356 		cgtime = acg.cg_time;
357 		printf("magic\t%x\ttell\t%jx\ttime\t%s",
358 		    acg.cg_magic, (intmax_t)cur, ctime(&cgtime));
359 		printf("cgx\t%d\tndblk\t%d\tniblk\t%d\tinitiblk %d\tunrefs %d\n",
360 		    acg.cg_cgx, acg.cg_ndblk, acg.cg_niblk, acg.cg_initediblk,
361 		    acg.cg_unrefs);
362 		break;
363 	case 1:
364 		cgtime = acg.cg_old_time;
365 		printf("magic\t%x\ttell\t%jx\ttime\t%s",
366 		    acg.cg_magic, (intmax_t)cur, ctime(&cgtime));
367 		printf("cgx\t%d\tncyl\t%d\tniblk\t%d\tndblk\t%d\n",
368 		    acg.cg_cgx, acg.cg_old_ncyl, acg.cg_old_niblk,
369 		    acg.cg_ndblk);
370 		break;
371 	default:
372 		break;
373 	}
374 	printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
375 	    acg.cg_cs.cs_nbfree, acg.cg_cs.cs_ndir,
376 	    acg.cg_cs.cs_nifree, acg.cg_cs.cs_nffree);
377 	printf("rotor\t%d\tirotor\t%d\tfrotor\t%d\nfrsum",
378 	    acg.cg_rotor, acg.cg_irotor, acg.cg_frotor);
379 	for (i = 1, j = 0; i < afs.fs_frag; i++) {
380 		printf("\t%d", acg.cg_frsum[i]);
381 		j += i * acg.cg_frsum[i];
382 	}
383 	printf("\nsum of frsum: %d", j);
384 	if (afs.fs_contigsumsize > 0) {
385 		for (i = 1; i < afs.fs_contigsumsize; i++) {
386 			if ((i - 1) % 8 == 0)
387 				printf("\nclusters %d-%d:", i,
388 				    MIN(afs.fs_contigsumsize - 1, i + 7));
389 			printf("\t%d", cg_clustersum(&acg)[i]);
390 		}
391 		printf("\nclusters size %d and over: %d\n",
392 		    afs.fs_contigsumsize,
393 		    cg_clustersum(&acg)[afs.fs_contigsumsize]);
394 		printf("clusters free:\t");
395 		pbits(cg_clustersfree(&acg), acg.cg_nclusterblks);
396 	} else
397 		printf("\n");
398 	printf("inodes used:\t");
399 	pbits(cg_inosused(&acg), afs.fs_ipg);
400 	printf("blks free:\t");
401 	pbits(cg_blksfree(&acg), afs.fs_fpg);
402 	return (0);
403 }
404 
405 static int
406 dumpfreespace(const char *name, int fflag)
407 {
408 	int i;
409 
410 	while ((i = cgread(&disk)) != 0) {
411 		if (i == -1)
412 			goto err;
413 		dumpfreespacecg(fflag);
414 	}
415 	return (0);
416 err:
417 	ufserr(name);
418 	return (1);
419 }
420 
421 static void
422 dumpfreespacecg(int fflag)
423 {
424 
425 	pblklist(cg_blksfree(&acg), afs.fs_fpg, disk.d_lcg * afs.fs_fpg,
426 	    fflag);
427 }
428 
429 static int
430 marshal(const char *name)
431 {
432 	struct fs *fs;
433 
434 	fs = &disk.d_fs;
435 
436 	printf("# newfs command for %s (%s)\n", name, disk.d_name);
437 	printf("newfs ");
438 	if (fs->fs_volname[0] != '\0')
439 		printf("-L %s ", fs->fs_volname);
440 	printf("-O %d ", disk.d_ufs);
441 	if (fs->fs_flags & FS_DOSOFTDEP)
442 		printf("-U ");
443 	printf("-a %d ", fs->fs_maxcontig);
444 	printf("-b %d ", fs->fs_bsize);
445 	/* -c is dumb */
446 	printf("-d %d ", fs->fs_maxbsize);
447 	printf("-e %d ", fs->fs_maxbpg);
448 	printf("-f %d ", fs->fs_fsize);
449 	printf("-g %d ", fs->fs_avgfilesize);
450 	printf("-h %d ", fs->fs_avgfpdir);
451 	printf("-i %jd ", fragroundup(fs, lblktosize(fs, fragstoblks(fs,
452 	    fs->fs_fpg)) / fs->fs_ipg));
453 	if (fs->fs_flags & FS_SUJ)
454 		printf("-j ");
455 	if (fs->fs_flags & FS_GJOURNAL)
456 		printf("-J ");
457 	printf("-k %jd ", fs->fs_metaspace);
458 	if (fs->fs_flags & FS_MULTILABEL)
459 		printf("-l ");
460 	printf("-m %d ", fs->fs_minfree);
461 	/* -n unimplemented */
462 	printf("-o ");
463 	switch (fs->fs_optim) {
464 	case FS_OPTSPACE:
465 		printf("space ");
466 		break;
467 	case FS_OPTTIME:
468 		printf("time ");
469 		break;
470 	default:
471 		printf("unknown ");
472 		break;
473 	}
474 	/* -p..r unimplemented */
475 	printf("-s %jd ", (intmax_t)fsbtodb(fs, fs->fs_size));
476 	if (fs->fs_flags & FS_TRIM)
477 		printf("-t ");
478 	printf("%s ", disk.d_name);
479 	printf("\n");
480 
481 	return 0;
482 }
483 
484 static void
485 pbits(void *vp, int max)
486 {
487 	int i;
488 	char *p;
489 	int count, j;
490 
491 	for (count = i = 0, p = vp; i < max; i++)
492 		if (isset(p, i)) {
493 			if (count)
494 				printf(",%s", count % 6 ? " " : "\n\t");
495 			count++;
496 			printf("%d", i);
497 			j = i;
498 			while ((i+1)<max && isset(p, i+1))
499 				i++;
500 			if (i != j)
501 				printf("-%d", i);
502 		}
503 	printf("\n");
504 }
505 
506 static void
507 pblklist(void *vp, int max, off_t offset, int fflag)
508 {
509 	int i, j;
510 	char *p;
511 
512 	for (i = 0, p = vp; i < max; i++) {
513 		if (isset(p, i)) {
514 			printf("%jd", (intmax_t)(i + offset));
515 			if (fflag < 2) {
516 				j = i;
517 				while ((i+1)<max && isset(p, i+1))
518 					i++;
519 				if (i != j)
520 					printf("-%jd", (intmax_t)(i + offset));
521 			}
522 			printf("\n");
523 		}
524 	}
525 }
526 
527 static void
528 ufserr(const char *name)
529 {
530 	if (disk.d_error != NULL)
531 		warnx("%s: %s", name, disk.d_error);
532 	else if (errno)
533 		warn("%s", name);
534 }
535 
536 static void
537 usage(void)
538 {
539 	(void)fprintf(stderr, "usage: dumpfs [-flm] filesys | device\n");
540 	exit(1);
541 }
542