[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)

#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

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

/* return value for read_node_page */
#define LOCKED_PAGE	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)
{
	unsigned char mask = 0x01 << type;
	if (set)
		ne->ni.flag |= mask;
	else
		ne->ni.flag &= ~mask;
}

static inline bool get_nat_flag(struct nat_entry *ne, unsigned int type)
{
	unsigned char mask = 0x01 << type;
	return ne->ni.flag & mask;
}

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)->dirty_nat_cnt >= 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 >= DEF_NAT_CACHE_THRESHOLD;
}

static inline bool excess_dirty_nodes(struct f2fs_sb_info *sbi)
{
	return get_pages(sbi, F2FS_DIRTY_NODES) >= sbi->blocks_per_seg * 8;
}

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 */
	EXTENT_CACHE,	/* indicates extent cache */
	INMEM_PAGES,	/* indicates inmemory 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 & (sbi->blocks_per_seg - 1)));

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

	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 ^= 1 << 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);

	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_cold_data(struct page *page)
{
	return PageChecked(page);
}

static inline void set_cold_data(struct page *page)
{
	SetPageChecked(page);
}

static inline void clear_cold_data(struct page *page)
{
	ClearPageChecked(page);
}

static inline int is_node(struct page *page, int type)
{
	struct f2fs_node *rn = F2FS_NODE(page);
	return le32_to_cpu(rn->footer.flag) & (1 << 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 int is_inline_node(struct page *page)
{
	return PageChecked(page);
}

static inline void set_inline_node(struct page *page)
{
	SetPageChecked(page);
}

static inline void clear_inline_node(struct page *page)
{
	ClearPageChecked(page);
}

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