[linux-block.git] / fs / btrfs / extent_map.h

/* SPDX-License-Identifier: GPL-2.0 */

#ifndef BTRFS_EXTENT_MAP_H
#define BTRFS_EXTENT_MAP_H

#include <linux/rbtree.h>
#include <linux/refcount.h>

#define EXTENT_MAP_LAST_BYTE ((u64)-4)
#define EXTENT_MAP_HOLE ((u64)-3)
#define EXTENT_MAP_INLINE ((u64)-2)
/* used only during fiemap calls */
#define EXTENT_MAP_DELALLOC ((u64)-1)

/* bits for the extent_map::flags field */
enum {
	/* this entry not yet on disk, don't free it */
	EXTENT_FLAG_PINNED,
	EXTENT_FLAG_COMPRESSED,
	/* pre-allocated extent */
	EXTENT_FLAG_PREALLOC,
	/* Logging this extent */
	EXTENT_FLAG_LOGGING,
	/* Filling in a preallocated extent */
	EXTENT_FLAG_FILLING,
	/* filesystem extent mapping type */
	EXTENT_FLAG_FS_MAPPING,
	/* This em is merged from two or more physically adjacent ems */
	EXTENT_FLAG_MERGED,
};

struct extent_map {
	struct rb_node rb_node;

	/* all of these are in bytes */
	u64 start;
	u64 len;
	u64 mod_start;
	u64 mod_len;
	u64 orig_start;
	u64 orig_block_len;
	u64 ram_bytes;
	u64 block_start;
	u64 block_len;

	/*
	 * Generation of the extent map, for merged em it's the highest
	 * generation of all merged ems.
	 * For non-merged extents, it's from btrfs_file_extent_item::generation.
	 */
	u64 generation;
	unsigned long flags;
	/* Used for chunk mappings, flag EXTENT_FLAG_FS_MAPPING must be set */
	struct map_lookup *map_lookup;
	refcount_t refs;
	unsigned int compress_type;
	struct list_head list;
};

struct extent_map_tree {
	struct rb_root_cached map;
	struct list_head modified_extents;
	rwlock_t lock;
};

struct btrfs_inode;

static inline int extent_map_in_tree(const struct extent_map *em)
{
	return !RB_EMPTY_NODE(&em->rb_node);
}

static inline u64 extent_map_end(struct extent_map *em)
{
	if (em->start + em->len < em->start)
		return (u64)-1;
	return em->start + em->len;
}

static inline u64 extent_map_block_end(struct extent_map *em)
{
	if (em->block_start + em->block_len < em->block_start)
		return (u64)-1;
	return em->block_start + em->block_len;
}

void extent_map_tree_init(struct extent_map_tree *tree);
struct extent_map *lookup_extent_mapping(struct extent_map_tree *tree,
					 u64 start, u64 len);
int add_extent_mapping(struct extent_map_tree *tree,
		       struct extent_map *em, int modified);
void remove_extent_mapping(struct extent_map_tree *tree, struct extent_map *em);
void replace_extent_mapping(struct extent_map_tree *tree,
			    struct extent_map *cur,
			    struct extent_map *new,
			    int modified);

struct extent_map *alloc_extent_map(void);
void free_extent_map(struct extent_map *em);
int __init extent_map_init(void);
void __cold extent_map_exit(void);
int unpin_extent_cache(struct extent_map_tree *tree, u64 start, u64 len, u64 gen);
void clear_em_logging(struct extent_map_tree *tree, struct extent_map *em);
struct extent_map *search_extent_mapping(struct extent_map_tree *tree,
					 u64 start, u64 len);
int btrfs_add_extent_mapping(struct btrfs_fs_info *fs_info,
			     struct extent_map_tree *em_tree,
			     struct extent_map **em_in, u64 start, u64 len);
void btrfs_drop_extent_map_range(struct btrfs_inode *inode,
				 u64 start, u64 end,
				 bool skip_pinned);
int btrfs_replace_extent_map_range(struct btrfs_inode *inode,
				   struct extent_map *new_em,
				   bool modified);

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
9888c340 DS	2
	3	#ifndef BTRFS_EXTENT_MAP_H
	4	#define BTRFS_EXTENT_MAP_H
a52d9a80 CM	5
a52d9a80 CM	6	#include <linux/rbtree.h>
490b54d6	7	#include <linux/refcount.h>
a52d9a80	8
e248e04e DG	9	#define EXTENT_MAP_LAST_BYTE ((u64)-4)
	10	#define EXTENT_MAP_HOLE ((u64)-3)
	11	#define EXTENT_MAP_INLINE ((u64)-2)
