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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 * Top-level entry points into iam module
35 * Author: Wang Di <wangdi@clusterfs.com>
36 * Author: Nikita Danilov <nikita@clusterfs.com>
40 * iam: big theory statement.
42 * iam (Index Access Module) is a module providing abstraction of persistent
43 * transactional container on top of generalized ldiskfs htree.
47 * - key, pointer, and record size specifiable per container.
49 * - trees taller than 2 index levels.
51 * - read/write to existing ldiskfs htree directories as iam containers.
53 * iam container is a tree, consisting of leaf nodes containing keys and
54 * records stored in this container, and index nodes, containing keys and
55 * pointers to leaf or index nodes.
57 * iam does not work with keys directly, instead it calls user-supplied key
58 * comparison function (->dpo_keycmp()).
60 * Pointers are (currently) interpreted as logical offsets (measured in
61 * blocksful) within underlying flat file on top of which iam tree lives.
65 * iam mostly tries to reuse existing htree formats.
67 * Format of index node:
69 * +-----+-------+-------+-------+------+-------+------------+
70 * | | count | | | | | |
71 * | gap | / | entry | entry | .... | entry | free space |
72 * | | limit | | | | | |
73 * +-----+-------+-------+-------+------+-------+------------+
75 * gap this part of node is never accessed by iam code. It
76 * exists for binary compatibility with ldiskfs htree (that,
77 * in turn, stores fake struct ext2_dirent for ext2
78 * compatibility), and to keep some unspecified per-node
79 * data. Gap can be different for root and non-root index
80 * nodes. Gap size can be specified for each container
81 * (gap of 0 is allowed).
83 * count/limit current number of entries in this node, and the maximal
84 * number of entries that can fit into node. count/limit
85 * has the same size as entry, and is itself counted in
88 * entry index entry: consists of a key immediately followed by
89 * a pointer to a child node. Size of a key and size of a
90 * pointer depends on container. Entry has neither
91 * alignment nor padding.
93 * free space portion of node new entries are added to
95 * Entries in index node are sorted by their key value.
97 * Format of a leaf node is not specified. Generic iam code accesses leaf
98 * nodes through ->id_leaf methods in struct iam_descr.
100 * The IAM root block is a special node, which contains the IAM descriptor.
101 * It is on disk format:
103 * +---------+-------+--------+---------+-------+------+-------+------------+
104 * |IAM desc | count | idle | | | | | |
105 * |(fix/var)| / | blocks | padding | entry | .... | entry | free space |
106 * | | limit | | | | | | |
107 * +---------+-------+--------+---------+-------+------+-------+------------+
109 * The padding length is calculated with the parameters in the IAM descriptor.
111 * The field "idle_blocks" is used to record empty leaf nodes, which have not
112 * been released but all contained entries in them have been removed. Usually,
113 * the idle blocks in the IAM should be reused when need to allocate new leaf
114 * nodes for new entries, it depends on the IAM hash functions to map the new
115 * entries to these idle blocks. Unfortunately, it is not easy to design some
116 * hash functions for such clever mapping, especially considering the insert/
117 * lookup performance.
119 * So the IAM recycles the empty leaf nodes, and put them into a per-file based
120 * idle blocks pool. If need some new leaf node, it will try to take idle block
121 * from such pool with priority, in spite of how the IAM hash functions to map
124 * The idle blocks pool is organized as a series of tables, and each table
125 * can be described as following (on-disk format):
127 * +---------+---------+---------+---------+------+---------+-------+
128 * | magic | count | next | logic | | logic | free |
129 * |(16 bits)|(16 bits)| table | blk # | .... | blk # | space |
130 * | | |(32 bits)|(32 bits)| |(32 bits)| |
131 * +---------+---------+---------+---------+------+---------+-------+
133 * The logic blk# for the first table is stored in the root node "idle_blocks".
137 #include <linux/module.h>
138 #include <linux/fs.h>
139 #include <linux/pagemap.h>
140 #include <linux/time.h>
141 #include <linux/fcntl.h>
142 #include <linux/stat.h>
143 #include <linux/string.h>
144 #include <linux/quotaops.h>
145 #include <linux/buffer_head.h>
147 #include <ldiskfs/ldiskfs.h>
148 #include <ldiskfs/xattr.h>
151 #include "osd_internal.h"
153 #include <ldiskfs/acl.h>
156 * List of all registered formats.
158 * No locking. Callers synchronize.
160 static LIST_HEAD(iam_formats);
162 void iam_format_register(struct iam_format *fmt)
164 list_add(&fmt->if_linkage, &iam_formats);
167 static struct buffer_head *
168 iam_load_idle_blocks(struct iam_container *c, iam_ptr_t blk)
170 struct inode *inode = c->ic_object;
171 struct iam_idle_head *head;
172 struct buffer_head *bh;
174 LASSERT(mutex_is_locked(&c->ic_idle_mutex));
179 bh = __ldiskfs_bread(NULL, inode, blk, 0);
180 if (IS_ERR_OR_NULL(bh)) {
181 CERROR("%s: cannot load idle blocks, blk = %u, err = %ld\n",
182 osd_ino2name(inode), blk, bh ? PTR_ERR(bh) : -EIO);
183 c->ic_idle_failed = 1;
189 head = (struct iam_idle_head *)(bh->b_data);
190 if (le16_to_cpu(head->iih_magic) != IAM_IDLE_HEADER_MAGIC) {
191 CERROR("%s: invalid idle block head, blk = %u, magic = %d\n",
192 osd_ino2name(inode), blk, le16_to_cpu(head->iih_magic));
194 c->ic_idle_failed = 1;
195 return ERR_PTR(-EBADF);
202 * Determine format of given container. This is done by scanning list of
203 * registered formats and calling ->if_guess() method of each in turn.
205 static int iam_format_guess(struct iam_container *c)
208 struct iam_format *fmt;
211 * XXX temporary initialization hook.
214 static int initialized = 0;
217 iam_lvar_format_init();
218 iam_lfix_format_init();
224 list_for_each_entry(fmt, &iam_formats, if_linkage) {
225 result = fmt->if_guess(c);
231 struct buffer_head *bh;
234 LASSERT(c->ic_root_bh != NULL);
236 idle_blocks = (__u32 *)(c->ic_root_bh->b_data +
237 c->ic_descr->id_root_gap +
238 sizeof(struct dx_countlimit));
239 mutex_lock(&c->ic_idle_mutex);
240 bh = iam_load_idle_blocks(c, le32_to_cpu(*idle_blocks));
241 if (bh != NULL && IS_ERR(bh))
242 result = PTR_ERR(bh);
245 mutex_unlock(&c->ic_idle_mutex);
252 * Initialize container @c.
254 int iam_container_init(struct iam_container *c,
255 struct iam_descr *descr, struct inode *inode)
257 memset(c, 0, sizeof *c);
259 c->ic_object = inode;
260 init_rwsem(&c->ic_sem);
261 dynlock_init(&c->ic_tree_lock);
262 mutex_init(&c->ic_idle_mutex);
267 * Determine container format.
269 int iam_container_setup(struct iam_container *c)
271 return iam_format_guess(c);
275 * Finalize container @c, release all resources.
277 void iam_container_fini(struct iam_container *c)
279 brelse(c->ic_idle_bh);
280 c->ic_idle_bh = NULL;
281 brelse(c->ic_root_bh);
282 c->ic_root_bh = NULL;
285 void iam_path_init(struct iam_path *path, struct iam_container *c,
286 struct iam_path_descr *pd)
288 memset(path, 0, sizeof *path);
289 path->ip_container = c;
290 path->ip_frame = path->ip_frames;
292 path->ip_leaf.il_path = path;
295 static void iam_leaf_fini(struct iam_leaf *leaf);
297 void iam_path_release(struct iam_path *path)
301 for (i = 0; i < ARRAY_SIZE(path->ip_frames); i++) {
302 if (path->ip_frames[i].bh != NULL) {
303 path->ip_frames[i].at_shifted = 0;
304 brelse(path->ip_frames[i].bh);
305 path->ip_frames[i].bh = NULL;
310 void iam_path_fini(struct iam_path *path)
312 iam_leaf_fini(&path->ip_leaf);
313 iam_path_release(path);
317 void iam_path_compat_init(struct iam_path_compat *path, struct inode *inode)
321 path->ipc_hinfo = &path->ipc_hinfo_area;
322 for (i = 0; i < ARRAY_SIZE(path->ipc_scratch); ++i)
323 path->ipc_descr.ipd_key_scratch[i] =
324 (struct iam_ikey *)&path->ipc_scratch[i];
326 iam_path_init(&path->ipc_path, &path->ipc_container, &path->ipc_descr);
329 void iam_path_compat_fini(struct iam_path_compat *path)
331 iam_path_fini(&path->ipc_path);
335 * Helper function initializing iam_path_descr and its key scratch area.
337 struct iam_path_descr *iam_ipd_alloc(void *area, int keysize)
339 struct iam_path_descr *ipd;
345 for (i = 0; i < ARRAY_SIZE(ipd->ipd_key_scratch); ++i, karea += keysize)
346 ipd->ipd_key_scratch[i] = karea;
350 void iam_ipd_free(struct iam_path_descr *ipd)
354 int iam_node_read(struct iam_container *c, iam_ptr_t ptr,
355 handle_t *h, struct buffer_head **bh)
358 * NB: it can be called by iam_lfix_guess() which is still at
359 * very early stage, c->ic_root_bh and c->ic_descr->id_ops
360 * haven't been intialized yet.
361 * Also, we don't have this for IAM dir.
363 if (c->ic_root_bh != NULL &&
364 c->ic_descr->id_ops->id_root_ptr(c) == ptr) {
365 get_bh(c->ic_root_bh);
370 *bh = __ldiskfs_bread(h, c->ic_object, (int)ptr, 0);
381 * Return pointer to current leaf record. Pointer is valid while corresponding
382 * leaf node is locked and pinned.
384 static struct iam_rec *iam_leaf_rec(const struct iam_leaf *leaf)
386 return iam_leaf_ops(leaf)->rec(leaf);
390 * Return pointer to the current leaf key. This function returns pointer to
391 * the key stored in node.
393 * Caller should assume that returned pointer is only valid while leaf node is
396 static struct iam_key *iam_leaf_key(const struct iam_leaf *leaf)
398 return iam_leaf_ops(leaf)->key(leaf);
401 static int iam_leaf_key_size(const struct iam_leaf *leaf)
403 return iam_leaf_ops(leaf)->key_size(leaf);
406 static struct iam_ikey *iam_leaf_ikey(const struct iam_leaf *leaf,
407 struct iam_ikey *key)
409 return iam_leaf_ops(leaf)->ikey(leaf, key);
412 static int iam_leaf_keycmp(const struct iam_leaf *leaf,
413 const struct iam_key *key)
415 return iam_leaf_ops(leaf)->key_cmp(leaf, key);
418 static int iam_leaf_keyeq(const struct iam_leaf *leaf,
419 const struct iam_key *key)
421 return iam_leaf_ops(leaf)->key_eq(leaf, key);
424 #if LDISKFS_INVARIANT_ON
425 static int iam_path_check(struct iam_path *p)
430 struct iam_descr *param;
433 param = iam_path_descr(p);
434 for (i = 0; result && i < ARRAY_SIZE(p->ip_frames); ++i) {
435 f = &p->ip_frames[i];
437 result = dx_node_check(p, f);
439 result = !param->id_ops->id_node_check(p, f);
442 if (result && p->ip_leaf.il_bh != NULL)
445 ldiskfs_std_error(iam_path_obj(p)->i_sb, result);
451 static int iam_leaf_load(struct iam_path *path)
455 struct iam_container *c;
456 struct buffer_head *bh;
457 struct iam_leaf *leaf;
458 struct iam_descr *descr;
460 c = path->ip_container;
461 leaf = &path->ip_leaf;
462 descr = iam_path_descr(path);
463 block = path->ip_frame->leaf;
466 printk(KERN_EMERG "wrong leaf: %lu %d [%p %p %p]\n",
467 (long unsigned)path->ip_frame->leaf,
468 dx_get_count(dx_node_get_entries(path, path->ip_frame)),
469 path->ip_frames[0].bh, path->ip_frames[1].bh,
470 path->ip_frames[2].bh);
472 err = descr->id_ops->id_node_read(c, block, NULL, &bh);
475 leaf->il_curidx = block;
476 err = iam_leaf_ops(leaf)->init(leaf);
481 static void iam_unlock_htree(struct iam_container *ic,
482 struct dynlock_handle *lh)
485 dynlock_unlock(&ic->ic_tree_lock, lh);
489 static void iam_leaf_unlock(struct iam_leaf *leaf)
491 if (leaf->il_lock != NULL) {
492 iam_unlock_htree(iam_leaf_container(leaf),
495 leaf->il_lock = NULL;
499 static void iam_leaf_fini(struct iam_leaf *leaf)
501 if (leaf->il_path != NULL) {
502 iam_leaf_unlock(leaf);
503 iam_leaf_ops(leaf)->fini(leaf);
512 static void iam_leaf_start(struct iam_leaf *folio)
514 iam_leaf_ops(folio)->start(folio);
517 void iam_leaf_next(struct iam_leaf *folio)
519 iam_leaf_ops(folio)->next(folio);
522 static void iam_leaf_rec_add(struct iam_leaf *leaf, const struct iam_key *key,
523 const struct iam_rec *rec)
525 iam_leaf_ops(leaf)->rec_add(leaf, key, rec);
528 static void iam_rec_del(struct iam_leaf *leaf, int shift)
530 iam_leaf_ops(leaf)->rec_del(leaf, shift);
533 int iam_leaf_at_end(const struct iam_leaf *leaf)
535 return iam_leaf_ops(leaf)->at_end(leaf);
538 static void iam_leaf_split(struct iam_leaf *l, struct buffer_head **bh,
541 iam_leaf_ops(l)->split(l, bh, nr);
544 static inline int iam_leaf_empty(struct iam_leaf *l)
546 return iam_leaf_ops(l)->leaf_empty(l);
549 int iam_leaf_can_add(const struct iam_leaf *l,
550 const struct iam_key *k, const struct iam_rec *r)
552 return iam_leaf_ops(l)->can_add(l, k, r);
555 static int iam_txn_dirty(handle_t *handle,
556 struct iam_path *path, struct buffer_head *bh)
560 result = ldiskfs_handle_dirty_metadata(handle, NULL, bh);
562 ldiskfs_std_error(iam_path_obj(path)->i_sb, result);
566 static int iam_txn_add(handle_t *handle,
567 struct iam_path *path, struct buffer_head *bh)
571 result = ldiskfs_journal_get_write_access(handle, bh);
573 ldiskfs_std_error(iam_path_obj(path)->i_sb, result);
577 /***********************************************************************/
578 /* iterator interface */
579 /***********************************************************************/
581 static enum iam_it_state it_state(const struct iam_iterator *it)
587 * Helper function returning scratch key.
589 static struct iam_container *iam_it_container(const struct iam_iterator *it)
591 return it->ii_path.ip_container;
594 static inline int it_keycmp(const struct iam_iterator *it,
595 const struct iam_key *k)
597 return iam_leaf_keycmp(&it->ii_path.ip_leaf, k);
600 static inline int it_keyeq(const struct iam_iterator *it,
601 const struct iam_key *k)
603 return iam_leaf_keyeq(&it->ii_path.ip_leaf, k);
606 static int it_ikeycmp(const struct iam_iterator *it, const struct iam_ikey *ik)
608 return iam_ikeycmp(it->ii_path.ip_container,
609 iam_leaf_ikey(&it->ii_path.ip_leaf,
610 iam_path_ikey(&it->ii_path, 0)), ik);
613 static inline int it_at_rec(const struct iam_iterator *it)
615 return !iam_leaf_at_end(&it->ii_path.ip_leaf);
618 static inline int it_before(const struct iam_iterator *it)
620 return it_state(it) == IAM_IT_SKEWED && it_at_rec(it);
624 * Helper wrapper around iam_it_get(): returns 0 (success) only when record
625 * with exactly the same key as asked is found.
627 static int iam_it_get_exact(struct iam_iterator *it, const struct iam_key *k)
631 result = iam_it_get(it, k);
634 else if (result == 0)
636 * Return -ENOENT if cursor is located above record with a key
637 * different from one specified, or in the empty leaf.
639 * XXX returning -ENOENT only works if iam_it_get() never
640 * returns -ENOENT as a legitimate error.
646 void iam_container_write_lock(struct iam_container *ic)
648 down_write(&ic->ic_sem);
651 void iam_container_write_unlock(struct iam_container *ic)
653 up_write(&ic->ic_sem);
656 void iam_container_read_lock(struct iam_container *ic)
658 down_read(&ic->ic_sem);
661 void iam_container_read_unlock(struct iam_container *ic)
663 up_read(&ic->ic_sem);
667 * Initialize iterator to IAM_IT_DETACHED state.
669 * postcondition: it_state(it) == IAM_IT_DETACHED
671 int iam_it_init(struct iam_iterator *it, struct iam_container *c, __u32 flags,
672 struct iam_path_descr *pd)
674 memset(it, 0, sizeof *it);
675 it->ii_flags = flags;
676 it->ii_state = IAM_IT_DETACHED;
677 iam_path_init(&it->ii_path, c, pd);
682 * Finalize iterator and release all resources.
684 * precondition: it_state(it) == IAM_IT_DETACHED
686 void iam_it_fini(struct iam_iterator *it)
688 assert_corr(it_state(it) == IAM_IT_DETACHED);
689 iam_path_fini(&it->ii_path);
693 * this locking primitives are used to protect parts
694 * of dir's htree. protection unit is block: leaf or index
696 static struct dynlock_handle *iam_lock_htree(struct iam_container *ic,
698 enum dynlock_type lt)
700 return dynlock_lock(&ic->ic_tree_lock, value, lt, GFP_NOFS);
703 static int iam_index_lock(struct iam_path *path, struct dynlock_handle **lh)
707 for (f = path->ip_frame; f >= path->ip_frames; --f, ++lh) {
709 *lh = iam_lock_htree(path->ip_container, f->curidx, DLT_READ);
717 * Fast check for frame consistency.
719 static int iam_check_fast(struct iam_path *path, struct iam_frame *frame)
721 struct iam_container *bag;
722 struct iam_entry *next;
723 struct iam_entry *last;
724 struct iam_entry *entries;
725 struct iam_entry *at;
727 bag = path->ip_container;
729 entries = frame->entries;
730 last = iam_entry_shift(path, entries, dx_get_count(entries) - 1);
732 if (unlikely(at > last))
735 if (unlikely(dx_get_block(path, at) != frame->leaf))
738 if (unlikely(iam_ikeycmp(bag, iam_ikey_at(path, at),
739 path->ip_ikey_target) > 0))
742 next = iam_entry_shift(path, at, +1);
744 if (unlikely(iam_ikeycmp(bag, iam_ikey_at(path, next),
745 path->ip_ikey_target) <= 0))
751 int dx_index_is_compat(struct iam_path *path)
753 return iam_path_descr(path) == NULL;
759 * search position of specified hash in index
763 static struct iam_entry *iam_find_position(struct iam_path *path,
764 struct iam_frame *frame)
771 count = dx_get_count(frame->entries);
772 assert_corr(count && count <= dx_get_limit(frame->entries));
773 p = iam_entry_shift(path, frame->entries,
774 dx_index_is_compat(path) ? 1 : 2);
775 q = iam_entry_shift(path, frame->entries, count - 1);
777 m = iam_entry_shift(path, p, iam_entry_diff(path, q, p) / 2);
778 if (iam_ikeycmp(path->ip_container, iam_ikey_at(path, m),
779 path->ip_ikey_target) > 0)
780 q = iam_entry_shift(path, m, -1);
782 p = iam_entry_shift(path, m, +1);
784 return iam_entry_shift(path, p, -1);
789 static iam_ptr_t iam_find_ptr(struct iam_path *path, struct iam_frame *frame)
791 return dx_get_block(path, iam_find_position(path, frame));
794 void iam_insert_key(struct iam_path *path, struct iam_frame *frame,
795 const struct iam_ikey *key, iam_ptr_t ptr)
797 struct iam_entry *entries = frame->entries;
798 struct iam_entry *new = iam_entry_shift(path, frame->at, +1);
799 int count = dx_get_count(entries);
802 * Unfortunately we cannot assert this, as this function is sometimes
803 * called by VFS under i_sem and without pdirops lock.
805 assert_corr(1 || iam_frame_is_locked(path, frame));
806 assert_corr(count < dx_get_limit(entries));
807 assert_corr(frame->at < iam_entry_shift(path, entries, count));
808 assert_inv(dx_node_check(path, frame));
810 memmove(iam_entry_shift(path, new, 1), new,
811 (char *)iam_entry_shift(path, entries, count) - (char *)new);
812 dx_set_ikey(path, new, key);
813 dx_set_block(path, new, ptr);
814 dx_set_count(entries, count + 1);
815 assert_inv(dx_node_check(path, frame));
818 void iam_insert_key_lock(struct iam_path *path, struct iam_frame *frame,
819 const struct iam_ikey *key, iam_ptr_t ptr)
821 iam_lock_bh(frame->bh);
822 iam_insert_key(path, frame, key, ptr);
823 iam_unlock_bh(frame->bh);
826 * returns 0 if path was unchanged, -EAGAIN otherwise.
828 static int iam_check_path(struct iam_path *path, struct iam_frame *frame)
832 iam_lock_bh(frame->bh);
833 equal = iam_check_fast(path, frame) == 0 ||
834 frame->leaf == iam_find_ptr(path, frame);
835 DX_DEVAL(iam_lock_stats.dls_bh_again += !equal);
836 iam_unlock_bh(frame->bh);
838 return equal ? 0 : -EAGAIN;
841 static int iam_lookup_try(struct iam_path *path)
847 struct iam_descr *param;
848 struct iam_frame *frame;
849 struct iam_container *c;
851 param = iam_path_descr(path);
852 c = path->ip_container;
854 ptr = param->id_ops->id_root_ptr(c);
855 for (frame = path->ip_frames, i = 0; i <= path->ip_indirect;
857 err = param->id_ops->id_node_read(c, (iam_ptr_t)ptr, NULL,
861 iam_lock_bh(frame->bh);
863 * node must be initialized under bh lock because concurrent
864 * creation procedure may change it and iam_lookup_try() will
865 * see obsolete tree height. -bzzz
870 if (LDISKFS_INVARIANT_ON) {
871 err = param->id_ops->id_node_check(path, frame);
876 err = param->id_ops->id_node_load(path, frame);
880 assert_inv(dx_node_check(path, frame));
882 * splitting may change root index block and move hash we're
883 * looking for into another index block so, we have to check
884 * this situation and repeat from begining if path got changed
888 err = iam_check_path(path, frame - 1);
893 frame->at = iam_find_position(path, frame);
895 frame->leaf = ptr = dx_get_block(path, frame->at);
897 iam_unlock_bh(frame->bh);
901 iam_unlock_bh(frame->bh);
902 path->ip_frame = --frame;
906 static int __iam_path_lookup(struct iam_path *path)
911 for (i = 0; i < DX_MAX_TREE_HEIGHT; ++ i)
912 assert(path->ip_frames[i].bh == NULL);
915 err = iam_lookup_try(path);
919 } while (err == -EAGAIN);
925 * returns 0 if path was unchanged, -EAGAIN otherwise.
927 static int iam_check_full_path(struct iam_path *path, int search)
929 struct iam_frame *bottom;
930 struct iam_frame *scan;
936 for (bottom = path->ip_frames, i = 0;
937 i < DX_MAX_TREE_HEIGHT && bottom->bh != NULL; ++bottom, ++i) {
938 ; /* find last filled in frame */
942 * Lock frames, bottom to top.
944 for (scan = bottom - 1; scan >= path->ip_frames; --scan)
945 iam_lock_bh(scan->bh);
947 * Check them top to bottom.
950 for (scan = path->ip_frames; scan < bottom; ++scan) {
951 struct iam_entry *pos;
954 if (iam_check_fast(path, scan) == 0)
957 pos = iam_find_position(path, scan);
958 if (scan->leaf != dx_get_block(path, pos)) {
964 pos = iam_entry_shift(path, scan->entries,
965 dx_get_count(scan->entries) - 1);
966 if (scan->at > pos ||
967 scan->leaf != dx_get_block(path, scan->at)) {
975 * Unlock top to bottom.
977 for (scan = path->ip_frames; scan < bottom; ++scan)
978 iam_unlock_bh(scan->bh);
979 DX_DEVAL(iam_lock_stats.dls_bh_full_again += !!result);
987 * Performs path lookup and returns with found leaf (if any) locked by htree
990 static int iam_lookup_lock(struct iam_path *path,
991 struct dynlock_handle **dl, enum dynlock_type lt)
995 while ((result = __iam_path_lookup(path)) == 0) {
997 *dl = iam_lock_htree(path->ip_container, path->ip_frame->leaf,
1000 iam_path_fini(path);
1004 do_corr(schedule());
1006 * while locking leaf we just found may get split so we need
1007 * to check this -bzzz
1009 if (iam_check_full_path(path, 1) == 0)
1011 iam_unlock_htree(path->ip_container, *dl);
1013 iam_path_fini(path);
1018 * Performs tree top-to-bottom traversal starting from root, and loads leaf
1021 static int iam_path_lookup(struct iam_path *path, int index)
1023 struct iam_leaf *leaf;
1026 leaf = &path->ip_leaf;
1027 result = iam_lookup_lock(path, &leaf->il_lock, DLT_WRITE);
1028 assert_inv(iam_path_check(path));
1029 do_corr(schedule());
1031 result = iam_leaf_load(path);
1033 do_corr(schedule());
1035 result = iam_leaf_ops(leaf)->
1036 ilookup(leaf, path->ip_ikey_target);
1038 result = iam_leaf_ops(leaf)->
1039 lookup(leaf, path->ip_key_target);
1040 do_corr(schedule());
1043 iam_leaf_unlock(leaf);
1049 * Common part of iam_it_{i,}get().
1051 static int __iam_it_get(struct iam_iterator *it, int index)
1055 assert_corr(it_state(it) == IAM_IT_DETACHED);
1057 result = iam_path_lookup(&it->ii_path, index);
1061 collision = result & IAM_LOOKUP_LAST;
1062 switch (result & ~IAM_LOOKUP_LAST) {
1063 case IAM_LOOKUP_EXACT:
1065 it->ii_state = IAM_IT_ATTACHED;
1069 it->ii_state = IAM_IT_ATTACHED;
1071 case IAM_LOOKUP_BEFORE:
1072 case IAM_LOOKUP_EMPTY:
1074 it->ii_state = IAM_IT_SKEWED;
1079 result |= collision;
1082 * See iam_it_get_exact() for explanation.
1084 assert_corr(result != -ENOENT);
1089 * Correct hash, but not the same key was found, iterate through hash
1090 * collision chain, looking for correct record.
1092 static int iam_it_collision(struct iam_iterator *it)
1096 assert(ergo(it_at_rec(it), !it_keyeq(it, it->ii_path.ip_key_target)));
1098 while ((result = iam_it_next(it)) == 0) {
1099 do_corr(schedule());
1100 if (it_ikeycmp(it, it->ii_path.ip_ikey_target) != 0)
1102 if (it_keyeq(it, it->ii_path.ip_key_target))
1109 * Attach iterator. After successful completion, @it points to record with
1110 * least key not larger than @k.
1112 * Return value: 0: positioned on existing record,
1113 * +ve: exact position found,
1116 * precondition: it_state(it) == IAM_IT_DETACHED
1117 * postcondition: ergo(result == 0 && it_state(it) == IAM_IT_ATTACHED,
1118 * it_keycmp(it, k) <= 0)
1120 int iam_it_get(struct iam_iterator *it, const struct iam_key *k)
1124 assert_corr(it_state(it) == IAM_IT_DETACHED);
1126 it->ii_path.ip_ikey_target = NULL;
1127 it->ii_path.ip_key_target = k;
1129 result = __iam_it_get(it, 0);
1131 if (result == IAM_LOOKUP_LAST) {
1132 result = iam_it_collision(it);
1136 result = __iam_it_get(it, 0);
1141 result &= ~IAM_LOOKUP_LAST;
1143 assert_corr(ergo(result > 0, it_keycmp(it, k) == 0));
1144 assert_corr(ergo(result == 0 && it_state(it) == IAM_IT_ATTACHED,
1145 it_keycmp(it, k) <= 0));
1150 * Attach iterator by index key.
1152 static int iam_it_iget(struct iam_iterator *it, const struct iam_ikey *k)
1154 assert_corr(it_state(it) == IAM_IT_DETACHED);
1156 it->ii_path.ip_ikey_target = k;
1157 return __iam_it_get(it, 1) & ~IAM_LOOKUP_LAST;
1161 * Attach iterator, and assure it points to the record (not skewed).
1163 * Return value: 0: positioned on existing record,
1164 * +ve: exact position found,
1167 * precondition: it_state(it) == IAM_IT_DETACHED &&
1168 * !(it->ii_flags&IAM_IT_WRITE)
1169 * postcondition: ergo(result == 0, it_state(it) == IAM_IT_ATTACHED)
1171 int iam_it_get_at(struct iam_iterator *it, const struct iam_key *k)
1175 assert_corr(it_state(it) == IAM_IT_DETACHED &&
1176 !(it->ii_flags&IAM_IT_WRITE));
1177 result = iam_it_get(it, k);
1179 if (it_state(it) != IAM_IT_ATTACHED) {
1180 assert_corr(it_state(it) == IAM_IT_SKEWED);
1181 result = iam_it_next(it);
1184 assert_corr(ergo(result >= 0, it_state(it) == IAM_IT_ATTACHED));
1189 * Duplicates iterator.
1191 * postcondition: it_state(dst) == it_state(src) &&
1192 * iam_it_container(dst) == iam_it_container(src) &&
1193 * dst->ii_flags = src->ii_flags &&
1194 * ergo(it_state(src) == IAM_IT_ATTACHED,
1195 * iam_it_rec_get(dst) == iam_it_rec_get(src) &&
1196 * iam_it_key_get(dst) == iam_it_key_get(src))
1198 void iam_it_dup(struct iam_iterator *dst, const struct iam_iterator *src)
1200 dst->ii_flags = src->ii_flags;
1201 dst->ii_state = src->ii_state;
1202 /* XXX not yet. iam_path_dup(&dst->ii_path, &src->ii_path); */
1204 * XXX: duplicate lock.
1206 assert_corr(it_state(dst) == it_state(src));
1207 assert_corr(iam_it_container(dst) == iam_it_container(src));
1208 assert_corr(dst->ii_flags = src->ii_flags);
1209 assert_corr(ergo(it_state(src) == IAM_IT_ATTACHED,
1210 iam_it_rec_get(dst) == iam_it_rec_get(src) &&
1211 iam_it_key_get(dst) == iam_it_key_get(src)));
1215 * Detach iterator. Does nothing it detached state.
1217 * postcondition: it_state(it) == IAM_IT_DETACHED
1219 void iam_it_put(struct iam_iterator *it)
1221 if (it->ii_state != IAM_IT_DETACHED) {
1222 it->ii_state = IAM_IT_DETACHED;
1223 iam_leaf_fini(&it->ii_path.ip_leaf);
1227 static struct iam_ikey *iam_it_ikey_get(const struct iam_iterator *it,
1228 struct iam_ikey *ikey);
1232 * This function increments the frame pointer to search the next leaf
1233 * block, and reads in the necessary intervening nodes if the search
1234 * should be necessary. Whether or not the search is necessary is
1235 * controlled by the hash parameter. If the hash value is even, then
1236 * the search is only continued if the next block starts with that
1237 * hash value. This is used if we are searching for a specific file.
1239 * If the hash value is HASH_NB_ALWAYS, then always go to the next block.
1241 * This function returns 1 if the caller should continue to search,
1242 * or 0 if it should not. If there is an error reading one of the
1243 * index blocks, it will a negative error code.
1245 * If start_hash is non-null, it will be filled in with the starting
1246 * hash of the next page.
1248 static int iam_htree_advance(struct inode *dir, __u32 hash,
1249 struct iam_path *path, __u32 *start_hash,
1252 struct iam_frame *p;
1253 struct buffer_head *bh;
1254 int err, num_frames = 0;
1259 * Find the next leaf page by incrementing the frame pointer.
1260 * If we run out of entries in the interior node, loop around and
1261 * increment pointer in the parent node. When we break out of
1262 * this loop, num_frames indicates the number of interior
1263 * nodes need to be read.
1266 do_corr(schedule());
1271 p->at = iam_entry_shift(path, p->at, +1);
1272 if (p->at < iam_entry_shift(path, p->entries,
1273 dx_get_count(p->entries))) {
1274 p->leaf = dx_get_block(path, p->at);
1275 iam_unlock_bh(p->bh);
1278 iam_unlock_bh(p->bh);
1279 if (p == path->ip_frames)
1291 * If the hash is 1, then continue only if the next page has a
1292 * continuation hash of any value. This is used for readdir
1293 * handling. Otherwise, check to see if the hash matches the
1294 * desired contiuation hash. If it doesn't, return since
1295 * there's no point to read in the successive index pages.
1297 dx_get_ikey(path, p->at, (struct iam_ikey *)&bhash);
1299 *start_hash = bhash;
1300 if ((hash & 1) == 0) {
1301 if ((bhash & ~1) != hash)
1306 * If the hash is HASH_NB_ALWAYS, we always go to the next
1307 * block so no check is necessary
1309 while (num_frames--) {
1312 do_corr(schedule());
1314 idx = p->leaf = dx_get_block(path, p->at);
1315 iam_unlock_bh(p->bh);
1316 err = iam_path_descr(path)->id_ops->
1317 id_node_read(path->ip_container, idx, NULL, &bh);
1319 return err; /* Failure */
1322 assert_corr(p->bh != bh);
1324 p->entries = dx_node_get_entries(path, p);
1325 p->at = iam_entry_shift(path, p->entries, !compat);
1326 assert_corr(p->curidx != idx);
1329 assert_corr(p->leaf != dx_get_block(path, p->at));
1330 p->leaf = dx_get_block(path, p->at);
1331 iam_unlock_bh(p->bh);
1332 assert_inv(dx_node_check(path, p));
1337 static inline int iam_index_advance(struct iam_path *path)
1339 return iam_htree_advance(iam_path_obj(path), 0, path, NULL, 0);
1342 static void iam_unlock_array(struct iam_container *ic,
1343 struct dynlock_handle **lh)
1347 for (i = 0; i < DX_MAX_TREE_HEIGHT; ++i, ++lh) {
1349 iam_unlock_htree(ic, *lh);
1355 * Advance index part of @path to point to the next leaf. Returns 1 on
1356 * success, 0, when end of container was reached. Leaf node is locked.
1358 int iam_index_next(struct iam_container *c, struct iam_path *path)
1361 struct dynlock_handle *lh[DX_MAX_TREE_HEIGHT] = { NULL, };
1365 * Locking for iam_index_next()... is to be described.
1368 cursor = path->ip_frame->leaf;
1371 result = iam_index_lock(path, lh);
1372 do_corr(schedule());
1376 result = iam_check_full_path(path, 0);
1377 if (result == 0 && cursor == path->ip_frame->leaf) {
1378 result = iam_index_advance(path);
1380 assert_corr(result == 0 ||
1381 cursor != path->ip_frame->leaf);
1385 iam_unlock_array(c, lh);
1387 iam_path_release(path);
1388 do_corr(schedule());
1390 result = __iam_path_lookup(path);
1394 while (path->ip_frame->leaf != cursor) {
1395 do_corr(schedule());
1397 result = iam_index_lock(path, lh);
1398 do_corr(schedule());
1402 result = iam_check_full_path(path, 0);
1406 result = iam_index_advance(path);
1408 CERROR("cannot find cursor : %u\n",
1414 result = iam_check_full_path(path, 0);
1417 iam_unlock_array(c, lh);
1419 } while (result == -EAGAIN);
1423 iam_unlock_array(c, lh);
1428 * Move iterator one record right.
1430 * Return value: 0: success,
1431 * +1: end of container reached
1434 * precondition: (it_state(it) == IAM_IT_ATTACHED ||
1435 * it_state(it) == IAM_IT_SKEWED) && it->ii_flags&IAM_IT_MOVE
1436 * postcondition: ergo(result == 0, it_state(it) == IAM_IT_ATTACHED) &&
1437 * ergo(result > 0, it_state(it) == IAM_IT_DETACHED)
1439 int iam_it_next(struct iam_iterator *it)
1442 struct iam_path *path;
1443 struct iam_leaf *leaf;
1445 do_corr(struct iam_ikey *ik_orig);
1447 /* assert_corr(it->ii_flags&IAM_IT_MOVE); */
1448 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
1449 it_state(it) == IAM_IT_SKEWED);
1451 path = &it->ii_path;
1452 leaf = &path->ip_leaf;
1454 assert_corr(iam_leaf_is_locked(leaf));
1457 do_corr(ik_orig = it_at_rec(it) ?
1458 iam_it_ikey_get(it, iam_path_ikey(path, 2)) : NULL);
1459 if (it_before(it)) {
1460 assert_corr(!iam_leaf_at_end(leaf));
1461 it->ii_state = IAM_IT_ATTACHED;
1463 if (!iam_leaf_at_end(leaf))
1464 /* advance within leaf node */
1465 iam_leaf_next(leaf);
1467 * multiple iterations may be necessary due to empty leaves.
1469 while (result == 0 && iam_leaf_at_end(leaf)) {
1470 do_corr(schedule());
1471 /* advance index portion of the path */
1472 result = iam_index_next(iam_it_container(it), path);
1473 assert_corr(iam_leaf_is_locked(leaf));
1475 struct dynlock_handle *lh;
1476 lh = iam_lock_htree(iam_it_container(it),
1477 path->ip_frame->leaf,
1480 iam_leaf_fini(leaf);
1482 result = iam_leaf_load(path);
1484 iam_leaf_start(leaf);
1487 } else if (result == 0)
1488 /* end of container reached */
1494 it->ii_state = IAM_IT_ATTACHED;
1496 assert_corr(ergo(result == 0, it_state(it) == IAM_IT_ATTACHED));
1497 assert_corr(ergo(result > 0, it_state(it) == IAM_IT_DETACHED));
1498 assert_corr(ergo(result == 0 && ik_orig != NULL,
1499 it_ikeycmp(it, ik_orig) >= 0));
1504 * Return pointer to the record under iterator.
1506 * precondition: it_state(it) == IAM_IT_ATTACHED && it_at_rec(it)
1507 * postcondition: it_state(it) == IAM_IT_ATTACHED
1509 struct iam_rec *iam_it_rec_get(const struct iam_iterator *it)
1511 assert_corr(it_state(it) == IAM_IT_ATTACHED);
1512 assert_corr(it_at_rec(it));
1513 return iam_leaf_rec(&it->ii_path.ip_leaf);
1516 static void iam_it_reccpy(struct iam_iterator *it, const struct iam_rec *r)
1518 struct iam_leaf *folio;
1520 folio = &it->ii_path.ip_leaf;
1521 iam_leaf_ops(folio)->rec_set(folio, r);
1525 * Replace contents of record under iterator.
1527 * precondition: it_state(it) == IAM_IT_ATTACHED &&
1528 * it->ii_flags&IAM_IT_WRITE
1529 * postcondition: it_state(it) == IAM_IT_ATTACHED &&
1530 * ergo(result == 0, !memcmp(iam_it_rec_get(it), r, ...))
1532 int iam_it_rec_set(handle_t *h,
1533 struct iam_iterator *it, const struct iam_rec *r)
1536 struct iam_path *path;
1537 struct buffer_head *bh;
1539 assert_corr(it_state(it) == IAM_IT_ATTACHED &&
1540 it->ii_flags&IAM_IT_WRITE);
1541 assert_corr(it_at_rec(it));
1543 path = &it->ii_path;
1544 bh = path->ip_leaf.il_bh;
1545 result = iam_txn_add(h, path, bh);
1547 iam_it_reccpy(it, r);
1548 result = iam_txn_dirty(h, path, bh);
1554 * Return pointer to the index key under iterator.
1556 * precondition: it_state(it) == IAM_IT_ATTACHED ||
1557 * it_state(it) == IAM_IT_SKEWED
1559 static struct iam_ikey *iam_it_ikey_get(const struct iam_iterator *it,
1560 struct iam_ikey *ikey)
1562 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
1563 it_state(it) == IAM_IT_SKEWED);
1564 assert_corr(it_at_rec(it));
1565 return iam_leaf_ikey(&it->ii_path.ip_leaf, ikey);
1569 * Return pointer to the key under iterator.
1571 * precondition: it_state(it) == IAM_IT_ATTACHED ||
1572 * it_state(it) == IAM_IT_SKEWED
1574 struct iam_key *iam_it_key_get(const struct iam_iterator *it)
1576 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
1577 it_state(it) == IAM_IT_SKEWED);
1578 assert_corr(it_at_rec(it));
1579 return iam_leaf_key(&it->ii_path.ip_leaf);
1583 * Return size of key under iterator (in bytes)
1585 * precondition: it_state(it) == IAM_IT_ATTACHED ||
1586 * it_state(it) == IAM_IT_SKEWED
1588 int iam_it_key_size(const struct iam_iterator *it)
1590 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
1591 it_state(it) == IAM_IT_SKEWED);
1592 assert_corr(it_at_rec(it));
1593 return iam_leaf_key_size(&it->ii_path.ip_leaf);
1596 static struct buffer_head *
1597 iam_new_node(handle_t *h, struct iam_container *c, iam_ptr_t *b, int *e)
1599 struct inode *inode = c->ic_object;
1600 struct buffer_head *bh = NULL;
1601 struct iam_idle_head *head;
1602 struct buffer_head *idle;
1606 if (c->ic_idle_bh == NULL)
1609 mutex_lock(&c->ic_idle_mutex);
1610 if (unlikely(c->ic_idle_bh == NULL)) {
1611 mutex_unlock(&c->ic_idle_mutex);
1615 head = (struct iam_idle_head *)(c->ic_idle_bh->b_data);
1616 count = le16_to_cpu(head->iih_count);
1618 *e = ldiskfs_journal_get_write_access(h, c->ic_idle_bh);
1623 *b = le32_to_cpu(head->iih_blks[count]);
1624 head->iih_count = cpu_to_le16(count);
1625 *e = ldiskfs_handle_dirty_metadata(h, inode, c->ic_idle_bh);
1629 mutex_unlock(&c->ic_idle_mutex);
1630 bh = __ldiskfs_bread(NULL, inode, *b, 0);
1631 if (IS_ERR_OR_NULL(bh)) {
1641 /* The block itself which contains the iam_idle_head is
1642 * also an idle block, and can be used as the new node. */
1643 idle_blocks = (__u32 *)(c->ic_root_bh->b_data +
1644 c->ic_descr->id_root_gap +
1645 sizeof(struct dx_countlimit));
1646 *e = ldiskfs_journal_get_write_access(h, c->ic_root_bh);
1650 *b = le32_to_cpu(*idle_blocks);
1651 iam_lock_bh(c->ic_root_bh);
1652 *idle_blocks = head->iih_next;
1653 iam_unlock_bh(c->ic_root_bh);
1654 *e = ldiskfs_handle_dirty_metadata(h, inode, c->ic_root_bh);
1656 iam_lock_bh(c->ic_root_bh);
1657 *idle_blocks = cpu_to_le32(*b);
1658 iam_unlock_bh(c->ic_root_bh);
1663 idle = iam_load_idle_blocks(c, le32_to_cpu(*idle_blocks));
1664 if (idle != NULL && IS_ERR(idle)) {
1666 c->ic_idle_bh = NULL;
1671 c->ic_idle_bh = idle;
1672 mutex_unlock(&c->ic_idle_mutex);
1675 /* get write access for the found buffer head */
1676 *e = ldiskfs_journal_get_write_access(h, bh);
1680 ldiskfs_std_error(inode->i_sb, *e);
1682 /* Clear the reused node as new node does. */
1683 memset(bh->b_data, 0, inode->i_sb->s_blocksize);
1684 set_buffer_uptodate(bh);
1689 bh = osd_ldiskfs_append(h, inode, b);
1698 mutex_unlock(&c->ic_idle_mutex);
1699 ldiskfs_std_error(inode->i_sb, *e);
1704 * Insertion of new record. Interaction with jbd during non-trivial case (when
1705 * split happens) is as following:
1707 * - new leaf node is involved into transaction by iam_new_node();
1709 * - old leaf node is involved into transaction by iam_add_rec();
1711 * - leaf where insertion point ends in, is marked dirty by iam_add_rec();
1713 * - leaf without insertion point is marked dirty (as @new_leaf) by
1716 * - split index nodes are involved into transaction and marked dirty by
1717 * split_index_node().
1719 * - "safe" index node, which is no split, but where new pointer is inserted
1720 * is involved into transaction and marked dirty by split_index_node().
1722 * - index node where pointer to new leaf is inserted is involved into
1723 * transaction by split_index_node() and marked dirty by iam_add_rec().
1725 * - inode is marked dirty by iam_add_rec().
1729 static int iam_new_leaf(handle_t *handle, struct iam_leaf *leaf)
1733 struct buffer_head *new_leaf;
1734 struct buffer_head *old_leaf;
1735 struct iam_container *c;
1737 struct iam_path *path;
1739 c = iam_leaf_container(leaf);
1740 path = leaf->il_path;
1743 new_leaf = iam_new_node(handle, c, &blknr, &err);
1744 do_corr(schedule());
1745 if (new_leaf != NULL) {
1746 struct dynlock_handle *lh;
1748 lh = iam_lock_htree(c, blknr, DLT_WRITE);
1749 do_corr(schedule());
1751 iam_leaf_ops(leaf)->init_new(c, new_leaf);
1752 do_corr(schedule());
1753 old_leaf = leaf->il_bh;
1754 iam_leaf_split(leaf, &new_leaf, blknr);
1755 if (old_leaf != leaf->il_bh) {
1757 * Switched to the new leaf.
1759 iam_leaf_unlock(leaf);
1761 path->ip_frame->leaf = blknr;
1763 iam_unlock_htree(path->ip_container, lh);
1764 do_corr(schedule());
1765 err = iam_txn_dirty(handle, path, new_leaf);
1767 err = ldiskfs_mark_inode_dirty(handle, obj);
1768 do_corr(schedule());
1773 assert_inv(iam_path_check(iam_leaf_path(leaf)));
1777 static inline void dx_set_limit(struct iam_entry *entries, unsigned value)
1779 ((struct dx_countlimit *) entries)->limit = cpu_to_le16(value);
1782 static int iam_shift_entries(struct iam_path *path,
1783 struct iam_frame *frame, unsigned count,
1784 struct iam_entry *entries, struct iam_entry *entries2,
1791 struct iam_frame *parent = frame - 1;
1792 struct iam_ikey *pivot = iam_path_ikey(path, 3);
1794 delta = dx_index_is_compat(path) ? 0 : +1;
1796 count1 = count/2 + delta;
1797 count2 = count - count1;
1798 dx_get_ikey(path, iam_entry_shift(path, entries, count1), pivot);
1800 dxtrace(printk("Split index %d/%d\n", count1, count2));
1802 memcpy((char *) iam_entry_shift(path, entries2, delta),
1803 (char *) iam_entry_shift(path, entries, count1),
1804 count2 * iam_entry_size(path));
1806 dx_set_count(entries2, count2 + delta);
1807 dx_set_limit(entries2, dx_node_limit(path));
1810 * NOTE: very subtle piece of code competing dx_probe() may find 2nd
1811 * level index in root index, then we insert new index here and set
1812 * new count in that 2nd level index. so, dx_probe() may see 2nd level
1813 * index w/o hash it looks for. the solution is to check root index
1814 * after we locked just founded 2nd level index -bzzz
1816 iam_insert_key_lock(path, parent, pivot, newblock);
1819 * now old and new 2nd level index blocks contain all pointers, so
1820 * dx_probe() may find it in the both. it's OK -bzzz
1822 iam_lock_bh(frame->bh);
1823 dx_set_count(entries, count1);
1824 iam_unlock_bh(frame->bh);
1827 * now old 2nd level index block points to first half of leafs. it's
1828 * importand that dx_probe() must check root index block for changes
1829 * under dx_lock_bh(frame->bh) -bzzz
1836 int split_index_node(handle_t *handle, struct iam_path *path,
1837 struct dynlock_handle **lh)
1839 struct iam_entry *entries; /* old block contents */
1840 struct iam_entry *entries2; /* new block contents */
1841 struct iam_frame *frame, *safe;
1842 struct buffer_head *bh_new[DX_MAX_TREE_HEIGHT] = {NULL};
1843 u32 newblock[DX_MAX_TREE_HEIGHT] = {0};
1844 struct dynlock_handle *lock[DX_MAX_TREE_HEIGHT] = {NULL,};
1845 struct dynlock_handle *new_lock[DX_MAX_TREE_HEIGHT] = {NULL,};
1846 struct inode *dir = iam_path_obj(path);
1847 struct iam_descr *descr;
1851 descr = iam_path_descr(path);
1853 * Algorithm below depends on this.
1855 assert_corr(dx_root_limit(path) < dx_node_limit(path));
1857 frame = path->ip_frame;
1858 entries = frame->entries;
1861 * Tall-tree handling: we might have to split multiple index blocks
1862 * all the way up to tree root. Tricky point here is error handling:
1863 * to avoid complicated undo/rollback we
1865 * - first allocate all necessary blocks
1867 * - insert pointers into them atomically.
1871 * Locking: leaf is already locked. htree-locks are acquired on all
1872 * index nodes that require split bottom-to-top, on the "safe" node,
1873 * and on all new nodes
1876 dxtrace(printk("using %u of %u node entries\n",
1877 dx_get_count(entries), dx_get_limit(entries)));
1879 /* What levels need split? */
1880 for (nr_splet = 0; frame >= path->ip_frames &&
1881 dx_get_count(frame->entries) == dx_get_limit(frame->entries);
1882 --frame, ++nr_splet) {
1883 do_corr(schedule());
1884 if (nr_splet == DX_MAX_TREE_HEIGHT) {
1886 * CWARN(dir->i_sb, __FUNCTION__,
1887 * "Directory index full!\n");
1897 * Lock all nodes, bottom to top.
1899 for (frame = path->ip_frame, i = nr_splet; i >= 0; --i, --frame) {
1900 do_corr(schedule());
1901 lock[i] = iam_lock_htree(path->ip_container, frame->curidx,
1903 if (lock[i] == NULL) {
1910 * Check for concurrent index modification.
1912 err = iam_check_full_path(path, 1);
1916 * And check that the same number of nodes is to be split.
1918 for (i = 0, frame = path->ip_frame; frame >= path->ip_frames &&
1919 dx_get_count(frame->entries) == dx_get_limit(frame->entries);
1923 if (i != nr_splet) {
1929 * Go back down, allocating blocks, locking them, and adding into
1932 for (frame = safe + 1, i = 0; i < nr_splet; ++i, ++frame) {
1933 bh_new[i] = iam_new_node(handle, path->ip_container,
1934 &newblock[i], &err);
1935 do_corr(schedule());
1937 descr->id_ops->id_node_init(path->ip_container,
1941 new_lock[i] = iam_lock_htree(path->ip_container, newblock[i],
1943 if (new_lock[i] == NULL) {
1947 do_corr(schedule());
1948 BUFFER_TRACE(frame->bh, "get_write_access");
1949 err = ldiskfs_journal_get_write_access(handle, frame->bh);
1953 /* Add "safe" node to transaction too */
1954 if (safe + 1 != path->ip_frames) {
1955 do_corr(schedule());
1956 err = ldiskfs_journal_get_write_access(handle, safe->bh);
1961 /* Go through nodes once more, inserting pointers */
1962 for (frame = safe + 1, i = 0; i < nr_splet; ++i, ++frame) {
1965 struct buffer_head *bh2;
1966 struct buffer_head *bh;
1968 entries = frame->entries;
1969 count = dx_get_count(entries);
1970 idx = iam_entry_diff(path, frame->at, entries);
1973 entries2 = dx_get_entries(path, bh2->b_data, 0);
1976 if (frame == path->ip_frames) {
1977 /* splitting root node. Tricky point:
1979 * In the "normal" B-tree we'd split root *and* add
1980 * new root to the tree with pointers to the old root
1981 * and its sibling (thus introducing two new nodes).
1983 * In htree it's enough to add one node, because
1984 * capacity of the root node is smaller than that of
1987 struct iam_frame *frames;
1988 struct iam_entry *next;
1990 assert_corr(i == 0);
1992 do_corr(schedule());
1994 frames = path->ip_frames;
1995 memcpy((char *) entries2, (char *) entries,
1996 count * iam_entry_size(path));
1997 dx_set_limit(entries2, dx_node_limit(path));
2000 iam_lock_bh(frame->bh);
2001 next = descr->id_ops->id_root_inc(path->ip_container,
2003 dx_set_block(path, next, newblock[0]);
2004 iam_unlock_bh(frame->bh);
2006 do_corr(schedule());
2007 /* Shift frames in the path */
2008 memmove(frames + 2, frames + 1,
2009 (sizeof path->ip_frames) - 2 * sizeof frames[0]);
2010 /* Add new access path frame */
2011 frames[1].at = iam_entry_shift(path, entries2, idx);
2012 frames[1].entries = entries = entries2;
2014 assert_inv(dx_node_check(path, frame));
2017 assert_inv(dx_node_check(path, frame));
2018 bh_new[0] = NULL; /* buffer head is "consumed" */
2019 err = ldiskfs_handle_dirty_metadata(handle, NULL, bh2);
2022 do_corr(schedule());
2024 /* splitting non-root index node. */
2025 struct iam_frame *parent = frame - 1;
2027 do_corr(schedule());
2028 count = iam_shift_entries(path, frame, count,
2029 entries, entries2, newblock[i]);
2030 /* Which index block gets the new entry? */
2032 int d = dx_index_is_compat(path) ? 0 : +1;
2034 frame->at = iam_entry_shift(path, entries2,
2036 frame->entries = entries = entries2;
2037 frame->curidx = newblock[i];
2038 swap(frame->bh, bh2);
2039 assert_corr(lock[i + 1] != NULL);
2040 assert_corr(new_lock[i] != NULL);
2041 swap(lock[i + 1], new_lock[i]);
2043 parent->at = iam_entry_shift(path,
2046 assert_inv(dx_node_check(path, frame));
2047 assert_inv(dx_node_check(path, parent));
2048 dxtrace(dx_show_index("node", frame->entries));
2049 dxtrace(dx_show_index("node",
2050 ((struct dx_node *) bh2->b_data)->entries));
2051 err = ldiskfs_handle_dirty_metadata(handle, NULL, bh2);
2054 do_corr(schedule());
2055 err = ldiskfs_handle_dirty_metadata(handle, NULL,
2060 do_corr(schedule());
2061 err = ldiskfs_handle_dirty_metadata(handle, NULL, bh);
2066 * This function was called to make insertion of new leaf
2067 * possible. Check that it fulfilled its obligations.
2069 assert_corr(dx_get_count(path->ip_frame->entries) <
2070 dx_get_limit(path->ip_frame->entries));
2071 assert_corr(lock[nr_splet] != NULL);
2072 *lh = lock[nr_splet];
2073 lock[nr_splet] = NULL;
2076 * Log ->i_size modification.
2078 err = ldiskfs_mark_inode_dirty(handle, dir);
2084 ldiskfs_std_error(dir->i_sb, err);
2087 iam_unlock_array(path->ip_container, lock);
2088 iam_unlock_array(path->ip_container, new_lock);
2090 assert_corr(err || iam_frame_is_locked(path, path->ip_frame));
2092 do_corr(schedule());
2093 for (i = 0; i < ARRAY_SIZE(bh_new); ++i) {
2094 if (bh_new[i] != NULL)
2100 static int iam_add_rec(handle_t *handle, struct iam_iterator *it,
2101 struct iam_path *path,
2102 const struct iam_key *k, const struct iam_rec *r)
2105 struct iam_leaf *leaf;
2107 leaf = &path->ip_leaf;
2108 assert_inv(iam_path_check(path));
2109 err = iam_txn_add(handle, path, leaf->il_bh);
2111 do_corr(schedule());
2112 if (!iam_leaf_can_add(leaf, k, r)) {
2113 struct dynlock_handle *lh = NULL;
2116 assert_corr(lh == NULL);
2117 do_corr(schedule());
2118 err = split_index_node(handle, path, &lh);
2119 if (err == -EAGAIN) {
2120 assert_corr(lh == NULL);
2122 iam_path_fini(path);
2123 it->ii_state = IAM_IT_DETACHED;
2125 do_corr(schedule());
2126 err = iam_it_get_exact(it, k);
2128 err = +1; /* repeat split */
2133 assert_inv(iam_path_check(path));
2135 assert_corr(lh != NULL);
2136 do_corr(schedule());
2137 err = iam_new_leaf(handle, leaf);
2139 err = iam_txn_dirty(handle, path,
2140 path->ip_frame->bh);
2142 iam_unlock_htree(path->ip_container, lh);
2143 do_corr(schedule());
2146 iam_leaf_rec_add(leaf, k, r);
2147 err = iam_txn_dirty(handle, path, leaf->il_bh);
2150 assert_inv(iam_path_check(path));
2155 * Insert new record with key @k and contents from @r, shifting records to the
2156 * right. On success, iterator is positioned on the newly inserted record.
2158 * precondition: it->ii_flags&IAM_IT_WRITE &&
2159 * (it_state(it) == IAM_IT_ATTACHED ||
2160 * it_state(it) == IAM_IT_SKEWED) &&
2161 * ergo(it_state(it) == IAM_IT_ATTACHED,
2162 * it_keycmp(it, k) <= 0) &&
2163 * ergo(it_before(it), it_keycmp(it, k) > 0));
2164 * postcondition: ergo(result == 0,
2165 * it_state(it) == IAM_IT_ATTACHED &&
2166 * it_keycmp(it, k) == 0 &&
2167 * !memcmp(iam_it_rec_get(it), r, ...))
2169 int iam_it_rec_insert(handle_t *h, struct iam_iterator *it,
2170 const struct iam_key *k, const struct iam_rec *r)
2173 struct iam_path *path;
2175 path = &it->ii_path;
2177 assert_corr(it->ii_flags&IAM_IT_WRITE);
2178 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
2179 it_state(it) == IAM_IT_SKEWED);
2180 assert_corr(ergo(it_state(it) == IAM_IT_ATTACHED,
2181 it_keycmp(it, k) <= 0));
2182 assert_corr(ergo(it_before(it), it_keycmp(it, k) > 0));
2183 result = iam_add_rec(h, it, path, k, r);
2185 it->ii_state = IAM_IT_ATTACHED;
2186 assert_corr(ergo(result == 0,
2187 it_state(it) == IAM_IT_ATTACHED &&
2188 it_keycmp(it, k) == 0));
2192 static inline int iam_idle_blocks_limit(struct inode *inode)
2194 return (inode->i_sb->s_blocksize - sizeof(struct iam_idle_head)) >> 2;
2198 * If the leaf cannnot be recycled, we will lose one block for reusing.
2199 * It is not a serious issue because it almost the same of non-recycle.
2201 static iam_ptr_t iam_index_shrink(handle_t *h, struct iam_path *p,
2202 struct iam_leaf *l, struct buffer_head **bh)
2204 struct iam_container *c = p->ip_container;
2205 struct inode *inode = c->ic_object;
2206 struct iam_frame *frame = p->ip_frame;
2207 struct iam_entry *entries;
2208 struct iam_entry *pos;
2209 struct dynlock_handle *lh;
2213 if (c->ic_idle_failed)
2216 if (unlikely(frame == NULL))
2219 if (!iam_leaf_empty(l))
2222 lh = iam_lock_htree(c, frame->curidx, DLT_WRITE);
2224 CWARN("%s: No memory to recycle idle blocks\n",
2225 osd_ino2name(inode));
2229 rc = iam_txn_add(h, p, frame->bh);
2231 iam_unlock_htree(c, lh);
2235 iam_lock_bh(frame->bh);
2236 entries = frame->entries;
2237 count = dx_get_count(entries);
2239 * NOT shrink the last entry in the index node, which can be reused
2240 * directly by next new node.
2243 iam_unlock_bh(frame->bh);
2244 iam_unlock_htree(c, lh);
2248 pos = iam_find_position(p, frame);
2250 * There may be some new leaf nodes have been added or empty leaf nodes
2251 * have been shrinked during my delete operation.
2253 * If the empty leaf is not under current index node because the index
2254 * node has been split, then just skip the empty leaf, which is rare.
2256 if (unlikely(frame->leaf != dx_get_block(p, pos))) {
2257 iam_unlock_bh(frame->bh);
2258 iam_unlock_htree(c, lh);
2263 if (frame->at < iam_entry_shift(p, entries, count - 1)) {
2264 struct iam_entry *n = iam_entry_shift(p, frame->at, 1);
2266 memmove(frame->at, n,
2267 (char *)iam_entry_shift(p, entries, count) - (char *)n);
2268 frame->at_shifted = 1;
2270 dx_set_count(entries, count - 1);
2271 iam_unlock_bh(frame->bh);
2272 rc = iam_txn_dirty(h, p, frame->bh);
2273 iam_unlock_htree(c, lh);
2283 iam_install_idle_blocks(handle_t *h, struct iam_path *p, struct buffer_head *bh,
2284 __u32 *idle_blocks, iam_ptr_t blk)
2286 struct iam_container *c = p->ip_container;
2287 struct buffer_head *old = c->ic_idle_bh;
2288 struct iam_idle_head *head;
2291 head = (struct iam_idle_head *)(bh->b_data);
2292 head->iih_magic = cpu_to_le16(IAM_IDLE_HEADER_MAGIC);
2293 head->iih_count = 0;
2294 head->iih_next = *idle_blocks;
2295 /* The bh already get_write_accessed. */
2296 rc = iam_txn_dirty(h, p, bh);
2300 rc = iam_txn_add(h, p, c->ic_root_bh);
2304 iam_lock_bh(c->ic_root_bh);
2305 *idle_blocks = cpu_to_le32(blk);
2306 iam_unlock_bh(c->ic_root_bh);
2307 rc = iam_txn_dirty(h, p, c->ic_root_bh);
2309 /* NOT release old before new assigned. */
2314 iam_lock_bh(c->ic_root_bh);
2315 *idle_blocks = head->iih_next;
2316 iam_unlock_bh(c->ic_root_bh);
2322 * If the leaf cannnot be recycled, we will lose one block for reusing.
2323 * It is not a serious issue because it almost the same of non-recycle.
2325 static void iam_recycle_leaf(handle_t *h, struct iam_path *p,
2326 struct buffer_head *bh, iam_ptr_t blk)
2328 struct iam_container *c = p->ip_container;
2329 struct inode *inode = c->ic_object;
2330 struct iam_idle_head *head;
2335 mutex_lock(&c->ic_idle_mutex);
2336 if (unlikely(c->ic_idle_failed)) {
2341 idle_blocks = (__u32 *)(c->ic_root_bh->b_data +
2342 c->ic_descr->id_root_gap +
2343 sizeof(struct dx_countlimit));
2344 /* It is the first idle block. */
2345 if (c->ic_idle_bh == NULL) {
2346 rc = iam_install_idle_blocks(h, p, bh, idle_blocks, blk);
2350 head = (struct iam_idle_head *)(c->ic_idle_bh->b_data);
2351 count = le16_to_cpu(head->iih_count);
2352 /* Current ic_idle_bh is full, to be replaced by the leaf. */
2353 if (count == iam_idle_blocks_limit(inode)) {
2354 rc = iam_install_idle_blocks(h, p, bh, idle_blocks, blk);
2358 /* Just add to ic_idle_bh. */
2359 rc = iam_txn_add(h, p, c->ic_idle_bh);
2363 head->iih_blks[count] = cpu_to_le32(blk);
2364 head->iih_count = cpu_to_le16(count + 1);
2365 rc = iam_txn_dirty(h, p, c->ic_idle_bh);
2368 mutex_unlock(&c->ic_idle_mutex);
2370 CWARN("%s: idle blocks failed, will lose the blk %u\n",
2371 osd_ino2name(inode), blk);
2375 * Delete record under iterator.
2377 * precondition: it_state(it) == IAM_IT_ATTACHED &&
2378 * it->ii_flags&IAM_IT_WRITE &&
2380 * postcondition: it_state(it) == IAM_IT_ATTACHED ||
2381 * it_state(it) == IAM_IT_DETACHED
2383 int iam_it_rec_delete(handle_t *h, struct iam_iterator *it)
2386 struct iam_leaf *leaf;
2387 struct iam_path *path;
2389 assert_corr(it_state(it) == IAM_IT_ATTACHED &&
2390 it->ii_flags&IAM_IT_WRITE);
2391 assert_corr(it_at_rec(it));
2393 path = &it->ii_path;
2394 leaf = &path->ip_leaf;
2396 assert_inv(iam_path_check(path));
2398 result = iam_txn_add(h, path, leaf->il_bh);
2400 * no compaction for now.
2403 iam_rec_del(leaf, it->ii_flags&IAM_IT_MOVE);
2404 result = iam_txn_dirty(h, path, leaf->il_bh);
2405 if (result == 0 && iam_leaf_at_end(leaf)) {
2406 struct buffer_head *bh = NULL;
2409 blk = iam_index_shrink(h, path, leaf, &bh);
2410 if (it->ii_flags & IAM_IT_MOVE) {
2411 result = iam_it_next(it);
2417 iam_recycle_leaf(h, path, bh, blk);
2422 assert_inv(iam_path_check(path));
2423 assert_corr(it_state(it) == IAM_IT_ATTACHED ||
2424 it_state(it) == IAM_IT_DETACHED);
2429 * Convert iterator to cookie.
2431 * precondition: it_state(it) == IAM_IT_ATTACHED &&
2432 * iam_path_descr(it->ii_path)->id_key_size <= sizeof(iam_pos_t)
2433 * postcondition: it_state(it) == IAM_IT_ATTACHED
2435 iam_pos_t iam_it_store(const struct iam_iterator *it)
2439 assert_corr(it_state(it) == IAM_IT_ATTACHED);
2440 assert_corr(it_at_rec(it));
2441 assert_corr(iam_it_container(it)->ic_descr->id_ikey_size <=
2445 return *(iam_pos_t *)iam_it_ikey_get(it, (void *)&result);
2449 * Restore iterator from cookie.
2451 * precondition: it_state(it) == IAM_IT_DETACHED && it->ii_flags&IAM_IT_MOVE &&
2452 * iam_path_descr(it->ii_path)->id_key_size <= sizeof(iam_pos_t)
2453 * postcondition: ergo(result == 0, it_state(it) == IAM_IT_ATTACHED &&
2454 * iam_it_store(it) == pos)
2456 int iam_it_load(struct iam_iterator *it, iam_pos_t pos)
2458 assert_corr(it_state(it) == IAM_IT_DETACHED &&
2459 it->ii_flags&IAM_IT_MOVE);
2460 assert_corr(iam_it_container(it)->ic_descr->id_ikey_size <= sizeof pos);
2461 return iam_it_iget(it, (struct iam_ikey *)&pos);
2464 /***********************************************************************/
2466 /***********************************************************************/
2468 static inline int ptr_inside(void *base, size_t size, void *ptr)
2470 return (base <= ptr) && (ptr < base + size);
2473 static int iam_frame_invariant(struct iam_frame *f)
2477 f->bh->b_data != NULL &&
2478 ptr_inside(f->bh->b_data, f->bh->b_size, f->entries) &&
2479 ptr_inside(f->bh->b_data, f->bh->b_size, f->at) &&
2480 f->entries <= f->at);
2483 static int iam_leaf_invariant(struct iam_leaf *l)
2487 l->il_bh->b_data != NULL &&
2488 ptr_inside(l->il_bh->b_data, l->il_bh->b_size, l->il_entries) &&
2489 ptr_inside(l->il_bh->b_data, l->il_bh->b_size, l->il_at) &&
2490 l->il_entries <= l->il_at;
2493 static int iam_path_invariant(struct iam_path *p)
2497 if (p->ip_container == NULL ||
2498 p->ip_indirect < 0 || p->ip_indirect > DX_MAX_TREE_HEIGHT - 1 ||
2499 p->ip_frame != p->ip_frames + p->ip_indirect ||
2500 !iam_leaf_invariant(&p->ip_leaf))
2502 for (i = 0; i < ARRAY_SIZE(p->ip_frames); ++i) {
2503 if (i <= p->ip_indirect) {
2504 if (!iam_frame_invariant(&p->ip_frames[i]))
2511 int iam_it_invariant(struct iam_iterator *it)
2514 (it->ii_state == IAM_IT_DETACHED ||
2515 it->ii_state == IAM_IT_ATTACHED ||
2516 it->ii_state == IAM_IT_SKEWED) &&
2517 !(it->ii_flags & ~(IAM_IT_MOVE | IAM_IT_WRITE)) &&
2518 ergo(it->ii_state == IAM_IT_ATTACHED ||
2519 it->ii_state == IAM_IT_SKEWED,
2520 iam_path_invariant(&it->ii_path) &&
2521 equi(it_at_rec(it), it->ii_state == IAM_IT_SKEWED));
2525 * Search container @c for record with key @k. If record is found, its data
2526 * are moved into @r.
2528 * Return values: 0: found, -ENOENT: not-found, -ve: error
2530 int iam_lookup(struct iam_container *c, const struct iam_key *k,
2531 struct iam_rec *r, struct iam_path_descr *pd)
2533 struct iam_iterator it;
2536 iam_it_init(&it, c, 0, pd);
2538 result = iam_it_get_exact(&it, k);
2541 * record with required key found, copy it into user buffer
2543 iam_reccpy(&it.ii_path.ip_leaf, r);
2550 * Insert new record @r with key @k into container @c (within context of
2553 * Return values: 0: success, -ve: error, including -EEXIST when record with
2554 * given key is already present.
2556 * postcondition: ergo(result == 0 || result == -EEXIST,
2557 * iam_lookup(c, k, r2) > 0;
2559 int iam_insert(handle_t *h, struct iam_container *c, const struct iam_key *k,
2560 const struct iam_rec *r, struct iam_path_descr *pd)
2562 struct iam_iterator it;
2565 iam_it_init(&it, c, IAM_IT_WRITE, pd);
2567 result = iam_it_get_exact(&it, k);
2568 if (result == -ENOENT)
2569 result = iam_it_rec_insert(h, &it, k, r);
2570 else if (result == 0)
2578 * Update record with the key @k in container @c (within context of
2579 * transaction @h), new record is given by @r.
2581 * Return values: +1: skip because of the same rec value, 0: success,
2582 * -ve: error, including -ENOENT if no record with the given key found.
2584 int iam_update(handle_t *h, struct iam_container *c, const struct iam_key *k,
2585 const struct iam_rec *r, struct iam_path_descr *pd)
2587 struct iam_iterator it;
2588 struct iam_leaf *folio;
2591 iam_it_init(&it, c, IAM_IT_WRITE, pd);
2593 result = iam_it_get_exact(&it, k);
2595 folio = &it.ii_path.ip_leaf;
2596 result = iam_leaf_ops(folio)->rec_eq(folio, r);
2598 iam_it_rec_set(h, &it, r);
2608 * Delete existing record with key @k.
2610 * Return values: 0: success, -ENOENT: not-found, -ve: other error.
2612 * postcondition: ergo(result == 0 || result == -ENOENT,
2613 * !iam_lookup(c, k, *));
2615 int iam_delete(handle_t *h, struct iam_container *c, const struct iam_key *k,
2616 struct iam_path_descr *pd)
2618 struct iam_iterator it;
2621 iam_it_init(&it, c, IAM_IT_WRITE, pd);
2623 result = iam_it_get_exact(&it, k);
2625 iam_it_rec_delete(h, &it);
2631 int iam_root_limit(int rootgap, int blocksize, int size)
2636 limit = (blocksize - rootgap) / size;
2637 nlimit = blocksize / size;
2638 if (limit == nlimit)