4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 * Top-level entry points into iam module
34 * Author: Wang Di <wangdi@clusterfs.com>
35 * Author: Nikita Danilov <nikita@clusterfs.com>
39 * iam: big theory statement.
41 * iam (Index Access Module) is a module providing abstraction of persistent
42 * transactional container on top of generalized ldiskfs htree.
46 * - key, pointer, and record size specifiable per container.
48 * - trees taller than 2 index levels.
50 * - read/write to existing ldiskfs htree directories as iam containers.
52 * iam container is a tree, consisting of leaf nodes containing keys and
53 * records stored in this container, and index nodes, containing keys and
54 * pointers to leaf or index nodes.
56 * iam does not work with keys directly, instead it calls user-supplied key
57 * comparison function (->dpo_keycmp()).
59 * Pointers are (currently) interpreted as logical offsets (measured in
60 * blocksful) within underlying flat file on top of which iam tree lives.
64 * iam mostly tries to reuse existing htree formats.
66 * Format of index node:
68 * +-----+-------+-------+-------+------+-------+------------+
69 * | | count | | | | | |
70 * | gap | / | entry | entry | .... | entry | free space |
71 * | | limit | | | | | |
72 * +-----+-------+-------+-------+------+-------+------------+
74 * gap this part of node is never accessed by iam code. It
75 * exists for binary compatibility with ldiskfs htree (that,
76 * in turn, stores fake struct ext2_dirent for ext2
77 * compatibility), and to keep some unspecified per-node
78 * data. Gap can be different for root and non-root index
79 * nodes. Gap size can be specified for each container
80 * (gap of 0 is allowed).
82 * count/limit current number of entries in this node, and the maximal
83 * number of entries that can fit into node. count/limit
84 * has the same size as entry, and is itself counted in
87 * entry index entry: consists of a key immediately followed by
88 * a pointer to a child node. Size of a key and size of a
89 * pointer depends on container. Entry has neither
90 * alignment nor padding.
92 * free space portion of node new entries are added to
94 * Entries in index node are sorted by their key value.
96 * Format of a leaf node is not specified. Generic iam code accesses leaf
97 * nodes through ->id_leaf methods in struct iam_descr.
99 * The IAM root block is a special node, which contains the IAM descriptor.
100 * It is on disk format:
102 * +---------+-------+--------+---------+-------+------+-------+------------+
103 * |IAM desc | count | idle | | | | | |
104 * |(fix/var)| / | blocks | padding | entry | .... | entry | free space |
105 * | | limit | | | | | | |
106 * +---------+-------+--------+---------+-------+------+-------+------------+
108 * The padding length is calculated with the parameters in the IAM descriptor.
110 * The field "idle_blocks" is used to record empty leaf nodes, which have not
111 * been released but all contained entries in them have been removed. Usually,
112 * the idle blocks in the IAM should be reused when need to allocate new leaf
113 * nodes for new entries, it depends on the IAM hash functions to map the new
114 * entries to these idle blocks. Unfortunately, it is not easy to design some
115 * hash functions for such clever mapping, especially considering the insert/
116 * lookup performance.
118 * So the IAM recycles the empty leaf nodes, and put them into a per-file based
119 * idle blocks pool. If need some new leaf node, it will try to take idle block
120 * from such pool with priority, in spite of how the IAM hash functions to map
123 * The idle blocks pool is organized as a series of tables, and each table
124 * can be described as following (on-disk format):
126 * +---------+---------+---------+---------+------+---------+-------+
127 * | magic | count | next | logic | | logic | free |
128 * |(16 bits)|(16 bits)| table | blk # | .... | blk # | space |
129 * | | |(32 bits)|(32 bits)| |(32 bits)| |
130 * +---------+---------+---------+---------+------+---------+-------+
132 * The logic blk# for the first table is stored in the root node "idle_blocks".
136 #include <linux/module.h>
137 #include <linux/fs.h>
138 #include <linux/pagemap.h>
139 #include <linux/time.h>
140 #include <linux/fcntl.h>
141 #include <linux/stat.h>
142 #include <linux/string.h>
143 #include <linux/quotaops.h>
144 #include <linux/buffer_head.h>
146 #include <ldiskfs/ldiskfs.h>
147 #include <ldiskfs/xattr.h>
150 #include "osd_internal.h"
152 #include <ldiskfs/acl.h>
154 static struct buffer_head *
155 iam_load_idle_blocks(struct iam_container *c, iam_ptr_t blk)
157 struct inode *inode = c->ic_object;
158 struct iam_idle_head *head;
159 struct buffer_head *bh;
161 LASSERT(mutex_is_locked(&c->ic_idle_mutex));
166 bh = __ldiskfs_bread(NULL, inode, blk, 0);
167 if (IS_ERR_OR_NULL(bh)) {
168 CERROR("%s: cannot load idle blocks, blk = %u: rc = %ld\n",
169 osd_ino2name(inode), blk, bh ? PTR_ERR(bh) : -EIO);
170 c->ic_idle_failed = 1;
176 head = (struct iam_idle_head *)(bh->b_data);
177 if (le16_to_cpu(head->iih_magic) != IAM_IDLE_HEADER_MAGIC) {
180 CERROR("%s: invalid idle block head, blk = %u, magic = %x: rc = %d\n",
181 osd_ino2name(inode), blk, le16_to_cpu(head->iih_magic),
184 c->ic_idle_failed = 1;
192 * Determine format of given container. This is done by scanning list of
193 * registered formats and calling ->if_guess() method of each in turn.
195 static int iam_format_guess(struct iam_container *c)
199 result = iam_lvar_guess(c);
201 result = iam_lfix_guess(c);
204 struct buffer_head *bh;
207 LASSERT(c->ic_root_bh != NULL);
209 idle_blocks = (__u32 *)(c->ic_root_bh->b_data +
210 c->ic_descr->id_root_gap +
211 sizeof(struct dx_countlimit));
212 mutex_lock(&c->ic_idle_mutex);
213 bh = iam_load_idle_blocks(c, le32_to_cpu(*idle_blocks));
214 if (bh != NULL && IS_ERR(bh))
215 result = PTR_ERR(bh);
218 mutex_unlock(&c->ic_idle_mutex);
225 * Initialize container @c.
227 int iam_container_init(struct iam_container *c,
228 struct iam_descr *descr, struct inode *inode)
230 memset(c, 0, sizeof *c);
232 c->ic_object = inode;
233 dynlock_init(&c->ic_tree_lock);
234 mutex_init(&c->ic_idle_mutex);
239 * Determine container format.
241 int iam_container_setup(struct iam_container *c)
243 return iam_format_guess(c);
247 * Finalize container @c, release all resources.
249 void iam_container_fini(struct iam_container *c)
251 brelse(c->ic_idle_bh);
252 c->ic_idle_bh = NULL;
253 brelse(c->ic_root_bh);
254 c->ic_root_bh = NULL;
257 void iam_path_init(struct iam_path *path, struct iam_container *c,
258 struct iam_path_descr *pd)
260 memset(path, 0, sizeof *path);
261 path->ip_container = c;
262 path->ip_frame = path->ip_frames;
264 path->ip_leaf.il_path = path;
267 static void iam_leaf_fini(struct iam_leaf *leaf);
269 void iam_path_release(struct iam_path *path)
273 for (i = 0; i < ARRAY_SIZE(path->ip_frames); i++) {
274 if (path->ip_frames[i].bh != NULL) {
275 path->ip_frames[i].at_shifted = 0;
276 brelse(path->ip_frames[i].bh);
277 path->ip_frames[i].bh = NULL;
282 void iam_path_fini(struct iam_path *path)
284 iam_leaf_fini(&path->ip_leaf);
285 iam_path_release(path);
289 void iam_path_compat_init(struct iam_path_compat *path, struct inode *inode)
293 path->ipc_hinfo = &path->ipc_hinfo_area;
294 for (i = 0; i < ARRAY_SIZE(path->ipc_scratch); ++i)
295 path->ipc_descr.ipd_key_scratch[i] =
296 (struct iam_ikey *)&path->ipc_scratch[i];
298 iam_path_init(&path->ipc_path, &path->ipc_container, &path->ipc_descr);
301 void iam_path_compat_fini(struct iam_path_compat *path)
303 iam_path_fini(&path->ipc_path);
307 * Helper function initializing iam_path_descr and its key scratch area.
309 struct iam_path_descr *iam_ipd_alloc(void *area, int keysize)
311 struct iam_path_descr *ipd;
317 for (i = 0; i < ARRAY_SIZE(ipd->ipd_key_scratch); ++i, karea += keysize)
318 ipd->ipd_key_scratch[i] = karea;
322 void iam_ipd_free(struct iam_path_descr *ipd)
326 int iam_node_read(struct iam_container *c, iam_ptr_t ptr,
327 handle_t *h, struct buffer_head **bh)
330 * NB: it can be called by iam_lfix_guess() which is still at
331 * very early stage, c->ic_root_bh and c->ic_descr->id_ops
332 * haven't been intialized yet.
333 * Also, we don't have this for IAM dir.
335 if (c->ic_root_bh != NULL &&
336 c->ic_descr->id_ops->id_root_ptr(c) == ptr) {
337 get_bh(c->ic_root_bh);
342 *bh = __ldiskfs_bread(h, c->ic_object, (int)ptr, 0);
353 * Return pointer to current leaf record. Pointer is valid while corresponding
354 * leaf node is locked and pinned.
356 static struct iam_rec *iam_leaf_rec(const struct iam_leaf *leaf)
358 return iam_leaf_ops(leaf)->rec(leaf);
362 * Return pointer to the current leaf key. This function returns pointer to
363 * the key stored in node.
365 * Caller should assume that returned pointer is only valid while leaf node is
368 static struct iam_key *iam_leaf_key(const struct iam_leaf *leaf)
370 return iam_leaf_ops(leaf)->key(leaf);
373 static int iam_leaf_key_size(const struct iam_leaf *leaf)
375 return iam_leaf_ops(leaf)->key_size(leaf);
378 static struct iam_ikey *iam_leaf_ikey(const struct iam_leaf *leaf,
379 struct iam_ikey *key)
381 return iam_leaf_ops(leaf)->ikey(leaf, key);
384 static int iam_leaf_keycmp(const struct iam_leaf *leaf,
385 const struct iam_key *key)
387 return iam_leaf_ops(leaf)->key_cmp(leaf, key);
390 static int iam_leaf_keyeq(const struct iam_leaf *leaf,
391 const struct iam_key *key)
393 return iam_leaf_ops(leaf)->key_eq(leaf, key);
396 #if LDISKFS_INVARIANT_ON
397 static int iam_path_check(struct iam_path *p)
402 struct iam_descr *param;
405 param = iam_path_descr(p);
406 for (i = 0; result && i < ARRAY_SIZE(p->ip_frames); ++i) {
407 f = &p->ip_frames[i];
409 result = dx_node_check(p, f);
411 result = !param->id_ops->id_node_check(p, f);
414 if (result && p->ip_leaf.il_bh != NULL)
417 ldiskfs_std_error(iam_path_obj(p)->i_sb, result);
423 static int iam_leaf_load(struct iam_path *path)
427 struct iam_container *c;
428 struct buffer_head *bh;
429 struct iam_leaf *leaf;
430 struct iam_descr *descr;
432 c = path->ip_container;
433 leaf = &path->ip_leaf;
434 descr = iam_path_descr(path);
435 block = path->ip_frame->leaf;
438 printk(KERN_EMERG "wrong leaf: %lu %d [%p %p %p]\n",
439 (long unsigned)path->ip_frame->leaf,
440 dx_get_count(dx_node_get_entries(path, path->ip_frame)),
441 path->ip_frames[0].bh, path->ip_frames[1].bh,
442 path->ip_frames[2].bh);
444 err = descr->id_ops->id_node_read(c, block, NULL, &bh);
447 leaf->il_curidx = block;
448 err = iam_leaf_ops(leaf)->init(leaf);
453 static void iam_unlock_htree(struct iam_container *ic,
454 struct dynlock_handle *lh)
457 dynlock_unlock(&ic->ic_tree_lock, lh);
461 static void iam_leaf_unlock(struct iam_leaf *leaf)
463 if (leaf->il_lock != NULL) {
464 iam_unlock_htree(iam_leaf_container(leaf),
467 leaf->il_lock = NULL;
471 static void iam_leaf_fini(struct iam_leaf *leaf)
473 if (leaf->il_path != NULL) {
474 iam_leaf_unlock(leaf);
475 iam_leaf_ops(leaf)->fini(leaf);
484 static void iam_leaf_start(struct iam_leaf *folio)
486 iam_leaf_ops(folio)->start(folio);
489 void iam_leaf_next(struct iam_leaf *folio)
491 iam_leaf_ops(folio)->next(folio);
494 static void iam_leaf_rec_add(struct iam_leaf *leaf, const struct iam_key *key,
495 const struct iam_rec *rec)
497 iam_leaf_ops(leaf)->rec_add(leaf, key, rec);
500 static void iam_rec_del(struct iam_leaf *leaf, int shift)
502 iam_leaf_ops(leaf)->rec_del(leaf, shift);
505 int iam_leaf_at_end(const struct iam_leaf *leaf)
507 return iam_leaf_ops(leaf)->at_end(leaf);
510 static void iam_leaf_split(struct iam_leaf *l, struct buffer_head **bh,
513 iam_leaf_ops(l)->split(l, bh, nr);
516 static inline int iam_leaf_empty(struct iam_leaf *l)
518 return iam_leaf_ops(l)->leaf_empty(l);
521 int iam_leaf_can_add(const struct iam_leaf *l,
522 const struct iam_key *k, const struct iam_rec *r)
524 return iam_leaf_ops(l)->can_add(l, k, r);
527 static int iam_txn_dirty(handle_t *handle,
528 struct iam_path *path, struct buffer_head *bh)
532 result = ldiskfs_handle_dirty_metadata(handle, NULL, bh);
534 ldiskfs_std_error(iam_path_obj(path)->i_sb, result);
538 static int iam_txn_add(handle_t *handle,
539 struct iam_path *path, struct buffer_head *bh)
542 struct super_block *sb = iam_path_obj(path)->i_sb;
544 result = osd_ldiskfs_journal_get_write_access(handle, sb, bh,
547 ldiskfs_std_error(sb, result);
551 /***********************************************************************/
552 /* iterator interface */
553 /***********************************************************************/
555 static enum iam_it_state it_state(const struct iam_iterator *it)
561 * Helper function returning scratch key.
563 static struct iam_container *iam_it_container(const struct iam_iterator *it)
565 return it->ii_path.ip_container;
568 static inline int it_keycmp(const struct iam_iterator *it,
569 const struct iam_key *k)
571 return iam_leaf_keycmp(&it->ii_path.ip_leaf, k);
574 static inline int it_keyeq(const struct iam_iterator *it,
575 const struct iam_key *k)
577 return iam_leaf_keyeq(&it->ii_path.ip_leaf, k);
580 static int it_ikeycmp(const struct iam_iterator *it, const struct iam_ikey *ik)
582 return iam_ikeycmp(it->ii_path.ip_container,
583 iam_leaf_ikey(&it->ii_path.ip_leaf,
584 iam_path_ikey(&it->ii_path, 0)), ik);
587 static inline int it_at_rec(const struct iam_iterator *it)
589 return !iam_leaf_at_end(&it->ii_path.ip_leaf);
592 static inline int it_before(const struct iam_iterator *it)
594 return it_state(it) == IAM_IT_SKEWED && it_at_rec(it);
598 * Helper wrapper around iam_it_get(): returns 0 (success) only when record
599 * with exactly the same key as asked is found.
601 static int iam_it_get_exact(struct iam_iterator *it, const struct iam_key *k)
605 result = iam_it_get(it, k);
608 else if (result == 0)
610 * Return -ENOENT if cursor is located above record with a key
611 * different from one specified, or in the empty leaf.
613 * XXX returning -ENOENT only works if iam_it_get() never
614 * returns -ENOENT as a legitimate error.
621 * Initialize iterator to IAM_IT_DETACHED state.
623 * postcondition: it_state(it) == IAM_IT_DETACHED
625 int iam_it_init(struct iam_iterator *it, struct iam_container *c, __u32 flags,
626 struct iam_path_descr *pd)
628 memset(it, 0, sizeof *it);
629 it->ii_flags = flags;
630 it->ii_state = IAM_IT_DETACHED;
631 iam_path_init(&it->ii_path, c, pd);
636 * Finalize iterator and release all resources.
638 * precondition: it_state(it) == IAM_IT_DETACHED
640 void iam_it_fini(struct iam_iterator *it)
642 assert_corr(it_state(it) == IAM_IT_DETACHED);
643 iam_path_fini(&it->ii_path);
647 * this locking primitives are used to protect parts
648 * of dir's htree. protection unit is block: leaf or index
650 static struct dynlock_handle *iam_lock_htree(struct iam_container *ic,
652 enum dynlock_type lt)
654 return dynlock_lock(&ic->ic_tree_lock, value, lt, GFP_NOFS);
657 static int iam_index_lock(struct iam_path *path, struct dynlock_handle **lh)
661 for (f = path->ip_frame; f >= path->ip_frames; --f, ++lh) {
663 *lh = iam_lock_htree(path->ip_container, f->curidx, DLT_READ);
671 * Fast check for frame consistency.
673 static int iam_check_fast(struct iam_path *path, struct iam_frame *frame)
675 struct iam_container *bag;
676 struct iam_entry *next;
677 struct iam_entry *last;
678 struct iam_entry *entries;
679 struct iam_entry *at;
681 bag = path->ip_container;
683 entries = frame->entries;
684 last = iam_entry_shift(path, entries, dx_get_count(entries) - 1);
686 if (unlikely(at > last))
689 if (unlikely(dx_get_block(path, at) != frame->leaf))
692 if (unlikely(iam_ikeycmp(bag, iam_ikey_at(path, at),
693 path->ip_ikey_target) > 0))
696 next = iam_entry_shift(path, at, +1);
698 if (unlikely(iam_ikeycmp(bag, iam_ikey_at(path, next),
699 path->ip_ikey_target) <= 0))
705 int dx_index_is_compat(struct iam_path *path)
707 return iam_path_descr(path) == NULL;
713 * search position of specified hash in index
717 static struct iam_entry *iam_find_position(struct iam_path *path,
718 struct iam_frame *frame)
725 count = dx_get_count(frame->entries);
726 assert_corr(count && count <= dx_get_limit(frame->entries));
727 p = iam_entry_shift(path, frame->entries,
728 dx_index_is_compat(path) ? 1 : 2);
729 q = iam_entry_shift(path, frame->entries, count - 1);
731 m = iam_entry_shift(path, p, iam_entry_diff(path, q, p) / 2);
732 if (iam_ikeycmp(path->ip_container, iam_ikey_at(path, m),
733 path->ip_ikey_target) > 0)
734 q = iam_entry_shift(path, m, -1);
736 p = iam_entry_shift(path, m, +1);
738 return iam_entry_shift(path, p, -1);
743 static iam_ptr_t iam_find_ptr(struct iam_path *path, struct iam_frame *frame)
745 return dx_get_block(path, iam_find_position(path, frame));
748 void iam_insert_key(struct iam_path *path, struct iam_frame *frame,
749 const struct iam_ikey *key, iam_ptr_t ptr)
751 struct iam_entry *entries = frame->entries;
752 struct iam_entry *new = iam_entry_shift(path, frame->at, +1);
753 int count = dx_get_count(entries);
756 * Unfortunately we cannot assert this, as this function is sometimes
757 * called by VFS under i_sem and without pdirops lock.
759 assert_corr(1 || iam_frame_is_locked(path, frame));
760 assert_corr(count < dx_get_limit(entries));
761 assert_corr(frame->at < iam_entry_shift(path, entries, count));
762 assert_inv(dx_node_check(path, frame));
763 /* Prevent memory corruption outside of buffer_head */
764 BUG_ON(count >= dx_get_limit(entries));
765 BUG_ON((char *)iam_entry_shift(path, entries, count + 1) >
766 (frame->bh->b_data + frame->bh->b_size));
768 memmove(iam_entry_shift(path, new, 1), new,
769 (char *)iam_entry_shift(path, entries, count) - (char *)new);
770 dx_set_ikey(path, new, key);
771 dx_set_block(path, new, ptr);
772 dx_set_count(entries, count + 1);
774 BUG_ON(count > dx_get_limit(entries));
775 assert_inv(dx_node_check(path, frame));
778 void iam_insert_key_lock(struct iam_path *path, struct iam_frame *frame,
779 const struct iam_ikey *key, iam_ptr_t ptr)
781 iam_lock_bh(frame->bh);
782 iam_insert_key(path, frame, key, ptr);
783 iam_unlock_bh(frame->bh);
786 * returns 0 if path was unchanged, -EAGAIN otherwise.
788 static int iam_check_path(struct iam_path *path, struct iam_frame *frame)
792 iam_lock_bh(frame->bh);
793 equal = iam_check_fast(path, frame) == 0 ||
794 frame->leaf == iam_find_ptr(path, frame);
795 DX_DEVAL(iam_lock_stats.dls_bh_again += !equal);
796 iam_unlock_bh(frame->bh);
798 return equal ? 0 : -EAGAIN;
801 static int iam_lookup_try(struct iam_path *path)
807 struct iam_descr *param;
808 struct iam_frame *frame;
809 struct iam_container *c;
811 param = iam_path_descr(path);
812 c = path->ip_container;
814 ptr = param->id_ops->id_root_ptr(c);
815 for (frame = path->ip_frames, i = 0; i <= path->ip_indirect;
817 err = param->id_ops->id_node_read(c, (iam_ptr_t)ptr, NULL,
821 iam_lock_bh(frame->bh);
823 * node must be initialized under bh lock because concurrent
824 * creation procedure may change it and iam_lookup_try() will
825 * see obsolete tree height. -bzzz
830 if (LDISKFS_INVARIANT_ON) {
831 err = param->id_ops->id_node_check(path, frame);
836 err = param->id_ops->id_node_load(path, frame);
840 assert_inv(dx_node_check(path, frame));
842 * splitting may change root index block and move hash we're
843 * looking for into another index block so, we have to check
844 * this situation and repeat from begining if path got changed
848 err = iam_check_path(path, frame - 1);
853 frame->at = iam_find_position(path, frame);
855 frame->leaf = ptr = dx_get_block(path, frame->at);
857 iam_unlock_bh(frame->bh);
861 iam_unlock_bh(frame->bh);
862 path->ip_frame = --frame;
866 static int __iam_path_lookup(struct iam_path *path)
871 for (i = 0; i < DX_MAX_TREE_HEIGHT; ++ i)
872 assert(path->ip_frames[i].bh == NULL);
875 err = iam_lookup_try(path);
879 } while (err == -EAGAIN);
885 * returns 0 if path was unchanged, -EAGAIN otherwise.
887 static int iam_check_full_path(struct iam_path *path, int search)
889 struct iam_frame *bottom;
890 struct iam_frame *scan;
896 for (bottom = path->ip_frames, i = 0;
897 i < DX_MAX_TREE_HEIGHT && bottom->bh != NULL; ++bottom, ++i) {
898 ; /* find last filled in frame */
902 * Lock frames, bottom to top.
904 for (scan = bottom - 1; scan >= path->ip_frames; --scan)
905 iam_lock_bh(scan->bh);
907 * Check them top to bottom.
910 for (scan = path->ip_frames; scan < bottom; ++scan) {
911 struct iam_entry *pos;
914 if (iam_check_fast(path, scan) == 0)
917 pos = iam_find_position(path, scan);
918 if (scan->leaf != dx_get_block(path, pos)) {
924 pos = iam_entry_shift(path, scan->entries,
925 dx_get_count(scan->entries) - 1);
926 if (scan->at > pos ||
927 scan->leaf != dx_get_block(path, scan->at)) {
935 * Unlock top to bottom.
937 for (scan = path->ip_frames; scan < bottom; ++scan)
938 iam_unlock_bh(scan->bh);
939 DX_DEVAL(iam_lock_stats.dls_bh_full_again += !!result);
947 * Performs path lookup and returns with found leaf (if any) locked by htree
950 static int iam_lookup_lock(struct iam_path *path,
951 struct dynlock_handle **dl, enum dynlock_type lt)
955 while ((result = __iam_path_lookup(path)) == 0) {
957 *dl = iam_lock_htree(path->ip_container, path->ip_frame->leaf,
966 * while locking leaf we just found may get split so we need
967 * to check this -bzzz
969 if (iam_check_full_path(path, 1) == 0)
971 iam_unlock_htree(path->ip_container, *dl);
978 * Performs tree top-to-bottom traversal starting from root, and loads leaf
981 static int iam_path_lookup(struct iam_path *path, int index)
983 struct iam_leaf *leaf;
986 leaf = &path->ip_leaf;
987 result = iam_lookup_lock(path, &leaf->il_lock, DLT_WRITE);
988 assert_inv(iam_path_check(path));
991 result = iam_leaf_load(path);
995 result = iam_leaf_ops(leaf)->
996 ilookup(leaf, path->ip_ikey_target);
998 result = iam_leaf_ops(leaf)->
999 lookup(leaf, path->ip_key_target);
1000 do_corr(schedule());
1003 iam_leaf_unlock(leaf);
1009 * Common part of iam_it_{i,}get().
1011 static int __iam_it_get(struct iam_iterator *it, int index)
1015 assert_corr(it_state(it) == IAM_IT_DETACHED);
1017 result = iam_path_lookup(&it->ii_path, index);
1021 collision = result & IAM_LOOKUP_LAST;
1022 switch (result & ~IAM_LOOKUP_LAST) {
1023 case IAM_LOOKUP_EXACT:
1025 it->ii_state = IAM_IT_ATTACHED;
1029 it->ii_state = IAM_IT_ATTACHED;
1031 case IAM_LOOKUP_BEFORE:
1032 case IAM_LOOKUP_EMPTY:
1034 it->ii_state = IAM_IT_SKEWED;
1039 result |= collision;
1042 * See iam_it_get_exact() for explanation.
1044 assert_corr(result != -ENOENT);
1049 * Correct hash, but not the same key was found, iterate through hash
1050 * collision chain, looking for correct record.
1052 static int iam_it_collision(struct iam_iterator *it)
1056 assert(ergo(it_at_rec(it), !it_keyeq(it, it->ii_path.ip_key_target)));
1058 while ((result = iam_it_next(it)) == 0) {
1059 do_corr(schedule());
1060 if (it_ikeycmp(it, it->ii_path.ip_ikey_target) != 0)
1062 if (it_keyeq(it, it->ii_path.ip_key_target))
1069 * Attach iterator. After successful completion, @it points to record with
1070 * least key not larger than @k.
1072 * Return value: 0: positioned on existing record,
1073 * +ve: exact position found,
1076 * precondition: it_state(it) == IAM_IT_DETACHED
1077 * postcondition: ergo(result == 0 && it_state(it) == IAM_IT_ATTACHED,
1078 * it_keycmp(it, k) <= 0)
1080 int iam_it_get(struct iam_iterator *it, const struct iam_key *k)
1084 assert_corr(it_state(it) == IAM_IT_DETACHED);
1086 it->ii_path.ip_ikey_target = NULL;
1087 it->ii_path.ip_key_target = k;
1089 result = __iam_it_get(it, 0);
1091 if (result == IAM_LOOKUP_LAST) {
1092 result = iam_it_collision(it);
1096 result = __iam_it_get(it, 0);
1101 result &= ~IAM_LOOKUP_LAST;
1103 assert_corr(ergo(result > 0, it_keycmp(it, k) == 0));
1104 assert_corr(ergo(result == 0 && it_state(it) == IAM_IT_ATTACHED,
1105 it_keycmp(it, k) <= 0));
1110 * Attach iterator by index key.
1112 static int iam_it_iget(struct iam_iterator *it, const struct iam_ikey *k)
1114 assert_corr(it_state(it) == IAM_IT_DETACHED);
1116 it->ii_path.ip_ikey_target = k;
1117 return __iam_it_get(it, 1) & ~IAM_LOOKUP_LAST;
1121 * Attach iterator, and assure it points to the record (not skewed).
1123 * Return value: 0: positioned on existing record,
1124 * +ve: exact position found,
1127 * precondition: it_state(it) == IAM_IT_DETACHED &&
1128 * !(it->ii_flags&IAM_IT_WRITE)
1129 * postcondition: ergo(result == 0, it_state(it) == IAM_IT_ATTACHED)
1131 int iam_it_get_at(struct iam_iterator *it, const struct iam_key *k)
1135 assert_corr(it_state(it) == IAM_IT_DETACHED &&
1136 !(it->ii_flags&IAM_IT_WRITE));
1137 result = iam_it_get(it, k);
1139 if (it_state(it) != IAM_IT_ATTACHED) {
1140 assert_corr(it_state(it) == IAM_IT_SKEWED);
1141 result = iam_it_next(it);
1144 assert_corr(ergo(result >= 0, it_state(it) == IAM_IT_ATTACHED));
1149 * Duplicates iterator.
1151 * postcondition: it_state(dst) == it_state(src) &&
1152 * iam_it_container(dst) == iam_it_container(src) &&
1153 * dst->ii_flags = src->ii_flags &&
1154 * ergo(it_state(src) == IAM_IT_ATTACHED,
1155 * iam_it_rec_get(dst) == iam_it_rec_get(src) &&
1156 * iam_it_key_get(dst) == iam_it_key_get(src))
1158 void iam_it_dup(struct iam_iterator *dst, const struct iam_iterator *src)
1160 dst->ii_flags = src->ii_flags;
1161 dst->ii_state = src->ii_state;
1162 /* XXX not yet. iam_path_dup(&dst->ii_path, &src->ii_path); */
1164 * XXX: duplicate lock.
1166 assert_corr(it_state(dst) == it_state(src));
1167 assert_corr(iam_it_container(dst) == iam_it_container(src));
1168 assert_corr(dst->ii_flags = src->ii_flags);
1169 assert_corr(ergo(it_state(src) == IAM_IT_ATTACHED,
1170 iam_it_rec_get(dst) == iam_it_rec_get(src) &&
1171 iam_it_key_get(dst) == iam_it_key_get(src)));
1175 * Detach iterator. Does nothing it detached state.
1177 * postcondition: it_state(it) == IAM_IT_DETACHED
1179 void iam_it_put(struct iam_iterator *it)
1181 if (it->ii_state != IAM_IT_DETACHED) {
1182 it->ii_state = IAM_IT_DETACHED;
1183 iam_leaf_fini(&it->ii_path.ip_leaf);
1187 static struct iam_ikey *iam_it_ikey_get(const struct iam_iterator *it,
1188 struct iam_ikey *ikey);
1192 * This function increments the frame pointer to search the next leaf
1193 * block, and reads in the necessary intervening nodes if the search
1194 * should be necessary. Whether or not the search is necessary is
1195 * controlled by the hash parameter. If the hash value is even, then
1196 * the search is only continued if the next block starts with that
1197 * hash value. This is used if we are searching for a specific file.
1199 * If the hash value is HASH_NB_ALWAYS, then always go to the next block.
1201 * This function returns 1 if the caller should continue to search,
1202 * or 0 if it should not. If there is an error reading one of the
1203 * index blocks, it will a negative error code.
1205 * If start_hash is non-null, it will be filled in with the starting
1206 * hash of the next page.
1208 static int iam_htree_advance(struct inode *dir, __u32 hash,
1209 struct iam_path *path, __u32 *start_hash,
1212 struct iam_frame *p;
1213 struct buffer_head *bh;
1214 int err, num_frames = 0;
1219 * Find the next leaf page by incrementing the frame pointer.
1220 * If we run out of entries in the interior node, loop around and
1221 * increment pointer in the parent node. When we break out of
1222 * this loop, num_frames indicates the number of interior
1223 * nodes need to be read.
1226 do_corr(schedule());
1231 p->at = iam_entry_shift(path, p->at, +1);
1232 if (p->at < iam_entry_shift(path, p->entries,
1233 dx_get_count(p->entries))) {
1234 p->leaf = dx_get_block(path, p->at);
1235 iam_unlock_bh(p->bh);
1238 iam_unlock_bh(p->bh);
1239 if (p == path->ip_frames)
1251 * If the hash is 1, then continue only if the next page has a
1252 * continuation hash of any value. This is used for readdir
1253 * handling. Otherwise, check to see if the hash matches the
1254 * desired contiuation hash. If it doesn't, return since
1255 * there's no point to read in the successive index pages.
1257 dx_get_ikey(path, p->at, (struct iam_ikey *)&bhash);
1259 *start_hash = bhash;
1260 if ((hash & 1) == 0) {
1261 if ((bhash & ~1) != hash)
1266 * If the hash is HASH_NB_ALWAYS, we always go to the next
1267 * block so no check is necessary
1269 while (num_frames--) {
1272 do_corr(schedule());
1274 idx = p->leaf = dx_get_block(path, p->at);
1275 iam_unlock_bh(p->bh);
1276 err = iam_path_descr(path)->id_ops->
1277 id_node_read(path->ip_container, idx, NULL, &bh);
1279 return err; /* Failure */
1282 assert_corr(p->bh != bh);
1284 p->entries = dx_node_get_entries(path, p);
1285 p->at = iam_entry_shift(path, p->entries, !compat);
1286 assert_corr(p->curidx != idx);
1289 assert_corr(p->leaf != dx_get_block(path, p->at));
1290 p->leaf = dx_get_block(path, p->at);
1291 iam_unlock_bh(p->bh);
1292 assert_inv(dx_node_check(path, p));
1297 static inline int iam_index_advance(struct iam_path *path)
1299 return iam_htree_advance(iam_path_obj(path), 0, path, NULL, 0);
1302 static void iam_unlock_array(struct iam_container *ic,
1303 struct dynlock_handle **lh)
1307 for (i = 0; i < DX_MAX_TREE_HEIGHT; ++i, ++lh) {
1309 iam_unlock_htree(ic, *lh);
1315 * Advance index part of @path to point to the next leaf. Returns 1 on
1316 * success, 0, when end of container was reached. Leaf node is locked.
1318 int iam_index_next(struct iam_container *c, struct iam_path *path)
1321 struct dynlock_handle *lh[DX_MAX_TREE_HEIGHT] = { NULL, };
1325 * Locking for iam_index_next()... is to be described.
1328 cursor = path->ip_frame->leaf;
1331 result = iam_index_lock(path, lh);
1332 do_corr(schedule());
1336 result = iam_check_full_path(path, 0);
1337 if (result == 0 && cursor == path->ip_frame->leaf) {
1338 result = iam_index_advance(path);
1340 assert_corr(result == 0 ||
1341 cursor != path->ip_frame->leaf);
1345 iam_unlock_array(c, lh);
1347 iam_path_release(path);
1348 do_corr(schedule());
1350 result = __iam_path_lookup(path);
1354 while (path->ip_frame->leaf != cursor) {
1355 do_corr(schedule());
1357 result = iam_index_lock(path, lh);
1358 do_corr(schedule());
1362 result = iam_check_full_path(path, 0);
1366 result = iam_index_advance(path);
1368 CERROR("cannot find cursor : %u\n",
1374 result = iam_check_full_path(path, 0);
1377 iam_unlock_array(c, lh);
1379 } while (result == -EAGAIN);
1383 iam_unlock_array(c, lh);
1388 * Move iterator one record right.
1390 * Return value: 0: success,
1391 * +1: end of container reached
1394 * precondition: (it_state(it) == IAM_IT_ATTACHED ||
1395 * it_state(it) == IAM_IT_SKEWED) && it->ii_flags&IAM_IT_MOVE
1396 * postcondition: ergo(result == 0, it_state(it) == IAM_IT_ATTACHED) &&
1397 * ergo(result > 0, it_state(it) == IAM_IT_DETACHED)
1399 int iam_it_next(struct iam_iterator *it)
1402 struct iam_path *path;
1403 struct iam_leaf *leaf;
1405 do_corr(struct iam_ikey *ik_orig);
1407 /* assert_corr(it->ii_flags&IAM_IT_MOVE); */
1408 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
1409 it_state(it) == IAM_IT_SKEWED);
1411 path = &it->ii_path;
1412 leaf = &path->ip_leaf;
1414 assert_corr(iam_leaf_is_locked(leaf));
1417 do_corr(ik_orig = it_at_rec(it) ?
1418 iam_it_ikey_get(it, iam_path_ikey(path, 2)) : NULL);
1419 if (it_before(it)) {
1420 assert_corr(!iam_leaf_at_end(leaf));
1421 it->ii_state = IAM_IT_ATTACHED;
1423 if (!iam_leaf_at_end(leaf))
1424 /* advance within leaf node */
1425 iam_leaf_next(leaf);
1427 * multiple iterations may be necessary due to empty leaves.
1429 while (result == 0 && iam_leaf_at_end(leaf)) {
1430 do_corr(schedule());
1431 /* advance index portion of the path */
1432 result = iam_index_next(iam_it_container(it), path);
1433 assert_corr(iam_leaf_is_locked(leaf));
1435 struct dynlock_handle *lh;
1436 lh = iam_lock_htree(iam_it_container(it),
1437 path->ip_frame->leaf,
1440 iam_leaf_fini(leaf);
1442 result = iam_leaf_load(path);
1444 iam_leaf_start(leaf);
1447 } else if (result == 0)
1448 /* end of container reached */
1454 it->ii_state = IAM_IT_ATTACHED;
1456 assert_corr(ergo(result == 0, it_state(it) == IAM_IT_ATTACHED));
1457 assert_corr(ergo(result > 0, it_state(it) == IAM_IT_DETACHED));
1458 assert_corr(ergo(result == 0 && ik_orig != NULL,
1459 it_ikeycmp(it, ik_orig) >= 0));
1464 * Return pointer to the record under iterator.
1466 * precondition: it_state(it) == IAM_IT_ATTACHED && it_at_rec(it)
1467 * postcondition: it_state(it) == IAM_IT_ATTACHED
1469 struct iam_rec *iam_it_rec_get(const struct iam_iterator *it)
1471 assert_corr(it_state(it) == IAM_IT_ATTACHED);
1472 assert_corr(it_at_rec(it));
1473 return iam_leaf_rec(&it->ii_path.ip_leaf);
1476 static void iam_it_reccpy(struct iam_iterator *it, const struct iam_rec *r)
1478 struct iam_leaf *folio;
1480 folio = &it->ii_path.ip_leaf;
1481 iam_leaf_ops(folio)->rec_set(folio, r);
1485 * Replace contents of record under iterator.
1487 * precondition: it_state(it) == IAM_IT_ATTACHED &&
1488 * it->ii_flags&IAM_IT_WRITE
1489 * postcondition: it_state(it) == IAM_IT_ATTACHED &&
1490 * ergo(result == 0, !memcmp(iam_it_rec_get(it), r, ...))
1492 int iam_it_rec_set(handle_t *h,
1493 struct iam_iterator *it, const struct iam_rec *r)
1496 struct iam_path *path;
1497 struct buffer_head *bh;
1499 assert_corr(it_state(it) == IAM_IT_ATTACHED &&
1500 it->ii_flags&IAM_IT_WRITE);
1501 assert_corr(it_at_rec(it));
1503 path = &it->ii_path;
1504 bh = path->ip_leaf.il_bh;
1505 result = iam_txn_add(h, path, bh);
1507 iam_it_reccpy(it, r);
1508 result = iam_txn_dirty(h, path, bh);
1514 * Return pointer to the index key under iterator.
1516 * precondition: it_state(it) == IAM_IT_ATTACHED ||
1517 * it_state(it) == IAM_IT_SKEWED
1519 static struct iam_ikey *iam_it_ikey_get(const struct iam_iterator *it,
1520 struct iam_ikey *ikey)
1522 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
1523 it_state(it) == IAM_IT_SKEWED);
1524 assert_corr(it_at_rec(it));
1525 return iam_leaf_ikey(&it->ii_path.ip_leaf, ikey);
1529 * Return pointer to the key under iterator.
1531 * precondition: it_state(it) == IAM_IT_ATTACHED ||
1532 * it_state(it) == IAM_IT_SKEWED
1534 struct iam_key *iam_it_key_get(const struct iam_iterator *it)
1536 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
1537 it_state(it) == IAM_IT_SKEWED);
1538 assert_corr(it_at_rec(it));
1539 return iam_leaf_key(&it->ii_path.ip_leaf);
1543 * Return size of key under iterator (in bytes)
1545 * precondition: it_state(it) == IAM_IT_ATTACHED ||
1546 * it_state(it) == IAM_IT_SKEWED
1548 int iam_it_key_size(const struct iam_iterator *it)
1550 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
1551 it_state(it) == IAM_IT_SKEWED);
1552 assert_corr(it_at_rec(it));
1553 return iam_leaf_key_size(&it->ii_path.ip_leaf);
1556 static struct buffer_head *
1557 iam_new_node(handle_t *h, struct iam_container *c, iam_ptr_t *b, int *e)
1559 struct inode *inode = c->ic_object;
1560 struct buffer_head *bh = NULL;
1561 struct iam_idle_head *head;
1562 struct buffer_head *idle;
1566 if (c->ic_idle_bh == NULL)
1569 mutex_lock(&c->ic_idle_mutex);
1570 if (unlikely(c->ic_idle_bh == NULL)) {
1571 mutex_unlock(&c->ic_idle_mutex);
1575 head = (struct iam_idle_head *)(c->ic_idle_bh->b_data);
1576 count = le16_to_cpu(head->iih_count);
1578 *e = osd_ldiskfs_journal_get_write_access(h, inode->i_sb,
1585 *b = le32_to_cpu(head->iih_blks[count]);
1586 head->iih_count = cpu_to_le16(count);
1587 *e = ldiskfs_handle_dirty_metadata(h, inode, c->ic_idle_bh);
1591 mutex_unlock(&c->ic_idle_mutex);
1592 bh = __ldiskfs_bread(NULL, inode, *b, 0);
1593 if (IS_ERR_OR_NULL(bh)) {
1603 /* The block itself which contains the iam_idle_head is
1604 * also an idle block, and can be used as the new node. */
1605 idle_blocks = (__u32 *)(c->ic_root_bh->b_data +
1606 c->ic_descr->id_root_gap +
1607 sizeof(struct dx_countlimit));
1608 *e = osd_ldiskfs_journal_get_write_access(h, inode->i_sb,
1614 *b = le32_to_cpu(*idle_blocks);
1615 iam_lock_bh(c->ic_root_bh);
1616 *idle_blocks = head->iih_next;
1617 iam_unlock_bh(c->ic_root_bh);
1618 *e = ldiskfs_handle_dirty_metadata(h, inode, c->ic_root_bh);
1620 iam_lock_bh(c->ic_root_bh);
1621 *idle_blocks = cpu_to_le32(*b);
1622 iam_unlock_bh(c->ic_root_bh);
1627 idle = iam_load_idle_blocks(c, le32_to_cpu(*idle_blocks));
1628 if (idle != NULL && IS_ERR(idle)) {
1630 c->ic_idle_bh = NULL;
1635 c->ic_idle_bh = idle;
1636 mutex_unlock(&c->ic_idle_mutex);
1639 /* get write access for the found buffer head */
1640 *e = osd_ldiskfs_journal_get_write_access(h, inode->i_sb, bh,
1645 ldiskfs_std_error(inode->i_sb, *e);
1647 /* Clear the reused node as new node does. */
1648 memset(bh->b_data, 0, inode->i_sb->s_blocksize);
1649 set_buffer_uptodate(bh);
1654 bh = osd_ldiskfs_append(h, inode, b);
1663 mutex_unlock(&c->ic_idle_mutex);
1664 ldiskfs_std_error(inode->i_sb, *e);
1669 * Insertion of new record. Interaction with jbd during non-trivial case (when
1670 * split happens) is as following:
1672 * - new leaf node is involved into transaction by iam_new_node();
1674 * - old leaf node is involved into transaction by iam_add_rec();
1676 * - leaf where insertion point ends in, is marked dirty by iam_add_rec();
1678 * - leaf without insertion point is marked dirty (as @new_leaf) by
1681 * - split index nodes are involved into transaction and marked dirty by
1682 * split_index_node().
1684 * - "safe" index node, which is no split, but where new pointer is inserted
1685 * is involved into transaction and marked dirty by split_index_node().
1687 * - index node where pointer to new leaf is inserted is involved into
1688 * transaction by split_index_node() and marked dirty by iam_add_rec().
1690 * - inode is marked dirty by iam_add_rec().
1694 static int iam_new_leaf(handle_t *handle, struct iam_leaf *leaf)
1698 struct buffer_head *new_leaf;
1699 struct buffer_head *old_leaf;
1700 struct iam_container *c;
1702 struct iam_path *path;
1704 c = iam_leaf_container(leaf);
1705 path = leaf->il_path;
1708 new_leaf = iam_new_node(handle, c, &blknr, &err);
1709 do_corr(schedule());
1710 if (new_leaf != NULL) {
1711 struct dynlock_handle *lh;
1713 lh = iam_lock_htree(c, blknr, DLT_WRITE);
1714 do_corr(schedule());
1716 iam_leaf_ops(leaf)->init_new(c, new_leaf);
1717 do_corr(schedule());
1718 old_leaf = leaf->il_bh;
1719 iam_leaf_split(leaf, &new_leaf, blknr);
1720 if (old_leaf != leaf->il_bh) {
1722 * Switched to the new leaf.
1724 iam_leaf_unlock(leaf);
1726 path->ip_frame->leaf = blknr;
1728 iam_unlock_htree(path->ip_container, lh);
1729 do_corr(schedule());
1730 err = iam_txn_dirty(handle, path, new_leaf);
1732 err = ldiskfs_mark_inode_dirty(handle, obj);
1733 do_corr(schedule());
1738 assert_inv(iam_path_check(iam_leaf_path(leaf)));
1742 static inline void dx_set_limit(struct iam_entry *entries, unsigned value)
1744 ((struct dx_countlimit *) entries)->limit = cpu_to_le16(value);
1747 static int iam_shift_entries(struct iam_path *path,
1748 struct iam_frame *frame, unsigned count,
1749 struct iam_entry *entries, struct iam_entry *entries2,
1756 struct iam_frame *parent = frame - 1;
1757 struct iam_ikey *pivot = iam_path_ikey(path, 3);
1759 delta = dx_index_is_compat(path) ? 0 : +1;
1761 count1 = count/2 + delta;
1762 count2 = count - count1;
1763 dx_get_ikey(path, iam_entry_shift(path, entries, count1), pivot);
1765 dxtrace(printk("Split index %d/%d\n", count1, count2));
1767 memcpy((char *) iam_entry_shift(path, entries2, delta),
1768 (char *) iam_entry_shift(path, entries, count1),
1769 count2 * iam_entry_size(path));
1771 dx_set_count(entries2, count2 + delta);
1772 dx_set_limit(entries2, dx_node_limit(path));
1775 * NOTE: very subtle piece of code competing dx_probe() may find 2nd
1776 * level index in root index, then we insert new index here and set
1777 * new count in that 2nd level index. so, dx_probe() may see 2nd level
1778 * index w/o hash it looks for. the solution is to check root index
1779 * after we locked just founded 2nd level index -bzzz
1781 iam_insert_key_lock(path, parent, pivot, newblock);
1784 * now old and new 2nd level index blocks contain all pointers, so
1785 * dx_probe() may find it in the both. it's OK -bzzz
1787 iam_lock_bh(frame->bh);
1788 dx_set_count(entries, count1);
1789 iam_unlock_bh(frame->bh);
1792 * now old 2nd level index block points to first half of leafs. it's
1793 * importand that dx_probe() must check root index block for changes
1794 * under dx_lock_bh(frame->bh) -bzzz
1801 int split_index_node(handle_t *handle, struct iam_path *path,
1802 struct dynlock_handle **lh)
1804 struct iam_entry *entries; /* old block contents */
1805 struct iam_entry *entries2; /* new block contents */
1806 struct iam_frame *frame, *safe;
1807 struct buffer_head *bh_new[DX_MAX_TREE_HEIGHT] = {NULL};
1808 u32 newblock[DX_MAX_TREE_HEIGHT] = {0};
1809 struct dynlock_handle *lock[DX_MAX_TREE_HEIGHT] = {NULL,};
1810 struct dynlock_handle *new_lock[DX_MAX_TREE_HEIGHT] = {NULL,};
1811 struct inode *dir = iam_path_obj(path);
1812 struct iam_descr *descr;
1816 descr = iam_path_descr(path);
1818 * Algorithm below depends on this.
1820 assert_corr(dx_root_limit(path) < dx_node_limit(path));
1822 frame = path->ip_frame;
1823 entries = frame->entries;
1826 * Tall-tree handling: we might have to split multiple index blocks
1827 * all the way up to tree root. Tricky point here is error handling:
1828 * to avoid complicated undo/rollback we
1830 * - first allocate all necessary blocks
1832 * - insert pointers into them atomically.
1836 * Locking: leaf is already locked. htree-locks are acquired on all
1837 * index nodes that require split bottom-to-top, on the "safe" node,
1838 * and on all new nodes
1841 dxtrace(printk("using %u of %u node entries\n",
1842 dx_get_count(entries), dx_get_limit(entries)));
1844 /* What levels need split? */
1845 for (nr_splet = 0; frame >= path->ip_frames &&
1846 dx_get_count(frame->entries) == dx_get_limit(frame->entries);
1847 --frame, ++nr_splet) {
1848 do_corr(schedule());
1849 if (nr_splet == DX_MAX_TREE_HEIGHT) {
1851 * CWARN(dir->i_sb, __FUNCTION__,
1852 * "Directory index full!\n");
1862 * Lock all nodes, bottom to top.
1864 for (frame = path->ip_frame, i = nr_splet; i >= 0; --i, --frame) {
1865 do_corr(schedule());
1866 lock[i] = iam_lock_htree(path->ip_container, frame->curidx,
1868 if (lock[i] == NULL) {
1875 * Check for concurrent index modification.
1877 err = iam_check_full_path(path, 1);
1881 * And check that the same number of nodes is to be split.
1883 for (i = 0, frame = path->ip_frame; frame >= path->ip_frames &&
1884 dx_get_count(frame->entries) == dx_get_limit(frame->entries);
1888 if (i != nr_splet) {
1894 * Go back down, allocating blocks, locking them, and adding into
1897 for (frame = safe + 1, i = 0; i < nr_splet; ++i, ++frame) {
1898 bh_new[i] = iam_new_node(handle, path->ip_container,
1899 &newblock[i], &err);
1900 do_corr(schedule());
1902 descr->id_ops->id_node_init(path->ip_container,
1906 new_lock[i] = iam_lock_htree(path->ip_container, newblock[i],
1908 if (new_lock[i] == NULL) {
1912 do_corr(schedule());
1913 BUFFER_TRACE(frame->bh, "get_write_access");
1914 err = osd_ldiskfs_journal_get_write_access(handle,
1921 /* Add "safe" node to transaction too */
1922 if (safe + 1 != path->ip_frames) {
1923 do_corr(schedule());
1924 err = osd_ldiskfs_journal_get_write_access(handle,
1932 /* Go through nodes once more, inserting pointers */
1933 for (frame = safe + 1, i = 0; i < nr_splet; ++i, ++frame) {
1936 struct buffer_head *bh2;
1937 struct buffer_head *bh;
1939 entries = frame->entries;
1940 count = dx_get_count(entries);
1941 idx = iam_entry_diff(path, frame->at, entries);
1944 entries2 = dx_get_entries(path, bh2->b_data, 0);
1947 if (frame == path->ip_frames) {
1948 /* splitting root node. Tricky point:
1950 * In the "normal" B-tree we'd split root *and* add
1951 * new root to the tree with pointers to the old root
1952 * and its sibling (thus introducing two new nodes).
1954 * In htree it's enough to add one node, because
1955 * capacity of the root node is smaller than that of
1958 struct iam_frame *frames;
1959 struct iam_entry *next;
1961 assert_corr(i == 0);
1963 do_corr(schedule());
1965 frames = path->ip_frames;
1966 memcpy((char *) entries2, (char *) entries,
1967 count * iam_entry_size(path));
1968 dx_set_limit(entries2, dx_node_limit(path));
1971 iam_lock_bh(frame->bh);
1972 next = descr->id_ops->id_root_inc(path->ip_container,
1974 dx_set_block(path, next, newblock[0]);
1975 iam_unlock_bh(frame->bh);
1977 do_corr(schedule());
1978 /* Shift frames in the path */
1979 memmove(frames + 2, frames + 1,
1980 (sizeof path->ip_frames) - 2 * sizeof frames[0]);
1981 /* Add new access path frame */
1982 frames[1].at = iam_entry_shift(path, entries2, idx);
1983 frames[1].entries = entries = entries2;
1985 assert_inv(dx_node_check(path, frame));
1988 assert_inv(dx_node_check(path, frame));
1989 bh_new[0] = NULL; /* buffer head is "consumed" */
1990 err = ldiskfs_handle_dirty_metadata(handle, NULL, bh2);
1993 do_corr(schedule());
1995 /* splitting non-root index node. */
1996 struct iam_frame *parent = frame - 1;
1998 do_corr(schedule());
1999 count = iam_shift_entries(path, frame, count,
2000 entries, entries2, newblock[i]);
2001 /* Which index block gets the new entry? */
2003 int d = dx_index_is_compat(path) ? 0 : +1;
2005 frame->at = iam_entry_shift(path, entries2,
2007 frame->entries = entries = entries2;
2008 frame->curidx = newblock[i];
2009 swap(frame->bh, bh2);
2010 assert_corr(lock[i + 1] != NULL);
2011 assert_corr(new_lock[i] != NULL);
2012 swap(lock[i + 1], new_lock[i]);
2014 parent->at = iam_entry_shift(path,
2017 assert_inv(dx_node_check(path, frame));
2018 assert_inv(dx_node_check(path, parent));
2019 dxtrace(dx_show_index("node", frame->entries));
2020 dxtrace(dx_show_index("node",
2021 ((struct dx_node *) bh2->b_data)->entries));
2022 err = ldiskfs_handle_dirty_metadata(handle, NULL, bh2);
2025 do_corr(schedule());
2026 err = ldiskfs_handle_dirty_metadata(handle, NULL,
2031 do_corr(schedule());
2032 err = ldiskfs_handle_dirty_metadata(handle, NULL, bh);
2037 * This function was called to make insertion of new leaf
2038 * possible. Check that it fulfilled its obligations.
2040 assert_corr(dx_get_count(path->ip_frame->entries) <
2041 dx_get_limit(path->ip_frame->entries));
2042 assert_corr(lock[nr_splet] != NULL);
2043 *lh = lock[nr_splet];
2044 lock[nr_splet] = NULL;
2047 * Log ->i_size modification.
2049 err = ldiskfs_mark_inode_dirty(handle, dir);
2055 ldiskfs_std_error(dir->i_sb, err);
2058 iam_unlock_array(path->ip_container, lock);
2059 iam_unlock_array(path->ip_container, new_lock);
2061 assert_corr(err || iam_frame_is_locked(path, path->ip_frame));
2063 do_corr(schedule());
2064 for (i = 0; i < ARRAY_SIZE(bh_new); ++i) {
2065 if (bh_new[i] != NULL)
2071 static int iam_add_rec(handle_t *handle, struct iam_iterator *it,
2072 struct iam_path *path,
2073 const struct iam_key *k, const struct iam_rec *r)
2076 struct iam_leaf *leaf;
2078 leaf = &path->ip_leaf;
2079 assert_inv(iam_path_check(path));
2080 err = iam_txn_add(handle, path, leaf->il_bh);
2082 do_corr(schedule());
2083 if (!iam_leaf_can_add(leaf, k, r)) {
2084 struct dynlock_handle *lh = NULL;
2087 assert_corr(lh == NULL);
2088 do_corr(schedule());
2089 err = split_index_node(handle, path, &lh);
2090 if (err == -EAGAIN) {
2091 assert_corr(lh == NULL);
2093 iam_path_fini(path);
2094 it->ii_state = IAM_IT_DETACHED;
2096 do_corr(schedule());
2097 err = iam_it_get_exact(it, k);
2099 err = +1; /* repeat split */
2104 assert_inv(iam_path_check(path));
2106 assert_corr(lh != NULL);
2107 do_corr(schedule());
2108 err = iam_new_leaf(handle, leaf);
2110 err = iam_txn_dirty(handle, path,
2111 path->ip_frame->bh);
2113 iam_unlock_htree(path->ip_container, lh);
2114 do_corr(schedule());
2117 iam_leaf_rec_add(leaf, k, r);
2118 err = iam_txn_dirty(handle, path, leaf->il_bh);
2121 assert_inv(iam_path_check(path));
2126 * Insert new record with key @k and contents from @r, shifting records to the
2127 * right. On success, iterator is positioned on the newly inserted record.
2129 * precondition: it->ii_flags&IAM_IT_WRITE &&
2130 * (it_state(it) == IAM_IT_ATTACHED ||
2131 * it_state(it) == IAM_IT_SKEWED) &&
2132 * ergo(it_state(it) == IAM_IT_ATTACHED,
2133 * it_keycmp(it, k) <= 0) &&
2134 * ergo(it_before(it), it_keycmp(it, k) > 0));
2135 * postcondition: ergo(result == 0,
2136 * it_state(it) == IAM_IT_ATTACHED &&
2137 * it_keycmp(it, k) == 0 &&
2138 * !memcmp(iam_it_rec_get(it), r, ...))
2140 int iam_it_rec_insert(handle_t *h, struct iam_iterator *it,
2141 const struct iam_key *k, const struct iam_rec *r)
2144 struct iam_path *path;
2146 path = &it->ii_path;
2148 assert_corr(it->ii_flags&IAM_IT_WRITE);
2149 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
2150 it_state(it) == IAM_IT_SKEWED);
2151 assert_corr(ergo(it_state(it) == IAM_IT_ATTACHED,
2152 it_keycmp(it, k) <= 0));
2153 assert_corr(ergo(it_before(it), it_keycmp(it, k) > 0));
2154 result = iam_add_rec(h, it, path, k, r);
2156 it->ii_state = IAM_IT_ATTACHED;
2157 assert_corr(ergo(result == 0,
2158 it_state(it) == IAM_IT_ATTACHED &&
2159 it_keycmp(it, k) == 0));
2163 static inline int iam_idle_blocks_limit(struct inode *inode)
2165 return (inode->i_sb->s_blocksize - sizeof(struct iam_idle_head)) >> 2;
2169 * If the leaf cannnot be recycled, we will lose one block for reusing.
2170 * It is not a serious issue because it almost the same of non-recycle.
2172 static iam_ptr_t iam_index_shrink(handle_t *h, struct iam_path *p,
2173 struct iam_leaf *l, struct buffer_head **bh)
2175 struct iam_container *c = p->ip_container;
2176 struct inode *inode = c->ic_object;
2177 struct iam_frame *frame = p->ip_frame;
2178 struct iam_entry *entries;
2179 struct iam_entry *pos;
2180 struct dynlock_handle *lh;
2184 if (c->ic_idle_failed)
2187 if (unlikely(frame == NULL))
2190 if (!iam_leaf_empty(l))
2193 lh = iam_lock_htree(c, frame->curidx, DLT_WRITE);
2195 CWARN("%s: No memory to recycle idle blocks\n",
2196 osd_ino2name(inode));
2200 rc = iam_txn_add(h, p, frame->bh);
2202 iam_unlock_htree(c, lh);
2206 iam_lock_bh(frame->bh);
2207 entries = frame->entries;
2208 count = dx_get_count(entries);
2210 * NOT shrink the last entry in the index node, which can be reused
2211 * directly by next new node.
2214 iam_unlock_bh(frame->bh);
2215 iam_unlock_htree(c, lh);
2219 pos = iam_find_position(p, frame);
2221 * There may be some new leaf nodes have been added or empty leaf nodes
2222 * have been shrinked during my delete operation.
2224 * If the empty leaf is not under current index node because the index
2225 * node has been split, then just skip the empty leaf, which is rare.
2227 if (unlikely(frame->leaf != dx_get_block(p, pos))) {
2228 iam_unlock_bh(frame->bh);
2229 iam_unlock_htree(c, lh);
2234 if (frame->at < iam_entry_shift(p, entries, count - 1)) {
2235 struct iam_entry *n = iam_entry_shift(p, frame->at, 1);
2237 memmove(frame->at, n,
2238 (char *)iam_entry_shift(p, entries, count) - (char *)n);
2239 frame->at_shifted = 1;
2241 dx_set_count(entries, count - 1);
2242 iam_unlock_bh(frame->bh);
2243 rc = iam_txn_dirty(h, p, frame->bh);
2244 iam_unlock_htree(c, lh);
2254 iam_install_idle_blocks(handle_t *h, struct iam_path *p, struct buffer_head *bh,
2255 __u32 *idle_blocks, iam_ptr_t blk)
2257 struct iam_container *c = p->ip_container;
2258 struct buffer_head *old = c->ic_idle_bh;
2259 struct iam_idle_head *head;
2262 head = (struct iam_idle_head *)(bh->b_data);
2263 head->iih_magic = cpu_to_le16(IAM_IDLE_HEADER_MAGIC);
2264 head->iih_count = 0;
2265 head->iih_next = *idle_blocks;
2266 /* The bh already get_write_accessed. */
2267 rc = iam_txn_dirty(h, p, bh);
2271 rc = iam_txn_add(h, p, c->ic_root_bh);
2275 iam_lock_bh(c->ic_root_bh);
2276 *idle_blocks = cpu_to_le32(blk);
2277 iam_unlock_bh(c->ic_root_bh);
2278 rc = iam_txn_dirty(h, p, c->ic_root_bh);
2280 /* NOT release old before new assigned. */
2285 iam_lock_bh(c->ic_root_bh);
2286 *idle_blocks = head->iih_next;
2287 iam_unlock_bh(c->ic_root_bh);
2293 * If the leaf cannnot be recycled, we will lose one block for reusing.
2294 * It is not a serious issue because it almost the same of non-recycle.
2296 static void iam_recycle_leaf(handle_t *h, struct iam_path *p,
2297 struct buffer_head *bh, iam_ptr_t blk)
2299 struct iam_container *c = p->ip_container;
2300 struct inode *inode = c->ic_object;
2301 struct iam_idle_head *head;
2306 mutex_lock(&c->ic_idle_mutex);
2307 if (unlikely(c->ic_idle_failed)) {
2312 idle_blocks = (__u32 *)(c->ic_root_bh->b_data +
2313 c->ic_descr->id_root_gap +
2314 sizeof(struct dx_countlimit));
2315 /* It is the first idle block. */
2316 if (c->ic_idle_bh == NULL) {
2317 rc = iam_install_idle_blocks(h, p, bh, idle_blocks, blk);
2321 head = (struct iam_idle_head *)(c->ic_idle_bh->b_data);
2322 count = le16_to_cpu(head->iih_count);
2323 /* Current ic_idle_bh is full, to be replaced by the leaf. */
2324 if (count == iam_idle_blocks_limit(inode)) {
2325 rc = iam_install_idle_blocks(h, p, bh, idle_blocks, blk);
2329 /* Just add to ic_idle_bh. */
2330 rc = iam_txn_add(h, p, c->ic_idle_bh);
2334 head->iih_blks[count] = cpu_to_le32(blk);
2335 head->iih_count = cpu_to_le16(count + 1);
2336 rc = iam_txn_dirty(h, p, c->ic_idle_bh);
2339 mutex_unlock(&c->ic_idle_mutex);
2341 CWARN("%s: idle blocks failed, will lose the blk %u\n",
2342 osd_ino2name(inode), blk);
2346 * Delete record under iterator.
2348 * precondition: it_state(it) == IAM_IT_ATTACHED &&
2349 * it->ii_flags&IAM_IT_WRITE &&
2351 * postcondition: it_state(it) == IAM_IT_ATTACHED ||
2352 * it_state(it) == IAM_IT_DETACHED
2354 int iam_it_rec_delete(handle_t *h, struct iam_iterator *it)
2357 struct iam_leaf *leaf;
2358 struct iam_path *path;
2360 assert_corr(it_state(it) == IAM_IT_ATTACHED &&
2361 it->ii_flags&IAM_IT_WRITE);
2362 assert_corr(it_at_rec(it));
2364 path = &it->ii_path;
2365 leaf = &path->ip_leaf;
2367 assert_inv(iam_path_check(path));
2369 result = iam_txn_add(h, path, leaf->il_bh);
2371 * no compaction for now.
2374 iam_rec_del(leaf, it->ii_flags&IAM_IT_MOVE);
2375 result = iam_txn_dirty(h, path, leaf->il_bh);
2376 if (result == 0 && iam_leaf_at_end(leaf)) {
2377 struct buffer_head *bh = NULL;
2380 blk = iam_index_shrink(h, path, leaf, &bh);
2381 if (it->ii_flags & IAM_IT_MOVE) {
2382 result = iam_it_next(it);
2388 iam_recycle_leaf(h, path, bh, blk);
2393 assert_inv(iam_path_check(path));
2394 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
2395 it_state(it) == IAM_IT_DETACHED);
2400 * Convert iterator to cookie.
2402 * precondition: it_state(it) == IAM_IT_ATTACHED &&
2403 * iam_path_descr(it->ii_path)->id_key_size <= sizeof(iam_pos_t)
2404 * postcondition: it_state(it) == IAM_IT_ATTACHED
2406 iam_pos_t iam_it_store(const struct iam_iterator *it)
2410 assert_corr(it_state(it) == IAM_IT_ATTACHED);
2411 assert_corr(it_at_rec(it));
2412 assert_corr(iam_it_container(it)->ic_descr->id_ikey_size <=
2416 return *(iam_pos_t *)iam_it_ikey_get(it, (void *)&result);
2420 * Restore iterator from cookie.
2422 * precondition: it_state(it) == IAM_IT_DETACHED && it->ii_flags&IAM_IT_MOVE &&
2423 * iam_path_descr(it->ii_path)->id_key_size <= sizeof(iam_pos_t)
2424 * postcondition: ergo(result == 0, it_state(it) == IAM_IT_ATTACHED &&
2425 * iam_it_store(it) == pos)
2427 int iam_it_load(struct iam_iterator *it, iam_pos_t pos)
2429 assert_corr(it_state(it) == IAM_IT_DETACHED &&
2430 it->ii_flags&IAM_IT_MOVE);
2431 assert_corr(iam_it_container(it)->ic_descr->id_ikey_size <= sizeof pos);
2432 return iam_it_iget(it, (struct iam_ikey *)&pos);
2435 /***********************************************************************/
2437 /***********************************************************************/
2439 static inline int ptr_inside(void *base, size_t size, void *ptr)
2441 return (base <= ptr) && (ptr < base + size);
2444 static int iam_frame_invariant(struct iam_frame *f)
2448 f->bh->b_data != NULL &&
2449 ptr_inside(f->bh->b_data, f->bh->b_size, f->entries) &&
2450 ptr_inside(f->bh->b_data, f->bh->b_size, f->at) &&
2451 f->entries <= f->at);
2454 static int iam_leaf_invariant(struct iam_leaf *l)
2458 l->il_bh->b_data != NULL &&
2459 ptr_inside(l->il_bh->b_data, l->il_bh->b_size, l->il_entries) &&
2460 ptr_inside(l->il_bh->b_data, l->il_bh->b_size, l->il_at) &&
2461 l->il_entries <= l->il_at;
2464 static int iam_path_invariant(struct iam_path *p)
2468 if (p->ip_container == NULL ||
2469 p->ip_indirect < 0 || p->ip_indirect > DX_MAX_TREE_HEIGHT - 1 ||
2470 p->ip_frame != p->ip_frames + p->ip_indirect ||
2471 !iam_leaf_invariant(&p->ip_leaf))
2473 for (i = 0; i < ARRAY_SIZE(p->ip_frames); ++i) {
2474 if (i <= p->ip_indirect) {
2475 if (!iam_frame_invariant(&p->ip_frames[i]))
2482 int iam_it_invariant(struct iam_iterator *it)
2485 (it->ii_state == IAM_IT_DETACHED ||
2486 it->ii_state == IAM_IT_ATTACHED ||
2487 it->ii_state == IAM_IT_SKEWED) &&
2488 !(it->ii_flags & ~(IAM_IT_MOVE | IAM_IT_WRITE)) &&
2489 ergo(it->ii_state == IAM_IT_ATTACHED ||
2490 it->ii_state == IAM_IT_SKEWED,
2491 iam_path_invariant(&it->ii_path) &&
2492 equi(it_at_rec(it), it->ii_state == IAM_IT_SKEWED));
2496 * Search container @c for record with key @k. If record is found, its data
2497 * are moved into @r.
2499 * Return values: 0: found, -ENOENT: not-found, -ve: error
2501 int iam_lookup(struct iam_container *c, const struct iam_key *k,
2502 struct iam_rec *r, struct iam_path_descr *pd)
2504 struct iam_iterator it;
2507 iam_it_init(&it, c, 0, pd);
2509 result = iam_it_get_exact(&it, k);
2512 * record with required key found, copy it into user buffer
2514 iam_reccpy(&it.ii_path.ip_leaf, r);
2521 * Insert new record @r with key @k into container @c (within context of
2524 * Return values: 0: success, -ve: error, including -EEXIST when record with
2525 * given key is already present.
2527 * postcondition: ergo(result == 0 || result == -EEXIST,
2528 * iam_lookup(c, k, r2) > 0;
2530 int iam_insert(handle_t *h, struct iam_container *c, const struct iam_key *k,
2531 const struct iam_rec *r, struct iam_path_descr *pd)
2533 struct iam_iterator it;
2536 iam_it_init(&it, c, IAM_IT_WRITE, pd);
2538 result = iam_it_get_exact(&it, k);
2539 if (result == -ENOENT)
2540 result = iam_it_rec_insert(h, &it, k, r);
2541 else if (result == 0)
2549 * Update record with the key @k in container @c (within context of
2550 * transaction @h), new record is given by @r.
2552 * Return values: +1: skip because of the same rec value, 0: success,
2553 * -ve: error, including -ENOENT if no record with the given key found.
2555 int iam_update(handle_t *h, struct iam_container *c, const struct iam_key *k,
2556 const struct iam_rec *r, struct iam_path_descr *pd)
2558 struct iam_iterator it;
2559 struct iam_leaf *folio;
2562 iam_it_init(&it, c, IAM_IT_WRITE, pd);
2564 result = iam_it_get_exact(&it, k);
2566 folio = &it.ii_path.ip_leaf;
2567 result = iam_leaf_ops(folio)->rec_eq(folio, r);
2569 iam_it_rec_set(h, &it, r);
2579 * Delete existing record with key @k.
2581 * Return values: 0: success, -ENOENT: not-found, -ve: other error.
2583 * postcondition: ergo(result == 0 || result == -ENOENT,
2584 * !iam_lookup(c, k, *));
2586 int iam_delete(handle_t *h, struct iam_container *c, const struct iam_key *k,
2587 struct iam_path_descr *pd)
2589 struct iam_iterator it;
2592 iam_it_init(&it, c, IAM_IT_WRITE, pd);
2594 result = iam_it_get_exact(&it, k);
2596 iam_it_rec_delete(h, &it);
2602 int iam_root_limit(int rootgap, int blocksize, int size)
2607 limit = (blocksize - rootgap) / size;
2608 nlimit = blocksize / size;
2609 if (limit == nlimit)