[mirror_ubuntu-zesty-kernel.git] / fs / f2fs / node.h

/*
 * fs/f2fs/node.h
 *
 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
 *             http://www.samsung.com/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
/* 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? */
};

/*
 * 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;
}

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 */
	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 */
};

/*
 * For free nid mangement
 */
enum nid_state {
	NID_NEW,	/* newly added to free nid list */
	NID_ALLOC	/* it is allocated */
};

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

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_LIST] <= 0) {
		spin_unlock(&nm_i->nid_list_lock);
		return;
	}
	fnid = list_entry(nm_i->nid_list[FREE_NID_LIST].next,
						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);
	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;
	int seg_off;

	block_off = NAT_BLOCK_OFFSET(start);
	seg_off = block_off >> sbi->log_blocks_per_seg;

	block_addr = (pgoff_t)(nm_i->nat_blkaddr +
		(seg_off << sbi->log_blocks_per_seg << 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;
	if ((block_addr >> sbi->log_blocks_per_seg) % 2)
		block_addr -= sbi->blocks_per_seg;
	else
		block_addr += sbi->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);
}

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);
	size_t crc_offset = le32_to_cpu(ckpt->checksum_offset);
	__u64 cp_ver = le64_to_cpu(ckpt->checkpoint_ver);

	if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG)) {
		__u64 crc = le32_to_cpu(*((__le32 *)
				((unsigned char *)ckpt + crc_offset)));
		cp_ver |= (crc << 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));
	size_t crc_offset = le32_to_cpu(ckpt->checksum_offset);
	__u64 cp_ver = cur_cp_version(ckpt);

	if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG)) {
		__u64 crc = le32_to_cpu(*((__le32 *)
				((unsigned char *)ckpt + crc_offset)));
		cp_ver |= (crc << 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 false;

	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 inode *inode, struct page *page)
{
	struct f2fs_node *rn = F2FS_NODE(page);
	unsigned int flag = le32_to_cpu(rn->footer.flag);

	if (S_ISDIR(inode->i_mode))
		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);
}
#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
0a8165d7	1	/*
39a53e0c JK	2	* fs/f2fs/node.h
	3	*
	4	* Copyright (c) 2012 Samsung Electronics Co., Ltd.
	5	* http://www.samsung.com/
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*/
	11	/* start node id of a node block dedicated to the given node id */
	12	#define START_NID(nid) ((nid / NAT_ENTRY_PER_BLOCK) * NAT_ENTRY_PER_BLOCK)
	13
	14	/* node block offset on the NAT area dedicated to the given start node id */
	15	#define NAT_BLOCK_OFFSET(start_nid) (start_nid / NAT_ENTRY_PER_BLOCK)
	16
ea1a29a0	17	/* # of pages to perform synchronous readahead before building free nids */
ad4edb83 JK	18	#define FREE_NID_PAGES 8
ad4edb83 JK	19	#define MAX_FREE_NIDS (NAT_ENTRY_PER_BLOCK * FREE_NID_PAGES)
39a53e0c	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? */
	47	};
	48
39a53e0c JK	49	/*
	50	* For node information
	51	*/
	52	struct node_info {
	53	nid_t nid; /* node id */
	54	nid_t ino; /* inode number of the node's owner */
	55	block_t blk_addr; /* block address of the node */
	56	unsigned char version; /* version of the node */
5c27f4ee	57	unsigned char flag; /* for node information bits */
7ef35e3b JK	58	};
7ef35e3b JK	59
39a53e0c JK	60	struct nat_entry {
39a53e0c JK	61	struct list_head list; /* for clean or dirty nat list */
39a53e0c JK	62	struct node_info ni; /* in-memory node information */
	63	};
	64
	65	#define nat_get_nid(nat) (nat->ni.nid)
	66	#define nat_set_nid(nat, n) (nat->ni.nid = n)
	67	#define nat_get_blkaddr(nat) (nat->ni.blk_addr)
	68	#define nat_set_blkaddr(nat, b) (nat->ni.blk_addr = b)
	69	#define nat_get_ino(nat) (nat->ni.ino)
	70	#define nat_set_ino(nat, i) (nat->ni.ino = i)
	71	#define nat_get_version(nat) (nat->ni.version)
	72	#define nat_set_version(nat, v) (nat->ni.version = v)
	73
