xref: /openbsd-src/sbin/dumpfs/dumpfs.c (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1 /*	$OpenBSD: dumpfs.c,v 1.26 2008/08/19 09:41:12 pedro 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 #ifndef lint
42 static const char copyright[] =
43 "@(#) Copyright (c) 1983, 1992, 1993\n\
44 	The Regents of the University of California.  All rights reserved.\n";
45 #endif /* not lint */
46 
47 #ifndef lint
48 #if 0
49 static const char sccsid[] = "@(#)dumpfs.c	8.5 (Berkeley) 4/29/95";
50 #else
51 static const char rcsid[] = "$OpenBSD: dumpfs.c,v 1.26 2008/08/19 09:41:12 pedro Exp $";
52 #endif
53 #endif /* not lint */
54 
55 #include <sys/param.h>
56 #include <sys/time.h>
57 
58 #include <ufs/ufs/dinode.h>
59 #include <ufs/ffs/fs.h>
60 
61 #include <err.h>
62 #include <errno.h>
63 #include <fcntl.h>
64 #include <fstab.h>
65 #include <stdint.h>
66 #include <stdio.h>
67 #include <stdlib.h>
68 #include <unistd.h>
69 
70 union {
71 	struct fs fs;
72 	char pad[MAXBSIZE];
73 } fsun;
74 #define afs	fsun.fs
75 
76 union {
77 	struct cg cg;
78 	char pad[MAXBSIZE];
79 } cgun;
80 #define acg	cgun.cg
81 
82 long	dev_bsize;
83 
84 int	dumpfs(int, const char *);
85 int	dumpcg(const char *, int, int);
86 int	marshal(const char *);
87 int	open_disk(const char *name);
88 void	pbits(void *, int);
89 __dead void	usage(void);
90 
91 int
92 main(int argc, char *argv[])
93 {
94 	struct fstab *fs;
95 	const char *name;
96 	int ch, domarshal, eval, fd;
97 
98 	domarshal = eval = 0;
99 
100 	while ((ch = getopt(argc, argv, "m")) != -1) {
101 		switch (ch) {
102 		case 'm':
103 			domarshal = 1;
104 			break;
105 		case '?':
106 		default:
107 			usage();
108 		}
109 	}
110 	argc -= optind;
111 	argv += optind;
112 
113 	if (argc < 1)
114 		usage();
115 
116 	for (; *argv != NULL; argv++) {
117 		if ((fs = getfsfile(*argv)) != NULL)
118 			name = fs->fs_spec;
119 		else
120 			name = *argv;
121 		if ((fd = open_disk(name)) == -1) {
122 			eval |= 1;
123 			continue;
124 		}
125 		if (domarshal)
126 			eval |= marshal(name);
127 		else
128 			eval |= dumpfs(fd, name);
129 		close(fd);
130 	}
131 	exit(eval);
132 }
133 
134 int
135 open_disk(const char *name)
136 {
137 	int fd, i, sbtry[] = SBLOCKSEARCH;
138 	ssize_t n;
139 
140 	/* XXX - should retry w/raw device on failure */
141 	if ((fd = open(name, O_RDONLY, 0)) < 0) {
142 		warn("%s", name);
143 		return(-1);
144 	}
145 
146 	/* Read superblock, could be UFS1 or UFS2. */
147 	for (i = 0; sbtry[i] != -1; i++) {
148 		n = pread(fd, &afs, SBLOCKSIZE, (off_t)sbtry[i]);
149 		if (n == SBLOCKSIZE && (afs.fs_magic == FS_UFS1_MAGIC ||
150 		    (afs.fs_magic == FS_UFS2_MAGIC &&
151 		    afs.fs_sblockloc == sbtry[i])) &&
152 		    afs.fs_bsize <= MAXBSIZE &&
153 		    afs.fs_bsize >= sizeof(struct fs))
154 			break;
155 	}
156 	if (sbtry[i] == -1) {
157 		warnx("cannot find filesystem superblock");
158 		close(fd);
159 		return (-1);
160 	}
161 
162 	dev_bsize = afs.fs_fsize / fsbtodb(&afs, 1);
163 	return (fd);
164 }
165 
166 int
167 dumpfs(int fd, const char *name)
168 {
169 	time_t fstime;
170 	int64_t fssize;
171 	int32_t fsflags;
172 	size_t size;
173 	off_t off;
174 	int i, j;
175 
176 	switch (afs.fs_magic) {
177 	case FS_UFS2_MAGIC:
178 		fssize = afs.fs_size;
179 		fstime = afs.fs_time;
180 		printf("magic\t%x (FFS2)\ttime\t%s",
181 		    afs.fs_magic, ctime(&fstime));
182 		printf("superblock location\t%jd\tid\t[ %x %x ]\n",
183 		    (intmax_t)afs.fs_sblockloc, afs.fs_id[0], afs.fs_id[1]);
184 		printf("ncg\t%d\tsize\t%jd\tblocks\t%jd\n",
185 		    afs.fs_ncg, (intmax_t)fssize, (intmax_t)afs.fs_dsize);
186 		break;
187 	case FS_UFS1_MAGIC:
188 		fssize = afs.fs_ffs1_size;
189 		fstime = afs.fs_ffs1_time;
190 		printf("magic\t%x (FFS1)\ttime\t%s",
191 		    afs.fs_magic, ctime(&fstime));
192 		printf("id\t[ %x %x ]\n", afs.fs_id[0], afs.fs_id[1]);
193 		i = 0;
194 		if (afs.fs_postblformat != FS_42POSTBLFMT) {
195 			i++;
196 			if (afs.fs_inodefmt >= FS_44INODEFMT) {
197 				size_t max;
198 
199 				i++;
200 				max = afs.fs_maxcontig;
201 				size = afs.fs_contigsumsize;
202 				if ((max < 2 && size == 0) ||
203 				    (max > 1 && size >= MIN(max, FS_MAXCONTIG)))
204 					i++;
205 			}
206 		}
207 		printf("cylgrp\t%s\tinodes\t%s\tfslevel %d\n",
208 		    i < 1 ? "static" : "dynamic",
209 		    i < 2 ? "4.2/4.3BSD" : "4.4BSD", i);
210 		printf("ncg\t%d\tncyl\t%d\tsize\t%d\tblocks\t%d\n",
211 		    afs.fs_ncg, afs.fs_ncyl, afs.fs_ffs1_size, afs.fs_ffs1_dsize);
212 		break;
213 	default:
214 		goto err;
215 	}
216 	printf("bsize\t%d\tshift\t%d\tmask\t0x%08x\n",
217 	    afs.fs_bsize, afs.fs_bshift, afs.fs_bmask);
218 	printf("fsize\t%d\tshift\t%d\tmask\t0x%08x\n",
219 	    afs.fs_fsize, afs.fs_fshift, afs.fs_fmask);
220 	printf("frag\t%d\tshift\t%d\tfsbtodb\t%d\n",
221 	    afs.fs_frag, afs.fs_fragshift, afs.fs_fsbtodb);
222 	printf("minfree\t%d%%\toptim\t%s\tsymlinklen %d\n",
223 	    afs.fs_minfree, afs.fs_optim == FS_OPTSPACE ? "space" : "time",
224 	    afs.fs_maxsymlinklen);
225 	switch (afs.fs_magic) {
226 	case FS_UFS2_MAGIC:
227 		printf("%s %d\tmaxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
228 		    "maxbsize", afs.fs_maxbsize, afs.fs_maxbpg,
229 		    afs.fs_maxcontig, afs.fs_contigsumsize);
230 		printf("nbfree\t%jd\tndir\t%jd\tnifree\t%jd\tnffree\t%jd\n",
231 		    (intmax_t)afs.fs_cstotal.cs_nbfree,
232 		    (intmax_t)afs.fs_cstotal.cs_ndir,
233 		    (intmax_t)afs.fs_cstotal.cs_nifree,
234 		    (intmax_t)afs.fs_cstotal.cs_nffree);
235 		printf("bpg\t%d\tfpg\t%d\tipg\t%d\n",
236 		    afs.fs_fpg / afs.fs_frag, afs.fs_fpg, afs.fs_ipg);
237 		printf("nindir\t%d\tinopb\t%d\tmaxfilesize\t%ju\n",
238 		    afs.fs_nindir, afs.fs_inopb,
239 		    (uintmax_t)afs.fs_maxfilesize);
240 		printf("sbsize\t%d\tcgsize\t%d\tcsaddr\t%jd\tcssize\t%d\n",
241 		    afs.fs_sbsize, afs.fs_cgsize, (intmax_t)afs.fs_csaddr,
242 		    afs.fs_cssize);
243 		break;
244 	case FS_UFS1_MAGIC:
245 		printf("maxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
246 		    afs.fs_maxbpg, afs.fs_maxcontig, afs.fs_contigsumsize);
247 		printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
248 		    afs.fs_ffs1_cstotal.cs_nbfree, afs.fs_ffs1_cstotal.cs_ndir,
249 		    afs.fs_ffs1_cstotal.cs_nifree, afs.fs_ffs1_cstotal.cs_nffree);
250 		printf("cpg\t%d\tbpg\t%d\tfpg\t%d\tipg\t%d\n",
251 		    afs.fs_cpg, afs.fs_fpg / afs.fs_frag, afs.fs_fpg,
252 		    afs.fs_ipg);
253 		printf("nindir\t%d\tinopb\t%d\tnspf\t%d\tmaxfilesize\t%ju\n",
254 		    afs.fs_nindir, afs.fs_inopb, afs.fs_nspf,
255 		    (uintmax_t)afs.fs_maxfilesize);
256 		printf("sbsize\t%d\tcgsize\t%d\tcgoffset %d\tcgmask\t0x%08x\n",
257 		    afs.fs_sbsize, afs.fs_cgsize, afs.fs_cgoffset,
258 		    afs.fs_cgmask);
259 		printf("csaddr\t%d\tcssize\t%d\n",
260 		    afs.fs_ffs1_csaddr, afs.fs_cssize);
261 		printf("rotdelay %dms\trps\t%d\tinterleave %d\n",
262 		    afs.fs_rotdelay, afs.fs_rps, afs.fs_interleave);
263 		printf("nsect\t%d\tnpsect\t%d\tspc\t%d\n",
264 		    afs.fs_nsect, afs.fs_npsect, afs.fs_spc);
265 		break;
266 	default:
267 		goto err;
268 	}
269 	printf("sblkno\t%d\tcblkno\t%d\tiblkno\t%d\tdblkno\t%d\n",
270 	    afs.fs_sblkno, afs.fs_cblkno, afs.fs_iblkno, afs.fs_dblkno);
271 	printf("cgrotor\t%d\tfmod\t%d\tronly\t%d\tclean\t%d\n",
272 	    afs.fs_cgrotor, afs.fs_fmod, afs.fs_ronly, afs.fs_clean);
273 	printf("avgfpdir %d\tavgfilesize %d\n",
274 	    afs.fs_avgfpdir, afs.fs_avgfilesize);
275 	printf("flags\t");
276 	if (afs.fs_magic == FS_UFS2_MAGIC ||
277 	    afs.fs_ffs1_flags & FS_FLAGS_UPDATED)
278 		fsflags = afs.fs_flags;
279 	else
280 		fsflags = afs.fs_ffs1_flags;
281 	if (fsflags == 0)
282 		printf("none");
283 	if (fsflags & FS_UNCLEAN)
284 		printf("unclean ");
285 	if (fsflags & FS_DOSOFTDEP)
286 		printf("soft-updates ");
287 	if (fsflags & FS_FLAGS_UPDATED)
288 		printf("updated ");
289 #if 0
290 	fsflags &= ~(FS_UNCLEAN | FS_DOSOFTDEP | FS_FLAGS_UPDATED);
291 	if (fsflags != 0)
292 		printf("unknown flags (%#x)", fsflags);
293 #endif
294 	putchar('\n');
295 	printf("fsmnt\t%s\n", afs.fs_fsmnt);
296 	printf("volname\t%s\tswuid\t%ju\n",
297 		afs.fs_volname, (uintmax_t)afs.fs_swuid);
298 	printf("\ncs[].cs_(nbfree,ndir,nifree,nffree):\n\t");
299 	afs.fs_csp = calloc(1, afs.fs_cssize);
300 	for (i = 0, j = 0; i < afs.fs_cssize; i += afs.fs_bsize, j++) {
301 		size = afs.fs_cssize - i < afs.fs_bsize ?
302 		    afs.fs_cssize - i : afs.fs_bsize;
303 		off = (off_t)(fsbtodb(&afs, (afs.fs_csaddr + j *
304 		    afs.fs_frag))) * dev_bsize;
305 		if (pread(fd, (char *)afs.fs_csp + i, size, off) != size)
306 			goto err;
307 	}
308 	for (i = 0; i < afs.fs_ncg; i++) {
309 		struct csum *cs = &afs.fs_cs(&afs, i);
310 		if (i && i % 4 == 0)
311 			printf("\n\t");
312 		printf("(%d,%d,%d,%d) ",
313 		    cs->cs_nbfree, cs->cs_ndir, cs->cs_nifree, cs->cs_nffree);
314 	}
315 	printf("\n");
316 	if (fssize % afs.fs_fpg) {
317 		if (afs.fs_magic == FS_UFS1_MAGIC)
318 			printf("cylinders in last group %d\n",
319 			    howmany(afs.fs_ffs1_size % afs.fs_fpg,
320 			    afs.fs_spc / afs.fs_nspf));
321 		printf("blocks in last group %ld\n\n",
322 		    (long)((fssize % afs.fs_fpg) / afs.fs_frag));
323 	}
324 	for (i = 0; i < afs.fs_ncg; i++)
325 		if (dumpcg(name, fd, i))
326 			goto err;
327 	return (0);
328 
329 err:	warn("%s", name);
330 	return (1);
331 }
332 
333 int
334 dumpcg(const char *name, int fd, int c)
335 {
336 	time_t cgtime;
337 	off_t cur;
338 	int i, j;
339 
340 	printf("\ncg %d:\n", c);
341 	cur = (off_t)fsbtodb(&afs, cgtod(&afs, c)) * dev_bsize;
342 	if (pread(fd, &acg, afs.fs_bsize, cur) != afs.fs_bsize) {
343 		warn("%s: error reading cg", name);
344 		return(1);
345 	}
346 	switch (afs.fs_magic) {
347 	case FS_UFS2_MAGIC:
348 		cgtime = acg.cg_ffs2_time;
349 		printf("magic\t%x\ttell\t%jx\ttime\t%s",
350 		    acg.cg_magic, (intmax_t)cur, ctime(&cgtime));
351 		printf("cgx\t%d\tndblk\t%d\tniblk\t%d\tinitiblk %d\n",
352 		    acg.cg_cgx, acg.cg_ndblk, acg.cg_ffs2_niblk,
353 		    acg.cg_initediblk);
354 		break;
355 	case FS_UFS1_MAGIC:
356 		cgtime = acg.cg_time;
357 		printf("magic\t%x\ttell\t%jx\ttime\t%s",
358 		    afs.fs_postblformat == FS_42POSTBLFMT ?
359 		    ((struct ocg *)&acg)->cg_magic : acg.cg_magic,
360 		    (intmax_t)cur, ctime(&acg.cg_time));
361 		printf("cgx\t%d\tncyl\t%d\tniblk\t%d\tndblk\t%d\n",
362 		    acg.cg_cgx, acg.cg_ncyl, acg.cg_niblk, acg.cg_ndblk);
363 		break;
364 	default:
365 		break;
366 	}
367 	printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
368 	    acg.cg_cs.cs_nbfree, acg.cg_cs.cs_ndir,
369 	    acg.cg_cs.cs_nifree, acg.cg_cs.cs_nffree);
370 	printf("rotor\t%d\tirotor\t%d\tfrotor\t%d\nfrsum",
371 	    acg.cg_rotor, acg.cg_irotor, acg.cg_frotor);
372 	for (i = 1, j = 0; i < afs.fs_frag; i++) {
373 		printf("\t%d", acg.cg_frsum[i]);
374 		j += i * acg.cg_frsum[i];
375 	}
376 	printf("\nsum of frsum: %d", j);
377 	if (afs.fs_contigsumsize > 0) {
378 		for (i = 1; i < afs.fs_contigsumsize; i++) {
379 			if ((i - 1) % 8 == 0)
380 				printf("\nclusters %d-%d:", i,
381 				    afs.fs_contigsumsize - 1 < i + 7 ?
382 				    afs.fs_contigsumsize - 1 : i + 7);
383 			printf("\t%d", cg_clustersum(&acg)[i]);
384 		}
385 		printf("\nclusters size %d and over: %d\n",
386 		    afs.fs_contigsumsize,
387 		    cg_clustersum(&acg)[afs.fs_contigsumsize]);
388 		printf("clusters free:\t");
389 		pbits(cg_clustersfree(&acg), acg.cg_nclusterblks);
390 	} else
391 		printf("\n");
392 	printf("inodes used:\t");
393 	pbits(cg_inosused(&acg), afs.fs_ipg);
394 	printf("blks free:\t");
395 	pbits(cg_blksfree(&acg), afs.fs_fpg);
396 #if 0
397 	/* XXX - keep this? */
398 	if (afs.fs_magic == FS_UFS1_MAGIC) {
399 		printf("b:\n");
400 		for (i = 0; i < afs.fs_cpg; i++) {
401 			if (cg_blktot(&acg)[i] == 0)
402 				continue;
403 			printf("   c%d:\t(%d)\t", i, cg_blktot(&acg)[i]);
404 			printf("\n");
405 		}
406 	}
407 #endif
408 	return (0);
409 }
410 
411 int
412 marshal(const char *name)
413 {
414 	int Oflag;
415 
416 	printf("# newfs command for %s\n", name);
417 	printf("newfs ");
418 	if (afs.fs_volname[0] != '\0')
419 		printf("-L %s ", afs.fs_volname);
420 
421 	Oflag = (afs.fs_magic == FS_UFS2_MAGIC) +
422 	    (afs.fs_inodefmt == FS_44INODEFMT);
423 	printf("-O %d ", Oflag);
424 	printf("-b %d ", afs.fs_bsize);
425 	/* -c unimplemented */
426 	printf("-e %d ", afs.fs_maxbpg);
427 	printf("-f %d ", afs.fs_fsize);
428 	printf("-g %d ", afs.fs_avgfilesize);
429 	printf("-h %d ", afs.fs_avgfpdir);
430 	/* -i unimplemented */
431 	printf("-m %d ", afs.fs_minfree);
432 	printf("-o ");
433 	switch (afs.fs_optim) {
434 	case FS_OPTSPACE:
435 		printf("space ");
436 		break;
437 	case FS_OPTTIME:
438 		printf("time ");
439 		break;
440 	default:
441 		printf("unknown ");
442 		break;
443 	}
444 	/* -S unimplemented */
445 	printf("-s %jd ", (intmax_t)afs.fs_size * (afs.fs_fsize / DEV_BSIZE));
446 	printf("%s ", name);
447 	printf("\n");
448 
449 	return 0;
450 }
451 
452 void
453 pbits(void *vp, int max)
454 {
455 	int i;
456 	char *p;
457 	int count, j;
458 
459 	for (count = i = 0, p = vp; i < max; i++)
460 		if (isset(p, i)) {
461 			if (count)
462 				printf(",%s", count % 6 ? " " : "\n\t");
463 			count++;
464 			printf("%d", i);
465 			j = i;
466 			while ((i+1)<max && isset(p, i+1))
467 				i++;
468 			if (i != j)
469 				printf("-%d", i);
470 		}
471 	printf("\n");
472 }
473 
474 __dead void
475 usage(void)
476 {
477 	(void)fprintf(stderr, "usage: dumpfs [-m] filesys | device\n");
478 	exit(1);
479 }
480