fs/f2fs/f2fs.h

   1 /*
   2  * fs/f2fs/f2fs.h
   3  *
   4  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   5  *             http://www.samsung.com/
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11 #ifndef _LINUX_F2FS_H
  12 #define _LINUX_F2FS_H
  13
  14 #include <linux/types.h>
  15 #include <linux/page-flags.h>
  16 #include <linux/buffer_head.h>
  17 #include <linux/slab.h>
  18 #include <linux/crc32.h>
  19 #include <linux/magic.h>
  20 #include <linux/kobject.h>
  21 #include <linux/sched.h>
  22
  23 #ifdef CONFIG_F2FS_CHECK_FS
  24 #define f2fs_bug_on(sbi, condition)     BUG_ON(condition)
  25 #define f2fs_down_write(x, y)   down_write_nest_lock(x, y)
  26 #else
  27 #define f2fs_bug_on(sbi, condition)                                     \
  28         do {                                                            \
  29                 if (unlikely(condition)) {                              \
  30                         WARN_ON(1);                                     \
  31                         sbi->need_fsck = true;                          \
  32                 }                                                       \
  33         } while (0)
  34 #define f2fs_down_write(x, y)   down_write(x)
  35 #endif
  36
  37 /*
  38  * For mount options
  39  */
  40 #define F2FS_MOUNT_BG_GC                0x00000001
  41 #define F2FS_MOUNT_DISABLE_ROLL_FORWARD 0x00000002
  42 #define F2FS_MOUNT_DISCARD              0x00000004
  43 #define F2FS_MOUNT_NOHEAP               0x00000008
  44 #define F2FS_MOUNT_XATTR_USER           0x00000010
  45 #define F2FS_MOUNT_POSIX_ACL            0x00000020
  46 #define F2FS_MOUNT_DISABLE_EXT_IDENTIFY 0x00000040
  47 #define F2FS_MOUNT_INLINE_XATTR         0x00000080
  48 #define F2FS_MOUNT_INLINE_DATA          0x00000100
  49 #define F2FS_MOUNT_INLINE_DENTRY        0x00000200
  50 #define F2FS_MOUNT_FLUSH_MERGE          0x00000400
  51 #define F2FS_MOUNT_NOBARRIER            0x00000800
  52 #define F2FS_MOUNT_FASTBOOT             0x00001000
  53
  54 #define clear_opt(sbi, option)  (sbi->mount_opt.opt &= ~F2FS_MOUNT_##option)
  55 #define set_opt(sbi, option)    (sbi->mount_opt.opt |= F2FS_MOUNT_##option)
  56 #define test_opt(sbi, option)   (sbi->mount_opt.opt & F2FS_MOUNT_##option)
  57
  58 #define ver_after(a, b) (typecheck(unsigned long long, a) &&            \
  59                 typecheck(unsigned long long, b) &&                     \
  60                 ((long long)((a) - (b)) > 0))
  61
  62 typedef u32 block_t;    /*
  63                          * should not change u32, since it is the on-disk block
  64                          * address format, __le32.
  65                          */
  66 typedef u32 nid_t;
  67
  68 struct f2fs_mount_info {
  69         unsigned int    opt;
  70 };
  71
  72 #define CRCPOLY_LE 0xedb88320
  73
  74 static inline __u32 f2fs_crc32(void *buf, size_t len)
  75 {
  76         unsigned char *p = (unsigned char *)buf;
  77         __u32 crc = F2FS_SUPER_MAGIC;
  78         int i;
  79
  80         while (len--) {
  81                 crc ^= *p++;
  82                 for (i = 0; i < 8; i++)
  83                         crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY_LE : 0);
  84         }
  85         return crc;
  86 }
  87
  88 static inline bool f2fs_crc_valid(__u32 blk_crc, void *buf, size_t buf_size)
  89 {
  90         return f2fs_crc32(buf, buf_size) == blk_crc;
  91 }
  92
  93 /*
  94  * For checkpoint manager
  95  */
  96 enum {
  97         NAT_BITMAP,
  98         SIT_BITMAP
  99 };
 100
 101 enum {
 102         CP_UMOUNT,
 103         CP_SYNC,
 104         CP_DISCARD,
 105 };
 106
 107 struct cp_control {
 108         int reason;
 109         __u64 trim_start;
 110         __u64 trim_end;
 111         __u64 trim_minlen;
 112         __u64 trimmed;
 113 };
 114
 115 /*
 116  * For CP/NAT/SIT/SSA readahead
 117  */
 118 enum {
 119         META_CP,
 120         META_NAT,
 121         META_SIT,
 122         META_SSA,
 123         META_POR,
 124 };
 125
 126 /* for the list of ino */
 127 enum {
 128         ORPHAN_INO,             /* for orphan ino list */
 129         APPEND_INO,             /* for append ino list */
 130         UPDATE_INO,             /* for update ino list */
 131         MAX_INO_ENTRY,          /* max. list */
 132 };
 133
 134 struct ino_entry {
 135         struct list_head list;  /* list head */
 136         nid_t ino;              /* inode number */
 137 };
 138
 139 /* for the list of directory inodes */
 140 struct dir_inode_entry {
 141         struct list_head list;  /* list head */
 142         struct inode *inode;    /* vfs inode pointer */
 143 };
 144
 145 /* for the list of blockaddresses to be discarded */
 146 struct discard_entry {
 147         struct list_head list;  /* list head */
 148         block_t blkaddr;        /* block address to be discarded */
 149         int len;                /* # of consecutive blocks of the discard */
 150 };
 151
 152 /* for the list of fsync inodes, used only during recovery */
 153 struct fsync_inode_entry {
 154         struct list_head list;  /* list head */
 155         struct inode *inode;    /* vfs inode pointer */
 156         block_t blkaddr;        /* block address locating the last fsync */
 157         block_t last_dentry;    /* block address locating the last dentry */
 158         block_t last_inode;     /* block address locating the last inode */
 159 };
 160
 161 #define nats_in_cursum(sum)             (le16_to_cpu(sum->n_nats))
 162 #define sits_in_cursum(sum)             (le16_to_cpu(sum->n_sits))
 163
 164 #define nat_in_journal(sum, i)          (sum->nat_j.entries[i].ne)
 165 #define nid_in_journal(sum, i)          (sum->nat_j.entries[i].nid)
 166 #define sit_in_journal(sum, i)          (sum->sit_j.entries[i].se)
 167 #define segno_in_journal(sum, i)        (sum->sit_j.entries[i].segno)
 168
 169 #define MAX_NAT_JENTRIES(sum)   (NAT_JOURNAL_ENTRIES - nats_in_cursum(sum))
 170 #define MAX_SIT_JENTRIES(sum)   (SIT_JOURNAL_ENTRIES - sits_in_cursum(sum))
 171
 172 static inline int update_nats_in_cursum(struct f2fs_summary_block *rs, int i)
 173 {
 174         int before = nats_in_cursum(rs);
 175         rs->n_nats = cpu_to_le16(before + i);
 176         return before;
 177 }
 178
 179 static inline int update_sits_in_cursum(struct f2fs_summary_block *rs, int i)
 180 {
 181         int before = sits_in_cursum(rs);
 182         rs->n_sits = cpu_to_le16(before + i);
 183         return before;
 184 }
 185
 186 static inline bool __has_cursum_space(struct f2fs_summary_block *sum, int size,
 187                                                                 int type)
 188 {
 189         if (type == NAT_JOURNAL)
 190                 return size <= MAX_NAT_JENTRIES(sum);
 191         return size <= MAX_SIT_JENTRIES(sum);
 192 }
 193
 194 /*
 195  * ioctl commands
 196  */
 197 #define F2FS_IOC_GETFLAGS               FS_IOC_GETFLAGS
 198 #define F2FS_IOC_SETFLAGS               FS_IOC_SETFLAGS
 199
 200 #define F2FS_IOCTL_MAGIC                0xf5
 201 #define F2FS_IOC_START_ATOMIC_WRITE     _IO(F2FS_IOCTL_MAGIC, 1)
 202 #define F2FS_IOC_COMMIT_ATOMIC_WRITE    _IO(F2FS_IOCTL_MAGIC, 2)
 203 #define F2FS_IOC_START_VOLATILE_WRITE   _IO(F2FS_IOCTL_MAGIC, 3)
 204
 205 #if defined(__KERNEL__) && defined(CONFIG_COMPAT)
 206 /*
 207  * ioctl commands in 32 bit emulation
 208  */
 209 #define F2FS_IOC32_GETFLAGS             FS_IOC32_GETFLAGS
 210 #define F2FS_IOC32_SETFLAGS             FS_IOC32_SETFLAGS
 211 #endif
 212
 213 /*
 214  * For INODE and NODE manager
 215  */
 216 /* for directory operations */
 217 struct f2fs_dentry_ptr {
 218         const void *bitmap;
 219         struct f2fs_dir_entry *dentry;
 220         __u8 (*filename)[F2FS_SLOT_LEN];
 221         int max;
 222 };
 223
 224 static inline void make_dentry_ptr(struct f2fs_dentry_ptr *d,
 225                                         void *src, int type)
 226 {
 227         if (type == 1) {
 228                 struct f2fs_dentry_block *t = (struct f2fs_dentry_block *)src;
 229                 d->max = NR_DENTRY_IN_BLOCK;
 230                 d->bitmap = &t->dentry_bitmap;
 231                 d->dentry = t->dentry;
 232                 d->filename = t->filename;
 233         } else {
 234                 struct f2fs_inline_dentry *t = (struct f2fs_inline_dentry *)src;
 235                 d->max = NR_INLINE_DENTRY;
 236                 d->bitmap = &t->dentry_bitmap;
 237                 d->dentry = t->dentry;
 238                 d->filename = t->filename;
 239         }
 240 }
 241
 242 /*
 243  * XATTR_NODE_OFFSET stores xattrs to one node block per file keeping -1
 244  * as its node offset to distinguish from index node blocks.
 245  * But some bits are used to mark the node block.
 246  */
 247 #define XATTR_NODE_OFFSET       ((((unsigned int)-1) << OFFSET_BIT_SHIFT) \
 248                                 >> OFFSET_BIT_SHIFT)
 249 enum {
 250         ALLOC_NODE,                     /* allocate a new node page if needed */
 251         LOOKUP_NODE,                    /* look up a node without readahead */
 252         LOOKUP_NODE_RA,                 /*
 253                                          * look up a node with readahead called
 254                                          * by get_data_block.
 255                                          */
 256 };
 257
 258 #define F2FS_LINK_MAX           32000   /* maximum link count per file */
 259
 260 #define MAX_DIR_RA_PAGES        4       /* maximum ra pages of dir */
 261
 262 /* for in-memory extent cache entry */
 263 #define F2FS_MIN_EXTENT_LEN     16      /* minimum extent length */
 264
 265 struct extent_info {
 266         rwlock_t ext_lock;      /* rwlock for consistency */
 267         unsigned int fofs;      /* start offset in a file */
 268         u32 blk_addr;           /* start block address of the extent */
 269         unsigned int len;       /* length of the extent */
 270 };
 271
 272 /*
 273  * i_advise uses FADVISE_XXX_BIT. We can add additional hints later.
 274  */
 275 #define FADVISE_COLD_BIT        0x01
 276 #define FADVISE_LOST_PINO_BIT   0x02
 277
 278 #define DEF_DIR_LEVEL           0
 279
 280 struct f2fs_inode_info {
 281         struct inode vfs_inode;         /* serve a vfs inode */
 282         unsigned long i_flags;          /* keep an inode flags for ioctl */
 283         unsigned char i_advise;         /* use to give file attribute hints */
 284         unsigned char i_dir_level;      /* use for dentry level for large dir */
 285         unsigned int i_current_depth;   /* use only in directory structure */
 286         unsigned int i_pino;            /* parent inode number */
 287         umode_t i_acl_mode;             /* keep file acl mode temporarily */
 288
 289         /* Use below internally in f2fs*/
 290         unsigned long flags;            /* use to pass per-file flags */
 291         struct rw_semaphore i_sem;      /* protect fi info */
 292         atomic_t dirty_pages;           /* # of dirty pages */
 293         f2fs_hash_t chash;              /* hash value of given file name */
 294         unsigned int clevel;            /* maximum level of given file name */
 295         nid_t i_xattr_nid;              /* node id that contains xattrs */
 296         unsigned long long xattr_ver;   /* cp version of xattr modification */
 297         struct extent_info ext;         /* in-memory extent cache entry */
 298         struct dir_inode_entry *dirty_dir;      /* the pointer of dirty dir */
 299
 300         struct radix_tree_root inmem_root;      /* radix tree for inmem pages */
 301         struct list_head inmem_pages;   /* inmemory pages managed by f2fs */
 302         struct mutex inmem_lock;        /* lock for inmemory pages */
 303 };
 304
 305 static inline void get_extent_info(struct extent_info *ext,
 306                                         struct f2fs_extent i_ext)
 307 {
 308         write_lock(&ext->ext_lock);
 309         ext->fofs = le32_to_cpu(i_ext.fofs);
 310         ext->blk_addr = le32_to_cpu(i_ext.blk_addr);
 311         ext->len = le32_to_cpu(i_ext.len);
 312         write_unlock(&ext->ext_lock);
 313 }
 314
 315 static inline void set_raw_extent(struct extent_info *ext,
 316                                         struct f2fs_extent *i_ext)
 317 {
 318         read_lock(&ext->ext_lock);
 319         i_ext->fofs = cpu_to_le32(ext->fofs);
 320         i_ext->blk_addr = cpu_to_le32(ext->blk_addr);
 321         i_ext->len = cpu_to_le32(ext->len);
 322         read_unlock(&ext->ext_lock);
 323 }
 324
 325 struct f2fs_nm_info {
 326         block_t nat_blkaddr;            /* base disk address of NAT */
 327         nid_t max_nid;                  /* maximum possible node ids */
 328         nid_t available_nids;           /* maximum available node ids */
 329         nid_t next_scan_nid;            /* the next nid to be scanned */
 330         unsigned int ram_thresh;        /* control the memory footprint */
 331
 332         /* NAT cache management */
 333         struct radix_tree_root nat_root;/* root of the nat entry cache */
 334         struct radix_tree_root nat_set_root;/* root of the nat set cache */
 335         rwlock_t nat_tree_lock;         /* protect nat_tree_lock */
 336         struct list_head nat_entries;   /* cached nat entry list (clean) */
 337         unsigned int nat_cnt;           /* the # of cached nat entries */
 338         unsigned int dirty_nat_cnt;     /* total num of nat entries in set */
 339
 340         /* free node ids management */
 341         struct radix_tree_root free_nid_root;/* root of the free_nid cache */
 342         struct list_head free_nid_list; /* a list for free nids */
 343         spinlock_t free_nid_list_lock;  /* protect free nid list */
 344         unsigned int fcnt;              /* the number of free node id */
 345         struct mutex build_lock;        /* lock for build free nids */
 346
 347         /* for checkpoint */
 348         char *nat_bitmap;               /* NAT bitmap pointer */
 349         int bitmap_size;                /* bitmap size */
 350 };
 351
 352 /*
 353  * this structure is used as one of function parameters.
 354  * all the information are dedicated to a given direct node block determined
 355  * by the data offset in a file.
 356  */
 357 struct dnode_of_data {
 358         struct inode *inode;            /* vfs inode pointer */
 359         struct page *inode_page;        /* its inode page, NULL is possible */
 360         struct page *node_page;         /* cached direct node page */
 361         nid_t nid;                      /* node id of the direct node block */
 362         unsigned int ofs_in_node;       /* data offset in the node page */
 363         bool inode_page_locked;         /* inode page is locked or not */
 364         block_t data_blkaddr;           /* block address of the node block */
 365 };
 366
 367 static inline void set_new_dnode(struct dnode_of_data *dn, struct inode *inode,
 368                 struct page *ipage, struct page *npage, nid_t nid)
 369 {
 370         memset(dn, 0, sizeof(*dn));
 371         dn->inode = inode;
 372         dn->inode_page = ipage;
 373         dn->node_page = npage;
 374         dn->nid = nid;
 375 }
 376
 377 /*
 378  * For SIT manager
 379  *
 380  * By default, there are 6 active log areas across the whole main area.
 381  * When considering hot and cold data separation to reduce cleaning overhead,
 382  * we split 3 for data logs and 3 for node logs as hot, warm, and cold types,
 383  * respectively.
 384  * In the current design, you should not change the numbers intentionally.
 385  * Instead, as a mount option such as active_logs=x, you can use 2, 4, and 6
 386  * logs individually according to the underlying devices. (default: 6)
 387  * Just in case, on-disk layout covers maximum 16 logs that consist of 8 for
 388  * data and 8 for node logs.
 389  */
 390 #define NR_CURSEG_DATA_TYPE     (3)
 391 #define NR_CURSEG_NODE_TYPE     (3)
 392 #define NR_CURSEG_TYPE  (NR_CURSEG_DATA_TYPE + NR_CURSEG_NODE_TYPE)
 393
 394 enum {
 395         CURSEG_HOT_DATA = 0,    /* directory entry blocks */
 396         CURSEG_WARM_DATA,       /* data blocks */
 397         CURSEG_COLD_DATA,       /* multimedia or GCed data blocks */
 398         CURSEG_HOT_NODE,        /* direct node blocks of directory files */
 399         CURSEG_WARM_NODE,       /* direct node blocks of normal files */
 400         CURSEG_COLD_NODE,       /* indirect node blocks */
 401         NO_CHECK_TYPE
 402 };
 403
 404 struct flush_cmd {
 405         struct completion wait;
 406         struct llist_node llnode;
 407         int ret;
 408 };
 409
 410 struct flush_cmd_control {
 411         struct task_struct *f2fs_issue_flush;   /* flush thread */
 412         wait_queue_head_t flush_wait_queue;     /* waiting queue for wake-up */
 413         struct llist_head issue_list;           /* list for command issue */
 414         struct llist_node *dispatch_list;       /* list for command dispatch */
 415 };
 416
 417 struct f2fs_sm_info {
 418         struct sit_info *sit_info;              /* whole segment information */
 419         struct free_segmap_info *free_info;     /* free segment information */
 420         struct dirty_seglist_info *dirty_info;  /* dirty segment information */
 421         struct curseg_info *curseg_array;       /* active segment information */
 422
 423         block_t seg0_blkaddr;           /* block address of 0'th segment */
 424         block_t main_blkaddr;           /* start block address of main area */
 425         block_t ssa_blkaddr;            /* start block address of SSA area */
 426
 427         unsigned int segment_count;     /* total # of segments */
 428         unsigned int main_segments;     /* # of segments in main area */
 429         unsigned int reserved_segments; /* # of reserved segments */
 430         unsigned int ovp_segments;      /* # of overprovision segments */
 431
 432         /* a threshold to reclaim prefree segments */
 433         unsigned int rec_prefree_segments;
 434
 435         /* for small discard management */
 436         struct list_head discard_list;          /* 4KB discard list */
 437         int nr_discards;                        /* # of discards in the list */
 438         int max_discards;                       /* max. discards to be issued */
 439
 440         struct list_head sit_entry_set; /* sit entry set list */
 441
 442         unsigned int ipu_policy;        /* in-place-update policy */
 443         unsigned int min_ipu_util;      /* in-place-update threshold */
 444         unsigned int min_fsync_blocks;  /* threshold for fsync */
 445
 446         /* for flush command control */
 447         struct flush_cmd_control *cmd_control_info;
 448
 449 };
 450
 451 /*
 452  * For superblock
 453  */
 454 /*
 455  * COUNT_TYPE for monitoring
 456  *
 457  * f2fs monitors the number of several block types such as on-writeback,
 458  * dirty dentry blocks, dirty node blocks, and dirty meta blocks.
 459  */
 460 enum count_type {
 461         F2FS_WRITEBACK,
 462         F2FS_DIRTY_DENTS,
 463         F2FS_DIRTY_NODES,
 464         F2FS_DIRTY_META,
 465         NR_COUNT_TYPE,
 466 };
 467
 468 /*
 469  * The below are the page types of bios used in submit_bio().
 470  * The available types are:
 471  * DATA                 User data pages. It operates as async mode.
 472  * NODE                 Node pages. It operates as async mode.
 473  * META                 FS metadata pages such as SIT, NAT, CP.
 474  * NR_PAGE_TYPE         The number of page types.
 475  * META_FLUSH           Make sure the previous pages are written
 476  *                      with waiting the bio's completion
 477  * ...                  Only can be used with META.
 478  */
 479 #define PAGE_TYPE_OF_BIO(type)  ((type) > META ? META : (type))
 480 enum page_type {
 481         DATA,
 482         NODE,
 483         META,
 484         NR_PAGE_TYPE,
 485         META_FLUSH,
 486 };
 487
 488 struct f2fs_io_info {
 489         enum page_type type;    /* contains DATA/NODE/META/META_FLUSH */
 490         int rw;                 /* contains R/RS/W/WS with REQ_META/REQ_PRIO */
 491 };
 492
 493 #define is_read_io(rw)  (((rw) & 1) == READ)
 494 struct f2fs_bio_info {
 495         struct f2fs_sb_info *sbi;       /* f2fs superblock */
 496         struct bio *bio;                /* bios to merge */
 497         sector_t last_block_in_bio;     /* last block number */
 498         struct f2fs_io_info fio;        /* store buffered io info. */
 499         struct rw_semaphore io_rwsem;   /* blocking op for bio */
 500 };
 501
 502 /* for inner inode cache management */
 503 struct inode_management {
 504         struct radix_tree_root ino_root;        /* ino entry array */
 505         spinlock_t ino_lock;                    /* for ino entry lock */
 506         struct list_head ino_list;              /* inode list head */
 507         unsigned long ino_num;                  /* number of entries */
 508 };
 509
 510 struct f2fs_sb_info {
 511         struct super_block *sb;                 /* pointer to VFS super block */
 512         struct proc_dir_entry *s_proc;          /* proc entry */
 513         struct buffer_head *raw_super_buf;      /* buffer head of raw sb */
 514         struct f2fs_super_block *raw_super;     /* raw super block pointer */
 515         int s_dirty;                            /* dirty flag for checkpoint */
 516         bool need_fsck;                         /* need fsck.f2fs to fix */
 517
 518         /* for node-related operations */
 519         struct f2fs_nm_info *nm_info;           /* node manager */
 520         struct inode *node_inode;               /* cache node blocks */
 521
 522         /* for segment-related operations */
 523         struct f2fs_sm_info *sm_info;           /* segment manager */
 524
 525         /* for bio operations */
 526         struct f2fs_bio_info read_io;                   /* for read bios */
 527         struct f2fs_bio_info write_io[NR_PAGE_TYPE];    /* for write bios */
 528
 529         /* for checkpoint */
 530         struct f2fs_checkpoint *ckpt;           /* raw checkpoint pointer */
 531         struct inode *meta_inode;               /* cache meta blocks */
 532         struct mutex cp_mutex;                  /* checkpoint procedure lock */
 533         struct rw_semaphore cp_rwsem;           /* blocking FS operations */
 534         struct rw_semaphore node_write;         /* locking node writes */
 535         struct mutex writepages;                /* mutex for writepages() */
 536         bool por_doing;                         /* recovery is doing or not */
 537         wait_queue_head_t cp_wait;
 538
 539         struct inode_management im[MAX_INO_ENTRY];      /* manage inode cache */
 540
 541         /* for orphan inode, use 0'th array */
 542         unsigned int max_orphans;               /* max orphan inodes */
 543
 544         /* for directory inode management */
 545         struct list_head dir_inode_list;        /* dir inode list */
 546         spinlock_t dir_inode_lock;              /* for dir inode list lock */
 547
 548         /* basic filesystem units */
 549         unsigned int log_sectors_per_block;     /* log2 sectors per block */
 550         unsigned int log_blocksize;             /* log2 block size */
 551         unsigned int blocksize;                 /* block size */
 552         unsigned int root_ino_num;              /* root inode number*/
 553         unsigned int node_ino_num;              /* node inode number*/
 554         unsigned int meta_ino_num;              /* meta inode number*/
 555         unsigned int log_blocks_per_seg;        /* log2 blocks per segment */
 556         unsigned int blocks_per_seg;            /* blocks per segment */
 557         unsigned int segs_per_sec;              /* segments per section */
 558         unsigned int secs_per_zone;             /* sections per zone */
 559         unsigned int total_sections;            /* total section count */
 560         unsigned int total_node_count;          /* total node block count */
 561         unsigned int total_valid_node_count;    /* valid node block count */
 562         unsigned int total_valid_inode_count;   /* valid inode count */
 563         int active_logs;                        /* # of active logs */
 564         int dir_level;                          /* directory level */
 565
 566         block_t user_block_count;               /* # of user blocks */
 567         block_t total_valid_block_count;        /* # of valid blocks */
 568         block_t alloc_valid_block_count;        /* # of allocated blocks */
 569         block_t last_valid_block_count;         /* for recovery */
 570         u32 s_next_generation;                  /* for NFS support */
 571         atomic_t nr_pages[NR_COUNT_TYPE];       /* # of pages, see count_type */
 572
 573         struct f2fs_mount_info mount_opt;       /* mount options */
 574
 575         /* for cleaning operations */
 576         struct mutex gc_mutex;                  /* mutex for GC */
 577         struct f2fs_gc_kthread  *gc_thread;     /* GC thread */
 578         unsigned int cur_victim_sec;            /* current victim section num */
 579
 580         /* maximum # of trials to find a victim segment for SSR and GC */
 581         unsigned int max_victim_search;
 582
 583         /*
 584          * for stat information.
 585          * one is for the LFS mode, and the other is for the SSR mode.
 586          */
 587 #ifdef CONFIG_F2FS_STAT_FS
 588         struct f2fs_stat_info *stat_info;       /* FS status information */
 589         unsigned int segment_count[2];          /* # of allocated segments */
 590         unsigned int block_count[2];            /* # of allocated blocks */
 591         int total_hit_ext, read_hit_ext;        /* extent cache hit ratio */
 592         int inline_inode;                       /* # of inline_data inodes */
 593         int inline_dir;                         /* # of inline_dentry inodes */
 594         int bg_gc;                              /* background gc calls */
 595         unsigned int n_dirty_dirs;              /* # of dir inodes */
 596 #endif
 597         unsigned int last_victim[2];            /* last victim segment # */
 598         spinlock_t stat_lock;                   /* lock for stat operations */
 599
 600         /* For sysfs suppport */
 601         struct kobject s_kobj;
 602         struct completion s_kobj_unregister;
 603 };
 604
 605 /*
 606  * Inline functions
 607  */
 608 static inline struct f2fs_inode_info *F2FS_I(struct inode *inode)
 609 {
 610         return container_of(inode, struct f2fs_inode_info, vfs_inode);
 611 }
 612
 613 static inline struct f2fs_sb_info *F2FS_SB(struct super_block *sb)
 614 {
 615         return sb->s_fs_info;
 616 }
 617
 618 static inline struct f2fs_sb_info *F2FS_I_SB(struct inode *inode)
 619 {
 620         return F2FS_SB(inode->i_sb);
 621 }
 622
 623 static inline struct f2fs_sb_info *F2FS_M_SB(struct address_space *mapping)
 624 {
 625         return F2FS_I_SB(mapping->host);
 626 }
 627
 628 static inline struct f2fs_sb_info *F2FS_P_SB(struct page *page)
 629 {
 630         return F2FS_M_SB(page->mapping);
 631 }
 632
 633 static inline struct f2fs_super_block *F2FS_RAW_SUPER(struct f2fs_sb_info *sbi)
 634 {
 635         return (struct f2fs_super_block *)(sbi->raw_super);
 636 }
 637
 638 static inline struct f2fs_checkpoint *F2FS_CKPT(struct f2fs_sb_info *sbi)
 639 {
 640         return (struct f2fs_checkpoint *)(sbi->ckpt);
 641 }
 642
 643 static inline struct f2fs_node *F2FS_NODE(struct page *page)
 644 {
 645         return (struct f2fs_node *)page_address(page);
 646 }
 647
 648 static inline struct f2fs_inode *F2FS_INODE(struct page *page)
 649 {
 650         return &((struct f2fs_node *)page_address(page))->i;
 651 }
 652
 653 static inline struct f2fs_nm_info *NM_I(struct f2fs_sb_info *sbi)
 654 {
 655         return (struct f2fs_nm_info *)(sbi->nm_info);
 656 }
 657
 658 static inline struct f2fs_sm_info *SM_I(struct f2fs_sb_info *sbi)
 659 {
 660         return (struct f2fs_sm_info *)(sbi->sm_info);
 661 }
 662
 663 static inline struct sit_info *SIT_I(struct f2fs_sb_info *sbi)
 664 {
 665         return (struct sit_info *)(SM_I(sbi)->sit_info);
 666 }
 667
 668 static inline struct free_segmap_info *FREE_I(struct f2fs_sb_info *sbi)
 669 {
 670         return (struct free_segmap_info *)(SM_I(sbi)->free_info);
 671 }
 672
 673 static inline struct dirty_seglist_info *DIRTY_I(struct f2fs_sb_info *sbi)
 674 {
 675         return (struct dirty_seglist_info *)(SM_I(sbi)->dirty_info);
 676 }
 677
 678 static inline struct address_space *META_MAPPING(struct f2fs_sb_info *sbi)
 679 {
 680         return sbi->meta_inode->i_mapping;
 681 }
 682
 683 static inline struct address_space *NODE_MAPPING(struct f2fs_sb_info *sbi)
 684 {
 685         return sbi->node_inode->i_mapping;
 686 }
 687
 688 static inline void F2FS_SET_SB_DIRT(struct f2fs_sb_info *sbi)
 689 {
 690         sbi->s_dirty = 1;
 691 }
 692
 693 static inline void F2FS_RESET_SB_DIRT(struct f2fs_sb_info *sbi)
 694 {
 695         sbi->s_dirty = 0;
 696 }
 697
 698 static inline unsigned long long cur_cp_version(struct f2fs_checkpoint *cp)
 699 {
 700         return le64_to_cpu(cp->checkpoint_ver);
 701 }
 702
 703 static inline bool is_set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
 704 {
 705         unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
 706         return ckpt_flags & f;
 707 }
 708
 709 static inline void set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
 710 {
 711         unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
 712         ckpt_flags |= f;
 713         cp->ckpt_flags = cpu_to_le32(ckpt_flags);
 714 }
 715
 716 static inline void clear_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
 717 {
 718         unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
 719         ckpt_flags &= (~f);
 720         cp->ckpt_flags = cpu_to_le32(ckpt_flags);
 721 }
 722
 723 static inline void f2fs_lock_op(struct f2fs_sb_info *sbi)
 724 {
 725         down_read(&sbi->cp_rwsem);
 726 }
 727
 728 static inline void f2fs_unlock_op(struct f2fs_sb_info *sbi)
 729 {
 730         up_read(&sbi->cp_rwsem);
 731 }
 732
 733 static inline void f2fs_lock_all(struct f2fs_sb_info *sbi)
 734 {
 735         f2fs_down_write(&sbi->cp_rwsem, &sbi->cp_mutex);
 736 }
 737
 738 static inline void f2fs_unlock_all(struct f2fs_sb_info *sbi)
 739 {
 740         up_write(&sbi->cp_rwsem);
 741 }
 742
 743 /*
 744  * Check whether the given nid is within node id range.
 745  */
 746 static inline int check_nid_range(struct f2fs_sb_info *sbi, nid_t nid)
 747 {
 748         if (unlikely(nid < F2FS_ROOT_INO(sbi)))
 749                 return -EINVAL;
 750         if (unlikely(nid >= NM_I(sbi)->max_nid))
 751                 return -EINVAL;
 752         return 0;
 753 }
 754
 755 #define F2FS_DEFAULT_ALLOCATED_BLOCKS   1
 756
 757 /*
 758  * Check whether the inode has blocks or not
 759  */
 760 static inline int F2FS_HAS_BLOCKS(struct inode *inode)
 761 {
 762         if (F2FS_I(inode)->i_xattr_nid)
 763                 return inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS + 1;
 764         else
 765                 return inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS;
 766 }
 767
 768 static inline bool f2fs_has_xattr_block(unsigned int ofs)
 769 {
 770         return ofs == XATTR_NODE_OFFSET;
 771 }
 772
 773 static inline bool inc_valid_block_count(struct f2fs_sb_info *sbi,
 774                                  struct inode *inode, blkcnt_t count)
 775 {
 776         block_t valid_block_count;
 777
 778         spin_lock(&sbi->stat_lock);
 779         valid_block_count =
 780                 sbi->total_valid_block_count + (block_t)count;
 781         if (unlikely(valid_block_count > sbi->user_block_count)) {
 782                 spin_unlock(&sbi->stat_lock);
 783                 return false;
 784         }
 785         inode->i_blocks += count;
 786         sbi->total_valid_block_count = valid_block_count;
 787         sbi->alloc_valid_block_count += (block_t)count;
 788         spin_unlock(&sbi->stat_lock);
 789         return true;
 790 }
 791
 792 static inline void dec_valid_block_count(struct f2fs_sb_info *sbi,
 793                                                 struct inode *inode,
 794                                                 blkcnt_t count)
 795 {
 796         spin_lock(&sbi->stat_lock);
 797         f2fs_bug_on(sbi, sbi->total_valid_block_count < (block_t) count);
 798         f2fs_bug_on(sbi, inode->i_blocks < count);
 799         inode->i_blocks -= count;
 800         sbi->total_valid_block_count -= (block_t)count;
 801         spin_unlock(&sbi->stat_lock);
 802 }
 803
 804 static inline void inc_page_count(struct f2fs_sb_info *sbi, int count_type)
 805 {
 806         atomic_inc(&sbi->nr_pages[count_type]);
 807         F2FS_SET_SB_DIRT(sbi);
 808 }
 809
 810 static inline void inode_inc_dirty_pages(struct inode *inode)
 811 {
 812         atomic_inc(&F2FS_I(inode)->dirty_pages);
 813         if (S_ISDIR(inode->i_mode))
 814                 inc_page_count(F2FS_I_SB(inode), F2FS_DIRTY_DENTS);
 815 }
 816
 817 static inline void dec_page_count(struct f2fs_sb_info *sbi, int count_type)
 818 {
 819         atomic_dec(&sbi->nr_pages[count_type]);
 820 }
 821
 822 static inline void inode_dec_dirty_pages(struct inode *inode)
 823 {
 824         if (!S_ISDIR(inode->i_mode) && !S_ISREG(inode->i_mode))
 825                 return;
 826
 827         atomic_dec(&F2FS_I(inode)->dirty_pages);
 828
 829         if (S_ISDIR(inode->i_mode))
 830                 dec_page_count(F2FS_I_SB(inode), F2FS_DIRTY_DENTS);
 831 }
 832
 833 static inline int get_pages(struct f2fs_sb_info *sbi, int count_type)
 834 {
 835         return atomic_read(&sbi->nr_pages[count_type]);
 836 }
 837
 838 static inline int get_dirty_pages(struct inode *inode)
 839 {
 840         return atomic_read(&F2FS_I(inode)->dirty_pages);
 841 }
 842
 843 static inline int get_blocktype_secs(struct f2fs_sb_info *sbi, int block_type)
 844 {
 845         unsigned int pages_per_sec = sbi->segs_per_sec *
 846                                         (1 << sbi->log_blocks_per_seg);
 847         return ((get_pages(sbi, block_type) + pages_per_sec - 1)
 848                         >> sbi->log_blocks_per_seg) / sbi->segs_per_sec;
 849 }
 850
 851 static inline block_t valid_user_blocks(struct f2fs_sb_info *sbi)
 852 {
 853         return sbi->total_valid_block_count;
 854 }
 855
 856 static inline unsigned long __bitmap_size(struct f2fs_sb_info *sbi, int flag)
 857 {
 858         struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
 859
 860         /* return NAT or SIT bitmap */
 861         if (flag == NAT_BITMAP)
 862                 return le32_to_cpu(ckpt->nat_ver_bitmap_bytesize);
 863         else if (flag == SIT_BITMAP)
 864                 return le32_to_cpu(ckpt->sit_ver_bitmap_bytesize);
 865
 866         return 0;
 867 }
 868
 869 static inline void *__bitmap_ptr(struct f2fs_sb_info *sbi, int flag)
 870 {
 871         struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
 872         int offset;
 873
 874         if (le32_to_cpu(F2FS_RAW_SUPER(sbi)->cp_payload) > 0) {
 875                 if (flag == NAT_BITMAP)
 876                         return &ckpt->sit_nat_version_bitmap;
 877                 else
 878                         return (unsigned char *)ckpt + F2FS_BLKSIZE;
 879         } else {
 880                 offset = (flag == NAT_BITMAP) ?
 881                         le32_to_cpu(ckpt->sit_ver_bitmap_bytesize) : 0;
 882                 return &ckpt->sit_nat_version_bitmap + offset;
 883         }
 884 }
 885
 886 static inline block_t __start_cp_addr(struct f2fs_sb_info *sbi)
 887 {
 888         block_t start_addr;
 889         struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
 890         unsigned long long ckpt_version = cur_cp_version(ckpt);
 891
 892         start_addr = le32_to_cpu(F2FS_RAW_SUPER(sbi)->cp_blkaddr);
 893
 894         /*
 895          * odd numbered checkpoint should at cp segment 0
 896          * and even segment must be at cp segment 1
 897          */
 898         if (!(ckpt_version & 1))
 899                 start_addr += sbi->blocks_per_seg;
 900
 901         return start_addr;
 902 }
 903
 904 static inline block_t __start_sum_addr(struct f2fs_sb_info *sbi)
 905 {
 906         return le32_to_cpu(F2FS_CKPT(sbi)->cp_pack_start_sum);
 907 }
 908
 909 static inline bool inc_valid_node_count(struct f2fs_sb_info *sbi,
 910                                                 struct inode *inode)
 911 {
 912         block_t valid_block_count;
 913         unsigned int valid_node_count;
 914
 915         spin_lock(&sbi->stat_lock);
 916
 917         valid_block_count = sbi->total_valid_block_count + 1;
 918         if (unlikely(valid_block_count > sbi->user_block_count)) {
 919                 spin_unlock(&sbi->stat_lock);
 920                 return false;
 921         }
 922
 923         valid_node_count = sbi->total_valid_node_count + 1;
 924         if (unlikely(valid_node_count > sbi->total_node_count)) {
 925                 spin_unlock(&sbi->stat_lock);
 926                 return false;
 927         }
 928
 929         if (inode)
 930                 inode->i_blocks++;
 931
 932         sbi->alloc_valid_block_count++;
 933         sbi->total_valid_node_count++;
 934         sbi->total_valid_block_count++;
 935         spin_unlock(&sbi->stat_lock);
 936
 937         return true;
 938 }
 939
 940 static inline void dec_valid_node_count(struct f2fs_sb_info *sbi,
 941                                                 struct inode *inode)
 942 {
 943         spin_lock(&sbi->stat_lock);
 944
 945         f2fs_bug_on(sbi, !sbi->total_valid_block_count);
 946         f2fs_bug_on(sbi, !sbi->total_valid_node_count);
 947         f2fs_bug_on(sbi, !inode->i_blocks);
 948
 949         inode->i_blocks--;
 950         sbi->total_valid_node_count--;
 951         sbi->total_valid_block_count--;
 952
 953         spin_unlock(&sbi->stat_lock);
 954 }
 955
 956 static inline unsigned int valid_node_count(struct f2fs_sb_info *sbi)
 957 {
 958         return sbi->total_valid_node_count;
 959 }
 960
 961 static inline void inc_valid_inode_count(struct f2fs_sb_info *sbi)
 962 {
 963         spin_lock(&sbi->stat_lock);
 964         f2fs_bug_on(sbi, sbi->total_valid_inode_count == sbi->total_node_count);
 965         sbi->total_valid_inode_count++;
 966         spin_unlock(&sbi->stat_lock);
 967 }
 968
 969 static inline void dec_valid_inode_count(struct f2fs_sb_info *sbi)
 970 {
 971         spin_lock(&sbi->stat_lock);
 972         f2fs_bug_on(sbi, !sbi->total_valid_inode_count);
 973         sbi->total_valid_inode_count--;
 974         spin_unlock(&sbi->stat_lock);
 975 }
 976
 977 static inline unsigned int valid_inode_count(struct f2fs_sb_info *sbi)
 978 {
 979         return sbi->total_valid_inode_count;
 980 }
 981
 982 static inline void f2fs_put_page(struct page *page, int unlock)
 983 {
 984         if (!page)
 985                 return;
 986
 987         if (unlock) {
 988                 f2fs_bug_on(F2FS_P_SB(page), !PageLocked(page));
 989                 unlock_page(page);
 990         }
 991         page_cache_release(page);
 992 }
 993
 994 static inline void f2fs_put_dnode(struct dnode_of_data *dn)
 995 {
 996         if (dn->node_page)
 997                 f2fs_put_page(dn->node_page, 1);
 998         if (dn->inode_page && dn->node_page != dn->inode_page)
 999                 f2fs_put_page(dn->inode_page, 0);
1000         dn->node_page = NULL;
1001         dn->inode_page = NULL;
1002 }
1003
1004 static inline struct kmem_cache *f2fs_kmem_cache_create(const char *name,
1005                                         size_t size)
1006 {
1007         return kmem_cache_create(name, size, 0, SLAB_RECLAIM_ACCOUNT, NULL);
1008 }
1009
1010 static inline void *f2fs_kmem_cache_alloc(struct kmem_cache *cachep,
1011                                                 gfp_t flags)
1012 {
1013         void *entry;
1014 retry:
1015         entry = kmem_cache_alloc(cachep, flags);
1016         if (!entry) {
1017                 cond_resched();
1018                 goto retry;
1019         }
1020
1021         return entry;
1022 }
1023
1024 #define RAW_IS_INODE(p) ((p)->footer.nid == (p)->footer.ino)
1025
1026 static inline bool IS_INODE(struct page *page)
1027 {
1028         struct f2fs_node *p = F2FS_NODE(page);
1029         return RAW_IS_INODE(p);
1030 }
1031
1032 static inline __le32 *blkaddr_in_node(struct f2fs_node *node)
1033 {
1034         return RAW_IS_INODE(node) ? node->i.i_addr : node->dn.addr;
1035 }
1036
1037 static inline block_t datablock_addr(struct page *node_page,
1038                 unsigned int offset)
1039 {
1040         struct f2fs_node *raw_node;
1041         __le32 *addr_array;
1042         raw_node = F2FS_NODE(node_page);
1043         addr_array = blkaddr_in_node(raw_node);
1044         return le32_to_cpu(addr_array[offset]);
1045 }
1046
1047 static inline int f2fs_test_bit(unsigned int nr, char *addr)
1048 {
1049         int mask;
1050
1051         addr += (nr >> 3);
1052         mask = 1 << (7 - (nr & 0x07));
1053         return mask & *addr;
1054 }
1055
1056 static inline int f2fs_test_and_set_bit(unsigned int nr, char *addr)
1057 {
1058         int mask;
1059         int ret;
1060
1061         addr += (nr >> 3);
1062         mask = 1 << (7 - (nr & 0x07));
1063         ret = mask & *addr;
1064         *addr |= mask;
1065         return ret;
1066 }
1067
1068 static inline int f2fs_test_and_clear_bit(unsigned int nr, char *addr)
1069 {
1070         int mask;
1071         int ret;
1072
1073         addr += (nr >> 3);
1074         mask = 1 << (7 - (nr & 0x07));
1075         ret = mask & *addr;
1076         *addr &= ~mask;
1077         return ret;
1078 }
1079
1080 static inline void f2fs_change_bit(unsigned int nr, char *addr)
1081 {
1082         int mask;
1083
1084         addr += (nr >> 3);
1085         mask = 1 << (7 - (nr & 0x07));
1086         *addr ^= mask;
1087 }
1088
1089 /* used for f2fs_inode_info->flags */
1090 enum {
1091         FI_NEW_INODE,           /* indicate newly allocated inode */
1092         FI_DIRTY_INODE,         /* indicate inode is dirty or not */
1093         FI_DIRTY_DIR,           /* indicate directory has dirty pages */
1094         FI_INC_LINK,            /* need to increment i_nlink */
1095         FI_ACL_MODE,            /* indicate acl mode */
1096         FI_NO_ALLOC,            /* should not allocate any blocks */
1097         FI_UPDATE_DIR,          /* should update inode block for consistency */
1098         FI_DELAY_IPUT,          /* used for the recovery */
1099         FI_NO_EXTENT,           /* not to use the extent cache */
1100         FI_INLINE_XATTR,        /* used for inline xattr */
1101         FI_INLINE_DATA,         /* used for inline data*/
1102         FI_INLINE_DENTRY,       /* used for inline dentry */
1103         FI_APPEND_WRITE,        /* inode has appended data */
1104         FI_UPDATE_WRITE,        /* inode has in-place-update data */
1105         FI_NEED_IPU,            /* used for ipu per file */
1106         FI_ATOMIC_FILE,         /* indicate atomic file */
1107         FI_VOLATILE_FILE,       /* indicate volatile file */
1108         FI_DATA_EXIST,          /* indicate data exists */
1109 };
1110
1111 static inline void set_inode_flag(struct f2fs_inode_info *fi, int flag)
1112 {
1113         if (!test_bit(flag, &fi->flags))
1114                 set_bit(flag, &fi->flags);
1115 }
1116
1117 static inline int is_inode_flag_set(struct f2fs_inode_info *fi, int flag)
1118 {
1119         return test_bit(flag, &fi->flags);
1120 }
1121
1122 static inline void clear_inode_flag(struct f2fs_inode_info *fi, int flag)
1123 {
1124         if (test_bit(flag, &fi->flags))
1125                 clear_bit(flag, &fi->flags);
1126 }
1127
1128 static inline void set_acl_inode(struct f2fs_inode_info *fi, umode_t mode)
1129 {
1130         fi->i_acl_mode = mode;
1131         set_inode_flag(fi, FI_ACL_MODE);
1132 }
1133
1134 static inline void get_inline_info(struct f2fs_inode_info *fi,
1135                                         struct f2fs_inode *ri)
1136 {
1137         if (ri->i_inline & F2FS_INLINE_XATTR)
1138                 set_inode_flag(fi, FI_INLINE_XATTR);
1139         if (ri->i_inline & F2FS_INLINE_DATA)
1140                 set_inode_flag(fi, FI_INLINE_DATA);
1141         if (ri->i_inline & F2FS_INLINE_DENTRY)
1142                 set_inode_flag(fi, FI_INLINE_DENTRY);
1143         if (ri->i_inline & F2FS_DATA_EXIST)
1144                 set_inode_flag(fi, FI_DATA_EXIST);
1145 }
1146
1147 static inline void set_raw_inline(struct f2fs_inode_info *fi,
1148                                         struct f2fs_inode *ri)
1149 {
1150         ri->i_inline = 0;
1151
1152         if (is_inode_flag_set(fi, FI_INLINE_XATTR))
1153                 ri->i_inline |= F2FS_INLINE_XATTR;
1154         if (is_inode_flag_set(fi, FI_INLINE_DATA))
1155                 ri->i_inline |= F2FS_INLINE_DATA;
1156         if (is_inode_flag_set(fi, FI_INLINE_DENTRY))
1157                 ri->i_inline |= F2FS_INLINE_DENTRY;
1158         if (is_inode_flag_set(fi, FI_DATA_EXIST))
1159                 ri->i_inline |= F2FS_DATA_EXIST;
1160 }
1161
1162 static inline int f2fs_has_inline_xattr(struct inode *inode)
1163 {
1164         return is_inode_flag_set(F2FS_I(inode), FI_INLINE_XATTR);
1165 }
1166
1167 static inline unsigned int addrs_per_inode(struct f2fs_inode_info *fi)
1168 {
1169         if (f2fs_has_inline_xattr(&fi->vfs_inode))
1170                 return DEF_ADDRS_PER_INODE - F2FS_INLINE_XATTR_ADDRS;
1171         return DEF_ADDRS_PER_INODE;
1172 }
1173
1174 static inline void *inline_xattr_addr(struct page *page)
1175 {
1176         struct f2fs_inode *ri = F2FS_INODE(page);
1177         return (void *)&(ri->i_addr[DEF_ADDRS_PER_INODE -
1178                                         F2FS_INLINE_XATTR_ADDRS]);
1179 }
1180
1181 static inline int inline_xattr_size(struct inode *inode)
1182 {
1183         if (f2fs_has_inline_xattr(inode))
1184                 return F2FS_INLINE_XATTR_ADDRS << 2;
1185         else
1186                 return 0;
1187 }
1188
1189 static inline int f2fs_has_inline_data(struct inode *inode)
1190 {
1191         return is_inode_flag_set(F2FS_I(inode), FI_INLINE_DATA);
1192 }
1193
1194 static inline void f2fs_clear_inline_inode(struct inode *inode)
1195 {
1196         clear_inode_flag(F2FS_I(inode), FI_INLINE_DATA);
1197         clear_inode_flag(F2FS_I(inode), FI_DATA_EXIST);
1198 }
1199
1200 static inline int f2fs_exist_data(struct inode *inode)
1201 {
1202         return is_inode_flag_set(F2FS_I(inode), FI_DATA_EXIST);
1203 }
1204
1205 static inline bool f2fs_is_atomic_file(struct inode *inode)
1206 {
1207         return is_inode_flag_set(F2FS_I(inode), FI_ATOMIC_FILE);
1208 }
1209
1210 static inline bool f2fs_is_volatile_file(struct inode *inode)
1211 {
1212         return is_inode_flag_set(F2FS_I(inode), FI_VOLATILE_FILE);
1213 }
1214
1215 static inline void *inline_data_addr(struct page *page)
1216 {
1217         struct f2fs_inode *ri = F2FS_INODE(page);
1218         return (void *)&(ri->i_addr[1]);
1219 }
1220
1221 static inline int f2fs_has_inline_dentry(struct inode *inode)
1222 {
1223         return is_inode_flag_set(F2FS_I(inode), FI_INLINE_DENTRY);
1224 }
1225
1226 static inline void *inline_dentry_addr(struct page *page)
1227 {
1228         struct f2fs_inode *ri = F2FS_INODE(page);
1229         return (void *)&(ri->i_addr[1]);
1230 }
1231
1232 static inline void f2fs_dentry_kunmap(struct inode *dir, struct page *page)
1233 {
1234         if (!f2fs_has_inline_dentry(dir))
1235                 kunmap(page);
1236 }
1237
1238 static inline int f2fs_readonly(struct super_block *sb)
1239 {
1240         return sb->s_flags & MS_RDONLY;
1241 }
1242
1243 static inline bool f2fs_cp_error(struct f2fs_sb_info *sbi)
1244 {
1245         return is_set_ckpt_flags(sbi->ckpt, CP_ERROR_FLAG);
1246 }
1247
1248 static inline void f2fs_stop_checkpoint(struct f2fs_sb_info *sbi)
1249 {
1250         set_ckpt_flags(sbi->ckpt, CP_ERROR_FLAG);
1251         sbi->sb->s_flags |= MS_RDONLY;
1252 }
1253
1254 #define get_inode_mode(i) \
1255         ((is_inode_flag_set(F2FS_I(i), FI_ACL_MODE)) ? \
1256          (F2FS_I(i)->i_acl_mode) : ((i)->i_mode))
1257
1258 /* get offset of first page in next direct node */
1259 #define PGOFS_OF_NEXT_DNODE(pgofs, fi)                          \
1260         ((pgofs < ADDRS_PER_INODE(fi)) ? ADDRS_PER_INODE(fi) :  \
1261         (pgofs - ADDRS_PER_INODE(fi) + ADDRS_PER_BLOCK) /       \
1262         ADDRS_PER_BLOCK * ADDRS_PER_BLOCK + ADDRS_PER_INODE(fi))
1263
1264 /*
1265  * file.c
1266  */
1267 int f2fs_sync_file(struct file *, loff_t, loff_t, int);
1268 void truncate_data_blocks(struct dnode_of_data *);
1269 int truncate_blocks(struct inode *, u64, bool);
1270 void f2fs_truncate(struct inode *);
1271 int f2fs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
1272 int f2fs_setattr(struct dentry *, struct iattr *);
1273 int truncate_hole(struct inode *, pgoff_t, pgoff_t);
1274 int truncate_data_blocks_range(struct dnode_of_data *, int);
1275 long f2fs_ioctl(struct file *, unsigned int, unsigned long);
1276 long f2fs_compat_ioctl(struct file *, unsigned int, unsigned long);
1277
1278 /*
1279  * inode.c
1280  */
1281 void f2fs_set_inode_flags(struct inode *);
1282 struct inode *f2fs_iget(struct super_block *, unsigned long);
1283 int try_to_free_nats(struct f2fs_sb_info *, int);
1284 void update_inode(struct inode *, struct page *);
1285 void update_inode_page(struct inode *);
1286 int f2fs_write_inode(struct inode *, struct writeback_control *);
1287 void f2fs_evict_inode(struct inode *);
1288 void handle_failed_inode(struct inode *);
1289
1290 /*
1291  * namei.c
1292  */
1293 struct dentry *f2fs_get_parent(struct dentry *child);
1294
1295 /*
1296  * dir.c
1297  */
1298 extern unsigned char f2fs_filetype_table[F2FS_FT_MAX];
1299 void set_de_type(struct f2fs_dir_entry *, struct inode *);
1300 struct f2fs_dir_entry *find_target_dentry(struct qstr *, int *,
1301                         struct f2fs_dentry_ptr *);
1302 bool f2fs_fill_dentries(struct dir_context *, struct f2fs_dentry_ptr *,
1303                         unsigned int);
1304 void do_make_empty_dir(struct inode *, struct inode *,
1305                         struct f2fs_dentry_ptr *);
1306 struct page *init_inode_metadata(struct inode *, struct inode *,
1307                         const struct qstr *, struct page *);
1308 void update_parent_metadata(struct inode *, struct inode *, unsigned int);
1309 int room_for_filename(const void *, int, int);
1310 void f2fs_drop_nlink(struct inode *, struct inode *, struct page *);
1311 struct f2fs_dir_entry *f2fs_find_entry(struct inode *, struct qstr *,
1312                                                         struct page **);
1313 struct f2fs_dir_entry *f2fs_parent_dir(struct inode *, struct page **);
1314 ino_t f2fs_inode_by_name(struct inode *, struct qstr *);
1315 void f2fs_set_link(struct inode *, struct f2fs_dir_entry *,
1316                                 struct page *, struct inode *);
1317 int update_dent_inode(struct inode *, const struct qstr *);
1318 int __f2fs_add_link(struct inode *, const struct qstr *, struct inode *);
1319 void f2fs_delete_entry(struct f2fs_dir_entry *, struct page *, struct inode *,
1320                                                         struct inode *);
1321 int f2fs_do_tmpfile(struct inode *, struct inode *);
1322 int f2fs_make_empty(struct inode *, struct inode *);
1323 bool f2fs_empty_dir(struct inode *);
1324
1325 static inline int f2fs_add_link(struct dentry *dentry, struct inode *inode)
1326 {
1327         return __f2fs_add_link(dentry->d_parent->d_inode, &dentry->d_name,
1328                                 inode);
1329 }
1330
1331 /*
1332  * super.c
1333  */
1334 int f2fs_sync_fs(struct super_block *, int);
1335 extern __printf(3, 4)
1336 void f2fs_msg(struct super_block *, const char *, const char *, ...);
1337
1338 /*
1339  * hash.c
1340  */
1341 f2fs_hash_t f2fs_dentry_hash(const struct qstr *);
1342
1343 /*
1344  * node.c
1345  */
1346 struct dnode_of_data;
1347 struct node_info;
1348
1349 bool available_free_memory(struct f2fs_sb_info *, int);
1350 bool is_checkpointed_node(struct f2fs_sb_info *, nid_t);
1351 bool has_fsynced_inode(struct f2fs_sb_info *, nid_t);
1352 bool need_inode_block_update(struct f2fs_sb_info *, nid_t);
1353 void get_node_info(struct f2fs_sb_info *, nid_t, struct node_info *);
1354 int get_dnode_of_data(struct dnode_of_data *, pgoff_t, int);
1355 int truncate_inode_blocks(struct inode *, pgoff_t);
1356 int truncate_xattr_node(struct inode *, struct page *);
1357 int wait_on_node_pages_writeback(struct f2fs_sb_info *, nid_t);
1358 void remove_inode_page(struct inode *);
1359 struct page *new_inode_page(struct inode *);
1360 struct page *new_node_page(struct dnode_of_data *, unsigned int, struct page *);
1361 void ra_node_page(struct f2fs_sb_info *, nid_t);
1362 struct page *get_node_page(struct f2fs_sb_info *, pgoff_t);
1363 struct page *get_node_page_ra(struct page *, int);
1364 void sync_inode_page(struct dnode_of_data *);
1365 int sync_node_pages(struct f2fs_sb_info *, nid_t, struct writeback_control *);
1366 bool alloc_nid(struct f2fs_sb_info *, nid_t *);
1367 void alloc_nid_done(struct f2fs_sb_info *, nid_t);
1368 void alloc_nid_failed(struct f2fs_sb_info *, nid_t);
1369 void recover_inline_xattr(struct inode *, struct page *);
1370 void recover_xattr_data(struct inode *, struct page *, block_t);
1371 int recover_inode_page(struct f2fs_sb_info *, struct page *);
1372 int restore_node_summary(struct f2fs_sb_info *, unsigned int,
1373                                 struct f2fs_summary_block *);
1374 void flush_nat_entries(struct f2fs_sb_info *);
1375 int build_node_manager(struct f2fs_sb_info *);
1376 void destroy_node_manager(struct f2fs_sb_info *);
1377 int __init create_node_manager_caches(void);
1378 void destroy_node_manager_caches(void);
1379
1380 /*
1381  * segment.c
1382  */
1383 void register_inmem_page(struct inode *, struct page *);
1384 void invalidate_inmem_page(struct inode *, struct page *);
1385 void commit_inmem_pages(struct inode *, bool);
1386 void f2fs_balance_fs(struct f2fs_sb_info *);
1387 void f2fs_balance_fs_bg(struct f2fs_sb_info *);
1388 int f2fs_issue_flush(struct f2fs_sb_info *);
1389 int create_flush_cmd_control(struct f2fs_sb_info *);
1390 void destroy_flush_cmd_control(struct f2fs_sb_info *);
1391 void invalidate_blocks(struct f2fs_sb_info *, block_t);
1392 void refresh_sit_entry(struct f2fs_sb_info *, block_t, block_t);
1393 void clear_prefree_segments(struct f2fs_sb_info *);
1394 void release_discard_addrs(struct f2fs_sb_info *);
1395 void discard_next_dnode(struct f2fs_sb_info *, block_t);
1396 int npages_for_summary_flush(struct f2fs_sb_info *);
1397 void allocate_new_segments(struct f2fs_sb_info *);
1398 int f2fs_trim_fs(struct f2fs_sb_info *, struct fstrim_range *);
1399 struct page *get_sum_page(struct f2fs_sb_info *, unsigned int);
1400 void write_meta_page(struct f2fs_sb_info *, struct page *);
1401 void write_node_page(struct f2fs_sb_info *, struct page *,
1402                 struct f2fs_io_info *, unsigned int, block_t, block_t *);
1403 void write_data_page(struct page *, struct dnode_of_data *, block_t *,
1404                                         struct f2fs_io_info *);
1405 void rewrite_data_page(struct page *, block_t, struct f2fs_io_info *);
1406 void recover_data_page(struct f2fs_sb_info *, struct page *,
1407                                 struct f2fs_summary *, block_t, block_t);
1408 void allocate_data_block(struct f2fs_sb_info *, struct page *,
1409                 block_t, block_t *, struct f2fs_summary *, int);
1410 void f2fs_wait_on_page_writeback(struct page *, enum page_type);
1411 void write_data_summaries(struct f2fs_sb_info *, block_t);
1412 void write_node_summaries(struct f2fs_sb_info *, block_t);
1413 int lookup_journal_in_cursum(struct f2fs_summary_block *,
1414                                         int, unsigned int, int);
1415 void flush_sit_entries(struct f2fs_sb_info *, struct cp_control *);
1416 int build_segment_manager(struct f2fs_sb_info *);
1417 void destroy_segment_manager(struct f2fs_sb_info *);
1418 int __init create_segment_manager_caches(void);
1419 void destroy_segment_manager_caches(void);
1420
1421 /*
1422  * checkpoint.c
1423  */
1424 struct page *grab_meta_page(struct f2fs_sb_info *, pgoff_t);
1425 struct page *get_meta_page(struct f2fs_sb_info *, pgoff_t);
1426 struct page *get_meta_page_ra(struct f2fs_sb_info *, pgoff_t);
1427 int ra_meta_pages(struct f2fs_sb_info *, block_t, int, int);
1428 long sync_meta_pages(struct f2fs_sb_info *, enum page_type, long);
1429 void add_dirty_inode(struct f2fs_sb_info *, nid_t, int type);
1430 void remove_dirty_inode(struct f2fs_sb_info *, nid_t, int type);
1431 void release_dirty_inode(struct f2fs_sb_info *);
1432 bool exist_written_data(struct f2fs_sb_info *, nid_t, int);
1433 int acquire_orphan_inode(struct f2fs_sb_info *);
1434 void release_orphan_inode(struct f2fs_sb_info *);
1435 void add_orphan_inode(struct f2fs_sb_info *, nid_t);
1436 void remove_orphan_inode(struct f2fs_sb_info *, nid_t);
1437 void recover_orphan_inodes(struct f2fs_sb_info *);
1438 int get_valid_checkpoint(struct f2fs_sb_info *);
1439 void update_dirty_page(struct inode *, struct page *);
1440 void add_dirty_dir_inode(struct inode *);
1441 void remove_dirty_dir_inode(struct inode *);
1442 void sync_dirty_dir_inodes(struct f2fs_sb_info *);
1443 void write_checkpoint(struct f2fs_sb_info *, struct cp_control *);
1444 void init_ino_entry_info(struct f2fs_sb_info *);
1445 int __init create_checkpoint_caches(void);
1446 void destroy_checkpoint_caches(void);
1447
1448 /*
1449  * data.c
1450  */
1451 void f2fs_submit_merged_bio(struct f2fs_sb_info *, enum page_type, int);
1452 int f2fs_submit_page_bio(struct f2fs_sb_info *, struct page *, block_t, int);
1453 void f2fs_submit_page_mbio(struct f2fs_sb_info *, struct page *, block_t,
1454                                                 struct f2fs_io_info *);
1455 int reserve_new_block(struct dnode_of_data *);
1456 int f2fs_reserve_block(struct dnode_of_data *, pgoff_t);
1457 void update_extent_cache(block_t, struct dnode_of_data *);
1458 struct page *find_data_page(struct inode *, pgoff_t, bool);
1459 struct page *get_lock_data_page(struct inode *, pgoff_t);
1460 struct page *get_new_data_page(struct inode *, struct page *, pgoff_t, bool);
1461 int do_write_data_page(struct page *, struct f2fs_io_info *);
1462 int f2fs_fiemap(struct inode *inode, struct fiemap_extent_info *, u64, u64);
1463
1464 /*
1465  * gc.c
1466  */
1467 int start_gc_thread(struct f2fs_sb_info *);
1468 void stop_gc_thread(struct f2fs_sb_info *);
1469 block_t start_bidx_of_node(unsigned int, struct f2fs_inode_info *);
1470 int f2fs_gc(struct f2fs_sb_info *);
1471 void build_gc_manager(struct f2fs_sb_info *);
1472 int __init create_gc_caches(void);
1473 void destroy_gc_caches(void);
1474
1475 /*
1476  * recovery.c
1477  */
1478 int recover_fsync_data(struct f2fs_sb_info *);
1479 bool space_for_roll_forward(struct f2fs_sb_info *);
1480
1481 /*
1482  * debug.c
1483  */
1484 #ifdef CONFIG_F2FS_STAT_FS
1485 struct f2fs_stat_info {
1486         struct list_head stat_list;
1487         struct f2fs_sb_info *sbi;
1488         int all_area_segs, sit_area_segs, nat_area_segs, ssa_area_segs;
1489         int main_area_segs, main_area_sections, main_area_zones;
1490         int hit_ext, total_ext;
1491         int ndirty_node, ndirty_dent, ndirty_dirs, ndirty_meta;
1492         int nats, sits, fnids;
1493         int total_count, utilization;
1494         int bg_gc, inline_inode, inline_dir;
1495         unsigned int valid_count, valid_node_count, valid_inode_count;
1496         unsigned int bimodal, avg_vblocks;
1497         int util_free, util_valid, util_invalid;
1498         int rsvd_segs, overp_segs;
1499         int dirty_count, node_pages, meta_pages;
1500         int prefree_count, call_count, cp_count;
1501         int tot_segs, node_segs, data_segs, free_segs, free_secs;
1502         int tot_blks, data_blks, node_blks;
1503         int curseg[NR_CURSEG_TYPE];
1504         int cursec[NR_CURSEG_TYPE];
1505         int curzone[NR_CURSEG_TYPE];
1506
1507         unsigned int segment_count[2];
1508         unsigned int block_count[2];
1509         unsigned base_mem, cache_mem;
1510 };
1511
1512 static inline struct f2fs_stat_info *F2FS_STAT(struct f2fs_sb_info *sbi)
1513 {
1514         return (struct f2fs_stat_info *)sbi->stat_info;
1515 }
1516
1517 #define stat_inc_cp_count(si)           ((si)->cp_count++)
1518 #define stat_inc_call_count(si)         ((si)->call_count++)
1519 #define stat_inc_bggc_count(sbi)        ((sbi)->bg_gc++)
1520 #define stat_inc_dirty_dir(sbi)         ((sbi)->n_dirty_dirs++)
1521 #define stat_dec_dirty_dir(sbi)         ((sbi)->n_dirty_dirs--)
1522 #define stat_inc_total_hit(sb)          ((F2FS_SB(sb))->total_hit_ext++)
1523 #define stat_inc_read_hit(sb)           ((F2FS_SB(sb))->read_hit_ext++)
1524 #define stat_inc_inline_inode(inode)                                    \
1525         do {                                                            \
1526                 if (f2fs_has_inline_data(inode))                        \
1527                         ((F2FS_I_SB(inode))->inline_inode++);           \
1528         } while (0)
1529 #define stat_dec_inline_inode(inode)                                    \
1530         do {                                                            \
1531                 if (f2fs_has_inline_data(inode))                        \
1532                         ((F2FS_I_SB(inode))->inline_inode--);           \
1533         } while (0)
1534 #define stat_inc_inline_dir(inode)                                      \
1535         do {                                                            \
1536                 if (f2fs_has_inline_dentry(inode))                      \
1537                         ((F2FS_I_SB(inode))->inline_dir++);             \
1538         } while (0)
1539 #define stat_dec_inline_dir(inode)                                      \
1540         do {                                                            \
1541                 if (f2fs_has_inline_dentry(inode))                      \
1542                         ((F2FS_I_SB(inode))->inline_dir--);             \
1543         } while (0)
1544 #define stat_inc_seg_type(sbi, curseg)                                  \
1545                 ((sbi)->segment_count[(curseg)->alloc_type]++)
1546 #define stat_inc_block_count(sbi, curseg)                               \
1547                 ((sbi)->block_count[(curseg)->alloc_type]++)
1548
1549 #define stat_inc_seg_count(sbi, type)                                   \
1550         do {                                                            \
1551                 struct f2fs_stat_info *si = F2FS_STAT(sbi);             \
1552                 (si)->tot_segs++;                                       \
1553                 if (type == SUM_TYPE_DATA)                              \
1554                         si->data_segs++;                                \
1555                 else                                                    \
1556                         si->node_segs++;                                \
1557         } while (0)
1558
1559 #define stat_inc_tot_blk_count(si, blks)                                \
1560         (si->tot_blks += (blks))
1561
1562 #define stat_inc_data_blk_count(sbi, blks)                              \
1563         do {                                                            \
1564                 struct f2fs_stat_info *si = F2FS_STAT(sbi);             \
1565                 stat_inc_tot_blk_count(si, blks);                       \
1566                 si->data_blks += (blks);                                \
1567         } while (0)
1568
1569 #define stat_inc_node_blk_count(sbi, blks)                              \
1570         do {                                                            \
1571                 struct f2fs_stat_info *si = F2FS_STAT(sbi);             \
1572                 stat_inc_tot_blk_count(si, blks);                       \
1573                 si->node_blks += (blks);                                \
1574         } while (0)
1575
1576 int f2fs_build_stats(struct f2fs_sb_info *);
1577 void f2fs_destroy_stats(struct f2fs_sb_info *);
1578 void __init f2fs_create_root_stats(void);
1579 void f2fs_destroy_root_stats(void);
1580 #else
1581 #define stat_inc_cp_count(si)
1582 #define stat_inc_call_count(si)
1583 #define stat_inc_bggc_count(si)
1584 #define stat_inc_dirty_dir(sbi)
1585 #define stat_dec_dirty_dir(sbi)
1586 #define stat_inc_total_hit(sb)
1587 #define stat_inc_read_hit(sb)
1588 #define stat_inc_inline_inode(inode)
1589 #define stat_dec_inline_inode(inode)
1590 #define stat_inc_inline_dir(inode)
1591 #define stat_dec_inline_dir(inode)
1592 #define stat_inc_seg_type(sbi, curseg)
1593 #define stat_inc_block_count(sbi, curseg)
1594 #define stat_inc_seg_count(si, type)
1595 #define stat_inc_tot_blk_count(si, blks)
1596 #define stat_inc_data_blk_count(si, blks)
1597 #define stat_inc_node_blk_count(sbi, blks)
1598
1599 static inline int f2fs_build_stats(struct f2fs_sb_info *sbi) { return 0; }
1600 static inline void f2fs_destroy_stats(struct f2fs_sb_info *sbi) { }
1601 static inline void __init f2fs_create_root_stats(void) { }
1602 static inline void f2fs_destroy_root_stats(void) { }
1603 #endif
1604
1605 extern const struct file_operations f2fs_dir_operations;
1606 extern const struct file_operations f2fs_file_operations;
1607 extern const struct inode_operations f2fs_file_inode_operations;
1608 extern const struct address_space_operations f2fs_dblock_aops;
1609 extern const struct address_space_operations f2fs_node_aops;
1610 extern const struct address_space_operations f2fs_meta_aops;
1611 extern const struct inode_operations f2fs_dir_inode_operations;
1612 extern const struct inode_operations f2fs_symlink_inode_operations;
1613 extern const struct inode_operations f2fs_special_inode_operations;
1614
1615 /*
1616  * inline.c
1617  */
1618 bool f2fs_may_inline(struct inode *);
1619 void read_inline_data(struct page *, struct page *);
1620 int f2fs_read_inline_data(struct inode *, struct page *);
1621 int f2fs_convert_inline_page(struct dnode_of_data *, struct page *);
1622 int f2fs_convert_inline_inode(struct inode *);
1623 int f2fs_write_inline_data(struct inode *, struct page *);
1624 void truncate_inline_data(struct page *, u64);
1625 bool recover_inline_data(struct inode *, struct page *);
1626 struct f2fs_dir_entry *find_in_inline_dir(struct inode *, struct qstr *,
1627                                                         struct page **);
1628 struct f2fs_dir_entry *f2fs_parent_inline_dir(struct inode *, struct page **);
1629 int make_empty_inline_dir(struct inode *inode, struct inode *, struct page *);
1630 int f2fs_add_inline_entry(struct inode *, const struct qstr *, struct inode *);
1631 void f2fs_delete_inline_entry(struct f2fs_dir_entry *, struct page *,
1632                                                 struct inode *, struct inode *);
1633 bool f2fs_empty_inline_dir(struct inode *);
1634 int f2fs_read_inline_dir(struct file *, struct dir_context *);
1635 #endif