39a53e0c JK	74	#define inc_node_version(version) (++version)
39a53e0c JK	75
5c27f4ee CY	76	static inline void copy_node_info(struct node_info *dst,
	77	struct node_info *src)
	78	{
	79	dst->nid = src->nid;
	80	dst->ino = src->ino;
	81	dst->blk_addr = src->blk_addr;
	82	dst->version = src->version;
	83	/* should not copy flag here */
	84	}
	85
7ef35e3b JK	86	static inline void set_nat_flag(struct nat_entry *ne,
	87	unsigned int type, bool set)
	88	{
	89	unsigned char mask = 0x01 << type;
	90	if (set)
5c27f4ee	91	ne->ni.flag \|= mask;
7ef35e3b	92	else
5c27f4ee	93	ne->ni.flag &= ~mask;
7ef35e3b JK	94	}
	95
	96	static inline bool get_nat_flag(struct nat_entry *ne, unsigned int type)
	97	{
	98	unsigned char mask = 0x01 << type;
5c27f4ee	99	return ne->ni.flag & mask;
7ef35e3b JK	100	}
7ef35e3b JK	101
88bd02c9 JK	102	static inline void nat_reset_flag(struct nat_entry *ne)
	103	{
	104	/* these states can be set only after checkpoint was done */
	105	set_nat_flag(ne, IS_CHECKPOINTED, true);
	106	set_nat_flag(ne, HAS_FSYNCED_INODE, false);
	107	set_nat_flag(ne, HAS_LAST_FSYNC, true);
	108	}
	109
39a53e0c JK	110	static inline void node_info_from_raw_nat(struct node_info *ni,
	111	struct f2fs_nat_entry *raw_ne)
	112	{
	113	ni->ino = le32_to_cpu(raw_ne->ino);
	114	ni->blk_addr = le32_to_cpu(raw_ne->block_addr);
	115	ni->version = raw_ne->version;
	116	}
	117
94dac22e CY	118	static inline void raw_nat_from_node_info(struct f2fs_nat_entry *raw_ne,
	119	struct node_info *ni)
	120	{
	121	raw_ne->ino = cpu_to_le32(ni->ino);
	122	raw_ne->block_addr = cpu_to_le32(ni->blk_addr);
	123	raw_ne->version = ni->version;
	124	}
	125
7d768d2c CY	126	static inline bool excess_dirty_nats(struct f2fs_sb_info *sbi)
	127	{
	128	return NM_I(sbi)->dirty_nat_cnt >= NM_I(sbi)->max_nid *
2304cb0c	129	NM_I(sbi)->dirty_nats_ratio / 100;
7d768d2c CY	130	}
7d768d2c CY	131
e589c2c4 JK	132	static inline bool excess_cached_nats(struct f2fs_sb_info *sbi)
	133	{
	134	return NM_I(sbi)->nat_cnt >= DEF_NAT_CACHE_THRESHOLD;
	135	}
	136
6fb03f3a	137	enum mem_type {
cdfc41c1	138	FREE_NIDS, /* indicates the free nid list */
6fb03f3a	139	NAT_ENTRIES, /* indicates the cached nat entry */
a1257023	140	DIRTY_DENTS, /* indicates dirty dentry pages */
e5e7ea3c	141	INO_ENTRIES, /* indicates inode entries */
13054c54	142	EXTENT_CACHE, /* indicates extent cache */
1e84371f	143	BASE_CHECK, /* check kernel status */
cdfc41c1 JK	144	};
cdfc41c1 JK	145
aec71382	146	struct nat_entry_set {
309cc2b6	147	struct list_head set_list; /* link with other nat sets */
aec71382	148	struct list_head entry_list; /* link with dirty nat entries */
309cc2b6	149	nid_t set; /* set number*/
aec71382 CY	150	unsigned int entry_cnt; /* the # of nat entries in set */
	151	};
	152
39a53e0c JK	153	/*
	154	* For free nid mangement
	155	*/
	156	enum nid_state {
	157	NID_NEW, /* newly added to free nid list */
	158	NID_ALLOC /* it is allocated */
	159	};
	160
	161	struct free_nid {
	162	struct list_head list; /* for free node id list */
	163	nid_t nid; /* node id */
	164	int state; /* in use or not: NID_NEW or NID_ALLOC */
	165	};
	166
