[mirror_ubuntu-bionic-kernel.git] / fs / ext4 / extents_status.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  fs/ext4/extents_status.h
 *
 * Written by Yongqiang Yang <xiaoqiangnk@gmail.com>
 * Modified by
 *	Allison Henderson <achender@linux.vnet.ibm.com>
 *	Zheng Liu <wenqing.lz@taobao.com>
 *
 */

#ifndef _EXT4_EXTENTS_STATUS_H
#define _EXT4_EXTENTS_STATUS_H

/*
 * Turn on ES_DEBUG__ to get lots of info about extent status operations.
 */
#ifdef ES_DEBUG__
#define es_debug(fmt, ...)	printk(fmt, ##__VA_ARGS__)
#else
#define es_debug(fmt, ...)	no_printk(fmt, ##__VA_ARGS__)
#endif

/*
 * With ES_AGGRESSIVE_TEST defined, the result of es caching will be
 * checked with old map_block's result.
 */
#define ES_AGGRESSIVE_TEST__

/*
 * These flags live in the high bits of extent_status.es_pblk
 */
enum {
	ES_WRITTEN_B,
	ES_UNWRITTEN_B,
	ES_DELAYED_B,
	ES_HOLE_B,
	ES_REFERENCED_B,
	ES_FLAGS
};

#define ES_SHIFT (sizeof(ext4_fsblk_t)*8 - ES_FLAGS)
#define ES_MASK (~((ext4_fsblk_t)0) << ES_SHIFT)

#define EXTENT_STATUS_WRITTEN	(1 << ES_WRITTEN_B)
#define EXTENT_STATUS_UNWRITTEN (1 << ES_UNWRITTEN_B)
#define EXTENT_STATUS_DELAYED	(1 << ES_DELAYED_B)
#define EXTENT_STATUS_HOLE	(1 << ES_HOLE_B)
#define EXTENT_STATUS_REFERENCED	(1 << ES_REFERENCED_B)

#define ES_TYPE_MASK	((ext4_fsblk_t)(EXTENT_STATUS_WRITTEN | \
			  EXTENT_STATUS_UNWRITTEN | \
			  EXTENT_STATUS_DELAYED | \
			  EXTENT_STATUS_HOLE) << ES_SHIFT)

struct ext4_sb_info;
struct ext4_extent;

struct extent_status {
	struct rb_node rb_node;
	ext4_lblk_t es_lblk;	/* first logical block extent covers */
	ext4_lblk_t es_len;	/* length of extent in block */
	ext4_fsblk_t es_pblk;	/* first physical block */
};

struct ext4_es_tree {
	struct rb_root root;
	struct extent_status *cache_es;	/* recently accessed extent */
};

struct ext4_es_stats {
	unsigned long es_stats_shrunk;
	unsigned long es_stats_cache_hits;
	unsigned long es_stats_cache_misses;
	u64 es_stats_scan_time;
	u64 es_stats_max_scan_time;
	struct percpu_counter es_stats_all_cnt;
	struct percpu_counter es_stats_shk_cnt;
};

extern int __init ext4_init_es(void);
extern void ext4_exit_es(void);
extern void ext4_es_init_tree(struct ext4_es_tree *tree);

extern int ext4_es_insert_extent(struct inode *inode, ext4_lblk_t lblk,
				 ext4_lblk_t len, ext4_fsblk_t pblk,
				 unsigned int status);
extern void ext4_es_cache_extent(struct inode *inode, ext4_lblk_t lblk,
				 ext4_lblk_t len, ext4_fsblk_t pblk,
				 unsigned int status);
extern int ext4_es_remove_extent(struct inode *inode, ext4_lblk_t lblk,
				 ext4_lblk_t len);
extern void ext4_es_find_delayed_extent_range(struct inode *inode,
					ext4_lblk_t lblk, ext4_lblk_t end,
					struct extent_status *es);
extern int ext4_es_lookup_extent(struct inode *inode, ext4_lblk_t lblk,
				 struct extent_status *es);

