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
  68 /* Compatibility flags */
  69 #define OCFS2_HAS_COMPAT_FEATURE(sb,mask)                       \
  70         ( OCFS2_SB(sb)->s_feature_compat & (mask) )
  71 #define OCFS2_HAS_RO_COMPAT_FEATURE(sb,mask)                    \
  72         ( OCFS2_SB(sb)->s_feature_ro_compat & (mask) )
  73 #define OCFS2_HAS_INCOMPAT_FEATURE(sb,mask)                     \
  74         ( OCFS2_SB(sb)->s_feature_incompat & (mask) )
  75 #define OCFS2_SET_COMPAT_FEATURE(sb,mask)                       \
  76         OCFS2_SB(sb)->s_feature_compat |= (mask)
  77 #define OCFS2_SET_RO_COMPAT_FEATURE(sb,mask)                    \
  78         OCFS2_SB(sb)->s_feature_ro_compat |= (mask)
  79 #define OCFS2_SET_INCOMPAT_FEATURE(sb,mask)                     \
  80         OCFS2_SB(sb)->s_feature_incompat |= (mask)
  81 #define OCFS2_CLEAR_COMPAT_FEATURE(sb,mask)                     \
  82         OCFS2_SB(sb)->s_feature_compat &= ~(mask)
  83 #define OCFS2_CLEAR_RO_COMPAT_FEATURE(sb,mask)                  \
  84         OCFS2_SB(sb)->s_feature_ro_compat &= ~(mask)
  85 #define OCFS2_CLEAR_INCOMPAT_FEATURE(sb,mask)                   \
  86         OCFS2_SB(sb)->s_feature_incompat &= ~(mask)
  87
  88 #define OCFS2_FEATURE_COMPAT_SUPP       OCFS2_FEATURE_COMPAT_BACKUP_SB
  89 #define OCFS2_FEATURE_INCOMPAT_SUPP     (OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT \
  90                                          | OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC \
  91                                          | OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
  92 #define OCFS2_FEATURE_RO_COMPAT_SUPP    OCFS2_FEATURE_RO_COMPAT_UNWRITTEN
  93
  94 /*
  95  * Heartbeat-only devices are missing journals and other files.  The
  96  * filesystem driver can't load them, but the library can.  Never put
  97  * this in OCFS2_FEATURE_INCOMPAT_SUPP, *ever*.
  98  */
  99 #define OCFS2_FEATURE_INCOMPAT_HEARTBEAT_DEV    0x0002
 100
 101 /*
 102  * tunefs sets this incompat flag before starting the resize and clears it
 103  * at the end. This flag protects users from inadvertently mounting the fs
 104  * after an aborted run without fsck-ing.
 105  */
 106 #define OCFS2_FEATURE_INCOMPAT_RESIZE_INPROG    0x0004
 107
 108 /* Used to denote a non-clustered volume */
 109 #define OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT      0x0008
 110
 111 /* Support for sparse allocation in b-trees */
 112 #define OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC     0x0010
 113
 114 /*
 115  * Tunefs sets this incompat flag before starting an operation which
 116  * would require cleanup on abort. This is done to protect users from
 117  * inadvertently mounting the fs after an aborted run without
 118  * fsck-ing.
 119  *
 120  * s_tunefs_flags on the super block describes precisely which
 121  * operations were in progress.
 122  */
 123 #define OCFS2_FEATURE_INCOMPAT_TUNEFS_INPROG    0x0020
 124
 125 /* Support for data packed into inode blocks */
 126 #define OCFS2_FEATURE_INCOMPAT_INLINE_DATA      0x0040
 127
 128 /*
 129  * backup superblock flag is used to indicate that this volume
 130  * has backup superblocks.
 131  */
 132 #define OCFS2_FEATURE_COMPAT_BACKUP_SB          0x0001
 133
 134 /*
 135  * Unwritten extents support.
 136  */
 137 #define OCFS2_FEATURE_RO_COMPAT_UNWRITTEN       0x0001
 138
 139 /* The byte offset of the first backup block will be 1G.
 140  * The following will be 4G, 16G, 64G, 256G and 1T.
 141  */
 142 #define OCFS2_BACKUP_SB_START                   1 << 30
 143
 144 /* the max backup superblock nums */
 145 #define OCFS2_MAX_BACKUP_SUPERBLOCKS    6
 146
 147 /*
 148  * Flags on ocfs2_super_block.s_tunefs_flags
 149  */
 150 #define OCFS2_TUNEFS_INPROG_REMOVE_SLOT         0x0001  /* Removing slots */
 151
 152 /*
 153  * Flags on ocfs2_dinode.i_flags
 154  */
 155 #define OCFS2_VALID_FL          (0x00000001)    /* Inode is valid */
 156 #define OCFS2_UNUSED2_FL        (0x00000002)
 157 #define OCFS2_ORPHANED_FL       (0x00000004)    /* On the orphan list */
 158 #define OCFS2_UNUSED3_FL        (0x00000008)
 159 /* System inode flags */
 160 #define OCFS2_SYSTEM_FL         (0x00000010)    /* System inode */
 161 #define OCFS2_SUPER_BLOCK_FL    (0x00000020)    /* Super block */
 162 #define OCFS2_LOCAL_ALLOC_FL    (0x00000040)    /* Slot local alloc bitmap */
 163 #define OCFS2_BITMAP_FL         (0x00000080)    /* Allocation bitmap */
 164 #define OCFS2_JOURNAL_FL        (0x00000100)    /* Slot local journal */
 165 #define OCFS2_HEARTBEAT_FL      (0x00000200)    /* Heartbeat area */
 166 #define OCFS2_CHAIN_FL          (0x00000400)    /* Chain allocator */
 167 #define OCFS2_DEALLOC_FL        (0x00000800)    /* Truncate log */
 168
 169 /*
 170  * Flags on ocfs2_dinode.i_dyn_features
 171  *
 172  * These can change much more often than i_flags. When adding flags,
 173  * keep in mind that i_dyn_features is only 16 bits wide.
 174  */
 175 #define OCFS2_INLINE_DATA_FL    (0x0001)        /* Data stored in inode block */
 176 #define OCFS2_HAS_XATTR_FL      (0x0002)
 177 #define OCFS2_INLINE_XATTR_FL   (0x0004)
 178 #define OCFS2_INDEXED_DIR_FL    (0x0008)
 179
 180 /* Inode attributes, keep in sync with EXT2 */
 181 #define OCFS2_SECRM_FL          (0x00000001)    /* Secure deletion */
 182 #define OCFS2_UNRM_FL           (0x00000002)    /* Undelete */
 183 #define OCFS2_COMPR_FL          (0x00000004)    /* Compress file */
 184 #define OCFS2_SYNC_FL           (0x00000008)    /* Synchronous updates */
 185 #define OCFS2_IMMUTABLE_FL      (0x00000010)    /* Immutable file */
 186 #define OCFS2_APPEND_FL         (0x00000020)    /* writes to file may only append */
 187 #define OCFS2_NODUMP_FL         (0x00000040)    /* do not dump file */
 188 #define OCFS2_NOATIME_FL        (0x00000080)    /* do not update atime */
 189 #define OCFS2_DIRSYNC_FL        (0x00010000)    /* dirsync behaviour (directories only) */
 190
 191 #define OCFS2_FL_VISIBLE        (0x000100FF)    /* User visible flags */
 192 #define OCFS2_FL_MODIFIABLE     (0x000100FF)    /* User modifiable flags */
 193
 194 /*
 195  * Extent record flags (e_node.leaf.flags)
 196  */
 197 #define OCFS2_EXT_UNWRITTEN     (0x01)  /* Extent is allocated but
 198                                          * unwritten */
 199
 200 /*
 201  * ioctl commands
 202  */
 203 #define OCFS2_IOC_GETFLAGS      _IOR('f', 1, long)
 204 #define OCFS2_IOC_SETFLAGS      _IOW('f', 2, long)
 205 #define OCFS2_IOC32_GETFLAGS    _IOR('f', 1, int)
 206 #define OCFS2_IOC32_SETFLAGS    _IOW('f', 2, int)
 207
 208 /*
 209  * Space reservation / allocation / free ioctls and argument structure
 210  * are designed to be compatible with XFS.
 211  *
 212  * ALLOCSP* and FREESP* are not and will never be supported, but are
 213  * included here for completeness.
 214  */
 215 struct ocfs2_space_resv {
 216         __s16           l_type;
 217         __s16           l_whence;
 218         __s64           l_start;
 219         __s64           l_len;          /* len == 0 means until end of file */
 220         __s32           l_sysid;
 221         __u32           l_pid;
 222         __s32           l_pad[4];       /* reserve area                     */
 223 };
 224
 225 #define OCFS2_IOC_ALLOCSP               _IOW ('X', 10, struct ocfs2_space_resv)
 226 #define OCFS2_IOC_FREESP                _IOW ('X', 11, struct ocfs2_space_resv)
 227 #define OCFS2_IOC_RESVSP                _IOW ('X', 40, struct ocfs2_space_resv)
 228 #define OCFS2_IOC_UNRESVSP      _IOW ('X', 41, struct ocfs2_space_resv)
 229 #define OCFS2_IOC_ALLOCSP64     _IOW ('X', 36, struct ocfs2_space_resv)
 230 #define OCFS2_IOC_FREESP64      _IOW ('X', 37, struct ocfs2_space_resv)
 231 #define OCFS2_IOC_RESVSP64      _IOW ('X', 42, struct ocfs2_space_resv)
 232 #define OCFS2_IOC_UNRESVSP64    _IOW ('X', 43, struct ocfs2_space_resv)
 233
 234 /*
 235  * Journal Flags (ocfs2_dinode.id1.journal1.i_flags)
 236  */
 237 #define OCFS2_JOURNAL_DIRTY_FL  (0x00000001)    /* Journal needs recovery */
 238
 239 /*
 240  * superblock s_state flags
 241  */
 242 #define OCFS2_ERROR_FS          (0x00000001)    /* FS saw errors */
 243
 244 /* Limit of space in ocfs2_dir_entry */
 245 #define OCFS2_MAX_FILENAME_LEN          255
 246
 247 /* Maximum slots on an ocfs2 file system */
 248 #define OCFS2_MAX_SLOTS                 255
 249
 250 /* Slot map indicator for an empty slot */
 251 #define OCFS2_INVALID_SLOT              -1
 252
 253 #define OCFS2_VOL_UUID_LEN              16
 254 #define OCFS2_MAX_VOL_LABEL_LEN         64
 255
 256 /* Journal limits (in bytes) */
 257 #define OCFS2_MIN_JOURNAL_SIZE          (4 * 1024 * 1024)
 258
 259 struct ocfs2_system_inode_info {
 260         char    *si_name;
 261         int     si_iflags;
 262         int     si_mode;
 263 };
 264
 265 /* System file index */
 266 enum {
 267         BAD_BLOCK_SYSTEM_INODE = 0,
 268         GLOBAL_INODE_ALLOC_SYSTEM_INODE,
 269         SLOT_MAP_SYSTEM_INODE,
 270 #define OCFS2_FIRST_ONLINE_SYSTEM_INODE SLOT_MAP_SYSTEM_INODE
 271         HEARTBEAT_SYSTEM_INODE,
 272         GLOBAL_BITMAP_SYSTEM_INODE,
 273 #define OCFS2_LAST_GLOBAL_SYSTEM_INODE GLOBAL_BITMAP_SYSTEM_INODE
 274         ORPHAN_DIR_SYSTEM_INODE,
 275         EXTENT_ALLOC_SYSTEM_INODE,
 276         INODE_ALLOC_SYSTEM_INODE,
 277         JOURNAL_SYSTEM_INODE,
 278         LOCAL_ALLOC_SYSTEM_INODE,
 279         TRUNCATE_LOG_SYSTEM_INODE,
 280         NUM_SYSTEM_INODES
 281 };
 282
 283 static struct ocfs2_system_inode_info ocfs2_system_inodes[NUM_SYSTEM_INODES] = {
 284         /* Global system inodes (single copy) */
 285         /* The first two are only used from userspace mfks/tunefs */
 286         [BAD_BLOCK_SYSTEM_INODE]                = { "bad_blocks", 0, S_IFREG | 0644 },
 287         [GLOBAL_INODE_ALLOC_SYSTEM_INODE]       = { "global_inode_alloc", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
 288
 289         /* These are used by the running filesystem */
 290         [SLOT_MAP_SYSTEM_INODE]                 = { "slot_map", 0, S_IFREG | 0644 },
 291         [HEARTBEAT_SYSTEM_INODE]                = { "heartbeat", OCFS2_HEARTBEAT_FL, S_IFREG | 0644 },
 292         [GLOBAL_BITMAP_SYSTEM_INODE]            = { "global_bitmap", 0, S_IFREG | 0644 },
 293
 294         /* Slot-specific system inodes (one copy per slot) */
 295         [ORPHAN_DIR_SYSTEM_INODE]               = { "orphan_dir:%04d", 0, S_IFDIR | 0755 },
 296         [EXTENT_ALLOC_SYSTEM_INODE]             = { "extent_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
 297         [INODE_ALLOC_SYSTEM_INODE]              = { "inode_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
 298         [JOURNAL_SYSTEM_INODE]                  = { "journal:%04d", OCFS2_JOURNAL_FL, S_IFREG | 0644 },
 299         [LOCAL_ALLOC_SYSTEM_INODE]              = { "local_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_LOCAL_ALLOC_FL, S_IFREG | 0644 },
 300         [TRUNCATE_LOG_SYSTEM_INODE]             = { "truncate_log:%04d", OCFS2_DEALLOC_FL, S_IFREG | 0644 }
 301 };
 302
 303 /* Parameter passed from mount.ocfs2 to module */
 304 #define OCFS2_HB_NONE                   "heartbeat=none"
 305 #define OCFS2_HB_LOCAL                  "heartbeat=local"
 306
 307 /*
 308  * OCFS2 directory file types.  Only the low 3 bits are used.  The
 309  * other bits are reserved for now.
 310  */
 311 #define OCFS2_FT_UNKNOWN        0
 312 #define OCFS2_FT_REG_FILE       1
 313 #define OCFS2_FT_DIR            2
 314 #define OCFS2_FT_CHRDEV         3
 315 #define OCFS2_FT_BLKDEV         4
 316 #define OCFS2_FT_FIFO           5
 317 #define OCFS2_FT_SOCK           6
 318 #define OCFS2_FT_SYMLINK        7
 319
 320 #define OCFS2_FT_MAX            8
 321
 322 /*
 323  * OCFS2_DIR_PAD defines the directory entries boundaries
 324  *
 325  * NOTE: It must be a multiple of 4
 326  */
 327 #define OCFS2_DIR_PAD                   4
 328 #define OCFS2_DIR_ROUND                 (OCFS2_DIR_PAD - 1)
 329 #define OCFS2_DIR_MEMBER_LEN            offsetof(struct ocfs2_dir_entry, name)
 330 #define OCFS2_DIR_REC_LEN(name_len)     (((name_len) + OCFS2_DIR_MEMBER_LEN + \
 331                                           OCFS2_DIR_ROUND) & \
 332                                          ~OCFS2_DIR_ROUND)
 333
 334 #define OCFS2_LINK_MAX          32000
 335
 336 #define S_SHIFT                 12
 337 static unsigned char ocfs2_type_by_mode[S_IFMT >> S_SHIFT] = {
 338         [S_IFREG >> S_SHIFT]  = OCFS2_FT_REG_FILE,
 339         [S_IFDIR >> S_SHIFT]  = OCFS2_FT_DIR,
 340         [S_IFCHR >> S_SHIFT]  = OCFS2_FT_CHRDEV,
 341         [S_IFBLK >> S_SHIFT]  = OCFS2_FT_BLKDEV,
 342         [S_IFIFO >> S_SHIFT]  = OCFS2_FT_FIFO,
 343         [S_IFSOCK >> S_SHIFT] = OCFS2_FT_SOCK,
 344         [S_IFLNK >> S_SHIFT]  = OCFS2_FT_SYMLINK,
 345 };
 346
 347
 348 /*
 349  * Convenience casts
 350  */
 351 #define OCFS2_RAW_SB(dinode)            (&((dinode)->id2.i_super))
 352
 353 /*
 354  * On disk extent record for OCFS2
 355  * It describes a range of clusters on disk.
 356  *
 357  * Length fields are divided into interior and leaf node versions.
 358  * This leaves room for a flags field (OCFS2_EXT_*) in the leaf nodes.
 359  */
 360 struct ocfs2_extent_rec {
 361 /*00*/  __le32 e_cpos;          /* Offset into the file, in clusters */
 362         union {
 363                 __le32 e_int_clusters; /* Clusters covered by all children */
 364                 struct {
 365                         __le16 e_leaf_clusters; /* Clusters covered by this
 366                                                    extent */
 367                         __u8 e_reserved1;
 368                         __u8 e_flags; /* Extent flags */
 369                 };
 370         };
 371         __le64 e_blkno;         /* Physical disk offset, in blocks */
 372 /*10*/
 373 };
 374
 375 struct ocfs2_chain_rec {
 376         __le32 c_free;  /* Number of free bits in this chain. */
 377         __le32 c_total; /* Number of total bits in this chain */
 378         __le64 c_blkno; /* Physical disk offset (blocks) of 1st group */
 379 };
 380
 381 struct ocfs2_truncate_rec {
 382         __le32 t_start;         /* 1st cluster in this log */
 383         __le32 t_clusters;      /* Number of total clusters covered */
 384 };
 385
 386 /*
 387  * On disk extent list for OCFS2 (node in the tree).  Note that this
 388  * is contained inside ocfs2_dinode or ocfs2_extent_block, so the
 389  * offsets are relative to ocfs2_dinode.id2.i_list or
 390  * ocfs2_extent_block.h_list, respectively.
 391  */
 392 struct ocfs2_extent_list {
 393 /*00*/  __le16 l_tree_depth;            /* Extent tree depth from this
 394                                            point.  0 means data extents
 395                                            hang directly off this
 396                                            header (a leaf)
 397                                            NOTE: The high 8 bits cannot be
 398                                            used - tree_depth is never that big.
 399                                         */
 400         __le16 l_count;                 /* Number of extent records */
 401         __le16 l_next_free_rec;         /* Next unused extent slot */
 402         __le16 l_reserved1;
 403         __le64 l_reserved2;             /* Pad to
 404                                            sizeof(ocfs2_extent_rec) */
 405 /*10*/  struct ocfs2_extent_rec l_recs[0];      /* Extent records */
 406 };
 407
 408 /*
 409  * On disk allocation chain list for OCFS2.  Note that this is
 410  * contained inside ocfs2_dinode, so the offsets are relative to
 411  * ocfs2_dinode.id2.i_chain.
 412  */
 413 struct ocfs2_chain_list {
 414 /*00*/  __le16 cl_cpg;                  /* Clusters per Block Group */
 415         __le16 cl_bpc;                  /* Bits per cluster */
 416         __le16 cl_count;                /* Total chains in this list */
 417         __le16 cl_next_free_rec;        /* Next unused chain slot */
 418         __le64 cl_reserved1;
 419 /*10*/  struct ocfs2_chain_rec cl_recs[0];      /* Chain records */
 420 };
 421
 422 /*
 423  * On disk deallocation log for OCFS2.  Note that this is
 424  * contained inside ocfs2_dinode, so the offsets are relative to
 425  * ocfs2_dinode.id2.i_dealloc.
 426  */
 427 struct ocfs2_truncate_log {
 428 /*00*/  __le16 tl_count;                /* Total records in this log */
 429         __le16 tl_used;                 /* Number of records in use */
 430         __le32 tl_reserved1;
 431 /*08*/  struct ocfs2_truncate_rec tl_recs[0];   /* Truncate records */
 432 };
 433
 434 /*
 435  * On disk extent block (indirect block) for OCFS2
 436  */
 437 struct ocfs2_extent_block
 438 {
 439 /*00*/  __u8 h_signature[8];            /* Signature for verification */
 440         __le64 h_reserved1;
 441 /*10*/  __le16 h_suballoc_slot;         /* Slot suballocator this
 442                                            extent_header belongs to */
 443         __le16 h_suballoc_bit;          /* Bit offset in suballocator
 444                                            block group */
 445         __le32 h_fs_generation;         /* Must match super block */
 446         __le64 h_blkno;                 /* Offset on disk, in blocks */
 447 /*20*/  __le64 h_reserved3;
 448         __le64 h_next_leaf_blk;         /* Offset on disk, in blocks,
 449                                            of next leaf header pointing
 450                                            to data */
 451 /*30*/  struct ocfs2_extent_list h_list;        /* Extent record list */
 452 /* Actual on-disk size is one block */
 453 };
 454
 455 /*
 456  * On disk superblock for OCFS2
 457  * Note that it is contained inside an ocfs2_dinode, so all offsets
 458  * are relative to the start of ocfs2_dinode.id2.
 459  */
 460 struct ocfs2_super_block {
 461 /*00*/  __le16 s_major_rev_level;
 462         __le16 s_minor_rev_level;
 463         __le16 s_mnt_count;
 464         __le16 s_max_mnt_count;
 465         __le16 s_state;                 /* File system state */
 466         __le16 s_errors;                        /* Behaviour when detecting errors */
 467         __le32 s_checkinterval;         /* Max time between checks */
 468 /*10*/  __le64 s_lastcheck;             /* Time of last check */
 469         __le32 s_creator_os;            /* OS */
 470         __le32 s_feature_compat;                /* Compatible feature set */
 471 /*20*/  __le32 s_feature_incompat;      /* Incompatible feature set */
 472         __le32 s_feature_ro_compat;     /* Readonly-compatible feature set */
 473         __le64 s_root_blkno;            /* Offset, in blocks, of root directory
 474                                            dinode */
 475 /*30*/  __le64 s_system_dir_blkno;      /* Offset, in blocks, of system
 476                                            directory dinode */
 477         __le32 s_blocksize_bits;                /* Blocksize for this fs */
 478         __le32 s_clustersize_bits;      /* Clustersize for this fs */
 479 /*40*/  __le16 s_max_slots;             /* Max number of simultaneous mounts
 480                                            before tunefs required */
 481         __le16 s_tunefs_flag;
 482         __le32 s_reserved1;
 483         __le64 s_first_cluster_group;   /* Block offset of 1st cluster
 484                                          * group header */
 485 /*50*/  __u8  s_label[OCFS2_MAX_VOL_LABEL_LEN]; /* Label for mounting, etc. */
 486 /*90*/  __u8  s_uuid[OCFS2_VOL_UUID_LEN];       /* 128-bit uuid */
 487 /*A0*/
 488 };
 489
 490 /*
 491  * Local allocation bitmap for OCFS2 slots
 492  * Note that it exists inside an ocfs2_dinode, so all offsets are
 493  * relative to the start of ocfs2_dinode.id2.
 494  */
 495 struct ocfs2_local_alloc
 496 {
 497 /*00*/  __le32 la_bm_off;       /* Starting bit offset in main bitmap */
 498         __le16 la_size;         /* Size of included bitmap, in bytes */
 499         __le16 la_reserved1;
 500         __le64 la_reserved2;
 501 /*10*/  __u8   la_bitmap[0];
 502 };
 503
 504 /*
 505  * Data-in-inode header. This is only used if i_dyn_features has
 506  * OCFS2_INLINE_DATA_FL set.
 507  */
 508 struct ocfs2_inline_data
 509 {
 510 /*00*/  __le16  id_count;       /* Number of bytes that can be used
 511                                  * for data, starting at id_data */
 512         __le16  id_reserved0;
 513         __le32  id_reserved1;
 514         __u8    id_data[0];     /* Start of user data */
 515 };
 516
 517 /*
 518  * On disk inode for OCFS2
 519  */
 520 struct ocfs2_dinode {
 521 /*00*/  __u8 i_signature[8];            /* Signature for validation */
 522         __le32 i_generation;            /* Generation number */
 523         __le16 i_suballoc_slot;         /* Slot suballocator this inode
 524                                            belongs to */
 525         __le16 i_suballoc_bit;          /* Bit offset in suballocator
 526                                            block group */
 527 /*10*/  __le32 i_reserved0;
 528         __le32 i_clusters;              /* Cluster count */
 529         __le32 i_uid;                   /* Owner UID */
 530         __le32 i_gid;                   /* Owning GID */
 531 /*20*/  __le64 i_size;                  /* Size in bytes */
 532         __le16 i_mode;                  /* File mode */
 533         __le16 i_links_count;           /* Links count */
 534         __le32 i_flags;                 /* File flags */
 535 /*30*/  __le64 i_atime;                 /* Access time */
 536         __le64 i_ctime;                 /* Creation time */
 537 /*40*/  __le64 i_mtime;                 /* Modification time */
 538         __le64 i_dtime;                 /* Deletion time */
 539 /*50*/  __le64 i_blkno;                 /* Offset on disk, in blocks */
 540         __le64 i_last_eb_blk;           /* Pointer to last extent
 541                                            block */
 542 /*60*/  __le32 i_fs_generation;         /* Generation per fs-instance */
 543         __le32 i_atime_nsec;
 544         __le32 i_ctime_nsec;
 545         __le32 i_mtime_nsec;
 546         __le32 i_attr;
 547         __le16 i_orphaned_slot;         /* Only valid when OCFS2_ORPHANED_FL
 548                                            was set in i_flags */
 549         __le16 i_dyn_features;
 550 /*70*/  __le64 i_reserved2[8];
 551 /*B8*/  union {
 552                 __le64 i_pad1;          /* Generic way to refer to this
 553                                            64bit union */
 554                 struct {
 555                         __le64 i_rdev;  /* Device number */
 556                 } dev1;
 557                 struct {                /* Info for bitmap system
 558                                            inodes */
 559                         __le32 i_used;  /* Bits (ie, clusters) used  */
 560                         __le32 i_total; /* Total bits (clusters)
 561                                            available */
 562                 } bitmap1;
 563                 struct {                /* Info for journal system
 564                                            inodes */
 565                         __le32 ij_flags;        /* Mounted, version, etc. */
 566                         __le32 ij_pad;
 567                 } journal1;
 568         } id1;                          /* Inode type dependant 1 */
 569 /*C0*/  union {
 570                 struct ocfs2_super_block        i_super;
 571                 struct ocfs2_local_alloc        i_lab;
 572                 struct ocfs2_chain_list         i_chain;
 573                 struct ocfs2_extent_list        i_list;
 574                 struct ocfs2_truncate_log       i_dealloc;
 575                 struct ocfs2_inline_data        i_data;
 576                 __u8                            i_symlink[0];
 577         } id2;
 578 /* Actual on-disk size is one block */
 579 };
 580
 581 /*
 582  * On-disk directory entry structure for OCFS2
 583  *
 584  * Packed as this structure could be accessed unaligned on 64-bit platforms
 585  */
 586 struct ocfs2_dir_entry {
 587 /*00*/  __le64   inode;                  /* Inode number */
 588         __le16   rec_len;                /* Directory entry length */
 589         __u8    name_len;               /* Name length */
 590         __u8    file_type;
 591 /*0C*/  char    name[OCFS2_MAX_FILENAME_LEN];   /* File name */
 592 /* Actual on-disk length specified by rec_len */
 593 } __attribute__ ((packed));
 594
 595 /*
 596  * On disk allocator group structure for OCFS2
 597  */
 598 struct ocfs2_group_desc
 599 {
 600 /*00*/  __u8    bg_signature[8];        /* Signature for validation */
 601         __le16   bg_size;                /* Size of included bitmap in
 602                                            bytes. */
 603         __le16   bg_bits;                /* Bits represented by this
 604                                            group. */
 605         __le16  bg_free_bits_count;     /* Free bits count */
 606         __le16   bg_chain;               /* What chain I am in. */
 607 /*10*/  __le32   bg_generation;
 608         __le32  bg_reserved1;
 609         __le64   bg_next_group;          /* Next group in my list, in
 610                                            blocks */
 611 /*20*/  __le64   bg_parent_dinode;       /* dinode which owns me, in
 612                                            blocks */
 613         __le64   bg_blkno;               /* Offset on disk, in blocks */
 614 /*30*/  __le64   bg_reserved2[2];
 615 /*40*/  __u8    bg_bitmap[0];
 616 };
 617
 618 #ifdef __KERNEL__
 619 static inline int ocfs2_fast_symlink_chars(struct super_block *sb)
 620 {
 621         return  sb->s_blocksize -
 622                  offsetof(struct ocfs2_dinode, id2.i_symlink);
 623 }
 624
 625 static inline int ocfs2_max_inline_data(struct super_block *sb)
 626 {
 627         return sb->s_blocksize -
 628                 offsetof(struct ocfs2_dinode, id2.i_data.id_data);
 629 }
 630
 631 static inline int ocfs2_extent_recs_per_inode(struct super_block *sb)
 632 {
 633         int size;
 634
 635         size = sb->s_blocksize -
 636                 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
 637
 638         return size / sizeof(struct ocfs2_extent_rec);
 639 }
 640
 641 static inline int ocfs2_chain_recs_per_inode(struct super_block *sb)
 642 {
 643         int size;
 644
 645         size = sb->s_blocksize -
 646                 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
 647
 648         return size / sizeof(struct ocfs2_chain_rec);
 649 }
 650
 651 static inline u16 ocfs2_extent_recs_per_eb(struct super_block *sb)
 652 {
 653         int size;
 654
 655         size = sb->s_blocksize -
 656                 offsetof(struct ocfs2_extent_block, h_list.l_recs);
 657
 658         return size / sizeof(struct ocfs2_extent_rec);
 659 }
 660
 661 static inline u16 ocfs2_local_alloc_size(struct super_block *sb)
 662 {
 663         u16 size;
 664
 665         size = sb->s_blocksize -
 666                 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
 667
 668         return size;
 669 }
 670
 671 static inline int ocfs2_group_bitmap_size(struct super_block *sb)
 672 {
 673         int size;
 674
 675         size = sb->s_blocksize -
 676                 offsetof(struct ocfs2_group_desc, bg_bitmap);
 677
 678         return size;
 679 }
 680
 681 static inline int ocfs2_truncate_recs_per_inode(struct super_block *sb)
 682 {
 683         int size;
 684
 685         size = sb->s_blocksize -
 686                 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
 687
 688         return size / sizeof(struct ocfs2_truncate_rec);
 689 }
 690
 691 static inline u64 ocfs2_backup_super_blkno(struct super_block *sb, int index)
 692 {
 693         u64 offset = OCFS2_BACKUP_SB_START;
 694
 695         if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
 696                 offset <<= (2 * index);
 697                 offset >>= sb->s_blocksize_bits;
 698                 return offset;
 699         }
 700
 701         return 0;
 702
 703 }
 704 #else
 705 static inline int ocfs2_fast_symlink_chars(int blocksize)
 706 {
 707         return blocksize - offsetof(struct ocfs2_dinode, id2.i_symlink);
 708 }
 709
 710 static inline int ocfs2_max_inline_data(int blocksize)
 711 {
 712         return blocksize - offsetof(struct ocfs2_dinode, id2.i_data.id_data);
 713 }
 714
 715 static inline int ocfs2_extent_recs_per_inode(int blocksize)
 716 {
 717         int size;
 718
 719         size = blocksize -
 720                 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
 721
 722         return size / sizeof(struct ocfs2_extent_rec);
 723 }
 724
 725 static inline int ocfs2_chain_recs_per_inode(int blocksize)
 726 {
 727         int size;
 728
 729         size = blocksize -
 730                 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
 731
 732         return size / sizeof(struct ocfs2_chain_rec);
 733 }
 734
 735 static inline int ocfs2_extent_recs_per_eb(int blocksize)
 736 {
 737         int size;
 738
 739         size = blocksize -
 740                 offsetof(struct ocfs2_extent_block, h_list.l_recs);
 741
 742         return size / sizeof(struct ocfs2_extent_rec);
 743 }
 744
 745 static inline int ocfs2_local_alloc_size(int blocksize)
 746 {
 747         int size;
 748
 749         size = blocksize -
 750                 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
 751
 752         return size;
 753 }
 754
 755 static inline int ocfs2_group_bitmap_size(int blocksize)
 756 {
 757         int size;
 758
 759         size = blocksize -
 760                 offsetof(struct ocfs2_group_desc, bg_bitmap);
 761
 762         return size;
 763 }
 764
 765 static inline int ocfs2_truncate_recs_per_inode(int blocksize)
 766 {
 767         int size;
 768
 769         size = blocksize -
 770                 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
 771
 772         return size / sizeof(struct ocfs2_truncate_rec);
 773 }
 774
 775 static inline uint64_t ocfs2_backup_super_blkno(int blocksize, int index)
 776 {
 777         uint64_t offset = OCFS2_BACKUP_SB_START;
 778
 779         if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
 780                 offset <<= (2 * index);
 781                 offset /= blocksize;
 782                 return offset;
 783         }
 784
 785         return 0;
 786 }
 787 #endif  /* __KERNEL__ */
 788
 789
 790 static inline int ocfs2_system_inode_is_global(int type)
 791 {
 792         return ((type >= 0) &&
 793                 (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE));
 794 }
 795
 796 static inline int ocfs2_sprintf_system_inode_name(char *buf, int len,
 797                                                   int type, int slot)
 798 {
 799         int chars;
 800
 801         /*
 802          * Global system inodes can only have one copy.  Everything
 803          * after OCFS2_LAST_GLOBAL_SYSTEM_INODE in the system inode
 804          * list has a copy per slot.
 805          */
 806         if (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE)
 807                 chars = snprintf(buf, len,
 808                                  ocfs2_system_inodes[type].si_name);
 809         else
 810                 chars = snprintf(buf, len,
 811                                  ocfs2_system_inodes[type].si_name,
 812                                  slot);
 813
 814         return chars;
 815 }
 816
 817 static inline void ocfs2_set_de_type(struct ocfs2_dir_entry *de,
 818                                     umode_t mode)
 819 {
 820         de->file_type = ocfs2_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
 821 }
 822
 823 #endif  /* _OCFS2_FS_H */
 824