120c2cba	167	static inline void next_free_nid(struct f2fs_sb_info sbi, nid_t nid)
39a53e0c JK	168	{
	169	struct f2fs_nm_info *nm_i = NM_I(sbi);
	170	struct free_nid *fnid;
	171
b8559dc2 CY	172	spin_lock(&nm_i->nid_list_lock);
	173	if (nm_i->nid_cnt[FREE_NID_LIST] <= 0) {
	174	spin_unlock(&nm_i->nid_list_lock);
120c2cba	175	return;
c6e48930	176	}
b8559dc2 CY	177	fnid = list_entry(nm_i->nid_list[FREE_NID_LIST].next,
b8559dc2 CY	178	struct free_nid, list);
39a53e0c	179	*nid = fnid->nid;
b8559dc2	180	spin_unlock(&nm_i->nid_list_lock);
39a53e0c JK	181	}
	182
	183	/*
	184	* inline functions
	185	*/
	186	static inline void get_nat_bitmap(struct f2fs_sb_info sbi, void addr)
	187	{
	188	struct f2fs_nm_info *nm_i = NM_I(sbi);
	189	memcpy(addr, nm_i->nat_bitmap, nm_i->bitmap_size);
	190	}
	191
	192	static inline pgoff_t current_nat_addr(struct f2fs_sb_info *sbi, nid_t start)
	193	{
	194	struct f2fs_nm_info *nm_i = NM_I(sbi);
	195	pgoff_t block_off;
	196	pgoff_t block_addr;
	197	int seg_off;
	198
	199	block_off = NAT_BLOCK_OFFSET(start);
	200	seg_off = block_off >> sbi->log_blocks_per_seg;
	201
	202	block_addr = (pgoff_t)(nm_i->nat_blkaddr +
	203	(seg_off << sbi->log_blocks_per_seg << 1) +
3519e3f9	204	(block_off & (sbi->blocks_per_seg - 1)));
39a53e0c JK	205
	206	if (f2fs_test_bit(block_off, nm_i->nat_bitmap))
	207	block_addr += sbi->blocks_per_seg;
	208
	209	return block_addr;
	210	}
	211
	212	static inline pgoff_t next_nat_addr(struct f2fs_sb_info *sbi,
	213	pgoff_t block_addr)
	214	{
	215	struct f2fs_nm_info *nm_i = NM_I(sbi);
	216
	217	block_addr -= nm_i->nat_blkaddr;
	218	if ((block_addr >> sbi->log_blocks_per_seg) % 2)
	219	block_addr -= sbi->blocks_per_seg;
	220	else
	221	block_addr += sbi->blocks_per_seg;
	222
	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);
39a53e0c JK	231	}
39a53e0c JK	232
a468f0ef JK	233	static inline nid_t ino_of_node(struct page *node_page)
	234	{
	235	struct f2fs_node *rn = F2FS_NODE(node_page);
	236	return le32_to_cpu(rn->footer.ino);
	237	}
	238
	239	static inline nid_t nid_of_node(struct page *node_page)
	240	{
	241	struct f2fs_node *rn = F2FS_NODE(node_page);
	242	return le32_to_cpu(rn->footer.nid);
	243	}
	244
	245	static inline unsigned int ofs_of_node(struct page *node_page)
	246	{
	247	struct f2fs_node *rn = F2FS_NODE(node_page);
	248	unsigned flag = le32_to_cpu(rn->footer.flag);
	249	return flag >> OFFSET_BIT_SHIFT;
	250	}
	251
	252	static inline __u64 cpver_of_node(struct page *node_page)
	253	{
	254	struct f2fs_node *rn = F2FS_NODE(node_page);
	255	return le64_to_cpu(rn->footer.cp_ver);
	256	}
	257
	258	static inline block_t next_blkaddr_of_node(struct page *node_page)
	259	{
	260	struct f2fs_node *rn = F2FS_NODE(node_page);
	261	return le32_to_cpu(rn->footer.next_blkaddr);
	262	}
	263
