home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 15 / 15.iso / s / s053 / 8.ddi / usr / include / sys / fs / ufs_fs.h < prev    next >
Encoding:
C/C++ Source or Header  |  1990-12-08  |  17.8 KB  |  402 lines
  1. /*    Copyright (c) 1990 UNIX System Laboratories, Inc.    */
  2. /*    Copyright (c) 1984, 1986, 1987, 1988, 1989, 1990 AT&T    */
  3. /*      All Rights Reserved      */
  4.  
  5. /*    THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF         */
  6. /*    UNIX System Laboratories, Inc.                         */
  7. /*    The copyright notice above does not evidence any       */
  8. /*    actual or intended publication of such source code.    */
  9.  
  10. #ifndef _SYS_FS_UFS_FS_H
  11. #define _SYS_FS_UFS_FS_H
  12.  
  13. #ident    "@(#)/usr/include/sys/fs/ufs_fs.h.sl 1.1 4.0 12/08/90 9486 AT&T-USL"
  14. /*
  15.  * Each disk drive contains some number of file systems.
  16.  * A file system consists of a number of cylinder groups.
  17.  * Each cylinder group has inodes and data.
  18.  *
  19.  * A file system is described by its super-block, which in turn
  20.  * describes the cylinder groups.  The super-block is critical
  21.  * data and is replicated in each cylinder group to protect against
  22.  * catastrophic loss.  This is done at mkfs time and the critical
  23.  * super-block data does not change, so the copies need not be
  24.  * referenced further unless disaster strikes.
  25.  *
  26.  * For file system fs, the offsets of the various blocks of interest
  27.  * are given in the super block as:
  28.  *      [fs->fs_sblkno]         Super-block
  29.  *      [fs->fs_cblkno]         Cylinder group block
  30.  *      [fs->fs_iblkno]         Inode blocks
  31.  *      [fs->fs_dblkno]         Data blocks
  32.  * The beginning of cylinder group cg in fs, is given by
  33.  * the ``cgbase(fs, cg)'' macro.
  34.  *
  35.  * The first boot and super blocks are given in absolute disk addresses.
  36.  */
  37. #define BBSIZE          8192
  38. #define SBSIZE          8192
  39. #define BBLOCK          ((daddr_t)(0))
  40. #define SBLOCK          ((daddr_t)(BBLOCK + BBSIZE / DEV_BSIZE))
  41.  
  42. /*
  43.  * Addresses stored in inodes are capable of addressing fragments
  44.  * of `blocks'. File system blocks of at most size MAXBSIZE can 
  45.  * be optionally broken into 2, 4, or 8 pieces, each of which is
  46.  * addressible; these pieces may be DEV_BSIZE, or some multiple of
  47.  * a DEV_BSIZE unit.
  48.  *
  49.  * Large files consist of exclusively large data blocks.  To avoid
  50.  * undue wasted disk space, the last data block of a small file may be
  51.  * allocated as only as many fragments of a large block as are
  52.  * necessary.  The file system format retains only a single pointer
  53.  * to such a fragment, which is a piece of a single large block that
  54.  * has been divided.  The size of such a fragment is determinable from
  55.  * information in the inode, using the ``blksize(fs, ip, lbn)'' macro.
  56.  *
  57.  * The file system records space availability at the fragment level;
  58.  * to determine block availability, aligned fragments are examined.
  59.  *
  60.  * The root inode is the root of the file system.
  61.  * Inode 0 can't be used for normal purposes and
  62.  * historically bad blocks were linked to inode 1,
  63.  * thus the root inode is 2. (inode 1 is no longer used for
  64.  * this purpose, however numerous dump tapes make this
  65.  * assumption, so we are stuck with it)
  66.  * The lost+found directory is given the next available
  67.  * inode when it is created by ``mkfs''.
  68.  */
  69. #define UFSROOTINO      ((ino_t)2)      /* i number of all roots */
  70. #define LOSTFOUNDINO    (UFSROOTINO + 1)
  71.  
  72. /*
  73.  * Cylinder group related limits.
  74.  *
  75.  * For each cylinder we keep track of the availability of blocks at different
  76.  * rotational positions, so that we can lay out the data to be picked
  77.  * up with minimum rotational latency.  NRPOS is the number of rotational
  78.  * positions which we distinguish.  With NRPOS 8 the resolution of our
  79.  * summary information is 2ms for a typical 3600 rpm drive.
  80.  */
  81. #define NRPOS           8       /* number distinct rotational positions */
  82.  
  83. /*
  84.  * MAXIPG bounds the number of inodes per cylinder group, and
  85.  * is needed only to keep the structure simpler by having the
  86.  * only a single variable size element (the free bit map).
  87.  *
  88.  * N.B.: MAXIPG must be a multiple of INOPB(fs).
  89.  */
  90. #define MAXIPG          2048    /* max number inodes/cyl group */
  91.  
  92. /*
  93.  * MINBSIZE is the smallest allowable block size.
  94.  * In order to insure that it is possible to create files of size
  95.  * 2^32 with only two levels of indirection, MINBSIZE is set to 4096.
  96.  * MINBSIZE must be big enough to hold a cylinder group block,
  97.  * thus changes to (struct cg) must keep its size within MINBSIZE.
  98.  * MAXCPG is limited only to dimension an array in (struct cg);
  99.  * it can be made larger as long as that structures size remains
  100.  * within the bounds dictated by MINBSIZE.
  101.  * Note that super blocks are always of size SBSIZE,
  102.  * and that both SBSIZE and MAXBSIZE must be >= MINBSIZE.
  103.  */
  104. #define MINBSIZE        4096
  105. #define MAXCPG          32      /* maximum fs_cpg */
  106.  
  107. /*
  108.  * The path name on which the file system is mounted is maintained
  109.  * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in 
  110.  * the super block for this name.
  111.  * The limit on the amount of summary information per file system
  112.  * is defined by MAXCSBUFS. It is currently parameterized for a
  113.  * maximum of two million cylinders.
  114.  */
  115. #define MAXMNTLEN 512
  116. #define MAXCSBUFS 32
  117.  
  118. /*
  119.  * Per cylinder group information; summarized in blocks allocated
  120.  * from first cylinder group data blocks.  These blocks have to be
  121.  * read in from fs_csaddr (size fs_cssize) in addition to the
  122.  * super block.
  123.  *
  124.  * N.B. sizeof (struct csum) must be a power of two in order for
  125.  * the ``fs_cs'' macro to work (see below).
  126.  */
  127. struct csum {
  128.         long    cs_ndir;        /* number of directories */
  129.         long    cs_nbfree;      /* number of free blocks */
  130.         long    cs_nifree;      /* number of free inodes */
  131.         long    cs_nffree;      /* number of free frags */
  132. };
  133.  
  134. /*
  135.  * Super block for a file system.
  136.  */
  137. #define FS_MAGIC        0x011954
  138. #define FSACTIVE    0x5e72d81a  /* fs_state: mounted */
  139. #define FSOKAY      0x7c269d38  /* fs_state: clean */
  140. #define FSBAD       0xcb096f43  /* fs_state: bad root */
  141. struct  fs {
  142.         struct  fs *fs_link;            /* linked list of file systems */
  143.         struct  fs *fs_rlink;           /*     used for incore super blocks */
  144.         daddr_t fs_sblkno;              /* addr of super-block in filesys */
  145.         daddr_t fs_cblkno;              /* offset of cyl-block in filesys */
  146.         daddr_t fs_iblkno;              /* offset of inode-blocks in filesys */
  147.         daddr_t fs_dblkno;              /* offset of first data after cg */
  148.         long    fs_cgoffset;            /* cylinder group offset in cylinder */
  149.         long    fs_cgmask;              /* used to calc mod fs_ntrak */
  150.         time_t  fs_time;                /* last time written */
  151.         long    fs_size;                /* number of blocks in fs */
  152.         long    fs_dsize;               /* number of data blocks in fs */
  153.         long    fs_ncg;                 /* number of cylinder groups */
  154.         long    fs_bsize;               /* size of basic blocks in fs */
  155.         long    fs_fsize;               /* size of frag blocks in fs */
  156.         long    fs_frag;                /* number of frags in a block in fs */
  157. /* these are configuration parameters */
  158.         long    fs_minfree;             /* minimum percentage of free blocks */
  159.         long    fs_rotdelay;            /* num of ms for optimal next block */
  160.         long    fs_rps;                 /* disk revolutions per second */
  161. /* these fields can be computed from the others */
  162.         long    fs_bmask;               /* ``blkoff'' calc of blk offsets */
  163.         long    fs_fmask;               /* ``fragoff'' calc of frag offsets */
  164.         long    fs_bshift;              /* ``lblkno'' calc of logical blkno */
  165.         long    fs_fshift;              /* ``numfrags'' calc number of frags */
  166. /* these are configuration parameters */
  167.         long    fs_maxcontig;           /* max number of contiguous blks */
  168.         long    fs_maxbpg;              /* max number of blks per cyl group */
  169. /* these fields can be computed from the others */
  170.         long    fs_fragshift;           /* block to frag shift */
  171.         long    fs_fsbtodb;             /* fsbtodb and dbtofsb shift constant */
  172.         long    fs_sbsize;              /* actual size of super block */
  173.         long    fs_csmask;              /* csum block offset */
  174.         long    fs_csshift;             /* csum block number */
  175.         long    fs_nindir;              /* value of NINDIR */
  176.         long    fs_inopb;               /* value of INOPB */
  177.         long    fs_nspf;                /* value of NSPF */
  178.         long    fs_optim;               /* optimization preference, see below */
  179.    long    fs_state;       /* fiel system state */
  180.            long    fs_sparecon[2];         /* reserved for future constants */
  181.  
  182. /* a unique id for this filesystem (currently unused and unmaintained) */
  183.         long    fs_id[2];               /* file system id */
  184. /* sizes determined by number of cylinder groups and their sizes */
  185.         daddr_t fs_csaddr;              /* blk addr of cyl grp summary area */
  186.         long    fs_cssize;              /* size of cyl grp summary area */
  187.         long    fs_cgsize;              /* cylinder group size */
  188. /* these fields should be derived from the hardware */
  189.         long    fs_ntrak;               /* tracks per cylinder */
  190.         long    fs_nsect;               /* sectors per track */
  191.         long    fs_spc;                 /* sectors per cylinder */
  192. /* this comes from the disk driver partitioning */
  193.         long    fs_ncyl;                /* cylinders in file system */
  194. /* these fields can be computed from the others */
  195.         long    fs_cpg;                 /* cylinders per group */
  196.         long    fs_ipg;                 /* inodes per group */
  197.         long    fs_fpg;                 /* blocks per group * fs_frag */
  198. /* this data must be re-computed after crashes */
  199.         struct  csum fs_cstotal;        /* cylinder summary information */
  200. /* these fields are cleared at mount time */
  201.         char    fs_fmod;                /* super block modified flag */
  202.         char    fs_clean;               /* file system is clean flag */
  203.         char    fs_ronly;               /* mounted read-only flag */
  204.         char    fs_flags;               /* currently unused flag */
  205.         char    fs_fsmnt[MAXMNTLEN];    /* name mounted on */
  206. /* these fields retain the current block allocation info */
  207.         long    fs_cgrotor;             /* last cg searched */
  208.         struct  csum *fs_csp[MAXCSBUFS];/* list of fs_cs info buffers */
  209.         long    fs_cpc;                 /* cyl per cycle in postbl */
  210.         short   fs_postbl[MAXCPG][NRPOS];/* head of blocks for each rotation */
  211.         long    fs_magic;               /* magic number */
  212.         u_char  fs_rotbl[1];            /* list of blocks for each rotation */
  213. /* actually longer */
  214. };
  215.  
  216. /*
  217.  * Preference for optimization.
  218.  */
  219. #define FS_OPTTIME      0       /* minimize allocation time */
  220. #define FS_OPTSPACE     1       /* minimize disk fragmentation */
  221.  
  222. /*
  223.  * Convert cylinder group to base address of its global summary info.
  224.  *
  225.  * N.B. This macro assumes that sizeof (struct csum) is a power of two.
  226.  */
  227. #define fs_cs(fs, indx) \
  228.         fs_csp[(indx) >> (fs)->fs_csshift][(indx) & ~(fs)->fs_csmask]
  229.  
  230. /*
  231.  * MAXBPC bounds the size of the rotational layout tables and
  232.  * is limited by the fact that the super block is of size SBSIZE.
  233.  * The size of these tables is INVERSELY proportional to the block
  234.  * size of the file system. It is aggravated by sector sizes that
  235.  * are not powers of two, as this increases the number of cylinders
  236.  * included before the rotational pattern repeats (fs_cpc).
  237.  * Its size is derived from the number of bytes remaining in (struct fs)
  238.  */
  239. #define MAXBPC  (SBSIZE - sizeof (struct fs))
  240.  
  241. /*
  242.  * Cylinder group block for a file system.
  243.  */
  244. #define CG_MAGIC        0x090255
  245. struct  cg {
  246.         struct  cg *cg_link;            /* linked list of cyl groups */
  247.         struct  cg *cg_rlink;           /*     used for incore cyl groups */
  248.         time_t  cg_time;                /* time last written */
  249.         long    cg_cgx;                 /* we are the cgx'th cylinder group */
  250.         short   cg_ncyl;                /* number of cyl's this cg */
  251.         short   cg_niblk;               /* number of inode blocks this cg */
  252.         long    cg_ndblk;               /* number of data blocks this cg */
  253.         struct  csum cg_cs;             /* cylinder summary information */
  254.         long    cg_rotor;               /* position of last used block */
  255.         long    cg_frotor;              /* position of last used frag */
  256.         long    cg_irotor;              /* position of last used inode */
  257.         long    cg_frsum[MAXFRAG];      /* counts of available frags */
  258.         long    cg_btot[MAXCPG];        /* block totals per cylinder */
  259.         short   cg_b[MAXCPG][NRPOS];    /* positions of free blocks */
  260.         char    cg_iused[MAXIPG/NBBY];  /* used inode map */
  261.         long    cg_magic;               /* magic number */
  262.         u_char  cg_free[1];             /* free block map */
  263. /* actually longer */
  264. };
  265.  
  266. /*
  267.  * MAXBPG bounds the number of blocks of data per cylinder group,
  268.  * and is limited by the fact that cylinder groups are at most one block.
  269.  * Its size is derived from the size of blocks and the (struct cg) size,
  270.  * by the number of remaining bits.
  271.  */
  272. #define MAXBPG(fs) \
  273.         (fragstoblks((fs), (NBBY * ((fs)->fs_bsize - (sizeof (struct cg))))))
  274.  
  275. /*
  276.  * Turn file system block numbers into disk block addresses.
  277.  * This maps file system blocks to device size blocks.
  278.  */
  279. #define fsbtodb(fs, b)  ((b) << (fs)->fs_fsbtodb)
  280. #define dbtofsb(fs, b)  ((b) >> (fs)->fs_fsbtodb)
  281.  
  282. /*
  283.  * Cylinder group macros to locate things in cylinder groups.
  284.  * They calc file system addresses of cylinder group data structures.
  285.  */
  286. #define cgbase(fs, c)   ((daddr_t)((fs)->fs_fpg * (c)))
  287. #define cgstart(fs, c) \
  288.         (cgbase(fs, c) + (fs)->fs_cgoffset * ((c) & ~((fs)->fs_cgmask)))
  289. #define cgsblock(fs, c) (cgstart(fs, c) + (fs)->fs_sblkno)      /* super blk */
  290. #define cgtod(fs, c)    (cgstart(fs, c) + (fs)->fs_cblkno)      /* cg block */
  291. #define cgimin(fs, c)   (cgstart(fs, c) + (fs)->fs_iblkno)      /* inode blk */
  292. #define cgdmin(fs, c)   (cgstart(fs, c) + (fs)->fs_dblkno)      /* 1st data */
  293.  
  294. /*
  295.  * Macros for handling inode numbers:
  296.  *     inode number to file system block offset.
  297.  *     inode number to cylinder group number.
  298.  *     inode number to file system block address.
  299.  */
  300. #define itoo(fs, x)     ((x) % (u_long)INOPB(fs))
  301. #define itog(fs, x)     ((x) / (u_long)(fs)->fs_ipg)
  302. #define itod(fs, x) \
  303.         ((daddr_t)(cgimin(fs, itog(fs, x)) + \
  304.         (blkstofrags((fs), (((x) % (u_long)(fs)->fs_ipg) / (u_long)INOPB(fs))))))
  305.  
  306. /*
  307.  * Give cylinder group number for a file system block.
  308.  * Give cylinder group block number for a file system block.
  309.  */
  310. #define dtog(fs, d)     ((d) / (fs)->fs_fpg)
  311. #define dtogd(fs, d)    ((d) % (fs)->fs_fpg)
  312.  
  313. /*
  314.  * Extract the bits for a block from a map.
  315.  * Compute the cylinder and rotational position of a cyl block addr.
  316.  */
  317. #define blkmap(fs, map, loc) \
  318.     (((map)[(loc) / NBBY] >> ((loc) % NBBY)) & (0xff >> (NBBY - (fs)->fs_frag)))
  319. #define cbtocylno(fs, bno) \
  320.     ((bno) * NSPF(fs) / (fs)->fs_spc)
  321. #define cbtorpos(fs, bno) \
  322.     ((bno) * NSPF(fs) % (fs)->fs_spc % (fs)->fs_nsect * NRPOS / (fs)->fs_nsect)
  323.  
  324. /*
  325.  * The following macros optimize certain frequently calculated
  326.  * quantities by using shifts and masks in place of divisions
  327.  * modulos and multiplications.
  328.  */
  329. #define blkoff(fs, loc)         /* calculates (loc % fs->fs_bsize) */ \
  330.         ((loc) & ~(fs)->fs_bmask)
  331. #define fragoff(fs, loc)        /* calculates (loc % fs->fs_fsize) */ \
  332.         ((loc) & ~(fs)->fs_fmask)
  333. #define lblkno(fs, loc)         /* calculates (loc / fs->fs_bsize) */ \
  334.         ((loc) >> (fs)->fs_bshift)
  335. #define numfrags(fs, loc)       /* calculates (loc / fs->fs_fsize) */ \
  336.         ((loc) >> (fs)->fs_fshift)
  337. #define blkroundup(fs, size)    /* calculates roundup(size, fs->fs_bsize) */ \
  338.         (((size) + (fs)->fs_bsize - 1) & (fs)->fs_bmask)
  339. #define fragroundup(fs, size)   /* calculates roundup(size, fs->fs_fsize) */ \
  340.         (((size) + (fs)->fs_fsize - 1) & (fs)->fs_fmask)
  341. #define fragstoblks(fs, frags)  /* calculates (frags / fs->fs_frag) */ \
  342.         ((frags) >> (fs)->fs_fragshift)
  343. #define blkstofrags(fs, blks)   /* calculates (blks * fs->fs_frag) */ \
  344.         ((blks) << (fs)->fs_fragshift)
  345. #define fragnum(fs, fsb)        /* calculates (fsb % fs->fs_frag) */ \
  346.         ((fsb) & ((fs)->fs_frag - 1))
  347. #define blknum(fs, fsb)         /* calculates rounddown(fsb, fs->fs_frag) */ \
  348.         ((fsb) &~ ((fs)->fs_frag - 1))
  349.  
  350. /*
  351.  * Determine the number of available frags given a
  352.  * percentage to hold in reserve
  353.  */
  354. #define freespace(fs, percentreserved) \
  355.         (blkstofrags((fs), (fs)->fs_cstotal.cs_nbfree) + \
  356.         (fs)->fs_cstotal.cs_nffree - ((fs)->fs_dsize * (percentreserved) / 100))
  357.  
  358. /*
  359.  * Determining the size of a file block in the file system.
  360.  */
  361. #define blksize(fs, ip, lbn) \
  362.         (((lbn) >= NDADDR || (ip)->i_size >= ((lbn) + 1) << (fs)->fs_bshift) \
  363.             ? (fs)->fs_bsize \
  364.             : (fragroundup(fs, blkoff(fs, (ip)->i_size))))
  365. #define dblksize(fs, dip, lbn) \
  366.         (((lbn) >= NDADDR || (dip)->di_size >= ((lbn) + 1) << (fs)->fs_bshift) \
  367.             ? (fs)->fs_bsize \
  368.             : (fragroundup(fs, blkoff(fs, (dip)->di_size))))
  369.  
  370. /*
  371.  * Number of disk sectors per block; assumes DEV_BSIZE byte sector size.
  372.  */
  373. #define NSPB(fs)        ((fs)->fs_nspf << (fs)->fs_fragshift)
  374. #define NSPF(fs)        ((fs)->fs_nspf)
  375.  
  376. /*
  377.  * INOPB is the number of inodes in a secondary storage block.
  378.  */
  379. #define INOPB(fs)       ((fs)->fs_inopb)
  380. #define INOPF(fs)       ((fs)->fs_inopb >> (fs)->fs_fragshift)
  381.  
  382. /*
  383.  * NINDIR is the number of indirects in a file system block.
  384.  */
  385. #define NINDIR(fs)      ((fs)->fs_nindir)
  386.  
  387. /* casts to keep lint happy */
  388. #define insque(q,p)     _insque((caddr_t)q,(caddr_t)p)
  389. #define remque(q)       _remque((caddr_t)q)
  390.  
  391. /*
  392.  * bit map related macros
  393.  */
  394. #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
  395. #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
  396. #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
  397. #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
  398.  
  399. #define getfs(vfsp) ((struct fs *)((struct ufsvfs *)vfsp->vfs_data)->vfs_bufp->b_un.b_addr)
  400.  
  401. #endif /* _SYS_FS_UFS_FS_H */
  402.