The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/bsd/ufs/ffs/fs.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*
    2  * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
    3  *
    4  * @APPLE_LICENSE_HEADER_START@
    5  * 
    6  * The contents of this file constitute Original Code as defined in and
    7  * are subject to the Apple Public Source License Version 1.1 (the
    8  * "License").  You may not use this file except in compliance with the
    9  * License.  Please obtain a copy of the License at
   10  * http://www.apple.com/publicsource and read it before using this file.
   11  * 
   12  * This Original Code and all software distributed under the License are
   13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
   14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
   15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
   16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
   17  * License for the specific language governing rights and limitations
   18  * under the License.
   19  * 
   20  * @APPLE_LICENSE_HEADER_END@
   21  */
   22 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
   23 /*
   24  * Copyright (c) 1982, 1986, 1993
   25  *      The Regents of the University of California.  All rights reserved.
   26  *
   27  * Redistribution and use in source and binary forms, with or without
   28  * modification, are permitted provided that the following conditions
   29  * are met:
   30  * 1. Redistributions of source code must retain the above copyright
   31  *    notice, this list of conditions and the following disclaimer.
   32  * 2. Redistributions in binary form must reproduce the above copyright
   33  *    notice, this list of conditions and the following disclaimer in the
   34  *    documentation and/or other materials provided with the distribution.
   35  * 3. All advertising materials mentioning features or use of this software
   36  *    must display the following acknowledgement:
   37  *      This product includes software developed by the University of
   38  *      California, Berkeley and its contributors.
   39  * 4. Neither the name of the University nor the names of its contributors
   40  *    may be used to endorse or promote products derived from this software
   41  *    without specific prior written permission.
   42  *
   43  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   53  * SUCH DAMAGE.
   54  *
   55  *      @(#)fs.h        8.13 (Berkeley) 3/21/95
   56  */
   57 #ifndef _FFS_FS_H_
   58 #define _FFS_FS_H_
   59 
   60 #include <sys/appleapiopts.h>
   61 
   62 #ifdef __APPLE_API_UNSTABLE
   63 /*
   64  * Each disk drive contains some number of file systems.
   65  * A file system consists of a number of cylinder groups.
   66  * Each cylinder group has inodes and data.
   67  *
   68  * A file system is described by its super-block, which in turn
   69  * describes the cylinder groups.  The super-block is critical
   70  * data and is replicated in each cylinder group to protect against
   71  * catastrophic loss.  This is done at `newfs' time and the critical
   72  * super-block data does not change, so the copies need not be
   73  * referenced further unless disaster strikes.
   74  *
   75  * For file system fs, the offsets of the various blocks of interest
   76  * are given in the super block as:
   77  *      [fs->fs_sblkno]         Super-block
   78  *      [fs->fs_cblkno]         Cylinder group block
   79  *      [fs->fs_iblkno]         Inode blocks
   80  *      [fs->fs_dblkno]         Data blocks
   81  * The beginning of cylinder group cg in fs, is given by
   82  * the ``cgbase(fs, cg)'' macro.
   83  *
   84  * The first boot and super blocks are given in absolute disk addresses.
   85  * The byte-offset forms are preferred, as they don't imply a sector size.
   86  */
   87 #define BBSIZE          8192
   88 #define SBSIZE          8192
   89 #define BBOFF           ((off_t)(0))
   90 #define SBOFF           ((off_t)(BBOFF + BBSIZE))
   91 #define BBLOCK          ((ufs_daddr_t)(0))
   92 #define SBLOCK          ((ufs_daddr_t)(BBLOCK + BBSIZE / DEV_BSIZE))
   93 
   94 /*
   95  * Addresses stored in inodes are capable of addressing fragments
   96  * of `blocks'. File system blocks of at most size MAXBSIZE can 
   97  * be optionally broken into 2, 4, or 8 pieces, each of which is
   98  * addressible; these pieces may be DEV_BSIZE, or some multiple of
   99  * a DEV_BSIZE unit.
  100  *
  101  * Large files consist of exclusively large data blocks.  To avoid
  102  * undue wasted disk space, the last data block of a small file may be
  103  * allocated as only as many fragments of a large block as are
  104  * necessary.  The file system format retains only a single pointer
  105  * to such a fragment, which is a piece of a single large block that
  106  * has been divided.  The size of such a fragment is determinable from
  107  * information in the inode, using the ``blksize(fs, ip, lbn)'' macro.
  108  *
  109  * The file system records space availability at the fragment level;
  110  * to determine block availability, aligned fragments are examined.
  111  */
  112 
  113 /*
  114  * MINBSIZE is the smallest allowable block size.
  115  * In order to insure that it is possible to create files of size
  116  * 2^32 with only two levels of indirection, MINBSIZE is set to 4096.
  117  * MINBSIZE must be big enough to hold a cylinder group block,
  118  * thus changes to (struct cg) must keep its size within MINBSIZE.
  119  * Note that super blocks are always of size SBSIZE,
  120  * and that both SBSIZE and MAXBSIZE must be >= MINBSIZE.
  121  */
  122 #define MINBSIZE        4096
  123 
  124 /*
  125  * The path name on which the file system is mounted is maintained
  126  * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in 
  127  * the super block for this name.
  128  */
  129 #define MAXMNTLEN       512
  130 
  131 /*
  132  * The limit on the amount of summary information per file system
  133  * is defined by MAXCSBUFS. It is currently parameterized for a
  134  * size of 128 bytes (2 million cylinder groups on machines with
  135  * 32-bit pointers, and 1 million on 64-bit machines). One pointer
  136  * is taken away to point to an array of cluster sizes that is
  137  * computed as cylinder groups are inspected.
  138  * There is a 128-byte region in the superblock reserved for in-core
  139  * pointers to summary information. Originally this included an array
  140  * of pointers to blocks of struct csum; now there are just three
  141  * pointers and the remaining space is padded with fs_ocsp[].
  142  *
  143  * NOCSPTRS determines the size of this padding. One pointer (fs_csp)
  144  * is taken away to point to a contiguous array of struct csum for
  145  * all cylinder groups; a second (fs_maxcluster) points to an array
  146  * of cluster sizes that is computed as cylinder groups are inspected,
  147  * and the third points to an array that tracks the creation of new
  148  * directories.
  149  */
  150 #define NOCSPTRS ((128 / sizeof(void *)) - 3)
  151 
  152 /*
  153  * A summary of contiguous blocks of various sizes is maintained
  154  * in each cylinder group. Normally this is set by the initial
  155  * value of fs_maxcontig. To conserve space, a maximum summary size
  156  * is set by FS_MAXCONTIG.
  157  */
  158 #define FS_MAXCONTIG    16
  159 
  160 /*
  161  * MINFREE gives the minimum acceptable percentage of file system
  162  * blocks which may be free. If the freelist drops below this level
  163  * only the superuser may continue to allocate blocks. This may
  164  * be set to 0 if no reserve of free blocks is deemed necessary,
  165  * however throughput drops by fifty percent if the file system
  166  * is run at between 95% and 100% full; thus the minimum default
  167  * value of fs_minfree is 5%. However, to get good clustering
  168  * performance, 10% is a better choice. hence we use 10% as our
  169  * default value. With 10% free space, fragmentation is not a
  170  * problem, so we choose to optimize for time.
  171  */
  172 #define MINFREE         5
  173 #define DEFAULTOPT      FS_OPTTIME
  174 
  175 /* Grigoriy Orlov <gluk@ptci.ru> has done some extensive work to fine
  176  * tune the layout preferences for directories within a filesystem.
  177  * His algorithm can be tuned by adjusting the following parameters
  178  * which tell the system the average file size and the average number
  179  * of files per directory. These defaults are well selected for typical
  180  * filesystems, but may need to be tuned for odd cases like filesystems
  181  * being used for squid caches or news spools.
  182  */
  183 #define AVFILESIZ       16384
  184 #define AFPDIR          64
  185 
  186 /*
  187  * Per cylinder group information; summarized in blocks allocated
  188  * from first cylinder group data blocks.  These blocks have to be
  189  * read in from fs_csaddr (size fs_cssize) in addition to the
  190  * super block.
  191  */
  192 struct csum {
  193         int32_t cs_ndir;                /* number of directories */
  194         int32_t cs_nbfree;              /* number of free blocks */
  195         int32_t cs_nifree;              /* number of free inodes */
  196         int32_t cs_nffree;              /* number of free frags */
  197 };
  198 
  199 /*
  200  * Super block for an FFS file system.
  201  */
  202 struct fs {
  203         int32_t  fs_firstfield;         /* historic file system linked list, */
  204         int32_t  fs_unused_1;           /*     used for incore super blocks */
  205         ufs_daddr_t fs_sblkno;          /* addr of super-block in filesys */
  206         ufs_daddr_t fs_cblkno;          /* offset of cyl-block in filesys */
  207         ufs_daddr_t fs_iblkno;          /* offset of inode-blocks in filesys */
  208         ufs_daddr_t fs_dblkno;          /* offset of first data after cg */
  209         int32_t  fs_cgoffset;           /* cylinder group offset in cylinder */
  210         int32_t  fs_cgmask;             /* used to calc mod fs_ntrak */
  211         time_t   fs_time;               /* last time written */
  212         int32_t  fs_size;               /* number of blocks in fs */
  213         int32_t  fs_dsize;              /* number of data blocks in fs */
  214         int32_t  fs_ncg;                /* number of cylinder groups */
  215         int32_t  fs_bsize;              /* size of basic blocks in fs */
  216         int32_t  fs_fsize;              /* size of frag blocks in fs */
  217         int32_t  fs_frag;               /* number of frags in a block in fs */
  218 /* these are configuration parameters */
  219         int32_t  fs_minfree;            /* minimum percentage of free blocks */
  220         int32_t  fs_rotdelay;           /* num of ms for optimal next block */
  221         int32_t  fs_rps;                /* disk revolutions per second */
  222 /* these fields can be computed from the others */
  223         int32_t  fs_bmask;              /* ``blkoff'' calc of blk offsets */
  224         int32_t  fs_fmask;              /* ``fragoff'' calc of frag offsets */
  225         int32_t  fs_bshift;             /* ``lblkno'' calc of logical blkno */
  226         int32_t  fs_fshift;             /* ``numfrags'' calc number of frags */
  227 /* these are configuration parameters */
  228         int32_t  fs_maxcontig;          /* max number of contiguous blks */
  229         int32_t  fs_maxbpg;             /* max number of blks per cyl group */
  230 /* these fields can be computed from the others */
  231         int32_t  fs_fragshift;          /* block to frag shift */
  232         int32_t  fs_fsbtodb;            /* fsbtodb and dbtofsb shift constant */
  233         int32_t  fs_sbsize;             /* actual size of super block */
  234         int32_t  fs_csmask;             /* csum block offset (now unused) */
  235         int32_t  fs_csshift;            /* csum block number (now unused) */
  236         int32_t  fs_nindir;             /* value of NINDIR */
  237         int32_t  fs_inopb;              /* value of INOPB */
  238         int32_t  fs_nspf;               /* value of NSPF */
  239 /* yet another configuration parameter */
  240         int32_t  fs_optim;              /* optimization preference, see below */
  241 /* these fields are derived from the hardware */
  242         int32_t  fs_npsect;             /* # sectors/track including spares */
  243         int32_t  fs_interleave;         /* hardware sector interleave */
  244         int32_t  fs_trackskew;          /* sector 0 skew, per track */
  245         int32_t  fs_headswitch;         /* head switch time, usec */
  246         int32_t  fs_trkseek;            /* track-to-track seek, usec */
  247 /* sizes determined by number of cylinder groups and their sizes */
  248         ufs_daddr_t fs_csaddr;          /* blk addr of cyl grp summary area */
  249         int32_t  fs_cssize;             /* size of cyl grp summary area */
  250         int32_t  fs_cgsize;             /* cylinder group size */
  251 /* these fields are derived from the hardware */
  252         int32_t  fs_ntrak;              /* tracks per cylinder */
  253         int32_t  fs_nsect;              /* sectors per track */
  254         int32_t  fs_spc;                        /* sectors per cylinder */
  255 /* this comes from the disk driver partitioning */
  256         int32_t  fs_ncyl;               /* cylinders in file system */
  257 /* these fields can be computed from the others */
  258         int32_t  fs_cpg;                        /* cylinders per group */
  259         int32_t  fs_ipg;                        /* inodes per group */
  260         int32_t  fs_fpg;                        /* blocks per group * fs_frag */
  261 /* this data must be re-computed after crashes */
  262         struct  csum fs_cstotal;        /* cylinder summary information */
  263 /* these fields are cleared at mount time */
  264         int8_t   fs_fmod;               /* super block modified flag */
  265         int8_t   fs_clean;              /* file system is clean flag */
  266         int8_t   fs_ronly;              /* mounted read-only flag */
  267         int8_t   fs_flags;              /* currently unused flag */
  268         u_char   fs_fsmnt[MAXMNTLEN];   /* name mounted on */
  269 /* these fields retain the current block allocation info */
  270         int32_t  fs_cgrotor;            /* last cg searched */
  271         void    *fs_ocsp[NOCSPTRS];     /* list of fs_cs info buffers */
  272         u_int8_t *fs_contigdirs;        /* # of contiguously allocated dirs */
  273         struct  csum *fs_csp;           /* list of fs_cs info buffers */
  274         int32_t  *fs_maxcluster;        /* max cluster in each cyl group */
  275         int32_t  fs_cpc;                /* cyl per cycle in postbl */
  276         int16_t  fs_opostbl[16][8];     /* old rotation block list head */
  277         int32_t  fs_avgfilesize;        /* expected average file size */
  278         int32_t  fs_avgfpdir;           /* expected # of files per directory */
  279         int32_t  fs_sparecon[48];       /* reserved for future constants */
  280         int32_t  fs_contigsumsize;      /* size of cluster summary array */ 
  281         int32_t  fs_maxsymlinklen;      /* max length of an internal symlink */
  282         int32_t  fs_inodefmt;           /* format of on-disk inodes */
  283         u_int64_t fs_maxfilesize;       /* maximum representable file size */
  284         int64_t  fs_qbmask;             /* ~fs_bmask for use with 64-bit size */
  285         int64_t  fs_qfmask;             /* ~fs_fmask for use with 64-bit size */
  286         int32_t  fs_state;              /* validate fs_clean field */
  287         int32_t  fs_postblformat;       /* format of positional layout tables */
  288         int32_t  fs_nrpos;              /* number of rotational positions */
  289         int32_t  fs_postbloff;          /* (u_int16) rotation block list head */
  290         int32_t  fs_rotbloff;           /* (u_int8) blocks for each rotation */
  291         int32_t  fs_magic;              /* magic number */
  292         u_int8_t fs_space[1];           /* list of blocks for each rotation */
  293 /* actually longer */
  294 };
  295 
  296 /*
  297  * Filesystem identification
  298  */
  299 #define FS_MAGIC        0x011954        /* the fast filesystem magic number */
  300 #define FS_OKAY         0x7c269d38      /* superblock checksum */
  301 #define FS_42INODEFMT   -1              /* 4.2BSD inode format */
  302 #define FS_44INODEFMT   2               /* 4.4BSD inode format */
  303 /*
  304  * Preference for optimization.
  305  */
  306 #define FS_OPTTIME      0       /* minimize allocation time */
  307 #define FS_OPTSPACE     1       /* minimize disk fragmentation */
  308 
  309 /*
  310  * Rotational layout table format types
  311  */
  312 #define FS_42POSTBLFMT          -1      /* 4.2BSD rotational table format */
  313 #define FS_DYNAMICPOSTBLFMT     1       /* dynamic rotational table format */
  314 /*
  315  * Macros for access to superblock array structures
  316  */
  317 #define fs_postbl(fs, cylno) \
  318     (((fs)->fs_postblformat == FS_42POSTBLFMT) \
  319     ? ((fs)->fs_opostbl[cylno]) \
  320     : ((int16_t *)((u_int8_t *)(fs) + \
  321         (fs)->fs_postbloff) + (cylno) * (fs)->fs_nrpos))
  322 #define fs_rotbl(fs) \
  323     (((fs)->fs_postblformat == FS_42POSTBLFMT) \
  324     ? ((fs)->fs_space) \
  325     : ((u_int8_t *)((u_int8_t *)(fs) + (fs)->fs_rotbloff)))
  326 
  327 /*
  328  * The size of a cylinder group is calculated by CGSIZE. The maximum size
  329  * is limited by the fact that cylinder groups are at most one block.
  330  * Its size is derived from the size of the maps maintained in the 
  331  * cylinder group and the (struct cg) size.
  332  */
  333 #define CGSIZE(fs) \
  334     /* base cg */       (sizeof(struct cg) + sizeof(int32_t) + \
  335     /* blktot size */   (fs)->fs_cpg * sizeof(int32_t) + \
  336     /* blks size */     (fs)->fs_cpg * (fs)->fs_nrpos * sizeof(int16_t) + \
  337     /* inode map */     howmany((fs)->fs_ipg, NBBY) + \
  338     /* block map */     howmany((fs)->fs_cpg * (fs)->fs_spc / NSPF(fs), NBBY) +\
  339     /* if present */    ((fs)->fs_contigsumsize <= 0 ? 0 : \
  340     /* cluster sum */   (fs)->fs_contigsumsize * sizeof(int32_t) + \
  341     /* cluster map */   howmany((fs)->fs_cpg * (fs)->fs_spc / NSPB(fs), NBBY)))
  342 
  343 /*
  344  * Convert cylinder group to base address of its global summary info.
  345  *
  346  * N.B. This macro assumes that sizeof(struct csum) is a power of two.
  347  */
  348 #define fs_cs(fs, indx) fs_csp[indx]
  349 
  350 /*
  351  * Cylinder group block for a file system.
  352  */
  353 #define CG_MAGIC        0x090255
  354 struct cg {
  355         int32_t  cg_firstfield;         /* historic cyl groups linked list */
  356         int32_t  cg_magic;              /* magic number */
  357         time_t   cg_time;               /* time last written */
  358         int32_t  cg_cgx;                /* we are the cgx'th cylinder group */
  359         int16_t  cg_ncyl;               /* number of cyl's this cg */
  360         int16_t  cg_niblk;              /* number of inode blocks this cg */
  361         int32_t  cg_ndblk;              /* number of data blocks this cg */
  362         struct  csum cg_cs;             /* cylinder summary information */
  363         int32_t  cg_rotor;              /* position of last used block */
  364         int32_t  cg_frotor;             /* position of last used frag */
  365         int32_t  cg_irotor;             /* position of last used inode */
  366         int32_t  cg_frsum[MAXFRAG];     /* counts of available frags */
  367         int32_t  cg_btotoff;            /* (int32) block totals per cylinder */
  368         int32_t  cg_boff;               /* (u_int16) free block positions */
  369         int32_t  cg_iusedoff;           /* (u_int8) used inode map */
  370         int32_t  cg_freeoff;            /* (u_int8) free block map */
  371         int32_t  cg_nextfreeoff;        /* (u_int8) next available space */
  372         int32_t  cg_clustersumoff;      /* (u_int32) counts of avail clusters */
  373         int32_t  cg_clusteroff;         /* (u_int8) free cluster map */
  374         int32_t  cg_nclusterblks;       /* number of clusters this cg */
  375         int32_t  cg_sparecon[13];       /* reserved for future use */
  376         u_int8_t cg_space[1];           /* space for cylinder group maps */
  377 /* actually longer */
  378 };
  379 
  380 /*
  381  * Macros for access to cylinder group array structures
  382  */
  383 #define cg_blktot(cgp) \
  384     (((cgp)->cg_magic != CG_MAGIC) \
  385     ? (((struct ocg *)(cgp))->cg_btot) \
  386     : ((int32_t *)((u_int8_t *)(cgp) + (cgp)->cg_btotoff)))
  387 #define cg_blks(fs, cgp, cylno) \
  388     (((cgp)->cg_magic != CG_MAGIC) \
  389     ? (((struct ocg *)(cgp))->cg_b[cylno]) \
  390     : ((int16_t *)((u_int8_t *)(cgp) + \
  391         (cgp)->cg_boff) + (cylno) * (fs)->fs_nrpos))
  392 #define cg_inosused(cgp) \
  393     (((cgp)->cg_magic != CG_MAGIC) \
  394     ? (((struct ocg *)(cgp))->cg_iused) \
  395     : ((u_int8_t *)((u_int8_t *)(cgp) + (cgp)->cg_iusedoff)))
  396 #define cg_blksfree(cgp) \
  397     (((cgp)->cg_magic != CG_MAGIC) \
  398     ? (((struct ocg *)(cgp))->cg_free) \
  399     : ((u_int8_t *)((u_int8_t *)(cgp) + (cgp)->cg_freeoff)))
  400 #define cg_chkmagic(cgp) \
  401     ((cgp)->cg_magic == CG_MAGIC || ((struct ocg *)(cgp))->cg_magic == CG_MAGIC)
  402 #define cg_clustersfree(cgp) \
  403     ((u_int8_t *)((u_int8_t *)(cgp) + (cgp)->cg_clusteroff))
  404 #define cg_clustersum(cgp) \
  405     ((int32_t *)((u_int8_t *)(cgp) + (cgp)->cg_clustersumoff))
  406 
  407 /*
  408  * The following structure is defined
  409  * for compatibility with old file systems.
  410  */
  411 struct ocg {
  412         int32_t  cg_firstfield;         /* historic linked list of cyl groups */
  413         int32_t  cg_unused_1;           /*     used for incore cyl groups */
  414         time_t   cg_time;               /* time last written */
  415         int32_t  cg_cgx;                /* we are the cgx'th cylinder group */
  416         int16_t  cg_ncyl;               /* number of cyl's this cg */
  417         int16_t  cg_niblk;              /* number of inode blocks this cg */
  418         int32_t  cg_ndblk;              /* number of data blocks this cg */
  419         struct  csum cg_cs;             /* cylinder summary information */
  420         int32_t  cg_rotor;              /* position of last used block */
  421         int32_t  cg_frotor;             /* position of last used frag */
  422         int32_t  cg_irotor;             /* position of last used inode */
  423         int32_t  cg_frsum[8];           /* counts of available frags */
  424         int32_t  cg_btot[32];           /* block totals per cylinder */
  425         int16_t  cg_b[32][8];           /* positions of free blocks */
  426         u_int8_t cg_iused[256];         /* used inode map */
  427         int32_t  cg_magic;              /* magic number */
  428         u_int8_t cg_free[1];            /* free block map */
  429 /* actually longer */
  430 };
  431 
  432 /*
  433  * Turn file system block numbers into disk block addresses.
  434  * This maps file system blocks to device size blocks.
  435  */
  436 #define fsbtodb(fs, b)  ((b) << (fs)->fs_fsbtodb)
  437 #define dbtofsb(fs, b)  ((b) >> (fs)->fs_fsbtodb)
  438 
  439 /*
  440  * Cylinder group macros to locate things in cylinder groups.
  441  * They calc file system addresses of cylinder group data structures.
  442  */
  443 #define cgbase(fs, c)   ((ufs_daddr_t)((fs)->fs_fpg * (c)))
  444 #define cgdmin(fs, c)   (cgstart(fs, c) + (fs)->fs_dblkno)      /* 1st data */
  445 #define cgimin(fs, c)   (cgstart(fs, c) + (fs)->fs_iblkno)      /* inode blk */
  446 #define cgsblock(fs, c) (cgstart(fs, c) + (fs)->fs_sblkno)      /* super blk */
  447 #define cgtod(fs, c)    (cgstart(fs, c) + (fs)->fs_cblkno)      /* cg block */
  448 #define cgstart(fs, c)                                                  \
  449         (cgbase(fs, c) + (fs)->fs_cgoffset * ((c) & ~((fs)->fs_cgmask)))
  450 
  451 /*
  452  * Macros for handling inode numbers:
  453  *     inode number to file system block offset.
  454  *     inode number to cylinder group number.
  455  *     inode number to file system block address.
  456  */
  457 #define ino_to_cg(fs, x)        ((x) / (fs)->fs_ipg)
  458 #define ino_to_fsba(fs, x)                                              \
  459         ((ufs_daddr_t)(cgimin(fs, ino_to_cg(fs, x)) +                   \
  460             (blkstofrags((fs), (((x) % (fs)->fs_ipg) / INOPB(fs))))))
  461 #define ino_to_fsbo(fs, x)      ((x) % INOPB(fs))
  462 
  463 /*
  464  * Give cylinder group number for a file system block.
  465  * Give cylinder group block number for a file system block.
  466  */
  467 #define dtog(fs, d)     ((d) / (fs)->fs_fpg)
  468 #define dtogd(fs, d)    ((d) % (fs)->fs_fpg)
  469 
  470 /*
  471  * Extract the bits for a block from a map.
  472  * Compute the cylinder and rotational position of a cyl block addr.
  473  */
  474 #define blkmap(fs, map, loc) \
  475     (((map)[(loc) / NBBY] >> ((loc) % NBBY)) & (0xff >> (NBBY - (fs)->fs_frag)))
  476 #define cbtocylno(fs, bno) \
  477     ((bno) * NSPF(fs) / (fs)->fs_spc)
  478 #define cbtorpos(fs, bno) \
  479     (((bno) * NSPF(fs) % (fs)->fs_spc / (fs)->fs_nsect * (fs)->fs_trackskew + \
  480      (bno) * NSPF(fs) % (fs)->fs_spc % (fs)->fs_nsect * (fs)->fs_interleave) % \
  481      (fs)->fs_nsect * (fs)->fs_nrpos / (fs)->fs_npsect)
  482 
  483 /*
  484  * The following macros optimize certain frequently calculated
  485  * quantities by using shifts and masks in place of divisions
  486  * modulos and multiplications.
  487  */
  488 #define blkoff(fs, loc)         /* calculates (loc % fs->fs_bsize) */ \
  489         ((loc) & (fs)->fs_qbmask)
  490 #define fragoff(fs, loc)        /* calculates (loc % fs->fs_fsize) */ \
  491         ((loc) & (fs)->fs_qfmask)
  492 #define lblktosize(fs, blk)     /* calculates (blk * fs->fs_bsize) */ \
  493         ((blk) << (fs)->fs_bshift)
  494 #define lblkno(fs, loc)         /* calculates (loc / fs->fs_bsize) */ \
  495         ((loc) >> (fs)->fs_bshift)
  496 #define numfrags(fs, loc)       /* calculates (loc / fs->fs_fsize) */ \
  497         ((loc) >> (fs)->fs_fshift)
  498 #define blkroundup(fs, size)    /* calculates roundup(size, fs->fs_bsize) */ \
  499         (((size) + (fs)->fs_qbmask) & (fs)->fs_bmask)
  500 #define fragroundup(fs, size)   /* calculates roundup(size, fs->fs_fsize) */ \
  501         (((size) + (fs)->fs_qfmask) & (fs)->fs_fmask)
  502 #define fragstoblks(fs, frags)  /* calculates (frags / fs->fs_frag) */ \
  503         ((frags) >> (fs)->fs_fragshift)
  504 #define blkstofrags(fs, blks)   /* calculates (blks * fs->fs_frag) */ \
  505         ((blks) << (fs)->fs_fragshift)
  506 #define fragnum(fs, fsb)        /* calculates (fsb % fs->fs_frag) */ \
  507         ((fsb) & ((fs)->fs_frag - 1))
  508 #define blknum(fs, fsb)         /* calculates rounddown(fsb, fs->fs_frag) */ \
  509         ((fsb) &~ ((fs)->fs_frag - 1))
  510 
  511 /*
  512  * Determine the number of available frags given a
  513  * percentage to hold in reserve.
  514  */
  515 #define freespace(fs, percentreserved) \
  516         (blkstofrags((fs), (fs)->fs_cstotal.cs_nbfree) + \
  517         (fs)->fs_cstotal.cs_nffree - ((fs)->fs_dsize * (percentreserved) / 100))
  518 
  519 /*
  520  * Determining the size of a file block in the file system.
  521  */
  522 #define blksize(fs, ip, lbn) \
  523         (((lbn) >= NDADDR || (ip)->i_size >= ((lbn) + 1) << (fs)->fs_bshift) \
  524             ? (fs)->fs_bsize \
  525             : (fragroundup(fs, blkoff(fs, (ip)->i_size))))
  526 #define dblksize(fs, dip, lbn) \
  527         (((lbn) >= NDADDR || (dip)->di_size >= ((lbn) + 1) << (fs)->fs_bshift) \
  528             ? (fs)->fs_bsize \
  529             : (fragroundup(fs, blkoff(fs, (dip)->di_size))))
  530 
  531 /*
  532  * Number of disk sectors per block/fragment; assumes DEV_BSIZE byte
  533  * sector size.
  534  */
  535 #define NSPB(fs)        ((fs)->fs_nspf << (fs)->fs_fragshift)
  536 #define NSPF(fs)        ((fs)->fs_nspf)
  537 
  538 /*
  539  * Number of inodes in a secondary storage block/fragment.
  540  */
  541 #define INOPB(fs)       ((fs)->fs_inopb)
  542 #define INOPF(fs)       ((fs)->fs_inopb >> (fs)->fs_fragshift)
  543 
  544 /*
  545  * Number of indirects in a file system block.
  546  */
  547 #define NINDIR(fs)      ((fs)->fs_nindir)
  548 
  549 /*
  550  * This macro controls whether the file system format is byte swapped or not.
  551  * At NeXT, all little endian machines read and write big endian file systems.
  552  */
  553 #define BIG_ENDIAN_FS   (__LITTLE_ENDIAN__)
  554 
  555 #ifdef __APPLE_API_PRIVATE
  556 extern int inside[], around[];
  557 extern u_char *fragtbl[];
  558 #endif /* __APPLE_API_PRIVATE */
  559 
  560 
  561 /*
  562  * UFS Label:
  563  *   The purpose of this label is to name a UFS/FFS filesystem.  The label
  564  *   is located at offset 7K (BBSIZE=8K - UFS_LABEL_SIZE=1K = 7K) of the 
  565  *   partition.  The first 7K is still available for boot blocks.
  566  */
  567 
  568 #define UFS_LABEL_MAGIC         { 'L', 'A', 'B', 'L' }
  569 #define UFS_LABEL_SIZE          1024
  570 #define UFS_LABEL_OFFSET        (BBSIZE - UFS_LABEL_SIZE) /* top 1K */
  571 #define UFS_LABEL_VERSION       1
  572 #define UFS_MAX_LABEL_NAME      512
  573 
  574 struct ufslabel {
  575     u_int32_t           ul_magic;
  576     u_int16_t           ul_checksum;    /* checksum over entire label*/
  577     u_int32_t           ul_version;     /* label version */
  578     u_int32_t           ul_time;        /* creation time */
  579     u_int16_t           ul_namelen;     /* filesystem name length */
  580     u_char              ul_name[UFS_MAX_LABEL_NAME]; /* filesystem name */
  581     u_int64_t           ul_uuid;        /* filesystem uuid */
  582     u_char              ul_reserved[24];/* reserved for future use */
  583     u_char              ul_unused[460]; /* pad out to 1K */
  584 };
  585 
  586 #endif /* __APPLE_API_UNSTABLE */
  587 #endif /* ! _FFS_FS_H_ */

Cache object: e594a7dedd2404b298b7e81096483a1c


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.