39a53e0c JK	264	static inline void fill_node_footer(struct page *page, nid_t nid,
	265	nid_t ino, unsigned int ofs, bool reset)
	266	{
45590710	267	struct f2fs_node *rn = F2FS_NODE(page);
09eb483e JK	268	unsigned int old_flag = 0;
09eb483e JK	269
39a53e0c JK	270	if (reset)
39a53e0c JK	271	memset(rn, 0, sizeof(*rn));
09eb483e JK	272	else
	273	old_flag = le32_to_cpu(rn->footer.flag);
	274
39a53e0c JK	275	rn->footer.nid = cpu_to_le32(nid);
39a53e0c JK	276	rn->footer.ino = cpu_to_le32(ino);
09eb483e JK	277
	278	/* should remain old flag bits such as COLD_BIT_SHIFT */
	279	rn->footer.flag = cpu_to_le32((ofs << OFFSET_BIT_SHIFT) \|
	280	(old_flag & OFFSET_BIT_MASK));
39a53e0c JK	281	}
	282
	283	static inline void copy_node_footer(struct page dst, struct page src)
	284	{
45590710 GZ	285	struct f2fs_node *src_rn = F2FS_NODE(src);
45590710 GZ	286	struct f2fs_node *dst_rn = F2FS_NODE(dst);
39a53e0c JK	287	memcpy(&dst_rn->footer, &src_rn->footer, sizeof(struct node_footer));
	288	}
	289
	290	static inline void fill_node_footer_blkaddr(struct page *page, block_t blkaddr)
	291	{
4081363f	292	struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
45590710	293	struct f2fs_node *rn = F2FS_NODE(page);
a468f0ef JK	294	size_t crc_offset = le32_to_cpu(ckpt->checksum_offset);
a468f0ef JK	295	__u64 cp_ver = le64_to_cpu(ckpt->checkpoint_ver);
45590710	296
aaec2b1d	297	if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG)) {
a468f0ef JK	298	__u64 crc = le32_to_cpu(((__le32 )
	299	((unsigned char *)ckpt + crc_offset)));
	300	cp_ver \|= (crc << 32);
	301	}
	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 JK	308	struct f2fs_checkpoint *ckpt = F2FS_CKPT(F2FS_P_SB(page));
	309	size_t crc_offset = le32_to_cpu(ckpt->checksum_offset);
	310	__u64 cp_ver = cur_cp_version(ckpt);
39a53e0c	311
aaec2b1d	312	if (__is_set_ckpt_flags(ckpt, CP_CRC_RECOVERY_FLAG)) {
a468f0ef JK	313	__u64 crc = le32_to_cpu(((__le32 )
	314	((unsigned char *)ckpt + crc_offset)));
	315	cp_ver \|= (crc << 32);
	316	}
0c0b471e	317	return cp_ver == cpver_of_node(page);
39a53e0c JK	318	}
	319
	320	/*
	321	* f2fs assigns the following node offsets described as (num).
	322	* N = NIDS_PER_BLOCK
	323	*
	324	* Inode block (0)
	325	* \|- direct node (1)
	326	* \|- direct node (2)
	327	* \|- indirect node (3)
	328	* \| `- direct node (4 => 4 + N - 1)
	329	* \|- indirect node (4 + N)
	330	* \| `- direct node (5 + N => 5 + 2N - 1)
	331	* `- double indirect node (5 + 2N)
	332	* `- indirect node (6 + 2N)
4f4124d0 CY	333	* `- direct node
	334	* ......
	335	* `- indirect node ((6 + 2N) + x(N + 1))
	336	* `- direct node
	337	* ......
	338	* `- indirect node ((6 + 2N) + (N - 1)(N + 1))
	339	* `- direct node
39a53e0c JK	340	*/
	341	static inline bool IS_DNODE(struct page *node_page)
	342	{
	343	unsigned int ofs = ofs_of_node(node_page);
dbe6a5ff	344
4bc8e9bc	345	if (f2fs_has_xattr_block(ofs))
dbe6a5ff JK	346	return false;
dbe6a5ff JK	347
39a53e0c JK	348	if (ofs == 3 \|\| ofs == 4 + NIDS_PER_BLOCK \|\|
	349	ofs == 5 + 2 * NIDS_PER_BLOCK)
	350	return false;
	351	if (ofs >= 6 + 2 * NIDS_PER_BLOCK) {
	352	ofs -= 6 + 2 * NIDS_PER_BLOCK;
3315101f	353	if (!((long int)ofs % (NIDS_PER_BLOCK + 1)))
39a53e0c JK	354	return false;
	355	}
	356	return true;
	357	}
	358
