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