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