12719ae1	359	static inline int set_nid(struct page *p, int off, nid_t nid, bool i)
39a53e0c	360	{
45590710	361	struct f2fs_node *rn = F2FS_NODE(p);
39a53e0c	362
fec1d657	363	f2fs_wait_on_page_writeback(p, NODE, true);
39a53e0c JK	364
	365	if (i)
	366	rn->i.i_nid[off - NODE_DIR1_BLOCK] = cpu_to_le32(nid);
	367	else
	368	rn->in.nid[off] = cpu_to_le32(nid);
12719ae1	369	return set_page_dirty(p);
39a53e0c JK	370	}
	371
	372	static inline nid_t get_nid(struct page *p, int off, bool i)
	373	{
45590710 GZ	374	struct f2fs_node *rn = F2FS_NODE(p);
45590710 GZ	375
39a53e0c JK	376	if (i)
	377	return le32_to_cpu(rn->i.i_nid[off - NODE_DIR1_BLOCK]);
	378	return le32_to_cpu(rn->in.nid[off]);
	379	}
	380
	381	/*
	382	* Coldness identification:
	383	* - Mark cold files in f2fs_inode_info
	384	* - Mark cold node blocks in their node footer
	385	* - Mark cold data pages in page cache
	386	*/
39a53e0c JK	387	static inline int is_cold_data(struct page *page)
	388	{
	389	return PageChecked(page);
	390	}
	391
	392	static inline void set_cold_data(struct page *page)
	393	{
	394	SetPageChecked(page);
	395	}
	396
	397	static inline void clear_cold_data(struct page *page)
	398	{
	399	ClearPageChecked(page);
	400	}
	401
a06a2416	402	static inline int is_node(struct page *page, int type)
39a53e0c	403	{
45590710	404	struct f2fs_node *rn = F2FS_NODE(page);
a06a2416	405	return le32_to_cpu(rn->footer.flag) & (1 << type);
39a53e0c JK	406	}
39a53e0c JK	407
a06a2416 NJ	408	#define is_cold_node(page) is_node(page, COLD_BIT_SHIFT)
	409	#define is_fsync_dnode(page) is_node(page, FSYNC_BIT_SHIFT)
	410	#define is_dent_dnode(page) is_node(page, DENT_BIT_SHIFT)
39a53e0c	411
2049d4fc JK	412	static inline int is_inline_node(struct page *page)
	413	{
	414	return PageChecked(page);
	415	}
	416
	417	static inline void set_inline_node(struct page *page)
	418	{
	419	SetPageChecked(page);
	420	}
	421
	422	static inline void clear_inline_node(struct page *page)
	423	{
	424	ClearPageChecked(page);
	425	}
	426
39a53e0c JK	427	static inline void set_cold_node(struct inode inode, struct page page)
39a53e0c JK	428	{
45590710	429	struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c JK	430	unsigned int flag = le32_to_cpu(rn->footer.flag);
	431
	432	if (S_ISDIR(inode->i_mode))
	433	flag &= ~(0x1 << COLD_BIT_SHIFT);
	434	else
	435	flag \|= (0x1 << COLD_BIT_SHIFT);
	436	rn->footer.flag = cpu_to_le32(flag);
	437	}
	438
a06a2416	439	static inline void set_mark(struct page *page, int mark, int type)
39a53e0c	440	{
45590710	441	struct f2fs_node *rn = F2FS_NODE(page);
39a53e0c JK	442	unsigned int flag = le32_to_cpu(rn->footer.flag);
39a53e0c JK	443	if (mark)
a06a2416	444	flag \|= (0x1 << type);
39a53e0c	445	else
a06a2416	446	flag &= ~(0x1 << type);
39a53e0c JK	447	rn->footer.flag = cpu_to_le32(flag);
39a53e0c JK	448	}
a06a2416 NJ	449	#define set_dentry_mark(page, mark) set_mark(page, mark, DENT_BIT_SHIFT)
a06a2416 NJ	450	#define set_fsync_mark(page, mark) set_mark(page, mark, FSYNC_BIT_SHIFT)