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 [sun.com URL with a
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 * Top-level entry points into osd module
39 * Author: Wang Di <wangdi@clusterfs.com>
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 #ifndef __LINUX_LUSTRE_IAM_H__
44 #define __LINUX_LUSTRE_IAM_H__
46 #include <linux/module.h>
47 #include <asm/unaligned.h>
48 #include <linux/dynlocks.h>
50 * linux/include/linux/osd_iam.h
53 #define CLASSERT(cond) do {switch(42) {case (cond): case 0: break;}} while (0)
56 #define ergo(a, b) (!(a) || (b))
57 /* logical equivalence */
58 #define equi(a, b) (!!(a) == !!(b))
62 * Maximal number of non-leaf levels in htree. In the stock ldiskfs this
66 * XXX reduced back to 2 to make per-node locking work.
68 DX_MAX_TREE_HEIGHT = 5,
70 * Scratch keys used by generic code for temporaries.
74 * [0] reserved for assertions and as a staging area for
75 * record keys immediately used for key comparisons.
77 * [1] reserved for record key, stored during iteration over
78 * node records (see dx_node_check()).
80 * [2] reserved for leaf node operations.
82 * [3] reserved for index operations.
84 * [4] reserved for path->ip_ikey_target
89 * Maximal format name length.
99 * Various debugging levels.
104 * Following macros are defined in config.h and are tunable through
105 * appropriate configure switches (indicated below).
109 * Compile basic assertions in. You want this most of the time.
111 * --{enable,disable}-ldiskfs-assert (on by default).
113 #define LDISKFS_ASSERT (1)
116 * Compile heavier correctness checks in. You want this during development
119 * --{enable,disable}-ldiskfs-correctness (off by default).
121 #define LDISKFS_CORRECTNESS (1)
124 * Compile heavy invariant checking in. You want this early during development
125 * or when chasing a bug.
127 * --{enable,disable}-ldiskfs-invariant (off by default).
129 #define LDISKFS_INVARIANT (1)
132 #if defined(LDISKFS_ASSERT)
133 #define LDISKFS_ASSERT_ON (1)
135 #define LDISKFS_ASSERT_ON (0)
138 #if defined(LDISKFS_CORRECTNESS)
139 #define LDISKFS_CORRECTNESS_ON (1)
141 #define LDISKFS_CORRECTNESS_ON (0)
144 #if defined(LDISKFS_INVARIANT)
145 #define LDISKFS_INVARIANT_ON (1)
147 #define LDISKFS_INVARIANT_ON (0)
151 #if LDISKFS_ASSERT_ON
152 #define assert(test) J_ASSERT(test)
154 #define assert(test) ((void)(test))
158 #if LDISKFS_CORRECTNESS_ON
159 #define assert_corr(test) J_ASSERT(test)
160 #define do_corr(exp) exp
162 #define assert_corr(test) do {;} while (0)
163 #define do_corr(exp) do {;} while (0)
166 #if LDISKFS_INVARIANT_ON
167 #define assert_inv(test) J_ASSERT(test)
169 #define assert_inv(test) do {;} while (0)
173 * Entry within index tree node. Consists of a key immediately followed
174 * (without padding) by a pointer to the child node.
176 * Both key and pointer are of variable size, hence incomplete type.
180 struct iam_entry_compat {
186 * Incomplete type used to refer to keys in iam container.
188 * As key size can be different from container to container, iam has to use
189 * incomplete type. Clients cast pointer to iam_key to real key type and back.
194 * Incomplete type use to refer to the records stored in iam containers.
199 * Key in index node. Possibly compressed. Fixed size.
204 * Scalar type into which certain iam_key's can be uniquely mapped. Used to
205 * support interfaces like readdir(), where iteration over index has to be
208 typedef __u32 iam_ptr_t;
211 * Index node traversed during tree lookup.
214 struct buffer_head *bh; /* buffer holding node data */
215 struct iam_entry *entries; /* array of entries */
216 struct iam_entry *at; /* target entry, found by binary search */
217 iam_ptr_t leaf; /* (logical) offset of child node found by
219 iam_ptr_t curidx; /* (logical) offset of this node. Used to
220 * per-node locking to detect concurrent
225 * Opaque entry in the leaf node.
230 struct iam_container;
233 /* leaf node reached by tree lookup */
235 struct iam_path *il_path;
236 struct buffer_head *il_bh;
237 struct iam_lentry *il_entries;
238 struct iam_lentry *il_at;
240 * Lock on a leaf node.
242 struct dynlock_handle *il_lock;
243 iam_ptr_t il_curidx; /* logical offset of leaf node. */
248 * Return values of ->lookup() operation from struct iam_leaf_operations.
252 * lookup found a record with the key requested
254 IAM_LOOKUP_EXACT = 0,
256 * lookup positioned leaf on some record
262 IAM_LOOKUP_EMPTY = 2,
264 * lookup positioned leaf before first record
266 IAM_LOOKUP_BEFORE = 3,
268 * Found hash may have a continuation in the next leaf.
270 IAM_LOOKUP_LAST = 0x100
274 * Format-specific container operations. These are called by generic iam code.
276 struct iam_operations {
278 * Returns pointer (in the same sense as pointer in index entry) to
281 __u32 (*id_root_ptr)(struct iam_container *c);
284 * Check validity and consistency of index node.
286 int (*id_node_check)(struct iam_path *path, struct iam_frame *frame);
288 * Copy some data from node header into frame. This is called when
289 * new node is loaded into frame.
291 int (*id_node_load)(struct iam_path *path, struct iam_frame *frame);
293 * Initialize new node (stored in @bh) that is going to be added into
296 int (*id_node_init)(struct iam_container *c,
297 struct buffer_head *bh, int root);
298 int (*id_node_read)(struct iam_container *c, iam_ptr_t ptr,
299 handle_t *h, struct buffer_head **bh);
301 * Key comparison functions. Returns -1, 0, +1.
303 int (*id_ikeycmp)(const struct iam_container *c,
304 const struct iam_ikey *k1,
305 const struct iam_ikey *k2);
307 * Modify root node when tree height increases.
309 struct iam_entry *(*id_root_inc)(struct iam_container *c,
310 struct iam_path *path,
311 struct iam_frame *frame);
313 struct iam_path_descr *(*id_ipd_alloc)(const struct iam_container *c,
315 void (*id_ipd_free)(struct iam_path_descr *ipd);
319 char id_name[DX_FMT_NAME_LEN];
323 * Another format-specific operation vector, consisting of methods to access
324 * leaf nodes. This is separated from struct iam_operations, because it is
325 * assumed that there will be many formats with different format of leaf
326 * nodes, yes the same struct iam_operations.
328 struct iam_leaf_operations {
334 * initialize just loaded leaf node.
336 int (*init)(struct iam_leaf *p);
340 void (*init_new)(struct iam_container *c, struct buffer_head *bh);
344 void (*fini)(struct iam_leaf *l);
346 * returns true iff leaf is positioned at the last entry.
348 int (*at_end)(const struct iam_leaf *l);
349 /* position leaf at the first entry */
350 void (*start)(struct iam_leaf *l);
351 /* more leaf to the next entry. */
352 void (*next)(struct iam_leaf *l);
354 * return key of current leaf record. This method may return
355 * either pointer to the key stored in node, or copy key into
356 * @k buffer supplied by caller and return pointer to this
357 * buffer. The latter approach is used when keys in nodes are
358 * not stored in plain form (e.g., htree doesn't store keys at
361 * Caller should assume that returned pointer is only valid
362 * while leaf node is pinned and locked.
364 struct iam_ikey *(*ikey)(const struct iam_leaf *l, struct iam_ikey *k);
365 struct iam_key *(*key)(const struct iam_leaf *l);
366 /* return pointer to entry body. Pointer is valid while
367 corresponding leaf node is locked and pinned. */
368 struct iam_rec *(*rec)(const struct iam_leaf *l);
370 void (*key_set)(struct iam_leaf *l, const struct iam_key *k);
371 void (*rec_set)(struct iam_leaf *l, const struct iam_rec *r);
372 void (*rec_get)(const struct iam_leaf *l, struct iam_rec *r);
374 int (*key_cmp)(const struct iam_leaf *l, const struct iam_key *k);
375 int (*key_eq)(const struct iam_leaf *l, const struct iam_key *k);
377 int (*rec_eq)(const struct iam_leaf *l, const struct iam_rec *r);
379 int (*key_size)(const struct iam_leaf *l);
381 * Search leaf @l for a record with key @k or for a place
382 * where such record is to be inserted.
384 * Scratch keys from @path can be used.
386 int (*lookup)(struct iam_leaf *l, const struct iam_key *k);
387 int (*ilookup)(struct iam_leaf *l, const struct iam_ikey *ik);
389 int (*can_add)(const struct iam_leaf *l,
390 const struct iam_key *k, const struct iam_rec *r);
394 void (*rec_add)(struct iam_leaf *l,
395 const struct iam_key *k, const struct iam_rec *r);
397 * remove rec for a leaf
399 void (*rec_del)(struct iam_leaf *l, int shift);
401 * split leaf node, moving some entries into @bh (the latter currently
402 * is assumed to be empty).
404 void (*split)(struct iam_leaf *l, struct buffer_head **bh,
409 * Parameters, describing a flavor of iam container.
413 * Size of a key in this container, in bytes.
417 * Size of a key in index nodes, in bytes.
421 * Size of a pointer to the next level (stored in index nodes), in
426 * Size of a record (stored in leaf nodes), in bytes.
430 * Size of unused (by iam) space at the beginning of every non-root
431 * node, in bytes. Used for compatibility with ldiskfs.
435 * Size of unused (by iam) space at the beginning of root node, in
436 * bytes. Used for compatibility with ldiskfs.
440 struct iam_operations *id_ops;
441 struct iam_leaf_operations *id_leaf_ops;
445 * An instance of iam container.
447 struct iam_container {
449 * Underlying flat file. IO against this object is issued to
452 struct inode *ic_object;
456 struct buffer_head *ic_root_bh;
460 struct iam_descr *ic_descr;
462 * read-write lock protecting index consistency.
464 cfs_rw_semaphore_t ic_sem;
468 * description-specific part of iam_path. This is usually embedded into larger
471 struct iam_path_descr {
473 * Scratch-pad area for temporary keys.
475 struct iam_ikey *ipd_key_scratch[DX_SCRATCH_KEYS];
479 * Structure to keep track of a path drilled through htree.
485 struct iam_container *ip_container;
487 * Number of index levels minus one.
491 * Nodes that top-to-bottom traversal passed through.
493 struct iam_frame ip_frames[DX_MAX_TREE_HEIGHT];
495 * Last filled frame in ->ip_frames. Refers to the 'twig' node (one
496 * immediately above leaf).
498 struct iam_frame *ip_frame;
500 * Leaf node: a child of ->ip_frame.
502 struct iam_leaf ip_leaf;
506 const struct iam_key *ip_key_target;
507 const struct iam_ikey *ip_ikey_target;
509 * Description-specific data.
511 struct iam_path_descr *ip_data;
514 struct ldiskfs_dx_hash_info;
517 * Helper structure for legacy htrees.
519 struct iam_path_compat {
520 struct iam_path ipc_path;
521 struct iam_container ipc_container;
522 __u32 ipc_scratch[DX_SCRATCH_KEYS];
523 struct ldiskfs_dx_hash_info *ipc_hinfo;
524 struct qstr *ipc_qstr;
525 struct iam_path_descr ipc_descr;
526 struct ldiskfs_dx_hash_info ipc_hinfo_area;
529 #define const_max(p, q) ((p > q) ? p : q)
532 DX_MAX_IKEY_SIZE = 32, /* be generous */
534 * Hack to avoid dynamic allocation and freeing of ipd.
536 DX_IPD_MAX_SIZE = const_max(sizeof(struct iam_path_compat),
537 DX_MAX_IKEY_SIZE * DX_SCRATCH_KEYS +
538 sizeof(struct iam_path_descr))
542 * iam cursor (iterator) api.
546 * States of iterator state machine.
551 /* iterator is above particular record in the container */
553 /* iterator is positioned before record */
558 * Flags controlling iterator functionality.
562 * this iterator will move (iam_it_next() will be called on it)
564 IAM_IT_MOVE = (1 << 0),
566 * tree can be updated through this iterator.
568 IAM_IT_WRITE = (1 << 1)
574 * Immediately after call to iam_it_init() iterator is in "detached"
575 * (IAM_IT_DETACHED) state: it is associated with given parent container, but
576 * doesn't point to any particular record in this container.
578 * After successful call to iam_it_get() and until corresponding call to
579 * iam_it_put() iterator is in one of "active" states: IAM_IT_ATTACHED or
582 * Active iterator can move through records in a container (provided
583 * IAM_IT_MOVE permission) in a key order, can get record and key values as it
584 * passes over them, and can modify container (provided IAM_IT_WRITE
587 * Iteration may reach the end of container, at which point iterator switches
588 * into IAM_IT_DETACHED state.
590 * Concurrency: iterators are supposed to be local to thread. Interfaces below
591 * do no internal serialization of access to the iterator fields.
593 * When in non-detached state, iterator keeps some container nodes pinned in
594 * memory and locked (that locking may be implemented at the container
595 * granularity though). In particular, clients may assume that pointers to
596 * records and keys obtained through iterator interface as valid until
597 * iterator is detached (except that they may be invalidated by sub-sequent
598 * operations done through the same iterator).
601 struct iam_iterator {
603 * iterator flags, taken from enum iam_it_flags.
606 enum iam_it_state ii_state;
608 * path to the record. Valid in IAM_IT_ATTACHED, and IAM_IT_SKEWED
611 struct iam_path ii_path;
614 void iam_path_init(struct iam_path *path, struct iam_container *c,
615 struct iam_path_descr *pd);
616 void iam_path_fini(struct iam_path *path);
617 void iam_path_release(struct iam_path *path);
619 void iam_path_compat_init(struct iam_path_compat *path, struct inode *inode);
620 void iam_path_compat_fini(struct iam_path_compat *path);
622 struct iam_path_descr *iam_ipd_alloc(void *area, int keysize);
623 void iam_ipd_free(struct iam_path_descr *ipd);
625 int iam_it_init(struct iam_iterator *it, struct iam_container *c, __u32 flags,
626 struct iam_path_descr *pd);
627 void iam_it_fini(struct iam_iterator *it);
628 int iam_it_get(struct iam_iterator *it, const struct iam_key *k);
629 int iam_it_get_at(struct iam_iterator *it, const struct iam_key *k);
630 void iam_it_dup(struct iam_iterator *dst, const struct iam_iterator *src);
631 void iam_it_put(struct iam_iterator *it);
632 int iam_it_next(struct iam_iterator *it);
633 struct iam_rec *iam_it_rec_get(const struct iam_iterator *it);
634 int iam_it_rec_set(handle_t *h,
635 struct iam_iterator *it, const struct iam_rec *r);
636 struct iam_key *iam_it_key_get(const struct iam_iterator *it);
637 int iam_it_key_size(const struct iam_iterator *it);
638 int iam_it_rec_insert(handle_t *h, struct iam_iterator *it,
639 const struct iam_key *k, const struct iam_rec *r);
640 int iam_it_rec_delete(handle_t *h, struct iam_iterator *it);
642 typedef __u64 iam_pos_t;
644 iam_pos_t iam_it_store(const struct iam_iterator *it);
645 int iam_it_load(struct iam_iterator *it, iam_pos_t pos);
647 int iam_lookup(struct iam_container *c, const struct iam_key *k,
648 struct iam_rec *r, struct iam_path_descr *pd);
649 int iam_delete(handle_t *h, struct iam_container *c, const struct iam_key *k,
650 struct iam_path_descr *pd);
651 int iam_update(handle_t *h, struct iam_container *c, const struct iam_key *k,
652 const struct iam_rec *r, struct iam_path_descr *pd);
653 int iam_insert(handle_t *handle, struct iam_container *c,
654 const struct iam_key *k,
655 const struct iam_rec *r, struct iam_path_descr *pd);
657 * Initialize container @c.
659 int iam_container_init(struct iam_container *c,
660 struct iam_descr *descr, struct inode *inode);
662 * Finalize container @c, release all resources.
664 void iam_container_fini(struct iam_container *c);
667 * Determine container format.
669 int iam_container_setup(struct iam_container *c);
671 static inline struct iam_descr *iam_container_descr(struct iam_container *c)
676 static inline struct iam_descr *iam_path_descr(const struct iam_path *p)
678 return p->ip_container->ic_descr;
681 static inline struct inode *iam_path_obj(struct iam_path *p)
683 return p->ip_container->ic_object;
686 static inline void iam_ikeycpy(const struct iam_container *c,
687 struct iam_ikey *k1, const struct iam_ikey *k2)
689 memcpy(k1, k2, c->ic_descr->id_ikey_size);
692 static inline size_t iam_entry_size(struct iam_path *p)
694 return iam_path_descr(p)->id_ikey_size + iam_path_descr(p)->id_ptr_size;
697 static inline struct iam_entry *iam_entry_shift(struct iam_path *p,
698 struct iam_entry *entry,
702 return e + shift * iam_entry_size(p);
705 static inline struct iam_ikey *dx_get_ikey(struct iam_path *p,
706 struct iam_entry *entry,
707 struct iam_ikey *key)
709 return memcpy(key, entry, iam_path_descr(p)->id_ikey_size);
712 static inline struct iam_ikey *iam_ikey_at(struct iam_path *p,
713 struct iam_entry *entry)
715 return (struct iam_ikey *)entry;
718 static inline ptrdiff_t iam_entry_diff(struct iam_path *p,
719 struct iam_entry *e1,
720 struct iam_entry *e2)
724 diff = (void *)e1 - (void *)e2;
725 assert_corr(diff / iam_entry_size(p) * iam_entry_size(p) == diff);
726 return diff / iam_entry_size(p);
730 * Helper for the frequent case, where key was already placed into @k1 by
733 static inline void iam_ikeycpy0(const struct iam_container *c,
734 struct iam_ikey *k1, const struct iam_ikey *k2)
737 iam_ikeycpy(c, k1, k2);
740 static inline int iam_ikeycmp(const struct iam_container *c,
741 const struct iam_ikey *k1,
742 const struct iam_ikey *k2)
744 return c->ic_descr->id_ops->id_ikeycmp(c, k1, k2);
747 static inline void *iam_entry_off(struct iam_entry *entry, size_t off)
749 return (void *)((char *)entry + off);
756 static inline struct iam_path *iam_leaf_path(const struct iam_leaf *leaf)
758 return leaf->il_path;
761 static inline struct iam_container *
762 iam_leaf_container(const struct iam_leaf *leaf)
764 return iam_leaf_path(leaf)->ip_container;
767 static inline struct iam_descr *iam_leaf_descr(const struct iam_leaf *leaf)
769 return iam_leaf_container(leaf)->ic_descr;
772 static inline struct iam_leaf_operations *
773 iam_leaf_ops(const struct iam_leaf *leaf)
775 return iam_leaf_descr(leaf)->id_leaf_ops;
778 static inline void iam_reccpy(const struct iam_leaf *leaf,
779 struct iam_rec *rec_dst)
781 iam_leaf_ops(leaf)->rec_get(leaf, rec_dst);
784 /*XXX These stuff put here, just because they are used by iam.c */
785 static inline unsigned dx_get_block(struct iam_path *p, struct iam_entry *entry)
789 addr = iam_entry_off(entry, iam_path_descr(p)->id_ikey_size);
790 return le32_to_cpu(get_unaligned(addr));
793 static inline void dx_set_block(struct iam_path *p,
794 struct iam_entry *entry, unsigned value)
798 addr = iam_entry_off(entry, iam_path_descr(p)->id_ikey_size);
799 put_unaligned(cpu_to_le32(value), addr);
802 static inline void dx_set_ikey(struct iam_path *p, struct iam_entry *entry,
803 const struct iam_ikey *key)
805 iam_ikeycpy(p->ip_container, iam_entry_off(entry, 0), key);
821 struct dx_countlimit {
827 * dx_root_info is laid out so that if it should somehow get overlaid by a
828 * dirent the two low bits of the hash version will be zero. Therefore, the
829 * hash version mod 4 should never be 0. Sincerely, the paranoia department.
833 struct fake_dirent dot;
835 struct fake_dirent dotdot;
839 __le32 reserved_zero;
841 u8 info_length; /* 8 */
846 struct {} entries[0];
851 struct fake_dirent fake;
852 struct {} entries[0];
856 static inline unsigned dx_get_count(struct iam_entry *entries)
858 return le16_to_cpu(((struct dx_countlimit *) entries)->count);
861 static inline unsigned dx_get_limit(struct iam_entry *entries)
863 return le16_to_cpu(((struct dx_countlimit *) entries)->limit);
866 static inline void dx_set_count(struct iam_entry *entries, unsigned value)
868 ((struct dx_countlimit *) entries)->count = cpu_to_le16(value);
871 static inline unsigned dx_node_limit(struct iam_path *p)
873 struct iam_descr *param = iam_path_descr(p);
874 unsigned entry_space = iam_path_obj(p)->i_sb->s_blocksize -
876 return entry_space / (param->id_ikey_size + param->id_ptr_size);
879 static inline unsigned dx_root_limit(struct iam_path *p)
881 struct iam_descr *param = iam_path_descr(p);
882 unsigned limit = iam_path_obj(p)->i_sb->s_blocksize -
884 limit /= (param->id_ikey_size + param->id_ptr_size);
885 if (limit == dx_node_limit(p))
891 static inline struct iam_entry *dx_get_entries(struct iam_path *path,
892 void *data, int root)
894 struct iam_descr *param = iam_path_descr(path);
895 return data + (root ? param->id_root_gap : param->id_node_gap);
899 static inline struct iam_entry *dx_node_get_entries(struct iam_path *path,
900 struct iam_frame *frame)
902 return dx_get_entries(path,
903 frame->bh->b_data, frame == path->ip_frames);
906 static inline struct iam_ikey *iam_path_ikey(const struct iam_path *path,
909 assert(0 <= nr && nr < ARRAY_SIZE(path->ip_data->ipd_key_scratch));
910 return path->ip_data->ipd_key_scratch[nr];
914 static inline struct dynlock *path_dynlock(struct iam_path *path)
916 return &LDISKFS_I(iam_path_obj(path))->i_htree_lock;
919 static inline int iam_leaf_is_locked(const struct iam_leaf *leaf)
923 result = dynlock_is_locked(path_dynlock(leaf->il_path),
930 static inline int iam_frame_is_locked(struct iam_path *path,
931 const struct iam_frame *frame)
935 result = dynlock_is_locked(path_dynlock(path), frame->curidx);
941 int dx_lookup_lock(struct iam_path *path,
942 struct dynlock_handle **dl, enum dynlock_type lt);
944 void dx_insert_block(struct iam_path *path, struct iam_frame *frame,
945 u32 hash, u32 block);
946 int dx_index_is_compat(struct iam_path *path);
948 int ldiskfs_htree_next_block(struct inode *dir, __u32 hash,
949 struct iam_path *path, __u32 *start_hash);
951 struct buffer_head *ldiskfs_append(handle_t *handle, struct inode *inode,
952 u32 *block, int *err);
953 int split_index_node(handle_t *handle, struct iam_path *path,
954 struct dynlock_handle **lh);
955 struct ldiskfs_dir_entry_2 *split_entry(struct inode *dir,
956 struct ldiskfs_dir_entry_2 *de,
957 unsigned long ino, mode_t mode,
958 const char *name, int namelen);
959 struct ldiskfs_dir_entry_2 *find_insertion_point(struct inode *dir,
960 struct buffer_head *bh,
961 const char *name, int namelen);
962 struct ldiskfs_dir_entry_2 *move_entries(struct inode *dir,
963 struct ldiskfs_dx_hash_info *hinfo,
964 struct buffer_head **bh1,
965 struct buffer_head **bh2,
968 extern struct iam_descr iam_htree_compat_param;
970 struct dynlock_handle *dx_lock_htree(struct inode *dir, unsigned long value,
971 enum dynlock_type lt);
972 void dx_unlock_htree(struct inode *dir, struct dynlock_handle *lh);
977 void iam_container_write_lock(struct iam_container *c);
978 void iam_container_write_unlock(struct iam_container *c);
980 void iam_container_read_lock(struct iam_container *c);
981 void iam_container_read_unlock(struct iam_container *c);
983 int iam_index_next(struct iam_container *c, struct iam_path *p);
984 int iam_read_leaf(struct iam_path *p);
986 int iam_node_read(struct iam_container *c, iam_ptr_t ptr,
987 handle_t *handle, struct buffer_head **bh);
988 int iam_lvar_create(struct inode *obj,
989 int keysize, int ptrsize, int recsize, handle_t *handle);
992 #define swap(x, y) do { typeof(x) z = x; x = y; y = z; } while (0)
996 #define dxtrace(command) command
998 #define dxtrace(command)
1001 #define BH_DXLock 25
1002 #define DX_DEBUG (0)
1004 static struct iam_lock_stats {
1005 unsigned dls_bh_lock;
1006 unsigned dls_bh_busy;
1007 unsigned dls_bh_again;
1008 unsigned dls_bh_full_again;
1009 } iam_lock_stats = { 0, };
1010 #define DX_DEVAL(x) x
1015 static inline void iam_lock_bh(struct buffer_head volatile *bh)
1017 DX_DEVAL(iam_lock_stats.dls_bh_lock++);
1019 while (cfs_test_and_set_bit(BH_DXLock, &bh->b_state)) {
1020 DX_DEVAL(iam_lock_stats.dls_bh_busy++);
1021 while (cfs_test_bit(BH_DXLock, &bh->b_state))
1027 static inline void iam_unlock_bh(struct buffer_head *bh)
1030 smp_mb__before_clear_bit();
1031 clear_bit(BH_DXLock, &bh->b_state);
1036 void iam_insert_key(struct iam_path *path, struct iam_frame *frame,
1037 const struct iam_ikey *key, iam_ptr_t ptr);
1039 void iam_insert_key_lock(struct iam_path *path, struct iam_frame *frame,
1040 const struct iam_ikey *key, iam_ptr_t ptr);
1043 int iam_leaf_at_end(const struct iam_leaf *l);
1044 void iam_leaf_next(struct iam_leaf *folio);
1045 int iam_leaf_can_add(const struct iam_leaf *l,
1046 const struct iam_key *k, const struct iam_rec *r);
1048 struct iam_path *iam_leaf_path(const struct iam_leaf *leaf);
1049 struct iam_container *iam_leaf_container(const struct iam_leaf *leaf);
1050 struct iam_descr *iam_leaf_descr(const struct iam_leaf *leaf);
1051 struct iam_leaf_operations *iam_leaf_ops(const struct iam_leaf *leaf);
1054 int iam_node_read(struct iam_container *c, iam_ptr_t ptr,
1055 handle_t *h, struct buffer_head **bh);
1062 * Method called to recognize container format. Should return true iff
1063 * container @c conforms to this format. This method may do IO to read
1066 * If container is recognized, this method sets operation vectors
1067 * ->id_ops and ->id_leaf_ops in container description (c->ic_descr),
1068 * and fills other description fields.
1070 int (*if_guess)(struct iam_container *c);
1072 * Linkage into global list of container formats.
1074 cfs_list_t if_linkage;
1077 void iam_format_register(struct iam_format *fmt);
1078 int iam_root_limit(int rootgap, int blocksize, int size);
1080 void iam_lfix_format_init(void);
1081 void iam_lvar_format_init(void);
1082 void iam_htree_format_init(void);
1084 int iam_lfix_create(struct inode *obj,
1085 int keysize, int ptrsize, int recsize, handle_t *handle);
1086 struct iam_private_info;
1088 void ldiskfs_iam_release(struct file *filp, struct inode *inode);
1090 int iam_uapi_ioctl(struct inode * inode, struct file * filp, unsigned int cmd,
1094 #if LDISKFS_INVARIANT_ON
1095 extern int ldiskfs_check_dir_entry(const char *, struct inode *,
1096 struct ldiskfs_dir_entry_2 *,
1097 struct buffer_head *, unsigned long);
1099 static inline int ldiskfs_check_dir_entry(const char * function,
1101 struct ldiskfs_dir_entry_2 * de,
1102 struct buffer_head * bh,
1103 unsigned long offset)
1114 * User level API. Copy exists in lustre/lustre/tests/iam_ut.c
1117 struct iam_uapi_info {
1122 char iui_fmt_name[DX_FMT_NAME_LEN];
1125 struct iam_uapi_op {
1130 struct iam_uapi_it {
1131 struct iam_uapi_op iui_op;
1135 enum iam_ioctl_cmd {
1136 IAM_IOC_INIT = _IOW('i', 1, struct iam_uapi_info),
1137 IAM_IOC_GETINFO = _IOR('i', 2, struct iam_uapi_info),
1138 IAM_IOC_INSERT = _IOR('i', 3, struct iam_uapi_op),
1139 IAM_IOC_LOOKUP = _IOWR('i', 4, struct iam_uapi_op),
1140 IAM_IOC_DELETE = _IOR('i', 5, struct iam_uapi_op),
1141 IAM_IOC_IT_START = _IOR('i', 6, struct iam_uapi_it),
1142 IAM_IOC_IT_NEXT = _IOW('i', 7, struct iam_uapi_it),
1143 IAM_IOC_IT_STOP = _IOR('i', 8, struct iam_uapi_it),
1145 IAM_IOC_POLYMORPH = _IOR('i', 9, unsigned long)
1148 /* __LINUX_LUSTRE_IAM_H__ */