[linux.git] / fs / f2fs / node.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * fs/f2fs/node.h
 *
 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
 *             http://www.samsung.com/
 */
/* start node id of a node block dedicated to the given node id */
#define	START_NID(nid) (((nid) / NAT_ENTRY_PER_BLOCK) * NAT_ENTRY_PER_BLOCK)

/* node block offset on the NAT area dedicated to the given start node id */
#define	NAT_BLOCK_OFFSET(start_nid) ((start_nid) / NAT_ENTRY_PER_BLOCK)

/* # of pages to perform synchronous readahead before building free nids */
#define FREE_NID_PAGES	8
#define MAX_FREE_NIDS	(NAT_ENTRY_PER_BLOCK * FREE_NID_PAGES)

/* size of free nid batch when shrinking */
#define SHRINK_NID_BATCH_SIZE	8

#define DEF_RA_NID_PAGES	0	/* # of nid pages to be readaheaded */

/* maximum readahead size for node during getting data blocks */
#define MAX_RA_NODE		128

/* control the memory footprint threshold (10MB per 1GB ram) */
#define DEF_RAM_THRESHOLD	1

/* control dirty nats ratio threshold (default: 10% over max nid count) */
#define DEF_DIRTY_NAT_RATIO_THRESHOLD		10
/* control total # of nats */
#define DEF_NAT_CACHE_THRESHOLD			100000

/* control total # of node writes used for roll-fowrad recovery */
#define DEF_RF_NODE_BLOCKS			0

/* vector size for gang look-up from nat cache that consists of radix tree */
#define NAT_VEC_SIZE	32

/* return value for read_node_page */
#define LOCKED_PAGE	1

/* check pinned file's alignment status of physical blocks */
#define FILE_NOT_ALIGNED	1

/* For flag in struct node_info */
enum {
	IS_CHECKPOINTED,	/* is it checkpointed before? */
	HAS_FSYNCED_INODE,	/* is the inode fsynced before? */
	HAS_LAST_FSYNC,		/* has the latest node fsync mark? */
	IS_DIRTY,		/* this nat entry is dirty? */
	IS_PREALLOC,		/* nat entry is preallocated */
};

/*
 * For node information
 */
struct node_info {
	nid_t nid;		/* node id */
	nid_t ino;		/* inode number of the node's owner */
	block_t	blk_addr;	/* block address of the node */
	unsigned char version;	/* version of the node */
	unsigned char flag;	/* for node information bits */
};

struct nat_entry {
	struct list_head list;	/* for clean or dirty nat list */
	struct node_info ni;	/* in-memory node information */
};

#define nat_get_nid(nat)		((nat)->ni.nid)
#define nat_set_nid(nat, n)		((nat)->ni.nid = (n))
#define nat_get_blkaddr(nat)		((nat)->ni.blk_addr)
#define nat_set_blkaddr(nat, b)		((nat)->ni.blk_addr = (b))
#define nat_get_ino(nat)		((nat)->ni.ino)
#define nat_set_ino(nat, i)		((nat)->ni.ino = (i))
#define nat_get_version(nat)		((nat)->ni.version)
#define nat_set_version(nat, v)		((nat)->ni.version = (v))

#define inc_node_version(version)	(++(version))

static inline void copy_node_info(struct node_info *dst,
						struct node_info *src)
{
	dst->nid = src->nid;
	dst->ino = src->ino;
	dst->blk_addr = src->blk_addr;
	dst->version = src->version;
	/* should not copy flag here */
}

static inline void set_nat_flag(struct nat_entry *ne,
				unsigned int type, bool set)
{
	if (set)
		ne->ni.flag |= BIT(type);
	else
		ne->ni.flag &= ~BIT(type);
}

static inline bool get_nat_flag(struct nat_entry *ne, unsigned int type)
{
	return ne->ni.flag & BIT(type);
}

static inline void nat_reset_flag(struct nat_entry *ne)
{
	/* these states can be set only after checkpoint was done */
	set_nat_flag(ne, IS_CHECKPOINTED, true);
	set_nat_flag(ne, HAS_FSYNCED_INODE, false);
	set_nat_flag(ne, HAS_LAST_FSYNC, true);
}

static inline void node_info_from_raw_nat(struct node_info *ni,
						struct f2fs_nat_entry *raw_ne)
{
	ni->ino = le32_to_cpu(raw_ne->ino);
	ni->blk_addr = le32_to_cpu(raw_ne->block_addr);
	ni->version = raw_ne->version;
}

static inline void raw_nat_from_node_info(struct f2fs_nat_entry *raw_ne,
						struct node_info *ni)
{
	raw_ne->ino = cpu_to_le32(ni->ino);
	raw_ne->block_addr = cpu_to_le32(ni->blk_addr);
	raw_ne->version = ni->version;
}