static inline unsigned int ext4_es_status(struct extent_status *es)
{
	return es->es_pblk >> ES_SHIFT;
}

static inline unsigned int ext4_es_type(struct extent_status *es)
{
	return (es->es_pblk & ES_TYPE_MASK) >> ES_SHIFT;
}

static inline int ext4_es_is_written(struct extent_status *es)
{
	return (ext4_es_type(es) & EXTENT_STATUS_WRITTEN) != 0;
}

static inline int ext4_es_is_unwritten(struct extent_status *es)
{
	return (ext4_es_type(es) & EXTENT_STATUS_UNWRITTEN) != 0;
}

static inline int ext4_es_is_delayed(struct extent_status *es)
{
	return (ext4_es_type(es) & EXTENT_STATUS_DELAYED) != 0;
}

static inline int ext4_es_is_hole(struct extent_status *es)
{
	return (ext4_es_type(es) & EXTENT_STATUS_HOLE) != 0;
}

static inline void ext4_es_set_referenced(struct extent_status *es)
{
	es->es_pblk |= ((ext4_fsblk_t)EXTENT_STATUS_REFERENCED) << ES_SHIFT;
}

static inline void ext4_es_clear_referenced(struct extent_status *es)
{
	es->es_pblk &= ~(((ext4_fsblk_t)EXTENT_STATUS_REFERENCED) << ES_SHIFT);
}

static inline int ext4_es_is_referenced(struct extent_status *es)
{
	return (ext4_es_status(es) & EXTENT_STATUS_REFERENCED) != 0;
}

static inline ext4_fsblk_t ext4_es_pblock(struct extent_status *es)
{
	return es->es_pblk & ~ES_MASK;
}

static inline void ext4_es_store_pblock(struct extent_status *es,
					ext4_fsblk_t pb)
{
	ext4_fsblk_t block;

	block = (pb & ~ES_MASK) | (es->es_pblk & ES_MASK);
	es->es_pblk = block;
}

static inline void ext4_es_store_status(struct extent_status *es,
					unsigned int status)
{
	es->es_pblk = (((ext4_fsblk_t)status << ES_SHIFT) & ES_MASK) |
		      (es->es_pblk & ~ES_MASK);
}

static inline void ext4_es_store_pblock_status(struct extent_status *es,
					       ext4_fsblk_t pb,
					       unsigned int status)
{
	es->es_pblk = (((ext4_fsblk_t)status << ES_SHIFT) & ES_MASK) |
		      (pb & ~ES_MASK);
}

extern int ext4_es_register_shrinker(struct ext4_sb_info *sbi);
extern void ext4_es_unregister_shrinker(struct ext4_sb_info *sbi);

extern int ext4_seq_es_shrinker_info_show(struct seq_file *seq, void *v);

#endif /* _EXT4_EXTENTS_STATUS_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
c0677e6d ZL	2	/*
	3	* fs/ext4/extents_status.h
	4	*
	5	* Written by Yongqiang Yang <xiaoqiangnk@gmail.com>
	6	* Modified by
	7	* Allison Henderson <achender@linux.vnet.ibm.com>
	8	* Zheng Liu <wenqing.lz@taobao.com>
	9	*
	10	*/
	11
	12	#ifndef _EXT4_EXTENTS_STATUS_H
	13	#define _EXT4_EXTENTS_STATUS_H
	14
654598be ZL	15	/*
	16	* Turn on ES_DEBUG__ to get lots of info about extent status operations.
	17	*/
	18	#ifdef ES_DEBUG__
	19	#define es_debug(fmt, ...) printk(fmt, ##__VA_ARGS__)
	20	#else
	21	#define es_debug(fmt, ...) no_printk(fmt, ##__VA_ARGS__)
	22	#endif
	23
921f266b DM	24	/*
	25	* With ES_AGGRESSIVE_TEST defined, the result of es caching will be
	26	* checked with old map_block's result.
	27	*/
	28	#define ES_AGGRESSIVE_TEST__
	29
8e919d13 TT	30	/*
	31	* These flags live in the high bits of extent_status.es_pblk
	32	*/
