Merge tag 'fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/arm...
[linux-2.6.git] / fs / f2fs / f2fs.h
blob89dc7508faf2edf173441a9e25cad8a9ff4856aa
1 /*
2 * fs/f2fs/f2fs.h
4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
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.
11 #ifndef _LINUX_F2FS_H
12 #define _LINUX_F2FS_H
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>
23 #ifdef CONFIG_F2FS_CHECK_FS
24 #define f2fs_bug_on(condition) BUG_ON(condition)
25 #else
26 #define f2fs_bug_on(condition)
27 #endif
30 * For mount options
32 #define F2FS_MOUNT_BG_GC 0x00000001
33 #define F2FS_MOUNT_DISABLE_ROLL_FORWARD 0x00000002
34 #define F2FS_MOUNT_DISCARD 0x00000004
35 #define F2FS_MOUNT_NOHEAP 0x00000008
36 #define F2FS_MOUNT_XATTR_USER 0x00000010
37 #define F2FS_MOUNT_POSIX_ACL 0x00000020
38 #define F2FS_MOUNT_DISABLE_EXT_IDENTIFY 0x00000040
39 #define F2FS_MOUNT_INLINE_XATTR 0x00000080
41 #define clear_opt(sbi, option) (sbi->mount_opt.opt &= ~F2FS_MOUNT_##option)
42 #define set_opt(sbi, option) (sbi->mount_opt.opt |= F2FS_MOUNT_##option)
43 #define test_opt(sbi, option) (sbi->mount_opt.opt & F2FS_MOUNT_##option)
45 #define ver_after(a, b) (typecheck(unsigned long long, a) && \
46 typecheck(unsigned long long, b) && \
47 ((long long)((a) - (b)) > 0))
49 typedef u32 block_t; /*
50 * should not change u32, since it is the on-disk block
51 * address format, __le32.
53 typedef u32 nid_t;
55 struct f2fs_mount_info {
56 unsigned int opt;
59 #define CRCPOLY_LE 0xedb88320
61 static inline __u32 f2fs_crc32(void *buf, size_t len)
63 unsigned char *p = (unsigned char *)buf;
64 __u32 crc = F2FS_SUPER_MAGIC;
65 int i;
67 while (len--) {
68 crc ^= *p++;
69 for (i = 0; i < 8; i++)
70 crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY_LE : 0);
72 return crc;
75 static inline bool f2fs_crc_valid(__u32 blk_crc, void *buf, size_t buf_size)
77 return f2fs_crc32(buf, buf_size) == blk_crc;
81 * For checkpoint manager
83 enum {
84 NAT_BITMAP,
85 SIT_BITMAP
88 /* for the list of orphan inodes */
89 struct orphan_inode_entry {
90 struct list_head list; /* list head */
91 nid_t ino; /* inode number */
94 /* for the list of directory inodes */
95 struct dir_inode_entry {
96 struct list_head list; /* list head */
97 struct inode *inode; /* vfs inode pointer */
100 /* for the list of fsync inodes, used only during recovery */
101 struct fsync_inode_entry {
102 struct list_head list; /* list head */
103 struct inode *inode; /* vfs inode pointer */
104 block_t blkaddr; /* block address locating the last inode */
107 #define nats_in_cursum(sum) (le16_to_cpu(sum->n_nats))
108 #define sits_in_cursum(sum) (le16_to_cpu(sum->n_sits))
110 #define nat_in_journal(sum, i) (sum->nat_j.entries[i].ne)
111 #define nid_in_journal(sum, i) (sum->nat_j.entries[i].nid)
112 #define sit_in_journal(sum, i) (sum->sit_j.entries[i].se)
113 #define segno_in_journal(sum, i) (sum->sit_j.entries[i].segno)
115 static inline int update_nats_in_cursum(struct f2fs_summary_block *rs, int i)
117 int before = nats_in_cursum(rs);
118 rs->n_nats = cpu_to_le16(before + i);
119 return before;
122 static inline int update_sits_in_cursum(struct f2fs_summary_block *rs, int i)
124 int before = sits_in_cursum(rs);
125 rs->n_sits = cpu_to_le16(before + i);
126 return before;
130 * ioctl commands
132 #define F2FS_IOC_GETFLAGS FS_IOC_GETFLAGS
133 #define F2FS_IOC_SETFLAGS FS_IOC_SETFLAGS
135 #if defined(__KERNEL__) && defined(CONFIG_COMPAT)
137 * ioctl commands in 32 bit emulation
139 #define F2FS_IOC32_GETFLAGS FS_IOC32_GETFLAGS
140 #define F2FS_IOC32_SETFLAGS FS_IOC32_SETFLAGS
141 #endif
144 * For INODE and NODE manager
147 * XATTR_NODE_OFFSET stores xattrs to one node block per file keeping -1
148 * as its node offset to distinguish from index node blocks.
149 * But some bits are used to mark the node block.
151 #define XATTR_NODE_OFFSET ((((unsigned int)-1) << OFFSET_BIT_SHIFT) \
152 >> OFFSET_BIT_SHIFT)
153 enum {
154 ALLOC_NODE, /* allocate a new node page if needed */
155 LOOKUP_NODE, /* look up a node without readahead */
156 LOOKUP_NODE_RA, /*
157 * look up a node with readahead called
158 * by get_datablock_ro.
162 #define F2FS_LINK_MAX 32000 /* maximum link count per file */
164 /* for in-memory extent cache entry */
165 struct extent_info {
166 rwlock_t ext_lock; /* rwlock for consistency */
167 unsigned int fofs; /* start offset in a file */
168 u32 blk_addr; /* start block address of the extent */
169 unsigned int len; /* length of the extent */
173 * i_advise uses FADVISE_XXX_BIT. We can add additional hints later.
175 #define FADVISE_COLD_BIT 0x01
176 #define FADVISE_LOST_PINO_BIT 0x02
178 struct f2fs_inode_info {
179 struct inode vfs_inode; /* serve a vfs inode */
180 unsigned long i_flags; /* keep an inode flags for ioctl */
181 unsigned char i_advise; /* use to give file attribute hints */
182 unsigned int i_current_depth; /* use only in directory structure */
183 unsigned int i_pino; /* parent inode number */
184 umode_t i_acl_mode; /* keep file acl mode temporarily */
186 /* Use below internally in f2fs*/
187 unsigned long flags; /* use to pass per-file flags */
188 atomic_t dirty_dents; /* # of dirty dentry pages */
189 f2fs_hash_t chash; /* hash value of given file name */
190 unsigned int clevel; /* maximum level of given file name */
191 nid_t i_xattr_nid; /* node id that contains xattrs */
192 unsigned long long xattr_ver; /* cp version of xattr modification */
193 struct extent_info ext; /* in-memory extent cache entry */
196 static inline void get_extent_info(struct extent_info *ext,
197 struct f2fs_extent i_ext)
199 write_lock(&ext->ext_lock);
200 ext->fofs = le32_to_cpu(i_ext.fofs);
201 ext->blk_addr = le32_to_cpu(i_ext.blk_addr);
202 ext->len = le32_to_cpu(i_ext.len);
203 write_unlock(&ext->ext_lock);
206 static inline void set_raw_extent(struct extent_info *ext,
207 struct f2fs_extent *i_ext)
209 read_lock(&ext->ext_lock);
210 i_ext->fofs = cpu_to_le32(ext->fofs);
211 i_ext->blk_addr = cpu_to_le32(ext->blk_addr);
212 i_ext->len = cpu_to_le32(ext->len);
213 read_unlock(&ext->ext_lock);
216 struct f2fs_nm_info {
217 block_t nat_blkaddr; /* base disk address of NAT */
218 nid_t max_nid; /* maximum possible node ids */
219 nid_t next_scan_nid; /* the next nid to be scanned */
221 /* NAT cache management */
222 struct radix_tree_root nat_root;/* root of the nat entry cache */
223 rwlock_t nat_tree_lock; /* protect nat_tree_lock */
224 unsigned int nat_cnt; /* the # of cached nat entries */
225 struct list_head nat_entries; /* cached nat entry list (clean) */
226 struct list_head dirty_nat_entries; /* cached nat entry list (dirty) */
228 /* free node ids management */
229 struct list_head free_nid_list; /* a list for free nids */
230 spinlock_t free_nid_list_lock; /* protect free nid list */
231 unsigned int fcnt; /* the number of free node id */
232 struct mutex build_lock; /* lock for build free nids */
234 /* for checkpoint */
235 char *nat_bitmap; /* NAT bitmap pointer */
236 int bitmap_size; /* bitmap size */
240 * this structure is used as one of function parameters.
241 * all the information are dedicated to a given direct node block determined
242 * by the data offset in a file.
244 struct dnode_of_data {
245 struct inode *inode; /* vfs inode pointer */
246 struct page *inode_page; /* its inode page, NULL is possible */
247 struct page *node_page; /* cached direct node page */
248 nid_t nid; /* node id of the direct node block */
249 unsigned int ofs_in_node; /* data offset in the node page */
250 bool inode_page_locked; /* inode page is locked or not */
251 block_t data_blkaddr; /* block address of the node block */
254 static inline void set_new_dnode(struct dnode_of_data *dn, struct inode *inode,
255 struct page *ipage, struct page *npage, nid_t nid)
257 memset(dn, 0, sizeof(*dn));
258 dn->inode = inode;
259 dn->inode_page = ipage;
260 dn->node_page = npage;
261 dn->nid = nid;
265 * For SIT manager
267 * By default, there are 6 active log areas across the whole main area.
268 * When considering hot and cold data separation to reduce cleaning overhead,
269 * we split 3 for data logs and 3 for node logs as hot, warm, and cold types,
270 * respectively.
271 * In the current design, you should not change the numbers intentionally.
272 * Instead, as a mount option such as active_logs=x, you can use 2, 4, and 6
273 * logs individually according to the underlying devices. (default: 6)
274 * Just in case, on-disk layout covers maximum 16 logs that consist of 8 for
275 * data and 8 for node logs.
277 #define NR_CURSEG_DATA_TYPE (3)
278 #define NR_CURSEG_NODE_TYPE (3)
279 #define NR_CURSEG_TYPE (NR_CURSEG_DATA_TYPE + NR_CURSEG_NODE_TYPE)
281 enum {
282 CURSEG_HOT_DATA = 0, /* directory entry blocks */
283 CURSEG_WARM_DATA, /* data blocks */
284 CURSEG_COLD_DATA, /* multimedia or GCed data blocks */
285 CURSEG_HOT_NODE, /* direct node blocks of directory files */
286 CURSEG_WARM_NODE, /* direct node blocks of normal files */
287 CURSEG_COLD_NODE, /* indirect node blocks */
288 NO_CHECK_TYPE
291 struct f2fs_sm_info {
292 struct sit_info *sit_info; /* whole segment information */
293 struct free_segmap_info *free_info; /* free segment information */
294 struct dirty_seglist_info *dirty_info; /* dirty segment information */
295 struct curseg_info *curseg_array; /* active segment information */
297 struct list_head wblist_head; /* list of under-writeback pages */
298 spinlock_t wblist_lock; /* lock for checkpoint */
300 block_t seg0_blkaddr; /* block address of 0'th segment */
301 block_t main_blkaddr; /* start block address of main area */
302 block_t ssa_blkaddr; /* start block address of SSA area */
304 unsigned int segment_count; /* total # of segments */
305 unsigned int main_segments; /* # of segments in main area */
306 unsigned int reserved_segments; /* # of reserved segments */
307 unsigned int ovp_segments; /* # of overprovision segments */
309 /* a threshold to reclaim prefree segments */
310 unsigned int rec_prefree_segments;
314 * For superblock
317 * COUNT_TYPE for monitoring
319 * f2fs monitors the number of several block types such as on-writeback,
320 * dirty dentry blocks, dirty node blocks, and dirty meta blocks.
322 enum count_type {
323 F2FS_WRITEBACK,
324 F2FS_DIRTY_DENTS,
325 F2FS_DIRTY_NODES,
326 F2FS_DIRTY_META,
327 NR_COUNT_TYPE,
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.
341 enum page_type {
342 DATA,
343 NODE,
344 META,
345 NR_PAGE_TYPE,
346 META_FLUSH,
349 struct f2fs_sb_info {
350 struct super_block *sb; /* pointer to VFS super block */
351 struct proc_dir_entry *s_proc; /* proc entry */
352 struct buffer_head *raw_super_buf; /* buffer head of raw sb */
353 struct f2fs_super_block *raw_super; /* raw super block pointer */
354 int s_dirty; /* dirty flag for checkpoint */
356 /* for node-related operations */
357 struct f2fs_nm_info *nm_info; /* node manager */
358 struct inode *node_inode; /* cache node blocks */
360 /* for segment-related operations */
361 struct f2fs_sm_info *sm_info; /* segment manager */
362 struct bio *bio[NR_PAGE_TYPE]; /* bios to merge */
363 sector_t last_block_in_bio[NR_PAGE_TYPE]; /* last block number */
364 struct rw_semaphore bio_sem; /* IO semaphore */
366 /* for checkpoint */
367 struct f2fs_checkpoint *ckpt; /* raw checkpoint pointer */
368 struct inode *meta_inode; /* cache meta blocks */
369 struct mutex cp_mutex; /* checkpoint procedure lock */
370 struct rw_semaphore cp_rwsem; /* blocking FS operations */
371 struct mutex node_write; /* locking node writes */
372 struct mutex writepages; /* mutex for writepages() */
373 bool por_doing; /* recovery is doing or not */
374 bool on_build_free_nids; /* build_free_nids is doing */
375 wait_queue_head_t cp_wait;
377 /* for orphan inode management */
378 struct list_head orphan_inode_list; /* orphan inode list */
379 struct mutex orphan_inode_mutex; /* for orphan inode list */
380 unsigned int n_orphans; /* # of orphan inodes */
382 /* for directory inode management */
383 struct list_head dir_inode_list; /* dir inode list */
384 spinlock_t dir_inode_lock; /* for dir inode list lock */
386 /* basic file system units */
387 unsigned int log_sectors_per_block; /* log2 sectors per block */
388 unsigned int log_blocksize; /* log2 block size */
389 unsigned int blocksize; /* block size */
390 unsigned int root_ino_num; /* root inode number*/
391 unsigned int node_ino_num; /* node inode number*/
392 unsigned int meta_ino_num; /* meta inode number*/
393 unsigned int log_blocks_per_seg; /* log2 blocks per segment */
394 unsigned int blocks_per_seg; /* blocks per segment */
395 unsigned int segs_per_sec; /* segments per section */
396 unsigned int secs_per_zone; /* sections per zone */
397 unsigned int total_sections; /* total section count */
398 unsigned int total_node_count; /* total node block count */
399 unsigned int total_valid_node_count; /* valid node block count */
400 unsigned int total_valid_inode_count; /* valid inode count */
401 int active_logs; /* # of active logs */
403 block_t user_block_count; /* # of user blocks */
404 block_t total_valid_block_count; /* # of valid blocks */
405 block_t alloc_valid_block_count; /* # of allocated blocks */
406 block_t last_valid_block_count; /* for recovery */
407 u32 s_next_generation; /* for NFS support */
408 atomic_t nr_pages[NR_COUNT_TYPE]; /* # of pages, see count_type */
410 struct f2fs_mount_info mount_opt; /* mount options */
412 /* for cleaning operations */
413 struct mutex gc_mutex; /* mutex for GC */
414 struct f2fs_gc_kthread *gc_thread; /* GC thread */
415 unsigned int cur_victim_sec; /* current victim section num */
418 * for stat information.
419 * one is for the LFS mode, and the other is for the SSR mode.
421 #ifdef CONFIG_F2FS_STAT_FS
422 struct f2fs_stat_info *stat_info; /* FS status information */
423 unsigned int segment_count[2]; /* # of allocated segments */
424 unsigned int block_count[2]; /* # of allocated blocks */
425 int total_hit_ext, read_hit_ext; /* extent cache hit ratio */
426 int bg_gc; /* background gc calls */
427 unsigned int n_dirty_dirs; /* # of dir inodes */
428 #endif
429 unsigned int last_victim[2]; /* last victim segment # */
430 spinlock_t stat_lock; /* lock for stat operations */
432 /* For sysfs suppport */
433 struct kobject s_kobj;
434 struct completion s_kobj_unregister;
438 * Inline functions
440 static inline struct f2fs_inode_info *F2FS_I(struct inode *inode)
442 return container_of(inode, struct f2fs_inode_info, vfs_inode);
445 static inline struct f2fs_sb_info *F2FS_SB(struct super_block *sb)
447 return sb->s_fs_info;
450 static inline struct f2fs_super_block *F2FS_RAW_SUPER(struct f2fs_sb_info *sbi)
452 return (struct f2fs_super_block *)(sbi->raw_super);
455 static inline struct f2fs_checkpoint *F2FS_CKPT(struct f2fs_sb_info *sbi)
457 return (struct f2fs_checkpoint *)(sbi->ckpt);
460 static inline struct f2fs_node *F2FS_NODE(struct page *page)
462 return (struct f2fs_node *)page_address(page);
465 static inline struct f2fs_nm_info *NM_I(struct f2fs_sb_info *sbi)
467 return (struct f2fs_nm_info *)(sbi->nm_info);
470 static inline struct f2fs_sm_info *SM_I(struct f2fs_sb_info *sbi)
472 return (struct f2fs_sm_info *)(sbi->sm_info);
475 static inline struct sit_info *SIT_I(struct f2fs_sb_info *sbi)
477 return (struct sit_info *)(SM_I(sbi)->sit_info);
480 static inline struct free_segmap_info *FREE_I(struct f2fs_sb_info *sbi)
482 return (struct free_segmap_info *)(SM_I(sbi)->free_info);
485 static inline struct dirty_seglist_info *DIRTY_I(struct f2fs_sb_info *sbi)
487 return (struct dirty_seglist_info *)(SM_I(sbi)->dirty_info);
490 static inline void F2FS_SET_SB_DIRT(struct f2fs_sb_info *sbi)
492 sbi->s_dirty = 1;
495 static inline void F2FS_RESET_SB_DIRT(struct f2fs_sb_info *sbi)
497 sbi->s_dirty = 0;
500 static inline unsigned long long cur_cp_version(struct f2fs_checkpoint *cp)
502 return le64_to_cpu(cp->checkpoint_ver);
505 static inline bool is_set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
507 unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
508 return ckpt_flags & f;
511 static inline void set_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
513 unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
514 ckpt_flags |= f;
515 cp->ckpt_flags = cpu_to_le32(ckpt_flags);
518 static inline void clear_ckpt_flags(struct f2fs_checkpoint *cp, unsigned int f)
520 unsigned int ckpt_flags = le32_to_cpu(cp->ckpt_flags);
521 ckpt_flags &= (~f);
522 cp->ckpt_flags = cpu_to_le32(ckpt_flags);
525 static inline void f2fs_lock_op(struct f2fs_sb_info *sbi)
527 down_read(&sbi->cp_rwsem);
530 static inline void f2fs_unlock_op(struct f2fs_sb_info *sbi)
532 up_read(&sbi->cp_rwsem);
535 static inline void f2fs_lock_all(struct f2fs_sb_info *sbi)
537 down_write_nest_lock(&sbi->cp_rwsem, &sbi->cp_mutex);
540 static inline void f2fs_unlock_all(struct f2fs_sb_info *sbi)
542 up_write(&sbi->cp_rwsem);
546 * Check whether the given nid is within node id range.
548 static inline int check_nid_range(struct f2fs_sb_info *sbi, nid_t nid)
550 WARN_ON((nid >= NM_I(sbi)->max_nid));
551 if (nid >= NM_I(sbi)->max_nid)
552 return -EINVAL;
553 return 0;
556 #define F2FS_DEFAULT_ALLOCATED_BLOCKS 1
559 * Check whether the inode has blocks or not
561 static inline int F2FS_HAS_BLOCKS(struct inode *inode)
563 if (F2FS_I(inode)->i_xattr_nid)
564 return (inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS + 1);
565 else
566 return (inode->i_blocks > F2FS_DEFAULT_ALLOCATED_BLOCKS);
569 static inline bool inc_valid_block_count(struct f2fs_sb_info *sbi,
570 struct inode *inode, blkcnt_t count)
572 block_t valid_block_count;
574 spin_lock(&sbi->stat_lock);
575 valid_block_count =
576 sbi->total_valid_block_count + (block_t)count;
577 if (valid_block_count > sbi->user_block_count) {
578 spin_unlock(&sbi->stat_lock);
579 return false;
581 inode->i_blocks += count;
582 sbi->total_valid_block_count = valid_block_count;
583 sbi->alloc_valid_block_count += (block_t)count;
584 spin_unlock(&sbi->stat_lock);
585 return true;
588 static inline int dec_valid_block_count(struct f2fs_sb_info *sbi,
589 struct inode *inode,
590 blkcnt_t count)
592 spin_lock(&sbi->stat_lock);
593 f2fs_bug_on(sbi->total_valid_block_count < (block_t) count);
594 f2fs_bug_on(inode->i_blocks < count);
595 inode->i_blocks -= count;
596 sbi->total_valid_block_count -= (block_t)count;
597 spin_unlock(&sbi->stat_lock);
598 return 0;
601 static inline void inc_page_count(struct f2fs_sb_info *sbi, int count_type)
603 atomic_inc(&sbi->nr_pages[count_type]);
604 F2FS_SET_SB_DIRT(sbi);
607 static inline void inode_inc_dirty_dents(struct inode *inode)
609 atomic_inc(&F2FS_I(inode)->dirty_dents);
612 static inline void dec_page_count(struct f2fs_sb_info *sbi, int count_type)
614 atomic_dec(&sbi->nr_pages[count_type]);
617 static inline void inode_dec_dirty_dents(struct inode *inode)
619 atomic_dec(&F2FS_I(inode)->dirty_dents);
622 static inline int get_pages(struct f2fs_sb_info *sbi, int count_type)
624 return atomic_read(&sbi->nr_pages[count_type]);
627 static inline int get_blocktype_secs(struct f2fs_sb_info *sbi, int block_type)
629 unsigned int pages_per_sec = sbi->segs_per_sec *
630 (1 << sbi->log_blocks_per_seg);
631 return ((get_pages(sbi, block_type) + pages_per_sec - 1)
632 >> sbi->log_blocks_per_seg) / sbi->segs_per_sec;
635 static inline block_t valid_user_blocks(struct f2fs_sb_info *sbi)
637 block_t ret;
638 spin_lock(&sbi->stat_lock);
639 ret = sbi->total_valid_block_count;
640 spin_unlock(&sbi->stat_lock);
641 return ret;
644 static inline unsigned long __bitmap_size(struct f2fs_sb_info *sbi, int flag)
646 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
648 /* return NAT or SIT bitmap */
649 if (flag == NAT_BITMAP)
650 return le32_to_cpu(ckpt->nat_ver_bitmap_bytesize);
651 else if (flag == SIT_BITMAP)
652 return le32_to_cpu(ckpt->sit_ver_bitmap_bytesize);
654 return 0;
657 static inline void *__bitmap_ptr(struct f2fs_sb_info *sbi, int flag)
659 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
660 int offset = (flag == NAT_BITMAP) ?
661 le32_to_cpu(ckpt->sit_ver_bitmap_bytesize) : 0;
662 return &ckpt->sit_nat_version_bitmap + offset;
665 static inline block_t __start_cp_addr(struct f2fs_sb_info *sbi)
667 block_t start_addr;
668 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
669 unsigned long long ckpt_version = cur_cp_version(ckpt);
671 start_addr = le32_to_cpu(F2FS_RAW_SUPER(sbi)->cp_blkaddr);
674 * odd numbered checkpoint should at cp segment 0
675 * and even segent must be at cp segment 1
677 if (!(ckpt_version & 1))
678 start_addr += sbi->blocks_per_seg;
680 return start_addr;
683 static inline block_t __start_sum_addr(struct f2fs_sb_info *sbi)
685 return le32_to_cpu(F2FS_CKPT(sbi)->cp_pack_start_sum);
688 static inline bool inc_valid_node_count(struct f2fs_sb_info *sbi,
689 struct inode *inode,
690 unsigned int count)
692 block_t valid_block_count;
693 unsigned int valid_node_count;
695 spin_lock(&sbi->stat_lock);
697 valid_block_count = sbi->total_valid_block_count + (block_t)count;
698 sbi->alloc_valid_block_count += (block_t)count;
699 valid_node_count = sbi->total_valid_node_count + count;
701 if (valid_block_count > sbi->user_block_count) {
702 spin_unlock(&sbi->stat_lock);
703 return false;
706 if (valid_node_count > sbi->total_node_count) {
707 spin_unlock(&sbi->stat_lock);
708 return false;
711 if (inode)
712 inode->i_blocks += count;
713 sbi->total_valid_node_count = valid_node_count;
714 sbi->total_valid_block_count = valid_block_count;
715 spin_unlock(&sbi->stat_lock);
717 return true;
720 static inline void dec_valid_node_count(struct f2fs_sb_info *sbi,
721 struct inode *inode,
722 unsigned int count)
724 spin_lock(&sbi->stat_lock);
726 f2fs_bug_on(sbi->total_valid_block_count < count);
727 f2fs_bug_on(sbi->total_valid_node_count < count);
728 f2fs_bug_on(inode->i_blocks < count);
730 inode->i_blocks -= count;
731 sbi->total_valid_node_count -= count;
732 sbi->total_valid_block_count -= (block_t)count;
734 spin_unlock(&sbi->stat_lock);
737 static inline unsigned int valid_node_count(struct f2fs_sb_info *sbi)
739 unsigned int ret;
740 spin_lock(&sbi->stat_lock);
741 ret = sbi->total_valid_node_count;
742 spin_unlock(&sbi->stat_lock);
743 return ret;
746 static inline void inc_valid_inode_count(struct f2fs_sb_info *sbi)
748 spin_lock(&sbi->stat_lock);
749 f2fs_bug_on(sbi->total_valid_inode_count == sbi->total_node_count);
750 sbi->total_valid_inode_count++;
751 spin_unlock(&sbi->stat_lock);
754 static inline int dec_valid_inode_count(struct f2fs_sb_info *sbi)
756 spin_lock(&sbi->stat_lock);
757 f2fs_bug_on(!sbi->total_valid_inode_count);
758 sbi->total_valid_inode_count--;
759 spin_unlock(&sbi->stat_lock);
760 return 0;
763 static inline unsigned int valid_inode_count(struct f2fs_sb_info *sbi)
765 unsigned int ret;
766 spin_lock(&sbi->stat_lock);
767 ret = sbi->total_valid_inode_count;
768 spin_unlock(&sbi->stat_lock);
769 return ret;
772 static inline void f2fs_put_page(struct page *page, int unlock)
774 if (!page || IS_ERR(page))
775 return;
777 if (unlock) {
778 f2fs_bug_on(!PageLocked(page));
779 unlock_page(page);
781 page_cache_release(page);
784 static inline void f2fs_put_dnode(struct dnode_of_data *dn)
786 if (dn->node_page)
787 f2fs_put_page(dn->node_page, 1);
788 if (dn->inode_page && dn->node_page != dn->inode_page)
789 f2fs_put_page(dn->inode_page, 0);
790 dn->node_page = NULL;
791 dn->inode_page = NULL;
794 static inline struct kmem_cache *f2fs_kmem_cache_create(const char *name,
795 size_t size, void (*ctor)(void *))
797 return kmem_cache_create(name, size, 0, SLAB_RECLAIM_ACCOUNT, ctor);
800 static inline void *f2fs_kmem_cache_alloc(struct kmem_cache *cachep,
801 gfp_t flags)
803 void *entry;
804 retry:
805 entry = kmem_cache_alloc(cachep, flags);
806 if (!entry) {
807 cond_resched();
808 goto retry;
811 return entry;
814 #define RAW_IS_INODE(p) ((p)->footer.nid == (p)->footer.ino)
816 static inline bool IS_INODE(struct page *page)
818 struct f2fs_node *p = F2FS_NODE(page);
819 return RAW_IS_INODE(p);
822 static inline __le32 *blkaddr_in_node(struct f2fs_node *node)
824 return RAW_IS_INODE(node) ? node->i.i_addr : node->dn.addr;
827 static inline block_t datablock_addr(struct page *node_page,
828 unsigned int offset)
830 struct f2fs_node *raw_node;
831 __le32 *addr_array;
832 raw_node = F2FS_NODE(node_page);
833 addr_array = blkaddr_in_node(raw_node);
834 return le32_to_cpu(addr_array[offset]);
837 static inline int f2fs_test_bit(unsigned int nr, char *addr)
839 int mask;
841 addr += (nr >> 3);
842 mask = 1 << (7 - (nr & 0x07));
843 return mask & *addr;
846 static inline int f2fs_set_bit(unsigned int nr, char *addr)
848 int mask;
849 int ret;
851 addr += (nr >> 3);
852 mask = 1 << (7 - (nr & 0x07));
853 ret = mask & *addr;
854 *addr |= mask;
855 return ret;
858 static inline int f2fs_clear_bit(unsigned int nr, char *addr)
860 int mask;
861 int ret;
863 addr += (nr >> 3);
864 mask = 1 << (7 - (nr & 0x07));
865 ret = mask & *addr;
866 *addr &= ~mask;
867 return ret;
870 /* used for f2fs_inode_info->flags */
871 enum {
872 FI_NEW_INODE, /* indicate newly allocated inode */
873 FI_DIRTY_INODE, /* indicate inode is dirty or not */
874 FI_INC_LINK, /* need to increment i_nlink */
875 FI_ACL_MODE, /* indicate acl mode */
876 FI_NO_ALLOC, /* should not allocate any blocks */
877 FI_UPDATE_DIR, /* should update inode block for consistency */
878 FI_DELAY_IPUT, /* used for the recovery */
879 FI_INLINE_XATTR, /* used for inline xattr */
882 static inline void set_inode_flag(struct f2fs_inode_info *fi, int flag)
884 set_bit(flag, &fi->flags);
887 static inline int is_inode_flag_set(struct f2fs_inode_info *fi, int flag)
889 return test_bit(flag, &fi->flags);
892 static inline void clear_inode_flag(struct f2fs_inode_info *fi, int flag)
894 clear_bit(flag, &fi->flags);
897 static inline void set_acl_inode(struct f2fs_inode_info *fi, umode_t mode)
899 fi->i_acl_mode = mode;
900 set_inode_flag(fi, FI_ACL_MODE);
903 static inline int cond_clear_inode_flag(struct f2fs_inode_info *fi, int flag)
905 if (is_inode_flag_set(fi, FI_ACL_MODE)) {
906 clear_inode_flag(fi, FI_ACL_MODE);
907 return 1;
909 return 0;
912 static inline void get_inline_info(struct f2fs_inode_info *fi,
913 struct f2fs_inode *ri)
915 if (ri->i_inline & F2FS_INLINE_XATTR)
916 set_inode_flag(fi, FI_INLINE_XATTR);
919 static inline void set_raw_inline(struct f2fs_inode_info *fi,
920 struct f2fs_inode *ri)
922 ri->i_inline = 0;
924 if (is_inode_flag_set(fi, FI_INLINE_XATTR))
925 ri->i_inline |= F2FS_INLINE_XATTR;
928 static inline unsigned int addrs_per_inode(struct f2fs_inode_info *fi)
930 if (is_inode_flag_set(fi, FI_INLINE_XATTR))
931 return DEF_ADDRS_PER_INODE - F2FS_INLINE_XATTR_ADDRS;
932 return DEF_ADDRS_PER_INODE;
935 static inline void *inline_xattr_addr(struct page *page)
937 struct f2fs_inode *ri;
938 ri = (struct f2fs_inode *)page_address(page);
939 return (void *)&(ri->i_addr[DEF_ADDRS_PER_INODE -
940 F2FS_INLINE_XATTR_ADDRS]);
943 static inline int inline_xattr_size(struct inode *inode)
945 if (is_inode_flag_set(F2FS_I(inode), FI_INLINE_XATTR))
946 return F2FS_INLINE_XATTR_ADDRS << 2;
947 else
948 return 0;
951 static inline int f2fs_readonly(struct super_block *sb)
953 return sb->s_flags & MS_RDONLY;
957 * file.c
959 int f2fs_sync_file(struct file *, loff_t, loff_t, int);
960 void truncate_data_blocks(struct dnode_of_data *);
961 void f2fs_truncate(struct inode *);
962 int f2fs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
963 int f2fs_setattr(struct dentry *, struct iattr *);
964 int truncate_hole(struct inode *, pgoff_t, pgoff_t);
965 int truncate_data_blocks_range(struct dnode_of_data *, int);
966 long f2fs_ioctl(struct file *, unsigned int, unsigned long);
967 long f2fs_compat_ioctl(struct file *, unsigned int, unsigned long);
970 * inode.c
972 void f2fs_set_inode_flags(struct inode *);
973 struct inode *f2fs_iget(struct super_block *, unsigned long);
974 int try_to_free_nats(struct f2fs_sb_info *, int);
975 void update_inode(struct inode *, struct page *);
976 int update_inode_page(struct inode *);
977 int f2fs_write_inode(struct inode *, struct writeback_control *);
978 void f2fs_evict_inode(struct inode *);
981 * namei.c
983 struct dentry *f2fs_get_parent(struct dentry *child);
986 * dir.c
988 struct f2fs_dir_entry *f2fs_find_entry(struct inode *, struct qstr *,
989 struct page **);
990 struct f2fs_dir_entry *f2fs_parent_dir(struct inode *, struct page **);
991 ino_t f2fs_inode_by_name(struct inode *, struct qstr *);
992 void f2fs_set_link(struct inode *, struct f2fs_dir_entry *,
993 struct page *, struct inode *);
994 int update_dent_inode(struct inode *, const struct qstr *);
995 int __f2fs_add_link(struct inode *, const struct qstr *, struct inode *);
996 void f2fs_delete_entry(struct f2fs_dir_entry *, struct page *, struct inode *);
997 int f2fs_make_empty(struct inode *, struct inode *);
998 bool f2fs_empty_dir(struct inode *);
1000 static inline int f2fs_add_link(struct dentry *dentry, struct inode *inode)
1002 return __f2fs_add_link(dentry->d_parent->d_inode, &dentry->d_name,
1003 inode);
1007 * super.c
1009 int f2fs_sync_fs(struct super_block *, int);
1010 extern __printf(3, 4)
1011 void f2fs_msg(struct super_block *, const char *, const char *, ...);
1014 * hash.c
1016 f2fs_hash_t f2fs_dentry_hash(const char *, size_t);
1019 * node.c
1021 struct dnode_of_data;
1022 struct node_info;
1024 int is_checkpointed_node(struct f2fs_sb_info *, nid_t);
1025 void get_node_info(struct f2fs_sb_info *, nid_t, struct node_info *);
1026 int get_dnode_of_data(struct dnode_of_data *, pgoff_t, int);
1027 int truncate_inode_blocks(struct inode *, pgoff_t);
1028 int truncate_xattr_node(struct inode *, struct page *);
1029 int wait_on_node_pages_writeback(struct f2fs_sb_info *, nid_t);
1030 int remove_inode_page(struct inode *);
1031 struct page *new_inode_page(struct inode *, const struct qstr *);
1032 struct page *new_node_page(struct dnode_of_data *, unsigned int, struct page *);
1033 void ra_node_page(struct f2fs_sb_info *, nid_t);
1034 struct page *get_node_page(struct f2fs_sb_info *, pgoff_t);
1035 struct page *get_node_page_ra(struct page *, int);
1036 void sync_inode_page(struct dnode_of_data *);
1037 int sync_node_pages(struct f2fs_sb_info *, nid_t, struct writeback_control *);
1038 bool alloc_nid(struct f2fs_sb_info *, nid_t *);
1039 void alloc_nid_done(struct f2fs_sb_info *, nid_t);
1040 void alloc_nid_failed(struct f2fs_sb_info *, nid_t);
1041 void recover_node_page(struct f2fs_sb_info *, struct page *,
1042 struct f2fs_summary *, struct node_info *, block_t);
1043 int recover_inode_page(struct f2fs_sb_info *, struct page *);
1044 int restore_node_summary(struct f2fs_sb_info *, unsigned int,
1045 struct f2fs_summary_block *);
1046 void flush_nat_entries(struct f2fs_sb_info *);
1047 int build_node_manager(struct f2fs_sb_info *);
1048 void destroy_node_manager(struct f2fs_sb_info *);
1049 int __init create_node_manager_caches(void);
1050 void destroy_node_manager_caches(void);
1053 * segment.c
1055 void f2fs_balance_fs(struct f2fs_sb_info *);
1056 void f2fs_balance_fs_bg(struct f2fs_sb_info *);
1057 void invalidate_blocks(struct f2fs_sb_info *, block_t);
1058 void clear_prefree_segments(struct f2fs_sb_info *);
1059 int npages_for_summary_flush(struct f2fs_sb_info *);
1060 void allocate_new_segments(struct f2fs_sb_info *);
1061 struct page *get_sum_page(struct f2fs_sb_info *, unsigned int);
1062 struct bio *f2fs_bio_alloc(struct block_device *, int);
1063 void f2fs_submit_bio(struct f2fs_sb_info *, enum page_type, bool);
1064 void f2fs_wait_on_page_writeback(struct page *, enum page_type, bool);
1065 void write_meta_page(struct f2fs_sb_info *, struct page *);
1066 void write_node_page(struct f2fs_sb_info *, struct page *, unsigned int,
1067 block_t, block_t *);
1068 void write_data_page(struct inode *, struct page *, struct dnode_of_data*,
1069 block_t, block_t *);
1070 void rewrite_data_page(struct f2fs_sb_info *, struct page *, block_t);
1071 void recover_data_page(struct f2fs_sb_info *, struct page *,
1072 struct f2fs_summary *, block_t, block_t);
1073 void rewrite_node_page(struct f2fs_sb_info *, struct page *,
1074 struct f2fs_summary *, block_t, block_t);
1075 void write_data_summaries(struct f2fs_sb_info *, block_t);
1076 void write_node_summaries(struct f2fs_sb_info *, block_t);
1077 int lookup_journal_in_cursum(struct f2fs_summary_block *,
1078 int, unsigned int, int);
1079 void flush_sit_entries(struct f2fs_sb_info *);
1080 int build_segment_manager(struct f2fs_sb_info *);
1081 void destroy_segment_manager(struct f2fs_sb_info *);
1084 * checkpoint.c
1086 struct page *grab_meta_page(struct f2fs_sb_info *, pgoff_t);
1087 struct page *get_meta_page(struct f2fs_sb_info *, pgoff_t);
1088 long sync_meta_pages(struct f2fs_sb_info *, enum page_type, long);
1089 int acquire_orphan_inode(struct f2fs_sb_info *);
1090 void release_orphan_inode(struct f2fs_sb_info *);
1091 void add_orphan_inode(struct f2fs_sb_info *, nid_t);
1092 void remove_orphan_inode(struct f2fs_sb_info *, nid_t);
1093 int recover_orphan_inodes(struct f2fs_sb_info *);
1094 int get_valid_checkpoint(struct f2fs_sb_info *);
1095 void set_dirty_dir_page(struct inode *, struct page *);
1096 void add_dirty_dir_inode(struct inode *);
1097 void remove_dirty_dir_inode(struct inode *);
1098 struct inode *check_dirty_dir_inode(struct f2fs_sb_info *, nid_t);
1099 void sync_dirty_dir_inodes(struct f2fs_sb_info *);
1100 void write_checkpoint(struct f2fs_sb_info *, bool);
1101 void init_orphan_info(struct f2fs_sb_info *);
1102 int __init create_checkpoint_caches(void);
1103 void destroy_checkpoint_caches(void);
1106 * data.c
1108 int reserve_new_block(struct dnode_of_data *);
1109 void update_extent_cache(block_t, struct dnode_of_data *);
1110 struct page *find_data_page(struct inode *, pgoff_t, bool);
1111 struct page *get_lock_data_page(struct inode *, pgoff_t);
1112 struct page *get_new_data_page(struct inode *, struct page *, pgoff_t, bool);
1113 int f2fs_readpage(struct f2fs_sb_info *, struct page *, block_t, int);
1114 int do_write_data_page(struct page *);
1117 * gc.c
1119 int start_gc_thread(struct f2fs_sb_info *);
1120 void stop_gc_thread(struct f2fs_sb_info *);
1121 block_t start_bidx_of_node(unsigned int, struct f2fs_inode_info *);
1122 int f2fs_gc(struct f2fs_sb_info *);
1123 void build_gc_manager(struct f2fs_sb_info *);
1124 int __init create_gc_caches(void);
1125 void destroy_gc_caches(void);
1128 * recovery.c
1130 int recover_fsync_data(struct f2fs_sb_info *);
1131 bool space_for_roll_forward(struct f2fs_sb_info *);
1134 * debug.c
1136 #ifdef CONFIG_F2FS_STAT_FS
1137 struct f2fs_stat_info {
1138 struct list_head stat_list;
1139 struct f2fs_sb_info *sbi;
1140 struct mutex stat_lock;
1141 int all_area_segs, sit_area_segs, nat_area_segs, ssa_area_segs;
1142 int main_area_segs, main_area_sections, main_area_zones;
1143 int hit_ext, total_ext;
1144 int ndirty_node, ndirty_dent, ndirty_dirs, ndirty_meta;
1145 int nats, sits, fnids;
1146 int total_count, utilization;
1147 int bg_gc;
1148 unsigned int valid_count, valid_node_count, valid_inode_count;
1149 unsigned int bimodal, avg_vblocks;
1150 int util_free, util_valid, util_invalid;
1151 int rsvd_segs, overp_segs;
1152 int dirty_count, node_pages, meta_pages;
1153 int prefree_count, call_count;
1154 int tot_segs, node_segs, data_segs, free_segs, free_secs;
1155 int tot_blks, data_blks, node_blks;
1156 int curseg[NR_CURSEG_TYPE];
1157 int cursec[NR_CURSEG_TYPE];
1158 int curzone[NR_CURSEG_TYPE];
1160 unsigned int segment_count[2];
1161 unsigned int block_count[2];
1162 unsigned base_mem, cache_mem;
1165 static inline struct f2fs_stat_info *F2FS_STAT(struct f2fs_sb_info *sbi)
1167 return (struct f2fs_stat_info*)sbi->stat_info;
1170 #define stat_inc_call_count(si) ((si)->call_count++)
1171 #define stat_inc_bggc_count(sbi) ((sbi)->bg_gc++)
1172 #define stat_inc_dirty_dir(sbi) ((sbi)->n_dirty_dirs++)
1173 #define stat_dec_dirty_dir(sbi) ((sbi)->n_dirty_dirs--)
1174 #define stat_inc_total_hit(sb) ((F2FS_SB(sb))->total_hit_ext++)
1175 #define stat_inc_read_hit(sb) ((F2FS_SB(sb))->read_hit_ext++)
1176 #define stat_inc_seg_type(sbi, curseg) \
1177 ((sbi)->segment_count[(curseg)->alloc_type]++)
1178 #define stat_inc_block_count(sbi, curseg) \
1179 ((sbi)->block_count[(curseg)->alloc_type]++)
1181 #define stat_inc_seg_count(sbi, type) \
1182 do { \
1183 struct f2fs_stat_info *si = F2FS_STAT(sbi); \
1184 (si)->tot_segs++; \
1185 if (type == SUM_TYPE_DATA) \
1186 si->data_segs++; \
1187 else \
1188 si->node_segs++; \
1189 } while (0)
1191 #define stat_inc_tot_blk_count(si, blks) \
1192 (si->tot_blks += (blks))
1194 #define stat_inc_data_blk_count(sbi, blks) \
1195 do { \
1196 struct f2fs_stat_info *si = F2FS_STAT(sbi); \
1197 stat_inc_tot_blk_count(si, blks); \
1198 si->data_blks += (blks); \
1199 } while (0)
1201 #define stat_inc_node_blk_count(sbi, blks) \
1202 do { \
1203 struct f2fs_stat_info *si = F2FS_STAT(sbi); \
1204 stat_inc_tot_blk_count(si, blks); \
1205 si->node_blks += (blks); \
1206 } while (0)
1208 int f2fs_build_stats(struct f2fs_sb_info *);
1209 void f2fs_destroy_stats(struct f2fs_sb_info *);
1210 void __init f2fs_create_root_stats(void);
1211 void f2fs_destroy_root_stats(void);
1212 #else
1213 #define stat_inc_call_count(si)
1214 #define stat_inc_bggc_count(si)
1215 #define stat_inc_dirty_dir(sbi)
1216 #define stat_dec_dirty_dir(sbi)
1217 #define stat_inc_total_hit(sb)
1218 #define stat_inc_read_hit(sb)
1219 #define stat_inc_seg_type(sbi, curseg)
1220 #define stat_inc_block_count(sbi, curseg)
1221 #define stat_inc_seg_count(si, type)
1222 #define stat_inc_tot_blk_count(si, blks)
1223 #define stat_inc_data_blk_count(si, blks)
1224 #define stat_inc_node_blk_count(sbi, blks)
1226 static inline int f2fs_build_stats(struct f2fs_sb_info *sbi) { return 0; }
1227 static inline void f2fs_destroy_stats(struct f2fs_sb_info *sbi) { }
1228 static inline void __init f2fs_create_root_stats(void) { }
1229 static inline void f2fs_destroy_root_stats(void) { }
1230 #endif
1232 extern const struct file_operations f2fs_dir_operations;
1233 extern const struct file_operations f2fs_file_operations;
1234 extern const struct inode_operations f2fs_file_inode_operations;
1235 extern const struct address_space_operations f2fs_dblock_aops;
1236 extern const struct address_space_operations f2fs_node_aops;
1237 extern const struct address_space_operations f2fs_meta_aops;
1238 extern const struct inode_operations f2fs_dir_inode_operations;
1239 extern const struct inode_operations f2fs_symlink_inode_operations;
1240 extern const struct inode_operations f2fs_special_inode_operations;
1241 #endif