static inline bool excess_dirty_nats(struct f2fs_sb_info *sbi)
{
	return NM_I(sbi)->nat_cnt[DIRTY_NAT] >= NM_I(sbi)->max_nid *
					NM_I(sbi)->dirty_nats_ratio / 100;
}

static inline bool excess_cached_nats(struct f2fs_sb_info *sbi)
{
	return NM_I(sbi)->nat_cnt[TOTAL_NAT] >= DEF_NAT_CACHE_THRESHOLD;
}

enum mem_type {
	FREE_NIDS,	/* indicates the free nid list */
	NAT_ENTRIES,	/* indicates the cached nat entry */
	DIRTY_DENTS,	/* indicates dirty dentry pages */
	INO_ENTRIES,	/* indicates inode entries */
	READ_EXTENT_CACHE,	/* indicates read extent cache */
	AGE_EXTENT_CACHE,	/* indicates age extent cache */
	DISCARD_CACHE,	/* indicates memory of cached discard cmds */
	COMPRESS_PAGE,	/* indicates memory of cached compressed pages */
	BASE_CHECK,	/* check kernel status */
};

struct nat_entry_set {
	struct list_head set_list;	/* link with other nat sets */
	struct list_head entry_list;	/* link with dirty nat entries */
	nid_t set;			/* set number*/
	unsigned int entry_cnt;		/* the # of nat entries in set */
};

struct free_nid {
	struct list_head list;	/* for free node id list */
	nid_t nid;		/* node id */
	int state;		/* in use or not: FREE_NID or PREALLOC_NID */
};

static inline void next_free_nid(struct f2fs_sb_info *sbi, nid_t *nid)
{
	struct f2fs_nm_info *nm_i = NM_I(sbi);
	struct free_nid *fnid;

	spin_lock(&nm_i->nid_list_lock);
	if (nm_i->nid_cnt[FREE_NID] <= 0) {
		spin_unlock(&nm_i->nid_list_lock);
		return;
	}
	fnid = list_first_entry(&nm_i->free_nid_list, struct free_nid, list);
	*nid = fnid->nid;
	spin_unlock(&nm_i->nid_list_lock);
}

/*
 * inline functions
 */
static inline void get_nat_bitmap(struct f2fs_sb_info *sbi, void *addr)
{
	struct f2fs_nm_info *nm_i = NM_I(sbi);

#ifdef CONFIG_F2FS_CHECK_FS
	if (memcmp(nm_i->nat_bitmap, nm_i->nat_bitmap_mir,
						nm_i->bitmap_size))
		f2fs_bug_on(sbi, 1);
#endif
	memcpy(addr, nm_i->nat_bitmap, nm_i->bitmap_size);
}

static inline pgoff_t current_nat_addr(struct f2fs_sb_info *sbi, nid_t start)
{
	struct f2fs_nm_info *nm_i = NM_I(sbi);
	pgoff_t block_off;
	pgoff_t block_addr;

	/*
	 * block_off = segment_off * 512 + off_in_segment
	 * OLD = (segment_off * 512) * 2 + off_in_segment
	 * NEW = 2 * (segment_off * 512 + off_in_segment) - off_in_segment
	 */
	block_off = NAT_BLOCK_OFFSET(start);

	block_addr = (pgoff_t)(nm_i->nat_blkaddr +
		(block_off << 1) -
		(block_off & (BLKS_PER_SEG(sbi) - 1)));

	if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
		block_addr += BLKS_PER_SEG(sbi);

	return block_addr;
}

static inline pgoff_t next_nat_addr(struct f2fs_sb_info *sbi,
						pgoff_t block_addr)
{
	struct f2fs_nm_info *nm_i = NM_I(sbi);

	block_addr -= nm_i->nat_blkaddr;
	block_addr ^= BIT(sbi->log_blocks_per_seg);
	return block_addr + nm_i->nat_blkaddr;
}

static inline void set_to_next_nat(struct f2fs_nm_info *nm_i, nid_t start_nid)
{
	unsigned int block_off = NAT_BLOCK_OFFSET(start_nid);

	f2fs_change_bit(block_off, nm_i->nat_bitmap);
#ifdef CONFIG_F2FS_CHECK_FS
	f2fs_change_bit(block_off, nm_i->nat_bitmap_mir);
#endif
}

static inline nid_t ino_of_node(struct page *node_page)
{
	struct f2fs_node *rn = F2FS_NODE(node_page);
	return le32_to_cpu(rn->footer.ino);
}

static inline nid_t nid_of_node(struct page *node_page)
{
	struct f2fs_node *rn = F2FS_NODE(node_page);
	return le32_to_cpu(rn->footer.nid);
}

