[linux-2.6-block.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

/* 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, 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
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
39a53e0c JK	34	/* vector size for gang look-up from nat cache that consists of radix tree */
39a53e0c JK	35	#define NATVEC_SIZE 64
7aed0d45	36	#define SETVEC_SIZE 32
39a53e0c	37
56ae674c JK	38	/* return value for read_node_page */
	39	#define LOCKED_PAGE 1
	40
5c27f4ee CY	41	/* For flag in struct node_info */
	42	enum {
	43	IS_CHECKPOINTED, /* is it checkpointed before? */
	44	HAS_FSYNCED_INODE, /* is the inode fsynced before? */
	45	HAS_LAST_FSYNC, /* has the latest node fsync mark? */
	46	IS_DIRTY, /* this nat entry is dirty? */
780de47c	47	IS_PREALLOC, /* nat entry is preallocated */
5c27f4ee CY	48	};
5c27f4ee CY	49
39a53e0c JK	50	/*
	51	* For node information
	52	*/
	53	struct node_info {
	54	nid_t nid; /* node id */
	55	nid_t ino; /* inode number of the node's owner */
	56	block_t blk_addr; /* block address of the node */
	57	unsigned char version; /* version of the node */
5c27f4ee	58	unsigned char flag; /* for node information bits */
7ef35e3b JK	59	};
7ef35e3b JK	60
39a53e0c JK	61	struct nat_entry {
39a53e0c JK	62	struct list_head list; /* for clean or dirty nat list */
39a53e0c JK	63	struct node_info ni; /* in-memory node information */
	64	};
	65
68afcf2d TK	66	#define nat_get_nid(nat) ((nat)->ni.nid)
	67	#define nat_set_nid(nat, n) ((nat)->ni.nid = (n))
	68	#define nat_get_blkaddr(nat) ((nat)->ni.blk_addr)
	69	#define nat_set_blkaddr(nat, b) ((nat)->ni.blk_addr = (b))
	70	#define nat_get_ino(nat) ((nat)->ni.ino)
	71	#define nat_set_ino(nat, i) ((nat)->ni.ino = (i))
	72	#define nat_get_version(nat) ((nat)->ni.version)
	73	#define nat_set_version(nat, v) ((nat)->ni.version = (v))
39a53e0c	74
68afcf2d	75	#define inc_node_version(version) (++(version))
39a53e0c	76
5c27f4ee CY	77	static inline void copy_node_info(struct node_info *dst,
	78	struct node_info *src)
	79	{
	80	dst->nid = src->nid;
	81	dst->ino = src->ino;
	82	dst->blk_addr = src->blk_addr;
	83	dst->version = src->version;
	84	/* should not copy flag here */
	85	}
	86
7ef35e3b JK	87	static inline void set_nat_flag(struct nat_entry *ne,
	88	unsigned int type, bool set)
	89	{
	90	unsigned char mask = 0x01 << type;
	91	if (set)
5c27f4ee	92	ne->ni.flag \|= mask;
7ef35e3b	93	else
5c27f4ee	94	ne->ni.flag &= ~mask;
7ef35e3b JK	95	}
	96
	97	static inline bool get_nat_flag(struct nat_entry *ne, unsigned int type)
	98	{
	99	unsigned char mask = 0x01 << type;
5c27f4ee	100	return ne->ni.flag & mask;
7ef35e3b JK	101	}
7ef35e3b JK	102
88bd02c9 JK	103	static inline void nat_reset_flag(struct nat_entry *ne)
	104	{
	105	/* these states can be set only after checkpoint was done */
	106	set_nat_flag(ne, IS_CHECKPOINTED, true);
	107	set_nat_flag(ne, HAS_FSYNCED_INODE, false);
	108	set_nat_flag(ne, HAS_LAST_FSYNC, true);
	109	}
	110
39a53e0c JK	111	static inline void node_info_from_raw_nat(struct node_info *ni,
	112	struct f2fs_nat_entry *raw_ne)
	113	{
	114	ni->ino = le32_to_cpu(raw_ne->ino);
	115	ni->blk_addr = le32_to_cpu(raw_ne->block_addr);
	116	ni->version = raw_ne->version;
	117	}
	118
94dac22e CY	119	static inline void raw_nat_from_node_info(struct f2fs_nat_entry *raw_ne,
	120	struct node_info *ni)
	121	{
	122	raw_ne->ino = cpu_to_le32(ni->ino);
	123	raw_ne->block_addr = cpu_to_le32(ni->blk_addr);
	124	raw_ne->version = ni->version;
	125	}
	126
7d768d2c CY	127	static inline bool excess_dirty_nats(struct f2fs_sb_info *sbi)
	128	{
	129	return NM_I(sbi)->dirty_nat_cnt >= NM_I(sbi)->max_nid *
2304cb0c	130	NM_I(sbi)->dirty_nats_ratio / 100;
7d768d2c CY	131	}
7d768d2c CY	132
e589c2c4 JK	133	static inline bool excess_cached_nats(struct f2fs_sb_info *sbi)
	134	{
	135	return NM_I(sbi)->nat_cnt >= DEF_NAT_CACHE_THRESHOLD;
	136	}
	137
fd8c8caf CY	138	static inline bool excess_dirty_nodes(struct f2fs_sb_info *sbi)
	139	{
	140	return get_pages(sbi, F2FS_DIRTY_NODES) >= sbi->blocks_per_seg * 8;
	141	}
	142
6fb03f3a	143	enum mem_type {
cdfc41c1	144	FREE_NIDS, /* indicates the free nid list */
6fb03f3a	145	NAT_ENTRIES, /* indicates the cached nat entry */
a1257023	146	DIRTY_DENTS, /* indicates dirty dentry pages */
e5e7ea3c	147	INO_ENTRIES, /* indicates inode entries */
13054c54	148	EXTENT_CACHE, /* indicates extent cache */
57864ae5	149	INMEM_PAGES, /* indicates inmemory 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) -
3519e3f9	211	(block_off & (sbi->blocks_per_seg - 1)));
39a53e0c JK	212
	213	if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
	214	block_addr += sbi->blocks_per_seg;
	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;
72fdbe2e	225	block_addr ^= 1 << 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 JK	391	static inline int is_cold_data(struct page *page)
	392	{
	393	return PageChecked(page);
	394	}
	395
	396	static inline void set_cold_data(struct page *page)
	397	{
	398	SetPageChecked(page);
	399	}
	400
	401	static inline void clear_cold_data(struct page *page)
	402	{
	403	ClearPageChecked(page);
	404	}
	405
a06a2416	406	static inline int is_node(struct page *page, int type)
39a53e0c	407	{
45590710	408	struct f2fs_node *rn = F2FS_NODE(page);
a06a2416	409	return le32_to_cpu(rn->footer.flag) & (1 << type);
39a53e0c JK	410	}
39a53e0c JK	411
a06a2416 NJ	412	#define is_cold_node(page) is_node(page, COLD_BIT_SHIFT)
	413	#define is_fsync_dnode(page) is_node(page, FSYNC_BIT_SHIFT)
	414	#define is_dent_dnode(page) is_node(page, DENT_BIT_SHIFT)
39a53e0c	415
2049d4fc JK	416	static inline int is_inline_node(struct page *page)
	417	{
	418	return PageChecked(page);
	419	}
	420
	421	static inline void set_inline_node(struct page *page)
	422	{
	423	SetPageChecked(page);
	424	}
	425
	426	static inline void clear_inline_node(struct page *page)
	427	{
	428	ClearPageChecked(page);
	429	}
	430
c5667575	431	static inline void set_cold_node(struct page *page, bool is_dir)
39a53e0c	432	{
45590710	433	struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c JK	434	unsigned int flag = le32_to_cpu(rn->footer.flag);
39a53e0c JK	435
c5667575	436	if (is_dir)
39a53e0c JK	437	flag &= ~(0x1 << COLD_BIT_SHIFT);
	438	else
	439	flag \|= (0x1 << COLD_BIT_SHIFT);
	440	rn->footer.flag = cpu_to_le32(flag);
	441	}
	442
a06a2416	443	static inline void set_mark(struct page *page, int mark, int type)
39a53e0c	444	{
45590710	445	struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c JK	446	unsigned int flag = le32_to_cpu(rn->footer.flag);
39a53e0c JK	447	if (mark)
a06a2416	448	flag \|= (0x1 << type);
39a53e0c	449	else
a06a2416	450	flag &= ~(0x1 << type);
39a53e0c	451	rn->footer.flag = cpu_to_le32(flag);
54c55c4e WG	452
	453	#ifdef CONFIG_F2FS_CHECK_FS
	454	f2fs_inode_chksum_set(F2FS_P_SB(page), page);
	455	#endif
39a53e0c	456	}
a06a2416 NJ	457	#define set_dentry_mark(page, mark) set_mark(page, mark, DENT_BIT_SHIFT)
a06a2416 NJ	458	#define set_fsync_mark(page, mark) set_mark(page, mark, FSYNC_BIT_SHIFT)