SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/ocfs2/ocfs2_fs.h

   1 /* -*- mode: c; c-basic-offset: 8; -*-
   2  * vim: noexpandtab sw=8 ts=8 sts=0:
   3  *
   4  * ocfs2_fs.h
   5  *
   6  * On-disk structures for OCFS2.
   7  *
   8  * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public
  12  * License, version 2,  as published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public
  20  * License along with this program; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 021110-1307, USA.
  23  */
  24
  25 #ifndef _OCFS2_FS_H
  26 #define _OCFS2_FS_H
  27
  28 /* Version */
  29 #define OCFS2_MAJOR_REV_LEVEL           0
  30 #define OCFS2_MINOR_REV_LEVEL           90
  31
  32 /*
  33  * An OCFS2 volume starts this way:
  34  * Sector 0: Valid ocfs1_vol_disk_hdr that cleanly fails to mount OCFS.
  35  * Sector 1: Valid ocfs1_vol_label that cleanly fails to mount OCFS.
  36  * Block OCFS2_SUPER_BLOCK_BLKNO: OCFS2 superblock.
  37  *
  38  * All other structures are found from the superblock information.
  39  *
  40  * OCFS2_SUPER_BLOCK_BLKNO is in blocks, not sectors.  eg, for a
  41  * blocksize of 2K, it is 4096 bytes into disk.
  42  */
  43 #define OCFS2_SUPER_BLOCK_BLKNO         2
  44
  45 /*
  46  * Cluster size limits. The maximum is kept arbitrarily at 1 MB, and could
  47  * grow if needed.
  48  */
  49 #define OCFS2_MIN_CLUSTERSIZE           4096
  50 #define OCFS2_MAX_CLUSTERSIZE           1048576
  51
  52 /*
  53  * Blocks cannot be bigger than clusters, so the maximum blocksize is the
  54  * minimum cluster size.
  55  */
  56 #define OCFS2_MIN_BLOCKSIZE             512
  57 #define OCFS2_MAX_BLOCKSIZE             OCFS2_MIN_CLUSTERSIZE
  58
  59 /* Filesystem magic number */
  60 #define OCFS2_SUPER_MAGIC               0x7461636f
  61
  62 /* Object signatures */
  63 #define OCFS2_SUPER_BLOCK_SIGNATURE     "OCFSV2"
  64 #define OCFS2_INODE_SIGNATURE           "INODE01"
  65 #define OCFS2_EXTENT_BLOCK_SIGNATURE    "EXBLK01"
  66 #define OCFS2_GROUP_DESC_SIGNATURE      "GROUP01"
  67 #define OCFS2_XATTR_BLOCK_SIGNATURE     "XATTR01"
  68 #define OCFS2_DIR_TRAILER_SIGNATURE     "DIRTRL1"
  69 #define OCFS2_DX_ROOT_SIGNATURE         "DXDIR01"
  70 #define OCFS2_DX_LEAF_SIGNATURE         "DXLEAF1"
  71 #define OCFS2_REFCOUNT_BLOCK_SIGNATURE  "REFCNT1"
  72
  73 /* Compatibility flags */
  74 #define OCFS2_HAS_COMPAT_FEATURE(sb,mask)                       \
  75         ( OCFS2_SB(sb)->s_feature_compat & (mask) )
  76 #define OCFS2_HAS_RO_COMPAT_FEATURE(sb,mask)                    \
  77         ( OCFS2_SB(sb)->s_feature_ro_compat & (mask) )
  78 #define OCFS2_HAS_INCOMPAT_FEATURE(sb,mask)                     \
  79         ( OCFS2_SB(sb)->s_feature_incompat & (mask) )
  80 #define OCFS2_SET_COMPAT_FEATURE(sb,mask)                       \
  81         OCFS2_SB(sb)->s_feature_compat |= (mask)
  82 #define OCFS2_SET_RO_COMPAT_FEATURE(sb,mask)                    \
  83         OCFS2_SB(sb)->s_feature_ro_compat |= (mask)
  84 #define OCFS2_SET_INCOMPAT_FEATURE(sb,mask)                     \
  85         OCFS2_SB(sb)->s_feature_incompat |= (mask)
  86 #define OCFS2_CLEAR_COMPAT_FEATURE(sb,mask)                     \
  87         OCFS2_SB(sb)->s_feature_compat &= ~(mask)
  88 #define OCFS2_CLEAR_RO_COMPAT_FEATURE(sb,mask)                  \
  89         OCFS2_SB(sb)->s_feature_ro_compat &= ~(mask)
  90 #define OCFS2_CLEAR_INCOMPAT_FEATURE(sb,mask)                   \
  91         OCFS2_SB(sb)->s_feature_incompat &= ~(mask)
  92
  93 #define OCFS2_FEATURE_COMPAT_SUPP       (OCFS2_FEATURE_COMPAT_BACKUP_SB \
  94                                          | OCFS2_FEATURE_COMPAT_JBD2_SB)
  95 #define OCFS2_FEATURE_INCOMPAT_SUPP     (OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT \
  96                                          | OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC \
  97                                          | OCFS2_FEATURE_INCOMPAT_INLINE_DATA \
  98                                          | OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP \
  99                                          | OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK \
 100                                          | OCFS2_FEATURE_INCOMPAT_XATTR \
 101                                          | OCFS2_FEATURE_INCOMPAT_META_ECC \
 102                                          | OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
 103 #define OCFS2_FEATURE_RO_COMPAT_SUPP    (OCFS2_FEATURE_RO_COMPAT_UNWRITTEN \
 104                                          | OCFS2_FEATURE_RO_COMPAT_USRQUOTA \
 105                                          | OCFS2_FEATURE_RO_COMPAT_GRPQUOTA)
 106
 107 /*
 108  * Heartbeat-only devices are missing journals and other files.  The
 109  * filesystem driver can't load them, but the library can.  Never put
 110  * this in OCFS2_FEATURE_INCOMPAT_SUPP, *ever*.
 111  */
 112 #define OCFS2_FEATURE_INCOMPAT_HEARTBEAT_DEV    0x0002
 113
 114 /*
 115  * tunefs sets this incompat flag before starting the resize and clears it
 116  * at the end. This flag protects users from inadvertently mounting the fs
 117  * after an aborted run without fsck-ing.
 118  */
 119 #define OCFS2_FEATURE_INCOMPAT_RESIZE_INPROG    0x0004
 120
 121 /* Used to denote a non-clustered volume */
 122 #define OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT      0x0008
 123
 124 /* Support for sparse allocation in b-trees */
 125 #define OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC     0x0010
 126
 127 /*
 128  * Tunefs sets this incompat flag before starting an operation which
 129  * would require cleanup on abort. This is done to protect users from
 130  * inadvertently mounting the fs after an aborted run without
 131  * fsck-ing.
 132  *
 133  * s_tunefs_flags on the super block describes precisely which
 134  * operations were in progress.
 135  */
 136 #define OCFS2_FEATURE_INCOMPAT_TUNEFS_INPROG    0x0020
 137
 138 /* Support for data packed into inode blocks */
 139 #define OCFS2_FEATURE_INCOMPAT_INLINE_DATA      0x0040
 140
 141 /*
 142  * Support for alternate, userspace cluster stacks.  If set, the superblock
 143  * field s_cluster_info contains a tag for the alternate stack in use as
 144  * well as the name of the cluster being joined.
 145  * mount.ocfs2 must pass in a matching stack name.
 146  *
 147  * If not set, the classic stack will be used.  This is compatbile with
 148  * all older versions.
 149  */
 150 #define OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK  0x0080
 151
 152 /* Support for the extended slot map */
 153 #define OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP 0x100
 154
 155 /* Support for extended attributes */
 156 #define OCFS2_FEATURE_INCOMPAT_XATTR            0x0200
 157
 158 /* Support for indexed directores */
 159 #define OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS     0x0400
 160
 161 /* Metadata checksum and error correction */
 162 #define OCFS2_FEATURE_INCOMPAT_META_ECC         0x0800
 163
 164 /* Refcount tree support */
 165 #define OCFS2_FEATURE_INCOMPAT_REFCOUNT_TREE    0x1000
 166
 167 /*
 168  * backup superblock flag is used to indicate that this volume
 169  * has backup superblocks.
 170  */
 171 #define OCFS2_FEATURE_COMPAT_BACKUP_SB          0x0001
 172
 173 /*
 174  * The filesystem will correctly handle journal feature bits.
 175  */
 176 #define OCFS2_FEATURE_COMPAT_JBD2_SB            0x0002
 177
 178 /*
 179  * Unwritten extents support.
 180  */
 181 #define OCFS2_FEATURE_RO_COMPAT_UNWRITTEN       0x0001
 182
 183 /*
 184  * Maintain quota information for this filesystem
 185  */
 186 #define OCFS2_FEATURE_RO_COMPAT_USRQUOTA        0x0002
 187 #define OCFS2_FEATURE_RO_COMPAT_GRPQUOTA        0x0004
 188
 189 /* The byte offset of the first backup block will be 1G.
 190  * The following will be 4G, 16G, 64G, 256G and 1T.
 191  */
 192 #define OCFS2_BACKUP_SB_START                   1 << 30
 193
 194 /* the max backup superblock nums */
 195 #define OCFS2_MAX_BACKUP_SUPERBLOCKS    6
 196
 197 /*
 198  * Flags on ocfs2_super_block.s_tunefs_flags
 199  */
 200 #define OCFS2_TUNEFS_INPROG_REMOVE_SLOT         0x0001  /* Removing slots */
 201
 202 /*
 203  * Flags on ocfs2_dinode.i_flags
 204  */
 205 #define OCFS2_VALID_FL          (0x00000001)    /* Inode is valid */
 206 #define OCFS2_UNUSED2_FL        (0x00000002)
 207 #define OCFS2_ORPHANED_FL       (0x00000004)    /* On the orphan list */
 208 #define OCFS2_UNUSED3_FL        (0x00000008)
 209 /* System inode flags */
 210 #define OCFS2_SYSTEM_FL         (0x00000010)    /* System inode */
 211 #define OCFS2_SUPER_BLOCK_FL    (0x00000020)    /* Super block */
 212 #define OCFS2_LOCAL_ALLOC_FL    (0x00000040)    /* Slot local alloc bitmap */
 213 #define OCFS2_BITMAP_FL         (0x00000080)    /* Allocation bitmap */
 214 #define OCFS2_JOURNAL_FL        (0x00000100)    /* Slot local journal */
 215 #define OCFS2_HEARTBEAT_FL      (0x00000200)    /* Heartbeat area */
 216 #define OCFS2_CHAIN_FL          (0x00000400)    /* Chain allocator */
 217 #define OCFS2_DEALLOC_FL        (0x00000800)    /* Truncate log */
 218 #define OCFS2_QUOTA_FL          (0x00001000)    /* Quota file */
 219
 220 /*
 221  * Flags on ocfs2_dinode.i_dyn_features
 222  *
 223  * These can change much more often than i_flags. When adding flags,
 224  * keep in mind that i_dyn_features is only 16 bits wide.
 225  */
 226 #define OCFS2_INLINE_DATA_FL    (0x0001)        /* Data stored in inode block */
 227 #define OCFS2_HAS_XATTR_FL      (0x0002)
 228 #define OCFS2_INLINE_XATTR_FL   (0x0004)
 229 #define OCFS2_INDEXED_DIR_FL    (0x0008)
 230 #define OCFS2_HAS_REFCOUNT_FL   (0x0010)
 231
 232 /* Inode attributes, keep in sync with EXT2 */
 233 #define OCFS2_SECRM_FL          (0x00000001)    /* Secure deletion */
 234 #define OCFS2_UNRM_FL           (0x00000002)    /* Undelete */
 235 #define OCFS2_COMPR_FL          (0x00000004)    /* Compress file */
 236 #define OCFS2_SYNC_FL           (0x00000008)    /* Synchronous updates */
 237 #define OCFS2_IMMUTABLE_FL      (0x00000010)    /* Immutable file */
 238 #define OCFS2_APPEND_FL         (0x00000020)    /* writes to file may only append */
 239 #define OCFS2_NODUMP_FL         (0x00000040)    /* do not dump file */
 240 #define OCFS2_NOATIME_FL        (0x00000080)    /* do not update atime */
 241 #define OCFS2_DIRSYNC_FL        (0x00010000)    /* dirsync behaviour (directories only) */
 242
 243 #define OCFS2_FL_VISIBLE        (0x000100FF)    /* User visible flags */
 244 #define OCFS2_FL_MODIFIABLE     (0x000100FF)    /* User modifiable flags */
 245
 246 /*
 247  * Extent record flags (e_node.leaf.flags)
 248  */
 249 #define OCFS2_EXT_UNWRITTEN             (0x01)  /* Extent is allocated but
 250                                                  * unwritten */
 251 #define OCFS2_EXT_REFCOUNTED            (0x02)  /* Extent is reference
 252                                                  * counted in an associated
 253                                                  * refcount tree */
 254
 255 /*
 256  * ioctl commands
 257  */
 258 #define OCFS2_IOC_GETFLAGS      _IOR('f', 1, long)
 259 #define OCFS2_IOC_SETFLAGS      _IOW('f', 2, long)
 260 #define OCFS2_IOC32_GETFLAGS    _IOR('f', 1, int)
 261 #define OCFS2_IOC32_SETFLAGS    _IOW('f', 2, int)
 262
 263 /*
 264  * Space reservation / allocation / free ioctls and argument structure
 265  * are designed to be compatible with XFS.
 266  *
 267  * ALLOCSP* and FREESP* are not and will never be supported, but are
 268  * included here for completeness.
 269  */
 270 struct ocfs2_space_resv {
 271         __s16           l_type;
 272         __s16           l_whence;
 273         __s64           l_start;
 274         __s64           l_len;          /* len == 0 means until end of file */
 275         __s32           l_sysid;
 276         __u32           l_pid;
 277         __s32           l_pad[4];       /* reserve area                     */
 278 };
 279
 280 #define OCFS2_IOC_ALLOCSP               _IOW ('X', 10, struct ocfs2_space_resv)
 281 #define OCFS2_IOC_FREESP                _IOW ('X', 11, struct ocfs2_space_resv)
 282 #define OCFS2_IOC_RESVSP                _IOW ('X', 40, struct ocfs2_space_resv)
 283 #define OCFS2_IOC_UNRESVSP      _IOW ('X', 41, struct ocfs2_space_resv)
 284 #define OCFS2_IOC_ALLOCSP64     _IOW ('X', 36, struct ocfs2_space_resv)
 285 #define OCFS2_IOC_FREESP64      _IOW ('X', 37, struct ocfs2_space_resv)
 286 #define OCFS2_IOC_RESVSP64      _IOW ('X', 42, struct ocfs2_space_resv)
 287 #define OCFS2_IOC_UNRESVSP64    _IOW ('X', 43, struct ocfs2_space_resv)
 288
 289 /* Used to pass group descriptor data when online resize is done */
 290 struct ocfs2_new_group_input {
 291         __u64 group;            /* Group descriptor's blkno. */
 292         __u32 clusters;         /* Total number of clusters in this group */
 293         __u32 frees;            /* Total free clusters in this group */
 294         __u16 chain;            /* Chain for this group */
 295         __u16 reserved1;
 296         __u32 reserved2;
 297 };
 298
 299 #define OCFS2_IOC_GROUP_EXTEND  _IOW('o', 1, int)
 300 #define OCFS2_IOC_GROUP_ADD     _IOW('o', 2,struct ocfs2_new_group_input)
 301 #define OCFS2_IOC_GROUP_ADD64   _IOW('o', 3,struct ocfs2_new_group_input)
 302
 303 /*
 304  * Journal Flags (ocfs2_dinode.id1.journal1.i_flags)
 305  */
 306 #define OCFS2_JOURNAL_DIRTY_FL  (0x00000001)    /* Journal needs recovery */
 307
 308 /*
 309  * superblock s_state flags
 310  */
 311 #define OCFS2_ERROR_FS          (0x00000001)    /* FS saw errors */
 312
 313 /* Limit of space in ocfs2_dir_entry */
 314 #define OCFS2_MAX_FILENAME_LEN          255
 315
 316 /* Maximum slots on an ocfs2 file system */
 317 #define OCFS2_MAX_SLOTS                 255
 318
 319 /* Slot map indicator for an empty slot */
 320 #define OCFS2_INVALID_SLOT              -1
 321
 322 #define OCFS2_VOL_UUID_LEN              16
 323 #define OCFS2_MAX_VOL_LABEL_LEN         64
 324
 325 /* The alternate, userspace stack fields */
 326 #define OCFS2_STACK_LABEL_LEN           4
 327 #define OCFS2_CLUSTER_NAME_LEN          16
 328
 329 /* Journal limits (in bytes) */
 330 #define OCFS2_MIN_JOURNAL_SIZE          (4 * 1024 * 1024)
 331
 332 /*
 333  * Default local alloc size (in megabytes)
 334  *
 335  * The value chosen should be such that most allocations, including new
 336  * block groups, use local alloc.
 337  */
 338 #define OCFS2_DEFAULT_LOCAL_ALLOC_SIZE  8
 339
 340 /*
 341  * Inline extended attribute size (in bytes)
 342  * The value chosen should be aligned to 16 byte boundaries.
 343  */
 344 #define OCFS2_MIN_XATTR_INLINE_SIZE     256
 345
 346 struct ocfs2_system_inode_info {
 347         char    *si_name;
 348         int     si_iflags;
 349         int     si_mode;
 350 };
 351
 352 /* System file index */
 353 enum {
 354         BAD_BLOCK_SYSTEM_INODE = 0,
 355         GLOBAL_INODE_ALLOC_SYSTEM_INODE,
 356         SLOT_MAP_SYSTEM_INODE,
 357 #define OCFS2_FIRST_ONLINE_SYSTEM_INODE SLOT_MAP_SYSTEM_INODE
 358         HEARTBEAT_SYSTEM_INODE,
 359         GLOBAL_BITMAP_SYSTEM_INODE,
 360         USER_QUOTA_SYSTEM_INODE,
 361         GROUP_QUOTA_SYSTEM_INODE,
 362 #define OCFS2_LAST_GLOBAL_SYSTEM_INODE GROUP_QUOTA_SYSTEM_INODE
 363         ORPHAN_DIR_SYSTEM_INODE,
 364         EXTENT_ALLOC_SYSTEM_INODE,
 365         INODE_ALLOC_SYSTEM_INODE,
 366         JOURNAL_SYSTEM_INODE,
 367         LOCAL_ALLOC_SYSTEM_INODE,
 368         TRUNCATE_LOG_SYSTEM_INODE,
 369         LOCAL_USER_QUOTA_SYSTEM_INODE,
 370         LOCAL_GROUP_QUOTA_SYSTEM_INODE,
 371         NUM_SYSTEM_INODES
 372 };
 373
 374 static struct ocfs2_system_inode_info ocfs2_system_inodes[NUM_SYSTEM_INODES] = {
 375         /* Global system inodes (single copy) */
 376         /* The first two are only used from userspace mfks/tunefs */
 377         [BAD_BLOCK_SYSTEM_INODE]                = { "bad_blocks", 0, S_IFREG | 0644 },
 378         [GLOBAL_INODE_ALLOC_SYSTEM_INODE]       = { "global_inode_alloc", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
 379
 380         /* These are used by the running filesystem */
 381         [SLOT_MAP_SYSTEM_INODE]                 = { "slot_map", 0, S_IFREG | 0644 },
 382         [HEARTBEAT_SYSTEM_INODE]                = { "heartbeat", OCFS2_HEARTBEAT_FL, S_IFREG | 0644 },
 383         [GLOBAL_BITMAP_SYSTEM_INODE]            = { "global_bitmap", 0, S_IFREG | 0644 },
 384         [USER_QUOTA_SYSTEM_INODE]               = { "aquota.user", OCFS2_QUOTA_FL, S_IFREG | 0644 },
 385         [GROUP_QUOTA_SYSTEM_INODE]              = { "aquota.group", OCFS2_QUOTA_FL, S_IFREG | 0644 },
 386
 387         /* Slot-specific system inodes (one copy per slot) */
 388         [ORPHAN_DIR_SYSTEM_INODE]               = { "orphan_dir:%04d", 0, S_IFDIR | 0755 },
 389         [EXTENT_ALLOC_SYSTEM_INODE]             = { "extent_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
 390         [INODE_ALLOC_SYSTEM_INODE]              = { "inode_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
 391         [JOURNAL_SYSTEM_INODE]                  = { "journal:%04d", OCFS2_JOURNAL_FL, S_IFREG | 0644 },
 392         [LOCAL_ALLOC_SYSTEM_INODE]              = { "local_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_LOCAL_ALLOC_FL, S_IFREG | 0644 },
 393         [TRUNCATE_LOG_SYSTEM_INODE]             = { "truncate_log:%04d", OCFS2_DEALLOC_FL, S_IFREG | 0644 },
 394         [LOCAL_USER_QUOTA_SYSTEM_INODE]         = { "aquota.user:%04d", OCFS2_QUOTA_FL, S_IFREG | 0644 },
 395         [LOCAL_GROUP_QUOTA_SYSTEM_INODE]        = { "aquota.group:%04d", OCFS2_QUOTA_FL, S_IFREG | 0644 },
 396 };
 397
 398 /* Parameter passed from mount.ocfs2 to module */
 399 #define OCFS2_HB_NONE                   "heartbeat=none"
 400 #define OCFS2_HB_LOCAL                  "heartbeat=local"
 401
 402 /*
 403  * OCFS2 directory file types.  Only the low 3 bits are used.  The
 404  * other bits are reserved for now.
 405  */
 406 #define OCFS2_FT_UNKNOWN        0
 407 #define OCFS2_FT_REG_FILE       1
 408 #define OCFS2_FT_DIR            2
 409 #define OCFS2_FT_CHRDEV         3
 410 #define OCFS2_FT_BLKDEV         4
 411 #define OCFS2_FT_FIFO           5
 412 #define OCFS2_FT_SOCK           6
 413 #define OCFS2_FT_SYMLINK        7
 414
 415 #define OCFS2_FT_MAX            8
 416
 417 /*
 418  * OCFS2_DIR_PAD defines the directory entries boundaries
 419  *
 420  * NOTE: It must be a multiple of 4
 421  */
 422 #define OCFS2_DIR_PAD                   4
 423 #define OCFS2_DIR_ROUND                 (OCFS2_DIR_PAD - 1)
 424 #define OCFS2_DIR_MEMBER_LEN            offsetof(struct ocfs2_dir_entry, name)
 425 #define OCFS2_DIR_REC_LEN(name_len)     (((name_len) + OCFS2_DIR_MEMBER_LEN + \
 426                                           OCFS2_DIR_ROUND) & \
 427                                          ~OCFS2_DIR_ROUND)
 428 #define OCFS2_DIR_MIN_REC_LEN   OCFS2_DIR_REC_LEN(1)
 429
 430 #define OCFS2_LINK_MAX          32000
 431 #define OCFS2_DX_LINK_MAX       ((1U << 31) - 1U)
 432 #define OCFS2_LINKS_HI_SHIFT    16
 433 #define OCFS2_DX_ENTRIES_MAX    (0xffffffffU)
 434
 435 #define S_SHIFT                 12
 436 static unsigned char ocfs2_type_by_mode[S_IFMT >> S_SHIFT] = {
 437         [S_IFREG >> S_SHIFT]  = OCFS2_FT_REG_FILE,
 438         [S_IFDIR >> S_SHIFT]  = OCFS2_FT_DIR,
 439         [S_IFCHR >> S_SHIFT]  = OCFS2_FT_CHRDEV,
 440         [S_IFBLK >> S_SHIFT]  = OCFS2_FT_BLKDEV,
 441         [S_IFIFO >> S_SHIFT]  = OCFS2_FT_FIFO,
 442         [S_IFSOCK >> S_SHIFT] = OCFS2_FT_SOCK,
 443         [S_IFLNK >> S_SHIFT]  = OCFS2_FT_SYMLINK,
 444 };
 445
 446
 447 /*
 448  * Convenience casts
 449  */
 450 #define OCFS2_RAW_SB(dinode)            (&((dinode)->id2.i_super))
 451
 452 /*
 453  * Block checking structure.  This is used in metadata to validate the
 454  * contents.  If OCFS2_FEATURE_INCOMPAT_META_ECC is not set, it is all
 455  * zeros.
 456  */
 457 struct ocfs2_block_check {
 458 /*00*/  __le32 bc_crc32e;       /* 802.3 Ethernet II CRC32 */
 459         __le16 bc_ecc;          /* Single-error-correction parity vector.
 460                                    This is a simple Hamming code dependant
 461                                    on the blocksize.  OCFS2's maximum
 462                                    blocksize, 4K, requires 16 parity bits,
 463                                    so we fit in __le16. */
 464         __le16 bc_reserved1;
 465 /*08*/
 466 };
 467
 468 /*
 469  * On disk extent record for OCFS2
 470  * It describes a range of clusters on disk.
 471  *
 472  * Length fields are divided into interior and leaf node versions.
 473  * This leaves room for a flags field (OCFS2_EXT_*) in the leaf nodes.
 474  */
 475 struct ocfs2_extent_rec {
 476 /*00*/  __le32 e_cpos;          /* Offset into the file, in clusters */
 477         union {
 478                 __le32 e_int_clusters; /* Clusters covered by all children */
 479                 struct {
 480                         __le16 e_leaf_clusters; /* Clusters covered by this
 481                                                    extent */
 482                         __u8 e_reserved1;
 483                         __u8 e_flags; /* Extent flags */
 484                 };
 485         };
 486         __le64 e_blkno;         /* Physical disk offset, in blocks */
 487 /*10*/
 488 };
 489
 490 struct ocfs2_chain_rec {
 491         __le32 c_free;  /* Number of free bits in this chain. */
 492         __le32 c_total; /* Number of total bits in this chain */
 493         __le64 c_blkno; /* Physical disk offset (blocks) of 1st group */
 494 };
 495
 496 struct ocfs2_truncate_rec {
 497         __le32 t_start;         /* 1st cluster in this log */
 498         __le32 t_clusters;      /* Number of total clusters covered */
 499 };
 500
 501 /*
 502  * On disk extent list for OCFS2 (node in the tree).  Note that this
 503  * is contained inside ocfs2_dinode or ocfs2_extent_block, so the
 504  * offsets are relative to ocfs2_dinode.id2.i_list or
 505  * ocfs2_extent_block.h_list, respectively.
 506  */
 507 struct ocfs2_extent_list {
 508 /*00*/  __le16 l_tree_depth;            /* Extent tree depth from this
 509                                            point.  0 means data extents
 510                                            hang directly off this
 511                                            header (a leaf)
 512                                            NOTE: The high 8 bits cannot be
 513                                            used - tree_depth is never that big.
 514                                         */
 515         __le16 l_count;                 /* Number of extent records */
 516         __le16 l_next_free_rec;         /* Next unused extent slot */
 517         __le16 l_reserved1;
 518         __le64 l_reserved2;             /* Pad to
 519                                            sizeof(ocfs2_extent_rec) */
 520 /*10*/  struct ocfs2_extent_rec l_recs[0];      /* Extent records */
 521 };
 522
 523 /*
 524  * On disk allocation chain list for OCFS2.  Note that this is
 525  * contained inside ocfs2_dinode, so the offsets are relative to
 526  * ocfs2_dinode.id2.i_chain.
 527  */
 528 struct ocfs2_chain_list {
 529 /*00*/  __le16 cl_cpg;                  /* Clusters per Block Group */
 530         __le16 cl_bpc;                  /* Bits per cluster */
 531         __le16 cl_count;                /* Total chains in this list */
 532         __le16 cl_next_free_rec;        /* Next unused chain slot */
 533         __le64 cl_reserved1;
 534 /*10*/  struct ocfs2_chain_rec cl_recs[0];      /* Chain records */
 535 };
 536
 537 /*
 538  * On disk deallocation log for OCFS2.  Note that this is
 539  * contained inside ocfs2_dinode, so the offsets are relative to
 540  * ocfs2_dinode.id2.i_dealloc.
 541  */
 542 struct ocfs2_truncate_log {
 543 /*00*/  __le16 tl_count;                /* Total records in this log */
 544         __le16 tl_used;                 /* Number of records in use */
 545         __le32 tl_reserved1;
 546 /*08*/  struct ocfs2_truncate_rec tl_recs[0];   /* Truncate records */
 547 };
 548
 549 /*
 550  * On disk extent block (indirect block) for OCFS2
 551  */
 552 struct ocfs2_extent_block
 553 {
 554 /*00*/  __u8 h_signature[8];            /* Signature for verification */
 555         struct ocfs2_block_check h_check;       /* Error checking */
 556 /*10*/  __le16 h_suballoc_slot;         /* Slot suballocator this
 557                                            extent_header belongs to */
 558         __le16 h_suballoc_bit;          /* Bit offset in suballocator
 559                                            block group */
 560         __le32 h_fs_generation;         /* Must match super block */
 561         __le64 h_blkno;                 /* Offset on disk, in blocks */
 562 /*20*/  __le64 h_reserved3;
 563         __le64 h_next_leaf_blk;         /* Offset on disk, in blocks,
 564                                            of next leaf header pointing
 565                                            to data */
 566 /*30*/  struct ocfs2_extent_list h_list;        /* Extent record list */
 567 /* Actual on-disk size is one block */
 568 };
 569
 570 /*
 571  * On disk slot map for OCFS2.  This defines the contents of the "slot_map"
 572  * system file.  A slot is valid if it contains a node number >= 0.  The
 573  * value -1 (0xFFFF) is OCFS2_INVALID_SLOT.  This marks a slot empty.
 574  */
 575 struct ocfs2_slot_map {
 576 /*00*/  __le16 sm_slots[0];
 577 /*
 578  * Actual on-disk size is one block.  OCFS2_MAX_SLOTS is 255,
 579  * 255 * sizeof(__le16) == 512B, within the 512B block minimum blocksize.
 580  */
 581 };
 582
 583 struct ocfs2_extended_slot {
 584 /*00*/  __u8    es_valid;
 585         __u8    es_reserved1[3];
 586         __le32  es_node_num;
 587 /*10*/
 588 };
 589
 590 /*
 591  * The extended slot map, used when OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP
 592  * is set.  It separates out the valid marker from the node number, and
 593  * has room to grow.  Unlike the old slot map, this format is defined by
 594  * i_size.
 595  */
 596 struct ocfs2_slot_map_extended {
 597 /*00*/  struct ocfs2_extended_slot se_slots[0];
 598 /*
 599  * Actual size is i_size of the slot_map system file.  It should
 600  * match s_max_slots * sizeof(struct ocfs2_extended_slot)
 601  */
 602 };
 603
 604 struct ocfs2_cluster_info {
 605 /*00*/  __u8   ci_stack[OCFS2_STACK_LABEL_LEN];
 606         __le32 ci_reserved;
 607 /*08*/  __u8   ci_cluster[OCFS2_CLUSTER_NAME_LEN];
 608 /*18*/
 609 };
 610
 611 /*
 612  * On disk superblock for OCFS2
 613  * Note that it is contained inside an ocfs2_dinode, so all offsets
 614  * are relative to the start of ocfs2_dinode.id2.
 615  */
 616 struct ocfs2_super_block {
 617 /*00*/  __le16 s_major_rev_level;
 618         __le16 s_minor_rev_level;
 619         __le16 s_mnt_count;
 620         __le16 s_max_mnt_count;
 621         __le16 s_state;                 /* File system state */
 622         __le16 s_errors;                        /* Behaviour when detecting errors */
 623         __le32 s_checkinterval;         /* Max time between checks */
 624 /*10*/  __le64 s_lastcheck;             /* Time of last check */
 625         __le32 s_creator_os;            /* OS */
 626         __le32 s_feature_compat;                /* Compatible feature set */
 627 /*20*/  __le32 s_feature_incompat;      /* Incompatible feature set */
 628         __le32 s_feature_ro_compat;     /* Readonly-compatible feature set */
 629         __le64 s_root_blkno;            /* Offset, in blocks, of root directory
 630                                            dinode */
 631 /*30*/  __le64 s_system_dir_blkno;      /* Offset, in blocks, of system
 632                                            directory dinode */
 633         __le32 s_blocksize_bits;                /* Blocksize for this fs */
 634         __le32 s_clustersize_bits;      /* Clustersize for this fs */
 635 /*40*/  __le16 s_max_slots;             /* Max number of simultaneous mounts
 636                                            before tunefs required */
 637         __le16 s_tunefs_flag;
 638         __le32 s_uuid_hash;             /* hash value of uuid */
 639         __le64 s_first_cluster_group;   /* Block offset of 1st cluster
 640                                          * group header */
 641 /*50*/  __u8  s_label[OCFS2_MAX_VOL_LABEL_LEN]; /* Label for mounting, etc. */
 642 /*90*/  __u8  s_uuid[OCFS2_VOL_UUID_LEN];       /* 128-bit uuid */
 643 /*A0*/  struct ocfs2_cluster_info s_cluster_info; /* Selected userspace
 644                                                      stack.  Only valid
 645                                                      with INCOMPAT flag. */
 646 /*B8*/  __le16 s_xattr_inline_size;     /* extended attribute inline size
 647                                            for this fs*/
 648         __le16 s_reserved0;
 649         __le32 s_dx_seed[3];            /* seed[0-2] for dx dir hash.
 650                                          * s_uuid_hash serves as seed[3]. */
 651 /*C0*/  __le64 s_reserved2[15];         /* Fill out superblock */
 652 /*140*/
 653
 654         /*
 655          * NOTE: As stated above, all offsets are relative to
 656          * ocfs2_dinode.id2, which is at 0xC0 in the inode.
 657          * 0xC0 + 0x140 = 0x200 or 512 bytes.  A superblock must fit within
 658          * our smallest blocksize, which is 512 bytes.  To ensure this,
 659          * we reserve the space in s_reserved2.  Anything past s_reserved2
 660          * will not be available on the smallest blocksize.
 661          */
 662 };
 663
 664 /*
 665  * Local allocation bitmap for OCFS2 slots
 666  * Note that it exists inside an ocfs2_dinode, so all offsets are
 667  * relative to the start of ocfs2_dinode.id2.
 668  */
 669 struct ocfs2_local_alloc
 670 {
 671 /*00*/  __le32 la_bm_off;       /* Starting bit offset in main bitmap */
 672         __le16 la_size;         /* Size of included bitmap, in bytes */
 673         __le16 la_reserved1;
 674         __le64 la_reserved2;
 675 /*10*/  __u8   la_bitmap[0];
 676 };
 677
 678 /*
 679  * Data-in-inode header. This is only used if i_dyn_features has
 680  * OCFS2_INLINE_DATA_FL set.
 681  */
 682 struct ocfs2_inline_data
 683 {
 684 /*00*/  __le16  id_count;       /* Number of bytes that can be used
 685                                  * for data, starting at id_data */
 686         __le16  id_reserved0;
 687         __le32  id_reserved1;
 688         __u8    id_data[0];     /* Start of user data */
 689 };
 690
 691 /*
 692  * On disk inode for OCFS2
 693  */
 694 struct ocfs2_dinode {
 695 /*00*/  __u8 i_signature[8];            /* Signature for validation */
 696         __le32 i_generation;            /* Generation number */
 697         __le16 i_suballoc_slot;         /* Slot suballocator this inode
 698                                            belongs to */
 699         __le16 i_suballoc_bit;          /* Bit offset in suballocator
 700                                            block group */
 701 /*10*/  __le16 i_links_count_hi;        /* High 16 bits of links count */
 702         __le16 i_xattr_inline_size;
 703         __le32 i_clusters;              /* Cluster count */
 704         __le32 i_uid;                   /* Owner UID */
 705         __le32 i_gid;                   /* Owning GID */
 706 /*20*/  __le64 i_size;                  /* Size in bytes */
 707         __le16 i_mode;                  /* File mode */
 708         __le16 i_links_count;           /* Links count */
 709         __le32 i_flags;                 /* File flags */
 710 /*30*/  __le64 i_atime;                 /* Access time */
 711         __le64 i_ctime;                 /* Creation time */
 712 /*40*/  __le64 i_mtime;                 /* Modification time */
 713         __le64 i_dtime;                 /* Deletion time */
 714 /*50*/  __le64 i_blkno;                 /* Offset on disk, in blocks */
 715         __le64 i_last_eb_blk;           /* Pointer to last extent
 716                                            block */
 717 /*60*/  __le32 i_fs_generation;         /* Generation per fs-instance */
 718         __le32 i_atime_nsec;
 719         __le32 i_ctime_nsec;
 720         __le32 i_mtime_nsec;
 721 /*70*/  __le32 i_attr;
 722         __le16 i_orphaned_slot;         /* Only valid when OCFS2_ORPHANED_FL
 723                                            was set in i_flags */
 724         __le16 i_dyn_features;
 725         __le64 i_xattr_loc;
 726 /*80*/  struct ocfs2_block_check i_check;       /* Error checking */
 727 /*88*/  __le64 i_dx_root;               /* Pointer to dir index root block */
 728 /*90*/  __le64 i_refcount_loc;
 729         __le64 i_reserved2[4];
 730 /*B8*/  union {
 731                 __le64 i_pad1;          /* Generic way to refer to this
 732                                            64bit union */
 733                 struct {
 734                         __le64 i_rdev;  /* Device number */
 735                 } dev1;
 736                 struct {                /* Info for bitmap system
 737                                            inodes */
 738                         __le32 i_used;  /* Bits (ie, clusters) used  */
 739                         __le32 i_total; /* Total bits (clusters)
 740                                            available */
 741                 } bitmap1;
 742                 struct {                /* Info for journal system
 743                                            inodes */
 744                         __le32 ij_flags;        /* Mounted, version, etc. */
 745                         __le32 ij_recovery_generation; /* Incremented when the
 746                                                           journal is recovered
 747                                                           after an unclean
 748                                                           shutdown */
 749                 } journal1;
 750         } id1;                          /* Inode type dependant 1 */
 751 /*C0*/  union {
 752                 struct ocfs2_super_block        i_super;
 753                 struct ocfs2_local_alloc        i_lab;
 754                 struct ocfs2_chain_list         i_chain;
 755                 struct ocfs2_extent_list        i_list;
 756                 struct ocfs2_truncate_log       i_dealloc;
 757                 struct ocfs2_inline_data        i_data;
 758                 __u8                            i_symlink[0];
 759         } id2;
 760 /* Actual on-disk size is one block */
 761 };
 762
 763 /*
 764  * On-disk directory entry structure for OCFS2
 765  *
 766  * Packed as this structure could be accessed unaligned on 64-bit platforms
 767  */
 768 struct ocfs2_dir_entry {
 769 /*00*/  __le64   inode;                  /* Inode number */
 770         __le16   rec_len;                /* Directory entry length */
 771         __u8    name_len;               /* Name length */
 772         __u8    file_type;
 773 /*0C*/  char    name[OCFS2_MAX_FILENAME_LEN];   /* File name */
 774 /* Actual on-disk length specified by rec_len */
 775 } __attribute__ ((packed));
 776
 777 /*
 778  * Per-block record for the unindexed directory btree. This is carefully
 779  * crafted so that the rec_len and name_len records of an ocfs2_dir_entry are
 780  * mirrored. That way, the directory manipulation code needs a minimal amount
 781  * of update.
 782  *
 783  * NOTE: Keep this structure aligned to a multiple of 4 bytes.
 784  */
 785 struct ocfs2_dir_block_trailer {
 786 /*00*/  __le64          db_compat_inode;        /* Always zero. Was inode */
 787
 788         __le16          db_compat_rec_len;      /* Backwards compatible with
 789                                                  * ocfs2_dir_entry. */
 790         __u8            db_compat_name_len;     /* Always zero. Was name_len */
 791         __u8            db_reserved0;
 792         __le16          db_reserved1;
 793         __le16          db_free_rec_len;        /* Size of largest empty hole
 794                                                  * in this block. (unused) */
 795 /*10*/  __u8            db_signature[8];        /* Signature for verification */
 796         __le64          db_reserved2;
 797         __le64          db_free_next;           /* Next block in list (unused) */
 798 /*20*/  __le64          db_blkno;               /* Offset on disk, in blocks */
 799         __le64          db_parent_dinode;       /* dinode which owns me, in
 800                                                    blocks */
 801 /*30*/  struct ocfs2_block_check db_check;      /* Error checking */
 802 /*40*/
 803 };
 804
 805  /*
 806  * A directory entry in the indexed tree. We don't store the full name here,
 807  * but instead provide a pointer to the full dirent in the unindexed tree.
 808  *
 809  * We also store name_len here so as to reduce the number of leaf blocks we
 810  * need to search in case of collisions.
 811  */
 812 struct ocfs2_dx_entry {
 813         __le32          dx_major_hash;  /* Used to find logical
 814                                          * cluster in index */
 815         __le32          dx_minor_hash;  /* Lower bits used to find
 816                                          * block in cluster */
 817         __le64          dx_dirent_blk;  /* Physical block in unindexed
 818                                          * tree holding this dirent. */
 819 };
 820
 821 struct ocfs2_dx_entry_list {
 822         __le32          de_reserved;
 823         __le16          de_count;       /* Maximum number of entries
 824                                          * possible in de_entries */
 825         __le16          de_num_used;    /* Current number of
 826                                          * de_entries entries */
 827         struct  ocfs2_dx_entry          de_entries[0];  /* Indexed dir entries
 828                                                          * in a packed array of
 829                                                          * length de_num_used */
 830 };
 831
 832 #define OCFS2_DX_FLAG_INLINE    0x01
 833
 834 /*
 835  * A directory indexing block. Each indexed directory has one of these,
 836  * pointed to by ocfs2_dinode.
 837  *
 838  * This block stores an indexed btree root, and a set of free space
 839  * start-of-list pointers.
 840  */
 841 struct ocfs2_dx_root_block {
 842         __u8            dr_signature[8];        /* Signature for verification */
 843         struct ocfs2_block_check dr_check;      /* Error checking */
 844         __le16          dr_suballoc_slot;       /* Slot suballocator this
 845                                                  * block belongs to. */
 846         __le16          dr_suballoc_bit;        /* Bit offset in suballocator
 847                                                  * block group */
 848         __le32          dr_fs_generation;       /* Must match super block */
 849         __le64          dr_blkno;               /* Offset on disk, in blocks */
 850         __le64          dr_last_eb_blk;         /* Pointer to last
 851                                                  * extent block */
 852         __le32          dr_clusters;            /* Clusters allocated
 853                                                  * to the indexed tree. */
 854         __u8            dr_flags;               /* OCFS2_DX_FLAG_* flags */
 855         __u8            dr_reserved0;
 856         __le16          dr_reserved1;
 857         __le64          dr_dir_blkno;           /* Pointer to parent inode */
 858         __le32          dr_num_entries;         /* Total number of
 859                                                  * names stored in
 860                                                  * this directory.*/
 861         __le32          dr_reserved2;
 862         __le64          dr_free_blk;            /* Pointer to head of free
 863                                                  * unindexed block list. */
 864         __le64          dr_reserved3[15];
 865         union {
 866                 struct ocfs2_extent_list dr_list; /* Keep this aligned to 128
 867                                                    * bits for maximum space
 868                                                    * efficiency. */
 869                 struct ocfs2_dx_entry_list dr_entries; /* In-root-block list of
 870                                                         * entries. We grow out
 871                                                         * to extents if this
 872                                                         * gets too big. */
 873         };
 874 };
 875
 876 /*
 877  * The header of a leaf block in the indexed tree.
 878  */
 879 struct ocfs2_dx_leaf {
 880         __u8            dl_signature[8];/* Signature for verification */
 881         struct ocfs2_block_check dl_check;      /* Error checking */
 882         __le64          dl_blkno;       /* Offset on disk, in blocks */
 883         __le32          dl_fs_generation;/* Must match super block */
 884         __le32          dl_reserved0;
 885         __le64          dl_reserved1;
 886         struct ocfs2_dx_entry_list      dl_list;
 887 };
 888
 889 /*
 890  * On disk allocator group structure for OCFS2
 891  */
 892 struct ocfs2_group_desc
 893 {
 894 /*00*/  __u8    bg_signature[8];        /* Signature for validation */
 895         __le16   bg_size;                /* Size of included bitmap in
 896                                            bytes. */
 897         __le16   bg_bits;                /* Bits represented by this
 898                                            group. */
 899         __le16  bg_free_bits_count;     /* Free bits count */
 900         __le16   bg_chain;               /* What chain I am in. */
 901 /*10*/  __le32   bg_generation;
 902         __le32  bg_reserved1;
 903         __le64   bg_next_group;          /* Next group in my list, in
 904                                            blocks */
 905 /*20*/  __le64   bg_parent_dinode;       /* dinode which owns me, in
 906                                            blocks */
 907         __le64   bg_blkno;               /* Offset on disk, in blocks */
 908 /*30*/  struct ocfs2_block_check bg_check;      /* Error checking */
 909         __le64   bg_reserved2;
 910 /*40*/  __u8    bg_bitmap[0];
 911 };
 912
 913 struct ocfs2_refcount_rec {
 914 /*00*/  __le64 r_cpos;          /* Physical offset, in clusters */
 915         __le32 r_clusters;      /* Clusters covered by this extent */
 916         __le32 r_refcount;      /* Reference count of this extent */
 917 /*10*/
 918 };
 919 #define OCFS2_32BIT_POS_MASK            (0xffffffffULL)
 920
 921 #define OCFS2_REFCOUNT_LEAF_FL          (0x00000001)
 922 #define OCFS2_REFCOUNT_TREE_FL          (0x00000002)
 923
 924 struct ocfs2_refcount_list {
 925 /*00*/  __le16 rl_count;        /* Maximum number of entries possible
 926                                    in rl_records */
 927         __le16 rl_used;         /* Current number of used records */
 928         __le32 rl_reserved2;
 929         __le64 rl_reserved1;    /* Pad to sizeof(ocfs2_refcount_record) */
 930 /*10*/  struct ocfs2_refcount_rec rl_recs[0];   /* Refcount records */
 931 };
 932
 933
 934 struct ocfs2_refcount_block {
 935 /*00*/  __u8 rf_signature[8];           /* Signature for verification */
 936         __le16 rf_suballoc_slot;        /* Slot suballocator this block
 937                                            belongs to */
 938         __le16 rf_suballoc_bit;         /* Bit offset in suballocator
 939                                            block group */
 940         __le32 rf_fs_generation;        /* Must match superblock */
 941 /*10*/  __le64 rf_blkno;                /* Offset on disk, in blocks */
 942         __le64 rf_parent;               /* Parent block, only valid if
 943                                            OCFS2_REFCOUNT_LEAF_FL is set in
 944                                            rf_flags */
 945 /*20*/  struct ocfs2_block_check rf_check;      /* Error checking */
 946         __le64 rf_last_eb_blk;          /* Pointer to last extent block */
 947 /*30*/  __le32 rf_count;                /* Number of inodes sharing this
 948                                            refcount tree */
 949         __le32 rf_flags;                /* See the flags above */
 950         __le32 rf_clusters;             /* clusters covered by refcount tree. */
 951         __le32 rf_cpos;                 /* cluster offset in refcount tree.*/
 952 /*40*/  __le32 rf_generation;           /* generation number. all be the same
 953                                          * for the same refcount tree. */
 954         __le32 rf_reserved0;
 955         __le64 rf_reserved1[7];
 956 /*80*/  union {
 957                 struct ocfs2_refcount_list rf_records;  /* List of refcount
 958                                                           records */
 959                 struct ocfs2_extent_list rf_list;       /* Extent record list,
 960                                                         only valid if
 961                                                         OCFS2_REFCOUNT_TREE_FL
 962                                                         is set in rf_flags */
 963         };
 964 /* Actual on-disk size is one block */
 965 };
 966
 967 /*
 968  * On disk extended attribute structure for OCFS2.
 969  */
 970
 971 /*
 972  * ocfs2_xattr_entry indicates one extend attribute.
 973  *
 974  * Note that it can be stored in inode, one block or one xattr bucket.
 975  */
 976 struct ocfs2_xattr_entry {
 977         __le32  xe_name_hash;    /* hash value of xattr prefix+suffix. */
 978         __le16  xe_name_offset;  /* byte offset from the 1st entry in the
 979                                     local xattr storage(inode, xattr block or
 980                                     xattr bucket). */
 981         __u8    xe_name_len;     /* xattr name len, does't include prefix. */
 982         __u8    xe_type;         /* the low 7 bits indicate the name prefix
 983                                   * type and the highest bit indicates whether
 984                                   * the EA is stored in the local storage. */
 985         __le64  xe_value_size;   /* real xattr value length. */
 986 };
 987
 988 /*
 989  * On disk structure for xattr header.
 990  *
 991  * One ocfs2_xattr_header describes how many ocfs2_xattr_entry records in
 992  * the local xattr storage.
 993  */
 994 struct ocfs2_xattr_header {
 995         __le16  xh_count;                       /* contains the count of how
 996                                                    many records are in the
 997                                                    local xattr storage. */
 998         __le16  xh_free_start;                  /* current offset for storing
 999                                                    xattr. */
1000         __le16  xh_name_value_len;              /* total length of name/value
1001                                                    length in this bucket. */
1002         __le16  xh_num_buckets;                 /* Number of xattr buckets
1003                                                    in this extent record,
1004                                                    only valid in the first
1005                                                    bucket. */
1006         struct ocfs2_block_check xh_check;      /* Error checking
1007                                                    (Note, this is only
1008                                                     used for xattr
1009                                                     buckets.  A block uses
1010                                                     xb_check and sets
1011                                                     this field to zero.) */
1012         struct ocfs2_xattr_entry xh_entries[0]; /* xattr entry list. */
1013 };
1014
1015 /*
1016  * On disk structure for xattr value root.
1017  *
1018  * When an xattr's value is large enough, it is stored in an external
1019  * b-tree like file data.  The xattr value root points to this structure.
1020  */
1021 struct ocfs2_xattr_value_root {
1022 /*00*/  __le32  xr_clusters;              /* clusters covered by xattr value. */
1023         __le32  xr_reserved0;
1024         __le64  xr_last_eb_blk;           /* Pointer to last extent block */
1025 /*10*/  struct ocfs2_extent_list xr_list; /* Extent record list */
1026 };
1027
1028 /*
1029  * On disk structure for xattr tree root.
1030  *
1031  * It is used when there are too many extended attributes for one file. These
1032  * attributes will be organized and stored in an indexed-btree.
1033  */
1034 struct ocfs2_xattr_tree_root {
1035 /*00*/  __le32  xt_clusters;              /* clusters covered by xattr. */
1036         __le32  xt_reserved0;
1037         __le64  xt_last_eb_blk;           /* Pointer to last extent block */
1038 /*10*/  struct ocfs2_extent_list xt_list; /* Extent record list */
1039 };
1040
1041 #define OCFS2_XATTR_INDEXED     0x1
1042 #define OCFS2_HASH_SHIFT        5
1043 #define OCFS2_XATTR_ROUND       3
1044 #define OCFS2_XATTR_SIZE(size)  (((size) + OCFS2_XATTR_ROUND) & \
1045                                 ~(OCFS2_XATTR_ROUND))
1046
1047 #define OCFS2_XATTR_BUCKET_SIZE                 4096
1048 #define OCFS2_XATTR_MAX_BLOCKS_PER_BUCKET       (OCFS2_XATTR_BUCKET_SIZE \
1049                                                  / OCFS2_MIN_BLOCKSIZE)
1050
1051 /*
1052  * On disk structure for xattr block.
1053  */
1054 struct ocfs2_xattr_block {
1055 /*00*/  __u8    xb_signature[8];     /* Signature for verification */
1056         __le16  xb_suballoc_slot;    /* Slot suballocator this
1057                                         block belongs to. */
1058         __le16  xb_suballoc_bit;     /* Bit offset in suballocator
1059                                         block group */
1060         __le32  xb_fs_generation;    /* Must match super block */
1061 /*10*/  __le64  xb_blkno;            /* Offset on disk, in blocks */
1062         struct ocfs2_block_check xb_check;      /* Error checking */
1063 /*20*/  __le16  xb_flags;            /* Indicates whether this block contains
1064                                         real xattr or a xattr tree. */
1065         __le16  xb_reserved0;
1066         __le32  xb_reserved1;
1067         __le64  xb_reserved2;
1068 /*30*/  union {
1069                 struct ocfs2_xattr_header xb_header; /* xattr header if this
1070                                                         block contains xattr */
1071                 struct ocfs2_xattr_tree_root xb_root;/* xattr tree root if this
1072                                                         block cotains xattr
1073                                                         tree. */
1074         } xb_attrs;
1075 };
1076
1077 #define OCFS2_XATTR_ENTRY_LOCAL         0x80
1078 #define OCFS2_XATTR_TYPE_MASK           0x7F
1079 static inline void ocfs2_xattr_set_local(struct ocfs2_xattr_entry *xe,
1080                                          int local)
1081 {
1082         if (local)
1083                 xe->xe_type |= OCFS2_XATTR_ENTRY_LOCAL;
1084         else
1085                 xe->xe_type &= ~OCFS2_XATTR_ENTRY_LOCAL;
1086 }
1087
1088 static inline int ocfs2_xattr_is_local(struct ocfs2_xattr_entry *xe)
1089 {
1090         return xe->xe_type & OCFS2_XATTR_ENTRY_LOCAL;
1091 }
1092
1093 static inline void ocfs2_xattr_set_type(struct ocfs2_xattr_entry *xe, int type)
1094 {
1095         xe->xe_type |= type & OCFS2_XATTR_TYPE_MASK;
1096 }
1097
1098 static inline int ocfs2_xattr_get_type(struct ocfs2_xattr_entry *xe)
1099 {
1100         return xe->xe_type & OCFS2_XATTR_TYPE_MASK;
1101 }
1102
1103 /*
1104  *  On disk structures for global quota file
1105  */
1106
1107 /* Magic numbers and known versions for global quota files */
1108 #define OCFS2_GLOBAL_QMAGICS {\
1109         0x0cf52470, /* USRQUOTA */ \
1110         0x0cf52471  /* GRPQUOTA */ \
1111 }
1112
1113 #define OCFS2_GLOBAL_QVERSIONS {\
1114         0, \
1115         0, \
1116 }
1117
1118
1119 /* Each block of each quota file has a certain fixed number of bytes reserved
1120  * for OCFS2 internal use at its end. OCFS2 can use it for things like
1121  * checksums, etc. */
1122 #define OCFS2_QBLK_RESERVED_SPACE 8
1123
1124 /* Generic header of all quota files */
1125 struct ocfs2_disk_dqheader {
1126         __le32 dqh_magic;       /* Magic number identifying file */
1127         __le32 dqh_version;     /* Quota format version */
1128 };
1129
1130 #define OCFS2_GLOBAL_INFO_OFF (sizeof(struct ocfs2_disk_dqheader))
1131
1132 /* Information header of global quota file (immediately follows the generic
1133  * header) */
1134 struct ocfs2_global_disk_dqinfo {
1135 /*00*/  __le32 dqi_bgrace;      /* Grace time for space softlimit excess */
1136         __le32 dqi_igrace;      /* Grace time for inode softlimit excess */
1137         __le32 dqi_syncms;      /* Time after which we sync local changes to
1138                                  * global quota file */
1139         __le32 dqi_blocks;      /* Number of blocks in quota file */
1140 /*10*/  __le32 dqi_free_blk;    /* First free block in quota file */
1141         __le32 dqi_free_entry;  /* First block with free dquot entry in quota
1142                                  * file */
1143 };
1144
1145 /* Structure with global user / group information. We reserve some space
1146  * for future use. */
1147 struct ocfs2_global_disk_dqblk {
1148 /*00*/  __le32 dqb_id;          /* ID the structure belongs to */
1149         __le32 dqb_use_count;   /* Number of nodes having reference to this structure */
1150         __le64 dqb_ihardlimit;  /* absolute limit on allocated inodes */
1151 /*10*/  __le64 dqb_isoftlimit;  /* preferred inode limit */
1152         __le64 dqb_curinodes;   /* current # allocated inodes */
1153 /*20*/  __le64 dqb_bhardlimit;  /* absolute limit on disk space */
1154         __le64 dqb_bsoftlimit;  /* preferred limit on disk space */
1155 /*30*/  __le64 dqb_curspace;    /* current space occupied */
1156         __le64 dqb_btime;       /* time limit for excessive disk use */
1157 /*40*/  __le64 dqb_itime;       /* time limit for excessive inode use */
1158         __le64 dqb_pad1;
1159 /*50*/  __le64 dqb_pad2;
1160 };
1161
1162 /*
1163  *  On-disk structures for local quota file
1164  */
1165
1166 /* Magic numbers and known versions for local quota files */
1167 #define OCFS2_LOCAL_QMAGICS {\
1168         0x0cf524c0, /* USRQUOTA */ \
1169         0x0cf524c1  /* GRPQUOTA */ \
1170 }
1171
1172 #define OCFS2_LOCAL_QVERSIONS {\
1173         0, \
1174         0, \
1175 }
1176
1177 /* Quota flags in dqinfo header */
1178 #define OLQF_CLEAN      0x0001  /* Quota file is empty (this should be after\
1179                                  * quota has been cleanly turned off) */
1180
1181 #define OCFS2_LOCAL_INFO_OFF (sizeof(struct ocfs2_disk_dqheader))
1182
1183 /* Information header of local quota file (immediately follows the generic
1184  * header) */
1185 struct ocfs2_local_disk_dqinfo {
1186         __le32 dqi_flags;       /* Flags for quota file */
1187         __le32 dqi_chunks;      /* Number of chunks of quota structures
1188                                  * with a bitmap */
1189         __le32 dqi_blocks;      /* Number of blocks allocated for quota file */
1190 };
1191
1192 /* Header of one chunk of a quota file */
1193 struct ocfs2_local_disk_chunk {
1194         __le32 dqc_free;        /* Number of free entries in the bitmap */
1195         u8 dqc_bitmap[0];       /* Bitmap of entries in the corresponding
1196                                  * chunk of quota file */
1197 };
1198
1199 /* One entry in local quota file */
1200 struct ocfs2_local_disk_dqblk {
1201 /*00*/  __le64 dqb_id;          /* id this quota applies to */
1202         __le64 dqb_spacemod;    /* Change in the amount of used space */
1203 /*10*/  __le64 dqb_inodemod;    /* Change in the amount of used inodes */
1204 };
1205
1206
1207 /*
1208  * The quota trailer lives at the end of each quota block.
1209  */
1210
1211 struct ocfs2_disk_dqtrailer {
1212 /*00*/  struct ocfs2_block_check dq_check;      /* Error checking */
1213 /*08*/  /* Cannot be larger than OCFS2_QBLK_RESERVED_SPACE */
1214 };
1215
1216 static inline struct ocfs2_disk_dqtrailer *ocfs2_block_dqtrailer(int blocksize,
1217                                                                  void *buf)
1218 {
1219         char *ptr = buf;
1220         ptr += blocksize - OCFS2_QBLK_RESERVED_SPACE;
1221
1222         return (struct ocfs2_disk_dqtrailer *)ptr;
1223 }
1224
1225 #ifdef __KERNEL__
1226 static inline int ocfs2_fast_symlink_chars(struct super_block *sb)
1227 {
1228         return  sb->s_blocksize -
1229                  offsetof(struct ocfs2_dinode, id2.i_symlink);
1230 }
1231
1232 static inline int ocfs2_max_inline_data_with_xattr(struct super_block *sb,
1233                                                    struct ocfs2_dinode *di)
1234 {
1235         unsigned int xattrsize = le16_to_cpu(di->i_xattr_inline_size);
1236
1237         if (le16_to_cpu(di->i_dyn_features) & OCFS2_INLINE_XATTR_FL)
1238                 return sb->s_blocksize -
1239                         offsetof(struct ocfs2_dinode, id2.i_data.id_data) -
1240                         xattrsize;
1241         else
1242                 return sb->s_blocksize -
1243                         offsetof(struct ocfs2_dinode, id2.i_data.id_data);
1244 }
1245
1246 static inline int ocfs2_extent_recs_per_inode(struct super_block *sb)
1247 {
1248         int size;
1249
1250         size = sb->s_blocksize -
1251                 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
1252
1253         return size / sizeof(struct ocfs2_extent_rec);
1254 }
1255
1256 static inline int ocfs2_extent_recs_per_inode_with_xattr(
1257                                                 struct super_block *sb,
1258                                                 struct ocfs2_dinode *di)
1259 {
1260         int size;
1261         unsigned int xattrsize = le16_to_cpu(di->i_xattr_inline_size);
1262
1263         if (le16_to_cpu(di->i_dyn_features) & OCFS2_INLINE_XATTR_FL)
1264                 size = sb->s_blocksize -
1265                         offsetof(struct ocfs2_dinode, id2.i_list.l_recs) -
1266                         xattrsize;
1267         else
1268                 size = sb->s_blocksize -
1269                         offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
1270
1271         return size / sizeof(struct ocfs2_extent_rec);
1272 }
1273
1274 static inline int ocfs2_extent_recs_per_dx_root(struct super_block *sb)
1275 {
1276         int size;
1277
1278         size = sb->s_blocksize -
1279                 offsetof(struct ocfs2_dx_root_block, dr_list.l_recs);
1280
1281         return size / sizeof(struct ocfs2_extent_rec);
1282 }
1283
1284 static inline int ocfs2_chain_recs_per_inode(struct super_block *sb)
1285 {
1286         int size;
1287
1288         size = sb->s_blocksize -
1289                 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
1290
1291         return size / sizeof(struct ocfs2_chain_rec);
1292 }
1293
1294 static inline u16 ocfs2_extent_recs_per_eb(struct super_block *sb)
1295 {
1296         int size;
1297
1298         size = sb->s_blocksize -
1299                 offsetof(struct ocfs2_extent_block, h_list.l_recs);
1300
1301         return size / sizeof(struct ocfs2_extent_rec);
1302 }
1303
1304 static inline int ocfs2_dx_entries_per_leaf(struct super_block *sb)
1305 {
1306         int size;
1307
1308         size = sb->s_blocksize -
1309                 offsetof(struct ocfs2_dx_leaf, dl_list.de_entries);
1310
1311         return size / sizeof(struct ocfs2_dx_entry);
1312 }
1313
1314 static inline int ocfs2_dx_entries_per_root(struct super_block *sb)
1315 {
1316         int size;
1317
1318         size = sb->s_blocksize -
1319                 offsetof(struct ocfs2_dx_root_block, dr_entries.de_entries);
1320
1321         return size / sizeof(struct ocfs2_dx_entry);
1322 }
1323
1324 static inline u16 ocfs2_local_alloc_size(struct super_block *sb)
1325 {
1326         u16 size;
1327
1328         size = sb->s_blocksize -
1329                 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
1330
1331         return size;
1332 }
1333
1334 static inline int ocfs2_group_bitmap_size(struct super_block *sb)
1335 {
1336         int size;
1337
1338         size = sb->s_blocksize -
1339                 offsetof(struct ocfs2_group_desc, bg_bitmap);
1340
1341         return size;
1342 }
1343
1344 static inline int ocfs2_truncate_recs_per_inode(struct super_block *sb)
1345 {
1346         int size;
1347
1348         size = sb->s_blocksize -
1349                 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
1350
1351         return size / sizeof(struct ocfs2_truncate_rec);
1352 }
1353
1354 static inline u64 ocfs2_backup_super_blkno(struct super_block *sb, int index)
1355 {
1356         u64 offset = OCFS2_BACKUP_SB_START;
1357
1358         if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
1359                 offset <<= (2 * index);
1360                 offset >>= sb->s_blocksize_bits;
1361                 return offset;
1362         }
1363
1364         return 0;
1365
1366 }
1367
1368 static inline u16 ocfs2_xattr_recs_per_xb(struct super_block *sb)
1369 {
1370         int size;
1371
1372         size = sb->s_blocksize -
1373                 offsetof(struct ocfs2_xattr_block,
1374                          xb_attrs.xb_root.xt_list.l_recs);
1375
1376         return size / sizeof(struct ocfs2_extent_rec);
1377 }
1378
1379 static inline u16 ocfs2_extent_recs_per_rb(struct super_block *sb)
1380 {
1381         int size;
1382
1383         size = sb->s_blocksize -
1384                 offsetof(struct ocfs2_refcount_block, rf_list.l_recs);
1385
1386         return size / sizeof(struct ocfs2_extent_rec);
1387 }
1388
1389 static inline u16 ocfs2_refcount_recs_per_rb(struct super_block *sb)
1390 {
1391         int size;
1392
1393         size = sb->s_blocksize -
1394                 offsetof(struct ocfs2_refcount_block, rf_records.rl_recs);
1395
1396         return size / sizeof(struct ocfs2_refcount_rec);
1397 }
1398
1399 static inline u32
1400 ocfs2_get_ref_rec_low_cpos(const struct ocfs2_refcount_rec *rec)
1401 {
1402         return le64_to_cpu(rec->r_cpos) & OCFS2_32BIT_POS_MASK;
1403 }
1404 #else
1405 static inline int ocfs2_fast_symlink_chars(int blocksize)
1406 {
1407         return blocksize - offsetof(struct ocfs2_dinode, id2.i_symlink);
1408 }
1409
1410 static inline int ocfs2_max_inline_data(int blocksize)
1411 {
1412         return blocksize - offsetof(struct ocfs2_dinode, id2.i_data.id_data);
1413 }
1414
1415 static inline int ocfs2_extent_recs_per_inode(int blocksize)
1416 {
1417         int size;
1418
1419         size = blocksize -
1420                 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
1421
1422         return size / sizeof(struct ocfs2_extent_rec);
1423 }
1424
1425 static inline int ocfs2_chain_recs_per_inode(int blocksize)
1426 {
1427         int size;
1428
1429         size = blocksize -
1430                 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
1431
1432         return size / sizeof(struct ocfs2_chain_rec);
1433 }
1434
1435 static inline int ocfs2_extent_recs_per_eb(int blocksize)
1436 {
1437         int size;
1438
1439         size = blocksize -
1440                 offsetof(struct ocfs2_extent_block, h_list.l_recs);
1441
1442         return size / sizeof(struct ocfs2_extent_rec);
1443 }
1444
1445 static inline int ocfs2_local_alloc_size(int blocksize)
1446 {
1447         int size;
1448
1449         size = blocksize -
1450                 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
1451
1452         return size;
1453 }
1454
1455 static inline int ocfs2_group_bitmap_size(int blocksize)
1456 {
1457         int size;
1458
1459         size = blocksize -
1460                 offsetof(struct ocfs2_group_desc, bg_bitmap);
1461
1462         return size;
1463 }
1464
1465 static inline int ocfs2_truncate_recs_per_inode(int blocksize)
1466 {
1467         int size;
1468
1469         size = blocksize -
1470                 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
1471
1472         return size / sizeof(struct ocfs2_truncate_rec);
1473 }
1474
1475 static inline uint64_t ocfs2_backup_super_blkno(int blocksize, int index)
1476 {
1477         uint64_t offset = OCFS2_BACKUP_SB_START;
1478
1479         if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
1480                 offset <<= (2 * index);
1481                 offset /= blocksize;
1482                 return offset;
1483         }
1484
1485         return 0;
1486 }
1487
1488 static inline int ocfs2_xattr_recs_per_xb(int blocksize)
1489 {
1490         int size;
1491
1492         size = blocksize -
1493                 offsetof(struct ocfs2_xattr_block,
1494                          xb_attrs.xb_root.xt_list.l_recs);
1495
1496         return size / sizeof(struct ocfs2_extent_rec);
1497 }
1498 #endif  /* __KERNEL__ */
1499
1500
1501 static inline int ocfs2_system_inode_is_global(int type)
1502 {
1503         return ((type >= 0) &&
1504                 (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE));
1505 }
1506
1507 static inline int ocfs2_sprintf_system_inode_name(char *buf, int len,
1508                                                   int type, int slot)
1509 {
1510         int chars;
1511
1512         /*
1513          * Global system inodes can only have one copy.  Everything
1514          * after OCFS2_LAST_GLOBAL_SYSTEM_INODE in the system inode
1515          * list has a copy per slot.
1516          */
1517         if (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE)
1518                 chars = snprintf(buf, len, "%s",
1519                                  ocfs2_system_inodes[type].si_name);
1520         else
1521                 chars = snprintf(buf, len,
1522                                  ocfs2_system_inodes[type].si_name,
1523                                  slot);
1524
1525         return chars;
1526 }
1527
1528 static inline void ocfs2_set_de_type(struct ocfs2_dir_entry *de,
1529                                     umode_t mode)
1530 {
1531         de->file_type = ocfs2_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
1532 }
1533
1534 #endif  /* _OCFS2_FS_H */
1535