static inline unsigned int ofs_of_node(struct page *node_page)
{
	struct f2fs_node *rn = F2FS_NODE(node_page);
	unsigned flag = le32_to_cpu(rn->footer.flag);
	return flag >> OFFSET_BIT_SHIFT;
}

static inline __u64 cpver_of_node(struct page *node_page)
{
	struct f2fs_node *rn = F2FS_NODE(node_page);
	return le64_to_cpu(rn->footer.cp_ver);
}

static inline block_t next_blkaddr_of_node(struct page *node_page)
{
	struct f2fs_node *rn = F2FS_NODE(node_page);
	return le32_to_cpu(rn->footer.next_blkaddr);
}

static inline void fill_node_footer(struct page *page, nid_t nid,
				nid_t ino, unsigned int ofs, bool reset)
{
	struct f2fs_node *rn = F2FS_NODE(page);
	unsigned int old_flag = 0;

	if (reset)
		memset(rn, 0, sizeof(*rn));
	else
		old_flag = le32_to_cpu(rn->footer.flag);

	rn->footer.nid = cpu_to_le32(nid);
	rn->footer.ino = cpu_to_le32(ino);

	/* should remain old flag bits such as COLD_BIT_SHIFT */
	rn->footer.flag = cpu_to_le32((ofs << OFFSET_BIT_SHIFT) |
					(old_flag & OFFSET_BIT_MASK));
}

static inline void copy_node_footer(struct page *dst, struct page *src)
{
	struct f2fs_node *src_rn = F2FS_NODE(src);
	struct f2fs_node *dst_rn = F2FS_NODE(dst);
	memcpy(&dst_rn->footer, &src_rn->footer, sizeof(struct node_footer));
}

static inline void fill_node_footer_blkaddr(struct page *page, block_t blkaddr)
{
	struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
	struct f2fs_node *rn = F2FS_NODE(page);
	__u64 cp_ver = cur_cp_version(ckpt);

	if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG))
		cp_ver |= (cur_cp_crc(ckpt) << 32);

	rn->footer.cp_ver = cpu_to_le64(cp_ver);
	rn->footer.next_blkaddr = cpu_to_le32(blkaddr);
}

static inline bool is_recoverable_dnode(struct page *page)
{
	struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
	__u64 cp_ver = cur_cp_version(ckpt);

	/* Don't care crc part, if fsck.f2fs sets it. */
	if (__is_set_ckpt_flags(ckpt, CP_NOCRC_RECOVERY_FLAG))
		return (cp_ver << 32) == (cpver_of_node(page) << 32);

	if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG))
		cp_ver |= (cur_cp_crc(ckpt) << 32);

	return cp_ver == cpver_of_node(page);
}

/*
 * f2fs assigns the following node offsets described as (num).
 * N = NIDS_PER_BLOCK
 *
 *  Inode block (0)
 *    |- direct node (1)
 *    |- direct node (2)
 *    |- indirect node (3)
 *    |            `- direct node (4 => 4 + N - 1)
 *    |- indirect node (4 + N)
 *    |            `- direct node (5 + N => 5 + 2N - 1)
 *    `- double indirect node (5 + 2N)
 *                 `- indirect node (6 + 2N)
 *                       `- direct node
 *                 ......
 *                 `- indirect node ((6 + 2N) + x(N + 1))
 *                       `- direct node
 *                 ......
 *                 `- indirect node ((6 + 2N) + (N - 1)(N + 1))
 *                       `- direct node
 */
static inline bool IS_DNODE(struct page *node_page)
{
	unsigned int ofs = ofs_of_node(node_page);

	if (f2fs_has_xattr_block(ofs))
		return true;

	if (ofs == 3 || ofs == 4 + NIDS_PER_BLOCK ||
			ofs == 5 + 2 * NIDS_PER_BLOCK)
		return false;
	if (ofs >= 6 + 2 * NIDS_PER_BLOCK) {
		ofs -= 6 + 2 * NIDS_PER_BLOCK;
		if (!((long int)ofs % (NIDS_PER_BLOCK + 1)))
			return false;
	}
	return true;
}

static inline int set_nid(struct page *p, int off, nid_t nid, bool i)
{
	struct f2fs_node *rn = F2FS_NODE(p);

	f2fs_wait_on_page_writeback(p, NODE, true, true);

	if (i)
		rn->i.i_nid[off - NODE_DIR1_BLOCK] = cpu_to_le32(nid);
	else
		rn->in.nid[off] = cpu_to_le32(nid);
	return set_page_dirty(p);
}

static inline nid_t get_nid(struct page *p, int off, bool i)
{
	struct f2fs_node *rn = F2FS_NODE(p);

	if (i)
		return le32_to_cpu(rn->i.i_nid[off - NODE_DIR1_BLOCK]);
	return le32_to_cpu(rn->in.nid[off]);
}

