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

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