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