/*
 * Coldness identification:
 *  - Mark cold files in f2fs_inode_info
 *  - Mark cold node blocks in their node footer
 *  - Mark cold data pages in page cache
 */

static inline int is_node(struct page *page, int type)
{
	struct f2fs_node *rn = F2FS_NODE(page);
	return le32_to_cpu(rn->footer.flag) & BIT(type);
}

#define is_cold_node(page)	is_node(page, COLD_BIT_SHIFT)
#define is_fsync_dnode(page)	is_node(page, FSYNC_BIT_SHIFT)
#define is_dent_dnode(page)	is_node(page, DENT_BIT_SHIFT)

static inline void set_cold_node(struct page *page, bool is_dir)
{
	struct f2fs_node *rn = F2FS_NODE(page);
	unsigned int flag = le32_to_cpu(rn->footer.flag);

	if (is_dir)
		flag &= ~BIT(COLD_BIT_SHIFT);
	else
		flag |= BIT(COLD_BIT_SHIFT);
	rn->footer.flag = cpu_to_le32(flag);
}

static inline void set_mark(struct page *page, int mark, int type)
{
	struct f2fs_node *rn = F2FS_NODE(page);
	unsigned int flag = le32_to_cpu(rn->footer.flag);
	if (mark)
		flag |= BIT(type);
	else
		flag &= ~BIT(type);
	rn->footer.flag = cpu_to_le32(flag);

#ifdef CONFIG_F2FS_CHECK_FS
	f2fs_inode_chksum_set(F2FS_P_SB(page), page);
#endif
}
#define set_dentry_mark(page, mark)	set_mark(page, mark, DENT_BIT_SHIFT)
#define set_fsync_mark(page, mark)	set_mark(page, mark, FSYNC_BIT_SHIFT)
Commit	Line	Data
d29fbcdb	1	/* SPDX-License-Identifier: GPL-2.0 */
0a8165d7	2	/*
39a53e0c JK	3	* fs/f2fs/node.h
	4	*
	5	* Copyright (c) 2012 Samsung Electronics Co., Ltd.
	6	* http://www.samsung.com/
39a53e0c JK	7	*/
39a53e0c JK	8	/* start node id of a node block dedicated to the given node id */
68afcf2d	9	#define START_NID(nid) (((nid) / NAT_ENTRY_PER_BLOCK) * NAT_ENTRY_PER_BLOCK)
39a53e0c JK	10
39a53e0c JK	11	/* node block offset on the NAT area dedicated to the given start node id */
68afcf2d	12	#define NAT_BLOCK_OFFSET(start_nid) ((start_nid) / NAT_ENTRY_PER_BLOCK)
39a53e0c	13
ea1a29a0	14	/* # of pages to perform synchronous readahead before building free nids */
ad4edb83 JK	15	#define FREE_NID_PAGES 8
ad4edb83 JK	16	#define MAX_FREE_NIDS (NAT_ENTRY_PER_BLOCK * FREE_NID_PAGES)
39a53e0c	17
042be373 CY	18	/* size of free nid batch when shrinking */
	19	#define SHRINK_NID_BATCH_SIZE 8
	20
ad4edb83	21	#define DEF_RA_NID_PAGES 0 /* # of nid pages to be readaheaded */
ea1a29a0	22
39a53e0c JK	23	/* maximum readahead size for node during getting data blocks */
	24	#define MAX_RA_NODE 128
	25
cdfc41c1	26	/* control the memory footprint threshold (10MB per 1GB ram) */
29710bcf	27	#define DEF_RAM_THRESHOLD 1
cdfc41c1	28
7d768d2c CY	29	/* control dirty nats ratio threshold (default: 10% over max nid count) */
7d768d2c CY	30	#define DEF_DIRTY_NAT_RATIO_THRESHOLD 10
e589c2c4 JK	31	/* control total # of nats */
e589c2c4 JK	32	#define DEF_NAT_CACHE_THRESHOLD 100000
7d768d2c	33
47c8ebcc JK	34	/* control total # of node writes used for roll-fowrad recovery */
	35	#define DEF_RF_NODE_BLOCKS 0
	36
39a53e0c	37	/* vector size for gang look-up from nat cache that consists of radix tree */
c31e4961	38	#define NAT_VEC_SIZE 32
39a53e0c	39
56ae674c JK	40	/* return value for read_node_page */
	41	#define LOCKED_PAGE 1
	42
859fca6b CY	43	/* check pinned file's alignment status of physical blocks */
	44	#define FILE_NOT_ALIGNED 1
	45
