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
  21 /*
  22  * For mount options
  23  */
  24 #define F2FS_MOUNT_BG_GC                0x00000001
  25 #define F2FS_MOUNT_DISABLE_ROLL_FORWARD 0x00000002
  26 #define F2FS_MOUNT_DISCARD              0x00000004
  27 #define F2FS_MOUNT_NOHEAP               0x00000008
  28 #define F2FS_MOUNT_XATTR_USER           0x00000010
  29 #define F2FS_MOUNT_POSIX_ACL            0x00000020
  30 #define F2FS_MOUNT_DISABLE_EXT_IDENTIFY 0x00000040
  31
  32 #define clear_opt(sbi, option)  (sbi->mount_opt.opt &= ~F2FS_MOUNT_##option)
  33 #define set_opt(sbi, option)    (sbi->mount_opt.opt |= F2FS_MOUNT_##option)
  34 #define test_opt(sbi, option)   (sbi->mount_opt.opt & F2FS_MOUNT_##option)
  35
  36 #define ver_after(a, b) (typecheck(unsigned long long, a) &&            \
  37                 typecheck(unsigned long long, b) &&                     \
  38                 ((long long)((a) - (b)) > 0))
  39
  40 typedef u64 block_t;
  41 typedef u32 nid_t;
  42
  43 struct f2fs_mount_info {
  44         unsigned int    opt;
  45 };
  46
  47 static inline __u32 f2fs_crc32(void *buff, size_t len)
  48 {
  49         return crc32_le(F2FS_SUPER_MAGIC, buff, len);
  50 }
  51
  52 static inline bool f2fs_crc_valid(__u32 blk_crc, void *buff, size_t buff_size)
  53 {
  54         return f2fs_crc32(buff, buff_size) == blk_crc;
  55 }
  56
  57 /*
  58  * For checkpoint manager
  59  */
  60 enum {
  61         NAT_BITMAP,
  62         SIT_BITMAP
  63 };
  64
  65 /* for the list of orphan inodes */
  66 struct orphan_inode_entry {
  67         struct list_head list;  /* list head */
  68         nid_t ino;              /* inode number */
  69 };
  70
  71 /* for the list of directory inodes */
  72 struct dir_inode_entry {
  73         struct list_head list;  /* list head */
  74         struct inode *inode;    /* vfs inode pointer */
  75 };
  76
  77 /* for the list of fsync inodes, used only during recovery */
  78 struct fsync_inode_entry {
  79         struct list_head list;  /* list head */
  80         struct inode *inode;    /* vfs inode pointer */
  81         block_t blkaddr;        /* block address locating the last inode */
  82 };
  83
  84 #define nats_in_cursum(sum)             (le16_to_cpu(sum->n_nats))
  85 #define sits_in_cursum(sum)             (le16_to_cpu(sum->n_sits))
  86
  87 #define nat_in_journal(sum, i)          (sum->nat_j.entries[i].ne)
  88 #define nid_in_journal(sum, i)          (sum->nat_j.entries[i].nid)
  89 #define sit_in_journal(sum, i)          (sum->sit_j.entries[i].se)
  90 #define segno_in_journal(sum, i)        (sum->sit_j.entries[i].segno)
  91
  92 static inline int update_nats_in_cursum(struct f2fs_summary_block *rs, int i)
  93 {
  94         int before = nats_in_cursum(rs);
  95         rs->n_nats = cpu_to_le16(before + i);
  96         return before;
  97 }
  98
  99 static inline int update_sits_in_cursum(struct f2fs_summary_block *rs, int i)
 100 {
 101         int before = sits_in_cursum(rs);
 102         rs->n_sits = cpu_to_le16(before + i);
 103         return before;
 104 }
 105
 106 /*
 107  * ioctl commands
 108  */
 109 #define F2FS_IOC_GETFLAGS               FS_IOC_GETFLAGS
 110 #define F2FS_IOC_SETFLAGS               FS_IOC_SETFLAGS
 111
 112 #if defined(__KERNEL__) && defined(CONFIG_COMPAT)
 113 /*
 114  * ioctl commands in 32 bit emulation
 115  */
 116 #define F2FS_IOC32_GETFLAGS             FS_IOC32_GETFLAGS
 117 #define F2FS_IOC32_SETFLAGS             FS_IOC32_SETFLAGS
 118 #endif
 119
 120 /*
 121  * For INODE and NODE manager
 122  */
 123 #define XATTR_NODE_OFFSET       (-1)    /*
 124                                          * store xattrs to one node block per
 125                                          * file keeping -1 as its node offset to
 126                                          * distinguish from index node blocks.
 127                                          */
 128 enum {
 129         ALLOC_NODE,                     /* allocate a new node page if needed */
 130         LOOKUP_NODE,                    /* look up a node without readahead */
 131         LOOKUP_NODE_RA,                 /*
 132                                          * look up a node with readahead called
 133                                          * by get_datablock_ro.
 134                                          */
 135 };
 136
 137 #define F2FS_LINK_MAX           32000   /* maximum link count per file */
 138
 139 /* for in-memory extent cache entry */
 140 struct extent_info {
 141         rwlock_t ext_lock;      /* rwlock for consistency */
 142         unsigned int fofs;      /* start offset in a file */
 143         u32 blk_addr;           /* start block address of the extent */
 144         unsigned int len;       /* lenth of the extent */
 145 };
 146
 147 /*
 148  * i_advise uses FADVISE_XXX_BIT. We can add additional hints later.
 149  */
 150 #define FADVISE_COLD_BIT        0x01
 151
 152 struct f2fs_inode_info {
 153         struct inode vfs_inode;         /* serve a vfs inode */
 154         unsigned long i_flags;          /* keep an inode flags for ioctl */
 155         unsigned char i_advise;         /* use to give file attribute hints */
 156         unsigned int i_current_depth;   /* use only in directory structure */
 157         unsigned int i_pino;            /* parent inode number */
 158         umode_t i_acl_mode;             /* keep file acl mode temporarily */
 159
 160         /* Use below internally in f2fs*/
 161         unsigned long flags;            /* use to pass per-file flags */
 162         unsigned long long data_version;/* latest version of data for fsync */
 163         atomic_t dirty_dents;           /* # of dirty dentry pages */
 164         f2fs_hash_t chash;              /* hash value of given file name */
 165         unsigned int clevel;            /* maximum level of given file name */
 166         nid_t i_xattr_nid;              /* node id that contains xattrs */
 167         struct extent_info ext;         /* in-memory extent cache entry */
 168 };
 169
 170 static inline void get_extent_info(struct extent_info *ext,
 171                                         struct f2fs_extent i_ext)
 172 {
 173         write_lock(&ext->ext_lock);
 174         ext->fofs = le32_to_cpu(i_ext.fofs);
 175         ext->blk_addr = le32_to_cpu(i_ext.blk_addr);
 176         ext->len = le32_to_cpu(i_ext.len);
 177         write_unlock(&ext->ext_lock);
 178 }
 179
 180 static inline void set_raw_extent(struct extent_info *ext,
 181                                         struct f2fs_extent *i_ext)
 182 {
 183         read_lock(&ext->ext_lock);
 184         i_ext->fofs = cpu_to_le32(ext->fofs);
 185         i_ext->blk_addr = cpu_to_le32(ext->blk_addr);
 186         i_ext->len = cpu_to_le32(ext->len);
 187         read_unlock(&ext->ext_lock);
 188 }
 189
 190 struct f2fs_nm_info {
 191         block_t nat_blkaddr;            /* base disk address of NAT */
 192         nid_t max_nid;                  /* maximum possible node ids */
 193         nid_t init_scan_nid;            /* the first nid to be scanned */
 194         nid_t next_scan_nid;            /* the next nid to be scanned */
 195
 196         /* NAT cache management */
 197         struct radix_tree_root nat_root;/* root of the nat entry cache */
 198         rwlock_t nat_tree_lock;         /* protect nat_tree_lock */
 199         unsigned int nat_cnt;           /* the # of cached nat entries */
 200         struct list_head nat_entries;   /* cached nat entry list (clean) */
 201         struct list_head dirty_nat_entries; /* cached nat entry list (dirty) */
 202
 203         /* free node ids management */
 204         struct list_head free_nid_list; /* a list for free nids */
 205         spinlock_t free_nid_list_lock;  /* protect free nid list */
 206         unsigned int fcnt;              /* the number of free node id */
 207         struct mutex build_lock;        /* lock for build free nids */
 208
 209         /* for checkpoint */
 210         char *nat_bitmap;               /* NAT bitmap pointer */
 211         int bitmap_size;                /* bitmap size */
 212 };
 213
 214 /*
 215  * this structure is used as one of function parameters.
 216  * all the information are dedicated to a given direct node block determined
 217  * by the data offset in a file.
 218  */
 219 struct dnode_of_data {
 220         struct inode *inode;            /* vfs inode pointer */
 221         struct page *inode_page;        /* its inode page, NULL is possible */
 222         struct page *node_page;         /* cached direct node page */
 223         nid_t nid;                      /* node id of the direct node block */
 224         unsigned int ofs_in_node;       /* data offset in the node page */
 225         bool inode_page_locked;         /* inode page is locked or not */
 226         block_t data_blkaddr;           /* block address of the node block */
 227 };
 228
 229 static inline void set_new_dnode(struct dnode_of_data *dn, struct inode *inode,
 230                 struct page *ipage, struct page *npage, nid_t nid)
 231 {
 232         memset(dn, 0, sizeof(*dn));
 233         dn->inode = inode;
 234         dn->inode_page = ipage;
 235         dn->node_page = npage;
 236         dn->nid = nid;
 237 }
 238
 239 /*
 240  * For SIT manager
 241  *
 242  * By default, there are 6 active log areas across the whole main area.
 243  * When considering hot and cold data separation to reduce cleaning overhead,
 244  * we split 3 for data logs and 3 for node logs as hot, warm, and cold types,
 245  * respectively.
 246  * In the current design, you should not change the numbers intentionally.
 247  * Instead, as a mount option such as active_logs=x, you can use 2, 4, and 6
 248  * logs individually according to the underlying devices. (default: 6)
 249  * Just in case, on-disk layout covers maximum 16 logs that consist of 8 for
 250  * data and 8 for node logs.
 251  */
 252 #define NR_CURSEG_DATA_TYPE     (3)
 253 #define NR_CURSEG_NODE_TYPE     (3)
 254 #define NR_CURSEG_TYPE  (NR_CURSEG_DATA_TYPE + NR_CURSEG_NODE_TYPE)
 255
 256 enum {
 257         CURSEG_HOT_DATA = 0,    /* directory entry blocks */
 258         CURSEG_WARM_DATA,       /* data blocks */
 259         CURSEG_COLD_DATA,       /* multimedia or GCed data blocks */
 260         CURSEG_HOT_NODE,        /* direct node blocks of directory files */
 261         CURSEG_WARM_NODE,       /* direct node blocks of normal files */
 262         CURSEG_COLD_NODE,       /* indirect node blocks */
 263         NO_CHECK_TYPE
 264 };
 265
 266 struct f2fs_sm_info {
 267         struct sit_info *sit_info;              /* whole segment information */
 268         struct free_segmap_info *free_info;     /* free segment information */
 269         struct dirty_seglist_info *dirty_info;  /* dirty segment information */
 270         struct curseg_info *curseg_array;       /* active segment information */
 271
 272         struct list_head wblist_head;   /* list of under-writeback pages */
 273         spinlock_t wblist_lock;         /* lock for checkpoint */
 274
 275         block_t seg0_blkaddr;           /* block address of 0'th segment */
 276         block_t main_blkaddr;           /* start block address of main area */
 277         block_t ssa_blkaddr;            /* start block address of SSA area */
 278
 279         unsigned int segment_count;     /* total # of segments */
 280         unsigned int main_segments;     /* # of segments in main area */
 281         unsigned int reserved_segments; /* # of reserved segments */
 282         unsigned int ovp_segments;      /* # of overprovision segments */
 283 };
 284
 285 /*
 286  * For directory operation
 287  */
 288 #define NODE_DIR1_BLOCK         (ADDRS_PER_INODE + 1)
 289 #define NODE_DIR2_BLOCK         (ADDRS_PER_INODE + 2)
 290 #define NODE_IND1_BLOCK         (ADDRS_PER_INODE + 3)
 291 #define NODE_IND2_BLOCK         (ADDRS_PER_INODE + 4)
 292 #define NODE_DIND_BLOCK         (ADDRS_PER_INODE + 5)
 293
 294 /*
 295  * For superblock
 296  */
 297 /*
 298  * COUNT_TYPE for monitoring
 299  *
 300  * f2fs monitors the number of several block types such as on-writeback,
 301  * dirty dentry blocks, dirty node blocks, and dirty meta blocks.
 302  */
 303 enum count_type {
 304         F2FS_WRITEBACK,
 305         F2FS_DIRTY_DENTS,
 306         F2FS_DIRTY_NODES,
 307         F2FS_DIRTY_META,
 308         NR_COUNT_TYPE,
 309 };
 310
 311 /*
 312  * FS_LOCK nesting subclasses for the lock validator:
 313  *
 314  * The locking order between these classes is
 315  * RENAME -> DENTRY_OPS -> DATA_WRITE -> DATA_NEW
 316  *    -> DATA_TRUNC -> NODE_WRITE -> NODE_NEW -> NODE_TRUNC
 317  */
 318 enum lock_type {
 319         RENAME,         /* for renaming operations */
 320         DENTRY_OPS,     /* for directory operations */
 321         DATA_WRITE,     /* for data write */
 322         DATA_NEW,       /* for data allocation */
 323         DATA_TRUNC,     /* for data truncate */
 324         NODE_NEW,       /* for node allocation */
 325         NODE_TRUNC,     /* for node truncate */
 326         NODE_WRITE,     /* for node write */
 327         NR_LOCK_TYPE,
 328 };
 329
 330 /*
 331  * The below are the page types of bios used in submti_bio().
 332  * The available types are:
 333  * DATA                 User data pages. It operates as async mode.
 334  * NODE                 Node pages. It operates as async mode.
 335  * META                 FS metadata pages such as SIT, NAT, CP.
 336  * NR_PAGE_TYPE         The number of page types.
 337  * META_FLUSH           Make sure the previous pages are written
 338  *                      with waiting the bio's completion
 339  * ...                  Only can be used with META.
 340  */
 341 enum page_type {
 342         DATA,
 343         NODE,
 344         META,
 345         NR_PAGE_TYPE,
 346         META_FLUSH,
 347 };
 348
 349 struct f2fs_sb_info {
 350         struct super_block *sb;                 /* pointer to VFS super block */
 351         struct buffer_head *raw_super_buf;      /* buffer head of raw sb */
 352         struct f2fs_super_block *raw_super;     /* raw super block pointer */
 353         int s_dirty;                            /* dirty flag for checkpoint */
 354
 355         /* for node-related operations */
 356         struct f2fs_nm_info *nm_info;           /* node manager */
 357         struct inode *node_inode;               /* cache node blocks */
 358
 359         /* for segment-related operations */
 360         struct f2fs_sm_info *sm_info;           /* segment manager */
 361         struct bio *bio[NR_PAGE_TYPE];          /* bios to merge */
 362         sector_t last_block_in_bio[NR_PAGE_TYPE];       /* last block number */
 363         struct rw_semaphore bio_sem;            /* IO semaphore */
 364
 365         /* for checkpoint */
 366         struct f2fs_checkpoint *ckpt;           /* raw checkpoint pointer */
 367         struct inode *meta_inode;               /* cache meta blocks */
 368         struct mutex cp_mutex;                  /* for checkpoint procedure */
 369         struct mutex fs_lock[NR_LOCK_TYPE];     /* for blocking FS operations */
 370         struct mutex write_inode;               /* mutex for write inode */
 371         struct mutex writepages;                /* mutex for writepages() */
 372         int por_doing;                          /* recovery is doing or not */
 373
 374         /* for orphan inode management */
 375         struct list_head orphan_inode_list;     /* orphan inode list */
 376         struct mutex orphan_inode_mutex;        /* for orphan inode list */
 377         unsigned int n_orphans;                 /* # of orphan inodes */
 378
 379         /* for directory inode management */
 380         struct list_head dir_inode_list;        /* dir inode list */
 381         spinlock_t dir_inode_lock;              /* for dir inode list lock */
 382         unsigned int n_dirty_dirs;              /* # of dir inodes */
 383
 384         /* basic file system units */
 385         unsigned int log_sectors_per_block;     /* log2 sectors per block */
 386         unsigned int log_blocksize;             /* log2 block size */
 387         unsigned int blocksize;                 /* block size */
 388         unsigned int root_ino_num;              /* root inode number*/
 389         unsigned int node_ino_num;              /* node inode number*/
 390         unsigned int meta_ino_num;              /* meta inode number*/
 391         unsigned int log_blocks_per_seg;        /* log2 blocks per segment */
 392         unsigned int blocks_per_seg;            /* blocks per segment */
 393         unsigned int segs_per_sec;              /* segments per section */
 394         unsigned int secs_per_zone;             /* sections per zone */
 395         unsigned int total_sections;            /* total section count */
 396         unsigned int total_node_count;          /* total node block count */
 397         unsigned int total_valid_node_count;    /* valid node block count */
 398         unsigned int total_valid_inode_count;   /* valid inode count */
 399         int active_logs;                        /* # of active logs */
 400
 401         block_t user_block_count;               /* # of user blocks */
 402         block_t total_valid_block_count;        /* # of valid blocks */
 403         block_t alloc_valid_block_count;        /* # of allocated blocks */
 404         block_t last_valid_block_count;         /* for recovery */
 405         u32 s_next_generation;                  /* for NFS support */
 406         atomic_t nr_pages[NR_COUNT_TYPE];       /* # of pages, see count_type */
 407
 408         struct f2fs_mount_info mount_opt;       /* mount options */
 409
 410         /* for cleaning operations */
 411         struct mutex gc_mutex;                  /* mutex for GC */
 412         struct f2fs_gc_kthread  *gc_thread;     /* GC thread */
 413
 414         /*
 415          * for stat information.
 416          * one is for the LFS mode, and the other is for the SSR mode.
 417          */
 418         struct f2fs_stat_info *stat_info;       /* FS status information */
 419         unsigned int segment_count[2];          /* # of allocated segments */
 420         unsigned int block_count[2];            /* # of allocated blocks */
 421         unsigned int last_victim[2];            /* last victim segment # */
 422         int total_hit_ext, read_hit_ext;        /* extent cache hit ratio */
 423         int bg_gc;                              /* background gc calls */
 424         spinlock_t stat_lock;                   /* lock for stat operations */
 425 };
 426
 427 /*
 428  * Inline functions
 429  */
 430 static inline struct f2fs_inode_info *F2FS_I(struct inode *inode)
 431 {
 432         return container_of(inode, struct f2fs_inode_info, vfs_inode);
 433 }
 434
 435 static inline struct f2fs_sb_info *F2FS_SB(struct super_block *sb)
 436 {
 437         return sb->s_fs_info;
 438 }
 439
 440 static inline struct f2fs_super_block *F2FS_RAW_SUPER(struct f2fs_sb_info *sbi)
 441 {
 442         return (struct f2fs_super_block *)(sbi->raw_super);
 443 }
 444
 445 static inline struct f2fs_checkpoint *F2FS_CKPT(struct f2fs_sb_info *sbi)
 446 {
 447         return (struct f2fs_checkpoint *)(sbi->ckpt);
 448 }
 449
 450 static inline struct f2fs_nm_info *NM_I(struct f2fs_sb_info *sbi)
 451 {
 452         return (struct f2fs_nm_info *)(sbi->nm_info);
 453 }
 454
 455 static inline struct f2fs_sm_info *SM_I(struct f2fs_sb_info *sbi)
 456 {
 457         return (struct f2fs_sm_info *)(sbi->sm_info);
 458 }
 459
 460 static inline struct sit_info *SIT_I(struct f2fs_sb_info *sbi)
 461 {
 462         return (struct sit_info *)(SM_I(sbi)->sit_info);
 463 }
 464
 465 static inline struct free_segmap_info *FREE_I(struct f2fs_sb_info *sbi)
 466 {
 467         return (struct free_segmap_info *)(SM_I(sbi)->free_info);
 468 }
 469
 470 static inline struct dirty_seglist_info *DIRTY_I(struct f2fs_sb_info *sbi)
 471 {
 472         return (struct dirty_seglist_info *)(SM_I(sbi)->dirty_info);
 473 }
 474
 475 static inline void F2FS_SET_SB_DIRT(struct f2fs_sb_info *sbi)
 476 {
 477         sbi->s_dirty = 1;
 478 }
 479
 480 static inline void F2FS_RESET_SB_DIRT(struct f2fs_sb_info *sbi)
 481 {
 482         sbi->s_dirty = 0;
 483 }
 484
 485 static inline bool is_set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
 486 {
 487         unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
 488         return ckpt_flags & f;
 489 }
 490
 491 static inline void set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
 492 {
 493         unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
 494         ckpt_flags |= f;
 495         cp->ckpt_flags = cpu_to_le32(ckpt_flags);
 496 }
 497
 498 static inline void clear_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
 499 {
 500         unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
 501         ckpt_flags &= (~f);
 502         cp->ckpt_flags = cpu_to_le32(ckpt_flags);
 503 }
 504
 505 static inline void mutex_lock_op(struct f2fs_sb_info *sbi, enum lock_type t)
 506 {
 507         mutex_lock_nested(&sbi->fs_lock[t], t);
 508 }
 509
 510 static inline void mutex_unlock_op(struct f2fs_sb_info *sbi, enum lock_type t)
 511 {
 512         mutex_unlock(&sbi->fs_lock[t]);
 513 }
 514
 515 /*
 516  * Check whether the given nid is within node id range.
 517  */
 518 static inline void check_nid_range(struct f2fs_sb_info *sbi, nid_t nid)
 519 {
 520         BUG_ON((nid >= NM_I(sbi)->max_nid));
 521 }
 522
 523 #define F2FS_DEFAULT_ALLOCATED_BLOCKS   1
 524
 525 /*
 526  * Check whether the inode has blocks or not
 527  */
 528 static inline int F2FS_HAS_BLOCKS(struct inode *inode)
 529 {
 530         if (F2FS_I(inode)->i_xattr_nid)
 531                 return (inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS + 1);
 532         else
 533                 return (inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS);
 534 }
 535
 536 static inline bool inc_valid_block_count(struct f2fs_sb_info *sbi,
 537                                  struct inode *inode, blkcnt_t count)
 538 {
 539         block_t valid_block_count;
 540
 541         spin_lock(&sbi->stat_lock);
 542         valid_block_count =
 543                 sbi->total_valid_block_count + (block_t)count;
 544         if (valid_block_count > sbi->user_block_count) {
 545                 spin_unlock(&sbi->stat_lock);
 546                 return false;
 547         }
 548         inode->i_blocks += count;
 549         sbi->total_valid_block_count = valid_block_count;
 550         sbi->alloc_valid_block_count += (block_t)count;
 551         spin_unlock(&sbi->stat_lock);
 552         return true;
 553 }
 554
 555 static inline int dec_valid_block_count(struct f2fs_sb_info *sbi,
 556                                                 struct inode *inode,
 557                                                 blkcnt_t count)
 558 {
 559         spin_lock(&sbi->stat_lock);
 560         BUG_ON(sbi->total_valid_block_count < (block_t) count);
 561         BUG_ON(inode->i_blocks < count);
 562         inode->i_blocks -= count;
 563         sbi->total_valid_block_count -= (block_t)count;
 564         spin_unlock(&sbi->stat_lock);
 565         return 0;
 566 }
 567
 568 static inline void inc_page_count(struct f2fs_sb_info *sbi, int count_type)
 569 {
 570         atomic_inc(&sbi->nr_pages[count_type]);
 571         F2FS_SET_SB_DIRT(sbi);
 572 }
 573
 574 static inline void inode_inc_dirty_dents(struct inode *inode)
 575 {
 576         atomic_inc(&F2FS_I(inode)->dirty_dents);
 577 }
 578
 579 static inline void dec_page_count(struct f2fs_sb_info *sbi, int count_type)
 580 {
 581         atomic_dec(&sbi->nr_pages[count_type]);
 582 }
 583
 584 static inline void inode_dec_dirty_dents(struct inode *inode)
 585 {
 586         atomic_dec(&F2FS_I(inode)->dirty_dents);
 587 }
 588
 589 static inline int get_pages(struct f2fs_sb_info *sbi, int count_type)
 590 {
 591         return atomic_read(&sbi->nr_pages[count_type]);
 592 }
 593
 594 static inline int get_blocktype_secs(struct f2fs_sb_info *sbi, int block_type)
 595 {
 596         unsigned int pages_per_sec = sbi->segs_per_sec *
 597                                         (1 << sbi->log_blocks_per_seg);
 598         return ((get_pages(sbi, block_type) + pages_per_sec - 1)
 599                         >> sbi->log_blocks_per_seg) / sbi->segs_per_sec;
 600 }
 601
 602 static inline block_t valid_user_blocks(struct f2fs_sb_info *sbi)
 603 {
 604         block_t ret;
 605         spin_lock(&sbi->stat_lock);
 606         ret = sbi->total_valid_block_count;
 607         spin_unlock(&sbi->stat_lock);
 608         return ret;
 609 }
 610
 611 static inline unsigned long __bitmap_size(struct f2fs_sb_info *sbi, int flag)
 612 {
 613         struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
 614
 615         /* return NAT or SIT bitmap */
 616         if (flag == NAT_BITMAP)
 617                 return le32_to_cpu(ckpt->nat_ver_bitmap_bytesize);
 618         else if (flag == SIT_BITMAP)
 619                 return le32_to_cpu(ckpt->sit_ver_bitmap_bytesize);
 620
 621         return 0;
 622 }
 623
 624 static inline void *__bitmap_ptr(struct f2fs_sb_info *sbi, int flag)
 625 {
 626         struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
 627         int offset = (flag == NAT_BITMAP) ?
 628                         le32_to_cpu(ckpt->sit_ver_bitmap_bytesize) : 0;
 629         return &ckpt->sit_nat_version_bitmap + offset;
 630 }
 631
 632 static inline block_t __start_cp_addr(struct f2fs_sb_info *sbi)
 633 {
 634         block_t start_addr;
 635         struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
 636         unsigned long long ckpt_version = le64_to_cpu(ckpt->checkpoint_ver);
 637
 638         start_addr = le32_to_cpu(F2FS_RAW_SUPER(sbi)->cp_blkaddr);
 639
 640         /*
 641          * odd numbered checkpoint should at cp segment 0
 642          * and even segent must be at cp segment 1
 643          */
 644         if (!(ckpt_version & 1))
 645                 start_addr += sbi->blocks_per_seg;
 646
 647         return start_addr;
 648 }
 649
 650 static inline block_t __start_sum_addr(struct f2fs_sb_info *sbi)
 651 {
 652         return le32_to_cpu(F2FS_CKPT(sbi)->cp_pack_start_sum);
 653 }
 654
 655 static inline bool inc_valid_node_count(struct f2fs_sb_info *sbi,
 656                                                 struct inode *inode,
 657                                                 unsigned int count)
 658 {
 659         block_t valid_block_count;
 660         unsigned int valid_node_count;
 661
 662         spin_lock(&sbi->stat_lock);
 663
 664         valid_block_count = sbi->total_valid_block_count + (block_t)count;
 665         sbi->alloc_valid_block_count += (block_t)count;
 666         valid_node_count = sbi->total_valid_node_count + count;
 667
 668         if (valid_block_count > sbi->user_block_count) {
 669                 spin_unlock(&sbi->stat_lock);
 670                 return false;
 671         }
 672
 673         if (valid_node_count > sbi->total_node_count) {
 674                 spin_unlock(&sbi->stat_lock);
 675                 return false;
 676         }
 677
 678         if (inode)
 679                 inode->i_blocks += count;
 680         sbi->total_valid_node_count = valid_node_count;
 681         sbi->total_valid_block_count = valid_block_count;
 682         spin_unlock(&sbi->stat_lock);
 683
 684         return true;
 685 }
 686
 687 static inline void dec_valid_node_count(struct f2fs_sb_info *sbi,
 688                                                 struct inode *inode,
 689                                                 unsigned int count)
 690 {
 691         spin_lock(&sbi->stat_lock);
 692
 693         BUG_ON(sbi->total_valid_block_count < count);
 694         BUG_ON(sbi->total_valid_node_count < count);
 695         BUG_ON(inode->i_blocks < count);
 696
 697         inode->i_blocks -= count;
 698         sbi->total_valid_node_count -= count;
 699         sbi->total_valid_block_count -= (block_t)count;
 700
 701         spin_unlock(&sbi->stat_lock);
 702 }
 703
 704 static inline unsigned int valid_node_count(struct f2fs_sb_info *sbi)
 705 {
 706         unsigned int ret;
 707         spin_lock(&sbi->stat_lock);
 708         ret = sbi->total_valid_node_count;
 709         spin_unlock(&sbi->stat_lock);
 710         return ret;
 711 }
 712
 713 static inline void inc_valid_inode_count(struct f2fs_sb_info *sbi)
 714 {
 715         spin_lock(&sbi->stat_lock);
 716         BUG_ON(sbi->total_valid_inode_count == sbi->total_node_count);
 717         sbi->total_valid_inode_count++;
 718         spin_unlock(&sbi->stat_lock);
 719 }
 720
 721 static inline int dec_valid_inode_count(struct f2fs_sb_info *sbi)
 722 {
 723         spin_lock(&sbi->stat_lock);
 724         BUG_ON(!sbi->total_valid_inode_count);
 725         sbi->total_valid_inode_count--;
 726         spin_unlock(&sbi->stat_lock);
 727         return 0;
 728 }
 729
 730 static inline unsigned int valid_inode_count(struct f2fs_sb_info *sbi)
 731 {
 732         unsigned int ret;
 733         spin_lock(&sbi->stat_lock);
 734         ret = sbi->total_valid_inode_count;
 735         spin_unlock(&sbi->stat_lock);
 736         return ret;
 737 }
 738
 739 static inline void f2fs_put_page(struct page *page, int unlock)
 740 {
 741         if (!page || IS_ERR(page))
 742                 return;
 743
 744         if (unlock) {
 745                 BUG_ON(!PageLocked(page));
 746                 unlock_page(page);
 747         }
 748         page_cache_release(page);
 749 }
 750
 751 static inline void f2fs_put_dnode(struct dnode_of_data *dn)
 752 {
 753         if (dn->node_page)
 754                 f2fs_put_page(dn->node_page, 1);
 755         if (dn->inode_page && dn->node_page != dn->inode_page)
 756                 f2fs_put_page(dn->inode_page, 0);
 757         dn->node_page = NULL;
 758         dn->inode_page = NULL;
 759 }
 760
 761 static inline struct kmem_cache *f2fs_kmem_cache_create(const char *name,
 762                                         size_t size, void (*ctor)(void *))
 763 {
 764         return kmem_cache_create(name, size, 0, SLAB_RECLAIM_ACCOUNT, ctor);
 765 }
 766
 767 #define RAW_IS_INODE(p) ((p)->footer.nid == (p)->footer.ino)
 768
 769 static inline bool IS_INODE(struct page *page)
 770 {
 771         struct f2fs_node *p = (struct f2fs_node *)page_address(page);
 772         return RAW_IS_INODE(p);
 773 }
 774
 775 static inline __le32 *blkaddr_in_node(struct f2fs_node *node)
 776 {
 777         return RAW_IS_INODE(node) ? node->i.i_addr : node->dn.addr;
 778 }
 779
 780 static inline block_t datablock_addr(struct page *node_page,
 781                 unsigned int offset)
 782 {
 783         struct f2fs_node *raw_node;
 784         __le32 *addr_array;
 785         raw_node = (struct f2fs_node *)page_address(node_page);
 786         addr_array = blkaddr_in_node(raw_node);
 787         return le32_to_cpu(addr_array[offset]);
 788 }
 789
 790 static inline int f2fs_test_bit(unsigned int nr, char *addr)
 791 {
 792         int mask;
 793
 794         addr += (nr >> 3);
 795         mask = 1 << (7 - (nr & 0x07));
 796         return mask & *addr;
 797 }
 798
 799 static inline int f2fs_set_bit(unsigned int nr, char *addr)
 800 {
 801         int mask;
 802         int ret;
 803
 804         addr += (nr >> 3);
 805         mask = 1 << (7 - (nr & 0x07));
 806         ret = mask & *addr;
 807         *addr |= mask;
 808         return ret;
 809 }
 810
 811 static inline int f2fs_clear_bit(unsigned int nr, char *addr)
 812 {
 813         int mask;
 814         int ret;
 815
 816         addr += (nr >> 3);
 817         mask = 1 << (7 - (nr & 0x07));
 818         ret = mask & *addr;
 819         *addr &= ~mask;
 820         return ret;
 821 }
 822
 823 /* used for f2fs_inode_info->flags */
 824 enum {
 825         FI_NEW_INODE,           /* indicate newly allocated inode */
 826         FI_NEED_CP,             /* need to do checkpoint during fsync */
 827         FI_INC_LINK,            /* need to increment i_nlink */
 828         FI_ACL_MODE,            /* indicate acl mode */
 829         FI_NO_ALLOC,            /* should not allocate any blocks */
 830 };
 831
 832 static inline void set_inode_flag(struct f2fs_inode_info *fi, int flag)
 833 {
 834         set_bit(flag, &fi->flags);
 835 }
 836
 837 static inline int is_inode_flag_set(struct f2fs_inode_info *fi, int flag)
 838 {
 839         return test_bit(flag, &fi->flags);
 840 }
 841
 842 static inline void clear_inode_flag(struct f2fs_inode_info *fi, int flag)
 843 {
 844         clear_bit(flag, &fi->flags);
 845 }
 846
 847 static inline void set_acl_inode(struct f2fs_inode_info *fi, umode_t mode)
 848 {
 849         fi->i_acl_mode = mode;
 850         set_inode_flag(fi, FI_ACL_MODE);
 851 }
 852
 853 static inline int cond_clear_inode_flag(struct f2fs_inode_info *fi, int flag)
 854 {
 855         if (is_inode_flag_set(fi, FI_ACL_MODE)) {
 856                 clear_inode_flag(fi, FI_ACL_MODE);
 857                 return 1;
 858         }
 859         return 0;
 860 }
 861
 862 /*
 863  * file.c
 864  */
 865 int f2fs_sync_file(struct file *, loff_t, loff_t, int);
 866 void truncate_data_blocks(struct dnode_of_data *);
 867 void f2fs_truncate(struct inode *);
 868 int f2fs_setattr(struct dentry *, struct iattr *);
 869 int truncate_hole(struct inode *, pgoff_t, pgoff_t);
 870 long f2fs_ioctl(struct file *, unsigned int, unsigned long);
 871 long f2fs_compat_ioctl(struct file *, unsigned int, unsigned long);
 872
 873 /*
 874  * inode.c
 875  */
 876 void f2fs_set_inode_flags(struct inode *);
 877 struct inode *f2fs_iget(struct super_block *, unsigned long);
 878 void update_inode(struct inode *, struct page *);
 879 int f2fs_write_inode(struct inode *, struct writeback_control *);
 880 void f2fs_evict_inode(struct inode *);
 881
 882 /*
 883  * namei.c
 884  */
 885 struct dentry *f2fs_get_parent(struct dentry *child);
 886
 887 /*
 888  * dir.c
 889  */
 890 struct f2fs_dir_entry *f2fs_find_entry(struct inode *, struct qstr *,
 891                                                         struct page **);
 892 struct f2fs_dir_entry *f2fs_parent_dir(struct inode *, struct page **);
 893 ino_t f2fs_inode_by_name(struct inode *, struct qstr *);
 894 void f2fs_set_link(struct inode *, struct f2fs_dir_entry *,
 895                                 struct page *, struct inode *);
 896 void init_dent_inode(const struct qstr *, struct page *);
 897 int __f2fs_add_link(struct inode *, const struct qstr *, struct inode *);
 898 void f2fs_delete_entry(struct f2fs_dir_entry *, struct page *, struct inode *);
 899 int f2fs_make_empty(struct inode *, struct inode *);
 900 bool f2fs_empty_dir(struct inode *);
 901
 902 static inline int f2fs_add_link(struct dentry *dentry, struct inode *inode)
 903 {
 904         return __f2fs_add_link(dentry->d_parent->d_inode, &dentry->d_name,
 905                                 inode);
 906 }
 907
 908 /*
 909  * super.c
 910  */
 911 int f2fs_sync_fs(struct super_block *, int);
 912 extern __printf(3, 4)
 913 void f2fs_msg(struct super_block *, const char *, const char *, ...);
 914
 915 /*
 916  * hash.c
 917  */
 918 f2fs_hash_t f2fs_dentry_hash(const char *, size_t);
 919
 920 /*
 921  * node.c
 922  */
 923 struct dnode_of_data;
 924 struct node_info;
 925
 926 int is_checkpointed_node(struct f2fs_sb_info *, nid_t);
 927 void get_node_info(struct f2fs_sb_info *, nid_t, struct node_info *);
 928 int get_dnode_of_data(struct dnode_of_data *, pgoff_t, int);
 929 int truncate_inode_blocks(struct inode *, pgoff_t);
 930 int remove_inode_page(struct inode *);
 931 int new_inode_page(struct inode *, const struct qstr *);
 932 struct page *new_node_page(struct dnode_of_data *, unsigned int);
 933 void ra_node_page(struct f2fs_sb_info *, nid_t);
 934 struct page *get_node_page(struct f2fs_sb_info *, pgoff_t);
 935 struct page *get_node_page_ra(struct page *, int);
 936 void sync_inode_page(struct dnode_of_data *);
 937 int sync_node_pages(struct f2fs_sb_info *, nid_t, struct writeback_control *);
 938 bool alloc_nid(struct f2fs_sb_info *, nid_t *);
 939 void alloc_nid_done(struct f2fs_sb_info *, nid_t);
 940 void alloc_nid_failed(struct f2fs_sb_info *, nid_t);
 941 void recover_node_page(struct f2fs_sb_info *, struct page *,
 942                 struct f2fs_summary *, struct node_info *, block_t);
 943 int recover_inode_page(struct f2fs_sb_info *, struct page *);
 944 int restore_node_summary(struct f2fs_sb_info *, unsigned int,
 945                                 struct f2fs_summary_block *);
 946 void flush_nat_entries(struct f2fs_sb_info *);
 947 int build_node_manager(struct f2fs_sb_info *);
 948 void destroy_node_manager(struct f2fs_sb_info *);
 949 int __init create_node_manager_caches(void);
 950 void destroy_node_manager_caches(void);
 951
 952 /*
 953  * segment.c
 954  */
 955 void f2fs_balance_fs(struct f2fs_sb_info *);
 956 void invalidate_blocks(struct f2fs_sb_info *, block_t);
 957 void locate_dirty_segment(struct f2fs_sb_info *, unsigned int);
 958 void clear_prefree_segments(struct f2fs_sb_info *);
 959 int npages_for_summary_flush(struct f2fs_sb_info *);
 960 void allocate_new_segments(struct f2fs_sb_info *);
 961 struct page *get_sum_page(struct f2fs_sb_info *, unsigned int);
 962 struct bio *f2fs_bio_alloc(struct block_device *, int);
 963 void f2fs_submit_bio(struct f2fs_sb_info *, enum page_type, bool sync);
 964 void write_meta_page(struct f2fs_sb_info *, struct page *);
 965 void write_node_page(struct f2fs_sb_info *, struct page *, unsigned int,
 966                                         block_t, block_t *);
 967 void write_data_page(struct inode *, struct page *, struct dnode_of_data*,
 968                                         block_t, block_t *);
 969 void rewrite_data_page(struct f2fs_sb_info *, struct page *, block_t);
 970 void recover_data_page(struct f2fs_sb_info *, struct page *,
 971                                 struct f2fs_summary *, block_t, block_t);
 972 void rewrite_node_page(struct f2fs_sb_info *, struct page *,
 973                                 struct f2fs_summary *, block_t, block_t);
 974 void write_data_summaries(struct f2fs_sb_info *, block_t);
 975 void write_node_summaries(struct f2fs_sb_info *, block_t);
 976 int lookup_journal_in_cursum(struct f2fs_summary_block *,
 977                                         int, unsigned int, int);
 978 void flush_sit_entries(struct f2fs_sb_info *);
 979 int build_segment_manager(struct f2fs_sb_info *);
 980 void reset_victim_segmap(struct f2fs_sb_info *);
 981 void destroy_segment_manager(struct f2fs_sb_info *);
 982
 983 /*
 984  * checkpoint.c
 985  */
 986 struct page *grab_meta_page(struct f2fs_sb_info *, pgoff_t);
 987 struct page *get_meta_page(struct f2fs_sb_info *, pgoff_t);
 988 long sync_meta_pages(struct f2fs_sb_info *, enum page_type, long);
 989 int check_orphan_space(struct f2fs_sb_info *);
 990 void add_orphan_inode(struct f2fs_sb_info *, nid_t);
 991 void remove_orphan_inode(struct f2fs_sb_info *, nid_t);
 992 int recover_orphan_inodes(struct f2fs_sb_info *);
 993 int get_valid_checkpoint(struct f2fs_sb_info *);
 994 void set_dirty_dir_page(struct inode *, struct page *);
 995 void remove_dirty_dir_inode(struct inode *);
 996 void sync_dirty_dir_inodes(struct f2fs_sb_info *);
 997 void write_checkpoint(struct f2fs_sb_info *, bool);
 998 void init_orphan_info(struct f2fs_sb_info *);
 999 int __init create_checkpoint_caches(void);
