xref: /openbsd-src/sbin/dumpfs/dumpfs.c (revision 99fd087599a8791921855f21bd7e36130f39aadc)
1 /*	$OpenBSD: dumpfs.c,v 1.35 2020/02/17 16:11:25 otto Exp $	*/
2 
3 /*
4  * Copyright (c) 2002 Networks Associates Technology, Inc.
5  * All rights reserved.
6  *
7  * This software was developed for the FreeBSD Project by Marshall
8  * Kirk McKusick and Network Associates Laboratories, the Security
9  * Research Division of Network Associates, Inc. under DARPA/SPAWAR
10  * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
11  * research program.
12  *
13  * Copyright (c) 1983, 1992, 1993
14  *	The Regents of the University of California.  All rights reserved.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  */
40 
41 #include <sys/param.h>	/* DEV_BSIZE MAXBSIZE isset */
42 #include <sys/time.h>
43 
44 #include <ufs/ufs/dinode.h>
45 #include <ufs/ffs/fs.h>
46 
47 #include <err.h>
48 #include <errno.h>
49 #include <fcntl.h>
50 #include <fstab.h>
51 #include <stdint.h>
52 #include <stdio.h>
53 #include <stdlib.h>
54 #include <unistd.h>
55 #include <util.h>
56 
57 #define MINIMUM(a, b)	(((a) < (b)) ? (a) : (b))
58 
59 union {
60 	struct fs fs;
61 	char pad[MAXBSIZE];
62 } fsun;
63 #define afs	fsun.fs
64 
65 union {
66 	struct cg cg;
67 	char pad[MAXBSIZE];
68 } cgun;
69 #define acg	cgun.cg
70 
71 int	dumpfs(int, const char *);
72 int	dumpcg(const char *, int, int);
73 int	marshal(const char *);
74 int	open_disk(const char *);
75 void	pbits(void *, int);
76 __dead void	usage(void);
77 
78 int
79 main(int argc, char *argv[])
80 {
81 	struct fstab *fs;
82 	const char *name;
83 	int ch, domarshal, eval, fd;
84 
85 	domarshal = eval = 0;
86 
87 	while ((ch = getopt(argc, argv, "m")) != -1) {
88 		switch (ch) {
89 		case 'm':
90 			domarshal = 1;
91 			break;
92 		case '?':
93 		default:
94 			usage();
95 		}
96 	}
97 	argc -= optind;
98 	argv += optind;
99 
100 	if (argc < 1)
101 		usage();
102 
103 	if (pledge("stdio rpath disklabel", NULL) == -1)
104 		err(1, "pledge");
105 
106 	for (; *argv != NULL; argv++) {
107 		if ((fs = getfsfile(*argv)) != NULL)
108 			name = fs->fs_spec;
109 		else
110 			name = *argv;
111 		if ((fd = open_disk(name)) == -1) {
112 			eval |= 1;
113 			continue;
114 		}
115 		if (domarshal)
116 			eval |= marshal(name);
117 		else
118 			eval |= dumpfs(fd, name);
119 		close(fd);
120 	}
121 	exit(eval);
122 }
123 
124 int
125 open_disk(const char *name)
126 {
127 	int fd, i, sbtry[] = SBLOCKSEARCH;
128 	ssize_t n;
129 
130 	/* XXX - should retry w/raw device on failure */
131 	if ((fd = opendev(name, O_RDONLY, 0, NULL)) == -1) {
132 		warn("%s", name);
133 		return(-1);
134 	}
135 
136 	/* Read superblock, could be UFS1 or UFS2. */
137 	for (i = 0; sbtry[i] != -1; i++) {
138 		n = pread(fd, &afs, SBLOCKSIZE, (off_t)sbtry[i]);
139 		if (n == SBLOCKSIZE && (afs.fs_magic == FS_UFS1_MAGIC ||
140 		    (afs.fs_magic == FS_UFS2_MAGIC &&
141 		    afs.fs_sblockloc == sbtry[i])) &&
142 		    !(afs.fs_magic == FS_UFS1_MAGIC &&
143 		    sbtry[i] == SBLOCK_UFS2) &&
144 		    afs.fs_bsize <= MAXBSIZE &&
145 		    afs.fs_bsize >= sizeof(struct fs))
146 			break;
147 	}
148 	if (sbtry[i] == -1) {
149 		warnx("cannot find filesystem superblock");
150 		close(fd);
151 		return (-1);
152 	}
153 
154 	return (fd);
155 }
156 
157 int
158 dumpfs(int fd, const char *name)
159 {
160 	time_t fstime;
161 	int64_t fssize;
162 	int32_t fsflags;
163 	size_t size;
164 	off_t off;
165 	int i, j;
166 
167 	switch (afs.fs_magic) {
168 	case FS_UFS2_MAGIC:
169 		fssize = afs.fs_size;
170 		fstime = afs.fs_time;
171 		printf("magic\t%x (FFS2)\ttime\t%s",
172 		    afs.fs_magic, ctime(&fstime));
173 		printf("superblock location\t%jd\tid\t[ %x %x ]\n",
174 		    (intmax_t)afs.fs_sblockloc, afs.fs_id[0], afs.fs_id[1]);
175 		printf("ncg\t%d\tsize\t%jd\tblocks\t%jd\n",
176 		    afs.fs_ncg, (intmax_t)fssize, (intmax_t)afs.fs_dsize);
177 		break;
178 	case FS_UFS1_MAGIC:
179 		fssize = afs.fs_ffs1_size;
180 		fstime = afs.fs_ffs1_time;
181 		printf("magic\t%x (FFS1)\ttime\t%s",
182 		    afs.fs_magic, ctime(&fstime));
183 		printf("id\t[ %x %x ]\n", afs.fs_id[0], afs.fs_id[1]);
184 		i = 0;
185 		if (afs.fs_postblformat != FS_42POSTBLFMT) {
186 			i++;
187 			if (afs.fs_inodefmt >= FS_44INODEFMT) {
188 				size_t max;
189 
190 				i++;
191 				max = afs.fs_maxcontig;
192 				size = afs.fs_contigsumsize;
193 				if ((max < 2 && size == 0) ||
194 				    (max > 1 && size >= MINIMUM(max, FS_MAXCONTIG)))
195 					i++;
196 			}
197 		}
198 		printf("cylgrp\t%s\tinodes\t%s\tfslevel %d\n",
199 		    i < 1 ? "static" : "dynamic",
200 		    i < 2 ? "4.2/4.3BSD" : "4.4BSD", i);
201 		printf("ncg\t%d\tncyl\t%d\tsize\t%d\tblocks\t%d\n",
202 		    afs.fs_ncg, afs.fs_ncyl, afs.fs_ffs1_size, afs.fs_ffs1_dsize);
203 		break;
204 	default:
205 		goto err;
206 	}
207 	printf("bsize\t%d\tshift\t%d\tmask\t0x%08x\n",
208 	    afs.fs_bsize, afs.fs_bshift, afs.fs_bmask);
209 	printf("fsize\t%d\tshift\t%d\tmask\t0x%08x\n",
210 	    afs.fs_fsize, afs.fs_fshift, afs.fs_fmask);
211 	printf("frag\t%d\tshift\t%d\tfsbtodb\t%d\n",
212 	    afs.fs_frag, afs.fs_fragshift, afs.fs_fsbtodb);
213 	printf("minfree\t%d%%\toptim\t%s\tsymlinklen %d\n",
214 	    afs.fs_minfree, afs.fs_optim == FS_OPTSPACE ? "space" : "time",
215 	    afs.fs_maxsymlinklen);
216 	switch (afs.fs_magic) {
217 	case FS_UFS2_MAGIC:
218 		printf("%s %d\tmaxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
219 		    "maxbsize", afs.fs_maxbsize, afs.fs_maxbpg,
220 		    afs.fs_maxcontig, afs.fs_contigsumsize);
221 		printf("nbfree\t%jd\tndir\t%jd\tnifree\t%jd\tnffree\t%jd\n",
222 		    (intmax_t)afs.fs_cstotal.cs_nbfree,
223 		    (intmax_t)afs.fs_cstotal.cs_ndir,
224 		    (intmax_t)afs.fs_cstotal.cs_nifree,
225 		    (intmax_t)afs.fs_cstotal.cs_nffree);
226 		printf("bpg\t%d\tfpg\t%d\tipg\t%d\n",
227 		    afs.fs_fpg / afs.fs_frag, afs.fs_fpg, afs.fs_ipg);
228 		printf("nindir\t%d\tinopb\t%d\tmaxfilesize\t%ju\n",
229 		    afs.fs_nindir, afs.fs_inopb,
230 		    (uintmax_t)afs.fs_maxfilesize);
231 		printf("sbsize\t%d\tcgsize\t%d\tcsaddr\t%jd\tcssize\t%d\n",
232 		    afs.fs_sbsize, afs.fs_cgsize, (intmax_t)afs.fs_csaddr,
233 		    afs.fs_cssize);
234 		break;
235 	case FS_UFS1_MAGIC:
236 		printf("maxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
237 		    afs.fs_maxbpg, afs.fs_maxcontig, afs.fs_contigsumsize);
238 		printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
239 		    afs.fs_ffs1_cstotal.cs_nbfree, afs.fs_ffs1_cstotal.cs_ndir,
240 		    afs.fs_ffs1_cstotal.cs_nifree, afs.fs_ffs1_cstotal.cs_nffree);
241 		printf("cpg\t%d\tbpg\t%d\tfpg\t%d\tipg\t%d\n",
242 		    afs.fs_cpg, afs.fs_fpg / afs.fs_frag, afs.fs_fpg,
243 		    afs.fs_ipg);
244 		printf("nindir\t%d\tinopb\t%d\tnspf\t%d\tmaxfilesize\t%ju\n",
245 		    afs.fs_nindir, afs.fs_inopb, afs.fs_nspf,
246 		    (uintmax_t)afs.fs_maxfilesize);
247 		printf("sbsize\t%d\tcgsize\t%d\tcgoffset %d\tcgmask\t0x%08x\n",
248 		    afs.fs_sbsize, afs.fs_cgsize, afs.fs_cgoffset,
249 		    afs.fs_cgmask);
250 		printf("csaddr\t%d\tcssize\t%d\n",
251 		    afs.fs_ffs1_csaddr, afs.fs_cssize);
252 		printf("rotdelay %dms\trps\t%d\tinterleave %d\n",
253 		    afs.fs_rotdelay, afs.fs_rps, afs.fs_interleave);
254 		printf("nsect\t%d\tnpsect\t%d\tspc\t%d\n",
255 		    afs.fs_nsect, afs.fs_npsect, afs.fs_spc);
256 		break;
257 	default:
258 		goto err;
259 	}
260 	printf("sblkno\t%d\tcblkno\t%d\tiblkno\t%d\tdblkno\t%d\n",
261 	    afs.fs_sblkno, afs.fs_cblkno, afs.fs_iblkno, afs.fs_dblkno);
262 	printf("cgrotor\t%d\tfmod\t%d\tronly\t%d\tclean\t%d\n",
263 	    afs.fs_cgrotor, afs.fs_fmod, afs.fs_ronly, afs.fs_clean);
264 	printf("avgfpdir %d\tavgfilesize %d\n",
265 	    afs.fs_avgfpdir, afs.fs_avgfilesize);
266 	printf("flags\t");
267 	if (afs.fs_magic == FS_UFS2_MAGIC ||
268 	    afs.fs_ffs1_flags & FS_FLAGS_UPDATED)
269 		fsflags = afs.fs_flags;
270 	else
271 		fsflags = afs.fs_ffs1_flags;
272 	if (fsflags == 0)
273 		printf("none");
274 	if (fsflags & FS_UNCLEAN)
275 		printf("unclean ");
276 	if (fsflags & FS_DOSOFTDEP)
277 		printf("soft-updates ");
278 	if (fsflags & FS_FLAGS_UPDATED)
279 		printf("updated ");
280 #if 0
281 	fsflags &= ~(FS_UNCLEAN | FS_DOSOFTDEP | FS_FLAGS_UPDATED);
282 	if (fsflags != 0)
283 		printf("unknown flags (%#x)", fsflags);
284 #endif
285 	putchar('\n');
286 	printf("fsmnt\t%s\n", afs.fs_fsmnt);
287 	printf("volname\t%s\tswuid\t%ju\n",
288 		afs.fs_volname, (uintmax_t)afs.fs_swuid);
289 	printf("\ncs[].cs_(nbfree,ndir,nifree,nffree):\n\t");
290 	afs.fs_csp = calloc(1, afs.fs_cssize);
291 	for (i = 0, j = 0; i < afs.fs_cssize; i += afs.fs_bsize, j++) {
292 		size = afs.fs_cssize - i < afs.fs_bsize ?
293 		    afs.fs_cssize - i : afs.fs_bsize;
294 		off = (off_t)(fsbtodb(&afs, (afs.fs_csaddr + j *
295 		    afs.fs_frag))) * DEV_BSIZE;
296 		if (pread(fd, (char *)afs.fs_csp + i, size, off) != size)
297 			goto err;
298 	}
299 	for (i = 0; i < afs.fs_ncg; i++) {
300 		struct csum *cs = &afs.fs_cs(&afs, i);
301 		if (i && i % 4 == 0)
302 			printf("\n\t");
303 		printf("(%d,%d,%d,%d) ",
304 		    cs->cs_nbfree, cs->cs_ndir, cs->cs_nifree, cs->cs_nffree);
305 	}
306 	printf("\n");
307 	if (fssize % afs.fs_fpg) {
308 		if (afs.fs_magic == FS_UFS1_MAGIC)
309 			printf("cylinders in last group %d\n",
310 			    howmany(afs.fs_ffs1_size % afs.fs_fpg,
311 			    afs.fs_spc / afs.fs_nspf));
312 		printf("blocks in last group %ld\n\n",
313 		    (long)((fssize % afs.fs_fpg) / afs.fs_frag));
314 	}
315 	for (i = 0; i < afs.fs_ncg; i++)
316 		if (dumpcg(name, fd, i))
317 			goto err;
318 	return (0);
319 
320 err:	warn("%s", name);
321 	return (1);
322 }
323 
324 int
325 dumpcg(const char *name, int fd, int c)
326 {
327 	time_t cgtime;
328 	off_t cur;
329 	int i, j;
330 
331 	printf("\ncg %d:\n", c);
332 	cur = (off_t)fsbtodb(&afs, cgtod(&afs, c)) * DEV_BSIZE;
333 	if (pread(fd, &acg, afs.fs_bsize, cur) != afs.fs_bsize) {
334 		warn("%s: error reading cg", name);
335 		return(1);
336 	}
337 	switch (afs.fs_magic) {
338 	case FS_UFS2_MAGIC:
339 		cgtime = acg.cg_ffs2_time;
340 		printf("magic\t%x\ttell\t%jx\ttime\t%s",
341 		    acg.cg_magic, (intmax_t)cur, ctime(&cgtime));
342 		printf("cgx\t%d\tndblk\t%d\tniblk\t%d\tinitiblk %d\n",
343 		    acg.cg_cgx, acg.cg_ndblk, acg.cg_ffs2_niblk,
344 		    acg.cg_initediblk);
345 		break;
346 	case FS_UFS1_MAGIC:
347 		cgtime = acg.cg_time;
348 		printf("magic\t%x\ttell\t%jx\ttime\t%s",
349 		    afs.fs_postblformat == FS_42POSTBLFMT ?
350 		    ((struct ocg *)&acg)->cg_magic : acg.cg_magic,
351 		    (intmax_t)cur, ctime(&cgtime));
352 		printf("cgx\t%d\tncyl\t%d\tniblk\t%d\tndblk\t%d\n",
353 		    acg.cg_cgx, acg.cg_ncyl, acg.cg_niblk, acg.cg_ndblk);
354 		break;
355 	default:
356 		break;
357 	}
358 	printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
359 	    acg.cg_cs.cs_nbfree, acg.cg_cs.cs_ndir,
360 	    acg.cg_cs.cs_nifree, acg.cg_cs.cs_nffree);
361 	printf("rotor\t%d\tirotor\t%d\tfrotor\t%d\nfrsum",
362 	    acg.cg_rotor, acg.cg_irotor, acg.cg_frotor);
363 	for (i = 1, j = 0; i < afs.fs_frag; i++) {
364 		printf("\t%d", acg.cg_frsum[i]);
365 		j += i * acg.cg_frsum[i];
366 	}
367 	printf("\nsum of frsum: %d", j);
368 	if (afs.fs_contigsumsize > 0) {
369 		for (i = 1; i < afs.fs_contigsumsize; i++) {
370 			if ((i - 1) % 8 == 0)
371 				printf("\nclusters %d-%d:", i,
372 				    afs.fs_contigsumsize - 1 < i + 7 ?
373 				    afs.fs_contigsumsize - 1 : i + 7);
374 			printf("\t%d", cg_clustersum(&acg)[i]);
375 		}
376 		printf("\nclusters size %d and over: %d\n",
377 		    afs.fs_contigsumsize,
378 		    cg_clustersum(&acg)[afs.fs_contigsumsize]);
379 		printf("clusters free:\t");
380 		pbits(cg_clustersfree(&acg), acg.cg_nclusterblks);
381 	} else
382 		printf("\n");
383 	printf("inodes used:\t");
384 	pbits(cg_inosused(&acg), afs.fs_ipg);
385 	printf("blks free:\t");
386 	pbits(cg_blksfree(&acg), afs.fs_fpg);
387 #if 0
388 	/* XXX - keep this? */
389 	if (afs.fs_magic == FS_UFS1_MAGIC) {
390 		printf("b:\n");
391 		for (i = 0; i < afs.fs_cpg; i++) {
392 			if (cg_blktot(&acg)[i] == 0)
393 				continue;
394 			printf("   c%d:\t(%d)\t", i, cg_blktot(&acg)[i]);
395 			printf("\n");
396 		}
397 	}
398 #endif
399 	return (0);
400 }
401 
402 int
403 marshal(const char *name)
404 {
405 	int Oflag;
406 
407 	printf("# newfs command for %s\n", name);
408 	printf("newfs ");
409 	if (afs.fs_volname[0] != '\0')
410 		printf("-L %s ", afs.fs_volname);
411 
412 	Oflag = (afs.fs_magic == FS_UFS2_MAGIC) +
413 	    (afs.fs_inodefmt == FS_44INODEFMT);
414 	printf("-O %d ", Oflag);
415 	printf("-b %d ", afs.fs_bsize);
416 	/* -c unimplemented */
417 	printf("-e %d ", afs.fs_maxbpg);
418 	printf("-f %d ", afs.fs_fsize);
419 	printf("-g %d ", afs.fs_avgfilesize);
420 	printf("-h %d ", afs.fs_avgfpdir);
421 	/* -i unimplemented */
422 	printf("-m %d ", afs.fs_minfree);
423 	printf("-o ");
424 	switch (afs.fs_optim) {
425 	case FS_OPTSPACE:
426 		printf("space ");
427 		break;
428 	case FS_OPTTIME:
429 		printf("time ");
430 		break;
431 	default:
432 		printf("unknown ");
433 		break;
434 	}
435 	/* -S unimplemented */
436 	printf("-s %jd ", (intmax_t)afs.fs_size * (afs.fs_fsize / DEV_BSIZE));
437 	printf("%s ", name);
438 	printf("\n");
439 
440 	return 0;
441 }
442 
443 void
444 pbits(void *vp, int max)
445 {
446 	int i;
447 	char *p;
448 	int count, j;
449 
450 	for (count = i = 0, p = vp; i < max; i++)
451 		if (isset(p, i)) {
452 			if (count)
453 				printf(",%s", count % 6 ? " " : "\n\t");
454 			count++;
455 			printf("%d", i);
456 			j = i;
457 			while ((i+1)<max && isset(p, i+1))
458 				i++;
459 			if (i != j)
460 				printf("-%d", i);
461 		}
462 	printf("\n");
463 }
464 
465 __dead void
466 usage(void)
467 {
468 	(void)fprintf(stderr, "usage: dumpfs [-m] filesys | device\n");
469 	exit(1);
470 }
471