LXR linux/fs/xfs/xfs

   1/*
   2 * Copyright (c) 2000,2002,2005 Silicon Graphics, Inc.
   3 * All Rights Reserved.
   4 *
   5 * This program is free software; you can redistribute it and/or
   6 * modify it under the terms of the GNU General Public License as
   7 * published by the Free Software Foundation.
   8 *
   9 * This program is distributed in the hope that it would be useful,
  10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 * GNU General Public License for more details.
  13 *
  14 * You should have received a copy of the GNU General Public License
  15 * along with this program; if not, write the Free Software Foundation,
  16 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17 */
  18#ifndef __XFS_DINODE_H__
  19#define __XFS_DINODE_H__
  20
  21struct xfs_buf;
  22struct xfs_mount;
  23
  24#define XFS_DINODE_VERSION_1    1
  25#define XFS_DINODE_VERSION_2    2
  26#define XFS_DINODE_GOOD_VERSION(v)      \
  27        (((v) == XFS_DINODE_VERSION_1 || (v) == XFS_DINODE_VERSION_2))
  28#define XFS_DINODE_MAGIC        0x494e  /* 'IN' */
  29
  30/*
  31 * Disk inode structure.
  32 * This is just the header; the inode is expanded to fill a variable size
  33 * with the last field expanding.  It is split into the core and "other"
  34 * because we only need the core part in the in-core inode.
  35 */
  36typedef struct xfs_timestamp {
  37        __be32          t_sec;          /* timestamp seconds */
  38        __be32          t_nsec;         /* timestamp nanoseconds */
  39} xfs_timestamp_t;
  40
  41/*
  42 * Note: Coordinate changes to this structure with the XFS_DI_* #defines
  43 * below, the offsets table in xfs_ialloc_log_di() and struct xfs_icdinode
  44 * in xfs_inode.h.
  45 */
  46typedef struct xfs_dinode_core {
  47        __be16          di_magic;       /* inode magic # = XFS_DINODE_MAGIC */
  48        __be16          di_mode;        /* mode and type of file */
  49        __u8            di_version;     /* inode version */
  50        __u8            di_format;      /* format of di_c data */
  51        __be16          di_onlink;      /* old number of links to file */
  52        __be32          di_uid;         /* owner's user id */
  53        __be32          di_gid;         /* owner's group id */
  54        __be32          di_nlink;       /* number of links to file */
  55        __be16          di_projid;      /* owner's project id */
  56        __u8            di_pad[8];      /* unused, zeroed space */
  57        __be16          di_flushiter;   /* incremented on flush */
  58        xfs_timestamp_t di_atime;       /* time last accessed */
  59        xfs_timestamp_t di_mtime;       /* time last modified */
  60        xfs_timestamp_t di_ctime;       /* time created/inode modified */
  61        __be64          di_size;        /* number of bytes in file */
  62        __be64          di_nblocks;     /* # of direct & btree blocks used */
  63        __be32          di_extsize;     /* basic/minimum extent size for file */
  64        __be32          di_nextents;    /* number of extents in data fork */
  65        __be16          di_anextents;   /* number of extents in attribute fork*/
  66        __u8            di_forkoff;     /* attr fork offs, <<3 for 64b align */
  67        __s8            di_aformat;     /* format of attr fork's data */
  68        __be32          di_dmevmask;    /* DMIG event mask */
  69        __be16          di_dmstate;     /* DMIG state info */
  70        __be16          di_flags;       /* random flags, XFS_DIFLAG_... */
  71        __be32          di_gen;         /* generation number */
  72} xfs_dinode_core_t;
  73
  74#define DI_MAX_FLUSH 0xffff
  75
  76typedef struct xfs_dinode
  77{
  78        xfs_dinode_core_t       di_core;
  79        /*
  80         * In adding anything between the core and the union, be
  81         * sure to update the macros like XFS_LITINO below and
  82         * XFS_BMAP_RBLOCK_DSIZE in xfs_bmap_btree.h.
  83         */
  84        __be32                  di_next_unlinked;/* agi unlinked list ptr */
  85        union {
  86                xfs_bmdr_block_t di_bmbt;       /* btree root block */
  87                xfs_bmbt_rec_32_t di_bmx[1];    /* extent list */
  88                xfs_dir2_sf_t   di_dir2sf;      /* shortform directory v2 */
  89                char            di_c[1];        /* local contents */
  90                __be32          di_dev;         /* device for S_IFCHR/S_IFBLK */
  91                uuid_t          di_muuid;       /* mount point value */
  92                char            di_symlink[1];  /* local symbolic link */
  93        }               di_u;
  94        union {
  95                xfs_bmdr_block_t di_abmbt;      /* btree root block */
  96                xfs_bmbt_rec_32_t di_abmx[1];   /* extent list */
  97                xfs_attr_shortform_t di_attrsf; /* shortform attribute list */
  98        }               di_a;
  99} xfs_dinode_t;
 100
 101/*
 102 * The 32 bit link count in the inode theoretically maxes out at UINT_MAX.
 103 * Since the pathconf interface is signed, we use 2^31 - 1 instead.
 104 * The old inode format had a 16 bit link count, so its maximum is USHRT_MAX.
 105 */
 106#define XFS_MAXLINK             ((1U << 31) - 1U)
 107#define XFS_MAXLINK_1           65535U
 108
 109/*
 110 * Bit names for logging disk inodes only
 111 */
 112#define XFS_DI_MAGIC            0x0000001
 113#define XFS_DI_MODE             0x0000002
 114#define XFS_DI_VERSION          0x0000004
 115#define XFS_DI_FORMAT           0x0000008
 116#define XFS_DI_ONLINK           0x0000010
 117#define XFS_DI_UID              0x0000020
 118#define XFS_DI_GID              0x0000040
 119#define XFS_DI_NLINK            0x0000080
 120#define XFS_DI_PROJID           0x0000100
 121#define XFS_DI_PAD              0x0000200
 122#define XFS_DI_ATIME            0x0000400
 123#define XFS_DI_MTIME            0x0000800
 124#define XFS_DI_CTIME            0x0001000
 125#define XFS_DI_SIZE             0x0002000
 126#define XFS_DI_NBLOCKS          0x0004000
 127#define XFS_DI_EXTSIZE          0x0008000
 128#define XFS_DI_NEXTENTS         0x0010000
 129#define XFS_DI_NAEXTENTS        0x0020000
 130#define XFS_DI_FORKOFF          0x0040000
 131#define XFS_DI_AFORMAT          0x0080000
 132#define XFS_DI_DMEVMASK         0x0100000
 133#define XFS_DI_DMSTATE          0x0200000
 134#define XFS_DI_FLAGS            0x0400000
 135#define XFS_DI_GEN              0x0800000
 136#define XFS_DI_NEXT_UNLINKED    0x1000000
 137#define XFS_DI_U                0x2000000
 138#define XFS_DI_A                0x4000000
 139#define XFS_DI_NUM_BITS         27
 140#define XFS_DI_ALL_BITS         ((1 << XFS_DI_NUM_BITS) - 1)
 141#define XFS_DI_CORE_BITS        (XFS_DI_ALL_BITS & ~(XFS_DI_U|XFS_DI_A))
 142
 143/*
 144 * Values for di_format
 145 */
 146typedef enum xfs_dinode_fmt
 147{
 148        XFS_DINODE_FMT_DEV,             /* CHR, BLK: di_dev */
 149        XFS_DINODE_FMT_LOCAL,           /* DIR, REG: di_c */
 150                                        /* LNK: di_symlink */
 151        XFS_DINODE_FMT_EXTENTS,         /* DIR, REG, LNK: di_bmx */
 152        XFS_DINODE_FMT_BTREE,           /* DIR, REG, LNK: di_bmbt */
 153        XFS_DINODE_FMT_UUID             /* MNT: di_uuid */
 154} xfs_dinode_fmt_t;
 155
 156/*
 157 * Inode minimum and maximum sizes.
 158 */
 159#define XFS_DINODE_MIN_LOG      8
 160#define XFS_DINODE_MAX_LOG      11
 161#define XFS_DINODE_MIN_SIZE     (1 << XFS_DINODE_MIN_LOG)
 162#define XFS_DINODE_MAX_SIZE     (1 << XFS_DINODE_MAX_LOG)
 163
 164/*
 165 * Inode size for given fs.
 166 */
 167#define XFS_LITINO(mp)  ((mp)->m_litino)
 168#define XFS_BROOT_SIZE_ADJ      \
 169        (sizeof(xfs_bmbt_block_t) - sizeof(xfs_bmdr_block_t))
 170
 171/*
 172 * Inode data & attribute fork sizes, per inode.
 173 */
 174#define XFS_CFORK_Q(dcp)                    ((dcp)->di_forkoff != 0)
 175#define XFS_CFORK_Q_DISK(dcp)               ((dcp)->di_forkoff != 0)
 176
 177#define XFS_CFORK_BOFF(dcp)                 ((int)((dcp)->di_forkoff << 3))
 178#define XFS_CFORK_BOFF_DISK(dcp)            ((int)((dcp)->di_forkoff << 3))
 179
 180#define XFS_CFORK_DSIZE_DISK(dcp,mp) \
 181        (XFS_CFORK_Q_DISK(dcp) ? XFS_CFORK_BOFF_DISK(dcp) : XFS_LITINO(mp))
 182#define XFS_CFORK_DSIZE(dcp,mp) \
 183        (XFS_CFORK_Q(dcp) ? XFS_CFORK_BOFF(dcp) : XFS_LITINO(mp))
 184
 185#define XFS_CFORK_ASIZE_DISK(dcp,mp) \
 186        (XFS_CFORK_Q_DISK(dcp) ? XFS_LITINO(mp) - XFS_CFORK_BOFF_DISK(dcp) : 0)
 187#define XFS_CFORK_ASIZE(dcp,mp) \
 188        (XFS_CFORK_Q(dcp) ? XFS_LITINO(mp) - XFS_CFORK_BOFF(dcp) : 0)
 189
 190#define XFS_CFORK_SIZE_DISK(dcp,mp,w) \
 191        ((w) == XFS_DATA_FORK ? \
 192                XFS_CFORK_DSIZE_DISK(dcp, mp) : \
 193                XFS_CFORK_ASIZE_DISK(dcp, mp))
 194#define XFS_CFORK_SIZE(dcp,mp,w) \
 195        ((w) == XFS_DATA_FORK ? \
 196                XFS_CFORK_DSIZE(dcp, mp) : XFS_CFORK_ASIZE(dcp, mp))
 197
 198#define XFS_DFORK_DSIZE(dip,mp) \
 199        XFS_CFORK_DSIZE_DISK(&(dip)->di_core, mp)
 200#define XFS_DFORK_DSIZE_HOST(dip,mp) \
 201        XFS_CFORK_DSIZE(&(dip)->di_core, mp)
 202#define XFS_DFORK_ASIZE(dip,mp) \
 203        XFS_CFORK_ASIZE_DISK(&(dip)->di_core, mp)
 204#define XFS_DFORK_ASIZE_HOST(dip,mp) \
 205        XFS_CFORK_ASIZE(&(dip)->di_core, mp)
 206#define XFS_DFORK_SIZE(dip,mp,w) \
 207        XFS_CFORK_SIZE_DISK(&(dip)->di_core, mp, w)
 208#define XFS_DFORK_SIZE_HOST(dip,mp,w) \
 209        XFS_CFORK_SIZE(&(dip)->di_core, mp, w)
 210
 211#define XFS_DFORK_Q(dip)                    XFS_CFORK_Q_DISK(&(dip)->di_core)
 212#define XFS_DFORK_BOFF(dip)                 XFS_CFORK_BOFF_DISK(&(dip)->di_core)
 213#define XFS_DFORK_DPTR(dip)                 ((dip)->di_u.di_c)
 214#define XFS_DFORK_APTR(dip)     \
 215        ((dip)->di_u.di_c + XFS_DFORK_BOFF(dip))
 216#define XFS_DFORK_PTR(dip,w)    \
 217        ((w) == XFS_DATA_FORK ? XFS_DFORK_DPTR(dip) : XFS_DFORK_APTR(dip))
 218#define XFS_CFORK_FORMAT(dcp,w) \
 219        ((w) == XFS_DATA_FORK ? (dcp)->di_format : (dcp)->di_aformat)
 220#define XFS_CFORK_FMT_SET(dcp,w,n) \
 221        ((w) == XFS_DATA_FORK ? \
 222                ((dcp)->di_format = (n)) : ((dcp)->di_aformat = (n)))
 223#define XFS_DFORK_FORMAT(dip,w) XFS_CFORK_FORMAT(&(dip)->di_core, w)
 224
 225#define XFS_CFORK_NEXTENTS_DISK(dcp,w) \
 226        ((w) == XFS_DATA_FORK ? \
 227                be32_to_cpu((dcp)->di_nextents) : \
 228                be16_to_cpu((dcp)->di_anextents))
 229#define XFS_CFORK_NEXTENTS(dcp,w) \
 230        ((w) == XFS_DATA_FORK ? (dcp)->di_nextents : (dcp)->di_anextents)
 231#define XFS_DFORK_NEXTENTS(dip,w) XFS_CFORK_NEXTENTS_DISK(&(dip)->di_core, w)
 232#define XFS_DFORK_NEXTENTS_HOST(dip,w) XFS_CFORK_NEXTENTS(&(dip)->di_core, w)
 233
 234#define XFS_CFORK_NEXT_SET(dcp,w,n) \
 235        ((w) == XFS_DATA_FORK ? \
 236                ((dcp)->di_nextents = (n)) : ((dcp)->di_anextents = (n)))
 237
 238#define XFS_BUF_TO_DINODE(bp)   ((xfs_dinode_t *)XFS_BUF_PTR(bp))
 239
 240/*
 241 * Values for di_flags
 242 * There should be a one-to-one correspondence between these flags and the
 243 * XFS_XFLAG_s.
 244 */
 245#define XFS_DIFLAG_REALTIME_BIT  0      /* file's blocks come from rt area */
 246#define XFS_DIFLAG_PREALLOC_BIT  1      /* file space has been preallocated */
 247#define XFS_DIFLAG_NEWRTBM_BIT   2      /* for rtbitmap inode, new format */
 248#define XFS_DIFLAG_IMMUTABLE_BIT 3      /* inode is immutable */
 249#define XFS_DIFLAG_APPEND_BIT    4      /* inode is append-only */
 250#define XFS_DIFLAG_SYNC_BIT      5      /* inode is written synchronously */
 251#define XFS_DIFLAG_NOATIME_BIT   6      /* do not update atime */
 252#define XFS_DIFLAG_NODUMP_BIT    7      /* do not dump */
 253#define XFS_DIFLAG_RTINHERIT_BIT 8      /* create with realtime bit set */
 254#define XFS_DIFLAG_PROJINHERIT_BIT   9  /* create with parents projid */
 255#define XFS_DIFLAG_NOSYMLINKS_BIT   10  /* disallow symlink creation */
 256#define XFS_DIFLAG_EXTSIZE_BIT      11  /* inode extent size allocator hint */
 257#define XFS_DIFLAG_EXTSZINHERIT_BIT 12  /* inherit inode extent size */
 258#define XFS_DIFLAG_NODEFRAG_BIT     13  /* do not reorganize/defragment */
 259#define XFS_DIFLAG_FILESTREAM_BIT   14  /* use filestream allocator */
 260#define XFS_DIFLAG_REALTIME      (1 << XFS_DIFLAG_REALTIME_BIT)
 261#define XFS_DIFLAG_PREALLOC      (1 << XFS_DIFLAG_PREALLOC_BIT)
 262#define XFS_DIFLAG_NEWRTBM       (1 << XFS_DIFLAG_NEWRTBM_BIT)
 263#define XFS_DIFLAG_IMMUTABLE     (1 << XFS_DIFLAG_IMMUTABLE_BIT)
 264#define XFS_DIFLAG_APPEND        (1 << XFS_DIFLAG_APPEND_BIT)
 265#define XFS_DIFLAG_SYNC          (1 << XFS_DIFLAG_SYNC_BIT)
 266#define XFS_DIFLAG_NOATIME       (1 << XFS_DIFLAG_NOATIME_BIT)
 267#define XFS_DIFLAG_NODUMP        (1 << XFS_DIFLAG_NODUMP_BIT)
 268#define XFS_DIFLAG_RTINHERIT     (1 << XFS_DIFLAG_RTINHERIT_BIT)
 269#define XFS_DIFLAG_PROJINHERIT   (1 << XFS_DIFLAG_PROJINHERIT_BIT)
 270#define XFS_DIFLAG_NOSYMLINKS    (1 << XFS_DIFLAG_NOSYMLINKS_BIT)
 271#define XFS_DIFLAG_EXTSIZE       (1 << XFS_DIFLAG_EXTSIZE_BIT)
 272#define XFS_DIFLAG_EXTSZINHERIT  (1 << XFS_DIFLAG_EXTSZINHERIT_BIT)
 273#define XFS_DIFLAG_NODEFRAG      (1 << XFS_DIFLAG_NODEFRAG_BIT)
 274#define XFS_DIFLAG_FILESTREAM    (1 << XFS_DIFLAG_FILESTREAM_BIT)
 275
 276#define XFS_DIFLAG_ANY \
 277        (XFS_DIFLAG_REALTIME | XFS_DIFLAG_PREALLOC | XFS_DIFLAG_NEWRTBM | \
 278         XFS_DIFLAG_IMMUTABLE | XFS_DIFLAG_APPEND | XFS_DIFLAG_SYNC | \
 279         XFS_DIFLAG_NOATIME | XFS_DIFLAG_NODUMP | XFS_DIFLAG_RTINHERIT | \
 280         XFS_DIFLAG_PROJINHERIT | XFS_DIFLAG_NOSYMLINKS | XFS_DIFLAG_EXTSIZE | \
 281         XFS_DIFLAG_EXTSZINHERIT | XFS_DIFLAG_NODEFRAG | XFS_DIFLAG_FILESTREAM)
 282
 283#endif  /* __XFS_DINODE_H__ */
 284