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