5c27f4ee CY	46	/* For flag in struct node_info */
	47	enum {
	48	IS_CHECKPOINTED, /* is it checkpointed before? */
	49	HAS_FSYNCED_INODE, /* is the inode fsynced before? */
	50	HAS_LAST_FSYNC, /* has the latest node fsync mark? */
	51	IS_DIRTY, /* this nat entry is dirty? */
780de47c	52	IS_PREALLOC, /* nat entry is preallocated */
5c27f4ee CY	53	};
5c27f4ee CY	54
39a53e0c JK	55	/*
	56	* For node information
	57	*/
	58	struct node_info {
	59	nid_t nid; /* node id */
	60	nid_t ino; /* inode number of the node's owner */
	61	block_t blk_addr; /* block address of the node */
	62	unsigned char version; /* version of the node */
5c27f4ee	63	unsigned char flag; /* for node information bits */
7ef35e3b JK	64	};
7ef35e3b JK	65
39a53e0c JK	66	struct nat_entry {
39a53e0c JK	67	struct list_head list; /* for clean or dirty nat list */
39a53e0c JK	68	struct node_info ni; /* in-memory node information */
	69	};
	70
68afcf2d TK	71	#define nat_get_nid(nat) ((nat)->ni.nid)
	72	#define nat_set_nid(nat, n) ((nat)->ni.nid = (n))
	73	#define nat_get_blkaddr(nat) ((nat)->ni.blk_addr)
	74	#define nat_set_blkaddr(nat, b) ((nat)->ni.blk_addr = (b))
	75	#define nat_get_ino(nat) ((nat)->ni.ino)
	76	#define nat_set_ino(nat, i) ((nat)->ni.ino = (i))
	77	#define nat_get_version(nat) ((nat)->ni.version)
	78	#define nat_set_version(nat, v) ((nat)->ni.version = (v))
39a53e0c	79
68afcf2d	80	#define inc_node_version(version) (++(version))
39a53e0c	81
5c27f4ee CY	82	static inline void copy_node_info(struct node_info *dst,
	83	struct node_info *src)
	84	{
	85	dst->nid = src->nid;
	86	dst->ino = src->ino;
	87	dst->blk_addr = src->blk_addr;
	88	dst->version = src->version;
	89	/* should not copy flag here */
	90	}
	91
7ef35e3b JK	92	static inline void set_nat_flag(struct nat_entry *ne,
	93	unsigned int type, bool set)
	94	{
7ef35e3b	95	if (set)
447286eb	96	ne->ni.flag \|= BIT(type);
7ef35e3b	97	else
447286eb	98	ne->ni.flag &= ~BIT(type);
7ef35e3b JK	99	}
	100
	101	static inline bool get_nat_flag(struct nat_entry *ne, unsigned int type)
	102	{
447286eb	103	return ne->ni.flag & BIT(type);
7ef35e3b JK	104	}
7ef35e3b JK	105
88bd02c9 JK	106	static inline void nat_reset_flag(struct nat_entry *ne)
	107	{
	108	/* these states can be set only after checkpoint was done */
	109	set_nat_flag(ne, IS_CHECKPOINTED, true);
	110	set_nat_flag(ne, HAS_FSYNCED_INODE, false);
	111	set_nat_flag(ne, HAS_LAST_FSYNC, true);
	112	}
	113
39a53e0c JK	114	static inline void node_info_from_raw_nat(struct node_info *ni,
	115	struct f2fs_nat_entry *raw_ne)
	116	{
	117	ni->ino = le32_to_cpu(raw_ne->ino);
	118	ni->blk_addr = le32_to_cpu(raw_ne->block_addr);
	119	ni->version = raw_ne->version;
	120	}
	121
94dac22e CY	122	static inline void raw_nat_from_node_info(struct f2fs_nat_entry *raw_ne,
	123	struct node_info *ni)
	124	{
	125	raw_ne->ino = cpu_to_le32(ni->ino);
	126	raw_ne->block_addr = cpu_to_le32(ni->blk_addr);
	127	raw_ne->version = ni->version;
	128	}
	129
