SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/ext4/ext4.h

   1 /*
   2  *  ext4.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 _EXT4_H
  17 #define _EXT4_H
  18
  19 #include <linux/types.h>
  20 #include <linux/blkdev.h>
  21 #include <linux/magic.h>
  22 #include <linux/jbd2.h>
  23 #include <linux/quota.h>
  24 #include "ext4_i.h"
  25
  26 /*
  27  * The fourth extended filesystem constants/structures
  28  */
  29
  30 /*
  31  * Define EXT4FS_DEBUG to produce debug messages
  32  */
  33 #undef EXT4FS_DEBUG
  34
  35 /*
  36  * Debug code
  37  */
  38 #ifdef EXT4FS_DEBUG
  39 #define ext4_debug(f, a...)                                             \
  40         do {                                                            \
  41                 printk(KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:",        \
  42                         __FILE__, __LINE__, __func__);                  \
  43                 printk(KERN_DEBUG f, ## a);                             \
  44         } while (0)
  45 #else
  46 #define ext4_debug(f, a...)     do {} while (0)
  47 #endif
  48
  49 /* prefer goal again. length */
  50 #define EXT4_MB_HINT_MERGE              1
  51 /* blocks already reserved */
  52 #define EXT4_MB_HINT_RESERVED           2
  53 /* metadata is being allocated */
  54 #define EXT4_MB_HINT_METADATA           4
  55 /* first blocks in the file */
  56 #define EXT4_MB_HINT_FIRST              8
  57 /* search for the best chunk */
  58 #define EXT4_MB_HINT_BEST               16
  59 /* data is being allocated */
  60 #define EXT4_MB_HINT_DATA               32
  61 /* don't preallocate (for tails) */
  62 #define EXT4_MB_HINT_NOPREALLOC         64
  63 /* allocate for locality group */
  64 #define EXT4_MB_HINT_GROUP_ALLOC        128
  65 /* allocate goal blocks or none */
  66 #define EXT4_MB_HINT_GOAL_ONLY          256
  67 /* goal is meaningful */
  68 #define EXT4_MB_HINT_TRY_GOAL           512
  69 /* blocks already pre-reserved by delayed allocation */
  70 #define EXT4_MB_DELALLOC_RESERVED      1024
  71
  72
  73 struct ext4_allocation_request {
  74         /* target inode for block we're allocating */
  75         struct inode *inode;
  76         /* logical block in target inode */
  77         ext4_lblk_t logical;
  78         /* phys. target (a hint) */
  79         ext4_fsblk_t goal;
  80         /* the closest logical allocated block to the left */
  81         ext4_lblk_t lleft;
  82         /* phys. block for ^^^ */
  83         ext4_fsblk_t pleft;
  84         /* the closest logical allocated block to the right */
  85         ext4_lblk_t lright;
  86         /* phys. block for ^^^ */
  87         ext4_fsblk_t pright;
  88         /* how many blocks we want to allocate */
  89         unsigned int len;
  90         /* flags. see above EXT4_MB_HINT_* */
  91         unsigned int flags;
  92 };
  93
  94 /*
  95  * Special inodes numbers
  96  */
  97 #define EXT4_BAD_INO             1      /* Bad blocks inode */
  98 #define EXT4_ROOT_INO            2      /* Root inode */
  99 #define EXT4_BOOT_LOADER_INO     5      /* Boot loader inode */
 100 #define EXT4_UNDEL_DIR_INO       6      /* Undelete directory inode */
 101 #define EXT4_RESIZE_INO          7      /* Reserved group descriptors inode */
 102 #define EXT4_JOURNAL_INO         8      /* Journal inode */
 103
 104 /* First non-reserved inode for old ext4 filesystems */
 105 #define EXT4_GOOD_OLD_FIRST_INO 11
 106
 107 /*
 108  * Maximal count of links to a file
 109  */
 110 #define EXT4_LINK_MAX           65000
 111
 112 /*
 113  * Macro-instructions used to manage several block sizes
 114  */
 115 #define EXT4_MIN_BLOCK_SIZE             1024
 116 #define EXT4_MAX_BLOCK_SIZE             65536
 117 #define EXT4_MIN_BLOCK_LOG_SIZE         10
 118 #ifdef __KERNEL__
 119 # define EXT4_BLOCK_SIZE(s)             ((s)->s_blocksize)
 120 #else
 121 # define EXT4_BLOCK_SIZE(s)             (EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
 122 #endif
 123 #define EXT4_ADDR_PER_BLOCK(s)          (EXT4_BLOCK_SIZE(s) / sizeof(__u32))
 124 #ifdef __KERNEL__
 125 # define EXT4_BLOCK_SIZE_BITS(s)        ((s)->s_blocksize_bits)
 126 #else
 127 # define EXT4_BLOCK_SIZE_BITS(s)        ((s)->s_log_block_size + 10)
 128 #endif
 129 #ifdef __KERNEL__
 130 #define EXT4_ADDR_PER_BLOCK_BITS(s)     (EXT4_SB(s)->s_addr_per_block_bits)
 131 #define EXT4_INODE_SIZE(s)              (EXT4_SB(s)->s_inode_size)
 132 #define EXT4_FIRST_INO(s)               (EXT4_SB(s)->s_first_ino)
 133 #else
 134 #define EXT4_INODE_SIZE(s)      (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
 135                                  EXT4_GOOD_OLD_INODE_SIZE : \
 136                                  (s)->s_inode_size)
 137 #define EXT4_FIRST_INO(s)       (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
 138                                  EXT4_GOOD_OLD_FIRST_INO : \
 139                                  (s)->s_first_ino)
 140 #endif
 141 #define EXT4_BLOCK_ALIGN(size, blkbits)         ALIGN((size), (1 << (blkbits)))
 142
 143 /*
 144  * Structure of a blocks group descriptor
 145  */
 146 struct ext4_group_desc
 147 {
 148         __le32  bg_block_bitmap_lo;     /* Blocks bitmap block */
 149         __le32  bg_inode_bitmap_lo;     /* Inodes bitmap block */
 150         __le32  bg_inode_table_lo;      /* Inodes table block */
 151         __le16  bg_free_blocks_count_lo;/* Free blocks count */
 152         __le16  bg_free_inodes_count_lo;/* Free inodes count */
 153         __le16  bg_used_dirs_count_lo;  /* Directories count */
 154         __le16  bg_flags;               /* EXT4_BG_flags (INODE_UNINIT, etc) */
 155         __u32   bg_reserved[2];         /* Likely block/inode bitmap checksum */
 156         __le16  bg_itable_unused_lo;    /* Unused inodes count */
 157         __le16  bg_checksum;            /* crc16(sb_uuid+group+desc) */
 158         __le32  bg_block_bitmap_hi;     /* Blocks bitmap block MSB */
 159         __le32  bg_inode_bitmap_hi;     /* Inodes bitmap block MSB */
 160         __le32  bg_inode_table_hi;      /* Inodes table block MSB */
 161         __le16  bg_free_blocks_count_hi;/* Free blocks count MSB */
 162         __le16  bg_free_inodes_count_hi;/* Free inodes count MSB */
 163         __le16  bg_used_dirs_count_hi;  /* Directories count MSB */
 164         __le16  bg_itable_unused_hi;    /* Unused inodes count MSB */
 165         __u32   bg_reserved2[3];
 166 };
 167
 168 /*
 169  * Structure of a flex block group info
 170  */
 171
 172 struct flex_groups {
 173         __u32 free_inodes;
 174         __u32 free_blocks;
 175 };
 176
 177 #define EXT4_BG_INODE_UNINIT    0x0001 /* Inode table/bitmap not in use */
 178 #define EXT4_BG_BLOCK_UNINIT    0x0002 /* Block bitmap not in use */
 179 #define EXT4_BG_INODE_ZEROED    0x0004 /* On-disk itable initialized to zero */
 180
 181 #ifdef __KERNEL__
 182 #include "ext4_sb.h"
 183 #endif
 184 /*
 185  * Macro-instructions used to manage group descriptors
 186  */
 187 #define EXT4_MIN_DESC_SIZE              32
 188 #define EXT4_MIN_DESC_SIZE_64BIT        64
 189 #define EXT4_MAX_DESC_SIZE              EXT4_MIN_BLOCK_SIZE
 190 #define EXT4_DESC_SIZE(s)               (EXT4_SB(s)->s_desc_size)
 191 #ifdef __KERNEL__
 192 # define EXT4_BLOCKS_PER_GROUP(s)       (EXT4_SB(s)->s_blocks_per_group)
 193 # define EXT4_DESC_PER_BLOCK(s)         (EXT4_SB(s)->s_desc_per_block)
 194 # define EXT4_INODES_PER_GROUP(s)       (EXT4_SB(s)->s_inodes_per_group)
 195 # define EXT4_DESC_PER_BLOCK_BITS(s)    (EXT4_SB(s)->s_desc_per_block_bits)
 196 #else
 197 # define EXT4_BLOCKS_PER_GROUP(s)       ((s)->s_blocks_per_group)
 198 # define EXT4_DESC_PER_BLOCK(s)         (EXT4_BLOCK_SIZE(s) / EXT4_DESC_SIZE(s))
 199 # define EXT4_INODES_PER_GROUP(s)       ((s)->s_inodes_per_group)
 200 #endif
 201
 202 /*
 203  * Constants relative to the data blocks
 204  */
 205 #define EXT4_NDIR_BLOCKS                12
 206 #define EXT4_IND_BLOCK                  EXT4_NDIR_BLOCKS
 207 #define EXT4_DIND_BLOCK                 (EXT4_IND_BLOCK + 1)
 208 #define EXT4_TIND_BLOCK                 (EXT4_DIND_BLOCK + 1)
 209 #define EXT4_N_BLOCKS                   (EXT4_TIND_BLOCK + 1)
 210
 211 /*
 212  * Inode flags
 213  */
 214 #define EXT4_SECRM_FL                   0x00000001 /* Secure deletion */
 215 #define EXT4_UNRM_FL                    0x00000002 /* Undelete */
 216 #define EXT4_COMPR_FL                   0x00000004 /* Compress file */
 217 #define EXT4_SYNC_FL                    0x00000008 /* Synchronous updates */
 218 #define EXT4_IMMUTABLE_FL               0x00000010 /* Immutable file */
 219 #define EXT4_APPEND_FL                  0x00000020 /* writes to file may only append */
 220 #define EXT4_NODUMP_FL                  0x00000040 /* do not dump file */
 221 #define EXT4_NOATIME_FL                 0x00000080 /* do not update atime */
 222 /* Reserved for compression usage... */
 223 #define EXT4_DIRTY_FL                   0x00000100
 224 #define EXT4_COMPRBLK_FL                0x00000200 /* One or more compressed clusters */
 225 #define EXT4_NOCOMPR_FL                 0x00000400 /* Don't compress */
 226 #define EXT4_ECOMPR_FL                  0x00000800 /* Compression error */
 227 /* End compression flags --- maybe not all used */
 228 #define EXT4_INDEX_FL                   0x00001000 /* hash-indexed directory */
 229 #define EXT4_IMAGIC_FL                  0x00002000 /* AFS directory */
 230 #define EXT4_JOURNAL_DATA_FL            0x00004000 /* file data should be journaled */
 231 #define EXT4_NOTAIL_FL                  0x00008000 /* file tail should not be merged */
 232 #define EXT4_DIRSYNC_FL                 0x00010000 /* dirsync behaviour (directories only) */
 233 #define EXT4_TOPDIR_FL                  0x00020000 /* Top of directory hierarchies*/
 234 #define EXT4_HUGE_FILE_FL               0x00040000 /* Set to each huge file */
 235 #define EXT4_EXTENTS_FL                 0x00080000 /* Inode uses extents */
 236 #define EXT4_EXT_MIGRATE                0x00100000 /* Inode is migrating */
 237 #define EXT4_RESERVED_FL                0x80000000 /* reserved for ext4 lib */
 238
 239 #define EXT4_FL_USER_VISIBLE            0x000BDFFF /* User visible flags */
 240 #define EXT4_FL_USER_MODIFIABLE         0x000B80FF /* User modifiable flags */
 241
 242 /* Flags that should be inherited by new inodes from their parent. */
 243 #define EXT4_FL_INHERITED (EXT4_SECRM_FL | EXT4_UNRM_FL | EXT4_COMPR_FL |\
 244                            EXT4_SYNC_FL | EXT4_IMMUTABLE_FL | EXT4_APPEND_FL |\
 245                            EXT4_NODUMP_FL | EXT4_NOATIME_FL |\
 246                            EXT4_NOCOMPR_FL | EXT4_JOURNAL_DATA_FL |\
 247                            EXT4_NOTAIL_FL | EXT4_DIRSYNC_FL)
 248
 249 /*
 250  * Inode dynamic state flags
 251  */
 252 #define EXT4_STATE_JDATA                0x00000001 /* journaled data exists */
 253 #define EXT4_STATE_NEW                  0x00000002 /* inode is newly created */
 254 #define EXT4_STATE_XATTR                0x00000004 /* has in-inode xattrs */
 255 #define EXT4_STATE_NO_EXPAND            0x00000008 /* No space for expansion */
 256
 257 /* Used to pass group descriptor data when online resize is done */
 258 struct ext4_new_group_input {
 259         __u32 group;            /* Group number for this data */
 260         __u64 block_bitmap;     /* Absolute block number of block bitmap */
 261         __u64 inode_bitmap;     /* Absolute block number of inode bitmap */
 262         __u64 inode_table;      /* Absolute block number of inode table start */
 263         __u32 blocks_count;     /* Total number of blocks in this group */
 264         __u16 reserved_blocks;  /* Number of reserved blocks in this group */
 265         __u16 unused;
 266 };
 267
 268 /* The struct ext4_new_group_input in kernel space, with free_blocks_count */
 269 struct ext4_new_group_data {
 270         __u32 group;
 271         __u64 block_bitmap;
 272         __u64 inode_bitmap;
 273         __u64 inode_table;
 274         __u32 blocks_count;
 275         __u16 reserved_blocks;
 276         __u16 unused;
 277         __u32 free_blocks_count;
 278 };
 279
 280 /*
 281  * Following is used by preallocation code to tell get_blocks() that we
 282  * want uninitialzed extents.
 283  */
 284 #define EXT4_CREATE_UNINITIALIZED_EXT           2
 285
 286 /*
 287  * ioctl commands
 288  */
 289 #define EXT4_IOC_GETFLAGS               FS_IOC_GETFLAGS
 290 #define EXT4_IOC_SETFLAGS               FS_IOC_SETFLAGS
 291 #define EXT4_IOC_GETVERSION             _IOR('f', 3, long)
 292 #define EXT4_IOC_SETVERSION             _IOW('f', 4, long)
 293 #define EXT4_IOC_GETVERSION_OLD         FS_IOC_GETVERSION
 294 #define EXT4_IOC_SETVERSION_OLD         FS_IOC_SETVERSION
 295 #ifdef CONFIG_JBD2_DEBUG
 296 #define EXT4_IOC_WAIT_FOR_READONLY      _IOR('f', 99, long)
 297 #endif
 298 #define EXT4_IOC_GETRSVSZ               _IOR('f', 5, long)
 299 #define EXT4_IOC_SETRSVSZ               _IOW('f', 6, long)
 300 #define EXT4_IOC_GROUP_EXTEND           _IOW('f', 7, unsigned long)
 301 #define EXT4_IOC_GROUP_ADD              _IOW('f', 8, struct ext4_new_group_input)
 302 #define EXT4_IOC_MIGRATE                _IO('f', 9)
 303  /* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
 304
 305 /*
 306  * ioctl commands in 32 bit emulation
 307  */
 308 #define EXT4_IOC32_GETFLAGS             FS_IOC32_GETFLAGS
 309 #define EXT4_IOC32_SETFLAGS             FS_IOC32_SETFLAGS
 310 #define EXT4_IOC32_GETVERSION           _IOR('f', 3, int)
 311 #define EXT4_IOC32_SETVERSION           _IOW('f', 4, int)
 312 #define EXT4_IOC32_GETRSVSZ             _IOR('f', 5, int)
 313 #define EXT4_IOC32_SETRSVSZ             _IOW('f', 6, int)
 314 #define EXT4_IOC32_GROUP_EXTEND         _IOW('f', 7, unsigned int)
 315 #ifdef CONFIG_JBD2_DEBUG
 316 #define EXT4_IOC32_WAIT_FOR_READONLY    _IOR('f', 99, int)
 317 #endif
 318 #define EXT4_IOC32_GETVERSION_OLD       FS_IOC32_GETVERSION
 319 #define EXT4_IOC32_SETVERSION_OLD       FS_IOC32_SETVERSION
 320
 321
 322 /*
 323  *  Mount options
 324  */
 325 struct ext4_mount_options {
 326         unsigned long s_mount_opt;
 327         uid_t s_resuid;
 328         gid_t s_resgid;
 329         unsigned long s_commit_interval;
 330         u32 s_min_batch_time, s_max_batch_time;
 331 #ifdef CONFIG_QUOTA
 332         int s_jquota_fmt;
 333         char *s_qf_names[MAXQUOTAS];
 334 #endif
 335 };
 336
 337 /*
 338  * Structure of an inode on the disk
 339  */
 340 struct ext4_inode {
 341         __le16  i_mode;         /* File mode */
 342         __le16  i_uid;          /* Low 16 bits of Owner Uid */
 343         __le32  i_size_lo;      /* Size in bytes */
 344         __le32  i_atime;        /* Access time */
 345         __le32  i_ctime;        /* Inode Change time */
 346         __le32  i_mtime;        /* Modification time */
 347         __le32  i_dtime;        /* Deletion Time */
 348         __le16  i_gid;          /* Low 16 bits of Group Id */
 349         __le16  i_links_count;  /* Links count */
 350         __le32  i_blocks_lo;    /* Blocks count */
 351         __le32  i_flags;        /* File flags */
 352         union {
 353                 struct {
 354                         __le32  l_i_version;
 355                 } linux1;
 356                 struct {
 357                         __u32  h_i_translator;
 358                 } hurd1;
 359                 struct {
 360                         __u32  m_i_reserved1;
 361                 } masix1;
 362         } osd1;                         /* OS dependent 1 */
 363         __le32  i_block[EXT4_N_BLOCKS];/* Pointers to blocks */
 364         __le32  i_generation;   /* File version (for NFS) */
 365         __le32  i_file_acl_lo;  /* File ACL */
 366         __le32  i_size_high;
 367         __le32  i_obso_faddr;   /* Obsoleted fragment address */
 368         union {
 369                 struct {
 370                         __le16  l_i_blocks_high; /* were l_i_reserved1 */
 371                         __le16  l_i_file_acl_high;
 372                         __le16  l_i_uid_high;   /* these 2 fields */
 373                         __le16  l_i_gid_high;   /* were reserved2[0] */
 374                         __u32   l_i_reserved2;
 375                 } linux2;
 376                 struct {
 377                         __le16  h_i_reserved1;  /* Obsoleted fragment number/size which are removed in ext4 */
 378                         __u16   h_i_mode_high;
 379                         __u16   h_i_uid_high;
 380                         __u16   h_i_gid_high;
 381                         __u32   h_i_author;
 382                 } hurd2;
 383                 struct {
 384                         __le16  h_i_reserved1;  /* Obsoleted fragment number/size which are removed in ext4 */
 385                         __le16  m_i_file_acl_high;
 386                         __u32   m_i_reserved2[2];
 387                 } masix2;
 388         } osd2;                         /* OS dependent 2 */
 389         __le16  i_extra_isize;
 390         __le16  i_pad1;
 391         __le32  i_ctime_extra;  /* extra Change time      (nsec << 2 | epoch) */
 392         __le32  i_mtime_extra;  /* extra Modification time(nsec << 2 | epoch) */
 393         __le32  i_atime_extra;  /* extra Access time      (nsec << 2 | epoch) */
 394         __le32  i_crtime;       /* File Creation time */
 395         __le32  i_crtime_extra; /* extra FileCreationtime (nsec << 2 | epoch) */
 396         __le32  i_version_hi;   /* high 32 bits for 64-bit version */
 397 };
 398
 399
 400 #define EXT4_EPOCH_BITS 2
 401 #define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
 402 #define EXT4_NSEC_MASK  (~0UL << EXT4_EPOCH_BITS)
 403
 404 /*
 405  * Extended fields will fit into an inode if the filesystem was formatted
 406  * with large inodes (-I 256 or larger) and there are not currently any EAs
 407  * consuming all of the available space. For new inodes we always reserve
 408  * enough space for the kernel's known extended fields, but for inodes
 409  * created with an old kernel this might not have been the case. None of
 410  * the extended inode fields is critical for correct filesystem operation.
 411  * This macro checks if a certain field fits in the inode. Note that
 412  * inode-size = GOOD_OLD_INODE_SIZE + i_extra_isize
 413  */
 414 #define EXT4_FITS_IN_INODE(ext4_inode, einode, field)   \
 415         ((offsetof(typeof(*ext4_inode), field) +        \
 416           sizeof((ext4_inode)->field))                  \
 417         <= (EXT4_GOOD_OLD_INODE_SIZE +                  \
 418             (einode)->i_extra_isize))                   \
 419
 420 static inline __le32 ext4_encode_extra_time(struct timespec *time)
 421 {
 422        return cpu_to_le32((sizeof(time->tv_sec) > 4 ?
 423                            time->tv_sec >> 32 : 0) |
 424                            ((time->tv_nsec << 2) & EXT4_NSEC_MASK));
 425 }
 426
 427 static inline void ext4_decode_extra_time(struct timespec *time, __le32 extra)
 428 {
 429        if (sizeof(time->tv_sec) > 4)
 430                time->tv_sec |= (__u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK)
 431                                << 32;
 432        time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> 2;
 433 }
 434
 435 #define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode)                          \
 436 do {                                                                           \
 437         (raw_inode)->xtime = cpu_to_le32((inode)->xtime.tv_sec);               \
 438         if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra))     \
 439                 (raw_inode)->xtime ## _extra =                                 \
 440                                 ext4_encode_extra_time(&(inode)->xtime);       \
 441 } while (0)
 442
 443 #define EXT4_EINODE_SET_XTIME(xtime, einode, raw_inode)                        \
 444 do {                                                                           \
 445         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))                      \
 446                 (raw_inode)->xtime = cpu_to_le32((einode)->xtime.tv_sec);      \
 447         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))            \
 448                 (raw_inode)->xtime ## _extra =                                 \
 449                                 ext4_encode_extra_time(&(einode)->xtime);      \
 450 } while (0)
 451
 452 #define EXT4_INODE_GET_XTIME(xtime, inode, raw_inode)                          \
 453 do {                                                                           \
 454         (inode)->xtime.tv_sec = (signed)le32_to_cpu((raw_inode)->xtime);       \
 455         if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra))     \
 456                 ext4_decode_extra_time(&(inode)->xtime,                        \
 457                                        raw_inode->xtime ## _extra);            \
 458 } while (0)
 459
 460 #define EXT4_EINODE_GET_XTIME(xtime, einode, raw_inode)                        \
 461 do {                                                                           \
 462         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))                      \
 463                 (einode)->xtime.tv_sec =                                       \
 464                         (signed)le32_to_cpu((raw_inode)->xtime);               \
 465         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))            \
 466                 ext4_decode_extra_time(&(einode)->xtime,                       \
 467                                        raw_inode->xtime ## _extra);            \
 468 } while (0)
 469
 470 #define i_disk_version osd1.linux1.l_i_version
 471
 472 #if defined(__KERNEL__) || defined(__linux__)
 473 #define i_reserved1     osd1.linux1.l_i_reserved1
 474 #define i_file_acl_high osd2.linux2.l_i_file_acl_high
 475 #define i_blocks_high   osd2.linux2.l_i_blocks_high
 476 #define i_uid_low       i_uid
 477 #define i_gid_low       i_gid
 478 #define i_uid_high      osd2.linux2.l_i_uid_high
 479 #define i_gid_high      osd2.linux2.l_i_gid_high
 480 #define i_reserved2     osd2.linux2.l_i_reserved2
 481
 482 #elif defined(__GNU__)
 483
 484 #define i_translator    osd1.hurd1.h_i_translator
 485 #define i_uid_high      osd2.hurd2.h_i_uid_high
 486 #define i_gid_high      osd2.hurd2.h_i_gid_high
 487 #define i_author        osd2.hurd2.h_i_author
 488
 489 #elif defined(__masix__)
 490
 491 #define i_reserved1     osd1.masix1.m_i_reserved1
 492 #define i_file_acl_high osd2.masix2.m_i_file_acl_high
 493 #define i_reserved2     osd2.masix2.m_i_reserved2
 494
 495 #endif /* defined(__KERNEL__) || defined(__linux__) */
 496
 497 /*
 498  * File system states
 499  */
 500 #define EXT4_VALID_FS                   0x0001  /* Unmounted cleanly */
 501 #define EXT4_ERROR_FS                   0x0002  /* Errors detected */
 502 #define EXT4_ORPHAN_FS                  0x0004  /* Orphans being recovered */
 503
 504 /*
 505  * Misc. filesystem flags
 506  */
 507 #define EXT2_FLAGS_SIGNED_HASH          0x0001  /* Signed dirhash in use */
 508 #define EXT2_FLAGS_UNSIGNED_HASH        0x0002  /* Unsigned dirhash in use */
 509 #define EXT2_FLAGS_TEST_FILESYS         0x0004  /* to test development code */
 510
 511 /*
 512  * Mount flags
 513  */
 514 #define EXT4_MOUNT_OLDALLOC             0x00002  /* Don't use the new Orlov allocator */
 515 #define EXT4_MOUNT_GRPID                0x00004 /* Create files with directory's group */
 516 #define EXT4_MOUNT_DEBUG                0x00008 /* Some debugging messages */
 517 #define EXT4_MOUNT_ERRORS_CONT          0x00010 /* Continue on errors */
 518 #define EXT4_MOUNT_ERRORS_RO            0x00020 /* Remount fs ro on errors */
 519 #define EXT4_MOUNT_ERRORS_PANIC         0x00040 /* Panic on errors */
 520 #define EXT4_MOUNT_MINIX_DF             0x00080 /* Mimics the Minix statfs */
 521 #define EXT4_MOUNT_NOLOAD               0x00100 /* Don't use existing journal*/
 522 #define EXT4_MOUNT_ABORT                0x00200 /* Fatal error detected */
 523 #define EXT4_MOUNT_DATA_FLAGS           0x00C00 /* Mode for data writes: */
 524 #define EXT4_MOUNT_JOURNAL_DATA         0x00400 /* Write data to journal */
 525 #define EXT4_MOUNT_ORDERED_DATA         0x00800 /* Flush data before commit */
 526 #define EXT4_MOUNT_WRITEBACK_DATA       0x00C00 /* No data ordering */
 527 #define EXT4_MOUNT_UPDATE_JOURNAL       0x01000 /* Update the journal format */
 528 #define EXT4_MOUNT_NO_UID32             0x02000  /* Disable 32-bit UIDs */
 529 #define EXT4_MOUNT_XATTR_USER           0x04000 /* Extended user attributes */
 530 #define EXT4_MOUNT_POSIX_ACL            0x08000 /* POSIX Access Control Lists */
 531 #define EXT4_MOUNT_RESERVATION          0x10000 /* Preallocation */
 532 #define EXT4_MOUNT_BARRIER              0x20000 /* Use block barriers */
 533 #define EXT4_MOUNT_NOBH                 0x40000 /* No bufferheads */
 534 #define EXT4_MOUNT_QUOTA                0x80000 /* Some quota option set */
 535 #define EXT4_MOUNT_USRQUOTA             0x100000 /* "old" user quota */
 536 #define EXT4_MOUNT_GRPQUOTA             0x200000 /* "old" group quota */
 537 #define EXT4_MOUNT_JOURNAL_CHECKSUM     0x800000 /* Journal checksums */
 538 #define EXT4_MOUNT_JOURNAL_ASYNC_COMMIT 0x1000000 /* Journal Async Commit */
 539 #define EXT4_MOUNT_I_VERSION            0x2000000 /* i_version support */
 540 #define EXT4_MOUNT_DELALLOC             0x8000000 /* Delalloc support */
 541 #define EXT4_MOUNT_DATA_ERR_ABORT       0x10000000 /* Abort on file data write */
 542
 543 /* Compatibility, for having both ext2_fs.h and ext4_fs.h included at once */
 544 #ifndef _LINUX_EXT2_FS_H
 545 #define clear_opt(o, opt)               o &= ~EXT4_MOUNT_##opt
 546 #define set_opt(o, opt)                 o |= EXT4_MOUNT_##opt
 547 #define test_opt(sb, opt)               (EXT4_SB(sb)->s_mount_opt & \
 548                                          EXT4_MOUNT_##opt)
 549 #else
 550 #define EXT2_MOUNT_NOLOAD               EXT4_MOUNT_NOLOAD
 551 #define EXT2_MOUNT_ABORT                EXT4_MOUNT_ABORT
 552 #define EXT2_MOUNT_DATA_FLAGS           EXT4_MOUNT_DATA_FLAGS
 553 #endif
 554
 555 #define ext4_set_bit                    ext2_set_bit
 556 #define ext4_set_bit_atomic             ext2_set_bit_atomic
 557 #define ext4_clear_bit                  ext2_clear_bit
 558 #define ext4_clear_bit_atomic           ext2_clear_bit_atomic
 559 #define ext4_test_bit                   ext2_test_bit
 560 #define ext4_find_first_zero_bit        ext2_find_first_zero_bit
 561 #define ext4_find_next_zero_bit         ext2_find_next_zero_bit
 562 #define ext4_find_next_bit              ext2_find_next_bit
 563
 564 /*
 565  * Maximal mount counts between two filesystem checks
 566  */
 567 #define EXT4_DFL_MAX_MNT_COUNT          20      /* Allow 20 mounts */
 568 #define EXT4_DFL_CHECKINTERVAL          0       /* Don't use interval check */
 569
 570 /*
 571  * Behaviour when detecting errors
 572  */
 573 #define EXT4_ERRORS_CONTINUE            1       /* Continue execution */
 574 #define EXT4_ERRORS_RO                  2       /* Remount fs read-only */
 575 #define EXT4_ERRORS_PANIC               3       /* Panic */
 576 #define EXT4_ERRORS_DEFAULT             EXT4_ERRORS_CONTINUE
 577
 578 /*
 579  * Structure of the super block
 580  */
 581 struct ext4_super_block {
 582 /*00*/  __le32  s_inodes_count;         /* Inodes count */
 583         __le32  s_blocks_count_lo;      /* Blocks count */
 584         __le32  s_r_blocks_count_lo;    /* Reserved blocks count */
 585         __le32  s_free_blocks_count_lo; /* Free blocks count */
 586 /*10*/  __le32  s_free_inodes_count;    /* Free inodes count */
 587         __le32  s_first_data_block;     /* First Data Block */
 588         __le32  s_log_block_size;       /* Block size */
 589         __le32  s_obso_log_frag_size;   /* Obsoleted fragment size */
 590 /*20*/  __le32  s_blocks_per_group;     /* # Blocks per group */
 591         __le32  s_obso_frags_per_group; /* Obsoleted fragments per group */
 592         __le32  s_inodes_per_group;     /* # Inodes per group */
 593         __le32  s_mtime;                /* Mount time */
 594 /*30*/  __le32  s_wtime;                /* Write time */
 595         __le16  s_mnt_count;            /* Mount count */
 596         __le16  s_max_mnt_count;        /* Maximal mount count */
 597         __le16  s_magic;                /* Magic signature */
 598         __le16  s_state;                /* File system state */
 599         __le16  s_errors;               /* Behaviour when detecting errors */
 600         __le16  s_minor_rev_level;      /* minor revision level */
 601 /*40*/  __le32  s_lastcheck;            /* time of last check */
 602         __le32  s_checkinterval;        /* max. time between checks */
 603         __le32  s_creator_os;           /* OS */
 604         __le32  s_rev_level;            /* Revision level */
 605 /*50*/  __le16  s_def_resuid;           /* Default uid for reserved blocks */
 606         __le16  s_def_resgid;           /* Default gid for reserved blocks */
 607         /*
 608          * These fields are for EXT4_DYNAMIC_REV superblocks only.
 609          *
 610          * Note: the difference between the compatible feature set and
 611          * the incompatible feature set is that if there is a bit set
 612          * in the incompatible feature set that the kernel doesn't
 613          * know about, it should refuse to mount the filesystem.
 614          *
 615          * e2fsck's requirements are more strict; if it doesn't know
 616          * about a feature in either the compatible or incompatible
 617          * feature set, it must abort and not try to meddle with
 618          * things it doesn't understand...
 619          */
 620         __le32  s_first_ino;            /* First non-reserved inode */
 621         __le16  s_inode_size;           /* size of inode structure */
 622         __le16  s_block_group_nr;       /* block group # of this superblock */
 623         __le32  s_feature_compat;       /* compatible feature set */
 624 /*60*/  __le32  s_feature_incompat;     /* incompatible feature set */
 625         __le32  s_feature_ro_compat;    /* readonly-compatible feature set */
 626 /*68*/  __u8    s_uuid[16];             /* 128-bit uuid for volume */
 627 /*78*/  char    s_volume_name[16];      /* volume name */
 628 /*88*/  char    s_last_mounted[64];     /* directory where last mounted */
 629 /*C8*/  __le32  s_algorithm_usage_bitmap; /* For compression */
 630         /*
 631          * Performance hints.  Directory preallocation should only
 632          * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
 633          */
 634         __u8    s_prealloc_blocks;      /* Nr of blocks to try to preallocate*/
 635         __u8    s_prealloc_dir_blocks;  /* Nr to preallocate for dirs */
 636         __le16  s_reserved_gdt_blocks;  /* Per group desc for online growth */
 637         /*
 638          * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
 639          */
 640 /*D0*/  __u8    s_journal_uuid[16];     /* uuid of journal superblock */
 641 /*E0*/  __le32  s_journal_inum;         /* inode number of journal file */
 642         __le32  s_journal_dev;          /* device number of journal file */
 643         __le32  s_last_orphan;          /* start of list of inodes to delete */
 644         __le32  s_hash_seed[4];         /* HTREE hash seed */
 645         __u8    s_def_hash_version;     /* Default hash version to use */
 646         __u8    s_reserved_char_pad;
 647         __le16  s_desc_size;            /* size of group descriptor */
 648 /*100*/ __le32  s_default_mount_opts;
 649         __le32  s_first_meta_bg;        /* First metablock block group */
 650         __le32  s_mkfs_time;            /* When the filesystem was created */
 651         __le32  s_jnl_blocks[17];       /* Backup of the journal inode */
 652         /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
 653 /*150*/ __le32  s_blocks_count_hi;      /* Blocks count */
 654         __le32  s_r_blocks_count_hi;    /* Reserved blocks count */
 655         __le32  s_free_blocks_count_hi; /* Free blocks count */
 656         __le16  s_min_extra_isize;      /* All inodes have at least # bytes */
 657         __le16  s_want_extra_isize;     /* New inodes should reserve # bytes */
 658         __le32  s_flags;                /* Miscellaneous flags */
 659         __le16  s_raid_stride;          /* RAID stride */
 660         __le16  s_mmp_interval;         /* # seconds to wait in MMP checking */
 661         __le64  s_mmp_block;            /* Block for multi-mount protection */
 662         __le32  s_raid_stripe_width;    /* blocks on all data disks (N*stride)*/
 663         __u8    s_log_groups_per_flex;  /* FLEX_BG group size */
 664         __u8    s_reserved_char_pad2;
 665         __le16  s_reserved_pad;
 666         __u32   s_reserved[162];        /* Padding to the end of the block */
 667 };
 668
 669 #ifdef __KERNEL__
 670 static inline struct ext4_sb_info *EXT4_SB(struct super_block *sb)
 671 {
 672         return sb->s_fs_info;
 673 }
 674 static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
 675 {
 676         return container_of(inode, struct ext4_inode_info, vfs_inode);
 677 }
 678
 679 static inline struct timespec ext4_current_time(struct inode *inode)
 680 {
 681         return (inode->i_sb->s_time_gran < NSEC_PER_SEC) ?
 682                 current_fs_time(inode->i_sb) : CURRENT_TIME_SEC;
 683 }
 684
 685
 686 static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
 687 {
 688         return ino == EXT4_ROOT_INO ||
 689                 ino == EXT4_JOURNAL_INO ||
 690                 ino == EXT4_RESIZE_INO ||
 691                 (ino >= EXT4_FIRST_INO(sb) &&
 692                  ino <= le32_to_cpu(EXT4_SB(sb)->s_es->s_inodes_count));
 693 }
 694 #else
 695 /* Assume that user mode programs are passing in an ext4fs superblock, not
 696  * a kernel struct super_block.  This will allow us to call the feature-test
 697  * macros from user land. */
 698 #define EXT4_SB(sb)     (sb)
 699 #endif
 700
 701 #define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
 702
 703 /*
 704  * Codes for operating systems
 705  */
 706 #define EXT4_OS_LINUX           0
 707 #define EXT4_OS_HURD            1
 708 #define EXT4_OS_MASIX           2
 709 #define EXT4_OS_FREEBSD         3
 710 #define EXT4_OS_LITES           4
 711
 712 /*
 713  * Revision levels
 714  */
 715 #define EXT4_GOOD_OLD_REV       0       /* The good old (original) format */
 716 #define EXT4_DYNAMIC_REV        1       /* V2 format w/ dynamic inode sizes */
 717
 718 #define EXT4_CURRENT_REV        EXT4_GOOD_OLD_REV
 719 #define EXT4_MAX_SUPP_REV       EXT4_DYNAMIC_REV
 720
 721 #define EXT4_GOOD_OLD_INODE_SIZE 128
 722
 723 /*
 724  * Feature set definitions
 725  */
 726
 727 #define EXT4_HAS_COMPAT_FEATURE(sb,mask)                        \
 728         ((EXT4_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask)) != 0)
 729 #define EXT4_HAS_RO_COMPAT_FEATURE(sb,mask)                     \
 730         ((EXT4_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask)) != 0)
 731 #define EXT4_HAS_INCOMPAT_FEATURE(sb,mask)                      \
 732         ((EXT4_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask)) != 0)
 733 #define EXT4_SET_COMPAT_FEATURE(sb,mask)                        \
 734         EXT4_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
 735 #define EXT4_SET_RO_COMPAT_FEATURE(sb,mask)                     \
 736         EXT4_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
 737 #define EXT4_SET_INCOMPAT_FEATURE(sb,mask)                      \
 738         EXT4_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
 739 #define EXT4_CLEAR_COMPAT_FEATURE(sb,mask)                      \
 740         EXT4_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
 741 #define EXT4_CLEAR_RO_COMPAT_FEATURE(sb,mask)                   \
 742         EXT4_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
 743 #define EXT4_CLEAR_INCOMPAT_FEATURE(sb,mask)                    \
 744         EXT4_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
 745
 746 #define EXT4_FEATURE_COMPAT_DIR_PREALLOC        0x0001
 747 #define EXT4_FEATURE_COMPAT_IMAGIC_INODES       0x0002
 748 #define EXT4_FEATURE_COMPAT_HAS_JOURNAL         0x0004
 749 #define EXT4_FEATURE_COMPAT_EXT_ATTR            0x0008
 750 #define EXT4_FEATURE_COMPAT_RESIZE_INODE        0x0010
 751 #define EXT4_FEATURE_COMPAT_DIR_INDEX           0x0020
 752
 753 #define EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER     0x0001
 754 #define EXT4_FEATURE_RO_COMPAT_LARGE_FILE       0x0002
 755 #define EXT4_FEATURE_RO_COMPAT_BTREE_DIR        0x0004
 756 #define EXT4_FEATURE_RO_COMPAT_HUGE_FILE        0x0008
 757 #define EXT4_FEATURE_RO_COMPAT_GDT_CSUM         0x0010
 758 #define EXT4_FEATURE_RO_COMPAT_DIR_NLINK        0x0020
 759 #define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE      0x0040
 760
 761 #define EXT4_FEATURE_INCOMPAT_COMPRESSION       0x0001
 762 #define EXT4_FEATURE_INCOMPAT_FILETYPE          0x0002
 763 #define EXT4_FEATURE_INCOMPAT_RECOVER           0x0004 /* Needs recovery */
 764 #define EXT4_FEATURE_INCOMPAT_JOURNAL_DEV       0x0008 /* Journal device */
 765 #define EXT4_FEATURE_INCOMPAT_META_BG           0x0010
 766 #define EXT4_FEATURE_INCOMPAT_EXTENTS           0x0040 /* extents support */
 767 #define EXT4_FEATURE_INCOMPAT_64BIT             0x0080
 768 #define EXT4_FEATURE_INCOMPAT_MMP               0x0100
 769 #define EXT4_FEATURE_INCOMPAT_FLEX_BG           0x0200
 770
 771 #define EXT4_FEATURE_COMPAT_SUPP        EXT2_FEATURE_COMPAT_EXT_ATTR
 772 #define EXT4_FEATURE_INCOMPAT_SUPP      (EXT4_FEATURE_INCOMPAT_FILETYPE| \
 773                                          EXT4_FEATURE_INCOMPAT_RECOVER| \
 774                                          EXT4_FEATURE_INCOMPAT_META_BG| \
 775                                          EXT4_FEATURE_INCOMPAT_EXTENTS| \
 776                                          EXT4_FEATURE_INCOMPAT_64BIT| \
 777                                          EXT4_FEATURE_INCOMPAT_FLEX_BG)
 778 #define EXT4_FEATURE_RO_COMPAT_SUPP     (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
 779                                          EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
 780                                          EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
 781                                          EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
 782                                          EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
 783                                          EXT4_FEATURE_RO_COMPAT_BTREE_DIR |\
 784                                          EXT4_FEATURE_RO_COMPAT_HUGE_FILE)
 785
 786 /*
 787  * Default values for user and/or group using reserved blocks
 788  */
 789 #define EXT4_DEF_RESUID         0
 790 #define EXT4_DEF_RESGID         0
 791
 792 #define EXT4_DEF_INODE_READAHEAD_BLKS   32
 793
 794 /*
 795  * Default mount options
 796  */
 797 #define EXT4_DEFM_DEBUG         0x0001
 798 #define EXT4_DEFM_BSDGROUPS     0x0002
 799 #define EXT4_DEFM_XATTR_USER    0x0004
 800 #define EXT4_DEFM_ACL           0x0008
 801 #define EXT4_DEFM_UID16         0x0010
 802 #define EXT4_DEFM_JMODE         0x0060
 803 #define EXT4_DEFM_JMODE_DATA    0x0020
 804 #define EXT4_DEFM_JMODE_ORDERED 0x0040
 805 #define EXT4_DEFM_JMODE_WBACK   0x0060
 806
 807 /*
 808  * Default journal batch times
 809  */
 810 #define EXT4_DEF_MIN_BATCH_TIME 0
 811 #define EXT4_DEF_MAX_BATCH_TIME 15000 /* 15ms */
 812
 813 /*
 814  * Structure of a directory entry
 815  */
 816 #define EXT4_NAME_LEN 255
 817
 818 struct ext4_dir_entry {
 819         __le32  inode;                  /* Inode number */
 820         __le16  rec_len;                /* Directory entry length */
 821         __le16  name_len;               /* Name length */
 822         char    name[EXT4_NAME_LEN];    /* File name */
 823 };
 824
 825 /*
 826  * The new version of the directory entry.  Since EXT4 structures are
 827  * stored in intel byte order, and the name_len field could never be
 828  * bigger than 255 chars, it's safe to reclaim the extra byte for the
 829  * file_type field.
 830  */
 831 struct ext4_dir_entry_2 {
 832         __le32  inode;                  /* Inode number */
 833         __le16  rec_len;                /* Directory entry length */
 834         __u8    name_len;               /* Name length */
 835         __u8    file_type;
 836         char    name[EXT4_NAME_LEN];    /* File name */
 837 };
 838
 839 /*
 840  * Ext4 directory file types.  Only the low 3 bits are used.  The
 841  * other bits are reserved for now.
 842  */
 843 #define EXT4_FT_UNKNOWN         0
 844 #define EXT4_FT_REG_FILE        1
 845 #define EXT4_FT_DIR             2
 846 #define EXT4_FT_CHRDEV          3
 847 #define EXT4_FT_BLKDEV          4
 848 #define EXT4_FT_FIFO            5
 849 #define EXT4_FT_SOCK            6
 850 #define EXT4_FT_SYMLINK         7
 851
 852 #define EXT4_FT_MAX             8
 853
 854 /*
 855  * EXT4_DIR_PAD defines the directory entries boundaries
 856  *
 857  * NOTE: It must be a multiple of 4
 858  */
 859 #define EXT4_DIR_PAD                    4
 860 #define EXT4_DIR_ROUND                  (EXT4_DIR_PAD - 1)
 861 #define EXT4_DIR_REC_LEN(name_len)      (((name_len) + 8 + EXT4_DIR_ROUND) & \
 862                                          ~EXT4_DIR_ROUND)
 863 #define EXT4_MAX_REC_LEN                ((1<<16)-1)
 864
 865 /*
 866  * Hash Tree Directory indexing
 867  * (c) Daniel Phillips, 2001
 868  */
 869
 870 #define is_dx(dir) (EXT4_HAS_COMPAT_FEATURE(dir->i_sb, \
 871                                       EXT4_FEATURE_COMPAT_DIR_INDEX) && \
 872                       (EXT4_I(dir)->i_flags & EXT4_INDEX_FL))
 873 #define EXT4_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT4_LINK_MAX)
 874 #define EXT4_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
 875
 876 /* Legal values for the dx_root hash_version field: */
 877
 878 #define DX_HASH_LEGACY          0
 879 #define DX_HASH_HALF_MD4        1
 880 #define DX_HASH_TEA             2
 881 #define DX_HASH_LEGACY_UNSIGNED 3
 882 #define DX_HASH_HALF_MD4_UNSIGNED       4
 883 #define DX_HASH_TEA_UNSIGNED            5
 884
 885 #ifdef __KERNEL__
 886
 887 /* hash info structure used by the directory hash */
 888 struct dx_hash_info
 889 {
 890         u32             hash;
 891         u32             minor_hash;
 892         int             hash_version;
 893         u32             *seed;
 894 };
 895
 896 #define EXT4_HTREE_EOF  0x7fffffff
 897
 898 /*
 899  * Control parameters used by ext4_htree_next_block
 900  */
 901 #define HASH_NB_ALWAYS          1
 902
 903
 904 /*
 905  * Describe an inode's exact location on disk and in memory
 906  */
 907 struct ext4_iloc
 908 {
 909         struct buffer_head *bh;
 910         unsigned long offset;
 911         ext4_group_t block_group;
 912 };
 913
 914 static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
 915 {
 916         return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
 917 }
 918
 919 /*
 920  * This structure is stuffed into the struct file's private_data field
 921  * for directories.  It is where we put information so that we can do
 922  * readdir operations in hash tree order.
 923  */
 924 struct dir_private_info {
 925         struct rb_root  root;
 926         struct rb_node  *curr_node;
 927         struct fname    *extra_fname;
 928         loff_t          last_pos;
 929         __u32           curr_hash;
 930         __u32           curr_minor_hash;
 931         __u32           next_hash;
 932 };
 933
 934 /* calculate the first block number of the group */
 935 static inline ext4_fsblk_t
 936 ext4_group_first_block_no(struct super_block *sb, ext4_group_t group_no)
 937 {
 938         return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
 939                 le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
 940 }
 941
 942 /*
 943  * Special error return code only used by dx_probe() and its callers.
 944  */
 945 #define ERR_BAD_DX_DIR  -75000
 946
 947 void ext4_get_group_no_and_offset(struct super_block *sb, ext4_fsblk_t blocknr,
 948                         ext4_group_t *blockgrpp, ext4_grpblk_t *offsetp);
 949
 950 extern struct proc_dir_entry *ext4_proc_root;
 951
 952 #ifdef CONFIG_PROC_FS
 953 extern const struct file_operations ext4_ui_proc_fops;
 954
 955 #define EXT4_PROC_HANDLER(name, var)                                    \
 956 do {                                                                    \
 957         proc = proc_create_data(name, mode, sbi->s_proc,                \
 958                                 &ext4_ui_proc_fops, &sbi->s_##var);     \
 959         if (proc == NULL) {                                             \
 960                 printk(KERN_ERR "EXT4-fs: can't create %s\n", name);    \
 961                 goto err_out;                                           \
 962         }                                                               \
 963 } while (0)
 964 #else
 965 #define EXT4_PROC_HANDLER(name, var)
 966 #endif
 967
 968 /*
 969  * Function prototypes
 970  */
 971
 972 /*
 973  * Ok, these declarations are also in <linux/kernel.h> but none of the
 974  * ext4 source programs needs to include it so they are duplicated here.
 975  */
 976 # define NORET_TYPE     /**/
 977 # define ATTRIB_NORET   __attribute__((noreturn))
 978 # define NORET_AND      noreturn,
 979
 980 /* bitmap.c */
 981 extern unsigned int ext4_count_free(struct buffer_head *, unsigned);
 982
 983 /* balloc.c */
 984 extern unsigned int ext4_block_group(struct super_block *sb,
 985                         ext4_fsblk_t blocknr);
 986 extern ext4_grpblk_t ext4_block_group_offset(struct super_block *sb,
 987                         ext4_fsblk_t blocknr);
 988 extern int ext4_bg_has_super(struct super_block *sb, ext4_group_t group);
 989 extern unsigned long ext4_bg_num_gdb(struct super_block *sb,
 990                         ext4_group_t group);
 991 extern ext4_fsblk_t ext4_new_meta_blocks(handle_t *handle, struct inode *inode,
 992                         ext4_fsblk_t goal, unsigned long *count, int *errp);
 993 extern int ext4_claim_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
 994 extern int ext4_has_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
 995 extern void ext4_free_blocks(handle_t *handle, struct inode *inode,
 996                         ext4_fsblk_t block, unsigned long count, int metadata);
 997 extern void ext4_add_groupblocks(handle_t *handle, struct super_block *sb,
 998                                 ext4_fsblk_t block, unsigned long count);
 999 extern ext4_fsblk_t ext4_count_free_blocks(struct super_block *);
1000 extern void ext4_check_blocks_bitmap(struct super_block *);
1001 extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
1002                                                     ext4_group_t block_group,
1003                                                     struct buffer_head ** bh);
1004 extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
1005
1006 /* dir.c */
1007 extern int ext4_check_dir_entry(const char *, struct inode *,
1008                                 struct ext4_dir_entry_2 *,
1009                                 struct buffer_head *, unsigned int);
1010 extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
1011                                     __u32 minor_hash,
1012                                     struct ext4_dir_entry_2 *dirent);
1013 extern void ext4_htree_free_dir_info(struct dir_private_info *p);
1014
1015 /* fsync.c */
1016 extern int ext4_sync_file(struct file *, struct dentry *, int);
1017
1018 /* hash.c */
1019 extern int ext4fs_dirhash(const char *name, int len, struct
1020                           dx_hash_info *hinfo);
1021
1022 /* ialloc.c */
1023 extern struct inode * ext4_new_inode(handle_t *, struct inode *, int);
1024 extern void ext4_free_inode(handle_t *, struct inode *);
1025 extern struct inode * ext4_orphan_get(struct super_block *, unsigned long);
1026 extern unsigned long ext4_count_free_inodes(struct super_block *);
1027 extern unsigned long ext4_count_dirs(struct super_block *);
1028 extern void ext4_check_inodes_bitmap(struct super_block *);
1029
1030 /* mballoc.c */
1031 extern long ext4_mb_stats;
1032 extern long ext4_mb_max_to_scan;
1033 extern int ext4_mb_init(struct super_block *, int);
1034 extern int ext4_mb_release(struct super_block *);
1035 extern ext4_fsblk_t ext4_mb_new_blocks(handle_t *,
1036                                 struct ext4_allocation_request *, int *);
1037 extern int ext4_mb_reserve_blocks(struct super_block *, int);
1038 extern void ext4_discard_preallocations(struct inode *);
1039 extern int __init init_ext4_mballoc(void);
1040 extern void exit_ext4_mballoc(void);
1041 extern void ext4_mb_free_blocks(handle_t *, struct inode *,
1042                 unsigned long, unsigned long, int, unsigned long *);
1043 extern int ext4_mb_add_groupinfo(struct super_block *sb,
1044                 ext4_group_t i, struct ext4_group_desc *desc);
1045 extern void ext4_mb_update_group_info(struct ext4_group_info *grp,
1046                 ext4_grpblk_t add);
1047 extern int ext4_mb_get_buddy_cache_lock(struct super_block *, ext4_group_t);
1048 extern void ext4_mb_put_buddy_cache_lock(struct super_block *,
1049                                                 ext4_group_t, int);
1050 /* inode.c */
1051 int ext4_forget(handle_t *handle, int is_metadata, struct inode *inode,
1052                 struct buffer_head *bh, ext4_fsblk_t blocknr);
1053 struct buffer_head *ext4_getblk(handle_t *, struct inode *,
1054                                                 ext4_lblk_t, int, int *);
1055 struct buffer_head *ext4_bread(handle_t *, struct inode *,
1056                                                 ext4_lblk_t, int, int *);
1057 int ext4_get_block(struct inode *inode, sector_t iblock,
1058                                 struct buffer_head *bh_result, int create);
1059
1060 extern struct inode *ext4_iget(struct super_block *, unsigned long);
1061 extern int  ext4_write_inode(struct inode *, int);
1062 extern int  ext4_setattr(struct dentry *, struct iattr *);
1063 extern int  ext4_getattr(struct vfsmount *mnt, struct dentry *dentry,
1064                                 struct kstat *stat);
1065 extern void ext4_delete_inode(struct inode *);
1066 extern int  ext4_sync_inode(handle_t *, struct inode *);
1067 extern void ext4_dirty_inode(struct inode *);
1068 extern int ext4_change_inode_journal_flag(struct inode *, int);
1069 extern int ext4_get_inode_loc(struct inode *, struct ext4_iloc *);
1070 extern int ext4_can_truncate(struct inode *inode);
1071 extern void ext4_truncate(struct inode *);
1072 extern void ext4_set_inode_flags(struct inode *);
1073 extern void ext4_get_inode_flags(struct ext4_inode_info *);
1074 extern void ext4_set_aops(struct inode *inode);
1075 extern int ext4_writepage_trans_blocks(struct inode *);
1076 extern int ext4_meta_trans_blocks(struct inode *, int nrblocks, int idxblocks);
1077 extern int ext4_chunk_trans_blocks(struct inode *, int nrblocks);
1078 extern int ext4_block_truncate_page(handle_t *handle,
1079                 struct address_space *mapping, loff_t from);
1080 extern int ext4_page_mkwrite(struct vm_area_struct *vma, struct page *page);
1081 extern qsize_t ext4_get_reserved_space(struct inode *inode);
1082
1083 /* ioctl.c */
1084 extern long ext4_ioctl(struct file *, unsigned int, unsigned long);
1085 extern long ext4_compat_ioctl(struct file *, unsigned int, unsigned long);
1086
1087 /* migrate.c */
1088 extern int ext4_ext_migrate(struct inode *);
1089
1090 /* namei.c */
1091 extern unsigned int ext4_rec_len_from_disk(__le16 dlen, unsigned blocksize);
1092 extern __le16 ext4_rec_len_to_disk(unsigned len, unsigned blocksize);
1093 extern int ext4_orphan_add(handle_t *, struct inode *);
1094 extern int ext4_orphan_del(handle_t *, struct inode *);
1095 extern int ext4_htree_fill_tree(struct file *dir_file, __u32 start_hash,
1096                                 __u32 start_minor_hash, __u32 *next_hash);
1097
1098 /* resize.c */
1099 extern int ext4_group_add(struct super_block *sb,
1100                                 struct ext4_new_group_data *input);
1101 extern int ext4_group_extend(struct super_block *sb,
1102                                 struct ext4_super_block *es,
1103                                 ext4_fsblk_t n_blocks_count);
1104
1105 /* super.c */
1106 extern void ext4_error(struct super_block *, const char *, const char *, ...)
1107         __attribute__ ((format (printf, 3, 4)));
1108 extern void __ext4_std_error(struct super_block *, const char *, int);
1109 extern void ext4_abort(struct super_block *, const char *, const char *, ...)
1110         __attribute__ ((format (printf, 3, 4)));
1111 extern void ext4_warning(struct super_block *, const char *, const char *, ...)
1112         __attribute__ ((format (printf, 3, 4)));
1113 extern void ext4_grp_locked_error(struct super_block *, ext4_group_t,
1114                                 const char *, const char *, ...)
1115         __attribute__ ((format (printf, 4, 5)));
1116 extern void ext4_update_dynamic_rev(struct super_block *sb);
1117 extern int ext4_update_compat_feature(handle_t *handle, struct super_block *sb,
1118                                         __u32 compat);
1119 extern int ext4_update_rocompat_feature(handle_t *handle,
1120                                         struct super_block *sb, __u32 rocompat);
1121 extern int ext4_update_incompat_feature(handle_t *handle,
1122                                         struct super_block *sb, __u32 incompat);
1123 extern ext4_fsblk_t ext4_block_bitmap(struct super_block *sb,
1124                                       struct ext4_group_desc *bg);
1125 extern ext4_fsblk_t ext4_inode_bitmap(struct super_block *sb,
1126                                       struct ext4_group_desc *bg);
1127 extern ext4_fsblk_t ext4_inode_table(struct super_block *sb,
1128                                      struct ext4_group_desc *bg);
1129 extern __u32 ext4_free_blks_count(struct super_block *sb,
1130                                 struct ext4_group_desc *bg);
1131 extern __u32 ext4_free_inodes_count(struct super_block *sb,
1132                                  struct ext4_group_desc *bg);
1133 extern __u32 ext4_used_dirs_count(struct super_block *sb,
1134                                 struct ext4_group_desc *bg);
1135 extern __u32 ext4_itable_unused_count(struct super_block *sb,
1136                                    struct ext4_group_desc *bg);
1137 extern void ext4_block_bitmap_set(struct super_block *sb,
1138                                   struct ext4_group_desc *bg, ext4_fsblk_t blk);
1139 extern void ext4_inode_bitmap_set(struct super_block *sb,
1140                                   struct ext4_group_desc *bg, ext4_fsblk_t blk);
1141 extern void ext4_inode_table_set(struct super_block *sb,
1142                                  struct ext4_group_desc *bg, ext4_fsblk_t blk);
1143 extern void ext4_free_blks_set(struct super_block *sb,
1144                                struct ext4_group_desc *bg, __u32 count);
1145 extern void ext4_free_inodes_set(struct super_block *sb,
1146                                 struct ext4_group_desc *bg, __u32 count);
1147 extern void ext4_used_dirs_set(struct super_block *sb,
1148                                 struct ext4_group_desc *bg, __u32 count);
1149 extern void ext4_itable_unused_set(struct super_block *sb,
1150                                    struct ext4_group_desc *bg, __u32 count);
1151
1152 static inline ext4_fsblk_t ext4_blocks_count(struct ext4_super_block *es)
1153 {
1154         return ((ext4_fsblk_t)le32_to_cpu(es->s_blocks_count_hi) << 32) |
1155                 le32_to_cpu(es->s_blocks_count_lo);
1156 }
1157
1158 static inline ext4_fsblk_t ext4_r_blocks_count(struct ext4_super_block *es)
1159 {
1160         return ((ext4_fsblk_t)le32_to_cpu(es->s_r_blocks_count_hi) << 32) |
1161                 le32_to_cpu(es->s_r_blocks_count_lo);
1162 }
1163
1164 static inline ext4_fsblk_t ext4_free_blocks_count(struct ext4_super_block *es)
1165 {
1166         return ((ext4_fsblk_t)le32_to_cpu(es->s_free_blocks_count_hi) << 32) |
1167                 le32_to_cpu(es->s_free_blocks_count_lo);
1168 }
1169
1170 static inline void ext4_blocks_count_set(struct ext4_super_block *es,
1171                                          ext4_fsblk_t blk)
1172 {
1173         es->s_blocks_count_lo = cpu_to_le32((u32)blk);
1174         es->s_blocks_count_hi = cpu_to_le32(blk >> 32);
1175 }
1176
1177 static inline void ext4_free_blocks_count_set(struct ext4_super_block *es,
1178                                               ext4_fsblk_t blk)
1179 {
1180         es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
1181         es->s_free_blocks_count_hi = cpu_to_le32(blk >> 32);
1182 }
1183
1184 static inline void ext4_r_blocks_count_set(struct ext4_super_block *es,
1185                                            ext4_fsblk_t blk)
1186 {
1187         es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
1188         es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
1189 }
1190
1191 static inline loff_t ext4_isize(struct ext4_inode *raw_inode)
1192 {
1193         if (S_ISREG(le16_to_cpu(raw_inode->i_mode)))
1194                 return ((loff_t)le32_to_cpu(raw_inode->i_size_high) << 32) |
1195                         le32_to_cpu(raw_inode->i_size_lo);
1196         else
1197                 return (loff_t) le32_to_cpu(raw_inode->i_size_lo);
1198 }
1199
1200 static inline void ext4_isize_set(struct ext4_inode *raw_inode, loff_t i_size)
1201 {
1202         raw_inode->i_size_lo = cpu_to_le32(i_size);
1203         raw_inode->i_size_high = cpu_to_le32(i_size >> 32);
1204 }
1205
1206 static inline
1207 struct ext4_group_info *ext4_get_group_info(struct super_block *sb,
1208                                             ext4_group_t group)
1209 {
1210          struct ext4_group_info ***grp_info;
1211          long indexv, indexh;
1212          grp_info = EXT4_SB(sb)->s_group_info;
1213          indexv = group >> (EXT4_DESC_PER_BLOCK_BITS(sb));
1214          indexh = group & ((EXT4_DESC_PER_BLOCK(sb)) - 1);
1215          return grp_info[indexv][indexh];
1216 }
1217
1218
1219 static inline ext4_group_t ext4_flex_group(struct ext4_sb_info *sbi,
1220                                              ext4_group_t block_group)
1221 {
1222         return block_group >> sbi->s_log_groups_per_flex;
1223 }
1224
1225 static inline unsigned int ext4_flex_bg_size(struct ext4_sb_info *sbi)
1226 {
1227         return 1 << sbi->s_log_groups_per_flex;
1228 }
1229
1230 #define ext4_std_error(sb, errno)                               \
1231 do {                                                            \
1232         if ((errno))                                            \
1233                 __ext4_std_error((sb), __func__, (errno));      \
1234 } while (0)
1235
1236 #ifdef CONFIG_SMP
1237 /* Each CPU can accumulate percpu_counter_batch blocks in their local
1238  * counters. So we need to make sure we have free blocks more
1239  * than percpu_counter_batch  * nr_cpu_ids. Also add a window of 4 times.
1240  */
1241 #define EXT4_FREEBLOCKS_WATERMARK (4 * (percpu_counter_batch * nr_cpu_ids))
1242 #else
1243 #define EXT4_FREEBLOCKS_WATERMARK 0
1244 #endif
1245
1246 static inline void ext4_update_i_disksize(struct inode *inode, loff_t newsize)
1247 {
1248         /*
1249          * XXX: replace with spinlock if seen contended -bzzz
1250          */
1251         down_write(&EXT4_I(inode)->i_data_sem);
1252         if (newsize > EXT4_I(inode)->i_disksize)
1253                 EXT4_I(inode)->i_disksize = newsize;
1254         up_write(&EXT4_I(inode)->i_data_sem);
1255         return ;
1256 }
1257
1258 struct ext4_group_info {
1259         unsigned long   bb_state;
1260         struct rb_root  bb_free_root;
1261         unsigned short  bb_first_free;
1262         unsigned short  bb_free;
1263         unsigned short  bb_fragments;
1264         struct          list_head bb_prealloc_list;
1265 #ifdef DOUBLE_CHECK
1266         void            *bb_bitmap;
1267 #endif
1268         struct rw_semaphore alloc_sem;
1269         unsigned short  bb_counters[];
1270 };
1271
1272 #define EXT4_GROUP_INFO_NEED_INIT_BIT   0
1273 #define EXT4_GROUP_INFO_LOCKED_BIT      1
1274
1275 #define EXT4_MB_GRP_NEED_INIT(grp)      \
1276         (test_bit(EXT4_GROUP_INFO_NEED_INIT_BIT, &((grp)->bb_state)))
1277
1278 static inline void ext4_lock_group(struct super_block *sb, ext4_group_t group)
1279 {
1280         struct ext4_group_info *grinfo = ext4_get_group_info(sb, group);
1281
1282         bit_spin_lock(EXT4_GROUP_INFO_LOCKED_BIT, &(grinfo->bb_state));
1283 }
1284
1285 static inline void ext4_unlock_group(struct super_block *sb,
1286                                         ext4_group_t group)
1287 {
1288         struct ext4_group_info *grinfo = ext4_get_group_info(sb, group);
1289
1290         bit_spin_unlock(EXT4_GROUP_INFO_LOCKED_BIT, &(grinfo->bb_state));
1291 }
1292
1293 static inline int ext4_is_group_locked(struct super_block *sb,
1294                                         ext4_group_t group)
1295 {
1296         struct ext4_group_info *grinfo = ext4_get_group_info(sb, group);
1297
1298         return bit_spin_is_locked(EXT4_GROUP_INFO_LOCKED_BIT,
1299                                                 &(grinfo->bb_state));
1300 }
1301
1302 /*
1303  * Inodes and files operations
1304  */
1305
1306 /* dir.c */
1307 extern const struct file_operations ext4_dir_operations;
1308
1309 /* file.c */
1310 extern const struct inode_operations ext4_file_inode_operations;
1311 extern const struct file_operations ext4_file_operations;
1312
1313 /* namei.c */
1314 extern const struct inode_operations ext4_dir_inode_operations;
1315 extern const struct inode_operations ext4_special_inode_operations;
1316
1317 /* symlink.c */
1318 extern const struct inode_operations ext4_symlink_inode_operations;
1319 extern const struct inode_operations ext4_fast_symlink_inode_operations;
1320
1321 /* extents.c */
1322 extern int ext4_ext_tree_init(handle_t *handle, struct inode *);
1323 extern int ext4_ext_writepage_trans_blocks(struct inode *, int);
1324 extern int ext4_ext_index_trans_blocks(struct inode *inode, int nrblocks,
1325                                        int chunk);
1326 extern int ext4_ext_get_blocks(handle_t *handle, struct inode *inode,
1327                                ext4_lblk_t iblock, unsigned int max_blocks,
1328                                struct buffer_head *bh_result,
1329                                int create, int extend_disksize);
1330 extern void ext4_ext_truncate(struct inode *);
1331 extern void ext4_ext_init(struct super_block *);
1332 extern void ext4_ext_release(struct super_block *);
1333 extern long ext4_fallocate(struct inode *inode, int mode, loff_t offset,
1334                           loff_t len);
1335 extern int ext4_get_blocks_wrap(handle_t *handle, struct inode *inode,
1336                         sector_t block, unsigned int max_blocks,
1337                         struct buffer_head *bh, int create,
1338                         int extend_disksize, int flag);
1339 extern int ext4_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
1340                         __u64 start, __u64 len);
1341
1342 /*
1343  * Add new method to test wether block and inode bitmaps are properly
1344  * initialized. With uninit_bg reading the block from disk is not enough
1345  * to mark the bitmap uptodate. We need to also zero-out the bitmap
1346  */
1347 #define BH_BITMAP_UPTODATE BH_JBDPrivateStart
1348
1349 static inline int bitmap_uptodate(struct buffer_head *bh)
1350 {
1351         return (buffer_uptodate(bh) &&
1352                         test_bit(BH_BITMAP_UPTODATE, &(bh)->b_state));
1353 }
1354 static inline void set_bitmap_uptodate(struct buffer_head *bh)
1355 {
1356         set_bit(BH_BITMAP_UPTODATE, &(bh)->b_state);
1357 }
1358
1359 #endif  /* __KERNEL__ */
1360
1361 #endif  /* _EXT4_H */