2 * bmap.c - NILFS block mapping.
4 * Copyright (C) 2006-2008 Nippon Telegraph and Telephone Corporation.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * Written by Koji Sato.
20 #include <linux/string.h>
21 #include <linux/errno.h>
31 struct inode *nilfs_bmap_get_dat(const struct nilfs_bmap *bmap)
33 struct the_nilfs *nilfs = bmap->b_inode->i_sb->s_fs_info;
38 static int nilfs_bmap_convert_error(struct nilfs_bmap *bmap,
39 const char *fname, int err)
41 struct inode *inode = bmap->b_inode;
44 __nilfs_error(inode->i_sb, fname,
45 "broken bmap (inode number=%lu)", inode->i_ino);
52 * nilfs_bmap_lookup_at_level - find a data block or node block
56 * @ptrp: place to store the value associated to @key
58 * Description: nilfs_bmap_lookup_at_level() finds a record whose key
59 * matches @key in the block at @level of the bmap.
61 * Return Value: On success, 0 is returned and the record associated with @key
62 * is stored in the place pointed by @ptrp. On error, one of the following
63 * negative error codes is returned.
67 * %-ENOMEM - Insufficient amount of memory available.
69 * %-ENOENT - A record associated with @key does not exist.
71 int nilfs_bmap_lookup_at_level(struct nilfs_bmap *bmap, __u64 key, int level,
77 down_read(&bmap->b_sem);
78 ret = bmap->b_ops->bop_lookup(bmap, key, level, ptrp);
82 if (NILFS_BMAP_USE_VBN(bmap)) {
83 ret = nilfs_dat_translate(nilfs_bmap_get_dat(bmap), *ptrp,
87 else if (ret == -ENOENT) {
89 * If there was no valid entry in DAT for the block
90 * address obtained by b_ops->bop_lookup, then pass
91 * internal code -EINVAL to nilfs_bmap_convert_error
92 * to treat it as metadata corruption.
99 up_read(&bmap->b_sem);
100 return nilfs_bmap_convert_error(bmap, __func__, ret);
103 int nilfs_bmap_lookup_contig(struct nilfs_bmap *bmap, __u64 key, __u64 *ptrp,
104 unsigned int maxblocks)
108 down_read(&bmap->b_sem);
109 ret = bmap->b_ops->bop_lookup_contig(bmap, key, ptrp, maxblocks);
110 up_read(&bmap->b_sem);
112 return nilfs_bmap_convert_error(bmap, __func__, ret);
115 static int nilfs_bmap_do_insert(struct nilfs_bmap *bmap, __u64 key, __u64 ptr)
117 __u64 keys[NILFS_BMAP_SMALL_HIGH + 1];
118 __u64 ptrs[NILFS_BMAP_SMALL_HIGH + 1];
121 if (bmap->b_ops->bop_check_insert != NULL) {
122 ret = bmap->b_ops->bop_check_insert(bmap, key);
124 n = bmap->b_ops->bop_gather_data(
125 bmap, keys, ptrs, NILFS_BMAP_SMALL_HIGH + 1);
128 ret = nilfs_btree_convert_and_insert(
129 bmap, key, ptr, keys, ptrs, n);
131 bmap->b_u.u_flags |= NILFS_BMAP_LARGE;
138 return bmap->b_ops->bop_insert(bmap, key, ptr);
142 * nilfs_bmap_insert - insert a new key-record pair into a bmap
147 * Description: nilfs_bmap_insert() inserts the new key-record pair specified
148 * by @key and @rec into @bmap.
150 * Return Value: On success, 0 is returned. On error, one of the following
151 * negative error codes is returned.
155 * %-ENOMEM - Insufficient amount of memory available.
157 * %-EEXIST - A record associated with @key already exist.
159 int nilfs_bmap_insert(struct nilfs_bmap *bmap, __u64 key, unsigned long rec)
163 down_write(&bmap->b_sem);
164 ret = nilfs_bmap_do_insert(bmap, key, rec);
165 up_write(&bmap->b_sem);
167 return nilfs_bmap_convert_error(bmap, __func__, ret);
170 static int nilfs_bmap_do_delete(struct nilfs_bmap *bmap, __u64 key)
172 __u64 keys[NILFS_BMAP_LARGE_LOW + 1];
173 __u64 ptrs[NILFS_BMAP_LARGE_LOW + 1];
176 if (bmap->b_ops->bop_check_delete != NULL) {
177 ret = bmap->b_ops->bop_check_delete(bmap, key);
179 n = bmap->b_ops->bop_gather_data(
180 bmap, keys, ptrs, NILFS_BMAP_LARGE_LOW + 1);
183 ret = nilfs_direct_delete_and_convert(
184 bmap, key, keys, ptrs, n);
186 bmap->b_u.u_flags &= ~NILFS_BMAP_LARGE;
193 return bmap->b_ops->bop_delete(bmap, key);
197 * nilfs_bmap_seek_key - seek a valid entry and return its key
199 * @start: start key number
200 * @keyp: place to store valid key
202 * Description: nilfs_bmap_seek_key() seeks a valid key on @bmap
203 * starting from @start, and stores it to @keyp if found.
205 * Return Value: On success, 0 is returned. On error, one of the following
206 * negative error codes is returned.
210 * %-ENOMEM - Insufficient amount of memory available.
212 * %-ENOENT - No valid entry was found
214 int nilfs_bmap_seek_key(struct nilfs_bmap *bmap, __u64 start, __u64 *keyp)
218 down_read(&bmap->b_sem);
219 ret = bmap->b_ops->bop_seek_key(bmap, start, keyp);
220 up_read(&bmap->b_sem);
223 ret = nilfs_bmap_convert_error(bmap, __func__, ret);
227 int nilfs_bmap_last_key(struct nilfs_bmap *bmap, __u64 *keyp)
231 down_read(&bmap->b_sem);
232 ret = bmap->b_ops->bop_last_key(bmap, keyp);
233 up_read(&bmap->b_sem);
236 ret = nilfs_bmap_convert_error(bmap, __func__, ret);
241 * nilfs_bmap_delete - delete a key-record pair from a bmap
245 * Description: nilfs_bmap_delete() deletes the key-record pair specified by
248 * Return Value: On success, 0 is returned. On error, one of the following
249 * negative error codes is returned.
253 * %-ENOMEM - Insufficient amount of memory available.
255 * %-ENOENT - A record associated with @key does not exist.
257 int nilfs_bmap_delete(struct nilfs_bmap *bmap, __u64 key)
261 down_write(&bmap->b_sem);
262 ret = nilfs_bmap_do_delete(bmap, key);
263 up_write(&bmap->b_sem);
265 return nilfs_bmap_convert_error(bmap, __func__, ret);
268 static int nilfs_bmap_do_truncate(struct nilfs_bmap *bmap, __u64 key)
273 ret = bmap->b_ops->bop_last_key(bmap, &lastkey);
280 while (key <= lastkey) {
281 ret = nilfs_bmap_do_delete(bmap, lastkey);
284 ret = bmap->b_ops->bop_last_key(bmap, &lastkey);
295 * nilfs_bmap_truncate - truncate a bmap to a specified key
299 * Description: nilfs_bmap_truncate() removes key-record pairs whose keys are
300 * greater than or equal to @key from @bmap.
302 * Return Value: On success, 0 is returned. On error, one of the following
303 * negative error codes is returned.
307 * %-ENOMEM - Insufficient amount of memory available.
309 int nilfs_bmap_truncate(struct nilfs_bmap *bmap, __u64 key)
313 down_write(&bmap->b_sem);
314 ret = nilfs_bmap_do_truncate(bmap, key);
315 up_write(&bmap->b_sem);
317 return nilfs_bmap_convert_error(bmap, __func__, ret);
321 * nilfs_bmap_clear - free resources a bmap holds
324 * Description: nilfs_bmap_clear() frees resources associated with @bmap.
326 void nilfs_bmap_clear(struct nilfs_bmap *bmap)
328 down_write(&bmap->b_sem);
329 if (bmap->b_ops->bop_clear != NULL)
330 bmap->b_ops->bop_clear(bmap);
331 up_write(&bmap->b_sem);
335 * nilfs_bmap_propagate - propagate dirty state
339 * Description: nilfs_bmap_propagate() marks the buffers that directly or
340 * indirectly refer to the block specified by @bh dirty.
342 * Return Value: On success, 0 is returned. On error, one of the following
343 * negative error codes is returned.
347 * %-ENOMEM - Insufficient amount of memory available.
349 int nilfs_bmap_propagate(struct nilfs_bmap *bmap, struct buffer_head *bh)
353 down_write(&bmap->b_sem);
354 ret = bmap->b_ops->bop_propagate(bmap, bh);
355 up_write(&bmap->b_sem);
357 return nilfs_bmap_convert_error(bmap, __func__, ret);
361 * nilfs_bmap_lookup_dirty_buffers -
363 * @listp: pointer to buffer head list
365 void nilfs_bmap_lookup_dirty_buffers(struct nilfs_bmap *bmap,
366 struct list_head *listp)
368 if (bmap->b_ops->bop_lookup_dirty_buffers != NULL)
369 bmap->b_ops->bop_lookup_dirty_buffers(bmap, listp);
373 * nilfs_bmap_assign - assign a new block number to a block
375 * @bhp: pointer to buffer head
376 * @blocknr: block number
377 * @binfo: block information
379 * Description: nilfs_bmap_assign() assigns the block number @blocknr to the
380 * buffer specified by @bh.
382 * Return Value: On success, 0 is returned and the buffer head of a newly
383 * create buffer and the block information associated with the buffer are
384 * stored in the place pointed by @bh and @binfo, respectively. On error, one
385 * of the following negative error codes is returned.
389 * %-ENOMEM - Insufficient amount of memory available.
391 int nilfs_bmap_assign(struct nilfs_bmap *bmap,
392 struct buffer_head **bh,
393 unsigned long blocknr,
394 union nilfs_binfo *binfo)
398 down_write(&bmap->b_sem);
399 ret = bmap->b_ops->bop_assign(bmap, bh, blocknr, binfo);
400 up_write(&bmap->b_sem);
402 return nilfs_bmap_convert_error(bmap, __func__, ret);
406 * nilfs_bmap_mark - mark block dirty
411 * Description: nilfs_bmap_mark() marks the block specified by @key and @level
414 * Return Value: On success, 0 is returned. On error, one of the following
415 * negative error codes is returned.
419 * %-ENOMEM - Insufficient amount of memory available.
421 int nilfs_bmap_mark(struct nilfs_bmap *bmap, __u64 key, int level)
425 if (bmap->b_ops->bop_mark == NULL)
428 down_write(&bmap->b_sem);
429 ret = bmap->b_ops->bop_mark(bmap, key, level);
430 up_write(&bmap->b_sem);
432 return nilfs_bmap_convert_error(bmap, __func__, ret);
436 * nilfs_bmap_test_and_clear_dirty - test and clear a bmap dirty state
439 * Description: nilfs_test_and_clear() is the atomic operation to test and
440 * clear the dirty state of @bmap.
442 * Return Value: 1 is returned if @bmap is dirty, or 0 if clear.
444 int nilfs_bmap_test_and_clear_dirty(struct nilfs_bmap *bmap)
448 down_write(&bmap->b_sem);
449 ret = nilfs_bmap_dirty(bmap);
450 nilfs_bmap_clear_dirty(bmap);
451 up_write(&bmap->b_sem);
459 __u64 nilfs_bmap_data_get_key(const struct nilfs_bmap *bmap,
460 const struct buffer_head *bh)
462 struct buffer_head *pbh;
465 key = page_index(bh->b_page) << (PAGE_SHIFT -
466 bmap->b_inode->i_blkbits);
467 for (pbh = page_buffers(bh->b_page); pbh != bh; pbh = pbh->b_this_page)
473 __u64 nilfs_bmap_find_target_seq(const struct nilfs_bmap *bmap, __u64 key)
477 diff = key - bmap->b_last_allocated_key;
478 if ((nilfs_bmap_keydiff_abs(diff) < NILFS_INODE_BMAP_SIZE) &&
479 (bmap->b_last_allocated_ptr != NILFS_BMAP_INVALID_PTR) &&
480 (bmap->b_last_allocated_ptr + diff > 0))
481 return bmap->b_last_allocated_ptr + diff;
483 return NILFS_BMAP_INVALID_PTR;
486 #define NILFS_BMAP_GROUP_DIV 8
487 __u64 nilfs_bmap_find_target_in_group(const struct nilfs_bmap *bmap)
489 struct inode *dat = nilfs_bmap_get_dat(bmap);
490 unsigned long entries_per_group = nilfs_palloc_entries_per_group(dat);
491 unsigned long group = bmap->b_inode->i_ino / entries_per_group;
493 return group * entries_per_group +
494 (bmap->b_inode->i_ino % NILFS_BMAP_GROUP_DIV) *
495 (entries_per_group / NILFS_BMAP_GROUP_DIV);
498 static struct lock_class_key nilfs_bmap_dat_lock_key;
499 static struct lock_class_key nilfs_bmap_mdt_lock_key;
502 * nilfs_bmap_read - read a bmap from an inode
504 * @raw_inode: on-disk inode
506 * Description: nilfs_bmap_read() initializes the bmap @bmap.
508 * Return Value: On success, 0 is returned. On error, the following negative
509 * error code is returned.
511 * %-ENOMEM - Insufficient amount of memory available.
513 int nilfs_bmap_read(struct nilfs_bmap *bmap, struct nilfs_inode *raw_inode)
515 if (raw_inode == NULL)
516 memset(bmap->b_u.u_data, 0, NILFS_BMAP_SIZE);
518 memcpy(bmap->b_u.u_data, raw_inode->i_bmap, NILFS_BMAP_SIZE);
520 init_rwsem(&bmap->b_sem);
522 bmap->b_inode = &NILFS_BMAP_I(bmap)->vfs_inode;
523 switch (bmap->b_inode->i_ino) {
525 bmap->b_ptr_type = NILFS_BMAP_PTR_P;
526 bmap->b_last_allocated_key = 0;
527 bmap->b_last_allocated_ptr = NILFS_BMAP_NEW_PTR_INIT;
528 lockdep_set_class(&bmap->b_sem, &nilfs_bmap_dat_lock_key);
530 case NILFS_CPFILE_INO:
531 case NILFS_SUFILE_INO:
532 bmap->b_ptr_type = NILFS_BMAP_PTR_VS;
533 bmap->b_last_allocated_key = 0;
534 bmap->b_last_allocated_ptr = NILFS_BMAP_INVALID_PTR;
535 lockdep_set_class(&bmap->b_sem, &nilfs_bmap_mdt_lock_key);
537 case NILFS_IFILE_INO:
538 lockdep_set_class(&bmap->b_sem, &nilfs_bmap_mdt_lock_key);
541 bmap->b_ptr_type = NILFS_BMAP_PTR_VM;
542 bmap->b_last_allocated_key = 0;
543 bmap->b_last_allocated_ptr = NILFS_BMAP_INVALID_PTR;
547 return (bmap->b_u.u_flags & NILFS_BMAP_LARGE) ?
548 nilfs_btree_init(bmap) : nilfs_direct_init(bmap);
552 * nilfs_bmap_write - write back a bmap to an inode
554 * @raw_inode: on-disk inode
556 * Description: nilfs_bmap_write() stores @bmap in @raw_inode.
558 void nilfs_bmap_write(struct nilfs_bmap *bmap, struct nilfs_inode *raw_inode)
560 down_write(&bmap->b_sem);
561 memcpy(raw_inode->i_bmap, bmap->b_u.u_data,
562 NILFS_INODE_BMAP_SIZE * sizeof(__le64));
563 if (bmap->b_inode->i_ino == NILFS_DAT_INO)
564 bmap->b_last_allocated_ptr = NILFS_BMAP_NEW_PTR_INIT;
566 up_write(&bmap->b_sem);
569 void nilfs_bmap_init_gc(struct nilfs_bmap *bmap)
571 memset(&bmap->b_u, 0, NILFS_BMAP_SIZE);
572 init_rwsem(&bmap->b_sem);
573 bmap->b_inode = &NILFS_BMAP_I(bmap)->vfs_inode;
574 bmap->b_ptr_type = NILFS_BMAP_PTR_U;
575 bmap->b_last_allocated_key = 0;
576 bmap->b_last_allocated_ptr = NILFS_BMAP_INVALID_PTR;
578 nilfs_btree_init_gc(bmap);
581 void nilfs_bmap_save(const struct nilfs_bmap *bmap,
582 struct nilfs_bmap_store *store)
584 memcpy(store->data, bmap->b_u.u_data, sizeof(store->data));
585 store->last_allocated_key = bmap->b_last_allocated_key;
586 store->last_allocated_ptr = bmap->b_last_allocated_ptr;
587 store->state = bmap->b_state;
590 void nilfs_bmap_restore(struct nilfs_bmap *bmap,
591 const struct nilfs_bmap_store *store)
593 memcpy(bmap->b_u.u_data, store->data, sizeof(store->data));
594 bmap->b_last_allocated_key = store->last_allocated_key;
595 bmap->b_last_allocated_ptr = store->last_allocated_ptr;
596 bmap->b_state = store->state;