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