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