LXR linux/include/linux/ext3

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