624d0f1d JK	33	enum {
	34	ES_WRITTEN_B,
	35	ES_UNWRITTEN_B,
	36	ES_DELAYED_B,
	37	ES_HOLE_B,
2be12de9	38	ES_REFERENCED_B,
624d0f1d JK	39	ES_FLAGS
624d0f1d JK	40	};
fdc0212e	41
624d0f1d JK	42	#define ES_SHIFT (sizeof(ext4_fsblk_t)*8 - ES_FLAGS)
624d0f1d JK	43	#define ES_MASK (~((ext4_fsblk_t)0) << ES_SHIFT)
3be78c73	44
624d0f1d JK	45	#define EXTENT_STATUS_WRITTEN (1 << ES_WRITTEN_B)
	46	#define EXTENT_STATUS_UNWRITTEN (1 << ES_UNWRITTEN_B)
	47	#define EXTENT_STATUS_DELAYED (1 << ES_DELAYED_B)
	48	#define EXTENT_STATUS_HOLE (1 << ES_HOLE_B)
2be12de9 JK	49	#define EXTENT_STATUS_REFERENCED (1 << ES_REFERENCED_B)
	50
	51	#define ES_TYPE_MASK ((ext4_fsblk_t)(EXTENT_STATUS_WRITTEN \| \
	52	EXTENT_STATUS_UNWRITTEN \| \
	53	EXTENT_STATUS_DELAYED \| \
	54	EXTENT_STATUS_HOLE) << ES_SHIFT)
3be78c73	55
d3922a77	56	struct ext4_sb_info;
adb23551 ZL	57	struct ext4_extent;
adb23551 ZL	58
c0677e6d ZL	59	struct extent_status {
c0677e6d ZL	60	struct rb_node rb_node;
06b0c886 ZL	61	ext4_lblk_t es_lblk; /* first logical block extent covers */
06b0c886 ZL	62	ext4_lblk_t es_len; /* length of extent in block */
fdc0212e	63	ext4_fsblk_t es_pblk; /* first physical block */
c0677e6d ZL	64	};
	65
	66	struct ext4_es_tree {
	67	struct rb_root root;
	68	struct extent_status cache_es; / recently accessed extent */
	69	};
	70
eb68d0e2	71	struct ext4_es_stats {
eb68d0e2 ZL	72	unsigned long es_stats_shrunk;
	73	unsigned long es_stats_cache_hits;
	74	unsigned long es_stats_cache_misses;
	75	u64 es_stats_scan_time;
	76	u64 es_stats_max_scan_time;
	77	struct percpu_counter es_stats_all_cnt;
edaa53ca	78	struct percpu_counter es_stats_shk_cnt;
eb68d0e2 ZL	79	};
eb68d0e2 ZL	80
654598be ZL	81	extern int __init ext4_init_es(void);
	82	extern void ext4_exit_es(void);
	83	extern void ext4_es_init_tree(struct ext4_es_tree *tree);
	84
06b0c886	85	extern int ext4_es_insert_extent(struct inode *inode, ext4_lblk_t lblk,
fdc0212e	86	ext4_lblk_t len, ext4_fsblk_t pblk,
3be78c73	87	unsigned int status);
107a7bd3 TT	88	extern void ext4_es_cache_extent(struct inode *inode, ext4_lblk_t lblk,
	89	ext4_lblk_t len, ext4_fsblk_t pblk,
	90	unsigned int status);
06b0c886	91	extern int ext4_es_remove_extent(struct inode *inode, ext4_lblk_t lblk,
654598be	92	ext4_lblk_t len);
e30b5dca YZ	93	extern void ext4_es_find_delayed_extent_range(struct inode *inode,
e30b5dca YZ	94	ext4_lblk_t lblk, ext4_lblk_t end,
be401363	95	struct extent_status *es);
d100eef2 ZL	96	extern int ext4_es_lookup_extent(struct inode *inode, ext4_lblk_t lblk,
d100eef2 ZL	97	struct extent_status *es);
654598be	98
624d0f1d JK	99	static inline unsigned int ext4_es_status(struct extent_status *es)
	100	{
	101	return es->es_pblk >> ES_SHIFT;
	102	}
	103
