include/linux/ext3_fs.h

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