include/linux/ext3_fs.h

   1 /*
   2  *  linux/include/linux/ext3_fs.h
   3  *
   4  * Copyright (C) 1992, 1993, 1994, 1995
   5  * Remy Card (card@masi.ibp.fr)
   6  * Laboratoire MASI - Institut Blaise Pascal
   7  * Universite Pierre et Marie Curie (Paris VI)
   8  *
   9  *  from
  10  *
  11  *  linux/include/linux/minix_fs.h
  12  *
  13  *  Copyright (C) 1991, 1992  Linus Torvalds
  14  */
  15
  16 #ifndef _LINUX_EXT3_FS_H
  17 #define _LINUX_EXT3_FS_H
  18
  19 #include <linux/types.h>
  20
  21 /*
  22  * The second extended filesystem constants/structures
  23  */
  24
  25 /*
  26  * Define EXT3FS_DEBUG to produce debug messages
  27  */
  28 #undef EXT3FS_DEBUG
  29
  30 /*
  31  * Define EXT3_RESERVATION to reserve data blocks for expanding files
  32  */
  33 #define EXT3_DEFAULT_RESERVE_BLOCKS     8
  34 /*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
  35 #define EXT3_MAX_RESERVE_BLOCKS         1027
  36 #define EXT3_RESERVE_WINDOW_NOT_ALLOCATED 0
  37 /*
  38  * Always enable hashed directories
  39  */
  40 #define CONFIG_EXT3_INDEX
  41
  42 /*
  43  * Debug code
  44  */
  45 #ifdef EXT3FS_DEBUG
  46 #define ext3_debug(f, a...)                                             \
  47         do {                                                            \
  48                 printk (KERN_DEBUG "EXT3-fs DEBUG (%s, %d): %s:",       \
  49                         __FILE__, __LINE__, __FUNCTION__);              \
  50                 printk (KERN_DEBUG f, ## a);                            \
  51         } while (0)
  52 #else
  53 #define ext3_debug(f, a...)     do {} while (0)
  54 #endif
  55
  56 /*
  57  * Special inodes numbers
  58  */
  59 #define EXT3_BAD_INO             1      /* Bad blocks inode */
  60 #define EXT3_ROOT_INO            2      /* Root inode */
  61 #define EXT3_BOOT_LOADER_INO     5      /* Boot loader inode */
  62 #define EXT3_UNDEL_DIR_INO       6      /* Undelete directory inode */
  63 #define EXT3_RESIZE_INO          7      /* Reserved group descriptors inode */
  64 #define EXT3_JOURNAL_INO         8      /* Journal inode */
  65
  66 /* First non-reserved inode for old ext3 filesystems */
  67 #define EXT3_GOOD_OLD_FIRST_INO 11
  68
  69 /*
  70  * The second extended file system magic number
  71  */
  72 #define EXT3_SUPER_MAGIC        0xEF53
  73
  74 /*
  75  * Maximal count of links to a file
  76  */
  77 #define EXT3_LINK_MAX           32000
  78
  79 /*
  80  * Macro-instructions used to manage several block sizes
  81  */
  82 #define EXT3_MIN_BLOCK_SIZE             1024
  83 #define EXT3_MAX_BLOCK_SIZE             4096
  84 #define EXT3_MIN_BLOCK_LOG_SIZE           10
  85 #ifdef __KERNEL__
  86 # define EXT3_BLOCK_SIZE(s)             ((s)->s_blocksize)
  87 #else
  88 # define EXT3_BLOCK_SIZE(s)             (EXT3_MIN_BLOCK_SIZE << (s)->s_log_block_size)
  89 #endif
  90 #define EXT3_ADDR_PER_BLOCK(s)          (EXT3_BLOCK_SIZE(s) / sizeof (__u32))
  91 #ifdef __KERNEL__
  92 # define EXT3_BLOCK_SIZE_BITS(s)        ((s)->s_blocksize_bits)
  93 #else
  94 # define EXT3_BLOCK_SIZE_BITS(s)        ((s)->s_log_block_size + 10)
  95 #endif
  96 #ifdef __KERNEL__
  97 #define EXT3_ADDR_PER_BLOCK_BITS(s)     (EXT3_SB(s)->s_addr_per_block_bits)
  98 #define EXT3_INODE_SIZE(s)              (EXT3_SB(s)->s_inode_size)
  99 #define EXT3_FIRST_INO(s)               (EXT3_SB(s)->s_first_ino)
 100 #else
 101 #define EXT3_INODE_SIZE(s)      (((s)->s_rev_level == EXT3_GOOD_OLD_REV) ? \
 102                                  EXT3_GOOD_OLD_INODE_SIZE : \
 103                                  (s)->s_inode_size)
 104 #define EXT3_FIRST_INO(s)       (((s)->s_rev_level == EXT3_GOOD_OLD_REV) ? \
 105                                  EXT3_GOOD_OLD_FIRST_INO : \
 106                                  (s)->s_first_ino)
 107 #endif
 108
 109 /*
 110  * Macro-instructions used to manage fragments
 111  */
 112 #define EXT3_MIN_FRAG_SIZE              1024
 113 #define EXT3_MAX_FRAG_SIZE              4096
 114 #define EXT3_MIN_FRAG_LOG_SIZE            10
 115 #ifdef __KERNEL__
 116 # define EXT3_FRAG_SIZE(s)              (EXT3_SB(s)->s_frag_size)
 117 # define EXT3_FRAGS_PER_BLOCK(s)        (EXT3_SB(s)->s_frags_per_block)
 118 #else
 119 # define EXT3_FRAG_SIZE(s)              (EXT3_MIN_FRAG_SIZE << (s)->s_log_frag_size)
 120 # define EXT3_FRAGS_PER_BLOCK(s)        (EXT3_BLOCK_SIZE(s) / EXT3_FRAG_SIZE(s))
 121 #endif
 122
 123 /*
 124  * Structure of a blocks group descriptor
 125  */
 126 struct ext3_group_desc
 127 {
 128         __le32  bg_block_bitmap;                /* Blocks bitmap block */
 129         __le32  bg_inode_bitmap;                /* Inodes bitmap block */
 130         __le32  bg_inode_table;         /* Inodes table block */
 131         __le16  bg_free_blocks_count;   /* Free blocks count */
 132         __le16  bg_free_inodes_count;   /* Free inodes count */
 133         __le16  bg_used_dirs_count;     /* Directories count */
 134         __u16   bg_pad;
 135         __le32  bg_reserved[3];
 136 };
 137
 138 /*
 139  * Macro-instructions used to manage group descriptors
 140  */
 141 #ifdef __KERNEL__
 142 # define EXT3_BLOCKS_PER_GROUP(s)       (EXT3_SB(s)->s_blocks_per_group)
 143 # define EXT3_DESC_PER_BLOCK(s)         (EXT3_SB(s)->s_desc_per_block)
 144 # define EXT3_INODES_PER_GROUP(s)       (EXT3_SB(s)->s_inodes_per_group)
 145 # define EXT3_DESC_PER_BLOCK_BITS(s)    (EXT3_SB(s)->s_desc_per_block_bits)
 146 #else
 147 # define EXT3_BLOCKS_PER_GROUP(s)       ((s)->s_blocks_per_group)
 148 # define EXT3_DESC_PER_BLOCK(s)         (EXT3_BLOCK_SIZE(s) / sizeof (struct ext3_group_desc))
 149 # define EXT3_INODES_PER_GROUP(s)       ((s)->s_inodes_per_group)
 150 #endif
 151
 152 /*
 153  * Constants relative to the data blocks
 154  */
 155 #define EXT3_NDIR_BLOCKS                12
 156 #define EXT3_IND_BLOCK                  EXT3_NDIR_BLOCKS
 157 #define EXT3_DIND_BLOCK                 (EXT3_IND_BLOCK + 1)
 158 #define EXT3_TIND_BLOCK                 (EXT3_DIND_BLOCK + 1)
 159 #define EXT3_N_BLOCKS                   (EXT3_TIND_BLOCK + 1)
 160
 161 /*
 162  * Inode flags
 163  */
 164 #define EXT3_SECRM_FL                   0x00000001 /* Secure deletion */
 165 #define EXT3_UNRM_FL                    0x00000002 /* Undelete */
 166 #define EXT3_COMPR_FL                   0x00000004 /* Compress file */
 167 #define EXT3_SYNC_FL                    0x00000008 /* Synchronous updates */
 168 #define EXT3_IMMUTABLE_FL               0x00000010 /* Immutable file */
 169 #define EXT3_APPEND_FL                  0x00000020 /* writes to file may only append */
 170 #define EXT3_NODUMP_FL                  0x00000040 /* do not dump file */
 171 #define EXT3_NOATIME_FL                 0x00000080 /* do not update atime */
 172 /* Reserved for compression usage... */
 173 #define EXT3_DIRTY_FL                   0x00000100
 174 #define EXT3_COMPRBLK_FL                0x00000200 /* One or more compressed clusters */
 175 #define EXT3_NOCOMPR_FL                 0x00000400 /* Don't compress */
 176 #define EXT3_ECOMPR_FL                  0x00000800 /* Compression error */
 177 /* End compression flags --- maybe not all used */
 178 #define EXT3_INDEX_FL                   0x00001000 /* hash-indexed directory */
 179 #define EXT3_IMAGIC_FL                  0x00002000 /* AFS directory */
 180 #define EXT3_JOURNAL_DATA_FL            0x00004000 /* file data should be journaled */
 181 #define EXT3_NOTAIL_FL                  0x00008000 /* file tail should not be merged */
 182 #define EXT3_DIRSYNC_FL                 0x00010000 /* dirsync behaviour (directories only) */
 183 #define EXT3_TOPDIR_FL                  0x00020000 /* Top of directory hierarchies*/
 184 #define EXT3_BARRIER_FL                 0x04000000 /* Barrier for chroot() */
 185 #define EXT3_IUNLINK_FL                 0x08000000 /* Immutable unlink */
 186 #define EXT3_RESERVED_FL                0x80000000 /* reserved for ext3 lib */
 187
 188 #ifdef CONFIG_VSERVER_LEGACY
 189 #define EXT3_FL_USER_VISIBLE            0x0803DFFF /* User visible flags */
 190 #define EXT3_FL_USER_MODIFIABLE         0x080380FF /* User modifiable flags */
 191 #else
 192 #define EXT3_FL_USER_VISIBLE            0x0003DFFF /* User visible flags */
 193 #define EXT3_FL_USER_MODIFIABLE         0x000380FF /* User modifiable flags */
 194 #endif
 195 #ifdef  CONFIG_VSERVER_LEGACY
 196 #define EXT3_IOC_SETXID                 FIOC_SETXIDJ
 197 #endif
 198
 199 /*
 200  * Inode dynamic state flags
 201  */
 202 #define EXT3_STATE_JDATA                0x00000001 /* journaled data exists */
 203 #define EXT3_STATE_NEW                  0x00000002 /* inode is newly created */
 204 #define EXT3_STATE_XATTR                0x00000004 /* has in-inode xattrs */
 205
 206 /* Used to pass group descriptor data when online resize is done */
 207 struct ext3_new_group_input {
 208         __u32 group;            /* Group number for this data */
 209         __u32 block_bitmap;     /* Absolute block number of block bitmap */
 210         __u32 inode_bitmap;     /* Absolute block number of inode bitmap */
 211         __u32 inode_table;      /* Absolute block number of inode table start */
 212         __u32 blocks_count;     /* Total number of blocks in this group */
 213         __u16 reserved_blocks;  /* Number of reserved blocks in this group */
 214         __u16 unused;
 215 };
 216
 217 /* The struct ext3_new_group_input in kernel space, with free_blocks_count */
 218 struct ext3_new_group_data {
 219         __u32 group;
 220         __u32 block_bitmap;
 221         __u32 inode_bitmap;
 222         __u32 inode_table;
 223         __u32 blocks_count;
 224         __u16 reserved_blocks;
 225         __u16 unused;
 226         __u32 free_blocks_count;
 227 };
 228
 229
 230 /*
 231  * ioctl commands
 232  */
 233 #define EXT3_IOC_GETFLAGS               _IOR('f', 1, long)
 234 #define EXT3_IOC_SETFLAGS               _IOW('f', 2, long)
 235 #define EXT3_IOC_GETVERSION             _IOR('f', 3, long)
 236 #define EXT3_IOC_SETVERSION             _IOW('f', 4, long)
 237 #define EXT3_IOC_GROUP_EXTEND           _IOW('f', 7, unsigned long)
 238 #define EXT3_IOC_GROUP_ADD              _IOW('f', 8,struct ext3_new_group_input)
 239 #define EXT3_IOC_GETVERSION_OLD         _IOR('v', 1, long)
 240 #define EXT3_IOC_SETVERSION_OLD         _IOW('v', 2, long)
 241 #ifdef CONFIG_JBD_DEBUG
 242 #define EXT3_IOC_WAIT_FOR_READONLY      _IOR('f', 99, long)
 243 #endif
 244 #define EXT3_IOC_GETRSVSZ               _IOR('f', 5, long)
 245 #define EXT3_IOC_SETRSVSZ               _IOW('f', 6, long)
 246
 247 /*
 248  *  Mount options
 249  */
 250 struct ext3_mount_options {
 251         unsigned long s_mount_opt;
 252         uid_t s_resuid;
 253         gid_t s_resgid;
 254         unsigned long s_commit_interval;
 255 #ifdef CONFIG_QUOTA
 256         int s_jquota_fmt;
 257         char *s_qf_names[MAXQUOTAS];
 258 #endif
 259 };
 260
 261 /*
 262  * Structure of an inode on the disk
 263  */
 264 struct ext3_inode {
 265         __le16  i_mode;         /* File mode */
 266         __le16  i_uid;          /* Low 16 bits of Owner Uid */
 267         __le32  i_size;         /* Size in bytes */
 268         __le32  i_atime;        /* Access time */
 269         __le32  i_ctime;        /* Creation time */
 270         __le32  i_mtime;        /* Modification time */
 271         __le32  i_dtime;        /* Deletion Time */
 272         __le16  i_gid;          /* Low 16 bits of Group Id */
 273         __le16  i_links_count;  /* Links count */
 274         __le32  i_blocks;       /* Blocks count */
 275         __le32  i_flags;        /* File flags */
 276         union {
 277                 struct {
 278                         __u32  l_i_reserved1;
 279                 } linux1;
 280                 struct {
 281                         __u32  h_i_translator;
 282                 } hurd1;
 283                 struct {
 284                         __u32  m_i_reserved1;
 285                 } masix1;
 286         } osd1;                         /* OS dependent 1 */
 287         __le32  i_block[EXT3_N_BLOCKS];/* Pointers to blocks */
 288         __le32  i_generation;   /* File version (for NFS) */
 289         __le32  i_file_acl;     /* File ACL */
 290         __le32  i_dir_acl;      /* Directory ACL */
 291         __le32  i_faddr;        /* Fragment address */
 292         union {
 293                 struct {
 294                         __u8    l_i_frag;       /* Fragment number */
 295                         __u8    l_i_fsize;      /* Fragment size */
 296                         __u16   l_i_xid;        /* LRU Context */
 297                         __le16  l_i_uid_high;   /* these 2 fields    */
 298                         __le16  l_i_gid_high;   /* were reserved2[0] */
 299                         __u32   l_i_reserved2;
 300                 } linux2;
 301                 struct {
 302                         __u8    h_i_frag;       /* Fragment number */
 303                         __u8    h_i_fsize;      /* Fragment size */
 304                         __u16   h_i_mode_high;
 305                         __u16   h_i_uid_high;
 306                         __u16   h_i_gid_high;
 307                         __u32   h_i_author;
 308                 } hurd2;
 309                 struct {
 310                         __u8    m_i_frag;       /* Fragment number */
 311                         __u8    m_i_fsize;      /* Fragment size */
 312                         __u16   m_pad1;
 313                         __u32   m_i_reserved2[2];
 314                 } masix2;
 315         } osd2;                         /* OS dependent 2 */
 316         __le16  i_extra_isize;
 317         __le16  i_pad1;
 318 };
 319
 320 #define i_size_high     i_dir_acl
 321
 322 #if defined(__KERNEL__) || defined(__linux__)
 323 #define i_reserved1     osd1.linux1.l_i_reserved1
 324 #define i_frag          osd2.linux2.l_i_frag
 325 #define i_fsize         osd2.linux2.l_i_fsize
 326 #define i_uid_low       i_uid
 327 #define i_gid_low       i_gid
 328 #define i_uid_high      osd2.linux2.l_i_uid_high
 329 #define i_gid_high      osd2.linux2.l_i_gid_high
 330 #define i_raw_xid       osd2.linux2.l_i_xid
 331 #define i_reserved2     osd2.linux2.l_i_reserved2
 332
 333 #elif defined(__GNU__)
 334
 335 #define i_translator    osd1.hurd1.h_i_translator
 336 #define i_frag          osd2.hurd2.h_i_frag;
 337 #define i_fsize         osd2.hurd2.h_i_fsize;
 338 #define i_uid_high      osd2.hurd2.h_i_uid_high
 339 #define i_gid_high      osd2.hurd2.h_i_gid_high
 340 #define i_author        osd2.hurd2.h_i_author
 341
 342 #elif defined(__masix__)
 343
 344 #define i_reserved1     osd1.masix1.m_i_reserved1
 345 #define i_frag          osd2.masix2.m_i_frag
 346 #define i_fsize         osd2.masix2.m_i_fsize
 347 #define i_reserved2     osd2.masix2.m_i_reserved2
 348
 349 #endif /* defined(__KERNEL__) || defined(__linux__) */
 350
 351 /*
 352  * File system states
 353  */
 354 #define EXT3_VALID_FS                   0x0001  /* Unmounted cleanly */
 355 #define EXT3_ERROR_FS                   0x0002  /* Errors detected */
 356 #define EXT3_ORPHAN_FS                  0x0004  /* Orphans being recovered */
 357
 358 /*
 359  * Mount flags
 360  */
 361 #define EXT3_MOUNT_CHECK                0x00001 /* Do mount-time checks */
 362 #define EXT3_MOUNT_OLDALLOC             0x00002  /* Don't use the new Orlov allocator */
 363 #define EXT3_MOUNT_GRPID                0x00004 /* Create files with directory's group */
 364 #define EXT3_MOUNT_DEBUG                0x00008 /* Some debugging messages */
 365 #define EXT3_MOUNT_ERRORS_CONT          0x00010 /* Continue on errors */
 366 #define EXT3_MOUNT_ERRORS_RO            0x00020 /* Remount fs ro on errors */
 367 #define EXT3_MOUNT_ERRORS_PANIC         0x00040 /* Panic on errors */
 368 #define EXT3_MOUNT_MINIX_DF             0x00080 /* Mimics the Minix statfs */
 369 #define EXT3_MOUNT_NOLOAD               0x00100 /* Don't use existing journal*/
 370 #define EXT3_MOUNT_ABORT                0x00200 /* Fatal error detected */
 371 #define EXT3_MOUNT_DATA_FLAGS           0x00C00 /* Mode for data writes: */
 372 #define EXT3_MOUNT_JOURNAL_DATA         0x00400 /* Write data to journal */
 373 #define EXT3_MOUNT_ORDERED_DATA         0x00800 /* Flush data before commit */
 374 #define EXT3_MOUNT_WRITEBACK_DATA       0x00C00 /* No data ordering */
 375 #define EXT3_MOUNT_UPDATE_JOURNAL       0x01000 /* Update the journal format */
 376 #define EXT3_MOUNT_NO_UID32             0x02000  /* Disable 32-bit UIDs */
 377 #define EXT3_MOUNT_XATTR_USER           0x04000 /* Extended user attributes */
 378 #define EXT3_MOUNT_POSIX_ACL            0x08000 /* POSIX Access Control Lists */
 379 #define EXT3_MOUNT_RESERVATION          0x10000 /* Preallocation */
 380 #define EXT3_MOUNT_BARRIER              0x20000 /* Use block barriers */
 381 #define EXT3_MOUNT_NOBH                 0x40000 /* No bufferheads */
 382 #define EXT3_MOUNT_QUOTA                0x80000 /* Some quota option set */
 383 #define EXT3_MOUNT_USRQUOTA             0x100000 /* "old" user quota */
 384 #define EXT3_MOUNT_GRPQUOTA             0x200000 /* "old" group quota */
 385 #define EXT3_MOUNT_TAGXID               (1<<24) /* Enable Context Tags */
 386
 387 /* Compatibility, for having both ext2_fs.h and ext3_fs.h included at once */
 388 #ifndef _LINUX_EXT2_FS_H
 389 #define clear_opt(o, opt)               o &= ~EXT3_MOUNT_##opt
 390 #define set_opt(o, opt)                 o |= EXT3_MOUNT_##opt
 391 #define test_opt(sb, opt)               (EXT3_SB(sb)->s_mount_opt & \
 392                                          EXT3_MOUNT_##opt)
 393 #else
 394 #define EXT2_MOUNT_NOLOAD               EXT3_MOUNT_NOLOAD
 395 #define EXT2_MOUNT_ABORT                EXT3_MOUNT_ABORT
 396 #define EXT2_MOUNT_DATA_FLAGS           EXT3_MOUNT_DATA_FLAGS
 397 #endif
 398
 399 #define ext3_set_bit                    ext2_set_bit
 400 #define ext3_set_bit_atomic             ext2_set_bit_atomic
 401 #define ext3_clear_bit                  ext2_clear_bit
 402 #define ext3_clear_bit_atomic           ext2_clear_bit_atomic
 403 #define ext3_test_bit                   ext2_test_bit
 404 #define ext3_find_first_zero_bit        ext2_find_first_zero_bit
 405 #define ext3_find_next_zero_bit         ext2_find_next_zero_bit
 406
 407 /*
 408  * Maximal mount counts between two filesystem checks
 409  */
 410 #define EXT3_DFL_MAX_MNT_COUNT          20      /* Allow 20 mounts */
 411 #define EXT3_DFL_CHECKINTERVAL          0       /* Don't use interval check */
 412
 413 /*
 414  * Behaviour when detecting errors
 415  */
 416 #define EXT3_ERRORS_CONTINUE            1       /* Continue execution */
 417 #define EXT3_ERRORS_RO                  2       /* Remount fs read-only */
 418 #define EXT3_ERRORS_PANIC               3       /* Panic */
 419 #define EXT3_ERRORS_DEFAULT             EXT3_ERRORS_CONTINUE
 420
 421 /*
 422  * Structure of the super block
 423  */
 424 struct ext3_super_block {
 425 /*00*/  __le32  s_inodes_count;         /* Inodes count */
 426         __le32  s_blocks_count;         /* Blocks count */
 427         __le32  s_r_blocks_count;       /* Reserved blocks count */
 428         __le32  s_free_blocks_count;    /* Free blocks count */
 429 /*10*/  __le32  s_free_inodes_count;    /* Free inodes count */
 430         __le32  s_first_data_block;     /* First Data Block */
 431         __le32  s_log_block_size;       /* Block size */
 432         __le32  s_log_frag_size;        /* Fragment size */
 433 /*20*/  __le32  s_blocks_per_group;     /* # Blocks per group */
 434         __le32  s_frags_per_group;      /* # Fragments per group */
 435         __le32  s_inodes_per_group;     /* # Inodes per group */
 436         __le32  s_mtime;                /* Mount time */
 437 /*30*/  __le32  s_wtime;                /* Write time */
 438         __le16  s_mnt_count;            /* Mount count */
 439         __le16  s_max_mnt_count;        /* Maximal mount count */
 440         __le16  s_magic;                /* Magic signature */
 441         __le16  s_state;                /* File system state */
 442         __le16  s_errors;               /* Behaviour when detecting errors */
 443         __le16  s_minor_rev_level;      /* minor revision level */
 444 /*40*/  __le32  s_lastcheck;            /* time of last check */
 445         __le32  s_checkinterval;        /* max. time between checks */
 446         __le32  s_creator_os;           /* OS */
 447         __le32  s_rev_level;            /* Revision level */
 448 /*50*/  __le16  s_def_resuid;           /* Default uid for reserved blocks */
 449         __le16  s_def_resgid;           /* Default gid for reserved blocks */
 450         /*
 451          * These fields are for EXT3_DYNAMIC_REV superblocks only.
 452          *
 453          * Note: the difference between the compatible feature set and
 454          * the incompatible feature set is that if there is a bit set
 455          * in the incompatible feature set that the kernel doesn't
 456          * know about, it should refuse to mount the filesystem.
 457          *
 458          * e2fsck's requirements are more strict; if it doesn't know
 459          * about a feature in either the compatible or incompatible
 460          * feature set, it must abort and not try to meddle with
 461          * things it doesn't understand...
 462          */
 463         __le32  s_first_ino;            /* First non-reserved inode */
 464         __le16   s_inode_size;          /* size of inode structure */
 465         __le16  s_block_group_nr;       /* block group # of this superblock */
 466         __le32  s_feature_compat;       /* compatible feature set */
 467 /*60*/  __le32  s_feature_incompat;     /* incompatible feature set */
 468         __le32  s_feature_ro_compat;    /* readonly-compatible feature set */
 469 /*68*/  __u8    s_uuid[16];             /* 128-bit uuid for volume */
 470 /*78*/  char    s_volume_name[16];      /* volume name */
 471 /*88*/  char    s_last_mounted[64];     /* directory where last mounted */
 472 /*C8*/  __le32  s_algorithm_usage_bitmap; /* For compression */
 473         /*
 474          * Performance hints.  Directory preallocation should only
 475          * happen if the EXT3_FEATURE_COMPAT_DIR_PREALLOC flag is on.
 476          */
 477         __u8    s_prealloc_blocks;      /* Nr of blocks to try to preallocate*/
 478         __u8    s_prealloc_dir_blocks;  /* Nr to preallocate for dirs */
 479         __u16   s_reserved_gdt_blocks;  /* Per group desc for online growth */
 480         /*
 481          * Journaling support valid if EXT3_FEATURE_COMPAT_HAS_JOURNAL set.
 482          */
 483 /*D0*/  __u8    s_journal_uuid[16];     /* uuid of journal superblock */
 484 /*E0*/  __le32  s_journal_inum;         /* inode number of journal file */
 485         __le32  s_journal_dev;          /* device number of journal file */
 486         __le32  s_last_orphan;          /* start of list of inodes to delete */
 487         __le32  s_hash_seed[4];         /* HTREE hash seed */
 488         __u8    s_def_hash_version;     /* Default hash version to use */
 489         __u8    s_reserved_char_pad;
 490         __u16   s_reserved_word_pad;
 491         __le32  s_default_mount_opts;
 492         __le32  s_first_meta_bg;        /* First metablock block group */
 493         __u32   s_reserved[190];        /* Padding to the end of the block */
 494 };
 495
 496 #ifdef __KERNEL__
 497 #include <linux/ext3_fs_i.h>
 498 #include <linux/ext3_fs_sb.h>
 499 static inline struct ext3_sb_info * EXT3_SB(struct super_block *sb)
 500 {
 501         return sb->s_fs_info;
 502 }
 503 static inline struct ext3_inode_info *EXT3_I(struct inode *inode)
 504 {
 505         return container_of(inode, struct ext3_inode_info, vfs_inode);
 506 }
 507
 508 static inline int ext3_valid_inum(struct super_block *sb, unsigned long ino)
 509 {
 510         return ino == EXT3_ROOT_INO ||
 511                 ino == EXT3_JOURNAL_INO ||
 512                 ino == EXT3_RESIZE_INO ||
 513                 (ino >= EXT3_FIRST_INO(sb) &&
 514                  ino <= le32_to_cpu(EXT3_SB(sb)->s_es->s_inodes_count));
 515 }
 516 #else
 517 /* Assume that user mode programs are passing in an ext3fs superblock, not
 518  * a kernel struct super_block.  This will allow us to call the feature-test
 519  * macros from user land. */
 520 #define EXT3_SB(sb)     (sb)
 521 #endif
 522
 523 #define NEXT_ORPHAN(inode) EXT3_I(inode)->i_dtime
 524
 525 /*
 526  * Codes for operating systems
 527  */
 528 #define EXT3_OS_LINUX           0
 529 #define EXT3_OS_HURD            1
 530 #define EXT3_OS_MASIX           2
 531 #define EXT3_OS_FREEBSD         3
 532 #define EXT3_OS_LITES           4
 533
 534 /*
 535  * Revision levels
 536  */
 537 #define EXT3_GOOD_OLD_REV       0       /* The good old (original) format */
 538 #define EXT3_DYNAMIC_REV        1       /* V2 format w/ dynamic inode sizes */
 539
 540 #define EXT3_CURRENT_REV        EXT3_GOOD_OLD_REV
 541 #define EXT3_MAX_SUPP_REV       EXT3_DYNAMIC_REV
 542
 543 #define EXT3_GOOD_OLD_INODE_SIZE 128
 544
 545 /*
 546  * Feature set definitions
 547  */
 548
 549 #define EXT3_HAS_COMPAT_FEATURE(sb,mask)                        \
 550         ( EXT3_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
 551 #define EXT3_HAS_RO_COMPAT_FEATURE(sb,mask)                     \
 552         ( EXT3_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
 553 #define EXT3_HAS_INCOMPAT_FEATURE(sb,mask)                      \
 554         ( EXT3_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
 555 #define EXT3_SET_COMPAT_FEATURE(sb,mask)                        \
 556         EXT3_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
 557 #define EXT3_SET_RO_COMPAT_FEATURE(sb,mask)                     \
 558         EXT3_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
 559 #define EXT3_SET_INCOMPAT_FEATURE(sb,mask)                      \
 560         EXT3_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
 561 #define EXT3_CLEAR_COMPAT_FEATURE(sb,mask)                      \
 562         EXT3_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
 563 #define EXT3_CLEAR_RO_COMPAT_FEATURE(sb,mask)                   \
 564         EXT3_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
 565 #define EXT3_CLEAR_INCOMPAT_FEATURE(sb,mask)                    \
 566         EXT3_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
 567
 568 #define EXT3_FEATURE_COMPAT_DIR_PREALLOC        0x0001
 569 #define EXT3_FEATURE_COMPAT_IMAGIC_INODES       0x0002
 570 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL         0x0004
 571 #define EXT3_FEATURE_COMPAT_EXT_ATTR            0x0008
 572 #define EXT3_FEATURE_COMPAT_RESIZE_INODE        0x0010
 573 #define EXT3_FEATURE_COMPAT_DIR_INDEX           0x0020
 574
 575 #define EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER     0x0001
 576 #define EXT3_FEATURE_RO_COMPAT_LARGE_FILE       0x0002
 577 #define EXT3_FEATURE_RO_COMPAT_BTREE_DIR        0x0004
 578
 579 #define EXT3_FEATURE_INCOMPAT_COMPRESSION       0x0001
 580 #define EXT3_FEATURE_INCOMPAT_FILETYPE          0x0002
 581 #define EXT3_FEATURE_INCOMPAT_RECOVER           0x0004 /* Needs recovery */
 582 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV       0x0008 /* Journal device */
 583 #define EXT3_FEATURE_INCOMPAT_META_BG           0x0010
 584
 585 #define EXT3_FEATURE_COMPAT_SUPP        EXT2_FEATURE_COMPAT_EXT_ATTR
 586 #define EXT3_FEATURE_INCOMPAT_SUPP      (EXT3_FEATURE_INCOMPAT_FILETYPE| \
 587                                          EXT3_FEATURE_INCOMPAT_RECOVER| \
 588                                          EXT3_FEATURE_INCOMPAT_META_BG)
 589 #define EXT3_FEATURE_RO_COMPAT_SUPP     (EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER| \
 590                                          EXT3_FEATURE_RO_COMPAT_LARGE_FILE| \
 591                                          EXT3_FEATURE_RO_COMPAT_BTREE_DIR)
 592
 593 /*
 594  * Default values for user and/or group using reserved blocks
 595  */
 596 #define EXT3_DEF_RESUID         0
 597 #define EXT3_DEF_RESGID         0
 598
 599 /*
 600  * Default mount options
 601  */
 602 #define EXT3_DEFM_DEBUG         0x0001
 603 #define EXT3_DEFM_BSDGROUPS     0x0002
 604 #define EXT3_DEFM_XATTR_USER    0x0004
 605 #define EXT3_DEFM_ACL           0x0008
 606 #define EXT3_DEFM_UID16         0x0010
 607 #define EXT3_DEFM_JMODE         0x0060
 608 #define EXT3_DEFM_JMODE_DATA    0x0020
 609 #define EXT3_DEFM_JMODE_ORDERED 0x0040
 610 #define EXT3_DEFM_JMODE_WBACK   0x0060
 611
 612 /*
 613  * Structure of a directory entry
 614  */
 615 #define EXT3_NAME_LEN 255
 616
 617 struct ext3_dir_entry {
 618         __le32  inode;                  /* Inode number */
 619         __le16  rec_len;                /* Directory entry length */
 620         __le16  name_len;               /* Name length */
 621         char    name[EXT3_NAME_LEN];    /* File name */
 622 };
 623
 624 /*
 625  * The new version of the directory entry.  Since EXT3 structures are
 626  * stored in intel byte order, and the name_len field could never be
 627  * bigger than 255 chars, it's safe to reclaim the extra byte for the
 628  * file_type field.
 629  */
 630 struct ext3_dir_entry_2 {
 631         __le32  inode;                  /* Inode number */
 632         __le16  rec_len;                /* Directory entry length */
 633         __u8    name_len;               /* Name length */
 634         __u8    file_type;
 635         char    name[EXT3_NAME_LEN];    /* File name */
 636 };
 637
 638 /*
 639  * Ext3 directory file types.  Only the low 3 bits are used.  The
 640  * other bits are reserved for now.
 641  */
 642 #define EXT3_FT_UNKNOWN         0
 643 #define EXT3_FT_REG_FILE        1
 644 #define EXT3_FT_DIR             2
 645 #define EXT3_FT_CHRDEV          3
 646 #define EXT3_FT_BLKDEV          4
 647 #define EXT3_FT_FIFO            5
 648 #define EXT3_FT_SOCK            6
 649 #define EXT3_FT_SYMLINK         7
 650
 651 #define EXT3_FT_MAX             8
 652
 653 /*
 654  * EXT3_DIR_PAD defines the directory entries boundaries
 655  *
 656  * NOTE: It must be a multiple of 4
 657  */
 658 #define EXT3_DIR_PAD                    4
 659 #define EXT3_DIR_ROUND                  (EXT3_DIR_PAD - 1)
 660 #define EXT3_DIR_REC_LEN(name_len)      (((name_len) + 8 + EXT3_DIR_ROUND) & \
 661                                          ~EXT3_DIR_ROUND)
 662 /*
 663  * Hash Tree Directory indexing
 664  * (c) Daniel Phillips, 2001
 665  */
 666
 667 #ifdef CONFIG_EXT3_INDEX
 668   #define is_dx(dir) (EXT3_HAS_COMPAT_FEATURE(dir->i_sb, \
 669                                               EXT3_FEATURE_COMPAT_DIR_INDEX) && \
 670                       (EXT3_I(dir)->i_flags & EXT3_INDEX_FL))
 671 #define EXT3_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT3_LINK_MAX)
 672 #define EXT3_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
 673 #else
 674   #define is_dx(dir) 0
 675 #define EXT3_DIR_LINK_MAX(dir) ((dir)->i_nlink >= EXT3_LINK_MAX)
 676 #define EXT3_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2)
 677 #endif
 678
 679 /* Legal values for the dx_root hash_version field: */
 680
 681 #define DX_HASH_LEGACY          0
 682 #define DX_HASH_HALF_MD4        1
 683 #define DX_HASH_TEA             2
 684
 685 #ifdef __KERNEL__
 686
 687 /* hash info structure used by the directory hash */
 688 struct dx_hash_info
 689 {
 690         u32             hash;
 691         u32             minor_hash;
 692         int             hash_version;
 693         u32             *seed;
 694 };
 695
 696 #define EXT3_HTREE_EOF  0x7fffffff
 697
 698 /*
 699  * Control parameters used by ext3_htree_next_block
 700  */
 701 #define HASH_NB_ALWAYS          1
 702
 703
 704 /*
 705  * Describe an inode's exact location on disk and in memory
 706  */
 707 struct ext3_iloc
 708 {
 709         struct buffer_head *bh;
 710         unsigned long offset;
 711         unsigned long block_group;
 712 };
 713
 714 static inline struct ext3_inode *ext3_raw_inode(struct ext3_iloc *iloc)
 715 {
 716         return (struct ext3_inode *) (iloc->bh->b_data + iloc->offset);
 717 }
 718
 719 /*
 720  * This structure is stuffed into the struct file's private_data field
 721  * for directories.  It is where we put information so that we can do
 722  * readdir operations in hash tree order.
 723  */
 724 struct dir_private_info {
 725         struct rb_root  root;
 726         struct rb_node  *curr_node;
 727         struct fname    *extra_fname;
 728         loff_t          last_pos;
 729         __u32           curr_hash;
 730         __u32           curr_minor_hash;
 731         __u32           next_hash;
 732 };
 733
 734 /* calculate the first block number of the group */
 735 static inline ext3_fsblk_t
 736 ext3_group_first_block_no(struct super_block *sb, unsigned long group_no)
 737 {
 738         return group_no * (ext3_fsblk_t)EXT3_BLOCKS_PER_GROUP(sb) +
 739                 le32_to_cpu(EXT3_SB(sb)->s_es->s_first_data_block);
 740 }
 741
 742 /*
 743  * Special error return code only used by dx_probe() and its callers.
 744  */
 745 #define ERR_BAD_DX_DIR  -75000
 746
 747 /*
 748  * Function prototypes
 749  */
 750
 751 /*
 752  * Ok, these declarations are also in <linux/kernel.h> but none of the
 753  * ext3 source programs needs to include it so they are duplicated here.
 754  */
 755 # define NORET_TYPE    /**/
 756 # define ATTRIB_NORET  __attribute__((noreturn))
 757 # define NORET_AND     noreturn,
 758
 759 /* balloc.c */
 760 extern int ext3_bg_has_super(struct super_block *sb, int group);
 761 extern unsigned long ext3_bg_num_gdb(struct super_block *sb, int group);
 762 extern ext3_fsblk_t ext3_new_block (handle_t *handle, struct inode *inode,
 763                         ext3_fsblk_t goal, int *errp);
 764 extern ext3_fsblk_t ext3_new_blocks (handle_t *handle, struct inode *inode,
 765                         ext3_fsblk_t goal, unsigned long *count, int *errp);
 766 extern void ext3_free_blocks (handle_t *handle, struct inode *inode,
 767                         ext3_fsblk_t block, unsigned long count);
 768 extern void ext3_free_blocks_sb (handle_t *handle, struct super_block *sb,
 769                                  ext3_fsblk_t block, unsigned long count,
 770                                 unsigned long *pdquot_freed_blocks);
 771 extern ext3_fsblk_t ext3_count_free_blocks (struct super_block *);
 772 extern void ext3_check_blocks_bitmap (struct super_block *);
 773 extern struct ext3_group_desc * ext3_get_group_desc(struct super_block * sb,
 774                                                     unsigned int block_group,
 775                                                     struct buffer_head ** bh);
 776 extern int ext3_should_retry_alloc(struct super_block *sb, int *retries);
 777 extern void ext3_init_block_alloc_info(struct inode *);
 778 extern void ext3_rsv_window_add(struct super_block *sb, struct ext3_reserve_window_node *rsv);
 779
 780 /* dir.c */
 781 extern int ext3_check_dir_entry(const char *, struct inode *,
 782                                 struct ext3_dir_entry_2 *,
 783                                 struct buffer_head *, unsigned long);
 784 extern int ext3_htree_store_dirent(struct file *dir_file, __u32 hash,
 785                                     __u32 minor_hash,
 786                                     struct ext3_dir_entry_2 *dirent);
 787 extern void ext3_htree_free_dir_info(struct dir_private_info *p);
 788
 789 /* fsync.c */
 790 extern int ext3_sync_file (struct file *, struct dentry *, int);
 791
 792 /* hash.c */
 793 extern int ext3fs_dirhash(const char *name, int len, struct
 794                           dx_hash_info *hinfo);
 795
 796 /* ialloc.c */
 797 extern struct inode * ext3_new_inode (handle_t *, struct inode *, int);
 798 extern void ext3_free_inode (handle_t *, struct inode *);
 799 extern struct inode * ext3_orphan_get (struct super_block *, unsigned long);
 800 extern unsigned long ext3_count_free_inodes (struct super_block *);
 801 extern unsigned long ext3_count_dirs (struct super_block *);
 802 extern void ext3_check_inodes_bitmap (struct super_block *);
 803 extern unsigned long ext3_count_free (struct buffer_head *, unsigned);
 804
 805
 806 /* inode.c */
 807 int ext3_forget(handle_t *handle, int is_metadata, struct inode *inode,
 808                 struct buffer_head *bh, ext3_fsblk_t blocknr);
 809 struct buffer_head * ext3_getblk (handle_t *, struct inode *, long, int, int *);
 810 struct buffer_head * ext3_bread (handle_t *, struct inode *, int, int, int *);
 811 int ext3_get_blocks_handle(handle_t *handle, struct inode *inode,
 812         sector_t iblock, unsigned long maxblocks, struct buffer_head *bh_result,
 813         int create, int extend_disksize);
 814 extern int ext3_sync_flags(struct inode *inode);
 815
 816 extern void ext3_read_inode (struct inode *);
 817 extern int  ext3_write_inode (struct inode *, int);
 818 extern int  ext3_setattr (struct dentry *, struct iattr *);
 819 extern void ext3_delete_inode (struct inode *);
 820 extern int  ext3_sync_inode (handle_t *, struct inode *);
 821 extern void ext3_discard_reservation (struct inode *);
 822 extern void ext3_dirty_inode(struct inode *);
 823 extern int ext3_change_inode_journal_flag(struct inode *, int);
 824 extern int ext3_get_inode_loc(struct inode *, struct ext3_iloc *);
 825 extern void ext3_truncate (struct inode *);
 826 extern void ext3_set_inode_flags(struct inode *);
 827 extern void ext3_set_aops(struct inode *inode);
 828
 829 /* ioctl.c */
 830 extern int ext3_ioctl (struct inode *, struct file *, unsigned int,
 831                        unsigned long);
 832
 833 /* namei.c */
 834 extern int ext3_orphan_add(handle_t *, struct inode *);
 835 extern int ext3_orphan_del(handle_t *, struct inode *);
 836 extern int ext3_htree_fill_tree(struct file *dir_file, __u32 start_hash,
 837                                 __u32 start_minor_hash, __u32 *next_hash);
 838
 839 /* resize.c */
 840 extern int ext3_group_add(struct super_block *sb,
 841                                 struct ext3_new_group_data *input);
 842 extern int ext3_group_extend(struct super_block *sb,
 843                                 struct ext3_super_block *es,
 844                                 ext3_fsblk_t n_blocks_count);
 845
 846 /* super.c */
 847 extern void ext3_error (struct super_block *, const char *, const char *, ...)
 848         __attribute__ ((format (printf, 3, 4)));
 849 extern void __ext3_std_error (struct super_block *, const char *, int);
 850 extern void ext3_abort (struct super_block *, const char *, const char *, ...)
 851         __attribute__ ((format (printf, 3, 4)));
 852 extern void ext3_warning (struct super_block *, const char *, const char *, ...)
 853         __attribute__ ((format (printf, 3, 4)));
 854 extern void ext3_update_dynamic_rev (struct super_block *sb);
 855
 856 #define ext3_std_error(sb, errno)                               \
 857 do {                                                            \
 858         if ((errno))                                            \
 859                 __ext3_std_error((sb), __FUNCTION__, (errno));  \
 860 } while (0)
 861
 862 /*
 863  * Inodes and files operations
 864  */
 865
 866 /* dir.c */
 867 extern const struct file_operations ext3_dir_operations;
 868
 869 /* file.c */
 870 extern struct inode_operations ext3_file_inode_operations;
 871 extern const struct file_operations ext3_file_operations;
 872
 873 /* namei.c */
 874 extern struct inode_operations ext3_dir_inode_operations;
 875 extern struct inode_operations ext3_special_inode_operations;
 876
 877 /* symlink.c */
 878 extern struct inode_operations ext3_symlink_inode_operations;
 879 extern struct inode_operations ext3_fast_symlink_inode_operations;
 880
 881
 882 #endif  /* __KERNEL__ */
 883
 884 #endif  /* _LINUX_EXT3_FS_H */