2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1980, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 static const char sccsid[] = "@(#)dir.c 8.8 (Berkeley) 4/28/95";
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include <sys/param.h>
42 #include <sys/types.h>
43 #include <sys/sysctl.h>
45 #include <ufs/ufs/dinode.h>
46 #include <ufs/ufs/dir.h>
47 #include <ufs/ffs/fs.h>
54 static struct dirtemplate emptydir = {
55 0, DIRBLKSIZ, DT_UNKNOWN, 0, "",
56 0, 0, DT_UNKNOWN, 0, ""
58 static struct dirtemplate dirhead = {
59 0, 12, DT_DIR, 1, ".",
60 0, DIRBLKSIZ - 12, DT_DIR, 2, ".."
63 static int chgino(struct inodesc *);
64 static int dircheck(struct inodesc *, struct direct *);
65 static int expanddir(union dinode *dp, char *name);
66 static void freedir(ino_t ino, ino_t parent);
67 static struct direct *fsck_readdir(struct inodesc *);
68 static struct bufarea *getdirblk(ufs2_daddr_t blkno, long size);
69 static int lftempname(char *bufp, ino_t ino);
70 static int mkentry(struct inodesc *);
73 * Propagate connected state through the tree.
78 struct inoinfo **inpp, *inp;
79 struct inoinfo **inpend;
82 inpend = &inpsort[inplast];
85 for (inpp = inpsort; inpp < inpend; inpp++) {
87 if (inp->i_parent == 0)
89 if (inoinfo(inp->i_parent)->ino_state == DFOUND &&
90 INO_IS_DUNFOUND(inp->i_number)) {
91 inoinfo(inp->i_number)->ino_state = DFOUND;
99 * Scan each entry in a directory block.
102 dirscan(struct inodesc *idesc)
108 char dbuf[DIRBLKSIZ];
110 if (idesc->id_type != DATA)
111 errx(EEXIT, "wrong type to dirscan %d", idesc->id_type);
112 if (idesc->id_entryno == 0 &&
113 (idesc->id_filesize & (DIRBLKSIZ - 1)) != 0)
114 idesc->id_filesize = roundup(idesc->id_filesize, DIRBLKSIZ);
115 blksiz = idesc->id_numfrags * sblock.fs_fsize;
116 if (chkrange(idesc->id_blkno, idesc->id_numfrags)) {
117 idesc->id_filesize -= blksiz;
121 for (dp = fsck_readdir(idesc); dp != NULL; dp = fsck_readdir(idesc)) {
122 dsize = dp->d_reclen;
123 if (dsize > sizeof(dbuf))
124 dsize = sizeof(dbuf);
125 memmove(dbuf, dp, (size_t)dsize);
126 idesc->id_dirp = (struct direct *)dbuf;
127 if ((n = (*idesc->id_func)(idesc)) & ALTERED) {
128 bp = getdirblk(idesc->id_blkno, blksiz);
129 memmove(bp->b_un.b_buf + idesc->id_loc - dsize, dbuf,
138 return (idesc->id_filesize > 0 ? KEEPON : STOP);
142 * get next entry in a directory.
144 static struct direct *
145 fsck_readdir(struct inodesc *idesc)
147 struct direct *dp, *ndp;
149 long size, blksiz, fix, dploc;
152 blksiz = idesc->id_numfrags * sblock.fs_fsize;
153 bp = getdirblk(idesc->id_blkno, blksiz);
154 if (idesc->id_loc % DIRBLKSIZ == 0 && idesc->id_filesize > 0 &&
155 idesc->id_loc < blksiz) {
156 dp = (struct direct *)(bp->b_un.b_buf + idesc->id_loc);
157 if ((dc = dircheck(idesc, dp)) > 0) {
160 * dircheck() cleared unused directory space.
161 * Mark the buffer as dirty to write it out.
167 if (idesc->id_fix == IGNORE)
169 fix = dofix(idesc, "DIRECTORY CORRUPTED");
170 bp = getdirblk(idesc->id_blkno, blksiz);
171 dp = (struct direct *)(bp->b_un.b_buf + idesc->id_loc);
172 dp->d_reclen = DIRBLKSIZ;
176 dp->d_name[0] = '\0';
179 idesc->id_loc += DIRBLKSIZ;
180 idesc->id_filesize -= DIRBLKSIZ;
184 if (idesc->id_filesize <= 0 || idesc->id_loc >= blksiz)
186 dploc = idesc->id_loc;
187 dp = (struct direct *)(bp->b_un.b_buf + dploc);
188 idesc->id_loc += dp->d_reclen;
189 idesc->id_filesize -= dp->d_reclen;
190 if ((idesc->id_loc % DIRBLKSIZ) == 0)
192 ndp = (struct direct *)(bp->b_un.b_buf + idesc->id_loc);
193 if (idesc->id_loc < blksiz && idesc->id_filesize > 0) {
194 if ((dc = dircheck(idesc, ndp)) == 0) {
195 size = DIRBLKSIZ - (idesc->id_loc % DIRBLKSIZ);
196 idesc->id_loc += size;
197 idesc->id_filesize -= size;
198 if (idesc->id_fix == IGNORE)
200 fix = dofix(idesc, "DIRECTORY CORRUPTED");
201 bp = getdirblk(idesc->id_blkno, blksiz);
202 dp = (struct direct *)(bp->b_un.b_buf + dploc);
203 dp->d_reclen += size;
206 } else if (dc == 2) {
208 * dircheck() cleared unused directory space.
209 * Mark the buffer as dirty to write it out.
218 * Verify that a directory entry is valid.
219 * This is a superset of the checks made in the kernel.
220 * Also optionally clears padding and unused directory space.
222 * Returns 0 if the entry is bad, 1 if the entry is good and no changes
223 * were made, and 2 if the entry is good but modified to clear out padding
224 * and unused space and needs to be written back to disk.
227 dircheck(struct inodesc *idesc, struct direct *dp)
233 int spaceleft, modified, unused;
236 spaceleft = DIRBLKSIZ - (idesc->id_loc % DIRBLKSIZ);
237 if (dp->d_reclen == 0 ||
238 dp->d_reclen > spaceleft ||
239 (dp->d_reclen & (DIR_ROUNDUP - 1)) != 0)
241 if (dp->d_ino == 0) {
243 * Special case of an unused directory entry. Normally
244 * the kernel would coalesce unused space with the previous
245 * entry by extending its d_reclen, but there are situations
246 * (e.g. fsck) where that doesn't occur.
247 * If we're clearing out directory cruft (-z flag), then make
248 * sure this entry gets fully cleared as well.
250 if (zflag && fswritefd >= 0) {
251 if (dp->d_type != 0) {
255 if (dp->d_namlen != 0) {
259 if (dp->d_name[0] != '\0') {
260 dp->d_name[0] = '\0';
266 size = DIRSIZ(0, dp);
267 namlen = dp->d_namlen;
269 if (dp->d_reclen < size ||
270 idesc->id_filesize < size ||
274 for (cp = dp->d_name, size = 0; size < namlen; size++)
275 if (*cp == '\0' || (*cp++ == '/'))
281 if (zflag && fswritefd >= 0) {
283 * Clear unused directory entry space, including the d_name
286 /* First figure the number of pad bytes. */
287 unused = roundup2(namlen + 1, DIR_ROUNDUP) - (namlen + 1);
289 /* Add in the free space to the end of the record. */
290 unused += dp->d_reclen - DIRSIZ(0, dp);
293 * Now clear out the unused space, keeping track if we actually
296 for (cp = &dp->d_name[namlen + 1]; unused > 0; unused--, cp++) {
312 printf("Bad dir: ino %d reclen %d namlen %d type %d name %s\n",
313 dp->d_ino, dp->d_reclen, dp->d_namlen, dp->d_type,
319 direrror(ino_t ino, const char *errmesg)
322 fileerror(ino, ino, errmesg);
326 fileerror(ino_t cwd, ino_t ino, const char *errmesg)
329 char pathbuf[MAXPATHLEN + 1];
331 pwarn("%s ", errmesg);
332 if (ino < UFS_ROOTINO || ino > maxino) {
333 pfatal("out-of-range inode number %ju", (uintmax_t)ino);
339 getpathname(pathbuf, cwd, ino);
342 (DIP(dp, di_mode) & IFMT) == IFDIR ? "DIR" : "FILE",
345 pfatal("NAME=%s\n", pathbuf);
349 adjust(struct inodesc *idesc, int lcnt)
354 dp = ginode(idesc->id_number);
355 if (DIP(dp, di_nlink) == lcnt) {
357 * If we have not hit any unresolved problems, are running
358 * in preen mode, and are on a file system using soft updates,
359 * then just toss any partially allocated files.
361 if (resolved && (preen || bkgrdflag) && usedsoftdep) {
362 clri(idesc, "UNREF", 1);
366 * The file system can be marked clean even if
367 * a file is not linked up, but is cleared.
368 * Hence, resolved should not be cleared when
369 * linkup is answered no, but clri is answered yes.
371 saveresolved = resolved;
372 if (linkup(idesc->id_number, (ino_t)0, NULL) == 0) {
373 resolved = saveresolved;
374 clri(idesc, "UNREF", 0);
378 * Account for the new reference created by linkup().
380 dp = ginode(idesc->id_number);
385 pwarn("LINK COUNT %s", (lfdir == idesc->id_number) ? lfname :
386 ((DIP(dp, di_mode) & IFMT) == IFDIR ? "DIR" : "FILE"));
387 prtinode(idesc->id_number, dp);
388 printf(" COUNT %d SHOULD BE %d",
389 DIP(dp, di_nlink), DIP(dp, di_nlink) - lcnt);
390 if (preen || usedsoftdep) {
393 pfatal("LINK COUNT INCREASING");
396 printf(" (ADJUSTED)\n");
398 if (preen || reply("ADJUST") == 1) {
399 if (bkgrdflag == 0) {
400 DIP_SET(dp, di_nlink, DIP(dp, di_nlink) - lcnt);
403 cmd.value = idesc->id_number;
406 printf("adjrefcnt ino %ld amt %lld\n",
408 (long long)cmd.size);
409 if (sysctl(adjrefcnt, MIBSIZE, 0, 0,
410 &cmd, sizeof cmd) == -1)
411 rwerror("ADJUST INODE", cmd.value);
418 mkentry(struct inodesc *idesc)
420 struct direct *dirp = idesc->id_dirp;
421 struct direct newent;
424 newent.d_namlen = strlen(idesc->id_name);
425 newlen = DIRSIZ(0, &newent);
426 if (dirp->d_ino != 0)
427 oldlen = DIRSIZ(0, dirp);
430 if (dirp->d_reclen - oldlen < newlen)
432 newent.d_reclen = dirp->d_reclen - oldlen;
433 dirp->d_reclen = oldlen;
434 dirp = (struct direct *)(((char *)dirp) + oldlen);
435 dirp->d_ino = idesc->id_parent; /* ino to be entered is in id_parent */
436 dirp->d_reclen = newent.d_reclen;
437 dirp->d_type = inoinfo(idesc->id_parent)->ino_type;
438 dirp->d_namlen = newent.d_namlen;
439 memmove(dirp->d_name, idesc->id_name, (size_t)newent.d_namlen + 1);
440 return (ALTERED|STOP);
444 chgino(struct inodesc *idesc)
446 struct direct *dirp = idesc->id_dirp;
448 if (memcmp(dirp->d_name, idesc->id_name, (int)dirp->d_namlen + 1))
450 dirp->d_ino = idesc->id_parent;
451 dirp->d_type = inoinfo(idesc->id_parent)->ino_type;
452 return (ALTERED|STOP);
456 linkup(ino_t orphan, ino_t parentdir, char *name)
461 struct inodesc idesc;
462 char tempname[BUFSIZ];
464 memset(&idesc, 0, sizeof(struct inodesc));
466 lostdir = (DIP(dp, di_mode) & IFMT) == IFDIR;
467 pwarn("UNREF %s ", lostdir ? "DIR" : "FILE");
468 prtinode(orphan, dp);
470 if (preen && DIP(dp, di_size) == 0)
472 if (cursnapshot != 0) {
473 pfatal("FILE LINKUP IN SNAPSHOT");
477 printf(" (RECONNECTED)\n");
479 if (reply("RECONNECT") == 0)
482 dp = ginode(UFS_ROOTINO);
483 idesc.id_name = strdup(lfname);
484 idesc.id_type = DATA;
485 idesc.id_func = findino;
486 idesc.id_number = UFS_ROOTINO;
487 if ((ckinode(dp, &idesc) & FOUND) != 0) {
488 lfdir = idesc.id_parent;
490 pwarn("NO lost+found DIRECTORY");
491 if (preen || reply("CREATE")) {
492 lfdir = allocdir(UFS_ROOTINO, (ino_t)0, lfmode);
494 if (makeentry(UFS_ROOTINO, lfdir,
498 printf(" (CREATED)\n");
500 freedir(lfdir, UFS_ROOTINO);
509 pfatal("SORRY. CANNOT CREATE lost+found DIRECTORY");
515 if ((DIP(dp, di_mode) & IFMT) != IFDIR) {
516 pfatal("lost+found IS NOT A DIRECTORY");
517 if (reply("REALLOCATE") == 0)
520 if ((lfdir = allocdir(UFS_ROOTINO, (ino_t)0, lfmode)) == 0) {
521 pfatal("SORRY. CANNOT CREATE lost+found DIRECTORY\n\n");
524 if ((changeino(UFS_ROOTINO, lfname, lfdir) & ALTERED) == 0) {
525 pfatal("SORRY. CANNOT CREATE lost+found DIRECTORY\n\n");
529 idesc.id_type = ADDR;
530 idesc.id_func = pass4check;
531 idesc.id_number = oldlfdir;
532 adjust(&idesc, inoinfo(oldlfdir)->ino_linkcnt + 1);
533 inoinfo(oldlfdir)->ino_linkcnt = 0;
536 if (inoinfo(lfdir)->ino_state != DFOUND) {
537 pfatal("SORRY. NO lost+found DIRECTORY\n\n");
540 (void)lftempname(tempname, orphan);
541 if (makeentry(lfdir, orphan, (name ? name : tempname)) == 0) {
542 pfatal("SORRY. NO SPACE IN lost+found DIRECTORY");
546 inoinfo(orphan)->ino_linkcnt--;
548 if ((changeino(orphan, "..", lfdir) & ALTERED) == 0 &&
549 parentdir != (ino_t)-1)
550 (void)makeentry(orphan, lfdir, "..");
552 DIP_SET(dp, di_nlink, DIP(dp, di_nlink) + 1);
554 inoinfo(lfdir)->ino_linkcnt++;
555 pwarn("DIR I=%lu CONNECTED. ", (u_long)orphan);
556 if (parentdir != (ino_t)-1) {
557 printf("PARENT WAS I=%lu\n", (u_long)parentdir);
559 * The parent directory, because of the ordering
560 * guarantees, has had the link count incremented
561 * for the child, but no entry was made. This
562 * fixes the parent link count so that fsck does
563 * not need to be rerun.
565 inoinfo(parentdir)->ino_linkcnt++;
574 * fix an entry in a directory.
577 changeino(ino_t dir, const char *name, ino_t newnum)
579 struct inodesc idesc;
581 memset(&idesc, 0, sizeof(struct inodesc));
582 idesc.id_type = DATA;
583 idesc.id_func = chgino;
584 idesc.id_number = dir;
585 idesc.id_fix = DONTKNOW;
586 idesc.id_name = strdup(name);
587 idesc.id_parent = newnum; /* new value for name */
588 return (ckinode(ginode(dir), &idesc));
592 * make an entry in a directory
595 makeentry(ino_t parent, ino_t ino, const char *name)
598 struct inodesc idesc;
599 char pathbuf[MAXPATHLEN + 1];
601 if (parent < UFS_ROOTINO || parent >= maxino ||
602 ino < UFS_ROOTINO || ino >= maxino)
604 memset(&idesc, 0, sizeof(struct inodesc));
605 idesc.id_type = DATA;
606 idesc.id_func = mkentry;
607 idesc.id_number = parent;
608 idesc.id_parent = ino; /* this is the inode to enter */
609 idesc.id_fix = DONTKNOW;
610 idesc.id_name = strdup(name);
612 if (DIP(dp, di_size) % DIRBLKSIZ) {
613 DIP_SET(dp, di_size, roundup(DIP(dp, di_size), DIRBLKSIZ));
616 if ((ckinode(dp, &idesc) & ALTERED) != 0)
618 getpathname(pathbuf, parent, parent);
620 if (expanddir(dp, pathbuf) == 0)
622 return (ckinode(dp, &idesc) & ALTERED);
626 * Attempt to expand the size of a directory
629 expanddir(union dinode *dp, char *name)
631 ufs2_daddr_t lastbn, newblk;
633 char *cp, firstblk[DIRBLKSIZ];
635 lastbn = lblkno(&sblock, DIP(dp, di_size));
636 if (lastbn >= UFS_NDADDR - 1 || DIP(dp, di_db[lastbn]) == 0 ||
637 DIP(dp, di_size) == 0)
639 if ((newblk = allocblk(sblock.fs_frag)) == 0)
641 DIP_SET(dp, di_db[lastbn + 1], DIP(dp, di_db[lastbn]));
642 DIP_SET(dp, di_db[lastbn], newblk);
643 DIP_SET(dp, di_size, DIP(dp, di_size) + sblock.fs_bsize);
644 DIP_SET(dp, di_blocks, DIP(dp, di_blocks) + btodb(sblock.fs_bsize));
645 bp = getdirblk(DIP(dp, di_db[lastbn + 1]),
646 sblksize(&sblock, DIP(dp, di_size), lastbn + 1));
649 memmove(firstblk, bp->b_un.b_buf, DIRBLKSIZ);
650 bp = getdirblk(newblk, sblock.fs_bsize);
653 memmove(bp->b_un.b_buf, firstblk, DIRBLKSIZ);
654 for (cp = &bp->b_un.b_buf[DIRBLKSIZ];
655 cp < &bp->b_un.b_buf[sblock.fs_bsize];
657 memmove(cp, &emptydir, sizeof emptydir);
659 bp = getdirblk(DIP(dp, di_db[lastbn + 1]),
660 sblksize(&sblock, DIP(dp, di_size), lastbn + 1));
663 memmove(bp->b_un.b_buf, &emptydir, sizeof emptydir);
664 pwarn("NO SPACE LEFT IN %s", name);
666 printf(" (EXPANDED)\n");
667 else if (reply("EXPAND") == 0)
673 DIP_SET(dp, di_db[lastbn], DIP(dp, di_db[lastbn + 1]));
674 DIP_SET(dp, di_db[lastbn + 1], 0);
675 DIP_SET(dp, di_size, DIP(dp, di_size) - sblock.fs_bsize);
676 DIP_SET(dp, di_blocks, DIP(dp, di_blocks) - btodb(sblock.fs_bsize));
677 freeblk(newblk, sblock.fs_frag);
682 * allocate a new directory
685 allocdir(ino_t parent, ino_t request, int mode)
692 struct dirtemplate *dirp;
694 ino = allocino(request, IFDIR|mode);
697 dirp->dotdot_ino = parent;
699 bp = getdirblk(DIP(dp, di_db[0]), sblock.fs_fsize);
704 memmove(bp->b_un.b_buf, dirp, sizeof(struct dirtemplate));
705 for (cp = &bp->b_un.b_buf[DIRBLKSIZ];
706 cp < &bp->b_un.b_buf[sblock.fs_fsize];
708 memmove(cp, &emptydir, sizeof emptydir);
710 DIP_SET(dp, di_nlink, 2);
712 if (ino == UFS_ROOTINO) {
713 inoinfo(ino)->ino_linkcnt = DIP(dp, di_nlink);
717 if (!INO_IS_DVALID(parent)) {
722 inp = getinoinfo(ino);
723 inp->i_parent = parent;
724 inp->i_dotdot = parent;
725 inoinfo(ino)->ino_state = inoinfo(parent)->ino_state;
726 if (inoinfo(ino)->ino_state == DSTATE) {
727 inoinfo(ino)->ino_linkcnt = DIP(dp, di_nlink);
728 inoinfo(parent)->ino_linkcnt++;
731 DIP_SET(dp, di_nlink, DIP(dp, di_nlink) + 1);
737 * free a directory inode
740 freedir(ino_t ino, ino_t parent)
746 DIP_SET(dp, di_nlink, DIP(dp, di_nlink) - 1);
753 * generate a temporary name for the lost+found directory.
756 lftempname(char *bufp, ino_t ino)
763 for (in = maxino; in > 0; in /= 10)
769 *--cp = (in % 10) + '0';
777 * Get a directory block.
778 * Insure that it is held until another is requested.
780 static struct bufarea *
781 getdirblk(ufs2_daddr_t blkno, long size)
785 pdirbp->b_flags &= ~B_INUSE;
786 pdirbp = getdatablk(blkno, size, BT_DIRDATA);