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