7d768d2c CY	130	static inline bool excess_dirty_nats(struct f2fs_sb_info *sbi)
7d768d2c CY	131	{
a95ba66a	132	return NM_I(sbi)->nat_cnt[DIRTY_NAT] >= NM_I(sbi)->max_nid *
2304cb0c	133	NM_I(sbi)->dirty_nats_ratio / 100;
7d768d2c CY	134	}
7d768d2c CY	135
e589c2c4 JK	136	static inline bool excess_cached_nats(struct f2fs_sb_info *sbi)
e589c2c4 JK	137	{
a95ba66a	138	return NM_I(sbi)->nat_cnt[TOTAL_NAT] >= DEF_NAT_CACHE_THRESHOLD;
e589c2c4 JK	139	}
e589c2c4 JK	140
6fb03f3a	141	enum mem_type {
cdfc41c1	142	FREE_NIDS, /* indicates the free nid list */
6fb03f3a	143	NAT_ENTRIES, /* indicates the cached nat entry */
a1257023	144	DIRTY_DENTS, /* indicates dirty dentry pages */
e5e7ea3c	145	INO_ENTRIES, /* indicates inode entries */
12607c1b	146	READ_EXTENT_CACHE, /* indicates read extent cache */
71644dff	147	AGE_EXTENT_CACHE, /* indicates age extent cache */
d6d2b491	148	DISCARD_CACHE, /* indicates memory of cached discard cmds */
6ce19aff	149	COMPRESS_PAGE, /* indicates memory of cached compressed pages */
1e84371f	150	BASE_CHECK, /* check kernel status */
cdfc41c1 JK	151	};
cdfc41c1 JK	152
aec71382	153	struct nat_entry_set {
309cc2b6	154	struct list_head set_list; /* link with other nat sets */
aec71382	155	struct list_head entry_list; /* link with dirty nat entries */
309cc2b6	156	nid_t set; /* set number*/
aec71382 CY	157	unsigned int entry_cnt; /* the # of nat entries in set */
	158	};
	159
39a53e0c JK	160	struct free_nid {
	161	struct list_head list; /* for free node id list */
	162	nid_t nid; /* node id */
9a4ffdf5	163	int state; /* in use or not: FREE_NID or PREALLOC_NID */
39a53e0c JK	164	};
39a53e0c JK	165
120c2cba	166	static inline void next_free_nid(struct f2fs_sb_info sbi, nid_t nid)
39a53e0c JK	167	{
	168	struct f2fs_nm_info *nm_i = NM_I(sbi);
	169	struct free_nid *fnid;
	170
b8559dc2	171	spin_lock(&nm_i->nid_list_lock);
9a4ffdf5	172	if (nm_i->nid_cnt[FREE_NID] <= 0) {
b8559dc2	173	spin_unlock(&nm_i->nid_list_lock);
120c2cba	174	return;
c6e48930	175	}
9a4ffdf5	176	fnid = list_first_entry(&nm_i->free_nid_list, struct free_nid, list);
39a53e0c	177	*nid = fnid->nid;
b8559dc2	178	spin_unlock(&nm_i->nid_list_lock);
39a53e0c JK	179	}
	180
	181	/*
	182	* inline functions
	183	*/
	184	static inline void get_nat_bitmap(struct f2fs_sb_info sbi, void addr)
	185	{
	186	struct f2fs_nm_info *nm_i = NM_I(sbi);
599a09b2 CY	187
	188	#ifdef CONFIG_F2FS_CHECK_FS
	189	if (memcmp(nm_i->nat_bitmap, nm_i->nat_bitmap_mir,
	190	nm_i->bitmap_size))
	191	f2fs_bug_on(sbi, 1);
	192	#endif
39a53e0c JK	193	memcpy(addr, nm_i->nat_bitmap, nm_i->bitmap_size);
	194	}
	195
	196	static inline pgoff_t current_nat_addr(struct f2fs_sb_info *sbi, nid_t start)
	197	{
	198	struct f2fs_nm_info *nm_i = NM_I(sbi);
	199	pgoff_t block_off;
	200	pgoff_t block_addr;
39a53e0c	201
8a6aa325 FL	202	/*
	203	* block_off = segment_off * 512 + off_in_segment
	204	* OLD = (segment_off * 512) * 2 + off_in_segment
	205	* NEW = 2 * (segment_off * 512 + off_in_segment) - off_in_segment
	206	*/
39a53e0c	207	block_off = NAT_BLOCK_OFFSET(start);
39a53e0c JK	208
39a53e0c JK	209	block_addr = (pgoff_t)(nm_i->nat_blkaddr +
8a6aa325	210	(block_off << 1) -
a60108f7	211	(block_off & (BLKS_PER_SEG(sbi) - 1)));
39a53e0c JK	212
39a53e0c JK	213	if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
a60108f7	214	block_addr += BLKS_PER_SEG(sbi);
39a53e0c JK	215
	216	return block_addr;
	217	}
	218
	219	static inline pgoff_t next_nat_addr(struct f2fs_sb_info *sbi,
	220	pgoff_t block_addr)
	221	{
	222	struct f2fs_nm_info *nm_i = NM_I(sbi);
	223
	224	block_addr -= nm_i->nat_blkaddr;
447286eb	225	block_addr ^= BIT(sbi->log_blocks_per_seg);
39a53e0c JK	226	return block_addr + nm_i->nat_blkaddr;
	227	}
	228
	229	static inline void set_to_next_nat(struct f2fs_nm_info *nm_i, nid_t start_nid)
	230	{
	231	unsigned int block_off = NAT_BLOCK_OFFSET(start_nid);
	232
c6ac4c0e	233	f2fs_change_bit(block_off, nm_i->nat_bitmap);
599a09b2 CY	234	#ifdef CONFIG_F2FS_CHECK_FS
	235	f2fs_change_bit(block_off, nm_i->nat_bitmap_mir);
	236	#endif
39a53e0c JK	237	}
39a53e0c JK	238
a468f0ef JK	239	static inline nid_t ino_of_node(struct page *node_page)
	240	{
	241	struct f2fs_node *rn = F2FS_NODE(node_page);
	242	return le32_to_cpu(rn->footer.ino);
	243	}
	244
	245	static inline nid_t nid_of_node(struct page *node_page)
	246	{
	247	struct f2fs_node *rn = F2FS_NODE(node_page);
	248	return le32_to_cpu(rn->footer.nid);
	249	}
	250
	251	static inline unsigned int ofs_of_node(struct page *node_page)
	252	{
	253	struct f2fs_node *rn = F2FS_NODE(node_page);
	254	unsigned flag = le32_to_cpu(rn->footer.flag);
	255	return flag >> OFFSET_BIT_SHIFT;
	256	}
	257
	258	static inline __u64 cpver_of_node(struct page *node_page)
	259	{
	260	struct f2fs_node *rn = F2FS_NODE(node_page);
	261	return le64_to_cpu(rn->footer.cp_ver);
	262	}
	263
	264	static inline block_t next_blkaddr_of_node(struct page *node_page)
	265	{
	266	struct f2fs_node *rn = F2FS_NODE(node_page);
	267	return le32_to_cpu(rn->footer.next_blkaddr);
	268	}
	269
