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