xref: /openbmc/linux/fs/btrfs/extent_map.c (revision 5dc562c5)
1 #include <linux/err.h>
2 #include <linux/slab.h>
3 #include <linux/module.h>
4 #include <linux/spinlock.h>
5 #include <linux/hardirq.h>
6 #include "ctree.h"
7 #include "extent_map.h"
8 
9 
10 static struct kmem_cache *extent_map_cache;
11 
12 int __init extent_map_init(void)
13 {
14 	extent_map_cache = kmem_cache_create("extent_map",
15 			sizeof(struct extent_map), 0,
16 			SLAB_RECLAIM_ACCOUNT | SLAB_MEM_SPREAD, NULL);
17 	if (!extent_map_cache)
18 		return -ENOMEM;
19 	return 0;
20 }
21 
22 void extent_map_exit(void)
23 {
24 	if (extent_map_cache)
25 		kmem_cache_destroy(extent_map_cache);
26 }
27 
28 /**
29  * extent_map_tree_init - initialize extent map tree
30  * @tree:		tree to initialize
31  *
32  * Initialize the extent tree @tree.  Should be called for each new inode
33  * or other user of the extent_map interface.
34  */
35 void extent_map_tree_init(struct extent_map_tree *tree)
36 {
37 	tree->map = RB_ROOT;
38 	INIT_LIST_HEAD(&tree->modified_extents);
39 	rwlock_init(&tree->lock);
40 }
41 
42 /**
43  * alloc_extent_map - allocate new extent map structure
44  *
45  * Allocate a new extent_map structure.  The new structure is
46  * returned with a reference count of one and needs to be
47  * freed using free_extent_map()
48  */
49 struct extent_map *alloc_extent_map(void)
50 {
51 	struct extent_map *em;
52 	em = kmem_cache_alloc(extent_map_cache, GFP_NOFS);
53 	if (!em)
54 		return NULL;
55 	em->in_tree = 0;
56 	em->flags = 0;
57 	em->compress_type = BTRFS_COMPRESS_NONE;
58 	em->generation = 0;
59 	atomic_set(&em->refs, 1);
60 	INIT_LIST_HEAD(&em->list);
61 	return em;
62 }
63 
64 /**
65  * free_extent_map - drop reference count of an extent_map
66  * @em:		extent map beeing releasead
67  *
68  * Drops the reference out on @em by one and free the structure
69  * if the reference count hits zero.
70  */
71 void free_extent_map(struct extent_map *em)
72 {
73 	if (!em)
74 		return;
75 	WARN_ON(atomic_read(&em->refs) == 0);
76 	if (atomic_dec_and_test(&em->refs)) {
77 		WARN_ON(em->in_tree);
78 		WARN_ON(!list_empty(&em->list));
79 		kmem_cache_free(extent_map_cache, em);
80 	}
81 }
82 
83 static struct rb_node *tree_insert(struct rb_root *root, u64 offset,
84 				   struct rb_node *node)
85 {
86 	struct rb_node **p = &root->rb_node;
87 	struct rb_node *parent = NULL;
88 	struct extent_map *entry;
89 
90 	while (*p) {
91 		parent = *p;
92 		entry = rb_entry(parent, struct extent_map, rb_node);
93 
94 		WARN_ON(!entry->in_tree);
95 
96 		if (offset < entry->start)
97 			p = &(*p)->rb_left;
98 		else if (offset >= extent_map_end(entry))
99 			p = &(*p)->rb_right;
100 		else
101 			return parent;
102 	}
103 
104 	entry = rb_entry(node, struct extent_map, rb_node);
105 	entry->in_tree = 1;
106 	rb_link_node(node, parent, p);
107 	rb_insert_color(node, root);
108 	return NULL;
109 }
110 
111 /*
112  * search through the tree for an extent_map with a given offset.  If
113  * it can't be found, try to find some neighboring extents
114  */
115 static struct rb_node *__tree_search(struct rb_root *root, u64 offset,
116 				     struct rb_node **prev_ret,
117 				     struct rb_node **next_ret)
118 {
119 	struct rb_node *n = root->rb_node;
120 	struct rb_node *prev = NULL;
121 	struct rb_node *orig_prev = NULL;
122 	struct extent_map *entry;
123 	struct extent_map *prev_entry = NULL;
124 
125 	while (n) {
126 		entry = rb_entry(n, struct extent_map, rb_node);
127 		prev = n;
128 		prev_entry = entry;
129 
130 		WARN_ON(!entry->in_tree);
131 
132 		if (offset < entry->start)
133 			n = n->rb_left;
134 		else if (offset >= extent_map_end(entry))
135 			n = n->rb_right;
136 		else
137 			return n;
138 	}
139 
140 	if (prev_ret) {
141 		orig_prev = prev;
142 		while (prev && offset >= extent_map_end(prev_entry)) {
143 			prev = rb_next(prev);
144 			prev_entry = rb_entry(prev, struct extent_map, rb_node);
145 		}
146 		*prev_ret = prev;
147 		prev = orig_prev;
148 	}
149 
150 	if (next_ret) {
151 		prev_entry = rb_entry(prev, struct extent_map, rb_node);
152 		while (prev && offset < prev_entry->start) {
153 			prev = rb_prev(prev);
154 			prev_entry = rb_entry(prev, struct extent_map, rb_node);
155 		}
156 		*next_ret = prev;
157 	}
158 	return NULL;
159 }
160 
161 /* check to see if two extent_map structs are adjacent and safe to merge */
162 static int mergable_maps(struct extent_map *prev, struct extent_map *next)
163 {
164 	if (test_bit(EXTENT_FLAG_PINNED, &prev->flags))
165 		return 0;
166 
167 	/*
168 	 * don't merge compressed extents, we need to know their
169 	 * actual size
170 	 */
171 	if (test_bit(EXTENT_FLAG_COMPRESSED, &prev->flags))
172 		return 0;
173 
174 	if (extent_map_end(prev) == next->start &&
175 	    prev->flags == next->flags &&
176 	    prev->bdev == next->bdev &&
177 	    ((next->block_start == EXTENT_MAP_HOLE &&
178 	      prev->block_start == EXTENT_MAP_HOLE) ||
179 	     (next->block_start == EXTENT_MAP_INLINE &&
180 	      prev->block_start == EXTENT_MAP_INLINE) ||
181 	     (next->block_start == EXTENT_MAP_DELALLOC &&
182 	      prev->block_start == EXTENT_MAP_DELALLOC) ||
183 	     (next->block_start < EXTENT_MAP_LAST_BYTE - 1 &&
184 	      next->block_start == extent_map_block_end(prev)))) {
185 		return 1;
186 	}
187 	return 0;
188 }
189 
190 static void try_merge_map(struct extent_map_tree *tree, struct extent_map *em)
191 {
192 	struct extent_map *merge = NULL;
193 	struct rb_node *rb;
194 
195 	if (em->start != 0) {
196 		rb = rb_prev(&em->rb_node);
197 		if (rb)
198 			merge = rb_entry(rb, struct extent_map, rb_node);
199 		if (rb && mergable_maps(merge, em)) {
200 			em->start = merge->start;
201 			em->len += merge->len;
202 			em->block_len += merge->block_len;
203 			em->block_start = merge->block_start;
204 			merge->in_tree = 0;
205 			if (merge->generation > em->generation) {
206 				em->generation = merge->generation;
207 				list_move(&em->list, &tree->modified_extents);
208 			}
209 
210 			list_del_init(&merge->list);
211 			rb_erase(&merge->rb_node, &tree->map);
212 			free_extent_map(merge);
213 		}
214 	}
215 
216 	rb = rb_next(&em->rb_node);
217 	if (rb)
218 		merge = rb_entry(rb, struct extent_map, rb_node);
219 	if (rb && mergable_maps(em, merge)) {
220 		em->len += merge->len;
221 		em->block_len += merge->len;
222 		rb_erase(&merge->rb_node, &tree->map);
223 		merge->in_tree = 0;
224 		if (merge->generation > em->generation) {
225 			em->generation = merge->generation;
226 			list_move(&em->list, &tree->modified_extents);
227 		}
228 		list_del_init(&merge->list);
229 		free_extent_map(merge);
230 	}
231 }
232 
233 /**
234  * unpint_extent_cache - unpin an extent from the cache
235  * @tree:	tree to unpin the extent in
236  * @start:	logical offset in the file
237  * @len:	length of the extent
238  * @gen:	generation that this extent has been modified in
239  * @prealloc:	if this is set we need to clear the prealloc flag
240  *
241  * Called after an extent has been written to disk properly.  Set the generation
242  * to the generation that actually added the file item to the inode so we know
243  * we need to sync this extent when we call fsync().
244  */
245 int unpin_extent_cache(struct extent_map_tree *tree, u64 start, u64 len,
246 		       u64 gen)
247 {
248 	int ret = 0;
249 	struct extent_map *em;
250 
251 	write_lock(&tree->lock);
252 	em = lookup_extent_mapping(tree, start, len);
253 
254 	WARN_ON(!em || em->start != start);
255 
256 	if (!em)
257 		goto out;
258 
259 	list_move(&em->list, &tree->modified_extents);
260 	em->generation = gen;
261 	clear_bit(EXTENT_FLAG_PINNED, &em->flags);
262 
263 	try_merge_map(tree, em);
264 	free_extent_map(em);
265 out:
266 	write_unlock(&tree->lock);
267 	return ret;
268 
269 }
270 
271 /**
272  * add_extent_mapping - add new extent map to the extent tree
273  * @tree:	tree to insert new map in
274  * @em:		map to insert
275  *
276  * Insert @em into @tree or perform a simple forward/backward merge with
277  * existing mappings.  The extent_map struct passed in will be inserted
278  * into the tree directly, with an additional reference taken, or a
279  * reference dropped if the merge attempt was successful.
280  */
281 int add_extent_mapping(struct extent_map_tree *tree,
282 		       struct extent_map *em)
283 {
284 	int ret = 0;
285 	struct rb_node *rb;
286 	struct extent_map *exist;
287 
288 	exist = lookup_extent_mapping(tree, em->start, em->len);
289 	if (exist) {
290 		free_extent_map(exist);
291 		ret = -EEXIST;
292 		goto out;
293 	}
294 	rb = tree_insert(&tree->map, em->start, &em->rb_node);
295 	if (rb) {
296 		ret = -EEXIST;
297 		goto out;
298 	}
299 	atomic_inc(&em->refs);
300 
301 	try_merge_map(tree, em);
302 out:
303 	return ret;
304 }
305 
306 /* simple helper to do math around the end of an extent, handling wrap */
307 static u64 range_end(u64 start, u64 len)
308 {
309 	if (start + len < start)
310 		return (u64)-1;
311 	return start + len;
312 }
313 
314 struct extent_map *__lookup_extent_mapping(struct extent_map_tree *tree,
315 					   u64 start, u64 len, int strict)
316 {
317 	struct extent_map *em;
318 	struct rb_node *rb_node;
319 	struct rb_node *prev = NULL;
320 	struct rb_node *next = NULL;
321 	u64 end = range_end(start, len);
322 
323 	rb_node = __tree_search(&tree->map, start, &prev, &next);
324 	if (!rb_node) {
325 		if (prev)
326 			rb_node = prev;
327 		else if (next)
328 			rb_node = next;
329 		else
330 			return NULL;
331 	}
332 
333 	em = rb_entry(rb_node, struct extent_map, rb_node);
334 
335 	if (strict && !(end > em->start && start < extent_map_end(em)))
336 		return NULL;
337 
338 	atomic_inc(&em->refs);
339 	return em;
340 }
341 
342 /**
343  * lookup_extent_mapping - lookup extent_map
344  * @tree:	tree to lookup in
345  * @start:	byte offset to start the search
346  * @len:	length of the lookup range
347  *
348  * Find and return the first extent_map struct in @tree that intersects the
349  * [start, len] range.  There may be additional objects in the tree that
350  * intersect, so check the object returned carefully to make sure that no
351  * additional lookups are needed.
352  */
353 struct extent_map *lookup_extent_mapping(struct extent_map_tree *tree,
354 					 u64 start, u64 len)
355 {
356 	return __lookup_extent_mapping(tree, start, len, 1);
357 }
358 
359 /**
360  * search_extent_mapping - find a nearby extent map
361  * @tree:	tree to lookup in
362  * @start:	byte offset to start the search
363  * @len:	length of the lookup range
364  *
365  * Find and return the first extent_map struct in @tree that intersects the
366  * [start, len] range.
367  *
368  * If one can't be found, any nearby extent may be returned
369  */
370 struct extent_map *search_extent_mapping(struct extent_map_tree *tree,
371 					 u64 start, u64 len)
372 {
373 	return __lookup_extent_mapping(tree, start, len, 0);
374 }
375 
376 /**
377  * remove_extent_mapping - removes an extent_map from the extent tree
378  * @tree:	extent tree to remove from
379  * @em:		extent map beeing removed
380  *
381  * Removes @em from @tree.  No reference counts are dropped, and no checks
382  * are done to see if the range is in use
383  */
384 int remove_extent_mapping(struct extent_map_tree *tree, struct extent_map *em)
385 {
386 	int ret = 0;
387 
388 	WARN_ON(test_bit(EXTENT_FLAG_PINNED, &em->flags));
389 	rb_erase(&em->rb_node, &tree->map);
390 	list_del_init(&em->list);
391 	em->in_tree = 0;
392 	return ret;
393 }
394