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