39a53e0c JK	270	static inline void fill_node_footer(struct page *page, nid_t nid,
	271	nid_t ino, unsigned int ofs, bool reset)
	272	{
45590710	273	struct f2fs_node *rn = F2FS_NODE(page);
09eb483e JK	274	unsigned int old_flag = 0;
09eb483e JK	275
39a53e0c JK	276	if (reset)
39a53e0c JK	277	memset(rn, 0, sizeof(*rn));
09eb483e JK	278	else
	279	old_flag = le32_to_cpu(rn->footer.flag);
	280
39a53e0c JK	281	rn->footer.nid = cpu_to_le32(nid);
39a53e0c JK	282	rn->footer.ino = cpu_to_le32(ino);
09eb483e JK	283
	284	/* should remain old flag bits such as COLD_BIT_SHIFT */
	285	rn->footer.flag = cpu_to_le32((ofs << OFFSET_BIT_SHIFT) \|
	286	(old_flag & OFFSET_BIT_MASK));
39a53e0c JK	287	}
	288
	289	static inline void copy_node_footer(struct page dst, struct page src)
	290	{
45590710 GZ	291	struct f2fs_node *src_rn = F2FS_NODE(src);
45590710 GZ	292	struct f2fs_node *dst_rn = F2FS_NODE(dst);
39a53e0c JK	293	memcpy(&dst_rn->footer, &src_rn->footer, sizeof(struct node_footer));
	294	}
	295
	296	static inline void fill_node_footer_blkaddr(struct page *page, block_t blkaddr)
	297	{
4081363f	298	struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
45590710	299	struct f2fs_node *rn = F2FS_NODE(page);
ced2c7ea KM	300	__u64 cp_ver = cur_cp_version(ckpt);
	301
	302	if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG))
	303	cp_ver \|= (cur_cp_crc(ckpt) << 32);
45590710	304
a468f0ef	305	rn->footer.cp_ver = cpu_to_le64(cp_ver);
25ca923b	306	rn->footer.next_blkaddr = cpu_to_le32(blkaddr);
39a53e0c JK	307	}
39a53e0c JK	308
a468f0ef	309	static inline bool is_recoverable_dnode(struct page *page)
39a53e0c	310	{
a468f0ef	311	struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
a468f0ef	312	__u64 cp_ver = cur_cp_version(ckpt);
39a53e0c	313
f2367923 JK	314	/* Don't care crc part, if fsck.f2fs sets it. */
	315	if (__is_set_ckpt_flags(ckpt, CP_NOCRC_RECOVERY_FLAG))
	316	return (cp_ver << 32) == (cpver_of_node(page) << 32);
	317
ced2c7ea KM	318	if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG))
	319	cp_ver \|= (cur_cp_crc(ckpt) << 32);
	320
