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