fsck.h revision 110884
1/* 2 * Copyright (c) 2002 Networks Associates Technology, Inc. 3 * All rights reserved. 4 * 5 * This software was developed for the FreeBSD Project by Marshall 6 * Kirk McKusick and Network Associates Laboratories, the Security 7 * Research Division of Network Associates, Inc. under DARPA/SPAWAR 8 * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS 9 * research program. 10 * 11 * Copyright (c) 1980, 1986, 1993 12 * The Regents of the University of California. All rights reserved. 13 * 14 * Redistribution and use in source and binary forms, with or without 15 * modification, are permitted provided that the following conditions 16 * are met: 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 2. Redistributions in binary form must reproduce the above copyright 20 * notice, this list of conditions and the following disclaimer in the 21 * documentation and/or other materials provided with the distribution. 22 * 3. All advertising materials mentioning features or use of this software 23 * must display the following acknowledgement: 24 * This product includes software developed by the University of 25 * California, Berkeley and its contributors. 26 * 4. Neither the name of the University nor the names of its contributors 27 * may be used to endorse or promote products derived from this software 28 * without specific prior written permission. 29 * 30 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 31 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 32 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 33 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 34 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 35 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 36 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 37 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 38 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 39 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 40 * SUCH DAMAGE. 41 * 42 * @(#)fsck.h 8.4 (Berkeley) 5/9/95 43 * $FreeBSD: head/sbin/fsck_ffs/fsck.h 110884 2003-02-14 21:08:14Z mckusick $ 44 */ 45 46#include <unistd.h> 47#include <stdlib.h> 48#include <stdio.h> 49 50#define MAXDUP 10 /* limit on dup blks (per inode) */ 51#define MAXBAD 10 /* limit on bad blks (per inode) */ 52#define MAXBUFSPACE 40*1024 /* maximum space to allocate to buffers */ 53#define INOBUFSIZE 56*1024 /* size of buffer to read inodes in pass1 */ 54 55union dinode { 56 struct ufs1_dinode dp1; 57 struct ufs2_dinode dp2; 58}; 59#define DIP(dp, field) \ 60 ((sblock.fs_magic == FS_UFS1_MAGIC) ? \ 61 (dp)->dp1.field : (dp)->dp2.field) 62 63/* 64 * Each inode on the file system is described by the following structure. 65 * The linkcnt is initially set to the value in the inode. Each time it 66 * is found during the descent in passes 2, 3, and 4 the count is 67 * decremented. Any inodes whose count is non-zero after pass 4 needs to 68 * have its link count adjusted by the value remaining in ino_linkcnt. 69 */ 70struct inostat { 71 char ino_state; /* state of inode, see below */ 72 char ino_type; /* type of inode */ 73 short ino_linkcnt; /* number of links not found */ 74}; 75/* 76 * Inode states. 77 */ 78#define USTATE 01 /* inode not allocated */ 79#define FSTATE 02 /* inode is file */ 80#define DSTATE 03 /* inode is directory */ 81#define DFOUND 04 /* directory found during descent */ 82#define DCLEAR 05 /* directory is to be cleared */ 83#define FCLEAR 06 /* file is to be cleared */ 84/* 85 * Inode state information is contained on per cylinder group lists 86 * which are described by the following structure. 87 */ 88struct inostatlist { 89 long il_numalloced; /* number of inodes allocated in this cg */ 90 struct inostat *il_stat;/* inostat info for this cylinder group */ 91} *inostathead; 92 93/* 94 * buffer cache structure. 95 */ 96struct bufarea { 97 struct bufarea *b_next; /* free list queue */ 98 struct bufarea *b_prev; /* free list queue */ 99 ufs2_daddr_t b_bno; 100 int b_size; 101 int b_errs; 102 int b_flags; 103 union { 104 char *b_buf; /* buffer space */ 105 ufs1_daddr_t *b_indir1; /* UFS1 indirect block */ 106 ufs2_daddr_t *b_indir2; /* UFS2 indirect block */ 107 struct fs *b_fs; /* super block */ 108 struct cg *b_cg; /* cylinder group */ 109 struct ufs1_dinode *b_dinode1; /* UFS1 inode block */ 110 struct ufs2_dinode *b_dinode2; /* UFS2 inode block */ 111 } b_un; 112 char b_dirty; 113}; 114#define IBLK(bp, i) \ 115 ((sblock.fs_magic == FS_UFS1_MAGIC) ? \ 116 (bp)->b_un.b_indir1[i] : (bp)->b_un.b_indir2[i]) 117 118#define B_INUSE 1 119 120#define MINBUFS 5 /* minimum number of buffers required */ 121struct bufarea bufhead; /* head of list of other blks in filesys */ 122struct bufarea sblk; /* file system superblock */ 123struct bufarea cgblk; /* cylinder group blocks */ 124struct bufarea *pdirbp; /* current directory contents */ 125struct bufarea *pbp; /* current inode block */ 126 127#define dirty(bp) do { \ 128 if (fswritefd < 0) \ 129 pfatal("SETTING DIRTY FLAG IN READ_ONLY MODE\n"); \ 130 else \ 131 (bp)->b_dirty = 1; \ 132} while (0) 133#define initbarea(bp) do { \ 134 (bp)->b_dirty = 0; \ 135 (bp)->b_bno = (ufs2_daddr_t)-1; \ 136 (bp)->b_flags = 0; \ 137} while (0) 138 139#define sbdirty() dirty(&sblk) 140#define cgdirty() dirty(&cgblk) 141#define sblock (*sblk.b_un.b_fs) 142#define cgrp (*cgblk.b_un.b_cg) 143 144enum fixstate {DONTKNOW, NOFIX, FIX, IGNORE}; 145ino_t cursnapshot; 146 147struct inodesc { 148 enum fixstate id_fix; /* policy on fixing errors */ 149 int (*id_func)(struct inodesc *); 150 /* function to be applied to blocks of inode */ 151 ino_t id_number; /* inode number described */ 152 ino_t id_parent; /* for DATA nodes, their parent */ 153 ufs_lbn_t id_lbn; /* logical block number of current block */ 154 ufs2_daddr_t id_blkno; /* current block number being examined */ 155 int id_numfrags; /* number of frags contained in block */ 156 off_t id_filesize; /* for DATA nodes, the size of the directory */ 157 ufs2_daddr_t id_entryno;/* for DATA nodes, current entry number */ 158 int id_loc; /* for DATA nodes, current location in dir */ 159 struct direct *id_dirp; /* for DATA nodes, ptr to current entry */ 160 char *id_name; /* for DATA nodes, name to find or enter */ 161 char id_type; /* type of descriptor, DATA or ADDR */ 162}; 163/* file types */ 164#define DATA 1 /* a directory */ 165#define SNAP 2 /* a snapshot */ 166#define ADDR 3 /* anything but a directory or a snapshot */ 167 168/* 169 * Linked list of duplicate blocks. 170 * 171 * The list is composed of two parts. The first part of the 172 * list (from duplist through the node pointed to by muldup) 173 * contains a single copy of each duplicate block that has been 174 * found. The second part of the list (from muldup to the end) 175 * contains duplicate blocks that have been found more than once. 176 * To check if a block has been found as a duplicate it is only 177 * necessary to search from duplist through muldup. To find the 178 * total number of times that a block has been found as a duplicate 179 * the entire list must be searched for occurences of the block 180 * in question. The following diagram shows a sample list where 181 * w (found twice), x (found once), y (found three times), and z 182 * (found once) are duplicate block numbers: 183 * 184 * w -> y -> x -> z -> y -> w -> y 185 * ^ ^ 186 * | | 187 * duplist muldup 188 */ 189struct dups { 190 struct dups *next; 191 ufs2_daddr_t dup; 192}; 193struct dups *duplist; /* head of dup list */ 194struct dups *muldup; /* end of unique duplicate dup block numbers */ 195 196/* 197 * Linked list of inodes with zero link counts. 198 */ 199struct zlncnt { 200 struct zlncnt *next; 201 ino_t zlncnt; 202}; 203struct zlncnt *zlnhead; /* head of zero link count list */ 204 205/* 206 * Inode cache data structures. 207 */ 208struct inoinfo { 209 struct inoinfo *i_nexthash; /* next entry in hash chain */ 210 ino_t i_number; /* inode number of this entry */ 211 ino_t i_parent; /* inode number of parent */ 212 ino_t i_dotdot; /* inode number of `..' */ 213 size_t i_isize; /* size of inode */ 214 u_int i_numblks; /* size of block array in bytes */ 215 ufs2_daddr_t i_blks[1]; /* actually longer */ 216} **inphead, **inpsort; 217long numdirs, dirhash, listmax, inplast; 218long countdirs; /* number of directories we actually found */ 219 220#define MIBSIZE 3 /* size of fsck sysctl MIBs */ 221int adjrefcnt[MIBSIZE]; /* MIB command to adjust inode reference cnt */ 222int adjblkcnt[MIBSIZE]; /* MIB command to adjust inode block count */ 223int freefiles[MIBSIZE]; /* MIB command to free a set of files */ 224int freedirs[MIBSIZE]; /* MIB command to free a set of directories */ 225int freeblks[MIBSIZE]; /* MIB command to free a set of data blocks */ 226struct fsck_cmd cmd; /* sysctl file system update commands */ 227char snapname[BUFSIZ]; /* when doing snapshots, the name of the file */ 228char *cdevname; /* name of device being checked */ 229long dev_bsize; /* computed value of DEV_BSIZE */ 230long secsize; /* actual disk sector size */ 231char nflag; /* assume a no response */ 232char yflag; /* assume a yes response */ 233int bkgrdflag; /* use a snapshot to run on an active system */ 234int bflag; /* location of alternate super block */ 235int debug; /* output debugging info */ 236int cvtlevel; /* convert to newer file system format */ 237int bkgrdcheck; /* determine if background check is possible */ 238char usedsoftdep; /* just fix soft dependency inconsistencies */ 239char preen; /* just fix normal inconsistencies */ 240char rerun; /* rerun fsck. Only used in non-preen mode */ 241int returntosingle; /* 1 => return to single user mode on exit */ 242char resolved; /* cleared if unresolved changes => not clean */ 243char havesb; /* superblock has been read */ 244char skipclean; /* skip clean file systems if preening */ 245int fsmodified; /* 1 => write done to file system */ 246int fsreadfd; /* file descriptor for reading file system */ 247int fswritefd; /* file descriptor for writing file system */ 248 249ufs2_daddr_t maxfsblock; /* number of blocks in the file system */ 250char *blockmap; /* ptr to primary blk allocation map */ 251ino_t maxino; /* number of inodes in file system */ 252 253ino_t lfdir; /* lost & found directory inode number */ 254const char *lfname; /* lost & found directory name */ 255int lfmode; /* lost & found directory creation mode */ 256 257ufs2_daddr_t n_blks; /* number of blocks in use */ 258ino_t n_files; /* number of files in use */ 259 260int got_siginfo; /* received a SIGINFO */ 261 262#define clearinode(dp) \ 263 if (sblock.fs_magic == FS_UFS1_MAGIC) { \ 264 (dp)->dp1 = ufs1_zino; \ 265 } else { \ 266 (dp)->dp2 = ufs2_zino; \ 267 } 268struct ufs1_dinode ufs1_zino; 269struct ufs2_dinode ufs2_zino; 270 271#define setbmap(blkno) setbit(blockmap, blkno) 272#define testbmap(blkno) isset(blockmap, blkno) 273#define clrbmap(blkno) clrbit(blockmap, blkno) 274 275#define STOP 0x01 276#define SKIP 0x02 277#define KEEPON 0x04 278#define ALTERED 0x08 279#define FOUND 0x10 280 281#define EEXIT 8 /* Standard error exit. */ 282 283struct fstab; 284 285 286void adjust(struct inodesc *, int lcnt); 287ufs2_daddr_t allocblk(long frags); 288ino_t allocdir(ino_t parent, ino_t request, int mode); 289ino_t allocino(ino_t request, int type); 290void blkerror(ino_t ino, const char *type, ufs2_daddr_t blk); 291char *blockcheck(char *name); 292int bread(int fd, char *buf, ufs2_daddr_t blk, long size); 293void bufinit(void); 294void bwrite(int fd, char *buf, ufs2_daddr_t blk, long size); 295void cacheino(union dinode *dp, ino_t inumber); 296void catch(int); 297void catchquit(int); 298int changeino(ino_t dir, const char *name, ino_t newnum); 299int chkrange(ufs2_daddr_t blk, int cnt); 300void ckfini(int markclean); 301int ckinode(union dinode *dp, struct inodesc *); 302void clri(struct inodesc *, const char *type, int flag); 303int clearentry(struct inodesc *); 304void direrror(ino_t ino, const char *errmesg); 305int dirscan(struct inodesc *); 306int dofix(struct inodesc *, const char *msg); 307int eascan(struct inodesc *, struct ufs2_dinode *dp); 308void ffs_clrblock(struct fs *, u_char *, ufs1_daddr_t); 309void ffs_fragacct(struct fs *, int, int32_t [], int); 310int ffs_isblock(struct fs *, u_char *, ufs1_daddr_t); 311void ffs_setblock(struct fs *, u_char *, ufs1_daddr_t); 312void fileerror(ino_t cwd, ino_t ino, const char *errmesg); 313int findino(struct inodesc *); 314int findname(struct inodesc *); 315void flush(int fd, struct bufarea *bp); 316void freeblk(ufs2_daddr_t blkno, long frags); 317void freeino(ino_t ino); 318void freeinodebuf(void); 319int ftypeok(union dinode *dp); 320void getblk(struct bufarea *bp, ufs2_daddr_t blk, long size); 321struct bufarea *getdatablk(ufs2_daddr_t blkno, long size); 322struct inoinfo *getinoinfo(ino_t inumber); 323union dinode *getnextinode(ino_t inumber); 324void getpathname(char *namebuf, ino_t curdir, ino_t ino); 325union dinode *ginode(ino_t inumber); 326void infohandler(int sig); 327void inocleanup(void); 328void inodirty(void); 329struct inostat *inoinfo(ino_t inum); 330int linkup(ino_t orphan, ino_t parentdir, char *name); 331int makeentry(ino_t parent, ino_t ino, const char *name); 332void panic(const char *fmt, ...) __printflike(1, 2); 333void pass1(void); 334void pass1b(void); 335int pass1check(struct inodesc *); 336void pass2(void); 337void pass3(void); 338void pass4(void); 339int pass4check(struct inodesc *); 340void pass5(void); 341void pfatal(const char *fmt, ...) __printflike(1, 2); 342void pinode(ino_t ino); 343void propagate(void); 344void pwarn(const char *fmt, ...) __printflike(1, 2); 345int readsb(int listerr); 346int reply(const char *question); 347void rwerror(const char *mesg, ufs2_daddr_t blk); 348void sblock_init(void); 349void setinodebuf(ino_t); 350int setup(char *dev); 351