0c0b471e	321	return cp_ver == cpver_of_node(page);
39a53e0c JK	322	}
	323
	324	/*
	325	* f2fs assigns the following node offsets described as (num).
	326	* N = NIDS_PER_BLOCK
	327	*
	328	* Inode block (0)
	329	* \|- direct node (1)
	330	* \|- direct node (2)
	331	* \|- indirect node (3)
	332	* \| `- direct node (4 => 4 + N - 1)
	333	* \|- indirect node (4 + N)
	334	* \| `- direct node (5 + N => 5 + 2N - 1)
	335	* `- double indirect node (5 + 2N)
	336	* `- indirect node (6 + 2N)
4f4124d0 CY	337	* `- direct node
	338	* ......
	339	* `- indirect node ((6 + 2N) + x(N + 1))
	340	* `- direct node
	341	* ......
	342	* `- indirect node ((6 + 2N) + (N - 1)(N + 1))
	343	* `- direct node
39a53e0c JK	344	*/
	345	static inline bool IS_DNODE(struct page *node_page)
	346	{
	347	unsigned int ofs = ofs_of_node(node_page);
dbe6a5ff	348
4bc8e9bc	349	if (f2fs_has_xattr_block(ofs))
d260081c	350	return true;
dbe6a5ff	351
39a53e0c JK	352	if (ofs == 3 \|\| ofs == 4 + NIDS_PER_BLOCK \|\|
	353	ofs == 5 + 2 * NIDS_PER_BLOCK)
	354	return false;
	355	if (ofs >= 6 + 2 * NIDS_PER_BLOCK) {
	356	ofs -= 6 + 2 * NIDS_PER_BLOCK;
3315101f	357	if (!((long int)ofs % (NIDS_PER_BLOCK + 1)))
39a53e0c JK	358	return false;
	359	}
	360	return true;
	361	}
	362
12719ae1	363	static inline int set_nid(struct page *p, int off, nid_t nid, bool i)
39a53e0c	364	{
45590710	365	struct f2fs_node *rn = F2FS_NODE(p);
39a53e0c	366
bae0ee7a	367	f2fs_wait_on_page_writeback(p, NODE, true, true);
39a53e0c JK	368
	369	if (i)
	370	rn->i.i_nid[off - NODE_DIR1_BLOCK] = cpu_to_le32(nid);
	371	else
	372	rn->in.nid[off] = cpu_to_le32(nid);
12719ae1	373	return set_page_dirty(p);
39a53e0c JK	374	}
	375
	376	static inline nid_t get_nid(struct page *p, int off, bool i)
	377	{
45590710 GZ	378	struct f2fs_node *rn = F2FS_NODE(p);
45590710 GZ	379
39a53e0c JK	380	if (i)
	381	return le32_to_cpu(rn->i.i_nid[off - NODE_DIR1_BLOCK]);
	382	return le32_to_cpu(rn->in.nid[off]);
	383	}
	384
	385	/*
	386	* Coldness identification:
	387	* - Mark cold files in f2fs_inode_info
	388	* - Mark cold node blocks in their node footer
	389	* - Mark cold data pages in page cache
	390	*/
39a53e0c	391
a06a2416	392	static inline int is_node(struct page *page, int type)
39a53e0c	393	{
45590710	394	struct f2fs_node *rn = F2FS_NODE(page);
447286eb	395	return le32_to_cpu(rn->footer.flag) & BIT(type);
39a53e0c JK	396	}
39a53e0c JK	397
a06a2416 NJ	398	#define is_cold_node(page) is_node(page, COLD_BIT_SHIFT)
	399	#define is_fsync_dnode(page) is_node(page, FSYNC_BIT_SHIFT)
	400	#define is_dent_dnode(page) is_node(page, DENT_BIT_SHIFT)
39a53e0c	401
c5667575	402	static inline void set_cold_node(struct page *page, bool is_dir)
39a53e0c	403	{
45590710	404	struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c JK	405	unsigned int flag = le32_to_cpu(rn->footer.flag);
39a53e0c JK	406
c5667575	407	if (is_dir)
447286eb	408	flag &= ~BIT(COLD_BIT_SHIFT);
39a53e0c	409	else
447286eb	410	flag \|= BIT(COLD_BIT_SHIFT);
39a53e0c JK	411	rn->footer.flag = cpu_to_le32(flag);
	412	}
	413
a06a2416	414	static inline void set_mark(struct page *page, int mark, int type)
39a53e0c	415	{
45590710	416	struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c JK	417	unsigned int flag = le32_to_cpu(rn->footer.flag);
39a53e0c JK	418	if (mark)
447286eb	419	flag \|= BIT(type);
39a53e0c	420	else
447286eb	421	flag &= ~BIT(type);
39a53e0c	422	rn->footer.flag = cpu_to_le32(flag);
54c55c4e WG	423
	424	#ifdef CONFIG_F2FS_CHECK_FS
	425	f2fs_inode_chksum_set(F2FS_P_SB(page), page);
	426	#endif
39a53e0c	427	}
a06a2416 NJ	428	#define set_dentry_mark(page, mark) set_mark(page, mark, DENT_BIT_SHIFT)
a06a2416 NJ	429	#define set_fsync_mark(page, mark) set_mark(page, mark, FSYNC_BIT_SHIFT)