2 * Copyright (C) 2007 Oracle. All rights reserved.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
19 #include <linux/delay.h>
20 #include <linux/kthread.h>
21 #include <linux/pagemap.h>
25 #include "free-space-cache.h"
26 #include "inode-map.h"
27 #include "transaction.h"
29 static int caching_kthread(void *data)
31 struct btrfs_root *root = data;
32 struct btrfs_fs_info *fs_info = root->fs_info;
33 struct btrfs_free_space_ctl *ctl = root->free_ino_ctl;
35 struct btrfs_path *path;
36 struct extent_buffer *leaf;
41 if (!btrfs_test_opt(root, INODE_MAP_CACHE))
44 path = btrfs_alloc_path();
48 /* Since the commit root is read-only, we can safely skip locking. */
49 path->skip_locking = 1;
50 path->search_commit_root = 1;
53 key.objectid = BTRFS_FIRST_FREE_OBJECTID;
55 key.type = BTRFS_INODE_ITEM_KEY;
57 /* need to make sure the commit_root doesn't disappear */
58 down_read(&fs_info->commit_root_sem);
60 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
65 if (btrfs_fs_closing(fs_info))
68 leaf = path->nodes[0];
69 slot = path->slots[0];
70 if (slot >= btrfs_header_nritems(leaf)) {
71 ret = btrfs_next_leaf(root, path);
78 btrfs_transaction_in_commit(fs_info)) {
79 leaf = path->nodes[0];
81 if (WARN_ON(btrfs_header_nritems(leaf) == 0))
85 * Save the key so we can advances forward
88 btrfs_item_key_to_cpu(leaf, &key, 0);
89 btrfs_release_path(path);
90 root->ino_cache_progress = last;
91 up_read(&fs_info->commit_root_sem);
98 btrfs_item_key_to_cpu(leaf, &key, slot);
100 if (key.type != BTRFS_INODE_ITEM_KEY)
103 if (key.objectid >= root->highest_objectid)
106 if (last != (u64)-1 && last + 1 != key.objectid) {
107 __btrfs_add_free_space(ctl, last + 1,
108 key.objectid - last - 1);
109 wake_up(&root->ino_cache_wait);
117 if (last < root->highest_objectid - 1) {
118 __btrfs_add_free_space(ctl, last + 1,
119 root->highest_objectid - last - 1);
122 spin_lock(&root->ino_cache_lock);
123 root->ino_cache_state = BTRFS_CACHE_FINISHED;
124 spin_unlock(&root->ino_cache_lock);
126 root->ino_cache_progress = (u64)-1;
127 btrfs_unpin_free_ino(root);
129 wake_up(&root->ino_cache_wait);
130 up_read(&fs_info->commit_root_sem);
132 btrfs_free_path(path);
137 static void start_caching(struct btrfs_root *root)
139 struct btrfs_free_space_ctl *ctl = root->free_ino_ctl;
140 struct task_struct *tsk;
144 if (!btrfs_test_opt(root, INODE_MAP_CACHE))
147 spin_lock(&root->ino_cache_lock);
148 if (root->ino_cache_state != BTRFS_CACHE_NO) {
149 spin_unlock(&root->ino_cache_lock);
153 root->ino_cache_state = BTRFS_CACHE_STARTED;
154 spin_unlock(&root->ino_cache_lock);
156 ret = load_free_ino_cache(root->fs_info, root);
158 spin_lock(&root->ino_cache_lock);
159 root->ino_cache_state = BTRFS_CACHE_FINISHED;
160 spin_unlock(&root->ino_cache_lock);
165 * It can be quite time-consuming to fill the cache by searching
166 * through the extent tree, and this can keep ino allocation path
167 * waiting. Therefore at start we quickly find out the highest
168 * inode number and we know we can use inode numbers which fall in
169 * [highest_ino + 1, BTRFS_LAST_FREE_OBJECTID].
171 ret = btrfs_find_free_objectid(root, &objectid);
172 if (!ret && objectid <= BTRFS_LAST_FREE_OBJECTID) {
173 __btrfs_add_free_space(ctl, objectid,
174 BTRFS_LAST_FREE_OBJECTID - objectid + 1);
177 tsk = kthread_run(caching_kthread, root, "btrfs-ino-cache-%llu",
178 root->root_key.objectid);
180 btrfs_warn(root->fs_info, "failed to start inode caching task");
181 btrfs_clear_pending_and_info(root->fs_info, INODE_MAP_CACHE,
182 "disabling inode map caching");
186 int btrfs_find_free_ino(struct btrfs_root *root, u64 *objectid)
188 if (!btrfs_test_opt(root, INODE_MAP_CACHE))
189 return btrfs_find_free_objectid(root, objectid);
192 *objectid = btrfs_find_ino_for_alloc(root);
199 wait_event(root->ino_cache_wait,
200 root->ino_cache_state == BTRFS_CACHE_FINISHED ||
201 root->free_ino_ctl->free_space > 0);
203 if (root->ino_cache_state == BTRFS_CACHE_FINISHED &&
204 root->free_ino_ctl->free_space == 0)
210 void btrfs_return_ino(struct btrfs_root *root, u64 objectid)
212 struct btrfs_free_space_ctl *pinned = root->free_ino_pinned;
214 if (!btrfs_test_opt(root, INODE_MAP_CACHE))
217 if (root->ino_cache_state == BTRFS_CACHE_FINISHED) {
218 __btrfs_add_free_space(pinned, objectid, 1);
220 down_write(&root->fs_info->commit_root_sem);
221 spin_lock(&root->ino_cache_lock);
222 if (root->ino_cache_state == BTRFS_CACHE_FINISHED) {
223 spin_unlock(&root->ino_cache_lock);
224 up_write(&root->fs_info->commit_root_sem);
227 spin_unlock(&root->ino_cache_lock);
231 __btrfs_add_free_space(pinned, objectid, 1);
233 up_write(&root->fs_info->commit_root_sem);
238 * When a transaction is committed, we'll move those inode numbers which are
239 * smaller than root->ino_cache_progress from pinned tree to free_ino tree, and
240 * others will just be dropped, because the commit root we were searching has
243 * Must be called with root->fs_info->commit_root_sem held
245 void btrfs_unpin_free_ino(struct btrfs_root *root)
247 struct btrfs_free_space_ctl *ctl = root->free_ino_ctl;
248 struct rb_root *rbroot = &root->free_ino_pinned->free_space_offset;
249 struct btrfs_free_space *info;
253 if (!btrfs_test_opt(root, INODE_MAP_CACHE))
257 n = rb_first(rbroot);
261 info = rb_entry(n, struct btrfs_free_space, offset_index);
262 BUG_ON(info->bitmap); /* Logic error */
264 if (info->offset > root->ino_cache_progress)
266 else if (info->offset + info->bytes > root->ino_cache_progress)
267 count = root->ino_cache_progress - info->offset + 1;
271 __btrfs_add_free_space(ctl, info->offset, count);
273 rb_erase(&info->offset_index, rbroot);
274 kmem_cache_free(btrfs_free_space_cachep, info);
278 #define INIT_THRESHOLD (((1024 * 32) / 2) / sizeof(struct btrfs_free_space))
279 #define INODES_PER_BITMAP (PAGE_CACHE_SIZE * 8)
282 * The goal is to keep the memory used by the free_ino tree won't
283 * exceed the memory if we use bitmaps only.
285 static void recalculate_thresholds(struct btrfs_free_space_ctl *ctl)
287 struct btrfs_free_space *info;
292 n = rb_last(&ctl->free_space_offset);
294 ctl->extents_thresh = INIT_THRESHOLD;
297 info = rb_entry(n, struct btrfs_free_space, offset_index);
300 * Find the maximum inode number in the filesystem. Note we
301 * ignore the fact that this can be a bitmap, because we are
302 * not doing precise calculation.
304 max_ino = info->bytes - 1;
306 max_bitmaps = ALIGN(max_ino, INODES_PER_BITMAP) / INODES_PER_BITMAP;
307 if (max_bitmaps <= ctl->total_bitmaps) {
308 ctl->extents_thresh = 0;
312 ctl->extents_thresh = (max_bitmaps - ctl->total_bitmaps) *
313 PAGE_CACHE_SIZE / sizeof(*info);
317 * We don't fall back to bitmap, if we are below the extents threshold
318 * or this chunk of inode numbers is a big one.
320 static bool use_bitmap(struct btrfs_free_space_ctl *ctl,
321 struct btrfs_free_space *info)
323 if (ctl->free_extents < ctl->extents_thresh ||
324 info->bytes > INODES_PER_BITMAP / 10)
330 static struct btrfs_free_space_op free_ino_op = {
331 .recalc_thresholds = recalculate_thresholds,
332 .use_bitmap = use_bitmap,
335 static void pinned_recalc_thresholds(struct btrfs_free_space_ctl *ctl)
339 static bool pinned_use_bitmap(struct btrfs_free_space_ctl *ctl,
340 struct btrfs_free_space *info)
343 * We always use extents for two reasons:
345 * - The pinned tree is only used during the process of caching
347 * - Make code simpler. See btrfs_unpin_free_ino().
352 static struct btrfs_free_space_op pinned_free_ino_op = {
353 .recalc_thresholds = pinned_recalc_thresholds,
354 .use_bitmap = pinned_use_bitmap,
357 void btrfs_init_free_ino_ctl(struct btrfs_root *root)
359 struct btrfs_free_space_ctl *ctl = root->free_ino_ctl;
360 struct btrfs_free_space_ctl *pinned = root->free_ino_pinned;
362 spin_lock_init(&ctl->tree_lock);
366 ctl->op = &free_ino_op;
367 INIT_LIST_HEAD(&ctl->trimming_ranges);
368 mutex_init(&ctl->cache_writeout_mutex);
371 * Initially we allow to use 16K of ram to cache chunks of
372 * inode numbers before we resort to bitmaps. This is somewhat
373 * arbitrary, but it will be adjusted in runtime.
375 ctl->extents_thresh = INIT_THRESHOLD;
377 spin_lock_init(&pinned->tree_lock);
380 pinned->private = NULL;
381 pinned->extents_thresh = 0;
382 pinned->op = &pinned_free_ino_op;
385 int btrfs_save_ino_cache(struct btrfs_root *root,
386 struct btrfs_trans_handle *trans)
388 struct btrfs_free_space_ctl *ctl = root->free_ino_ctl;
389 struct btrfs_path *path;
391 struct btrfs_block_rsv *rsv;
398 /* only fs tree and subvol/snap needs ino cache */
399 if (root->root_key.objectid != BTRFS_FS_TREE_OBJECTID &&
400 (root->root_key.objectid < BTRFS_FIRST_FREE_OBJECTID ||
401 root->root_key.objectid > BTRFS_LAST_FREE_OBJECTID))
404 /* Don't save inode cache if we are deleting this root */
405 if (btrfs_root_refs(&root->root_item) == 0)
408 if (!btrfs_test_opt(root, INODE_MAP_CACHE))
411 path = btrfs_alloc_path();
415 rsv = trans->block_rsv;
416 trans->block_rsv = &root->fs_info->trans_block_rsv;
418 num_bytes = trans->bytes_reserved;
420 * 1 item for inode item insertion if need
421 * 4 items for inode item update (in the worst case)
422 * 1 items for slack space if we need do truncation
423 * 1 item for free space object
424 * 3 items for pre-allocation
426 trans->bytes_reserved = btrfs_calc_trans_metadata_size(root, 10);
427 ret = btrfs_block_rsv_add(root, trans->block_rsv,
428 trans->bytes_reserved,
429 BTRFS_RESERVE_NO_FLUSH);
432 trace_btrfs_space_reservation(root->fs_info, "ino_cache",
433 trans->transid, trans->bytes_reserved, 1);
435 inode = lookup_free_ino_inode(root, path);
436 if (IS_ERR(inode) && (PTR_ERR(inode) != -ENOENT || retry)) {
437 ret = PTR_ERR(inode);
442 BUG_ON(retry); /* Logic error */
445 ret = create_free_ino_inode(root, trans, path);
451 BTRFS_I(inode)->generation = 0;
452 ret = btrfs_update_inode(trans, root, inode);
454 btrfs_abort_transaction(trans, root, ret);
458 if (i_size_read(inode) > 0) {
459 ret = btrfs_truncate_free_space_cache(root, trans, NULL, inode);
462 btrfs_abort_transaction(trans, root, ret);
467 spin_lock(&root->ino_cache_lock);
468 if (root->ino_cache_state != BTRFS_CACHE_FINISHED) {
470 spin_unlock(&root->ino_cache_lock);
473 spin_unlock(&root->ino_cache_lock);
475 spin_lock(&ctl->tree_lock);
476 prealloc = sizeof(struct btrfs_free_space) * ctl->free_extents;
477 prealloc = ALIGN(prealloc, PAGE_CACHE_SIZE);
478 prealloc += ctl->total_bitmaps * PAGE_CACHE_SIZE;
479 spin_unlock(&ctl->tree_lock);
481 /* Just to make sure we have enough space */
482 prealloc += 8 * PAGE_CACHE_SIZE;
484 ret = btrfs_delalloc_reserve_space(inode, prealloc);
488 ret = btrfs_prealloc_file_range_trans(inode, trans, 0, 0, prealloc,
489 prealloc, prealloc, &alloc_hint);
491 btrfs_delalloc_release_space(inode, prealloc);
494 btrfs_free_reserved_data_space(inode, prealloc);
496 ret = btrfs_write_out_ino_cache(root, trans, path, inode);
500 trace_btrfs_space_reservation(root->fs_info, "ino_cache",
501 trans->transid, trans->bytes_reserved, 0);
502 btrfs_block_rsv_release(root, trans->block_rsv, trans->bytes_reserved);
504 trans->block_rsv = rsv;
505 trans->bytes_reserved = num_bytes;
507 btrfs_free_path(path);
511 static int btrfs_find_highest_objectid(struct btrfs_root *root, u64 *objectid)
513 struct btrfs_path *path;
515 struct extent_buffer *l;
516 struct btrfs_key search_key;
517 struct btrfs_key found_key;
520 path = btrfs_alloc_path();
524 search_key.objectid = BTRFS_LAST_FREE_OBJECTID;
525 search_key.type = -1;
526 search_key.offset = (u64)-1;
527 ret = btrfs_search_slot(NULL, root, &search_key, path, 0, 0);
530 BUG_ON(ret == 0); /* Corruption */
531 if (path->slots[0] > 0) {
532 slot = path->slots[0] - 1;
534 btrfs_item_key_to_cpu(l, &found_key, slot);
535 *objectid = max_t(u64, found_key.objectid,
536 BTRFS_FIRST_FREE_OBJECTID - 1);
538 *objectid = BTRFS_FIRST_FREE_OBJECTID - 1;
542 btrfs_free_path(path);
546 int btrfs_find_free_objectid(struct btrfs_root *root, u64 *objectid)
549 mutex_lock(&root->objectid_mutex);
551 if (unlikely(root->highest_objectid < BTRFS_FIRST_FREE_OBJECTID)) {
552 ret = btrfs_find_highest_objectid(root,
553 &root->highest_objectid);
558 if (unlikely(root->highest_objectid >= BTRFS_LAST_FREE_OBJECTID)) {
563 *objectid = ++root->highest_objectid;
566 mutex_unlock(&root->objectid_mutex);