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