1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2008 Red Hat. All rights reserved.
6 #include <linux/pagemap.h>
7 #include <linux/sched.h>
8 #include <linux/sched/signal.h>
9 #include <linux/slab.h>
10 #include <linux/math64.h>
11 #include <linux/ratelimit.h>
12 #include <linux/error-injection.h>
13 #include <linux/sched/mm.h>
16 #include "free-space-cache.h"
17 #include "transaction.h"
19 #include "extent_io.h"
21 #include "space-info.h"
22 #include "delalloc-space.h"
23 #include "block-group.h"
26 #define BITS_PER_BITMAP (PAGE_SIZE * 8UL)
27 #define MAX_CACHE_BYTES_PER_GIG SZ_64K
28 #define FORCE_EXTENT_THRESHOLD SZ_1M
30 struct btrfs_trim_range {
33 struct list_head list;
36 static int link_free_space(struct btrfs_free_space_ctl *ctl,
37 struct btrfs_free_space *info);
38 static void unlink_free_space(struct btrfs_free_space_ctl *ctl,
39 struct btrfs_free_space *info);
40 static int search_bitmap(struct btrfs_free_space_ctl *ctl,
41 struct btrfs_free_space *bitmap_info, u64 *offset,
42 u64 *bytes, bool for_alloc);
43 static void free_bitmap(struct btrfs_free_space_ctl *ctl,
44 struct btrfs_free_space *bitmap_info);
45 static void bitmap_clear_bits(struct btrfs_free_space_ctl *ctl,
46 struct btrfs_free_space *info, u64 offset,
49 static struct inode *__lookup_free_space_inode(struct btrfs_root *root,
50 struct btrfs_path *path,
53 struct btrfs_fs_info *fs_info = root->fs_info;
55 struct btrfs_key location;
56 struct btrfs_disk_key disk_key;
57 struct btrfs_free_space_header *header;
58 struct extent_buffer *leaf;
59 struct inode *inode = NULL;
63 key.objectid = BTRFS_FREE_SPACE_OBJECTID;
67 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
71 btrfs_release_path(path);
72 return ERR_PTR(-ENOENT);
75 leaf = path->nodes[0];
76 header = btrfs_item_ptr(leaf, path->slots[0],
77 struct btrfs_free_space_header);
78 btrfs_free_space_key(leaf, header, &disk_key);
79 btrfs_disk_key_to_cpu(&location, &disk_key);
80 btrfs_release_path(path);
83 * We are often under a trans handle at this point, so we need to make
84 * sure NOFS is set to keep us from deadlocking.
86 nofs_flag = memalloc_nofs_save();
87 inode = btrfs_iget_path(fs_info->sb, location.objectid, root, path);
88 btrfs_release_path(path);
89 memalloc_nofs_restore(nofs_flag);
93 mapping_set_gfp_mask(inode->i_mapping,
94 mapping_gfp_constraint(inode->i_mapping,
95 ~(__GFP_FS | __GFP_HIGHMEM)));
100 struct inode *lookup_free_space_inode(struct btrfs_block_group *block_group,
101 struct btrfs_path *path)
103 struct btrfs_fs_info *fs_info = block_group->fs_info;
104 struct inode *inode = NULL;
105 u32 flags = BTRFS_INODE_NODATASUM | BTRFS_INODE_NODATACOW;
107 spin_lock(&block_group->lock);
108 if (block_group->inode)
109 inode = igrab(block_group->inode);
110 spin_unlock(&block_group->lock);
114 inode = __lookup_free_space_inode(fs_info->tree_root, path,
119 spin_lock(&block_group->lock);
120 if (!((BTRFS_I(inode)->flags & flags) == flags)) {
121 btrfs_info(fs_info, "Old style space inode found, converting.");
122 BTRFS_I(inode)->flags |= BTRFS_INODE_NODATASUM |
123 BTRFS_INODE_NODATACOW;
124 block_group->disk_cache_state = BTRFS_DC_CLEAR;
127 if (!block_group->iref) {
128 block_group->inode = igrab(inode);
129 block_group->iref = 1;
131 spin_unlock(&block_group->lock);
136 static int __create_free_space_inode(struct btrfs_root *root,
137 struct btrfs_trans_handle *trans,
138 struct btrfs_path *path,
141 struct btrfs_key key;
142 struct btrfs_disk_key disk_key;
143 struct btrfs_free_space_header *header;
144 struct btrfs_inode_item *inode_item;
145 struct extent_buffer *leaf;
146 /* We inline CRCs for the free disk space cache */
147 const u64 flags = BTRFS_INODE_NOCOMPRESS | BTRFS_INODE_PREALLOC |
148 BTRFS_INODE_NODATASUM | BTRFS_INODE_NODATACOW;
151 ret = btrfs_insert_empty_inode(trans, root, path, ino);
155 leaf = path->nodes[0];
156 inode_item = btrfs_item_ptr(leaf, path->slots[0],
157 struct btrfs_inode_item);
158 btrfs_item_key(leaf, &disk_key, path->slots[0]);
159 memzero_extent_buffer(leaf, (unsigned long)inode_item,
160 sizeof(*inode_item));
161 btrfs_set_inode_generation(leaf, inode_item, trans->transid);
162 btrfs_set_inode_size(leaf, inode_item, 0);
163 btrfs_set_inode_nbytes(leaf, inode_item, 0);
164 btrfs_set_inode_uid(leaf, inode_item, 0);
165 btrfs_set_inode_gid(leaf, inode_item, 0);
166 btrfs_set_inode_mode(leaf, inode_item, S_IFREG | 0600);
167 btrfs_set_inode_flags(leaf, inode_item, flags);
168 btrfs_set_inode_nlink(leaf, inode_item, 1);
169 btrfs_set_inode_transid(leaf, inode_item, trans->transid);
170 btrfs_set_inode_block_group(leaf, inode_item, offset);
171 btrfs_mark_buffer_dirty(leaf);
172 btrfs_release_path(path);
174 key.objectid = BTRFS_FREE_SPACE_OBJECTID;
177 ret = btrfs_insert_empty_item(trans, root, path, &key,
178 sizeof(struct btrfs_free_space_header));
180 btrfs_release_path(path);
184 leaf = path->nodes[0];
185 header = btrfs_item_ptr(leaf, path->slots[0],
186 struct btrfs_free_space_header);
187 memzero_extent_buffer(leaf, (unsigned long)header, sizeof(*header));
188 btrfs_set_free_space_key(leaf, header, &disk_key);
189 btrfs_mark_buffer_dirty(leaf);
190 btrfs_release_path(path);
195 int create_free_space_inode(struct btrfs_trans_handle *trans,
196 struct btrfs_block_group *block_group,
197 struct btrfs_path *path)
202 ret = btrfs_get_free_objectid(trans->fs_info->tree_root, &ino);
206 return __create_free_space_inode(trans->fs_info->tree_root, trans, path,
207 ino, block_group->start);
211 * inode is an optional sink: if it is NULL, btrfs_remove_free_space_inode
212 * handles lookup, otherwise it takes ownership and iputs the inode.
213 * Don't reuse an inode pointer after passing it into this function.
215 int btrfs_remove_free_space_inode(struct btrfs_trans_handle *trans,
217 struct btrfs_block_group *block_group)
219 struct btrfs_path *path;
220 struct btrfs_key key;
223 path = btrfs_alloc_path();
228 inode = lookup_free_space_inode(block_group, path);
230 if (PTR_ERR(inode) != -ENOENT)
231 ret = PTR_ERR(inode);
234 ret = btrfs_orphan_add(trans, BTRFS_I(inode));
236 btrfs_add_delayed_iput(inode);
240 /* One for the block groups ref */
241 spin_lock(&block_group->lock);
242 if (block_group->iref) {
243 block_group->iref = 0;
244 block_group->inode = NULL;
245 spin_unlock(&block_group->lock);
248 spin_unlock(&block_group->lock);
250 /* One for the lookup ref */
251 btrfs_add_delayed_iput(inode);
253 key.objectid = BTRFS_FREE_SPACE_OBJECTID;
255 key.offset = block_group->start;
256 ret = btrfs_search_slot(trans, trans->fs_info->tree_root, &key, path,
263 ret = btrfs_del_item(trans, trans->fs_info->tree_root, path);
265 btrfs_free_path(path);
269 int btrfs_check_trunc_cache_free_space(struct btrfs_fs_info *fs_info,
270 struct btrfs_block_rsv *rsv)
275 /* 1 for slack space, 1 for updating the inode */
276 needed_bytes = btrfs_calc_insert_metadata_size(fs_info, 1) +
277 btrfs_calc_metadata_size(fs_info, 1);
279 spin_lock(&rsv->lock);
280 if (rsv->reserved < needed_bytes)
284 spin_unlock(&rsv->lock);
288 int btrfs_truncate_free_space_cache(struct btrfs_trans_handle *trans,
289 struct btrfs_block_group *block_group,
292 struct btrfs_root *root = BTRFS_I(inode)->root;
297 struct btrfs_path *path = btrfs_alloc_path();
304 mutex_lock(&trans->transaction->cache_write_mutex);
305 if (!list_empty(&block_group->io_list)) {
306 list_del_init(&block_group->io_list);
308 btrfs_wait_cache_io(trans, block_group, path);
309 btrfs_put_block_group(block_group);
313 * now that we've truncated the cache away, its no longer
316 spin_lock(&block_group->lock);
317 block_group->disk_cache_state = BTRFS_DC_CLEAR;
318 spin_unlock(&block_group->lock);
319 btrfs_free_path(path);
322 btrfs_i_size_write(BTRFS_I(inode), 0);
323 truncate_pagecache(inode, 0);
326 * We skip the throttling logic for free space cache inodes, so we don't
327 * need to check for -EAGAIN.
329 ret = btrfs_truncate_inode_items(trans, root, BTRFS_I(inode),
330 0, BTRFS_EXTENT_DATA_KEY, NULL);
334 ret = btrfs_update_inode(trans, root, BTRFS_I(inode));
338 mutex_unlock(&trans->transaction->cache_write_mutex);
340 btrfs_abort_transaction(trans, ret);
345 static void readahead_cache(struct inode *inode)
347 struct file_ra_state ra;
348 unsigned long last_index;
350 file_ra_state_init(&ra, inode->i_mapping);
351 last_index = (i_size_read(inode) - 1) >> PAGE_SHIFT;
353 page_cache_sync_readahead(inode->i_mapping, &ra, NULL, 0, last_index);
356 static int io_ctl_init(struct btrfs_io_ctl *io_ctl, struct inode *inode,
361 num_pages = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
363 /* Make sure we can fit our crcs and generation into the first page */
364 if (write && (num_pages * sizeof(u32) + sizeof(u64)) > PAGE_SIZE)
367 memset(io_ctl, 0, sizeof(struct btrfs_io_ctl));
369 io_ctl->pages = kcalloc(num_pages, sizeof(struct page *), GFP_NOFS);
373 io_ctl->num_pages = num_pages;
374 io_ctl->fs_info = btrfs_sb(inode->i_sb);
375 io_ctl->inode = inode;
379 ALLOW_ERROR_INJECTION(io_ctl_init, ERRNO);
381 static void io_ctl_free(struct btrfs_io_ctl *io_ctl)
383 kfree(io_ctl->pages);
384 io_ctl->pages = NULL;
387 static void io_ctl_unmap_page(struct btrfs_io_ctl *io_ctl)
395 static void io_ctl_map_page(struct btrfs_io_ctl *io_ctl, int clear)
397 ASSERT(io_ctl->index < io_ctl->num_pages);
398 io_ctl->page = io_ctl->pages[io_ctl->index++];
399 io_ctl->cur = page_address(io_ctl->page);
400 io_ctl->orig = io_ctl->cur;
401 io_ctl->size = PAGE_SIZE;
403 clear_page(io_ctl->cur);
406 static void io_ctl_drop_pages(struct btrfs_io_ctl *io_ctl)
410 io_ctl_unmap_page(io_ctl);
412 for (i = 0; i < io_ctl->num_pages; i++) {
413 if (io_ctl->pages[i]) {
414 ClearPageChecked(io_ctl->pages[i]);
415 unlock_page(io_ctl->pages[i]);
416 put_page(io_ctl->pages[i]);
421 static int io_ctl_prepare_pages(struct btrfs_io_ctl *io_ctl, bool uptodate)
424 struct inode *inode = io_ctl->inode;
425 gfp_t mask = btrfs_alloc_write_mask(inode->i_mapping);
428 for (i = 0; i < io_ctl->num_pages; i++) {
431 page = find_or_create_page(inode->i_mapping, i, mask);
433 io_ctl_drop_pages(io_ctl);
437 ret = set_page_extent_mapped(page);
441 io_ctl_drop_pages(io_ctl);
445 io_ctl->pages[i] = page;
446 if (uptodate && !PageUptodate(page)) {
447 btrfs_readpage(NULL, page);
449 if (page->mapping != inode->i_mapping) {
450 btrfs_err(BTRFS_I(inode)->root->fs_info,
451 "free space cache page truncated");
452 io_ctl_drop_pages(io_ctl);
455 if (!PageUptodate(page)) {
456 btrfs_err(BTRFS_I(inode)->root->fs_info,
457 "error reading free space cache");
458 io_ctl_drop_pages(io_ctl);
464 for (i = 0; i < io_ctl->num_pages; i++)
465 clear_page_dirty_for_io(io_ctl->pages[i]);
470 static void io_ctl_set_generation(struct btrfs_io_ctl *io_ctl, u64 generation)
472 io_ctl_map_page(io_ctl, 1);
475 * Skip the csum areas. If we don't check crcs then we just have a
476 * 64bit chunk at the front of the first page.
478 io_ctl->cur += (sizeof(u32) * io_ctl->num_pages);
479 io_ctl->size -= sizeof(u64) + (sizeof(u32) * io_ctl->num_pages);
481 put_unaligned_le64(generation, io_ctl->cur);
482 io_ctl->cur += sizeof(u64);
485 static int io_ctl_check_generation(struct btrfs_io_ctl *io_ctl, u64 generation)
490 * Skip the crc area. If we don't check crcs then we just have a 64bit
491 * chunk at the front of the first page.
493 io_ctl->cur += sizeof(u32) * io_ctl->num_pages;
494 io_ctl->size -= sizeof(u64) + (sizeof(u32) * io_ctl->num_pages);
496 cache_gen = get_unaligned_le64(io_ctl->cur);
497 if (cache_gen != generation) {
498 btrfs_err_rl(io_ctl->fs_info,
499 "space cache generation (%llu) does not match inode (%llu)",
500 cache_gen, generation);
501 io_ctl_unmap_page(io_ctl);
504 io_ctl->cur += sizeof(u64);
508 static void io_ctl_set_crc(struct btrfs_io_ctl *io_ctl, int index)
515 offset = sizeof(u32) * io_ctl->num_pages;
517 crc = btrfs_crc32c(crc, io_ctl->orig + offset, PAGE_SIZE - offset);
518 btrfs_crc32c_final(crc, (u8 *)&crc);
519 io_ctl_unmap_page(io_ctl);
520 tmp = page_address(io_ctl->pages[0]);
525 static int io_ctl_check_crc(struct btrfs_io_ctl *io_ctl, int index)
532 offset = sizeof(u32) * io_ctl->num_pages;
534 tmp = page_address(io_ctl->pages[0]);
538 io_ctl_map_page(io_ctl, 0);
539 crc = btrfs_crc32c(crc, io_ctl->orig + offset, PAGE_SIZE - offset);
540 btrfs_crc32c_final(crc, (u8 *)&crc);
542 btrfs_err_rl(io_ctl->fs_info,
543 "csum mismatch on free space cache");
544 io_ctl_unmap_page(io_ctl);
551 static int io_ctl_add_entry(struct btrfs_io_ctl *io_ctl, u64 offset, u64 bytes,
554 struct btrfs_free_space_entry *entry;
560 put_unaligned_le64(offset, &entry->offset);
561 put_unaligned_le64(bytes, &entry->bytes);
562 entry->type = (bitmap) ? BTRFS_FREE_SPACE_BITMAP :
563 BTRFS_FREE_SPACE_EXTENT;
564 io_ctl->cur += sizeof(struct btrfs_free_space_entry);
565 io_ctl->size -= sizeof(struct btrfs_free_space_entry);
567 if (io_ctl->size >= sizeof(struct btrfs_free_space_entry))
570 io_ctl_set_crc(io_ctl, io_ctl->index - 1);
572 /* No more pages to map */
573 if (io_ctl->index >= io_ctl->num_pages)
576 /* map the next page */
577 io_ctl_map_page(io_ctl, 1);
581 static int io_ctl_add_bitmap(struct btrfs_io_ctl *io_ctl, void *bitmap)
587 * If we aren't at the start of the current page, unmap this one and
588 * map the next one if there is any left.
590 if (io_ctl->cur != io_ctl->orig) {
591 io_ctl_set_crc(io_ctl, io_ctl->index - 1);
592 if (io_ctl->index >= io_ctl->num_pages)
594 io_ctl_map_page(io_ctl, 0);
597 copy_page(io_ctl->cur, bitmap);
598 io_ctl_set_crc(io_ctl, io_ctl->index - 1);
599 if (io_ctl->index < io_ctl->num_pages)
600 io_ctl_map_page(io_ctl, 0);
604 static void io_ctl_zero_remaining_pages(struct btrfs_io_ctl *io_ctl)
607 * If we're not on the boundary we know we've modified the page and we
608 * need to crc the page.
610 if (io_ctl->cur != io_ctl->orig)
611 io_ctl_set_crc(io_ctl, io_ctl->index - 1);
613 io_ctl_unmap_page(io_ctl);
615 while (io_ctl->index < io_ctl->num_pages) {
616 io_ctl_map_page(io_ctl, 1);
617 io_ctl_set_crc(io_ctl, io_ctl->index - 1);
621 static int io_ctl_read_entry(struct btrfs_io_ctl *io_ctl,
622 struct btrfs_free_space *entry, u8 *type)
624 struct btrfs_free_space_entry *e;
628 ret = io_ctl_check_crc(io_ctl, io_ctl->index);
634 entry->offset = get_unaligned_le64(&e->offset);
635 entry->bytes = get_unaligned_le64(&e->bytes);
637 io_ctl->cur += sizeof(struct btrfs_free_space_entry);
638 io_ctl->size -= sizeof(struct btrfs_free_space_entry);
640 if (io_ctl->size >= sizeof(struct btrfs_free_space_entry))
643 io_ctl_unmap_page(io_ctl);
648 static int io_ctl_read_bitmap(struct btrfs_io_ctl *io_ctl,
649 struct btrfs_free_space *entry)
653 ret = io_ctl_check_crc(io_ctl, io_ctl->index);
657 copy_page(entry->bitmap, io_ctl->cur);
658 io_ctl_unmap_page(io_ctl);
663 static void recalculate_thresholds(struct btrfs_free_space_ctl *ctl)
665 struct btrfs_block_group *block_group = ctl->private;
669 u64 size = block_group->length;
670 u64 bytes_per_bg = BITS_PER_BITMAP * ctl->unit;
671 u64 max_bitmaps = div64_u64(size + bytes_per_bg - 1, bytes_per_bg);
673 max_bitmaps = max_t(u64, max_bitmaps, 1);
675 ASSERT(ctl->total_bitmaps <= max_bitmaps);
678 * We are trying to keep the total amount of memory used per 1GiB of
679 * space to be MAX_CACHE_BYTES_PER_GIG. However, with a reclamation
680 * mechanism of pulling extents >= FORCE_EXTENT_THRESHOLD out of
681 * bitmaps, we may end up using more memory than this.
684 max_bytes = MAX_CACHE_BYTES_PER_GIG;
686 max_bytes = MAX_CACHE_BYTES_PER_GIG * div_u64(size, SZ_1G);
688 bitmap_bytes = ctl->total_bitmaps * ctl->unit;
691 * we want the extent entry threshold to always be at most 1/2 the max
692 * bytes we can have, or whatever is less than that.
694 extent_bytes = max_bytes - bitmap_bytes;
695 extent_bytes = min_t(u64, extent_bytes, max_bytes >> 1);
697 ctl->extents_thresh =
698 div_u64(extent_bytes, sizeof(struct btrfs_free_space));
701 static int __load_free_space_cache(struct btrfs_root *root, struct inode *inode,
702 struct btrfs_free_space_ctl *ctl,
703 struct btrfs_path *path, u64 offset)
705 struct btrfs_fs_info *fs_info = root->fs_info;
706 struct btrfs_free_space_header *header;
707 struct extent_buffer *leaf;
708 struct btrfs_io_ctl io_ctl;
709 struct btrfs_key key;
710 struct btrfs_free_space *e, *n;
718 /* Nothing in the space cache, goodbye */
719 if (!i_size_read(inode))
722 key.objectid = BTRFS_FREE_SPACE_OBJECTID;
726 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
730 btrfs_release_path(path);
736 leaf = path->nodes[0];
737 header = btrfs_item_ptr(leaf, path->slots[0],
738 struct btrfs_free_space_header);
739 num_entries = btrfs_free_space_entries(leaf, header);
740 num_bitmaps = btrfs_free_space_bitmaps(leaf, header);
741 generation = btrfs_free_space_generation(leaf, header);
742 btrfs_release_path(path);
744 if (!BTRFS_I(inode)->generation) {
746 "the free space cache file (%llu) is invalid, skip it",
751 if (BTRFS_I(inode)->generation != generation) {
753 "free space inode generation (%llu) did not match free space cache generation (%llu)",
754 BTRFS_I(inode)->generation, generation);
761 ret = io_ctl_init(&io_ctl, inode, 0);
765 readahead_cache(inode);
767 ret = io_ctl_prepare_pages(&io_ctl, true);
771 ret = io_ctl_check_crc(&io_ctl, 0);
775 ret = io_ctl_check_generation(&io_ctl, generation);
779 while (num_entries) {
780 e = kmem_cache_zalloc(btrfs_free_space_cachep,
787 ret = io_ctl_read_entry(&io_ctl, e, &type);
789 kmem_cache_free(btrfs_free_space_cachep, e);
795 kmem_cache_free(btrfs_free_space_cachep, e);
799 if (type == BTRFS_FREE_SPACE_EXTENT) {
800 spin_lock(&ctl->tree_lock);
801 ret = link_free_space(ctl, e);
802 spin_unlock(&ctl->tree_lock);
805 "Duplicate entries in free space cache, dumping");
806 kmem_cache_free(btrfs_free_space_cachep, e);
812 e->bitmap = kmem_cache_zalloc(
813 btrfs_free_space_bitmap_cachep, GFP_NOFS);
817 btrfs_free_space_cachep, e);
820 spin_lock(&ctl->tree_lock);
821 ret = link_free_space(ctl, e);
822 ctl->total_bitmaps++;
823 recalculate_thresholds(ctl);
824 spin_unlock(&ctl->tree_lock);
827 "Duplicate entries in free space cache, dumping");
828 kmem_cache_free(btrfs_free_space_cachep, e);
831 list_add_tail(&e->list, &bitmaps);
837 io_ctl_unmap_page(&io_ctl);
840 * We add the bitmaps at the end of the entries in order that
841 * the bitmap entries are added to the cache.
843 list_for_each_entry_safe(e, n, &bitmaps, list) {
844 list_del_init(&e->list);
845 ret = io_ctl_read_bitmap(&io_ctl, e);
850 io_ctl_drop_pages(&io_ctl);
853 io_ctl_free(&io_ctl);
856 io_ctl_drop_pages(&io_ctl);
857 __btrfs_remove_free_space_cache(ctl);
861 static int copy_free_space_cache(struct btrfs_block_group *block_group,
862 struct btrfs_free_space_ctl *ctl)
864 struct btrfs_free_space *info;
868 while (!ret && (n = rb_first(&ctl->free_space_offset)) != NULL) {
869 info = rb_entry(n, struct btrfs_free_space, offset_index);
871 unlink_free_space(ctl, info);
872 ret = btrfs_add_free_space(block_group, info->offset,
874 kmem_cache_free(btrfs_free_space_cachep, info);
876 u64 offset = info->offset;
877 u64 bytes = ctl->unit;
879 while (search_bitmap(ctl, info, &offset, &bytes,
881 ret = btrfs_add_free_space(block_group, offset,
885 bitmap_clear_bits(ctl, info, offset, bytes);
886 offset = info->offset;
889 free_bitmap(ctl, info);
896 int load_free_space_cache(struct btrfs_block_group *block_group)
898 struct btrfs_fs_info *fs_info = block_group->fs_info;
899 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
900 struct btrfs_free_space_ctl tmp_ctl = {};
902 struct btrfs_path *path;
905 u64 used = block_group->used;
908 * Because we could potentially discard our loaded free space, we want
909 * to load everything into a temporary structure first, and then if it's
910 * valid copy it all into the actual free space ctl.
912 btrfs_init_free_space_ctl(block_group, &tmp_ctl);
915 * If this block group has been marked to be cleared for one reason or
916 * another then we can't trust the on disk cache, so just return.
918 spin_lock(&block_group->lock);
919 if (block_group->disk_cache_state != BTRFS_DC_WRITTEN) {
920 spin_unlock(&block_group->lock);
923 spin_unlock(&block_group->lock);
925 path = btrfs_alloc_path();
928 path->search_commit_root = 1;
929 path->skip_locking = 1;
932 * We must pass a path with search_commit_root set to btrfs_iget in
933 * order to avoid a deadlock when allocating extents for the tree root.
935 * When we are COWing an extent buffer from the tree root, when looking
936 * for a free extent, at extent-tree.c:find_free_extent(), we can find
937 * block group without its free space cache loaded. When we find one
938 * we must load its space cache which requires reading its free space
939 * cache's inode item from the root tree. If this inode item is located
940 * in the same leaf that we started COWing before, then we end up in
941 * deadlock on the extent buffer (trying to read lock it when we
942 * previously write locked it).
944 * It's safe to read the inode item using the commit root because
945 * block groups, once loaded, stay in memory forever (until they are
946 * removed) as well as their space caches once loaded. New block groups
947 * once created get their ->cached field set to BTRFS_CACHE_FINISHED so
948 * we will never try to read their inode item while the fs is mounted.
950 inode = lookup_free_space_inode(block_group, path);
952 btrfs_free_path(path);
956 /* We may have converted the inode and made the cache invalid. */
957 spin_lock(&block_group->lock);
958 if (block_group->disk_cache_state != BTRFS_DC_WRITTEN) {
959 spin_unlock(&block_group->lock);
960 btrfs_free_path(path);
963 spin_unlock(&block_group->lock);
965 ret = __load_free_space_cache(fs_info->tree_root, inode, &tmp_ctl,
966 path, block_group->start);
967 btrfs_free_path(path);
971 matched = (tmp_ctl.free_space == (block_group->length - used -
972 block_group->bytes_super));
975 ret = copy_free_space_cache(block_group, &tmp_ctl);
977 * ret == 1 means we successfully loaded the free space cache,
978 * so we need to re-set it here.
983 __btrfs_remove_free_space_cache(&tmp_ctl);
985 "block group %llu has wrong amount of free space",
991 /* This cache is bogus, make sure it gets cleared */
992 spin_lock(&block_group->lock);
993 block_group->disk_cache_state = BTRFS_DC_CLEAR;
994 spin_unlock(&block_group->lock);
998 "failed to load free space cache for block group %llu, rebuilding it now",
1002 spin_lock(&ctl->tree_lock);
1003 btrfs_discard_update_discardable(block_group);
1004 spin_unlock(&ctl->tree_lock);
1009 static noinline_for_stack
1010 int write_cache_extent_entries(struct btrfs_io_ctl *io_ctl,
1011 struct btrfs_free_space_ctl *ctl,
1012 struct btrfs_block_group *block_group,
1013 int *entries, int *bitmaps,
1014 struct list_head *bitmap_list)
1017 struct btrfs_free_cluster *cluster = NULL;
1018 struct btrfs_free_cluster *cluster_locked = NULL;
1019 struct rb_node *node = rb_first(&ctl->free_space_offset);
1020 struct btrfs_trim_range *trim_entry;
1022 /* Get the cluster for this block_group if it exists */
1023 if (block_group && !list_empty(&block_group->cluster_list)) {
1024 cluster = list_entry(block_group->cluster_list.next,
1025 struct btrfs_free_cluster,
1029 if (!node && cluster) {
1030 cluster_locked = cluster;
1031 spin_lock(&cluster_locked->lock);
1032 node = rb_first(&cluster->root);
1036 /* Write out the extent entries */
1038 struct btrfs_free_space *e;
1040 e = rb_entry(node, struct btrfs_free_space, offset_index);
1043 ret = io_ctl_add_entry(io_ctl, e->offset, e->bytes,
1049 list_add_tail(&e->list, bitmap_list);
1052 node = rb_next(node);
1053 if (!node && cluster) {
1054 node = rb_first(&cluster->root);
1055 cluster_locked = cluster;
1056 spin_lock(&cluster_locked->lock);
1060 if (cluster_locked) {
1061 spin_unlock(&cluster_locked->lock);
1062 cluster_locked = NULL;
1066 * Make sure we don't miss any range that was removed from our rbtree
1067 * because trimming is running. Otherwise after a umount+mount (or crash
1068 * after committing the transaction) we would leak free space and get
1069 * an inconsistent free space cache report from fsck.
1071 list_for_each_entry(trim_entry, &ctl->trimming_ranges, list) {
1072 ret = io_ctl_add_entry(io_ctl, trim_entry->start,
1073 trim_entry->bytes, NULL);
1082 spin_unlock(&cluster_locked->lock);
1086 static noinline_for_stack int
1087 update_cache_item(struct btrfs_trans_handle *trans,
1088 struct btrfs_root *root,
1089 struct inode *inode,
1090 struct btrfs_path *path, u64 offset,
1091 int entries, int bitmaps)
1093 struct btrfs_key key;
1094 struct btrfs_free_space_header *header;
1095 struct extent_buffer *leaf;
1098 key.objectid = BTRFS_FREE_SPACE_OBJECTID;
1099 key.offset = offset;
1102 ret = btrfs_search_slot(trans, root, &key, path, 0, 1);
1104 clear_extent_bit(&BTRFS_I(inode)->io_tree, 0, inode->i_size - 1,
1105 EXTENT_DELALLOC, 0, 0, NULL);
1108 leaf = path->nodes[0];
1110 struct btrfs_key found_key;
1111 ASSERT(path->slots[0]);
1113 btrfs_item_key_to_cpu(leaf, &found_key, path->slots[0]);
1114 if (found_key.objectid != BTRFS_FREE_SPACE_OBJECTID ||
1115 found_key.offset != offset) {
1116 clear_extent_bit(&BTRFS_I(inode)->io_tree, 0,
1117 inode->i_size - 1, EXTENT_DELALLOC, 0,
1119 btrfs_release_path(path);
1124 BTRFS_I(inode)->generation = trans->transid;
1125 header = btrfs_item_ptr(leaf, path->slots[0],
1126 struct btrfs_free_space_header);
1127 btrfs_set_free_space_entries(leaf, header, entries);
1128 btrfs_set_free_space_bitmaps(leaf, header, bitmaps);
1129 btrfs_set_free_space_generation(leaf, header, trans->transid);
1130 btrfs_mark_buffer_dirty(leaf);
1131 btrfs_release_path(path);
1139 static noinline_for_stack int write_pinned_extent_entries(
1140 struct btrfs_trans_handle *trans,
1141 struct btrfs_block_group *block_group,
1142 struct btrfs_io_ctl *io_ctl,
1145 u64 start, extent_start, extent_end, len;
1146 struct extent_io_tree *unpin = NULL;
1153 * We want to add any pinned extents to our free space cache
1154 * so we don't leak the space
1156 * We shouldn't have switched the pinned extents yet so this is the
1159 unpin = &trans->transaction->pinned_extents;
1161 start = block_group->start;
1163 while (start < block_group->start + block_group->length) {
1164 ret = find_first_extent_bit(unpin, start,
1165 &extent_start, &extent_end,
1166 EXTENT_DIRTY, NULL);
1170 /* This pinned extent is out of our range */
1171 if (extent_start >= block_group->start + block_group->length)
1174 extent_start = max(extent_start, start);
1175 extent_end = min(block_group->start + block_group->length,
1177 len = extent_end - extent_start;
1180 ret = io_ctl_add_entry(io_ctl, extent_start, len, NULL);
1190 static noinline_for_stack int
1191 write_bitmap_entries(struct btrfs_io_ctl *io_ctl, struct list_head *bitmap_list)
1193 struct btrfs_free_space *entry, *next;
1196 /* Write out the bitmaps */
1197 list_for_each_entry_safe(entry, next, bitmap_list, list) {
1198 ret = io_ctl_add_bitmap(io_ctl, entry->bitmap);
1201 list_del_init(&entry->list);
1207 static int flush_dirty_cache(struct inode *inode)
1211 ret = btrfs_wait_ordered_range(inode, 0, (u64)-1);
1213 clear_extent_bit(&BTRFS_I(inode)->io_tree, 0, inode->i_size - 1,
1214 EXTENT_DELALLOC, 0, 0, NULL);
1219 static void noinline_for_stack
1220 cleanup_bitmap_list(struct list_head *bitmap_list)
1222 struct btrfs_free_space *entry, *next;
1224 list_for_each_entry_safe(entry, next, bitmap_list, list)
1225 list_del_init(&entry->list);
1228 static void noinline_for_stack
1229 cleanup_write_cache_enospc(struct inode *inode,
1230 struct btrfs_io_ctl *io_ctl,
1231 struct extent_state **cached_state)
1233 io_ctl_drop_pages(io_ctl);
1234 unlock_extent_cached(&BTRFS_I(inode)->io_tree, 0,
1235 i_size_read(inode) - 1, cached_state);
1238 static int __btrfs_wait_cache_io(struct btrfs_root *root,
1239 struct btrfs_trans_handle *trans,
1240 struct btrfs_block_group *block_group,
1241 struct btrfs_io_ctl *io_ctl,
1242 struct btrfs_path *path, u64 offset)
1245 struct inode *inode = io_ctl->inode;
1250 /* Flush the dirty pages in the cache file. */
1251 ret = flush_dirty_cache(inode);
1255 /* Update the cache item to tell everyone this cache file is valid. */
1256 ret = update_cache_item(trans, root, inode, path, offset,
1257 io_ctl->entries, io_ctl->bitmaps);
1260 invalidate_inode_pages2(inode->i_mapping);
1261 BTRFS_I(inode)->generation = 0;
1263 btrfs_debug(root->fs_info,
1264 "failed to write free space cache for block group %llu error %d",
1265 block_group->start, ret);
1267 btrfs_update_inode(trans, root, BTRFS_I(inode));
1270 /* the dirty list is protected by the dirty_bgs_lock */
1271 spin_lock(&trans->transaction->dirty_bgs_lock);
1273 /* the disk_cache_state is protected by the block group lock */
1274 spin_lock(&block_group->lock);
1277 * only mark this as written if we didn't get put back on
1278 * the dirty list while waiting for IO. Otherwise our
1279 * cache state won't be right, and we won't get written again
1281 if (!ret && list_empty(&block_group->dirty_list))
1282 block_group->disk_cache_state = BTRFS_DC_WRITTEN;
1284 block_group->disk_cache_state = BTRFS_DC_ERROR;
1286 spin_unlock(&block_group->lock);
1287 spin_unlock(&trans->transaction->dirty_bgs_lock);
1288 io_ctl->inode = NULL;
1296 int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
1297 struct btrfs_block_group *block_group,
1298 struct btrfs_path *path)
1300 return __btrfs_wait_cache_io(block_group->fs_info->tree_root, trans,
1301 block_group, &block_group->io_ctl,
1302 path, block_group->start);
1306 * Write out cached info to an inode
1308 * @root: root the inode belongs to
1309 * @inode: freespace inode we are writing out
1310 * @ctl: free space cache we are going to write out
1311 * @block_group: block_group for this cache if it belongs to a block_group
1312 * @io_ctl: holds context for the io
1313 * @trans: the trans handle
1315 * This function writes out a free space cache struct to disk for quick recovery
1316 * on mount. This will return 0 if it was successful in writing the cache out,
1317 * or an errno if it was not.
1319 static int __btrfs_write_out_cache(struct btrfs_root *root, struct inode *inode,
1320 struct btrfs_free_space_ctl *ctl,
1321 struct btrfs_block_group *block_group,
1322 struct btrfs_io_ctl *io_ctl,
1323 struct btrfs_trans_handle *trans)
1325 struct extent_state *cached_state = NULL;
1326 LIST_HEAD(bitmap_list);
1332 if (!i_size_read(inode))
1335 WARN_ON(io_ctl->pages);
1336 ret = io_ctl_init(io_ctl, inode, 1);
1340 if (block_group && (block_group->flags & BTRFS_BLOCK_GROUP_DATA)) {
1341 down_write(&block_group->data_rwsem);
1342 spin_lock(&block_group->lock);
1343 if (block_group->delalloc_bytes) {
1344 block_group->disk_cache_state = BTRFS_DC_WRITTEN;
1345 spin_unlock(&block_group->lock);
1346 up_write(&block_group->data_rwsem);
1347 BTRFS_I(inode)->generation = 0;
1352 spin_unlock(&block_group->lock);
1355 /* Lock all pages first so we can lock the extent safely. */
1356 ret = io_ctl_prepare_pages(io_ctl, false);
1360 lock_extent_bits(&BTRFS_I(inode)->io_tree, 0, i_size_read(inode) - 1,
1363 io_ctl_set_generation(io_ctl, trans->transid);
1365 mutex_lock(&ctl->cache_writeout_mutex);
1366 /* Write out the extent entries in the free space cache */
1367 spin_lock(&ctl->tree_lock);
1368 ret = write_cache_extent_entries(io_ctl, ctl,
1369 block_group, &entries, &bitmaps,
1372 goto out_nospc_locked;
1375 * Some spaces that are freed in the current transaction are pinned,
1376 * they will be added into free space cache after the transaction is
1377 * committed, we shouldn't lose them.
1379 * If this changes while we are working we'll get added back to
1380 * the dirty list and redo it. No locking needed
1382 ret = write_pinned_extent_entries(trans, block_group, io_ctl, &entries);
1384 goto out_nospc_locked;
1387 * At last, we write out all the bitmaps and keep cache_writeout_mutex
1388 * locked while doing it because a concurrent trim can be manipulating
1389 * or freeing the bitmap.
1391 ret = write_bitmap_entries(io_ctl, &bitmap_list);
1392 spin_unlock(&ctl->tree_lock);
1393 mutex_unlock(&ctl->cache_writeout_mutex);
1397 /* Zero out the rest of the pages just to make sure */
1398 io_ctl_zero_remaining_pages(io_ctl);
1400 /* Everything is written out, now we dirty the pages in the file. */
1401 ret = btrfs_dirty_pages(BTRFS_I(inode), io_ctl->pages,
1402 io_ctl->num_pages, 0, i_size_read(inode),
1403 &cached_state, false);
1407 if (block_group && (block_group->flags & BTRFS_BLOCK_GROUP_DATA))
1408 up_write(&block_group->data_rwsem);
1410 * Release the pages and unlock the extent, we will flush
1413 io_ctl_drop_pages(io_ctl);
1414 io_ctl_free(io_ctl);
1416 unlock_extent_cached(&BTRFS_I(inode)->io_tree, 0,
1417 i_size_read(inode) - 1, &cached_state);
1420 * at this point the pages are under IO and we're happy,
1421 * The caller is responsible for waiting on them and updating
1422 * the cache and the inode
1424 io_ctl->entries = entries;
1425 io_ctl->bitmaps = bitmaps;
1427 ret = btrfs_fdatawrite_range(inode, 0, (u64)-1);
1434 cleanup_bitmap_list(&bitmap_list);
1435 spin_unlock(&ctl->tree_lock);
1436 mutex_unlock(&ctl->cache_writeout_mutex);
1439 cleanup_write_cache_enospc(inode, io_ctl, &cached_state);
1442 if (block_group && (block_group->flags & BTRFS_BLOCK_GROUP_DATA))
1443 up_write(&block_group->data_rwsem);
1446 io_ctl->inode = NULL;
1447 io_ctl_free(io_ctl);
1449 invalidate_inode_pages2(inode->i_mapping);
1450 BTRFS_I(inode)->generation = 0;
1452 btrfs_update_inode(trans, root, BTRFS_I(inode));
1458 int btrfs_write_out_cache(struct btrfs_trans_handle *trans,
1459 struct btrfs_block_group *block_group,
1460 struct btrfs_path *path)
1462 struct btrfs_fs_info *fs_info = trans->fs_info;
1463 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
1464 struct inode *inode;
1467 spin_lock(&block_group->lock);
1468 if (block_group->disk_cache_state < BTRFS_DC_SETUP) {
1469 spin_unlock(&block_group->lock);
1472 spin_unlock(&block_group->lock);
1474 inode = lookup_free_space_inode(block_group, path);
1478 ret = __btrfs_write_out_cache(fs_info->tree_root, inode, ctl,
1479 block_group, &block_group->io_ctl, trans);
1481 btrfs_debug(fs_info,
1482 "failed to write free space cache for block group %llu error %d",
1483 block_group->start, ret);
1484 spin_lock(&block_group->lock);
1485 block_group->disk_cache_state = BTRFS_DC_ERROR;
1486 spin_unlock(&block_group->lock);
1488 block_group->io_ctl.inode = NULL;
1493 * if ret == 0 the caller is expected to call btrfs_wait_cache_io
1494 * to wait for IO and put the inode
1500 static inline unsigned long offset_to_bit(u64 bitmap_start, u32 unit,
1503 ASSERT(offset >= bitmap_start);
1504 offset -= bitmap_start;
1505 return (unsigned long)(div_u64(offset, unit));
1508 static inline unsigned long bytes_to_bits(u64 bytes, u32 unit)
1510 return (unsigned long)(div_u64(bytes, unit));
1513 static inline u64 offset_to_bitmap(struct btrfs_free_space_ctl *ctl,
1517 u64 bytes_per_bitmap;
1519 bytes_per_bitmap = BITS_PER_BITMAP * ctl->unit;
1520 bitmap_start = offset - ctl->start;
1521 bitmap_start = div64_u64(bitmap_start, bytes_per_bitmap);
1522 bitmap_start *= bytes_per_bitmap;
1523 bitmap_start += ctl->start;
1525 return bitmap_start;
1528 static int tree_insert_offset(struct rb_root *root, u64 offset,
1529 struct rb_node *node, int bitmap)
1531 struct rb_node **p = &root->rb_node;
1532 struct rb_node *parent = NULL;
1533 struct btrfs_free_space *info;
1537 info = rb_entry(parent, struct btrfs_free_space, offset_index);
1539 if (offset < info->offset) {
1541 } else if (offset > info->offset) {
1542 p = &(*p)->rb_right;
1545 * we could have a bitmap entry and an extent entry
1546 * share the same offset. If this is the case, we want
1547 * the extent entry to always be found first if we do a
1548 * linear search through the tree, since we want to have
1549 * the quickest allocation time, and allocating from an
1550 * extent is faster than allocating from a bitmap. So
1551 * if we're inserting a bitmap and we find an entry at
1552 * this offset, we want to go right, or after this entry
1553 * logically. If we are inserting an extent and we've
1554 * found a bitmap, we want to go left, or before
1562 p = &(*p)->rb_right;
1564 if (!info->bitmap) {
1573 rb_link_node(node, parent, p);
1574 rb_insert_color(node, root);
1580 * searches the tree for the given offset.
1582 * fuzzy - If this is set, then we are trying to make an allocation, and we just
1583 * want a section that has at least bytes size and comes at or after the given
1586 static struct btrfs_free_space *
1587 tree_search_offset(struct btrfs_free_space_ctl *ctl,
1588 u64 offset, int bitmap_only, int fuzzy)
1590 struct rb_node *n = ctl->free_space_offset.rb_node;
1591 struct btrfs_free_space *entry, *prev = NULL;
1593 /* find entry that is closest to the 'offset' */
1600 entry = rb_entry(n, struct btrfs_free_space, offset_index);
1603 if (offset < entry->offset)
1605 else if (offset > entry->offset)
1618 * bitmap entry and extent entry may share same offset,
1619 * in that case, bitmap entry comes after extent entry.
1624 entry = rb_entry(n, struct btrfs_free_space, offset_index);
1625 if (entry->offset != offset)
1628 WARN_ON(!entry->bitmap);
1631 if (entry->bitmap) {
1633 * if previous extent entry covers the offset,
1634 * we should return it instead of the bitmap entry
1636 n = rb_prev(&entry->offset_index);
1638 prev = rb_entry(n, struct btrfs_free_space,
1640 if (!prev->bitmap &&
1641 prev->offset + prev->bytes > offset)
1651 /* find last entry before the 'offset' */
1653 if (entry->offset > offset) {
1654 n = rb_prev(&entry->offset_index);
1656 entry = rb_entry(n, struct btrfs_free_space,
1658 ASSERT(entry->offset <= offset);
1667 if (entry->bitmap) {
1668 n = rb_prev(&entry->offset_index);
1670 prev = rb_entry(n, struct btrfs_free_space,
1672 if (!prev->bitmap &&
1673 prev->offset + prev->bytes > offset)
1676 if (entry->offset + BITS_PER_BITMAP * ctl->unit > offset)
1678 } else if (entry->offset + entry->bytes > offset)
1685 if (entry->bitmap) {
1686 if (entry->offset + BITS_PER_BITMAP *
1690 if (entry->offset + entry->bytes > offset)
1694 n = rb_next(&entry->offset_index);
1697 entry = rb_entry(n, struct btrfs_free_space, offset_index);
1703 __unlink_free_space(struct btrfs_free_space_ctl *ctl,
1704 struct btrfs_free_space *info)
1706 rb_erase(&info->offset_index, &ctl->free_space_offset);
1707 ctl->free_extents--;
1709 if (!info->bitmap && !btrfs_free_space_trimmed(info)) {
1710 ctl->discardable_extents[BTRFS_STAT_CURR]--;
1711 ctl->discardable_bytes[BTRFS_STAT_CURR] -= info->bytes;
1715 static void unlink_free_space(struct btrfs_free_space_ctl *ctl,
1716 struct btrfs_free_space *info)
1718 __unlink_free_space(ctl, info);
1719 ctl->free_space -= info->bytes;
1722 static int link_free_space(struct btrfs_free_space_ctl *ctl,
1723 struct btrfs_free_space *info)
1727 ASSERT(info->bytes || info->bitmap);
1728 ret = tree_insert_offset(&ctl->free_space_offset, info->offset,
1729 &info->offset_index, (info->bitmap != NULL));
1733 if (!info->bitmap && !btrfs_free_space_trimmed(info)) {
1734 ctl->discardable_extents[BTRFS_STAT_CURR]++;
1735 ctl->discardable_bytes[BTRFS_STAT_CURR] += info->bytes;
1738 ctl->free_space += info->bytes;
1739 ctl->free_extents++;
1743 static inline void __bitmap_clear_bits(struct btrfs_free_space_ctl *ctl,
1744 struct btrfs_free_space *info,
1745 u64 offset, u64 bytes)
1747 unsigned long start, count, end;
1748 int extent_delta = -1;
1750 start = offset_to_bit(info->offset, ctl->unit, offset);
1751 count = bytes_to_bits(bytes, ctl->unit);
1752 end = start + count;
1753 ASSERT(end <= BITS_PER_BITMAP);
1755 bitmap_clear(info->bitmap, start, count);
1757 info->bytes -= bytes;
1758 if (info->max_extent_size > ctl->unit)
1759 info->max_extent_size = 0;
1761 if (start && test_bit(start - 1, info->bitmap))
1764 if (end < BITS_PER_BITMAP && test_bit(end, info->bitmap))
1767 info->bitmap_extents += extent_delta;
1768 if (!btrfs_free_space_trimmed(info)) {
1769 ctl->discardable_extents[BTRFS_STAT_CURR] += extent_delta;
1770 ctl->discardable_bytes[BTRFS_STAT_CURR] -= bytes;
1774 static void bitmap_clear_bits(struct btrfs_free_space_ctl *ctl,
1775 struct btrfs_free_space *info, u64 offset,
1778 __bitmap_clear_bits(ctl, info, offset, bytes);
1779 ctl->free_space -= bytes;
1782 static void bitmap_set_bits(struct btrfs_free_space_ctl *ctl,
1783 struct btrfs_free_space *info, u64 offset,
1786 unsigned long start, count, end;
1787 int extent_delta = 1;
1789 start = offset_to_bit(info->offset, ctl->unit, offset);
1790 count = bytes_to_bits(bytes, ctl->unit);
1791 end = start + count;
1792 ASSERT(end <= BITS_PER_BITMAP);
1794 bitmap_set(info->bitmap, start, count);
1796 info->bytes += bytes;
1797 ctl->free_space += bytes;
1799 if (start && test_bit(start - 1, info->bitmap))
1802 if (end < BITS_PER_BITMAP && test_bit(end, info->bitmap))
1805 info->bitmap_extents += extent_delta;
1806 if (!btrfs_free_space_trimmed(info)) {
1807 ctl->discardable_extents[BTRFS_STAT_CURR] += extent_delta;
1808 ctl->discardable_bytes[BTRFS_STAT_CURR] += bytes;
1813 * If we can not find suitable extent, we will use bytes to record
1814 * the size of the max extent.
1816 static int search_bitmap(struct btrfs_free_space_ctl *ctl,
1817 struct btrfs_free_space *bitmap_info, u64 *offset,
1818 u64 *bytes, bool for_alloc)
1820 unsigned long found_bits = 0;
1821 unsigned long max_bits = 0;
1822 unsigned long bits, i;
1823 unsigned long next_zero;
1824 unsigned long extent_bits;
1827 * Skip searching the bitmap if we don't have a contiguous section that
1828 * is large enough for this allocation.
1831 bitmap_info->max_extent_size &&
1832 bitmap_info->max_extent_size < *bytes) {
1833 *bytes = bitmap_info->max_extent_size;
1837 i = offset_to_bit(bitmap_info->offset, ctl->unit,
1838 max_t(u64, *offset, bitmap_info->offset));
1839 bits = bytes_to_bits(*bytes, ctl->unit);
1841 for_each_set_bit_from(i, bitmap_info->bitmap, BITS_PER_BITMAP) {
1842 if (for_alloc && bits == 1) {
1846 next_zero = find_next_zero_bit(bitmap_info->bitmap,
1847 BITS_PER_BITMAP, i);
1848 extent_bits = next_zero - i;
1849 if (extent_bits >= bits) {
1850 found_bits = extent_bits;
1852 } else if (extent_bits > max_bits) {
1853 max_bits = extent_bits;
1859 *offset = (u64)(i * ctl->unit) + bitmap_info->offset;
1860 *bytes = (u64)(found_bits) * ctl->unit;
1864 *bytes = (u64)(max_bits) * ctl->unit;
1865 bitmap_info->max_extent_size = *bytes;
1869 static inline u64 get_max_extent_size(struct btrfs_free_space *entry)
1872 return entry->max_extent_size;
1873 return entry->bytes;
1876 /* Cache the size of the max extent in bytes */
1877 static struct btrfs_free_space *
1878 find_free_space(struct btrfs_free_space_ctl *ctl, u64 *offset, u64 *bytes,
1879 unsigned long align, u64 *max_extent_size)
1881 struct btrfs_free_space *entry;
1882 struct rb_node *node;
1887 if (!ctl->free_space_offset.rb_node)
1890 entry = tree_search_offset(ctl, offset_to_bitmap(ctl, *offset), 0, 1);
1894 for (node = &entry->offset_index; node; node = rb_next(node)) {
1895 entry = rb_entry(node, struct btrfs_free_space, offset_index);
1896 if (entry->bytes < *bytes) {
1897 *max_extent_size = max(get_max_extent_size(entry),
1902 /* make sure the space returned is big enough
1903 * to match our requested alignment
1905 if (*bytes >= align) {
1906 tmp = entry->offset - ctl->start + align - 1;
1907 tmp = div64_u64(tmp, align);
1908 tmp = tmp * align + ctl->start;
1909 align_off = tmp - entry->offset;
1912 tmp = entry->offset;
1915 if (entry->bytes < *bytes + align_off) {
1916 *max_extent_size = max(get_max_extent_size(entry),
1921 if (entry->bitmap) {
1924 ret = search_bitmap(ctl, entry, &tmp, &size, true);
1931 max(get_max_extent_size(entry),
1938 *bytes = entry->bytes - align_off;
1945 static void add_new_bitmap(struct btrfs_free_space_ctl *ctl,
1946 struct btrfs_free_space *info, u64 offset)
1948 info->offset = offset_to_bitmap(ctl, offset);
1950 info->bitmap_extents = 0;
1951 INIT_LIST_HEAD(&info->list);
1952 link_free_space(ctl, info);
1953 ctl->total_bitmaps++;
1954 recalculate_thresholds(ctl);
1957 static void free_bitmap(struct btrfs_free_space_ctl *ctl,
1958 struct btrfs_free_space *bitmap_info)
1961 * Normally when this is called, the bitmap is completely empty. However,
1962 * if we are blowing up the free space cache for one reason or another
1963 * via __btrfs_remove_free_space_cache(), then it may not be freed and
1964 * we may leave stats on the table.
1966 if (bitmap_info->bytes && !btrfs_free_space_trimmed(bitmap_info)) {
1967 ctl->discardable_extents[BTRFS_STAT_CURR] -=
1968 bitmap_info->bitmap_extents;
1969 ctl->discardable_bytes[BTRFS_STAT_CURR] -= bitmap_info->bytes;
1972 unlink_free_space(ctl, bitmap_info);
1973 kmem_cache_free(btrfs_free_space_bitmap_cachep, bitmap_info->bitmap);
1974 kmem_cache_free(btrfs_free_space_cachep, bitmap_info);
1975 ctl->total_bitmaps--;
1976 recalculate_thresholds(ctl);
1979 static noinline int remove_from_bitmap(struct btrfs_free_space_ctl *ctl,
1980 struct btrfs_free_space *bitmap_info,
1981 u64 *offset, u64 *bytes)
1984 u64 search_start, search_bytes;
1988 end = bitmap_info->offset + (u64)(BITS_PER_BITMAP * ctl->unit) - 1;
1991 * We need to search for bits in this bitmap. We could only cover some
1992 * of the extent in this bitmap thanks to how we add space, so we need
1993 * to search for as much as it as we can and clear that amount, and then
1994 * go searching for the next bit.
1996 search_start = *offset;
1997 search_bytes = ctl->unit;
1998 search_bytes = min(search_bytes, end - search_start + 1);
1999 ret = search_bitmap(ctl, bitmap_info, &search_start, &search_bytes,
2001 if (ret < 0 || search_start != *offset)
2004 /* We may have found more bits than what we need */
2005 search_bytes = min(search_bytes, *bytes);
2007 /* Cannot clear past the end of the bitmap */
2008 search_bytes = min(search_bytes, end - search_start + 1);
2010 bitmap_clear_bits(ctl, bitmap_info, search_start, search_bytes);
2011 *offset += search_bytes;
2012 *bytes -= search_bytes;
2015 struct rb_node *next = rb_next(&bitmap_info->offset_index);
2016 if (!bitmap_info->bytes)
2017 free_bitmap(ctl, bitmap_info);
2020 * no entry after this bitmap, but we still have bytes to
2021 * remove, so something has gone wrong.
2026 bitmap_info = rb_entry(next, struct btrfs_free_space,
2030 * if the next entry isn't a bitmap we need to return to let the
2031 * extent stuff do its work.
2033 if (!bitmap_info->bitmap)
2037 * Ok the next item is a bitmap, but it may not actually hold
2038 * the information for the rest of this free space stuff, so
2039 * look for it, and if we don't find it return so we can try
2040 * everything over again.
2042 search_start = *offset;
2043 search_bytes = ctl->unit;
2044 ret = search_bitmap(ctl, bitmap_info, &search_start,
2045 &search_bytes, false);
2046 if (ret < 0 || search_start != *offset)
2050 } else if (!bitmap_info->bytes)
2051 free_bitmap(ctl, bitmap_info);
2056 static u64 add_bytes_to_bitmap(struct btrfs_free_space_ctl *ctl,
2057 struct btrfs_free_space *info, u64 offset,
2058 u64 bytes, enum btrfs_trim_state trim_state)
2060 u64 bytes_to_set = 0;
2064 * This is a tradeoff to make bitmap trim state minimal. We mark the
2065 * whole bitmap untrimmed if at any point we add untrimmed regions.
2067 if (trim_state == BTRFS_TRIM_STATE_UNTRIMMED) {
2068 if (btrfs_free_space_trimmed(info)) {
2069 ctl->discardable_extents[BTRFS_STAT_CURR] +=
2070 info->bitmap_extents;
2071 ctl->discardable_bytes[BTRFS_STAT_CURR] += info->bytes;
2073 info->trim_state = BTRFS_TRIM_STATE_UNTRIMMED;
2076 end = info->offset + (u64)(BITS_PER_BITMAP * ctl->unit);
2078 bytes_to_set = min(end - offset, bytes);
2080 bitmap_set_bits(ctl, info, offset, bytes_to_set);
2083 * We set some bytes, we have no idea what the max extent size is
2086 info->max_extent_size = 0;
2088 return bytes_to_set;
2092 static bool use_bitmap(struct btrfs_free_space_ctl *ctl,
2093 struct btrfs_free_space *info)
2095 struct btrfs_block_group *block_group = ctl->private;
2096 struct btrfs_fs_info *fs_info = block_group->fs_info;
2097 bool forced = false;
2099 #ifdef CONFIG_BTRFS_DEBUG
2100 if (btrfs_should_fragment_free_space(block_group))
2104 /* This is a way to reclaim large regions from the bitmaps. */
2105 if (!forced && info->bytes >= FORCE_EXTENT_THRESHOLD)
2109 * If we are below the extents threshold then we can add this as an
2110 * extent, and don't have to deal with the bitmap
2112 if (!forced && ctl->free_extents < ctl->extents_thresh) {
2114 * If this block group has some small extents we don't want to
2115 * use up all of our free slots in the cache with them, we want
2116 * to reserve them to larger extents, however if we have plenty
2117 * of cache left then go ahead an dadd them, no sense in adding
2118 * the overhead of a bitmap if we don't have to.
2120 if (info->bytes <= fs_info->sectorsize * 8) {
2121 if (ctl->free_extents * 3 <= ctl->extents_thresh)
2129 * The original block groups from mkfs can be really small, like 8
2130 * megabytes, so don't bother with a bitmap for those entries. However
2131 * some block groups can be smaller than what a bitmap would cover but
2132 * are still large enough that they could overflow the 32k memory limit,
2133 * so allow those block groups to still be allowed to have a bitmap
2136 if (((BITS_PER_BITMAP * ctl->unit) >> 1) > block_group->length)
2142 static const struct btrfs_free_space_op free_space_op = {
2143 .use_bitmap = use_bitmap,
2146 static int insert_into_bitmap(struct btrfs_free_space_ctl *ctl,
2147 struct btrfs_free_space *info)
2149 struct btrfs_free_space *bitmap_info;
2150 struct btrfs_block_group *block_group = NULL;
2152 u64 bytes, offset, bytes_added;
2153 enum btrfs_trim_state trim_state;
2156 bytes = info->bytes;
2157 offset = info->offset;
2158 trim_state = info->trim_state;
2160 if (!ctl->op->use_bitmap(ctl, info))
2163 if (ctl->op == &free_space_op)
2164 block_group = ctl->private;
2167 * Since we link bitmaps right into the cluster we need to see if we
2168 * have a cluster here, and if so and it has our bitmap we need to add
2169 * the free space to that bitmap.
2171 if (block_group && !list_empty(&block_group->cluster_list)) {
2172 struct btrfs_free_cluster *cluster;
2173 struct rb_node *node;
2174 struct btrfs_free_space *entry;
2176 cluster = list_entry(block_group->cluster_list.next,
2177 struct btrfs_free_cluster,
2179 spin_lock(&cluster->lock);
2180 node = rb_first(&cluster->root);
2182 spin_unlock(&cluster->lock);
2183 goto no_cluster_bitmap;
2186 entry = rb_entry(node, struct btrfs_free_space, offset_index);
2187 if (!entry->bitmap) {
2188 spin_unlock(&cluster->lock);
2189 goto no_cluster_bitmap;
2192 if (entry->offset == offset_to_bitmap(ctl, offset)) {
2193 bytes_added = add_bytes_to_bitmap(ctl, entry, offset,
2195 bytes -= bytes_added;
2196 offset += bytes_added;
2198 spin_unlock(&cluster->lock);
2206 bitmap_info = tree_search_offset(ctl, offset_to_bitmap(ctl, offset),
2213 bytes_added = add_bytes_to_bitmap(ctl, bitmap_info, offset, bytes,
2215 bytes -= bytes_added;
2216 offset += bytes_added;
2226 if (info && info->bitmap) {
2227 add_new_bitmap(ctl, info, offset);
2232 spin_unlock(&ctl->tree_lock);
2234 /* no pre-allocated info, allocate a new one */
2236 info = kmem_cache_zalloc(btrfs_free_space_cachep,
2239 spin_lock(&ctl->tree_lock);
2245 /* allocate the bitmap */
2246 info->bitmap = kmem_cache_zalloc(btrfs_free_space_bitmap_cachep,
2248 info->trim_state = BTRFS_TRIM_STATE_TRIMMED;
2249 spin_lock(&ctl->tree_lock);
2250 if (!info->bitmap) {
2260 kmem_cache_free(btrfs_free_space_bitmap_cachep,
2262 kmem_cache_free(btrfs_free_space_cachep, info);
2269 * Free space merging rules:
2270 * 1) Merge trimmed areas together
2271 * 2) Let untrimmed areas coalesce with trimmed areas
2272 * 3) Always pull neighboring regions from bitmaps
2274 * The above rules are for when we merge free space based on btrfs_trim_state.
2275 * Rules 2 and 3 are subtle because they are suboptimal, but are done for the
2276 * same reason: to promote larger extent regions which makes life easier for
2277 * find_free_extent(). Rule 2 enables coalescing based on the common path
2278 * being returning free space from btrfs_finish_extent_commit(). So when free
2279 * space is trimmed, it will prevent aggregating trimmed new region and
2280 * untrimmed regions in the rb_tree. Rule 3 is purely to obtain larger extents
2281 * and provide find_free_extent() with the largest extents possible hoping for
2284 static bool try_merge_free_space(struct btrfs_free_space_ctl *ctl,
2285 struct btrfs_free_space *info, bool update_stat)
2287 struct btrfs_free_space *left_info = NULL;
2288 struct btrfs_free_space *right_info;
2289 bool merged = false;
2290 u64 offset = info->offset;
2291 u64 bytes = info->bytes;
2292 const bool is_trimmed = btrfs_free_space_trimmed(info);
2295 * first we want to see if there is free space adjacent to the range we
2296 * are adding, if there is remove that struct and add a new one to
2297 * cover the entire range
2299 right_info = tree_search_offset(ctl, offset + bytes, 0, 0);
2300 if (right_info && rb_prev(&right_info->offset_index))
2301 left_info = rb_entry(rb_prev(&right_info->offset_index),
2302 struct btrfs_free_space, offset_index);
2303 else if (!right_info)
2304 left_info = tree_search_offset(ctl, offset - 1, 0, 0);
2306 /* See try_merge_free_space() comment. */
2307 if (right_info && !right_info->bitmap &&
2308 (!is_trimmed || btrfs_free_space_trimmed(right_info))) {
2310 unlink_free_space(ctl, right_info);
2312 __unlink_free_space(ctl, right_info);
2313 info->bytes += right_info->bytes;
2314 kmem_cache_free(btrfs_free_space_cachep, right_info);
2318 /* See try_merge_free_space() comment. */
2319 if (left_info && !left_info->bitmap &&
2320 left_info->offset + left_info->bytes == offset &&
2321 (!is_trimmed || btrfs_free_space_trimmed(left_info))) {
2323 unlink_free_space(ctl, left_info);
2325 __unlink_free_space(ctl, left_info);
2326 info->offset = left_info->offset;
2327 info->bytes += left_info->bytes;
2328 kmem_cache_free(btrfs_free_space_cachep, left_info);
2335 static bool steal_from_bitmap_to_end(struct btrfs_free_space_ctl *ctl,
2336 struct btrfs_free_space *info,
2339 struct btrfs_free_space *bitmap;
2342 const u64 end = info->offset + info->bytes;
2343 const u64 bitmap_offset = offset_to_bitmap(ctl, end);
2346 bitmap = tree_search_offset(ctl, bitmap_offset, 1, 0);
2350 i = offset_to_bit(bitmap->offset, ctl->unit, end);
2351 j = find_next_zero_bit(bitmap->bitmap, BITS_PER_BITMAP, i);
2354 bytes = (j - i) * ctl->unit;
2355 info->bytes += bytes;
2357 /* See try_merge_free_space() comment. */
2358 if (!btrfs_free_space_trimmed(bitmap))
2359 info->trim_state = BTRFS_TRIM_STATE_UNTRIMMED;
2362 bitmap_clear_bits(ctl, bitmap, end, bytes);
2364 __bitmap_clear_bits(ctl, bitmap, end, bytes);
2367 free_bitmap(ctl, bitmap);
2372 static bool steal_from_bitmap_to_front(struct btrfs_free_space_ctl *ctl,
2373 struct btrfs_free_space *info,
2376 struct btrfs_free_space *bitmap;
2380 unsigned long prev_j;
2383 bitmap_offset = offset_to_bitmap(ctl, info->offset);
2384 /* If we're on a boundary, try the previous logical bitmap. */
2385 if (bitmap_offset == info->offset) {
2386 if (info->offset == 0)
2388 bitmap_offset = offset_to_bitmap(ctl, info->offset - 1);
2391 bitmap = tree_search_offset(ctl, bitmap_offset, 1, 0);
2395 i = offset_to_bit(bitmap->offset, ctl->unit, info->offset) - 1;
2397 prev_j = (unsigned long)-1;
2398 for_each_clear_bit_from(j, bitmap->bitmap, BITS_PER_BITMAP) {
2406 if (prev_j == (unsigned long)-1)
2407 bytes = (i + 1) * ctl->unit;
2409 bytes = (i - prev_j) * ctl->unit;
2411 info->offset -= bytes;
2412 info->bytes += bytes;
2414 /* See try_merge_free_space() comment. */
2415 if (!btrfs_free_space_trimmed(bitmap))
2416 info->trim_state = BTRFS_TRIM_STATE_UNTRIMMED;
2419 bitmap_clear_bits(ctl, bitmap, info->offset, bytes);
2421 __bitmap_clear_bits(ctl, bitmap, info->offset, bytes);
2424 free_bitmap(ctl, bitmap);
2430 * We prefer always to allocate from extent entries, both for clustered and
2431 * non-clustered allocation requests. So when attempting to add a new extent
2432 * entry, try to see if there's adjacent free space in bitmap entries, and if
2433 * there is, migrate that space from the bitmaps to the extent.
2434 * Like this we get better chances of satisfying space allocation requests
2435 * because we attempt to satisfy them based on a single cache entry, and never
2436 * on 2 or more entries - even if the entries represent a contiguous free space
2437 * region (e.g. 1 extent entry + 1 bitmap entry starting where the extent entry
2440 static void steal_from_bitmap(struct btrfs_free_space_ctl *ctl,
2441 struct btrfs_free_space *info,
2445 * Only work with disconnected entries, as we can change their offset,
2446 * and must be extent entries.
2448 ASSERT(!info->bitmap);
2449 ASSERT(RB_EMPTY_NODE(&info->offset_index));
2451 if (ctl->total_bitmaps > 0) {
2453 bool stole_front = false;
2455 stole_end = steal_from_bitmap_to_end(ctl, info, update_stat);
2456 if (ctl->total_bitmaps > 0)
2457 stole_front = steal_from_bitmap_to_front(ctl, info,
2460 if (stole_end || stole_front)
2461 try_merge_free_space(ctl, info, update_stat);
2465 int __btrfs_add_free_space(struct btrfs_fs_info *fs_info,
2466 struct btrfs_free_space_ctl *ctl,
2467 u64 offset, u64 bytes,
2468 enum btrfs_trim_state trim_state)
2470 struct btrfs_block_group *block_group = ctl->private;
2471 struct btrfs_free_space *info;
2473 u64 filter_bytes = bytes;
2475 ASSERT(!btrfs_is_zoned(fs_info));
2477 info = kmem_cache_zalloc(btrfs_free_space_cachep, GFP_NOFS);
2481 info->offset = offset;
2482 info->bytes = bytes;
2483 info->trim_state = trim_state;
2484 RB_CLEAR_NODE(&info->offset_index);
2486 spin_lock(&ctl->tree_lock);
2488 if (try_merge_free_space(ctl, info, true))
2492 * There was no extent directly to the left or right of this new
2493 * extent then we know we're going to have to allocate a new extent, so
2494 * before we do that see if we need to drop this into a bitmap
2496 ret = insert_into_bitmap(ctl, info);
2505 * Only steal free space from adjacent bitmaps if we're sure we're not
2506 * going to add the new free space to existing bitmap entries - because
2507 * that would mean unnecessary work that would be reverted. Therefore
2508 * attempt to steal space from bitmaps if we're adding an extent entry.
2510 steal_from_bitmap(ctl, info, true);
2512 filter_bytes = max(filter_bytes, info->bytes);
2514 ret = link_free_space(ctl, info);
2516 kmem_cache_free(btrfs_free_space_cachep, info);
2518 btrfs_discard_update_discardable(block_group);
2519 spin_unlock(&ctl->tree_lock);
2522 btrfs_crit(fs_info, "unable to add free space :%d", ret);
2523 ASSERT(ret != -EEXIST);
2526 if (trim_state != BTRFS_TRIM_STATE_TRIMMED) {
2527 btrfs_discard_check_filter(block_group, filter_bytes);
2528 btrfs_discard_queue_work(&fs_info->discard_ctl, block_group);
2534 static int __btrfs_add_free_space_zoned(struct btrfs_block_group *block_group,
2535 u64 bytenr, u64 size, bool used)
2537 struct btrfs_fs_info *fs_info = block_group->fs_info;
2538 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
2539 u64 offset = bytenr - block_group->start;
2540 u64 to_free, to_unusable;
2541 const int bg_reclaim_threshold = READ_ONCE(fs_info->bg_reclaim_threshold);
2543 spin_lock(&ctl->tree_lock);
2546 else if (offset >= block_group->alloc_offset)
2548 else if (offset + size <= block_group->alloc_offset)
2551 to_free = offset + size - block_group->alloc_offset;
2552 to_unusable = size - to_free;
2554 ctl->free_space += to_free;
2556 * If the block group is read-only, we should account freed space into
2559 if (!block_group->ro)
2560 block_group->zone_unusable += to_unusable;
2561 spin_unlock(&ctl->tree_lock);
2563 spin_lock(&block_group->lock);
2564 block_group->alloc_offset -= size;
2565 spin_unlock(&block_group->lock);
2568 /* All the region is now unusable. Mark it as unused and reclaim */
2569 if (block_group->zone_unusable == block_group->length) {
2570 btrfs_mark_bg_unused(block_group);
2571 } else if (bg_reclaim_threshold &&
2572 block_group->zone_unusable >=
2573 div_factor_fine(block_group->length, bg_reclaim_threshold)) {
2574 btrfs_mark_bg_to_reclaim(block_group);
2580 int btrfs_add_free_space(struct btrfs_block_group *block_group,
2581 u64 bytenr, u64 size)
2583 enum btrfs_trim_state trim_state = BTRFS_TRIM_STATE_UNTRIMMED;
2585 if (btrfs_is_zoned(block_group->fs_info))
2586 return __btrfs_add_free_space_zoned(block_group, bytenr, size,
2589 if (btrfs_test_opt(block_group->fs_info, DISCARD_SYNC))
2590 trim_state = BTRFS_TRIM_STATE_TRIMMED;
2592 return __btrfs_add_free_space(block_group->fs_info,
2593 block_group->free_space_ctl,
2594 bytenr, size, trim_state);
2597 int btrfs_add_free_space_unused(struct btrfs_block_group *block_group,
2598 u64 bytenr, u64 size)
2600 if (btrfs_is_zoned(block_group->fs_info))
2601 return __btrfs_add_free_space_zoned(block_group, bytenr, size,
2604 return btrfs_add_free_space(block_group, bytenr, size);
2608 * This is a subtle distinction because when adding free space back in general,
2609 * we want it to be added as untrimmed for async. But in the case where we add
2610 * it on loading of a block group, we want to consider it trimmed.
2612 int btrfs_add_free_space_async_trimmed(struct btrfs_block_group *block_group,
2613 u64 bytenr, u64 size)
2615 enum btrfs_trim_state trim_state = BTRFS_TRIM_STATE_UNTRIMMED;
2617 if (btrfs_is_zoned(block_group->fs_info))
2618 return __btrfs_add_free_space_zoned(block_group, bytenr, size,
2621 if (btrfs_test_opt(block_group->fs_info, DISCARD_SYNC) ||
2622 btrfs_test_opt(block_group->fs_info, DISCARD_ASYNC))
2623 trim_state = BTRFS_TRIM_STATE_TRIMMED;
2625 return __btrfs_add_free_space(block_group->fs_info,
2626 block_group->free_space_ctl,
2627 bytenr, size, trim_state);
2630 int btrfs_remove_free_space(struct btrfs_block_group *block_group,
2631 u64 offset, u64 bytes)
2633 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
2634 struct btrfs_free_space *info;
2636 bool re_search = false;
2638 if (btrfs_is_zoned(block_group->fs_info)) {
2640 * This can happen with conventional zones when replaying log.
2641 * Since the allocation info of tree-log nodes are not recorded
2642 * to the extent-tree, calculate_alloc_pointer() failed to
2643 * advance the allocation pointer after last allocated tree log
2646 * This function is called from
2647 * btrfs_pin_extent_for_log_replay() when replaying the log.
2648 * Advance the pointer not to overwrite the tree-log nodes.
2650 if (block_group->start + block_group->alloc_offset <
2652 block_group->alloc_offset =
2653 offset + bytes - block_group->start;
2658 spin_lock(&ctl->tree_lock);
2665 info = tree_search_offset(ctl, offset, 0, 0);
2668 * oops didn't find an extent that matched the space we wanted
2669 * to remove, look for a bitmap instead
2671 info = tree_search_offset(ctl, offset_to_bitmap(ctl, offset),
2675 * If we found a partial bit of our free space in a
2676 * bitmap but then couldn't find the other part this may
2677 * be a problem, so WARN about it.
2685 if (!info->bitmap) {
2686 unlink_free_space(ctl, info);
2687 if (offset == info->offset) {
2688 u64 to_free = min(bytes, info->bytes);
2690 info->bytes -= to_free;
2691 info->offset += to_free;
2693 ret = link_free_space(ctl, info);
2696 kmem_cache_free(btrfs_free_space_cachep, info);
2703 u64 old_end = info->bytes + info->offset;
2705 info->bytes = offset - info->offset;
2706 ret = link_free_space(ctl, info);
2711 /* Not enough bytes in this entry to satisfy us */
2712 if (old_end < offset + bytes) {
2713 bytes -= old_end - offset;
2716 } else if (old_end == offset + bytes) {
2720 spin_unlock(&ctl->tree_lock);
2722 ret = __btrfs_add_free_space(block_group->fs_info, ctl,
2724 old_end - (offset + bytes),
2731 ret = remove_from_bitmap(ctl, info, &offset, &bytes);
2732 if (ret == -EAGAIN) {
2737 btrfs_discard_update_discardable(block_group);
2738 spin_unlock(&ctl->tree_lock);
2743 void btrfs_dump_free_space(struct btrfs_block_group *block_group,
2746 struct btrfs_fs_info *fs_info = block_group->fs_info;
2747 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
2748 struct btrfs_free_space *info;
2753 * Zoned btrfs does not use free space tree and cluster. Just print
2754 * out the free space after the allocation offset.
2756 if (btrfs_is_zoned(fs_info)) {
2757 btrfs_info(fs_info, "free space %llu",
2758 block_group->length - block_group->alloc_offset);
2762 spin_lock(&ctl->tree_lock);
2763 for (n = rb_first(&ctl->free_space_offset); n; n = rb_next(n)) {
2764 info = rb_entry(n, struct btrfs_free_space, offset_index);
2765 if (info->bytes >= bytes && !block_group->ro)
2767 btrfs_crit(fs_info, "entry offset %llu, bytes %llu, bitmap %s",
2768 info->offset, info->bytes,
2769 (info->bitmap) ? "yes" : "no");
2771 spin_unlock(&ctl->tree_lock);
2772 btrfs_info(fs_info, "block group has cluster?: %s",
2773 list_empty(&block_group->cluster_list) ? "no" : "yes");
2775 "%d blocks of free space at or bigger than bytes is", count);
2778 void btrfs_init_free_space_ctl(struct btrfs_block_group *block_group,
2779 struct btrfs_free_space_ctl *ctl)
2781 struct btrfs_fs_info *fs_info = block_group->fs_info;
2783 spin_lock_init(&ctl->tree_lock);
2784 ctl->unit = fs_info->sectorsize;
2785 ctl->start = block_group->start;
2786 ctl->private = block_group;
2787 ctl->op = &free_space_op;
2788 INIT_LIST_HEAD(&ctl->trimming_ranges);
2789 mutex_init(&ctl->cache_writeout_mutex);
2792 * we only want to have 32k of ram per block group for keeping
2793 * track of free space, and if we pass 1/2 of that we want to
2794 * start converting things over to using bitmaps
2796 ctl->extents_thresh = (SZ_32K / 2) / sizeof(struct btrfs_free_space);
2800 * for a given cluster, put all of its extents back into the free
2801 * space cache. If the block group passed doesn't match the block group
2802 * pointed to by the cluster, someone else raced in and freed the
2803 * cluster already. In that case, we just return without changing anything
2805 static void __btrfs_return_cluster_to_free_space(
2806 struct btrfs_block_group *block_group,
2807 struct btrfs_free_cluster *cluster)
2809 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
2810 struct btrfs_free_space *entry;
2811 struct rb_node *node;
2813 spin_lock(&cluster->lock);
2814 if (cluster->block_group != block_group) {
2815 spin_unlock(&cluster->lock);
2819 cluster->block_group = NULL;
2820 cluster->window_start = 0;
2821 list_del_init(&cluster->block_group_list);
2823 node = rb_first(&cluster->root);
2827 entry = rb_entry(node, struct btrfs_free_space, offset_index);
2828 node = rb_next(&entry->offset_index);
2829 rb_erase(&entry->offset_index, &cluster->root);
2830 RB_CLEAR_NODE(&entry->offset_index);
2832 bitmap = (entry->bitmap != NULL);
2834 /* Merging treats extents as if they were new */
2835 if (!btrfs_free_space_trimmed(entry)) {
2836 ctl->discardable_extents[BTRFS_STAT_CURR]--;
2837 ctl->discardable_bytes[BTRFS_STAT_CURR] -=
2841 try_merge_free_space(ctl, entry, false);
2842 steal_from_bitmap(ctl, entry, false);
2844 /* As we insert directly, update these statistics */
2845 if (!btrfs_free_space_trimmed(entry)) {
2846 ctl->discardable_extents[BTRFS_STAT_CURR]++;
2847 ctl->discardable_bytes[BTRFS_STAT_CURR] +=
2851 tree_insert_offset(&ctl->free_space_offset,
2852 entry->offset, &entry->offset_index, bitmap);
2854 cluster->root = RB_ROOT;
2855 spin_unlock(&cluster->lock);
2856 btrfs_put_block_group(block_group);
2859 static void __btrfs_remove_free_space_cache_locked(
2860 struct btrfs_free_space_ctl *ctl)
2862 struct btrfs_free_space *info;
2863 struct rb_node *node;
2865 while ((node = rb_last(&ctl->free_space_offset)) != NULL) {
2866 info = rb_entry(node, struct btrfs_free_space, offset_index);
2867 if (!info->bitmap) {
2868 unlink_free_space(ctl, info);
2869 kmem_cache_free(btrfs_free_space_cachep, info);
2871 free_bitmap(ctl, info);
2874 cond_resched_lock(&ctl->tree_lock);
2878 void __btrfs_remove_free_space_cache(struct btrfs_free_space_ctl *ctl)
2880 spin_lock(&ctl->tree_lock);
2881 __btrfs_remove_free_space_cache_locked(ctl);
2883 btrfs_discard_update_discardable(ctl->private);
2884 spin_unlock(&ctl->tree_lock);
2887 void btrfs_remove_free_space_cache(struct btrfs_block_group *block_group)
2889 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
2890 struct btrfs_free_cluster *cluster;
2891 struct list_head *head;
2893 spin_lock(&ctl->tree_lock);
2894 while ((head = block_group->cluster_list.next) !=
2895 &block_group->cluster_list) {
2896 cluster = list_entry(head, struct btrfs_free_cluster,
2899 WARN_ON(cluster->block_group != block_group);
2900 __btrfs_return_cluster_to_free_space(block_group, cluster);
2902 cond_resched_lock(&ctl->tree_lock);
2904 __btrfs_remove_free_space_cache_locked(ctl);
2905 btrfs_discard_update_discardable(block_group);
2906 spin_unlock(&ctl->tree_lock);
2911 * btrfs_is_free_space_trimmed - see if everything is trimmed
2912 * @block_group: block_group of interest
2914 * Walk @block_group's free space rb_tree to determine if everything is trimmed.
2916 bool btrfs_is_free_space_trimmed(struct btrfs_block_group *block_group)
2918 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
2919 struct btrfs_free_space *info;
2920 struct rb_node *node;
2923 spin_lock(&ctl->tree_lock);
2924 node = rb_first(&ctl->free_space_offset);
2927 info = rb_entry(node, struct btrfs_free_space, offset_index);
2929 if (!btrfs_free_space_trimmed(info)) {
2934 node = rb_next(node);
2937 spin_unlock(&ctl->tree_lock);
2941 u64 btrfs_find_space_for_alloc(struct btrfs_block_group *block_group,
2942 u64 offset, u64 bytes, u64 empty_size,
2943 u64 *max_extent_size)
2945 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
2946 struct btrfs_discard_ctl *discard_ctl =
2947 &block_group->fs_info->discard_ctl;
2948 struct btrfs_free_space *entry = NULL;
2949 u64 bytes_search = bytes + empty_size;
2952 u64 align_gap_len = 0;
2953 enum btrfs_trim_state align_gap_trim_state = BTRFS_TRIM_STATE_UNTRIMMED;
2955 ASSERT(!btrfs_is_zoned(block_group->fs_info));
2957 spin_lock(&ctl->tree_lock);
2958 entry = find_free_space(ctl, &offset, &bytes_search,
2959 block_group->full_stripe_len, max_extent_size);
2964 if (entry->bitmap) {
2965 bitmap_clear_bits(ctl, entry, offset, bytes);
2967 if (!btrfs_free_space_trimmed(entry))
2968 atomic64_add(bytes, &discard_ctl->discard_bytes_saved);
2971 free_bitmap(ctl, entry);
2973 unlink_free_space(ctl, entry);
2974 align_gap_len = offset - entry->offset;
2975 align_gap = entry->offset;
2976 align_gap_trim_state = entry->trim_state;
2978 if (!btrfs_free_space_trimmed(entry))
2979 atomic64_add(bytes, &discard_ctl->discard_bytes_saved);
2981 entry->offset = offset + bytes;
2982 WARN_ON(entry->bytes < bytes + align_gap_len);
2984 entry->bytes -= bytes + align_gap_len;
2986 kmem_cache_free(btrfs_free_space_cachep, entry);
2988 link_free_space(ctl, entry);
2991 btrfs_discard_update_discardable(block_group);
2992 spin_unlock(&ctl->tree_lock);
2995 __btrfs_add_free_space(block_group->fs_info, ctl,
2996 align_gap, align_gap_len,
2997 align_gap_trim_state);
3002 * given a cluster, put all of its extents back into the free space
3003 * cache. If a block group is passed, this function will only free
3004 * a cluster that belongs to the passed block group.
3006 * Otherwise, it'll get a reference on the block group pointed to by the
3007 * cluster and remove the cluster from it.
3009 void btrfs_return_cluster_to_free_space(
3010 struct btrfs_block_group *block_group,
3011 struct btrfs_free_cluster *cluster)
3013 struct btrfs_free_space_ctl *ctl;
3015 /* first, get a safe pointer to the block group */
3016 spin_lock(&cluster->lock);
3018 block_group = cluster->block_group;
3020 spin_unlock(&cluster->lock);
3023 } else if (cluster->block_group != block_group) {
3024 /* someone else has already freed it don't redo their work */
3025 spin_unlock(&cluster->lock);
3028 btrfs_get_block_group(block_group);
3029 spin_unlock(&cluster->lock);
3031 ctl = block_group->free_space_ctl;
3033 /* now return any extents the cluster had on it */
3034 spin_lock(&ctl->tree_lock);
3035 __btrfs_return_cluster_to_free_space(block_group, cluster);
3036 spin_unlock(&ctl->tree_lock);
3038 btrfs_discard_queue_work(&block_group->fs_info->discard_ctl, block_group);
3040 /* finally drop our ref */
3041 btrfs_put_block_group(block_group);
3044 static u64 btrfs_alloc_from_bitmap(struct btrfs_block_group *block_group,
3045 struct btrfs_free_cluster *cluster,
3046 struct btrfs_free_space *entry,
3047 u64 bytes, u64 min_start,
3048 u64 *max_extent_size)
3050 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3052 u64 search_start = cluster->window_start;
3053 u64 search_bytes = bytes;
3056 search_start = min_start;
3057 search_bytes = bytes;
3059 err = search_bitmap(ctl, entry, &search_start, &search_bytes, true);
3061 *max_extent_size = max(get_max_extent_size(entry),
3067 __bitmap_clear_bits(ctl, entry, ret, bytes);
3073 * given a cluster, try to allocate 'bytes' from it, returns 0
3074 * if it couldn't find anything suitably large, or a logical disk offset
3075 * if things worked out
3077 u64 btrfs_alloc_from_cluster(struct btrfs_block_group *block_group,
3078 struct btrfs_free_cluster *cluster, u64 bytes,
3079 u64 min_start, u64 *max_extent_size)
3081 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3082 struct btrfs_discard_ctl *discard_ctl =
3083 &block_group->fs_info->discard_ctl;
3084 struct btrfs_free_space *entry = NULL;
3085 struct rb_node *node;
3088 ASSERT(!btrfs_is_zoned(block_group->fs_info));
3090 spin_lock(&cluster->lock);
3091 if (bytes > cluster->max_size)
3094 if (cluster->block_group != block_group)
3097 node = rb_first(&cluster->root);
3101 entry = rb_entry(node, struct btrfs_free_space, offset_index);
3103 if (entry->bytes < bytes)
3104 *max_extent_size = max(get_max_extent_size(entry),
3107 if (entry->bytes < bytes ||
3108 (!entry->bitmap && entry->offset < min_start)) {
3109 node = rb_next(&entry->offset_index);
3112 entry = rb_entry(node, struct btrfs_free_space,
3117 if (entry->bitmap) {
3118 ret = btrfs_alloc_from_bitmap(block_group,
3119 cluster, entry, bytes,
3120 cluster->window_start,
3123 node = rb_next(&entry->offset_index);
3126 entry = rb_entry(node, struct btrfs_free_space,
3130 cluster->window_start += bytes;
3132 ret = entry->offset;
3134 entry->offset += bytes;
3135 entry->bytes -= bytes;
3141 spin_unlock(&cluster->lock);
3146 spin_lock(&ctl->tree_lock);
3148 if (!btrfs_free_space_trimmed(entry))
3149 atomic64_add(bytes, &discard_ctl->discard_bytes_saved);
3151 ctl->free_space -= bytes;
3152 if (!entry->bitmap && !btrfs_free_space_trimmed(entry))
3153 ctl->discardable_bytes[BTRFS_STAT_CURR] -= bytes;
3155 spin_lock(&cluster->lock);
3156 if (entry->bytes == 0) {
3157 rb_erase(&entry->offset_index, &cluster->root);
3158 ctl->free_extents--;
3159 if (entry->bitmap) {
3160 kmem_cache_free(btrfs_free_space_bitmap_cachep,
3162 ctl->total_bitmaps--;
3163 recalculate_thresholds(ctl);
3164 } else if (!btrfs_free_space_trimmed(entry)) {
3165 ctl->discardable_extents[BTRFS_STAT_CURR]--;
3167 kmem_cache_free(btrfs_free_space_cachep, entry);
3170 spin_unlock(&cluster->lock);
3171 spin_unlock(&ctl->tree_lock);
3176 static int btrfs_bitmap_cluster(struct btrfs_block_group *block_group,
3177 struct btrfs_free_space *entry,
3178 struct btrfs_free_cluster *cluster,
3179 u64 offset, u64 bytes,
3180 u64 cont1_bytes, u64 min_bytes)
3182 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3183 unsigned long next_zero;
3185 unsigned long want_bits;
3186 unsigned long min_bits;
3187 unsigned long found_bits;
3188 unsigned long max_bits = 0;
3189 unsigned long start = 0;
3190 unsigned long total_found = 0;
3193 i = offset_to_bit(entry->offset, ctl->unit,
3194 max_t(u64, offset, entry->offset));
3195 want_bits = bytes_to_bits(bytes, ctl->unit);
3196 min_bits = bytes_to_bits(min_bytes, ctl->unit);
3199 * Don't bother looking for a cluster in this bitmap if it's heavily
3202 if (entry->max_extent_size &&
3203 entry->max_extent_size < cont1_bytes)
3207 for_each_set_bit_from(i, entry->bitmap, BITS_PER_BITMAP) {
3208 next_zero = find_next_zero_bit(entry->bitmap,
3209 BITS_PER_BITMAP, i);
3210 if (next_zero - i >= min_bits) {
3211 found_bits = next_zero - i;
3212 if (found_bits > max_bits)
3213 max_bits = found_bits;
3216 if (next_zero - i > max_bits)
3217 max_bits = next_zero - i;
3222 entry->max_extent_size = (u64)max_bits * ctl->unit;
3228 cluster->max_size = 0;
3231 total_found += found_bits;
3233 if (cluster->max_size < found_bits * ctl->unit)
3234 cluster->max_size = found_bits * ctl->unit;
3236 if (total_found < want_bits || cluster->max_size < cont1_bytes) {
3241 cluster->window_start = start * ctl->unit + entry->offset;
3242 rb_erase(&entry->offset_index, &ctl->free_space_offset);
3243 ret = tree_insert_offset(&cluster->root, entry->offset,
3244 &entry->offset_index, 1);
3245 ASSERT(!ret); /* -EEXIST; Logic error */
3247 trace_btrfs_setup_cluster(block_group, cluster,
3248 total_found * ctl->unit, 1);
3253 * This searches the block group for just extents to fill the cluster with.
3254 * Try to find a cluster with at least bytes total bytes, at least one
3255 * extent of cont1_bytes, and other clusters of at least min_bytes.
3258 setup_cluster_no_bitmap(struct btrfs_block_group *block_group,
3259 struct btrfs_free_cluster *cluster,
3260 struct list_head *bitmaps, u64 offset, u64 bytes,
3261 u64 cont1_bytes, u64 min_bytes)
3263 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3264 struct btrfs_free_space *first = NULL;
3265 struct btrfs_free_space *entry = NULL;
3266 struct btrfs_free_space *last;
3267 struct rb_node *node;
3272 entry = tree_search_offset(ctl, offset, 0, 1);
3277 * We don't want bitmaps, so just move along until we find a normal
3280 while (entry->bitmap || entry->bytes < min_bytes) {
3281 if (entry->bitmap && list_empty(&entry->list))
3282 list_add_tail(&entry->list, bitmaps);
3283 node = rb_next(&entry->offset_index);
3286 entry = rb_entry(node, struct btrfs_free_space, offset_index);
3289 window_free = entry->bytes;
3290 max_extent = entry->bytes;
3294 for (node = rb_next(&entry->offset_index); node;
3295 node = rb_next(&entry->offset_index)) {
3296 entry = rb_entry(node, struct btrfs_free_space, offset_index);
3298 if (entry->bitmap) {
3299 if (list_empty(&entry->list))
3300 list_add_tail(&entry->list, bitmaps);
3304 if (entry->bytes < min_bytes)
3308 window_free += entry->bytes;
3309 if (entry->bytes > max_extent)
3310 max_extent = entry->bytes;
3313 if (window_free < bytes || max_extent < cont1_bytes)
3316 cluster->window_start = first->offset;
3318 node = &first->offset_index;
3321 * now we've found our entries, pull them out of the free space
3322 * cache and put them into the cluster rbtree
3327 entry = rb_entry(node, struct btrfs_free_space, offset_index);
3328 node = rb_next(&entry->offset_index);
3329 if (entry->bitmap || entry->bytes < min_bytes)
3332 rb_erase(&entry->offset_index, &ctl->free_space_offset);
3333 ret = tree_insert_offset(&cluster->root, entry->offset,
3334 &entry->offset_index, 0);
3335 total_size += entry->bytes;
3336 ASSERT(!ret); /* -EEXIST; Logic error */
3337 } while (node && entry != last);
3339 cluster->max_size = max_extent;
3340 trace_btrfs_setup_cluster(block_group, cluster, total_size, 0);
3345 * This specifically looks for bitmaps that may work in the cluster, we assume
3346 * that we have already failed to find extents that will work.
3349 setup_cluster_bitmap(struct btrfs_block_group *block_group,
3350 struct btrfs_free_cluster *cluster,
3351 struct list_head *bitmaps, u64 offset, u64 bytes,
3352 u64 cont1_bytes, u64 min_bytes)
3354 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3355 struct btrfs_free_space *entry = NULL;
3357 u64 bitmap_offset = offset_to_bitmap(ctl, offset);
3359 if (ctl->total_bitmaps == 0)
3363 * The bitmap that covers offset won't be in the list unless offset
3364 * is just its start offset.
3366 if (!list_empty(bitmaps))
3367 entry = list_first_entry(bitmaps, struct btrfs_free_space, list);
3369 if (!entry || entry->offset != bitmap_offset) {
3370 entry = tree_search_offset(ctl, bitmap_offset, 1, 0);
3371 if (entry && list_empty(&entry->list))
3372 list_add(&entry->list, bitmaps);
3375 list_for_each_entry(entry, bitmaps, list) {
3376 if (entry->bytes < bytes)
3378 ret = btrfs_bitmap_cluster(block_group, entry, cluster, offset,
3379 bytes, cont1_bytes, min_bytes);
3385 * The bitmaps list has all the bitmaps that record free space
3386 * starting after offset, so no more search is required.
3392 * here we try to find a cluster of blocks in a block group. The goal
3393 * is to find at least bytes+empty_size.
3394 * We might not find them all in one contiguous area.
3396 * returns zero and sets up cluster if things worked out, otherwise
3397 * it returns -enospc
3399 int btrfs_find_space_cluster(struct btrfs_block_group *block_group,
3400 struct btrfs_free_cluster *cluster,
3401 u64 offset, u64 bytes, u64 empty_size)
3403 struct btrfs_fs_info *fs_info = block_group->fs_info;
3404 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3405 struct btrfs_free_space *entry, *tmp;
3412 * Choose the minimum extent size we'll require for this
3413 * cluster. For SSD_SPREAD, don't allow any fragmentation.
3414 * For metadata, allow allocates with smaller extents. For
3415 * data, keep it dense.
3417 if (btrfs_test_opt(fs_info, SSD_SPREAD)) {
3418 cont1_bytes = min_bytes = bytes + empty_size;
3419 } else if (block_group->flags & BTRFS_BLOCK_GROUP_METADATA) {
3420 cont1_bytes = bytes;
3421 min_bytes = fs_info->sectorsize;
3423 cont1_bytes = max(bytes, (bytes + empty_size) >> 2);
3424 min_bytes = fs_info->sectorsize;
3427 spin_lock(&ctl->tree_lock);
3430 * If we know we don't have enough space to make a cluster don't even
3431 * bother doing all the work to try and find one.
3433 if (ctl->free_space < bytes) {
3434 spin_unlock(&ctl->tree_lock);
3438 spin_lock(&cluster->lock);
3440 /* someone already found a cluster, hooray */
3441 if (cluster->block_group) {
3446 trace_btrfs_find_cluster(block_group, offset, bytes, empty_size,
3449 ret = setup_cluster_no_bitmap(block_group, cluster, &bitmaps, offset,
3451 cont1_bytes, min_bytes);
3453 ret = setup_cluster_bitmap(block_group, cluster, &bitmaps,
3454 offset, bytes + empty_size,
3455 cont1_bytes, min_bytes);
3457 /* Clear our temporary list */
3458 list_for_each_entry_safe(entry, tmp, &bitmaps, list)
3459 list_del_init(&entry->list);
3462 btrfs_get_block_group(block_group);
3463 list_add_tail(&cluster->block_group_list,
3464 &block_group->cluster_list);
3465 cluster->block_group = block_group;
3467 trace_btrfs_failed_cluster_setup(block_group);
3470 spin_unlock(&cluster->lock);
3471 spin_unlock(&ctl->tree_lock);
3477 * simple code to zero out a cluster
3479 void btrfs_init_free_cluster(struct btrfs_free_cluster *cluster)
3481 spin_lock_init(&cluster->lock);
3482 spin_lock_init(&cluster->refill_lock);
3483 cluster->root = RB_ROOT;
3484 cluster->max_size = 0;
3485 cluster->fragmented = false;
3486 INIT_LIST_HEAD(&cluster->block_group_list);
3487 cluster->block_group = NULL;
3490 static int do_trimming(struct btrfs_block_group *block_group,
3491 u64 *total_trimmed, u64 start, u64 bytes,
3492 u64 reserved_start, u64 reserved_bytes,
3493 enum btrfs_trim_state reserved_trim_state,
3494 struct btrfs_trim_range *trim_entry)
3496 struct btrfs_space_info *space_info = block_group->space_info;
3497 struct btrfs_fs_info *fs_info = block_group->fs_info;
3498 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3501 const u64 end = start + bytes;
3502 const u64 reserved_end = reserved_start + reserved_bytes;
3503 enum btrfs_trim_state trim_state = BTRFS_TRIM_STATE_UNTRIMMED;
3506 spin_lock(&space_info->lock);
3507 spin_lock(&block_group->lock);
3508 if (!block_group->ro) {
3509 block_group->reserved += reserved_bytes;
3510 space_info->bytes_reserved += reserved_bytes;
3513 spin_unlock(&block_group->lock);
3514 spin_unlock(&space_info->lock);
3516 ret = btrfs_discard_extent(fs_info, start, bytes, &trimmed);
3518 *total_trimmed += trimmed;
3519 trim_state = BTRFS_TRIM_STATE_TRIMMED;
3522 mutex_lock(&ctl->cache_writeout_mutex);
3523 if (reserved_start < start)
3524 __btrfs_add_free_space(fs_info, ctl, reserved_start,
3525 start - reserved_start,
3526 reserved_trim_state);
3527 if (start + bytes < reserved_start + reserved_bytes)
3528 __btrfs_add_free_space(fs_info, ctl, end, reserved_end - end,
3529 reserved_trim_state);
3530 __btrfs_add_free_space(fs_info, ctl, start, bytes, trim_state);
3531 list_del(&trim_entry->list);
3532 mutex_unlock(&ctl->cache_writeout_mutex);
3535 spin_lock(&space_info->lock);
3536 spin_lock(&block_group->lock);
3537 if (block_group->ro)
3538 space_info->bytes_readonly += reserved_bytes;
3539 block_group->reserved -= reserved_bytes;
3540 space_info->bytes_reserved -= reserved_bytes;
3541 spin_unlock(&block_group->lock);
3542 spin_unlock(&space_info->lock);
3549 * If @async is set, then we will trim 1 region and return.
3551 static int trim_no_bitmap(struct btrfs_block_group *block_group,
3552 u64 *total_trimmed, u64 start, u64 end, u64 minlen,
3555 struct btrfs_discard_ctl *discard_ctl =
3556 &block_group->fs_info->discard_ctl;
3557 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3558 struct btrfs_free_space *entry;
3559 struct rb_node *node;
3563 enum btrfs_trim_state extent_trim_state;
3565 const u64 max_discard_size = READ_ONCE(discard_ctl->max_discard_size);
3567 while (start < end) {
3568 struct btrfs_trim_range trim_entry;
3570 mutex_lock(&ctl->cache_writeout_mutex);
3571 spin_lock(&ctl->tree_lock);
3573 if (ctl->free_space < minlen)
3576 entry = tree_search_offset(ctl, start, 0, 1);
3580 /* Skip bitmaps and if async, already trimmed entries */
3581 while (entry->bitmap ||
3582 (async && btrfs_free_space_trimmed(entry))) {
3583 node = rb_next(&entry->offset_index);
3586 entry = rb_entry(node, struct btrfs_free_space,
3590 if (entry->offset >= end)
3593 extent_start = entry->offset;
3594 extent_bytes = entry->bytes;
3595 extent_trim_state = entry->trim_state;
3597 start = entry->offset;
3598 bytes = entry->bytes;
3599 if (bytes < minlen) {
3600 spin_unlock(&ctl->tree_lock);
3601 mutex_unlock(&ctl->cache_writeout_mutex);
3604 unlink_free_space(ctl, entry);
3606 * Let bytes = BTRFS_MAX_DISCARD_SIZE + X.
3607 * If X < BTRFS_ASYNC_DISCARD_MIN_FILTER, we won't trim
3608 * X when we come back around. So trim it now.
3610 if (max_discard_size &&
3611 bytes >= (max_discard_size +
3612 BTRFS_ASYNC_DISCARD_MIN_FILTER)) {
3613 bytes = max_discard_size;
3614 extent_bytes = max_discard_size;
3615 entry->offset += max_discard_size;
3616 entry->bytes -= max_discard_size;
3617 link_free_space(ctl, entry);
3619 kmem_cache_free(btrfs_free_space_cachep, entry);
3622 start = max(start, extent_start);
3623 bytes = min(extent_start + extent_bytes, end) - start;
3624 if (bytes < minlen) {
3625 spin_unlock(&ctl->tree_lock);
3626 mutex_unlock(&ctl->cache_writeout_mutex);
3630 unlink_free_space(ctl, entry);
3631 kmem_cache_free(btrfs_free_space_cachep, entry);
3634 spin_unlock(&ctl->tree_lock);
3635 trim_entry.start = extent_start;
3636 trim_entry.bytes = extent_bytes;
3637 list_add_tail(&trim_entry.list, &ctl->trimming_ranges);
3638 mutex_unlock(&ctl->cache_writeout_mutex);
3640 ret = do_trimming(block_group, total_trimmed, start, bytes,
3641 extent_start, extent_bytes, extent_trim_state,
3644 block_group->discard_cursor = start + bytes;
3649 block_group->discard_cursor = start;
3650 if (async && *total_trimmed)
3653 if (fatal_signal_pending(current)) {
3664 block_group->discard_cursor = btrfs_block_group_end(block_group);
3665 spin_unlock(&ctl->tree_lock);
3666 mutex_unlock(&ctl->cache_writeout_mutex);
3672 * If we break out of trimming a bitmap prematurely, we should reset the
3673 * trimming bit. In a rather contrieved case, it's possible to race here so
3674 * reset the state to BTRFS_TRIM_STATE_UNTRIMMED.
3676 * start = start of bitmap
3677 * end = near end of bitmap
3679 * Thread 1: Thread 2:
3680 * trim_bitmaps(start)
3682 * end_trimming_bitmap()
3683 * reset_trimming_bitmap()
3685 static void reset_trimming_bitmap(struct btrfs_free_space_ctl *ctl, u64 offset)
3687 struct btrfs_free_space *entry;
3689 spin_lock(&ctl->tree_lock);
3690 entry = tree_search_offset(ctl, offset, 1, 0);
3692 if (btrfs_free_space_trimmed(entry)) {
3693 ctl->discardable_extents[BTRFS_STAT_CURR] +=
3694 entry->bitmap_extents;
3695 ctl->discardable_bytes[BTRFS_STAT_CURR] += entry->bytes;
3697 entry->trim_state = BTRFS_TRIM_STATE_UNTRIMMED;
3700 spin_unlock(&ctl->tree_lock);
3703 static void end_trimming_bitmap(struct btrfs_free_space_ctl *ctl,
3704 struct btrfs_free_space *entry)
3706 if (btrfs_free_space_trimming_bitmap(entry)) {
3707 entry->trim_state = BTRFS_TRIM_STATE_TRIMMED;
3708 ctl->discardable_extents[BTRFS_STAT_CURR] -=
3709 entry->bitmap_extents;
3710 ctl->discardable_bytes[BTRFS_STAT_CURR] -= entry->bytes;
3715 * If @async is set, then we will trim 1 region and return.
3717 static int trim_bitmaps(struct btrfs_block_group *block_group,
3718 u64 *total_trimmed, u64 start, u64 end, u64 minlen,
3719 u64 maxlen, bool async)
3721 struct btrfs_discard_ctl *discard_ctl =
3722 &block_group->fs_info->discard_ctl;
3723 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3724 struct btrfs_free_space *entry;
3728 u64 offset = offset_to_bitmap(ctl, start);
3729 const u64 max_discard_size = READ_ONCE(discard_ctl->max_discard_size);
3731 while (offset < end) {
3732 bool next_bitmap = false;
3733 struct btrfs_trim_range trim_entry;
3735 mutex_lock(&ctl->cache_writeout_mutex);
3736 spin_lock(&ctl->tree_lock);
3738 if (ctl->free_space < minlen) {
3739 block_group->discard_cursor =
3740 btrfs_block_group_end(block_group);
3741 spin_unlock(&ctl->tree_lock);
3742 mutex_unlock(&ctl->cache_writeout_mutex);
3746 entry = tree_search_offset(ctl, offset, 1, 0);
3748 * Bitmaps are marked trimmed lossily now to prevent constant
3749 * discarding of the same bitmap (the reason why we are bound
3750 * by the filters). So, retrim the block group bitmaps when we
3751 * are preparing to punt to the unused_bgs list. This uses
3752 * @minlen to determine if we are in BTRFS_DISCARD_INDEX_UNUSED
3753 * which is the only discard index which sets minlen to 0.
3755 if (!entry || (async && minlen && start == offset &&
3756 btrfs_free_space_trimmed(entry))) {
3757 spin_unlock(&ctl->tree_lock);
3758 mutex_unlock(&ctl->cache_writeout_mutex);
3764 * Async discard bitmap trimming begins at by setting the start
3765 * to be key.objectid and the offset_to_bitmap() aligns to the
3766 * start of the bitmap. This lets us know we are fully
3767 * scanning the bitmap rather than only some portion of it.
3769 if (start == offset)
3770 entry->trim_state = BTRFS_TRIM_STATE_TRIMMING;
3773 ret2 = search_bitmap(ctl, entry, &start, &bytes, false);
3774 if (ret2 || start >= end) {
3776 * We lossily consider a bitmap trimmed if we only skip
3777 * over regions <= BTRFS_ASYNC_DISCARD_MIN_FILTER.
3779 if (ret2 && minlen <= BTRFS_ASYNC_DISCARD_MIN_FILTER)
3780 end_trimming_bitmap(ctl, entry);
3782 entry->trim_state = BTRFS_TRIM_STATE_UNTRIMMED;
3783 spin_unlock(&ctl->tree_lock);
3784 mutex_unlock(&ctl->cache_writeout_mutex);
3790 * We already trimmed a region, but are using the locking above
3791 * to reset the trim_state.
3793 if (async && *total_trimmed) {
3794 spin_unlock(&ctl->tree_lock);
3795 mutex_unlock(&ctl->cache_writeout_mutex);
3799 bytes = min(bytes, end - start);
3800 if (bytes < minlen || (async && maxlen && bytes > maxlen)) {
3801 spin_unlock(&ctl->tree_lock);
3802 mutex_unlock(&ctl->cache_writeout_mutex);
3807 * Let bytes = BTRFS_MAX_DISCARD_SIZE + X.
3808 * If X < @minlen, we won't trim X when we come back around.
3809 * So trim it now. We differ here from trimming extents as we
3810 * don't keep individual state per bit.
3814 bytes > (max_discard_size + minlen))
3815 bytes = max_discard_size;
3817 bitmap_clear_bits(ctl, entry, start, bytes);
3818 if (entry->bytes == 0)
3819 free_bitmap(ctl, entry);
3821 spin_unlock(&ctl->tree_lock);
3822 trim_entry.start = start;
3823 trim_entry.bytes = bytes;
3824 list_add_tail(&trim_entry.list, &ctl->trimming_ranges);
3825 mutex_unlock(&ctl->cache_writeout_mutex);
3827 ret = do_trimming(block_group, total_trimmed, start, bytes,
3828 start, bytes, 0, &trim_entry);
3830 reset_trimming_bitmap(ctl, offset);
3831 block_group->discard_cursor =
3832 btrfs_block_group_end(block_group);
3837 offset += BITS_PER_BITMAP * ctl->unit;
3842 block_group->discard_cursor = start;
3844 if (fatal_signal_pending(current)) {
3845 if (start != offset)
3846 reset_trimming_bitmap(ctl, offset);
3855 block_group->discard_cursor = end;
3861 int btrfs_trim_block_group(struct btrfs_block_group *block_group,
3862 u64 *trimmed, u64 start, u64 end, u64 minlen)
3864 struct btrfs_free_space_ctl *ctl = block_group->free_space_ctl;
3868 ASSERT(!btrfs_is_zoned(block_group->fs_info));
3872 spin_lock(&block_group->lock);
3873 if (block_group->removed) {
3874 spin_unlock(&block_group->lock);
3877 btrfs_freeze_block_group(block_group);
3878 spin_unlock(&block_group->lock);
3880 ret = trim_no_bitmap(block_group, trimmed, start, end, minlen, false);
3884 ret = trim_bitmaps(block_group, trimmed, start, end, minlen, 0, false);
3885 div64_u64_rem(end, BITS_PER_BITMAP * ctl->unit, &rem);
3886 /* If we ended in the middle of a bitmap, reset the trimming flag */
3888 reset_trimming_bitmap(ctl, offset_to_bitmap(ctl, end));
3890 btrfs_unfreeze_block_group(block_group);
3894 int btrfs_trim_block_group_extents(struct btrfs_block_group *block_group,
3895 u64 *trimmed, u64 start, u64 end, u64 minlen,
3902 spin_lock(&block_group->lock);
3903 if (block_group->removed) {
3904 spin_unlock(&block_group->lock);
3907 btrfs_freeze_block_group(block_group);
3908 spin_unlock(&block_group->lock);
3910 ret = trim_no_bitmap(block_group, trimmed, start, end, minlen, async);
3911 btrfs_unfreeze_block_group(block_group);
3916 int btrfs_trim_block_group_bitmaps(struct btrfs_block_group *block_group,
3917 u64 *trimmed, u64 start, u64 end, u64 minlen,
3918 u64 maxlen, bool async)
3924 spin_lock(&block_group->lock);
3925 if (block_group->removed) {
3926 spin_unlock(&block_group->lock);
3929 btrfs_freeze_block_group(block_group);
3930 spin_unlock(&block_group->lock);
3932 ret = trim_bitmaps(block_group, trimmed, start, end, minlen, maxlen,
3935 btrfs_unfreeze_block_group(block_group);
3940 bool btrfs_free_space_cache_v1_active(struct btrfs_fs_info *fs_info)
3942 return btrfs_super_cache_generation(fs_info->super_copy);
3945 static int cleanup_free_space_cache_v1(struct btrfs_fs_info *fs_info,
3946 struct btrfs_trans_handle *trans)
3948 struct btrfs_block_group *block_group;
3949 struct rb_node *node;
3952 btrfs_info(fs_info, "cleaning free space cache v1");
3954 node = rb_first(&fs_info->block_group_cache_tree);
3956 block_group = rb_entry(node, struct btrfs_block_group, cache_node);
3957 ret = btrfs_remove_free_space_inode(trans, NULL, block_group);
3960 node = rb_next(node);
3966 int btrfs_set_free_space_cache_v1_active(struct btrfs_fs_info *fs_info, bool active)
3968 struct btrfs_trans_handle *trans;
3972 * update_super_roots will appropriately set or unset
3973 * super_copy->cache_generation based on SPACE_CACHE and
3974 * BTRFS_FS_CLEANUP_SPACE_CACHE_V1. For this reason, we need a
3975 * transaction commit whether we are enabling space cache v1 and don't
3976 * have any other work to do, or are disabling it and removing free
3979 trans = btrfs_start_transaction(fs_info->tree_root, 0);
3981 return PTR_ERR(trans);
3984 set_bit(BTRFS_FS_CLEANUP_SPACE_CACHE_V1, &fs_info->flags);
3985 ret = cleanup_free_space_cache_v1(fs_info, trans);
3987 btrfs_abort_transaction(trans, ret);
3988 btrfs_end_transaction(trans);
3993 ret = btrfs_commit_transaction(trans);
3995 clear_bit(BTRFS_FS_CLEANUP_SPACE_CACHE_V1, &fs_info->flags);
4000 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
4002 * Use this if you need to make a bitmap or extent entry specifically, it
4003 * doesn't do any of the merging that add_free_space does, this acts a lot like
4004 * how the free space cache loading stuff works, so you can get really weird
4007 int test_add_free_space_entry(struct btrfs_block_group *cache,
4008 u64 offset, u64 bytes, bool bitmap)
4010 struct btrfs_free_space_ctl *ctl = cache->free_space_ctl;
4011 struct btrfs_free_space *info = NULL, *bitmap_info;
4013 enum btrfs_trim_state trim_state = BTRFS_TRIM_STATE_TRIMMED;
4019 info = kmem_cache_zalloc(btrfs_free_space_cachep, GFP_NOFS);
4025 spin_lock(&ctl->tree_lock);
4026 info->offset = offset;
4027 info->bytes = bytes;
4028 info->max_extent_size = 0;
4029 ret = link_free_space(ctl, info);
4030 spin_unlock(&ctl->tree_lock);
4032 kmem_cache_free(btrfs_free_space_cachep, info);
4037 map = kmem_cache_zalloc(btrfs_free_space_bitmap_cachep, GFP_NOFS);
4039 kmem_cache_free(btrfs_free_space_cachep, info);
4044 spin_lock(&ctl->tree_lock);
4045 bitmap_info = tree_search_offset(ctl, offset_to_bitmap(ctl, offset),
4050 add_new_bitmap(ctl, info, offset);
4055 bytes_added = add_bytes_to_bitmap(ctl, bitmap_info, offset, bytes,
4058 bytes -= bytes_added;
4059 offset += bytes_added;
4060 spin_unlock(&ctl->tree_lock);
4066 kmem_cache_free(btrfs_free_space_cachep, info);
4068 kmem_cache_free(btrfs_free_space_bitmap_cachep, map);
4073 * Checks to see if the given range is in the free space cache. This is really
4074 * just used to check the absence of space, so if there is free space in the
4075 * range at all we will return 1.
4077 int test_check_exists(struct btrfs_block_group *cache,
4078 u64 offset, u64 bytes)
4080 struct btrfs_free_space_ctl *ctl = cache->free_space_ctl;
4081 struct btrfs_free_space *info;
4084 spin_lock(&ctl->tree_lock);
4085 info = tree_search_offset(ctl, offset, 0, 0);
4087 info = tree_search_offset(ctl, offset_to_bitmap(ctl, offset),
4095 u64 bit_off, bit_bytes;
4097 struct btrfs_free_space *tmp;
4100 bit_bytes = ctl->unit;
4101 ret = search_bitmap(ctl, info, &bit_off, &bit_bytes, false);
4103 if (bit_off == offset) {
4106 } else if (bit_off > offset &&
4107 offset + bytes > bit_off) {
4113 n = rb_prev(&info->offset_index);
4115 tmp = rb_entry(n, struct btrfs_free_space,
4117 if (tmp->offset + tmp->bytes < offset)
4119 if (offset + bytes < tmp->offset) {
4120 n = rb_prev(&tmp->offset_index);
4127 n = rb_next(&info->offset_index);
4129 tmp = rb_entry(n, struct btrfs_free_space,
4131 if (offset + bytes < tmp->offset)
4133 if (tmp->offset + tmp->bytes < offset) {
4134 n = rb_next(&tmp->offset_index);
4145 if (info->offset == offset) {
4150 if (offset > info->offset && offset < info->offset + info->bytes)
4153 spin_unlock(&ctl->tree_lock);
4156 #endif /* CONFIG_BTRFS_FS_RUN_SANITY_TESTS */