951e05a9	12	/* used only during fiemap calls */
e248e04e	13	#define EXTENT_MAP_DELALLOC ((u64)-1)
a52d9a80	14
50b5b602 DS	15	/* bits for the extent_map::flags field */
	16	enum {
	17	/* this entry not yet on disk, don't free it */
	18	EXTENT_FLAG_PINNED,
	19	EXTENT_FLAG_COMPRESSED,
	20	/* pre-allocated extent */
	21	EXTENT_FLAG_PREALLOC,
	22	/* Logging this extent */
	23	EXTENT_FLAG_LOGGING,
	24	/* Filling in a preallocated extent */
	25	EXTENT_FLAG_FILLING,
	26	/* filesystem extent mapping type */
	27	EXTENT_FLAG_FS_MAPPING,
199257a7 QW	28	/* This em is merged from two or more physically adjacent ems */
199257a7 QW	29	EXTENT_FLAG_MERGED,
50b5b602	30	};
7f3c74fb	31
a52d9a80	32	struct extent_map {
a52d9a80	33	struct rb_node rb_node;
d1310b2e CM	34
	35	/* all of these are in bytes */
	36	u64 start;
	37	u64 len;
4e2f84e6 LB	38	u64 mod_start;
4e2f84e6 LB	39	u64 mod_len;
ff5b7ee3	40	u64 orig_start;
b4939680	41	u64 orig_block_len;
cc95bef6	42	u64 ram_bytes;
a52d9a80	43	u64 block_start;
c8b97818	44	u64 block_len;
199257a7 QW	45
	46	/*
	47	* Generation of the extent map, for merged em it's the highest
	48	* generation of all merged ems.
	49	* For non-merged extents, it's from btrfs_file_extent_item::generation.
	50	*/
5dc562c5	51	u64 generation;
d1310b2e	52	unsigned long flags;
a019e9e1 DS	53	/* Used for chunk mappings, flag EXTENT_FLAG_FS_MAPPING must be set */
a019e9e1 DS	54	struct map_lookup *map_lookup;
490b54d6	55	refcount_t refs;
c08782da	56	unsigned int compress_type;
5dc562c5	57	struct list_head list;
a52d9a80 CM	58	};
a52d9a80 CM	59
d1310b2e	60	struct extent_map_tree {
07e1ce09	61	struct rb_root_cached map;
5dc562c5	62	struct list_head modified_extents;
890871be	63	rwlock_t lock;
a52d9a80 CM	64	};
a52d9a80 CM	65
4c0c8cfc FM	66	struct btrfs_inode;
4c0c8cfc FM	67
cbc0e928 FM	68	static inline int extent_map_in_tree(const struct extent_map *em)
	69	{
	70	return !RB_EMPTY_NODE(&em->rb_node);
	71	}
	72
d1310b2e CM	73	static inline u64 extent_map_end(struct extent_map *em)
	74	{
	75	if (em->start + em->len < em->start)
	76	return (u64)-1;
	77	return em->start + em->len;
	78	}
	79
	80	static inline u64 extent_map_block_end(struct extent_map *em)
	81	{
c8b97818	82	if (em->block_start + em->block_len < em->block_start)
d1310b2e	83	return (u64)-1;
c8b97818	84	return em->block_start + em->block_len;
d1310b2e	85	}
a52d9a80	86
a8067e02	87	void extent_map_tree_init(struct extent_map_tree *tree);
a52d9a80	88	struct extent_map lookup_extent_mapping(struct extent_map_tree tree,
d1310b2e	89	u64 start, u64 len);
a52d9a80	90	int add_extent_mapping(struct extent_map_tree *tree,
09a2a8f9	91	struct extent_map *em, int modified);
c1766dd7	92	void remove_extent_mapping(struct extent_map_tree tree, struct extent_map em);
176840b3 FM	93	void replace_extent_mapping(struct extent_map_tree *tree,
	94	struct extent_map *cur,
	95	struct extent_map *new,
	96	int modified);
d1310b2e	97
172ddd60	98	struct extent_map *alloc_extent_map(void);
a52d9a80	99	void free_extent_map(struct extent_map *em);
2f4cbe64	100	int __init extent_map_init(void);
e67c718b	101	void __cold extent_map_exit(void);
5dc562c5	102	int unpin_extent_cache(struct extent_map_tree *tree, u64 start, u64 len, u64 gen);
201a9038	103	void clear_em_logging(struct extent_map_tree tree, struct extent_map em);
b917b7c3 CM	104	struct extent_map search_extent_mapping(struct extent_map_tree tree,
b917b7c3 CM	105	u64 start, u64 len);
f46b24c9 DS	106	int btrfs_add_extent_mapping(struct btrfs_fs_info *fs_info,
f46b24c9 DS	107	struct extent_map_tree *em_tree,
c04e61b5	108	struct extent_map **em_in, u64 start, u64 len);
4c0c8cfc FM	109	void btrfs_drop_extent_map_range(struct btrfs_inode *inode,
	110	u64 start, u64 end,
	111	bool skip_pinned);
a1ba4c08 FM	112	int btrfs_replace_extent_map_range(struct btrfs_inode *inode,
	113	struct extent_map *new_em,
	114	bool modified);
9888c340	115
a52d9a80	116	#endif