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