err.no Git - 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
  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 /* Used to pass group descriptor data when online resize is done */
 235 struct ocfs2_new_group_input {
 236         __u64 group;            /* Group descriptor's blkno. */
 237         __u32 clusters;         /* Total number of clusters in this group */
 238         __u32 frees;            /* Total free clusters in this group */
 239         __u16 chain;            /* Chain for this group */
 240         __u16 reserved1;
 241         __u32 reserved2;
 242 };
 243
 244 #define OCFS2_IOC_GROUP_EXTEND  _IOW('o', 1, int)
 245 #define OCFS2_IOC_GROUP_ADD     _IOW('o', 2,struct ocfs2_new_group_input)
 246 #define OCFS2_IOC_GROUP_ADD64   _IOW('o', 3,struct ocfs2_new_group_input)
 247
 248 /*
 249  * Journal Flags (ocfs2_dinode.id1.journal1.i_flags)
 250  */
 251 #define OCFS2_JOURNAL_DIRTY_FL  (0x00000001)    /* Journal needs recovery */
 252
 253 /*
 254  * superblock s_state flags
 255  */
 256 #define OCFS2_ERROR_FS          (0x00000001)    /* FS saw errors */
 257
 258 /* Limit of space in ocfs2_dir_entry */
 259 #define OCFS2_MAX_FILENAME_LEN          255
 260
 261 /* Maximum slots on an ocfs2 file system */
 262 #define OCFS2_MAX_SLOTS                 255
 263
 264 /* Slot map indicator for an empty slot */
 265 #define OCFS2_INVALID_SLOT              -1
 266
 267 #define OCFS2_VOL_UUID_LEN              16
 268 #define OCFS2_MAX_VOL_LABEL_LEN         64
 269
 270 /* Journal limits (in bytes) */
 271 #define OCFS2_MIN_JOURNAL_SIZE          (4 * 1024 * 1024)
 272
 273 struct ocfs2_system_inode_info {
 274         char    *si_name;
 275         int     si_iflags;
 276         int     si_mode;
 277 };
 278
 279 /* System file index */
 280 enum {
 281         BAD_BLOCK_SYSTEM_INODE = 0,
 282         GLOBAL_INODE_ALLOC_SYSTEM_INODE,
 283         SLOT_MAP_SYSTEM_INODE,
 284 #define OCFS2_FIRST_ONLINE_SYSTEM_INODE SLOT_MAP_SYSTEM_INODE
 285         HEARTBEAT_SYSTEM_INODE,
 286         GLOBAL_BITMAP_SYSTEM_INODE,
 287 #define OCFS2_LAST_GLOBAL_SYSTEM_INODE GLOBAL_BITMAP_SYSTEM_INODE
 288         ORPHAN_DIR_SYSTEM_INODE,
 289         EXTENT_ALLOC_SYSTEM_INODE,
 290         INODE_ALLOC_SYSTEM_INODE,
 291         JOURNAL_SYSTEM_INODE,
 292         LOCAL_ALLOC_SYSTEM_INODE,
 293         TRUNCATE_LOG_SYSTEM_INODE,
 294         NUM_SYSTEM_INODES
 295 };
 296
 297 static struct ocfs2_system_inode_info ocfs2_system_inodes[NUM_SYSTEM_INODES] = {
 298         /* Global system inodes (single copy) */
 299         /* The first two are only used from userspace mfks/tunefs */
 300         [BAD_BLOCK_SYSTEM_INODE]                = { "bad_blocks", 0, S_IFREG | 0644 },
 301         [GLOBAL_INODE_ALLOC_SYSTEM_INODE]       = { "global_inode_alloc", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
 302
 303         /* These are used by the running filesystem */
 304         [SLOT_MAP_SYSTEM_INODE]                 = { "slot_map", 0, S_IFREG | 0644 },
 305         [HEARTBEAT_SYSTEM_INODE]                = { "heartbeat", OCFS2_HEARTBEAT_FL, S_IFREG | 0644 },
 306         [GLOBAL_BITMAP_SYSTEM_INODE]            = { "global_bitmap", 0, S_IFREG | 0644 },
 307
 308         /* Slot-specific system inodes (one copy per slot) */
 309         [ORPHAN_DIR_SYSTEM_INODE]               = { "orphan_dir:%04d", 0, S_IFDIR | 0755 },
 310         [EXTENT_ALLOC_SYSTEM_INODE]             = { "extent_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
 311         [INODE_ALLOC_SYSTEM_INODE]              = { "inode_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_CHAIN_FL, S_IFREG | 0644 },
 312         [JOURNAL_SYSTEM_INODE]                  = { "journal:%04d", OCFS2_JOURNAL_FL, S_IFREG | 0644 },
 313         [LOCAL_ALLOC_SYSTEM_INODE]              = { "local_alloc:%04d", OCFS2_BITMAP_FL | OCFS2_LOCAL_ALLOC_FL, S_IFREG | 0644 },
 314         [TRUNCATE_LOG_SYSTEM_INODE]             = { "truncate_log:%04d", OCFS2_DEALLOC_FL, S_IFREG | 0644 }
 315 };
 316
 317 /* Parameter passed from mount.ocfs2 to module */
 318 #define OCFS2_HB_NONE                   "heartbeat=none"
 319 #define OCFS2_HB_LOCAL                  "heartbeat=local"
 320
 321 /*
 322  * OCFS2 directory file types.  Only the low 3 bits are used.  The
 323  * other bits are reserved for now.
 324  */
 325 #define OCFS2_FT_UNKNOWN        0
 326 #define OCFS2_FT_REG_FILE       1
 327 #define OCFS2_FT_DIR            2
 328 #define OCFS2_FT_CHRDEV         3
 329 #define OCFS2_FT_BLKDEV         4
 330 #define OCFS2_FT_FIFO           5
 331 #define OCFS2_FT_SOCK           6
 332 #define OCFS2_FT_SYMLINK        7
 333
 334 #define OCFS2_FT_MAX            8
 335
 336 /*
 337  * OCFS2_DIR_PAD defines the directory entries boundaries
 338  *
 339  * NOTE: It must be a multiple of 4
 340  */
 341 #define OCFS2_DIR_PAD                   4
 342 #define OCFS2_DIR_ROUND                 (OCFS2_DIR_PAD - 1)
 343 #define OCFS2_DIR_MEMBER_LEN            offsetof(struct ocfs2_dir_entry, name)
 344 #define OCFS2_DIR_REC_LEN(name_len)     (((name_len) + OCFS2_DIR_MEMBER_LEN + \
 345                                           OCFS2_DIR_ROUND) & \
 346                                          ~OCFS2_DIR_ROUND)
 347
 348 #define OCFS2_LINK_MAX          32000
 349
 350 #define S_SHIFT                 12
 351 static unsigned char ocfs2_type_by_mode[S_IFMT >> S_SHIFT] = {
 352         [S_IFREG >> S_SHIFT]  = OCFS2_FT_REG_FILE,
 353         [S_IFDIR >> S_SHIFT]  = OCFS2_FT_DIR,
 354         [S_IFCHR >> S_SHIFT]  = OCFS2_FT_CHRDEV,
 355         [S_IFBLK >> S_SHIFT]  = OCFS2_FT_BLKDEV,
 356         [S_IFIFO >> S_SHIFT]  = OCFS2_FT_FIFO,
 357         [S_IFSOCK >> S_SHIFT] = OCFS2_FT_SOCK,
 358         [S_IFLNK >> S_SHIFT]  = OCFS2_FT_SYMLINK,
 359 };
 360
 361
 362 /*
 363  * Convenience casts
 364  */
 365 #define OCFS2_RAW_SB(dinode)            (&((dinode)->id2.i_super))
 366
 367 /*
 368  * On disk extent record for OCFS2
 369  * It describes a range of clusters on disk.
 370  *
 371  * Length fields are divided into interior and leaf node versions.
 372  * This leaves room for a flags field (OCFS2_EXT_*) in the leaf nodes.
 373  */
 374 struct ocfs2_extent_rec {
 375 /*00*/  __le32 e_cpos;          /* Offset into the file, in clusters */
 376         union {
 377                 __le32 e_int_clusters; /* Clusters covered by all children */
 378                 struct {
 379                         __le16 e_leaf_clusters; /* Clusters covered by this
 380                                                    extent */
 381                         __u8 e_reserved1;
 382                         __u8 e_flags; /* Extent flags */
 383                 };
 384         };
 385         __le64 e_blkno;         /* Physical disk offset, in blocks */
 386 /*10*/
 387 };
 388
 389 struct ocfs2_chain_rec {
 390         __le32 c_free;  /* Number of free bits in this chain. */
 391         __le32 c_total; /* Number of total bits in this chain */
 392         __le64 c_blkno; /* Physical disk offset (blocks) of 1st group */
 393 };
 394
 395 struct ocfs2_truncate_rec {
 396         __le32 t_start;         /* 1st cluster in this log */
 397         __le32 t_clusters;      /* Number of total clusters covered */
 398 };
 399
 400 /*
 401  * On disk extent list for OCFS2 (node in the tree).  Note that this
 402  * is contained inside ocfs2_dinode or ocfs2_extent_block, so the
 403  * offsets are relative to ocfs2_dinode.id2.i_list or
 404  * ocfs2_extent_block.h_list, respectively.
 405  */
 406 struct ocfs2_extent_list {
 407 /*00*/  __le16 l_tree_depth;            /* Extent tree depth from this
 408                                            point.  0 means data extents
 409                                            hang directly off this
 410                                            header (a leaf)
 411                                            NOTE: The high 8 bits cannot be
 412                                            used - tree_depth is never that big.
 413                                         */
 414         __le16 l_count;                 /* Number of extent records */
 415         __le16 l_next_free_rec;         /* Next unused extent slot */
 416         __le16 l_reserved1;
 417         __le64 l_reserved2;             /* Pad to
 418                                            sizeof(ocfs2_extent_rec) */
 419 /*10*/  struct ocfs2_extent_rec l_recs[0];      /* Extent records */
 420 };
 421
 422 /*
 423  * On disk allocation chain list for OCFS2.  Note that this is
 424  * contained inside ocfs2_dinode, so the offsets are relative to
 425  * ocfs2_dinode.id2.i_chain.
 426  */
 427 struct ocfs2_chain_list {
 428 /*00*/  __le16 cl_cpg;                  /* Clusters per Block Group */
 429         __le16 cl_bpc;                  /* Bits per cluster */
 430         __le16 cl_count;                /* Total chains in this list */
 431         __le16 cl_next_free_rec;        /* Next unused chain slot */
 432         __le64 cl_reserved1;
 433 /*10*/  struct ocfs2_chain_rec cl_recs[0];      /* Chain records */
 434 };
 435
 436 /*
 437  * On disk deallocation log for OCFS2.  Note that this is
 438  * contained inside ocfs2_dinode, so the offsets are relative to
 439  * ocfs2_dinode.id2.i_dealloc.
 440  */
 441 struct ocfs2_truncate_log {
 442 /*00*/  __le16 tl_count;                /* Total records in this log */
 443         __le16 tl_used;                 /* Number of records in use */
 444         __le32 tl_reserved1;
 445 /*08*/  struct ocfs2_truncate_rec tl_recs[0];   /* Truncate records */
 446 };
 447
 448 /*
 449  * On disk extent block (indirect block) for OCFS2
 450  */
 451 struct ocfs2_extent_block
 452 {
 453 /*00*/  __u8 h_signature[8];            /* Signature for verification */
 454         __le64 h_reserved1;
 455 /*10*/  __le16 h_suballoc_slot;         /* Slot suballocator this
 456                                            extent_header belongs to */
 457         __le16 h_suballoc_bit;          /* Bit offset in suballocator
 458                                            block group */
 459         __le32 h_fs_generation;         /* Must match super block */
 460         __le64 h_blkno;                 /* Offset on disk, in blocks */
 461 /*20*/  __le64 h_reserved3;
 462         __le64 h_next_leaf_blk;         /* Offset on disk, in blocks,
 463                                            of next leaf header pointing
 464                                            to data */
 465 /*30*/  struct ocfs2_extent_list h_list;        /* Extent record list */
 466 /* Actual on-disk size is one block */
 467 };
 468
 469 /*
 470  * On disk superblock for OCFS2
 471  * Note that it is contained inside an ocfs2_dinode, so all offsets
 472  * are relative to the start of ocfs2_dinode.id2.
 473  */
 474 struct ocfs2_super_block {
 475 /*00*/  __le16 s_major_rev_level;
 476         __le16 s_minor_rev_level;
 477         __le16 s_mnt_count;
 478         __le16 s_max_mnt_count;
 479         __le16 s_state;                 /* File system state */
 480         __le16 s_errors;                        /* Behaviour when detecting errors */
 481         __le32 s_checkinterval;         /* Max time between checks */
 482 /*10*/  __le64 s_lastcheck;             /* Time of last check */
 483         __le32 s_creator_os;            /* OS */
 484         __le32 s_feature_compat;                /* Compatible feature set */
 485 /*20*/  __le32 s_feature_incompat;      /* Incompatible feature set */
 486         __le32 s_feature_ro_compat;     /* Readonly-compatible feature set */
 487         __le64 s_root_blkno;            /* Offset, in blocks, of root directory
 488                                            dinode */
 489 /*30*/  __le64 s_system_dir_blkno;      /* Offset, in blocks, of system
 490                                            directory dinode */
 491         __le32 s_blocksize_bits;                /* Blocksize for this fs */
 492         __le32 s_clustersize_bits;      /* Clustersize for this fs */
 493 /*40*/  __le16 s_max_slots;             /* Max number of simultaneous mounts
 494                                            before tunefs required */
 495         __le16 s_tunefs_flag;
 496         __le32 s_reserved1;
 497         __le64 s_first_cluster_group;   /* Block offset of 1st cluster
 498                                          * group header */
 499 /*50*/  __u8  s_label[OCFS2_MAX_VOL_LABEL_LEN]; /* Label for mounting, etc. */
 500 /*90*/  __u8  s_uuid[OCFS2_VOL_UUID_LEN];       /* 128-bit uuid */
 501 /*A0*/
 502 };
 503
 504 /*
 505  * Local allocation bitmap for OCFS2 slots
 506  * Note that it exists inside an ocfs2_dinode, so all offsets are
 507  * relative to the start of ocfs2_dinode.id2.
 508  */
 509 struct ocfs2_local_alloc
 510 {
 511 /*00*/  __le32 la_bm_off;       /* Starting bit offset in main bitmap */
 512         __le16 la_size;         /* Size of included bitmap, in bytes */
 513         __le16 la_reserved1;
 514         __le64 la_reserved2;
 515 /*10*/  __u8   la_bitmap[0];
 516 };
 517
 518 /*
 519  * Data-in-inode header. This is only used if i_dyn_features has
 520  * OCFS2_INLINE_DATA_FL set.
 521  */
 522 struct ocfs2_inline_data
 523 {
 524 /*00*/  __le16  id_count;       /* Number of bytes that can be used
 525                                  * for data, starting at id_data */
 526         __le16  id_reserved0;
 527         __le32  id_reserved1;
 528         __u8    id_data[0];     /* Start of user data */
 529 };
 530
 531 /*
 532  * On disk inode for OCFS2
 533  */
 534 struct ocfs2_dinode {
 535 /*00*/  __u8 i_signature[8];            /* Signature for validation */
 536         __le32 i_generation;            /* Generation number */
 537         __le16 i_suballoc_slot;         /* Slot suballocator this inode
 538                                            belongs to */
 539         __le16 i_suballoc_bit;          /* Bit offset in suballocator
 540                                            block group */
 541 /*10*/  __le32 i_reserved0;
 542         __le32 i_clusters;              /* Cluster count */
 543         __le32 i_uid;                   /* Owner UID */
 544         __le32 i_gid;                   /* Owning GID */
 545 /*20*/  __le64 i_size;                  /* Size in bytes */
 546         __le16 i_mode;                  /* File mode */
 547         __le16 i_links_count;           /* Links count */
 548         __le32 i_flags;                 /* File flags */
 549 /*30*/  __le64 i_atime;                 /* Access time */
 550         __le64 i_ctime;                 /* Creation time */
 551 /*40*/  __le64 i_mtime;                 /* Modification time */
 552         __le64 i_dtime;                 /* Deletion time */
 553 /*50*/  __le64 i_blkno;                 /* Offset on disk, in blocks */
 554         __le64 i_last_eb_blk;           /* Pointer to last extent
 555                                            block */
 556 /*60*/  __le32 i_fs_generation;         /* Generation per fs-instance */
 557         __le32 i_atime_nsec;
 558         __le32 i_ctime_nsec;
 559         __le32 i_mtime_nsec;
 560         __le32 i_attr;
 561         __le16 i_orphaned_slot;         /* Only valid when OCFS2_ORPHANED_FL
 562                                            was set in i_flags */
 563         __le16 i_dyn_features;
 564 /*70*/  __le64 i_reserved2[8];
 565 /*B8*/  union {
 566                 __le64 i_pad1;          /* Generic way to refer to this
 567                                            64bit union */
 568                 struct {
 569                         __le64 i_rdev;  /* Device number */
 570                 } dev1;
 571                 struct {                /* Info for bitmap system
 572                                            inodes */
 573                         __le32 i_used;  /* Bits (ie, clusters) used  */
 574                         __le32 i_total; /* Total bits (clusters)
 575                                            available */
 576                 } bitmap1;
 577                 struct {                /* Info for journal system
 578                                            inodes */
 579                         __le32 ij_flags;        /* Mounted, version, etc. */
 580                         __le32 ij_pad;
 581                 } journal1;
 582         } id1;                          /* Inode type dependant 1 */
 583 /*C0*/  union {
 584                 struct ocfs2_super_block        i_super;
 585                 struct ocfs2_local_alloc        i_lab;
 586                 struct ocfs2_chain_list         i_chain;
 587                 struct ocfs2_extent_list        i_list;
 588                 struct ocfs2_truncate_log       i_dealloc;
 589                 struct ocfs2_inline_data        i_data;
 590                 __u8                            i_symlink[0];
 591         } id2;
 592 /* Actual on-disk size is one block */
 593 };
 594
 595 /*
 596  * On-disk directory entry structure for OCFS2
 597  *
 598  * Packed as this structure could be accessed unaligned on 64-bit platforms
 599  */
 600 struct ocfs2_dir_entry {
 601 /*00*/  __le64   inode;                  /* Inode number */
 602         __le16   rec_len;                /* Directory entry length */
 603         __u8    name_len;               /* Name length */
 604         __u8    file_type;
 605 /*0C*/  char    name[OCFS2_MAX_FILENAME_LEN];   /* File name */
 606 /* Actual on-disk length specified by rec_len */
 607 } __attribute__ ((packed));
 608
 609 /*
 610  * On disk allocator group structure for OCFS2
 611  */
 612 struct ocfs2_group_desc
 613 {
 614 /*00*/  __u8    bg_signature[8];        /* Signature for validation */
 615         __le16   bg_size;                /* Size of included bitmap in
 616                                            bytes. */
 617         __le16   bg_bits;                /* Bits represented by this
 618                                            group. */
 619         __le16  bg_free_bits_count;     /* Free bits count */
 620         __le16   bg_chain;               /* What chain I am in. */
 621 /*10*/  __le32   bg_generation;
 622         __le32  bg_reserved1;
 623         __le64   bg_next_group;          /* Next group in my list, in
 624                                            blocks */
 625 /*20*/  __le64   bg_parent_dinode;       /* dinode which owns me, in
 626                                            blocks */
 627         __le64   bg_blkno;               /* Offset on disk, in blocks */
 628 /*30*/  __le64   bg_reserved2[2];
 629 /*40*/  __u8    bg_bitmap[0];
 630 };
 631
 632 #ifdef __KERNEL__
 633 static inline int ocfs2_fast_symlink_chars(struct super_block *sb)
 634 {
 635         return  sb->s_blocksize -
 636                  offsetof(struct ocfs2_dinode, id2.i_symlink);
 637 }
 638
 639 static inline int ocfs2_max_inline_data(struct super_block *sb)
 640 {
 641         return sb->s_blocksize -
 642                 offsetof(struct ocfs2_dinode, id2.i_data.id_data);
 643 }
 644
 645 static inline int ocfs2_extent_recs_per_inode(struct super_block *sb)
 646 {
 647         int size;
 648
 649         size = sb->s_blocksize -
 650                 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
 651
 652         return size / sizeof(struct ocfs2_extent_rec);
 653 }
 654
 655 static inline int ocfs2_chain_recs_per_inode(struct super_block *sb)
 656 {
 657         int size;
 658
 659         size = sb->s_blocksize -
 660                 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
 661
 662         return size / sizeof(struct ocfs2_chain_rec);
 663 }
 664
 665 static inline u16 ocfs2_extent_recs_per_eb(struct super_block *sb)
 666 {
 667         int size;
 668
 669         size = sb->s_blocksize -
 670                 offsetof(struct ocfs2_extent_block, h_list.l_recs);
 671
 672         return size / sizeof(struct ocfs2_extent_rec);
 673 }
 674
 675 static inline u16 ocfs2_local_alloc_size(struct super_block *sb)
 676 {
 677         u16 size;
 678
 679         size = sb->s_blocksize -
 680                 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
 681
 682         return size;
 683 }
 684
 685 static inline int ocfs2_group_bitmap_size(struct super_block *sb)
 686 {
 687         int size;
 688
 689         size = sb->s_blocksize -
 690                 offsetof(struct ocfs2_group_desc, bg_bitmap);
 691
 692         return size;
 693 }
 694
 695 static inline int ocfs2_truncate_recs_per_inode(struct super_block *sb)
 696 {
 697         int size;
 698
 699         size = sb->s_blocksize -
 700                 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
 701
 702         return size / sizeof(struct ocfs2_truncate_rec);
 703 }
 704
 705 static inline u64 ocfs2_backup_super_blkno(struct super_block *sb, int index)
 706 {
 707         u64 offset = OCFS2_BACKUP_SB_START;
 708
 709         if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
 710                 offset <<= (2 * index);
 711                 offset >>= sb->s_blocksize_bits;
 712                 return offset;
 713         }
 714
 715         return 0;
 716
 717 }
 718 #else
 719 static inline int ocfs2_fast_symlink_chars(int blocksize)
 720 {
 721         return blocksize - offsetof(struct ocfs2_dinode, id2.i_symlink);
 722 }
 723
 724 static inline int ocfs2_max_inline_data(int blocksize)
 725 {
 726         return blocksize - offsetof(struct ocfs2_dinode, id2.i_data.id_data);
 727 }
 728
 729 static inline int ocfs2_extent_recs_per_inode(int blocksize)
 730 {
 731         int size;
 732
 733         size = blocksize -
 734                 offsetof(struct ocfs2_dinode, id2.i_list.l_recs);
 735
 736         return size / sizeof(struct ocfs2_extent_rec);
 737 }
 738
 739 static inline int ocfs2_chain_recs_per_inode(int blocksize)
 740 {
 741         int size;
 742
 743         size = blocksize -
 744                 offsetof(struct ocfs2_dinode, id2.i_chain.cl_recs);
 745
 746         return size / sizeof(struct ocfs2_chain_rec);
 747 }
 748
 749 static inline int ocfs2_extent_recs_per_eb(int blocksize)
 750 {
 751         int size;
 752
 753         size = blocksize -
 754                 offsetof(struct ocfs2_extent_block, h_list.l_recs);
 755
 756         return size / sizeof(struct ocfs2_extent_rec);
 757 }
 758
 759 static inline int ocfs2_local_alloc_size(int blocksize)
 760 {
 761         int size;
 762
 763         size = blocksize -
 764                 offsetof(struct ocfs2_dinode, id2.i_lab.la_bitmap);
 765
 766         return size;
 767 }
 768
 769 static inline int ocfs2_group_bitmap_size(int blocksize)
 770 {
 771         int size;
 772
 773         size = blocksize -
 774                 offsetof(struct ocfs2_group_desc, bg_bitmap);
 775
 776         return size;
 777 }
 778
 779 static inline int ocfs2_truncate_recs_per_inode(int blocksize)
 780 {
 781         int size;
 782
 783         size = blocksize -
 784                 offsetof(struct ocfs2_dinode, id2.i_dealloc.tl_recs);
 785
 786         return size / sizeof(struct ocfs2_truncate_rec);
 787 }
 788
 789 static inline uint64_t ocfs2_backup_super_blkno(int blocksize, int index)
 790 {
 791         uint64_t offset = OCFS2_BACKUP_SB_START;
 792
 793         if (index >= 0 && index < OCFS2_MAX_BACKUP_SUPERBLOCKS) {
 794                 offset <<= (2 * index);
 795                 offset /= blocksize;
 796                 return offset;
 797         }
 798
 799         return 0;
 800 }
 801 #endif  /* __KERNEL__ */
 802
 803
 804 static inline int ocfs2_system_inode_is_global(int type)
 805 {
 806         return ((type >= 0) &&
 807                 (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE));
 808 }
 809
 810 static inline int ocfs2_sprintf_system_inode_name(char *buf, int len,
 811                                                   int type, int slot)
 812 {
 813         int chars;
 814
 815         /*
 816          * Global system inodes can only have one copy.  Everything
 817          * after OCFS2_LAST_GLOBAL_SYSTEM_INODE in the system inode
 818          * list has a copy per slot.
 819          */
 820         if (type <= OCFS2_LAST_GLOBAL_SYSTEM_INODE)
 821                 chars = snprintf(buf, len,
 822                                  ocfs2_system_inodes[type].si_name);
 823         else
 824                 chars = snprintf(buf, len,
 825                                  ocfs2_system_inodes[type].si_name,
 826                                  slot);
 827
 828         return chars;
 829 }
 830
 831 static inline void ocfs2_set_de_type(struct ocfs2_dir_entry *de,
 832                                     umode_t mode)
 833 {
 834         de->file_type = ocfs2_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
 835 }
 836
 837 #endif  /* _OCFS2_FS_H */
 838