1000 void destroy_checkpoint_caches(void);
1001
1002 /*
1003  * data.c
1004  */
1005 int reserve_new_block(struct dnode_of_data *);
1006 void update_extent_cache(block_t, struct dnode_of_data *);
1007 struct page *find_data_page(struct inode *, pgoff_t);
1008 struct page *get_lock_data_page(struct inode *, pgoff_t);
1009 struct page *get_new_data_page(struct inode *, pgoff_t, bool);
1010 int f2fs_readpage(struct f2fs_sb_info *, struct page *, block_t, int);
1011 int do_write_data_page(struct page *);
1012
1013 /*
1014  * gc.c
1015  */
1016 int start_gc_thread(struct f2fs_sb_info *);
1017 void stop_gc_thread(struct f2fs_sb_info *);
1018 block_t start_bidx_of_node(unsigned int);
1019 int f2fs_gc(struct f2fs_sb_info *);
1020 void build_gc_manager(struct f2fs_sb_info *);
1021 int __init create_gc_caches(void);
1022 void destroy_gc_caches(void);
1023
1024 /*
1025  * recovery.c
1026  */
1027 void recover_fsync_data(struct f2fs_sb_info *);
1028 bool space_for_roll_forward(struct f2fs_sb_info *);
1029
1030 /*
1031  * debug.c
1032  */
1033 #ifdef CONFIG_F2FS_STAT_FS
1034 struct f2fs_stat_info {
1035         struct list_head stat_list;
1036         struct f2fs_sb_info *sbi;
1037         struct mutex stat_lock;
1038         int all_area_segs, sit_area_segs, nat_area_segs, ssa_area_segs;
1039         int main_area_segs, main_area_sections, main_area_zones;
1040         int hit_ext, total_ext;
1041         int ndirty_node, ndirty_dent, ndirty_dirs, ndirty_meta;
1042         int nats, sits, fnids;
1043         int total_count, utilization;
1044         int bg_gc;
1045         unsigned int valid_count, valid_node_count, valid_inode_count;
1046         unsigned int bimodal, avg_vblocks;
1047         int util_free, util_valid, util_invalid;
1048         int rsvd_segs, overp_segs;
1049         int dirty_count, node_pages, meta_pages;
1050         int prefree_count, call_count;
1051         int tot_segs, node_segs, data_segs, free_segs, free_secs;
1052         int tot_blks, data_blks, node_blks;
1053         int curseg[NR_CURSEG_TYPE];
1054         int cursec[NR_CURSEG_TYPE];
1055         int curzone[NR_CURSEG_TYPE];
1056
1057         unsigned int segment_count[2];
1058         unsigned int block_count[2];
1059         unsigned base_mem, cache_mem;
1060 };
1061
1062 #define stat_inc_call_count(si) ((si)->call_count++)
1063
1064 #define stat_inc_seg_count(sbi, type)                                   \
1065         do {                                                            \
1066                 struct f2fs_stat_info *si = sbi->stat_info;             \
1067                 (si)->tot_segs++;                                       \
1068                 if (type == SUM_TYPE_DATA)                              \
1069                         si->data_segs++;                                \
1070                 else                                                    \
1071                         si->node_segs++;                                \
1072         } while (0)
1073
1074 #define stat_inc_tot_blk_count(si, blks)                                \
1075         (si->tot_blks += (blks))
1076
1077 #define stat_inc_data_blk_count(sbi, blks)                              \
1078         do {                                                            \
1079                 struct f2fs_stat_info *si = sbi->stat_info;             \
1080                 stat_inc_tot_blk_count(si, blks);                       \
1081                 si->data_blks += (blks);                                \
1082         } while (0)
1083
1084 #define stat_inc_node_blk_count(sbi, blks)                              \
1085         do {                                                            \
1086                 struct f2fs_stat_info *si = sbi->stat_info;             \
1087                 stat_inc_tot_blk_count(si, blks);                       \
1088                 si->node_blks += (blks);                                \
1089         } while (0)
1090
1091 int f2fs_build_stats(struct f2fs_sb_info *);
1092 void f2fs_destroy_stats(struct f2fs_sb_info *);
1093 void __init f2fs_create_root_stats(void);
1094 void f2fs_destroy_root_stats(void);
1095 #else
1096 #define stat_inc_call_count(si)
1097 #define stat_inc_seg_count(si, type)
1098 #define stat_inc_tot_blk_count(si, blks)
1099 #define stat_inc_data_blk_count(si, blks)
1100 #define stat_inc_node_blk_count(sbi, blks)
1101
1102 static inline int f2fs_build_stats(struct f2fs_sb_info *sbi) { return 0; }
1103 static inline void f2fs_destroy_stats(struct f2fs_sb_info *sbi) { }
1104 static inline void __init f2fs_create_root_stats(void) { }
1105 static inline void f2fs_destroy_root_stats(void) { }
1106 #endif
1107
1108 extern const struct file_operations f2fs_dir_operations;
1109 extern const struct file_operations f2fs_file_operations;
1110 extern const struct inode_operations f2fs_file_inode_operations;
1111 extern const struct address_space_operations f2fs_dblock_aops;
1112 extern const struct address_space_operations f2fs_node_aops;
1113 extern const struct address_space_operations f2fs_meta_aops;
1114 extern const struct inode_operations f2fs_dir_inode_operations;
1115 extern const struct inode_operations f2fs_symlink_inode_operations;
1116 extern const struct inode_operations f2fs_special_inode_operations;
1117 #endif