2be12de9 JK	104	static inline unsigned int ext4_es_type(struct extent_status *es)
	105	{
	106	return (es->es_pblk & ES_TYPE_MASK) >> ES_SHIFT;
	107	}
	108
fdc0212e ZL	109	static inline int ext4_es_is_written(struct extent_status *es)
fdc0212e ZL	110	{
2be12de9	111	return (ext4_es_type(es) & EXTENT_STATUS_WRITTEN) != 0;
fdc0212e ZL	112	}
	113
	114	static inline int ext4_es_is_unwritten(struct extent_status *es)
	115	{
2be12de9	116	return (ext4_es_type(es) & EXTENT_STATUS_UNWRITTEN) != 0;
fdc0212e ZL	117	}
	118
	119	static inline int ext4_es_is_delayed(struct extent_status *es)
	120	{
2be12de9	121	return (ext4_es_type(es) & EXTENT_STATUS_DELAYED) != 0;
fdc0212e ZL	122	}
	123
	124	static inline int ext4_es_is_hole(struct extent_status *es)
	125	{
2be12de9 JK	126	return (ext4_es_type(es) & EXTENT_STATUS_HOLE) != 0;
	127	}
	128
	129	static inline void ext4_es_set_referenced(struct extent_status *es)
	130	{
	131	es->es_pblk \|= ((ext4_fsblk_t)EXTENT_STATUS_REFERENCED) << ES_SHIFT;
	132	}
	133
	134	static inline void ext4_es_clear_referenced(struct extent_status *es)
	135	{
	136	es->es_pblk &= ~(((ext4_fsblk_t)EXTENT_STATUS_REFERENCED) << ES_SHIFT);
	137	}
	138
	139	static inline int ext4_es_is_referenced(struct extent_status *es)
	140	{
	141	return (ext4_es_status(es) & EXTENT_STATUS_REFERENCED) != 0;
fdc0212e ZL	142	}
	143
	144	static inline ext4_fsblk_t ext4_es_pblock(struct extent_status *es)
	145	{
3be78c73	146	return es->es_pblk & ~ES_MASK;
fdc0212e ZL	147	}
	148
	149	static inline void ext4_es_store_pblock(struct extent_status *es,
	150	ext4_fsblk_t pb)
	151	{
	152	ext4_fsblk_t block;
	153
3be78c73	154	block = (pb & ~ES_MASK) \| (es->es_pblk & ES_MASK);
fdc0212e ZL	155	es->es_pblk = block;
	156	}
	157
	158	static inline void ext4_es_store_status(struct extent_status *es,
3be78c73	159	unsigned int status)
fdc0212e	160	{
624d0f1d JK	161	es->es_pblk = (((ext4_fsblk_t)status << ES_SHIFT) & ES_MASK) \|
624d0f1d JK	162	(es->es_pblk & ~ES_MASK);
fdc0212e ZL	163	}
fdc0212e ZL	164
9a6633b1 TT	165	static inline void ext4_es_store_pblock_status(struct extent_status *es,
	166	ext4_fsblk_t pb,
	167	unsigned int status)
	168	{
624d0f1d JK	169	es->es_pblk = (((ext4_fsblk_t)status << ES_SHIFT) & ES_MASK) \|
624d0f1d JK	170	(pb & ~ES_MASK);
9a6633b1 TT	171	}
9a6633b1 TT	172
eb68d0e2	173	extern int ext4_es_register_shrinker(struct ext4_sb_info *sbi);
d3922a77	174	extern void ext4_es_unregister_shrinker(struct ext4_sb_info *sbi);
74cd15cd	175
ebd173be TT	176	extern int ext4_seq_es_shrinker_info_show(struct seq_file seq, void v);
ebd173be TT	177
c0677e6d	178	#endif /* _EXT4_EXTENTS_STATUS_H */