fs/freevxfs/vxfs.h

   1 /*
   2  * Copyright (c) 2000-2001 Christoph Hellwig.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions, and the following disclaimer,
  10  *    without modification.
  11  * 2. The name of the author may not be used to endorse or promote products
  12  *    derived from this software without specific prior written permission.
  13  *
  14  * Alternatively, this software may be distributed under the terms of the
  15  * GNU General Public License ("GPL").
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  */
  30 #ifndef _VXFS_SUPER_H_
  31 #define _VXFS_SUPER_H_
  32
  33 /*
  34  * Veritas filesystem driver - superblock structure.
  35  *
  36  * This file contains the definition of the disk and core
  37  * superblocks of the Veritas Filesystem.
  38  */
  39 #include <linux/types.h>
  40
  41 /*
  42  * Superblock magic number (vxfs_super->vs_magic).
  43  */
  44 #define VXFS_SUPER_MAGIC        0xa501FCF5
  45
  46 /*
  47  * The root inode.
  48  */
  49 #define VXFS_ROOT_INO           2
  50
  51 /*
  52  * Num of entries in free extent array
  53  */
  54 #define VXFS_NEFREE             32
  55
  56 enum vxfs_byte_order {
  57         VXFS_BO_LE,
  58         VXFS_BO_BE,
  59 };
  60
  61 typedef __u16 __bitwise __fs16;
  62 typedef __u32 __bitwise __fs32;
  63 typedef __u64 __bitwise __fs64;
  64
  65 /*
  66  * VxFS superblock (disk).
  67  */
  68 struct vxfs_sb {
  69         /*
  70          * Readonly fields for the version 1 superblock.
  71          *
  72          * Lots of this fields are no more used by version 2
  73          * and never filesystems.
  74          */
  75         __fs32          vs_magic;               /* Magic number */
  76         __fs32          vs_version;             /* VxFS version */
  77         __fs32          vs_ctime;               /* create time - secs */
  78         __fs32          vs_cutime;              /* create time - usecs */
  79         __fs32          __unused1;              /* unused */
  80         __fs32          __unused2;              /* unused */
  81         __fs32          vs_old_logstart;        /* obsolete */
  82         __fs32          vs_old_logend;          /* obsolete */
  83         __fs32          vs_bsize;               /* block size */
  84         __fs32          vs_size;                /* number of blocks */
  85         __fs32          vs_dsize;               /* number of data blocks */
  86         __fs32          vs_old_ninode;          /* obsolete */
  87         __fs32          vs_old_nau;             /* obsolete */
  88         __fs32          __unused3;              /* unused */
  89         __fs32          vs_old_defiextsize;     /* obsolete */
  90         __fs32          vs_old_ilbsize;         /* obsolete */
  91         __fs32          vs_immedlen;            /* size of immediate data area */
  92         __fs32          vs_ndaddr;              /* number of direct extentes */
  93         __fs32          vs_firstau;             /* address of first AU */
  94         __fs32          vs_emap;                /* offset of extent map in AU */
  95         __fs32          vs_imap;                /* offset of inode map in AU */
  96         __fs32          vs_iextop;              /* offset of ExtOp. map in AU */
  97         __fs32          vs_istart;              /* offset of inode list in AU */
  98         __fs32          vs_bstart;              /* offset of fdblock in AU */
  99         __fs32          vs_femap;               /* aufirst + emap */
 100         __fs32          vs_fimap;               /* aufirst + imap */
 101         __fs32          vs_fiextop;             /* aufirst + iextop */
 102         __fs32          vs_fistart;             /* aufirst + istart */
 103         __fs32          vs_fbstart;             /* aufirst + bstart */
 104         __fs32          vs_nindir;              /* number of entries in indir */
 105         __fs32          vs_aulen;               /* length of AU in blocks */
 106         __fs32          vs_auimlen;             /* length of imap in blocks */
 107         __fs32          vs_auemlen;             /* length of emap in blocks */
 108         __fs32          vs_auilen;              /* length of ilist in blocks */
 109         __fs32          vs_aupad;               /* length of pad in blocks */
 110         __fs32          vs_aublocks;            /* data blocks in AU */
 111         __fs32          vs_maxtier;             /* log base 2 of aublocks */
 112         __fs32          vs_inopb;               /* number of inodes per blk */
 113         __fs32          vs_old_inopau;          /* obsolete */
 114         __fs32          vs_old_inopilb;         /* obsolete */
 115         __fs32          vs_old_ndiripau;        /* obsolete */
 116         __fs32          vs_iaddrlen;            /* size of indirect addr ext. */
 117         __fs32          vs_bshift;              /* log base 2 of bsize */
 118         __fs32          vs_inoshift;            /* log base 2 of inobp */
 119         __fs32          vs_bmask;               /* ~( bsize - 1 ) */
 120         __fs32          vs_boffmask;            /* bsize - 1 */
 121         __fs32          vs_old_inomask;         /* old_inopilb - 1 */
 122         __fs32          vs_checksum;            /* checksum of V1 data */
 123
 124         /*
 125          * Version 1, writable
 126          */
 127         __fs32          vs_free;                /* number of free blocks */
 128         __fs32          vs_ifree;               /* number of free inodes */
 129         __fs32          vs_efree[VXFS_NEFREE];  /* number of free extents by size */
 130         __fs32          vs_flags;               /* flags ?!? */
 131         __u8            vs_mod;                 /* filesystem has been changed */
 132         __u8            vs_clean;               /* clean FS */
 133         __fs16          __unused4;              /* unused */
 134         __fs32          vs_firstlogid;          /* mount time log ID */
 135         __fs32          vs_wtime;               /* last time written - sec */
 136         __fs32          vs_wutime;              /* last time written - usec */
 137         __u8            vs_fname[6];            /* FS name */
 138         __u8            vs_fpack[6];            /* FS pack name */
 139         __fs32          vs_logversion;          /* log format version */
 140         __u32           __unused5;              /* unused */
 141
 142         /*
 143          * Version 2, Read-only
 144          */
 145         __fs32          vs_oltext[2];           /* OLT extent and replica */
 146         __fs32          vs_oltsize;             /* OLT extent size */
 147         __fs32          vs_iauimlen;            /* size of inode map */
 148         __fs32          vs_iausize;             /* size of IAU in blocks */
 149         __fs32          vs_dinosize;            /* size of inode in bytes */
 150         __fs32          vs_old_dniaddr;         /* indir levels per inode */
 151         __fs32          vs_checksum2;           /* checksum of V2 RO */
 152
 153         /*
 154          * Actually much more...
 155          */
 156 };
 157
 158
 159 /*
 160  * In core superblock filesystem private data for VxFS.
 161  */
 162 struct vxfs_sb_info {
 163         struct vxfs_sb          *vsi_raw;       /* raw (on disk) superblock */
 164         struct buffer_head      *vsi_bp;        /* buffer for raw superblock*/
 165         struct inode            *vsi_fship;     /* fileset header inode */
 166         struct inode            *vsi_ilist;     /* inode list inode */
 167         struct inode            *vsi_stilist;   /* structural inode list inode */
 168         u_long                  vsi_iext;       /* initial inode list */
 169         ino_t                   vsi_fshino;     /* fileset header inode */
 170         daddr_t                 vsi_oltext;     /* OLT extent */
 171         daddr_t                 vsi_oltsize;    /* OLT size */
 172         enum vxfs_byte_order    byte_order;
 173 };
 174
 175 static inline u16 fs16_to_cpu(struct vxfs_sb_info *sbi, __fs16 a)
 176 {
 177         if (sbi->byte_order == VXFS_BO_BE)
 178                 return be16_to_cpu((__force __be16)a);
 179         else
 180                 return le16_to_cpu((__force __le16)a);
 181 }
 182
 183 static inline u32 fs32_to_cpu(struct vxfs_sb_info *sbi, __fs32 a)
 184 {
 185         if (sbi->byte_order == VXFS_BO_BE)
 186                 return be32_to_cpu((__force __be32)a);
 187         else
 188                 return le32_to_cpu((__force __le32)a);
 189 }
 190
 191 static inline u64 fs64_to_cpu(struct vxfs_sb_info *sbi, __fs64 a)
 192 {
 193         if (sbi->byte_order == VXFS_BO_BE)
 194                 return be64_to_cpu((__force __be64)a);
 195         else
 196                 return le64_to_cpu((__force __le64)a);
 197 }
 198
 199 /*
 200  * File modes.  File types above 0xf000 are vxfs internal only, they should
 201  * not be passed back to higher levels of the system.  vxfs file types must
 202  * never have one of the regular file type bits set.
 203  */
 204 enum vxfs_mode {
 205         VXFS_ISUID = 0x00000800,        /* setuid */
 206         VXFS_ISGID = 0x00000400,        /* setgid */
 207         VXFS_ISVTX = 0x00000200,        /* sticky bit */
 208         VXFS_IREAD = 0x00000100,        /* read */
 209         VXFS_IWRITE = 0x00000080,       /* write */
 210         VXFS_IEXEC = 0x00000040,        /* exec */
 211
 212         VXFS_IFIFO = 0x00001000,        /* Named pipe */
 213         VXFS_IFCHR = 0x00002000,        /* Character device */
 214         VXFS_IFDIR = 0x00004000,        /* Directory */
 215         VXFS_IFNAM = 0x00005000,        /* Xenix device ?? */
 216         VXFS_IFBLK = 0x00006000,        /* Block device */
 217         VXFS_IFREG = 0x00008000,        /* Regular file */
 218         VXFS_IFCMP = 0x00009000,        /* Compressed file ?!? */
 219         VXFS_IFLNK = 0x0000a000,        /* Symlink */
 220         VXFS_IFSOC = 0x0000c000,        /* Socket */
 221
 222         /* VxFS internal */
 223         VXFS_IFFSH = 0x10000000,        /* Fileset header */
 224         VXFS_IFILT = 0x20000000,        /* Inode list */
 225         VXFS_IFIAU = 0x30000000,        /* Inode allocation unit */
 226         VXFS_IFCUT = 0x40000000,        /* Current usage table */
 227         VXFS_IFATT = 0x50000000,        /* Attr. inode */
 228         VXFS_IFLCT = 0x60000000,        /* Link count table */
 229         VXFS_IFIAT = 0x70000000,        /* Indirect attribute file */
 230         VXFS_IFEMR = 0x80000000,        /* Extent map reorg file */
 231         VXFS_IFQUO = 0x90000000,        /* BSD quota file */
 232         VXFS_IFPTI = 0xa0000000,        /* "Pass through" inode */
 233         VXFS_IFLAB = 0x11000000,        /* Device label file */
 234         VXFS_IFOLT = 0x12000000,        /* OLT file */
 235         VXFS_IFLOG = 0x13000000,        /* Log file */
 236         VXFS_IFEMP = 0x14000000,        /* Extent map file */
 237         VXFS_IFEAU = 0x15000000,        /* Extent AU file */
 238         VXFS_IFAUS = 0x16000000,        /* Extent AU summary file */
 239         VXFS_IFDEV = 0x17000000,        /* Device config file */
 240
 241 };
 242
 243 #define VXFS_TYPE_MASK          0xfffff000
 244
 245 #define VXFS_IS_TYPE(ip,type)   (((ip)->vii_mode & VXFS_TYPE_MASK) == (type))
 246 #define VXFS_ISFIFO(x)          VXFS_IS_TYPE((x),VXFS_IFIFO)
 247 #define VXFS_ISCHR(x)           VXFS_IS_TYPE((x),VXFS_IFCHR)
 248 #define VXFS_ISDIR(x)           VXFS_IS_TYPE((x),VXFS_IFDIR)
 249 #define VXFS_ISNAM(x)           VXFS_IS_TYPE((x),VXFS_IFNAM)
 250 #define VXFS_ISBLK(x)           VXFS_IS_TYPE((x),VXFS_IFBLK)
 251 #define VXFS_ISLNK(x)           VXFS_IS_TYPE((x),VXFS_IFLNK)
 252 #define VXFS_ISREG(x)           VXFS_IS_TYPE((x),VXFS_IFREG)
 253 #define VXFS_ISCMP(x)           VXFS_IS_TYPE((x),VXFS_IFCMP)
 254 #define VXFS_ISSOC(x)           VXFS_IS_TYPE((x),VXFS_IFSOC)
 255
 256 #define VXFS_ISFSH(x)           VXFS_IS_TYPE((x),VXFS_IFFSH)
 257 #define VXFS_ISILT(x)           VXFS_IS_TYPE((x),VXFS_IFILT)
 258
 259 /*
 260  * Inmode organisation types.
 261  */
 262 enum {
 263         VXFS_ORG_NONE   = 0,    /* Inode has *no* format ?!? */
 264         VXFS_ORG_EXT4   = 1,    /* Ext4 */
 265         VXFS_ORG_IMMED  = 2,    /* All data stored in inode */
 266         VXFS_ORG_TYPED  = 3,    /* Typed extents */
 267 };
 268
 269 #define VXFS_IS_ORG(ip,org)     ((ip)->vii_orgtype == (org))
 270 #define VXFS_ISNONE(ip)         VXFS_IS_ORG((ip), VXFS_ORG_NONE)
 271 #define VXFS_ISEXT4(ip)         VXFS_IS_ORG((ip), VXFS_ORG_EXT4)
 272 #define VXFS_ISIMMED(ip)        VXFS_IS_ORG((ip), VXFS_ORG_IMMED)
 273 #define VXFS_ISTYPED(ip)        VXFS_IS_ORG((ip), VXFS_ORG_TYPED)
 274
 275
 276 /*
 277  * Get filesystem private data from VFS inode.
 278  */
 279 #define VXFS_INO(ip) \
 280         ((struct vxfs_inode_info *)(ip)->i_private)
 281
 282 /*
 283  * Get filesystem private data from VFS superblock.
 284  */
 285 #define VXFS_SBI(sbp) \
 286         ((struct vxfs_sb_info *)(sbp)->s_fs_info)
 287
 288 #endif /* _VXFS_SUPER_H_ */