2 * Copyright (c) 1980, 1988, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * @(#)traverse.c 8.7 (Berkeley) 6/15/95
34 * $FreeBSD: src/sbin/dump/traverse.c,v 1.10.2.6 2003/04/14 20:10:35 johan Exp $
37 #include <sys/param.h>
40 #include <sys/vnode.h>
43 #include <ufs/fsdir.h>
44 #include <ufs/inode.h>
46 #include <vfs/ufs/dir.h>
47 #include <vfs/ufs/dinode.h>
48 #include <vfs/ufs/fs.h>
51 #include <protocols/dumprestore.h>
61 #define HASDUMPEDFILE 0x1
62 #define HASSUBDIRS 0x2
65 typedef quad_t fsizeT;
70 static int dirindir(ufs1_ino_t, daddr_t, int, long *, long *, int);
71 static void dmpindir(ufs1_ino_t, daddr_t, int, fsizeT *);
72 static int searchdir(ufs1_ino_t, daddr_t, long, long, long *, int);
75 * This is an estimation of the number of TP_BSIZE blocks in the file.
76 * It estimates the number of blocks in files with holes by assuming
77 * that all of the blocks accounted for by di_blocks are data blocks
78 * (when some of the blocks are usually used for indirect pointers);
79 * hence the estimate may be high.
82 blockest(struct ufs1_dinode *dp)
87 * dp->di_size is the size of the file in bytes.
88 * dp->di_blocks stores the number of sectors actually in the file.
89 * If there are more sectors than the size would indicate, this just
90 * means that there are indirect blocks in the file or unused
91 * sectors in the last file block; we can safely ignore these
92 * (blkest = sizeest below).
93 * If the file is bigger than the number of sectors would indicate,
94 * then the file has holes in it. In this case we must use the
95 * block count to estimate the number of data blocks used, but
96 * we use the actual size for estimating the number of indirect
97 * dump blocks (sizeest vs. blkest in the indirect block
100 blkest = howmany(dbtob(dp->di_blocks), TP_BSIZE);
101 sizeest = howmany(dp->di_size, TP_BSIZE);
102 if (blkest > sizeest)
104 if (dp->di_size > (unsigned)sblock->fs_bsize * NDADDR) {
105 /* calculate the number of indirect blocks on the dump tape */
107 howmany(sizeest - NDADDR * sblock->fs_bsize / TP_BSIZE,
113 /* Auxiliary macro to pick up files changed since previous dump. */
114 #define CHANGEDSINCE(dp, t) \
115 ((dp)->di_mtime >= (t) || (dp)->di_ctime >= (t))
117 /* The WANTTODUMP macro decides whether a file should be dumped. */
119 #define WANTTODUMP(dp) \
120 (CHANGEDSINCE(dp, spcl.c_ddate) && \
121 (nonodump || ((dp)->di_flags & UF_NODUMP) != UF_NODUMP))
123 #define WANTTODUMP(dp) CHANGEDSINCE(dp, spcl.c_ddate)
129 * Walk the inode list for a filesystem to find all allocated inodes
130 * that have been modified since the previous dump time. Also, find all
131 * the directories in the filesystem.
134 mapfiles(ufs1_ino_t maxino, long *tape_size)
138 struct ufs1_dinode *dp;
139 int anydirskipped = 0;
141 for (ino = ROOTINO; ino < maxino; ino++) {
143 if ((mode = (dp->di_mode & IFMT)) == 0)
146 * Everything must go in usedinomap so that a check
147 * for "in dumpdirmap but not in usedinomap" to detect
148 * dirs with nodump set has a chance of succeeding
149 * (this is used in mapdirs()).
151 SETINO(ino, usedinomap);
153 SETINO(ino, dumpdirmap);
154 if (WANTTODUMP(dp)) {
155 SETINO(ino, dumpinomap);
156 if (mode != IFREG && mode != IFDIR && mode != IFLNK)
159 *tape_size += blockest(dp);
163 if (!nonodump && (dp->di_flags & UF_NODUMP))
164 CLRINO(ino, usedinomap);
169 * Restore gets very upset if the root is not dumped,
170 * so ensure that it always is dumped.
172 SETINO(ROOTINO, dumpinomap);
173 return (anydirskipped);
179 * Scan each directory on the filesystem to see if it has any modified
180 * files in it. If it does, and has not already been added to the dump
181 * list (because it was itself modified), then add it. If a directory
182 * has not been modified itself, contains no modified files and has no
183 * subdirectories, then it can be deleted from the dump list and from
184 * the list of directories. By deleting it from the list of directories,
185 * its parent may now qualify for the same treatment on this or a later
186 * pass using this algorithm.
189 mapdirs(ufs1_ino_t maxino, long *tape_size)
191 struct ufs1_dinode *dp;
196 struct ufs1_dinode di;
200 isdir = 0; /* XXX just to get gcc to shut up */
201 for (map = dumpdirmap, ino = 1; ino < maxino; ino++) {
202 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */
207 * If a directory has been removed from usedinomap, it
208 * either has the nodump flag set, or has inherited
209 * it. Although a directory can't be in dumpinomap if
210 * it isn't in usedinomap, we have to go through it to
211 * propagate the nodump flag.
213 nodump = !nonodump && (TSTINO(ino, usedinomap) == 0);
214 if ((isdir & 1) == 0 || (TSTINO(ino, dumpinomap) && !nodump))
217 di = *dp; /* inode buf may change in searchdir(). */
218 filesize = di.di_size;
219 for (ret = 0, i = 0; filesize > 0 && i < NDADDR; i++) {
220 if (di.di_db[i] != 0) {
221 ret |= searchdir(ino, di.di_db[i],
222 (long)dblksize(sblock, &di, i),
223 filesize, tape_size, nodump);
225 if (ret & HASDUMPEDFILE)
228 filesize -= sblock->fs_bsize;
230 for (i = 0; filesize > 0 && i < NIADDR; i++) {
231 if (di.di_ib[i] == 0)
233 ret |= dirindir(ino, di.di_ib[i], i, &filesize,
236 if (ret & HASDUMPEDFILE) {
237 SETINO(ino, dumpinomap);
238 *tape_size += blockest(&di);
243 if (ret & HASSUBDIRS)
244 change = 1; /* subdirs inherit nodump */
245 CLRINO(ino, dumpdirmap);
246 } else if ((ret & HASSUBDIRS) == 0)
247 if (!TSTINO(ino, dumpinomap)) {
248 CLRINO(ino, dumpdirmap);
256 * Read indirect blocks, and pass the data blocks to be searched
257 * as directories. Quit as soon as any entry is found that will
258 * require the directory to be dumped.
261 dirindir(ufs1_ino_t ino, daddr_t blkno, int ind_level, long *filesize,
262 long *tape_size, int nodump)
266 daddr_t idblk[MAXNINDIR];
268 bread(fsbtodb(sblock, blkno), (char *)idblk, (int)sblock->fs_bsize);
269 if (ind_level <= 0) {
270 for (i = 0; *filesize > 0 && i < NINDIR(sblock); i++) {
273 ret |= searchdir(ino, blkno, sblock->fs_bsize,
274 *filesize, tape_size, nodump);
276 if (ret & HASDUMPEDFILE)
279 *filesize -= sblock->fs_bsize;
284 for (i = 0; *filesize > 0 && i < NINDIR(sblock); i++) {
287 ret |= dirindir(ino, blkno, ind_level, filesize,
295 * Scan a disk block containing directory information looking to see if
296 * any of the entries are on the dump list and to see if the directory
297 * contains any subdirectories.
300 searchdir(ufs1_ino_t ino, daddr_t blkno, long size, long filesize,
301 long *tape_size, int nodump)
304 struct ufs1_dinode *ip;
308 bread(fsbtodb(sblock, blkno), dblk, (int)size);
311 for (loc = 0; loc < size; ) {
312 dp = (struct direct *)(dblk + loc);
313 if (dp->d_reclen == 0) {
314 msg("corrupted directory, inumber %d\n", ino);
320 if (dp->d_name[0] == '.') {
321 if (dp->d_name[1] == '\0')
323 if (dp->d_name[1] == '.' && dp->d_name[2] == '\0')
327 ip = getino(dp->d_ino);
328 if (TSTINO(dp->d_ino, dumpinomap)) {
329 CLRINO(dp->d_ino, dumpinomap);
330 *tape_size -= blockest(ip);
333 * Add back to dumpdirmap and remove from usedinomap
334 * to propagate nodump.
336 if ((ip->di_mode & IFMT) == IFDIR) {
337 SETINO(dp->d_ino, dumpdirmap);
338 CLRINO(dp->d_ino, usedinomap);
342 if (TSTINO(dp->d_ino, dumpinomap)) {
343 ret |= HASDUMPEDFILE;
344 if (ret & HASSUBDIRS)
347 if (TSTINO(dp->d_ino, dumpdirmap)) {
349 if (ret & HASDUMPEDFILE)
358 * Dump passes 3 and 4.
360 * Dump the contents of an inode to tape.
363 dumpino(struct ufs1_dinode *dp, ufs1_ino_t ino)
371 dumpmap(dumpinomap, TS_BITS, ino);
373 CLRINO(ino, dumpinomap);
375 spcl.c_type = TS_INODE;
377 switch (dp->di_mode & S_IFMT) {
387 * Check for short symbolic link.
390 if (dp->di_size > 0 &&
391 dp->di_size < (unsigned)sblock->fs_maxsymlinklen) {
395 memmove(buf, dp->di_shortlink, (u_long)dp->di_size);
396 buf[dp->di_size] = '\0';
417 msg("Warning: undefined file type 0%o\n", dp->di_mode & IFMT);
420 if (dp->di_size > NDADDR * (unsigned)sblock->fs_bsize)
421 cnt = NDADDR * sblock->fs_frag;
423 cnt = howmany(dp->di_size, sblock->fs_fsize);
424 blksout(&dp->di_db[0], cnt, ino);
425 if ((size = dp->di_size - NDADDR * sblock->fs_bsize) <= 0)
427 for (ind_level = 0; ind_level < NIADDR; ind_level++) {
428 dmpindir(ino, dp->di_ib[ind_level], ind_level, &size);
435 * Read indirect blocks, and pass the data blocks to be dumped.
438 dmpindir(ufs1_ino_t ino, daddr_t blk, int ind_level, fsizeT *size)
441 daddr_t idblk[MAXNINDIR];
444 bread(fsbtodb(sblock, blk), (char *)idblk, (int) sblock->fs_bsize);
446 memset(idblk, 0, (int)sblock->fs_bsize);
447 if (ind_level <= 0) {
448 if (*size < NINDIR(sblock) * sblock->fs_bsize)
449 cnt = howmany(*size, sblock->fs_fsize);
451 cnt = NINDIR(sblock) * sblock->fs_frag;
452 *size -= NINDIR(sblock) * sblock->fs_bsize;
453 blksout(&idblk[0], cnt, ino);
457 for (i = 0; i < NINDIR(sblock); i++) {
458 dmpindir(ino, idblk[i], ind_level, size);
465 * Collect up the data into tape record sized buffers and output them.
468 blksout(daddr_t *blkp, int frags, ufs1_ino_t ino)
471 int i, j, count, blks, tbperdb;
473 blks = howmany(frags * sblock->fs_fsize, TP_BSIZE);
474 tbperdb = sblock->fs_bsize >> tp_bshift;
475 for (i = 0; i < blks; i += TP_NINDIR) {
476 if (i + TP_NINDIR > blks)
479 count = i + TP_NINDIR;
480 for (j = i; j < count; j++)
481 if (blkp[j / tbperdb] != 0)
482 spcl.c_addr[j - i] = 1;
484 spcl.c_addr[j - i] = 0;
485 spcl.c_count = count - i;
487 bp = &blkp[i / tbperdb];
488 for (j = i; j < count; j += tbperdb, bp++)
490 if (j + tbperdb <= count)
491 dumpblock(*bp, (int)sblock->fs_bsize);
493 dumpblock(*bp, (count - j) * TP_BSIZE);
495 spcl.c_type = TS_ADDR;
500 * Dump a map to the tape.
503 dumpmap(const char *map, int type, ufs1_ino_t ino)
509 spcl.c_count = howmany(mapsize * sizeof(char), TP_BSIZE);
511 for (i = 0, cp = map; i < spcl.c_count; i++, cp += TP_BSIZE)
516 * Write a header record to the dump tape.
519 writeheader(ufs1_ino_t ino)
521 int32_t sum, cnt, *lp;
523 spcl.c_inumber = ino;
524 spcl.c_magic = NFS_MAGIC;
526 lp = (int32_t *)&spcl;
528 cnt = sizeof(union u_spcl) / (4 * sizeof(int32_t));
535 spcl.c_checksum = CHECKSUM - sum;
540 getino(ufs1_ino_t inum)
542 static daddr_t minino, maxino;
543 static struct ufs1_dinode inoblock[MAXINOPB];
546 if (inum >= (unsigned)minino && inum < (unsigned)maxino)
547 return (&inoblock[inum - minino]);
548 bread(fsbtodb(sblock, ino_to_fsba(sblock, inum)), (char *)inoblock,
549 (int)sblock->fs_bsize);
550 minino = inum - (inum % INOPB(sblock));
551 maxino = minino + INOPB(sblock);
552 return (&inoblock[inum - minino]);
556 * Read a chunk of data from the disk.
557 * Try to recover from hard errors by reading in sector sized pieces.
558 * Error recovery is attempted at most BREADEMAX times before seeking
559 * consent from the operator to continue.
565 bread(daddr_t blkno, char *buf, int size)
570 cnt = cread(diskfd, buf, size, ((off_t)blkno << dev_bshift));
573 if (blkno + (size / dev_bsize) > fsbtodb(sblock, sblock->fs_size)) {
575 * Trying to read the final fragment.
577 * NB - dump only works in TP_BSIZE blocks, hence
578 * rounds `dev_bsize' fragments up to TP_BSIZE pieces.
579 * It should be smarter about not actually trying to
580 * read more than it can get, but for the time being
581 * we punt and scale back the read only when it gets
582 * us into trouble. (mkm 9/25/83)
588 msg("read error from %s: %s: [block %d]: count=%d\n",
589 disk, strerror(errno), blkno, size);
591 msg("short read error from %s: [block %d]: count=%d, got=%d\n",
592 disk, blkno, size, cnt);
593 if (++breaderrors > BREADEMAX) {
594 msg("More than %d block read errors from %s\n",
596 broadcast("DUMP IS AILING!\n");
597 msg("This is an unrecoverable error.\n");
598 if (!query("Do you want to attempt to continue?")){
605 * Zero buffer, then try to read each sector of buffer separately,
606 * and bypass the cache.
608 memset(buf, 0, size);
609 for (i = 0; i < size; i += dev_bsize, buf += dev_bsize, blkno++) {
610 if ((cnt = pread(diskfd, buf, (int)dev_bsize,
611 ((off_t)blkno << dev_bshift))) == dev_bsize)
614 msg("read error from %s: %s: [sector %d]: count=%ld\n",
615 disk, strerror(errno), blkno, dev_bsize);
618 msg("short read error from %s: [sector %d]: count=%ld, got=%d\n",
619 disk, blkno, dev_bsize, cnt);