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