1 /*- 2 * Copyright (c) 1980, 1988, 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 20 * 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 31 * SUCH DAMAGE. 32 * 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 $ 35 * $DragonFly: src/sbin/dump/traverse.c,v 1.15 2006/10/21 04:10:02 pavalos Exp $ 36 */ 37 38 #include <sys/param.h> 39 #include <sys/stat.h> 40 #ifdef sunos 41 #include <sys/vnode.h> 42 43 #include <ufs/fs.h> 44 #include <ufs/fsdir.h> 45 #include <ufs/inode.h> 46 #else 47 #include <vfs/ufs/dir.h> 48 #include <vfs/ufs/dinode.h> 49 #include <vfs/ufs/fs.h> 50 #endif 51 52 #include <protocols/dumprestore.h> 53 54 #include <ctype.h> 55 #include <stdio.h> 56 #ifdef __STDC__ 57 #include <errno.h> 58 #include <string.h> 59 #include <unistd.h> 60 #endif 61 62 #include "dump.h" 63 64 #define HASDUMPEDFILE 0x1 65 #define HASSUBDIRS 0x2 66 67 #ifdef FS_44INODEFMT 68 typedef quad_t fsizeT; 69 #else 70 typedef long fsizeT; 71 #endif 72 73 static int dirindir(ufs1_ino_t, daddr_t, int, long *, long *, int); 74 static void dmpindir(ufs1_ino_t, daddr_t, int, fsizeT *); 75 static int searchdir(ufs1_ino_t, daddr_t, long, long, long *, int); 76 77 /* 78 * This is an estimation of the number of TP_BSIZE blocks in the file. 79 * It estimates the number of blocks in files with holes by assuming 80 * that all of the blocks accounted for by di_blocks are data blocks 81 * (when some of the blocks are usually used for indirect pointers); 82 * hence the estimate may be high. 83 */ 84 long 85 blockest(struct ufs1_dinode *dp) 86 { 87 long blkest, sizeest; 88 89 /* 90 * dp->di_size is the size of the file in bytes. 91 * dp->di_blocks stores the number of sectors actually in the file. 92 * If there are more sectors than the size would indicate, this just 93 * means that there are indirect blocks in the file or unused 94 * sectors in the last file block; we can safely ignore these 95 * (blkest = sizeest below). 96 * If the file is bigger than the number of sectors would indicate, 97 * then the file has holes in it. In this case we must use the 98 * block count to estimate the number of data blocks used, but 99 * we use the actual size for estimating the number of indirect 100 * dump blocks (sizeest vs. blkest in the indirect block 101 * calculation). 102 */ 103 blkest = howmany(dbtob(dp->di_blocks), TP_BSIZE); 104 sizeest = howmany(dp->di_size, TP_BSIZE); 105 if (blkest > sizeest) 106 blkest = sizeest; 107 if (dp->di_size > (unsigned)sblock->fs_bsize * NDADDR) { 108 /* calculate the number of indirect blocks on the dump tape */ 109 blkest += 110 howmany(sizeest - NDADDR * sblock->fs_bsize / TP_BSIZE, 111 TP_NINDIR); 112 } 113 return (blkest + 1); 114 } 115 116 /* Auxiliary macro to pick up files changed since previous dump. */ 117 #define CHANGEDSINCE(dp, t) \ 118 ((dp)->di_mtime >= (t) || (dp)->di_ctime >= (t)) 119 120 /* The WANTTODUMP macro decides whether a file should be dumped. */ 121 #ifdef UF_NODUMP 122 #define WANTTODUMP(dp) \ 123 (CHANGEDSINCE(dp, spcl.c_ddate) && \ 124 (nonodump || ((dp)->di_flags & UF_NODUMP) != UF_NODUMP)) 125 #else 126 #define WANTTODUMP(dp) CHANGEDSINCE(dp, spcl.c_ddate) 127 #endif 128 129 /* 130 * Dump pass 1. 131 * 132 * Walk the inode list for a filesystem to find all allocated inodes 133 * that have been modified since the previous dump time. Also, find all 134 * the directories in the filesystem. 135 */ 136 int 137 mapfiles(ufs1_ino_t maxino, long *tape_size) 138 { 139 int mode; 140 ufs1_ino_t ino; 141 struct ufs1_dinode *dp; 142 int anydirskipped = 0; 143 144 for (ino = ROOTINO; ino < maxino; ino++) { 145 dp = getino(ino); 146 if ((mode = (dp->di_mode & IFMT)) == 0) 147 continue; 148 /* 149 * Everything must go in usedinomap so that a check 150 * for "in dumpdirmap but not in usedinomap" to detect 151 * dirs with nodump set has a chance of succeeding 152 * (this is used in mapdirs()). 153 */ 154 SETINO(ino, usedinomap); 155 if (mode == IFDIR) 156 SETINO(ino, dumpdirmap); 157 if (WANTTODUMP(dp)) { 158 SETINO(ino, dumpinomap); 159 if (mode != IFREG && mode != IFDIR && mode != IFLNK) 160 *tape_size += 1; 161 else 162 *tape_size += blockest(dp); 163 continue; 164 } 165 if (mode == IFDIR) { 166 if (!nonodump && (dp->di_flags & UF_NODUMP)) 167 CLRINO(ino, usedinomap); 168 anydirskipped = 1; 169 } 170 } 171 /* 172 * Restore gets very upset if the root is not dumped, 173 * so ensure that it always is dumped. 174 */ 175 SETINO(ROOTINO, dumpinomap); 176 return (anydirskipped); 177 } 178 179 /* 180 * Dump pass 2. 181 * 182 * Scan each directory on the filesystem to see if it has any modified 183 * files in it. If it does, and has not already been added to the dump 184 * list (because it was itself modified), then add it. If a directory 185 * has not been modified itself, contains no modified files and has no 186 * subdirectories, then it can be deleted from the dump list and from 187 * the list of directories. By deleting it from the list of directories, 188 * its parent may now qualify for the same treatment on this or a later 189 * pass using this algorithm. 190 */ 191 int 192 mapdirs(ufs1_ino_t maxino, long *tape_size) 193 { 194 struct ufs1_dinode *dp; 195 int isdir, nodump; 196 unsigned int i; 197 char *map; 198 ufs1_ino_t ino; 199 struct ufs1_dinode di; 200 long filesize; 201 int ret, change = 0; 202 203 isdir = 0; /* XXX just to get gcc to shut up */ 204 for (map = dumpdirmap, ino = 1; ino < maxino; ino++) { 205 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */ 206 isdir = *map++; 207 else 208 isdir >>= 1; 209 /* 210 * If a directory has been removed from usedinomap, it 211 * either has the nodump flag set, or has inherited 212 * it. Although a directory can't be in dumpinomap if 213 * it isn't in usedinomap, we have to go through it to 214 * propagate the nodump flag. 215 */ 216 nodump = !nonodump && (TSTINO(ino, usedinomap) == 0); 217 if ((isdir & 1) == 0 || (TSTINO(ino, dumpinomap) && !nodump)) 218 continue; 219 dp = getino(ino); 220 di = *dp; /* inode buf may change in searchdir(). */ 221 filesize = di.di_size; 222 for (ret = 0, i = 0; filesize > 0 && i < NDADDR; i++) { 223 if (di.di_db[i] != 0) { 224 ret |= searchdir(ino, di.di_db[i], 225 (long)dblksize(sblock, &di, i), 226 filesize, tape_size, nodump); 227 } 228 if (ret & HASDUMPEDFILE) 229 filesize = 0; 230 else 231 filesize -= sblock->fs_bsize; 232 } 233 for (i = 0; filesize > 0 && i < NIADDR; i++) { 234 if (di.di_ib[i] == 0) 235 continue; 236 ret |= dirindir(ino, di.di_ib[i], i, &filesize, 237 tape_size, nodump); 238 } 239 if (ret & HASDUMPEDFILE) { 240 SETINO(ino, dumpinomap); 241 *tape_size += blockest(&di); 242 change = 1; 243 continue; 244 } 245 if (nodump) { 246 if (ret & HASSUBDIRS) 247 change = 1; /* subdirs inherit nodump */ 248 CLRINO(ino, dumpdirmap); 249 } else if ((ret & HASSUBDIRS) == 0) 250 if (!TSTINO(ino, dumpinomap)) { 251 CLRINO(ino, dumpdirmap); 252 change = 1; 253 } 254 } 255 return (change); 256 } 257 258 /* 259 * Read indirect blocks, and pass the data blocks to be searched 260 * as directories. Quit as soon as any entry is found that will 261 * require the directory to be dumped. 262 */ 263 static int 264 dirindir(ufs1_ino_t ino, daddr_t blkno, int ind_level, long *filesize, 265 long *tape_size, int nodump) 266 { 267 int ret = 0; 268 int i; 269 daddr_t idblk[MAXNINDIR]; 270 271 bread(fsbtodb(sblock, blkno), (char *)idblk, (int)sblock->fs_bsize); 272 if (ind_level <= 0) { 273 for (i = 0; *filesize > 0 && i < NINDIR(sblock); i++) { 274 blkno = idblk[i]; 275 if (blkno != 0) { 276 ret |= searchdir(ino, blkno, sblock->fs_bsize, 277 *filesize, tape_size, nodump); 278 } 279 if (ret & HASDUMPEDFILE) 280 *filesize = 0; 281 else 282 *filesize -= sblock->fs_bsize; 283 } 284 return (ret); 285 } 286 ind_level--; 287 for (i = 0; *filesize > 0 && i < NINDIR(sblock); i++) { 288 blkno = idblk[i]; 289 if (blkno != 0) { 290 ret |= dirindir(ino, blkno, ind_level, filesize, 291 tape_size, nodump); 292 } 293 } 294 return (ret); 295 } 296 297 /* 298 * Scan a disk block containing directory information looking to see if 299 * any of the entries are on the dump list and to see if the directory 300 * contains any subdirectories. 301 */ 302 static int 303 searchdir(ufs1_ino_t ino, daddr_t blkno, long size, long filesize, 304 long *tape_size, int nodump) 305 { 306 struct direct *dp; 307 struct ufs1_dinode *ip; 308 long loc, ret = 0; 309 char dblk[MAXBSIZE]; 310 311 bread(fsbtodb(sblock, blkno), dblk, (int)size); 312 if (filesize < size) 313 size = filesize; 314 for (loc = 0; loc < size; ) { 315 dp = (struct direct *)(dblk + loc); 316 if (dp->d_reclen == 0) { 317 msg("corrupted directory, inumber %d\n", ino); 318 break; 319 } 320 loc += dp->d_reclen; 321 if (dp->d_ino == 0) 322 continue; 323 if (dp->d_name[0] == '.') { 324 if (dp->d_name[1] == '\0') 325 continue; 326 if (dp->d_name[1] == '.' && dp->d_name[2] == '\0') 327 continue; 328 } 329 if (nodump) { 330 ip = getino(dp->d_ino); 331 if (TSTINO(dp->d_ino, dumpinomap)) { 332 CLRINO(dp->d_ino, dumpinomap); 333 *tape_size -= blockest(ip); 334 } 335 /* 336 * Add back to dumpdirmap and remove from usedinomap 337 * to propagate nodump. 338 */ 339 if ((ip->di_mode & IFMT) == IFDIR) { 340 SETINO(dp->d_ino, dumpdirmap); 341 CLRINO(dp->d_ino, usedinomap); 342 ret |= HASSUBDIRS; 343 } 344 } else { 345 if (TSTINO(dp->d_ino, dumpinomap)) { 346 ret |= HASDUMPEDFILE; 347 if (ret & HASSUBDIRS) 348 break; 349 } 350 if (TSTINO(dp->d_ino, dumpdirmap)) { 351 ret |= HASSUBDIRS; 352 if (ret & HASDUMPEDFILE) 353 break; 354 } 355 } 356 } 357 return (ret); 358 } 359 360 /* 361 * Dump passes 3 and 4. 362 * 363 * Dump the contents of an inode to tape. 364 */ 365 void 366 dumpino(struct ufs1_dinode *dp, ufs1_ino_t ino) 367 { 368 int ind_level, cnt; 369 fsizeT size; 370 char buf[TP_BSIZE]; 371 372 if (newtape) { 373 newtape = 0; 374 dumpmap(dumpinomap, TS_BITS, ino); 375 } 376 CLRINO(ino, dumpinomap); 377 spcl.c_dinode = *dp; 378 spcl.c_type = TS_INODE; 379 spcl.c_count = 0; 380 switch (dp->di_mode & S_IFMT) { 381 382 case 0: 383 /* 384 * Freed inode. 385 */ 386 return; 387 388 case S_IFLNK: 389 /* 390 * Check for short symbolic link. 391 */ 392 #ifdef FS_44INODEFMT 393 if (dp->di_size > 0 && 394 dp->di_size < (unsigned)sblock->fs_maxsymlinklen) { 395 spcl.c_addr[0] = 1; 396 spcl.c_count = 1; 397 writeheader(ino); 398 memmove(buf, dp->di_shortlink, (u_long)dp->di_size); 399 buf[dp->di_size] = '\0'; 400 writerec(buf, 0); 401 return; 402 } 403 #endif 404 /* fall through */ 405 406 case S_IFDIR: 407 case S_IFREG: 408 if (dp->di_size > 0) 409 break; 410 /* fall through */ 411 412 case S_IFIFO: 413 case S_IFSOCK: 414 case S_IFCHR: 415 case S_IFBLK: 416 writeheader(ino); 417 return; 418 419 default: 420 msg("Warning: undefined file type 0%o\n", dp->di_mode & IFMT); 421 return; 422 } 423 if (dp->di_size > NDADDR * (unsigned)sblock->fs_bsize) 424 cnt = NDADDR * sblock->fs_frag; 425 else 426 cnt = howmany(dp->di_size, sblock->fs_fsize); 427 blksout(&dp->di_db[0], cnt, ino); 428 if ((size = dp->di_size - NDADDR * sblock->fs_bsize) <= 0) 429 return; 430 for (ind_level = 0; ind_level < NIADDR; ind_level++) { 431 dmpindir(ino, dp->di_ib[ind_level], ind_level, &size); 432 if (size <= 0) 433 return; 434 } 435 } 436 437 /* 438 * Read indirect blocks, and pass the data blocks to be dumped. 439 */ 440 static void 441 dmpindir(ufs1_ino_t ino, daddr_t blk, int ind_level, fsizeT *size) 442 { 443 int i, cnt; 444 daddr_t idblk[MAXNINDIR]; 445 446 if (blk != 0) 447 bread(fsbtodb(sblock, blk), (char *)idblk, (int) sblock->fs_bsize); 448 else 449 memset(idblk, 0, (int)sblock->fs_bsize); 450 if (ind_level <= 0) { 451 if (*size < NINDIR(sblock) * sblock->fs_bsize) 452 cnt = howmany(*size, sblock->fs_fsize); 453 else 454 cnt = NINDIR(sblock) * sblock->fs_frag; 455 *size -= NINDIR(sblock) * sblock->fs_bsize; 456 blksout(&idblk[0], cnt, ino); 457 return; 458 } 459 ind_level--; 460 for (i = 0; i < NINDIR(sblock); i++) { 461 dmpindir(ino, idblk[i], ind_level, size); 462 if (*size <= 0) 463 return; 464 } 465 } 466 467 /* 468 * Collect up the data into tape record sized buffers and output them. 469 */ 470 void 471 blksout(daddr_t *blkp, int frags, ufs1_ino_t ino) 472 { 473 daddr_t *bp; 474 int i, j, count, blks, tbperdb; 475 476 blks = howmany(frags * sblock->fs_fsize, TP_BSIZE); 477 tbperdb = sblock->fs_bsize >> tp_bshift; 478 for (i = 0; i < blks; i += TP_NINDIR) { 479 if (i + TP_NINDIR > blks) 480 count = blks; 481 else 482 count = i + TP_NINDIR; 483 for (j = i; j < count; j++) 484 if (blkp[j / tbperdb] != 0) 485 spcl.c_addr[j - i] = 1; 486 else 487 spcl.c_addr[j - i] = 0; 488 spcl.c_count = count - i; 489 writeheader(ino); 490 bp = &blkp[i / tbperdb]; 491 for (j = i; j < count; j += tbperdb, bp++) 492 if (*bp != 0) { 493 if (j + tbperdb <= count) 494 dumpblock(*bp, (int)sblock->fs_bsize); 495 else 496 dumpblock(*bp, (count - j) * TP_BSIZE); 497 } 498 spcl.c_type = TS_ADDR; 499 } 500 } 501 502 /* 503 * Dump a map to the tape. 504 */ 505 void 506 dumpmap(const char *map, int type, ufs1_ino_t ino) 507 { 508 int i; 509 const char *cp; 510 511 spcl.c_type = type; 512 spcl.c_count = howmany(mapsize * sizeof(char), TP_BSIZE); 513 writeheader(ino); 514 for (i = 0, cp = map; i < spcl.c_count; i++, cp += TP_BSIZE) 515 writerec(cp, 0); 516 } 517 518 /* 519 * Write a header record to the dump tape. 520 */ 521 void 522 writeheader(ufs1_ino_t ino) 523 { 524 int32_t sum, cnt, *lp; 525 526 spcl.c_inumber = ino; 527 spcl.c_magic = NFS_MAGIC; 528 spcl.c_checksum = 0; 529 lp = (int32_t *)&spcl; 530 sum = 0; 531 cnt = sizeof(union u_spcl) / (4 * sizeof(int32_t)); 532 while (--cnt >= 0) { 533 sum += *lp++; 534 sum += *lp++; 535 sum += *lp++; 536 sum += *lp++; 537 } 538 spcl.c_checksum = CHECKSUM - sum; 539 writerec(&spcl, 1); 540 } 541 542 struct ufs1_dinode * 543 getino(ufs1_ino_t inum) 544 { 545 static daddr_t minino, maxino; 546 static struct ufs1_dinode inoblock[MAXINOPB]; 547 548 curino = inum; 549 if (inum >= (unsigned)minino && inum < (unsigned)maxino) 550 return (&inoblock[inum - minino]); 551 bread(fsbtodb(sblock, ino_to_fsba(sblock, inum)), (char *)inoblock, 552 (int)sblock->fs_bsize); 553 minino = inum - (inum % INOPB(sblock)); 554 maxino = minino + INOPB(sblock); 555 return (&inoblock[inum - minino]); 556 } 557 558 /* 559 * Read a chunk of data from the disk. 560 * Try to recover from hard errors by reading in sector sized pieces. 561 * Error recovery is attempted at most BREADEMAX times before seeking 562 * consent from the operator to continue. 563 */ 564 int breaderrors = 0; 565 #define BREADEMAX 32 566 567 void 568 bread(daddr_t blkno, char *buf, int size) 569 { 570 int cnt, i; 571 572 loop: 573 cnt = cread(diskfd, buf, size, ((off_t)blkno << dev_bshift)); 574 if (cnt == size) 575 return; 576 if (blkno + (size / dev_bsize) > fsbtodb(sblock, sblock->fs_size)) { 577 /* 578 * Trying to read the final fragment. 579 * 580 * NB - dump only works in TP_BSIZE blocks, hence 581 * rounds `dev_bsize' fragments up to TP_BSIZE pieces. 582 * It should be smarter about not actually trying to 583 * read more than it can get, but for the time being 584 * we punt and scale back the read only when it gets 585 * us into trouble. (mkm 9/25/83) 586 */ 587 size -= dev_bsize; 588 goto loop; 589 } 590 if (cnt == -1) 591 msg("read error from %s: %s: [block %d]: count=%d\n", 592 disk, strerror(errno), blkno, size); 593 else 594 msg("short read error from %s: [block %d]: count=%d, got=%d\n", 595 disk, blkno, size, cnt); 596 if (++breaderrors > BREADEMAX) { 597 msg("More than %d block read errors from %s\n", 598 BREADEMAX, disk); 599 broadcast("DUMP IS AILING!\n"); 600 msg("This is an unrecoverable error.\n"); 601 if (!query("Do you want to attempt to continue?")){ 602 dumpabort(0); 603 /*NOTREACHED*/ 604 } else 605 breaderrors = 0; 606 } 607 /* 608 * Zero buffer, then try to read each sector of buffer separately, 609 * and bypass the cache. 610 */ 611 memset(buf, 0, size); 612 for (i = 0; i < size; i += dev_bsize, buf += dev_bsize, blkno++) { 613 if ((cnt = pread(diskfd, buf, (int)dev_bsize, 614 ((off_t)blkno << dev_bshift))) == dev_bsize) 615 continue; 616 if (cnt == -1) { 617 msg("read error from %s: %s: [sector %d]: count=%ld\n", 618 disk, strerror(errno), blkno, dev_bsize); 619 continue; 620 } 621 msg("short read error from %s: [sector %d]: count=%ld, got=%d\n", 622 disk, blkno, dev_bsize, cnt); 623 } 624 } 625