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, 2015, 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 osd module
35 * Author: Wang Di <wangdi@clusterfs.com>
36 * Author: Nikita Danilov <nikita@clusterfs.com>
39 #ifndef __LINUX_LUSTRE_IAM_H__
40 #define __LINUX_LUSTRE_IAM_H__
42 #include <linux/module.h>
43 #include <asm/unaligned.h>
45 #include "osd_dynlocks.h"
50 #define CLASSERT(cond) do {switch(42) {case (cond): case 0: break;}} while (0)
53 #define ergo(a, b) (!(a) || (b))
54 /* logical equivalence */
55 #define equi(a, b) (!!(a) == !!(b))
59 * Maximal number of non-leaf levels in htree. In the stock ldiskfs this
63 * XXX reduced back to 2 to make per-node locking work.
65 DX_MAX_TREE_HEIGHT = 5,
67 * Scratch keys used by generic code for temporaries.
71 * [0] reserved for assertions and as a staging area for
72 * record keys immediately used for key comparisons.
74 * [1] reserved for record key, stored during iteration over
75 * node records (see dx_node_check()).
77 * [2] reserved for leaf node operations.
79 * [3] reserved for index operations.
81 * [4] reserved for path->ip_ikey_target
86 * Maximal format name length.
95 * Various debugging levels.
100 * Following macros are defined in config.h and are tunable through
101 * appropriate configure switches (indicated below).
105 * Compile basic assertions in. You want this most of the time.
107 * --{enable,disable}-ldiskfs-assert (on by default).
109 #define LDISKFS_ASSERT (1)
112 * Compile heavier correctness checks in. You want this during development
115 * --{enable,disable}-ldiskfs-correctness (off by default).
117 #define LDISKFS_CORRECTNESS (1)
120 * Compile heavy invariant checking in. You want this early during development
121 * or when chasing a bug.
123 * --{enable,disable}-ldiskfs-invariant (off by default).
125 #define LDISKFS_INVARIANT (1)
128 #if defined(LDISKFS_ASSERT)
129 #define LDISKFS_ASSERT_ON (1)
131 #define LDISKFS_ASSERT_ON (0)
134 #if defined(LDISKFS_CORRECTNESS)
135 #define LDISKFS_CORRECTNESS_ON (1)
137 #define LDISKFS_CORRECTNESS_ON (0)
140 #if defined(LDISKFS_INVARIANT)
141 #define LDISKFS_INVARIANT_ON (1)
143 #define LDISKFS_INVARIANT_ON (0)
147 #if LDISKFS_ASSERT_ON
148 #define assert(test) J_ASSERT(test)
150 #define assert(test) ((void)(test))
154 #if LDISKFS_CORRECTNESS_ON
155 #define assert_corr(test) J_ASSERT(test)
156 #define do_corr(exp) exp
158 #define assert_corr(test) do {;} while (0)
159 #define do_corr(exp) do {;} while (0)
162 #if LDISKFS_INVARIANT_ON
163 #define assert_inv(test) J_ASSERT(test)
165 #define assert_inv(test) do {;} while (0)
169 * Entry within index tree node. Consists of a key immediately followed
170 * (without padding) by a pointer to the child node.
172 * Both key and pointer are of variable size, hence incomplete type.
176 struct iam_entry_compat {
182 * Incomplete type used to refer to keys in iam container.
184 * As key size can be different from container to container, iam has to use
185 * incomplete type. Clients cast pointer to iam_key to real key type and back.
190 * Incomplete type use to refer to the records stored in iam containers.
195 * Key in index node. Possibly compressed. Fixed size.
200 * Scalar type into which certain iam_key's can be uniquely mapped. Used to
201 * support interfaces like readdir(), where iteration over index has to be
204 typedef __u32 iam_ptr_t;
207 * Index node traversed during tree lookup.
210 struct buffer_head *bh; /* buffer holding node data */
211 struct iam_entry *entries; /* array of entries */
212 struct iam_entry *at; /* target entry, found by binary search */
213 iam_ptr_t leaf; /* (logical) offset of child node found by
215 iam_ptr_t curidx; /* (logical) offset of this node. Used to
216 * per-node locking to detect concurrent
218 unsigned int at_shifted:1; /* The "at" entry has moved to next
219 * because of shrinking index node
220 * for recycling empty leaf node. */
224 * Opaque entry in the leaf node.
229 struct iam_container;
232 /* leaf node reached by tree lookup */
234 struct iam_path *il_path;
235 struct buffer_head *il_bh;
236 struct iam_lentry *il_entries;
237 struct iam_lentry *il_at;
239 * Lock on a leaf node.
241 struct dynlock_handle *il_lock;
242 iam_ptr_t il_curidx; /* logical offset of leaf node. */
247 * Return values of ->lookup() operation from struct iam_leaf_operations.
251 * lookup found a record with the key requested
253 IAM_LOOKUP_EXACT = 0,
255 * lookup positioned leaf on some record
261 IAM_LOOKUP_EMPTY = 2,
263 * lookup positioned leaf before first record
265 IAM_LOOKUP_BEFORE = 3,
267 * Found hash may have a continuation in the next leaf.
269 IAM_LOOKUP_LAST = 0x100
273 * Format-specific container operations. These are called by generic iam code.
275 struct iam_operations {
277 * Returns pointer (in the same sense as pointer in index entry) to
280 __u32 (*id_root_ptr)(struct iam_container *c);
283 * Check validity and consistency of index node.
285 int (*id_node_check)(struct iam_path *path, struct iam_frame *frame);
287 * Copy some data from node header into frame. This is called when
288 * new node is loaded into frame.
290 int (*id_node_load)(struct iam_path *path, struct iam_frame *frame);
292 * Initialize new node (stored in @bh) that is going to be added into
295 int (*id_node_init)(struct iam_container *c,
296 struct buffer_head *bh, int root);
297 int (*id_node_read)(struct iam_container *c, iam_ptr_t ptr,
298 handle_t *h, struct buffer_head **bh);
300 * Key comparison functions. Returns -1, 0, +1.
302 int (*id_ikeycmp)(const struct iam_container *c,
303 const struct iam_ikey *k1,
304 const struct iam_ikey *k2);
306 * Modify root node when tree height increases.
308 struct iam_entry *(*id_root_inc)(struct iam_container *c,
309 struct iam_path *path,
310 struct iam_frame *frame);
312 struct iam_path_descr *(*id_ipd_alloc)(const struct iam_container *c,
314 void (*id_ipd_free)(struct iam_path_descr *ipd);
318 char id_name[DX_FMT_NAME_LEN];
322 * Another format-specific operation vector, consisting of methods to access
323 * leaf nodes. This is separated from struct iam_operations, because it is
324 * assumed that there will be many formats with different format of leaf
325 * nodes, yes the same struct iam_operations.
327 struct iam_leaf_operations {
333 * initialize just loaded leaf node.
335 int (*init)(struct iam_leaf *p);
339 void (*init_new)(struct iam_container *c, struct buffer_head *bh);
343 void (*fini)(struct iam_leaf *l);
345 * returns true iff leaf is positioned at the last entry.
347 int (*at_end)(const struct iam_leaf *l);
348 /* position leaf at the first entry */
349 void (*start)(struct iam_leaf *l);
350 /* more leaf to the next entry. */
351 void (*next)(struct iam_leaf *l);
353 * return key of current leaf record. This method may return
354 * either pointer to the key stored in node, or copy key into
355 * @k buffer supplied by caller and return pointer to this
356 * buffer. The latter approach is used when keys in nodes are
357 * not stored in plain form (e.g., htree doesn't store keys at
360 * Caller should assume that returned pointer is only valid
361 * while leaf node is pinned and locked.
363 struct iam_ikey *(*ikey)(const struct iam_leaf *l, struct iam_ikey *k);
364 struct iam_key *(*key)(const struct iam_leaf *l);
365 /* return pointer to entry body. Pointer is valid while
366 corresponding leaf node is locked and pinned. */
367 struct iam_rec *(*rec)(const struct iam_leaf *l);
369 void (*key_set)(struct iam_leaf *l, const struct iam_key *k);
370 void (*rec_set)(struct iam_leaf *l, const struct iam_rec *r);
371 void (*rec_get)(const struct iam_leaf *l, struct iam_rec *r);
373 int (*key_cmp)(const struct iam_leaf *l, const struct iam_key *k);
374 int (*key_eq)(const struct iam_leaf *l, const struct iam_key *k);
376 int (*rec_eq)(const struct iam_leaf *l, const struct iam_rec *r);
378 int (*key_size)(const struct iam_leaf *l);
380 * Search leaf @l for a record with key @k or for a place
381 * where such record is to be inserted.
383 * Scratch keys from @path can be used.
385 int (*lookup)(struct iam_leaf *l, const struct iam_key *k);
386 int (*ilookup)(struct iam_leaf *l, const struct iam_ikey *ik);
388 int (*can_add)(const struct iam_leaf *l,
389 const struct iam_key *k, const struct iam_rec *r);
393 void (*rec_add)(struct iam_leaf *l,
394 const struct iam_key *k, const struct iam_rec *r);
396 * remove rec for a leaf
398 void (*rec_del)(struct iam_leaf *l, int shift);
400 * split leaf node, moving some entries into @bh (the latter currently
401 * is assumed to be empty).
403 void (*split)(struct iam_leaf *l, struct buffer_head **bh,
408 int (*leaf_empty)(struct iam_leaf *l);
412 * Parameters, describing a flavor of iam container.
416 * Size of a key in this container, in bytes.
420 * Size of a key in index nodes, in bytes.
424 * Size of a pointer to the next level (stored in index nodes), in
429 * Size of a record (stored in leaf nodes), in bytes.
433 * Size of unused (by iam) space at the beginning of every non-root
434 * node, in bytes. Used for compatibility with ldiskfs.
438 * Size of unused (by iam) space at the beginning of root node, in
439 * bytes. Used for compatibility with ldiskfs.
443 struct iam_operations *id_ops;
444 struct iam_leaf_operations *id_leaf_ops;
448 IAM_IDLE_HEADER_MAGIC = 0x7903,
452 * Header structure to record idle blocks.
454 struct iam_idle_head {
456 __le16 iih_count; /* how many idle blocks in this head */
457 __le32 iih_next; /* next head for idle blocks */
462 * An instance of iam container.
464 struct iam_container {
466 * Underlying flat file. IO against this object is issued to
469 struct inode *ic_object;
473 struct buffer_head *ic_root_bh;
477 struct iam_descr *ic_descr;
479 * read-write lock protecting index consistency.
481 struct rw_semaphore ic_sem;
482 struct dynlock ic_tree_lock;
483 /* Protect ic_idle_bh */
484 struct mutex ic_idle_mutex;
488 struct buffer_head *ic_idle_bh;
489 unsigned int ic_idle_failed:1; /* Idle block mechanism failed */
493 * description-specific part of iam_path. This is usually embedded into larger
496 struct iam_path_descr {
498 * Scratch-pad area for temporary keys.
500 struct iam_ikey *ipd_key_scratch[DX_SCRATCH_KEYS];
504 * Structure to keep track of a path drilled through htree.
510 struct iam_container *ip_container;
512 * Number of index levels minus one.
516 * Nodes that top-to-bottom traversal passed through.
518 struct iam_frame ip_frames[DX_MAX_TREE_HEIGHT];
520 * Last filled frame in ->ip_frames. Refers to the 'twig' node (one
521 * immediately above leaf).
523 struct iam_frame *ip_frame;
525 * Leaf node: a child of ->ip_frame.
527 struct iam_leaf ip_leaf;
531 const struct iam_key *ip_key_target;
532 const struct iam_ikey *ip_ikey_target;
534 * Description-specific data.
536 struct iam_path_descr *ip_data;
539 struct ldiskfs_dx_hash_info;
542 * Helper structure for legacy htrees.
544 struct iam_path_compat {
545 struct iam_path ipc_path;
546 struct iam_container ipc_container;
547 __u32 ipc_scratch[DX_SCRATCH_KEYS];
548 struct ldiskfs_dx_hash_info *ipc_hinfo;
549 struct qstr *ipc_qstr;
550 struct iam_path_descr ipc_descr;
551 struct ldiskfs_dx_hash_info ipc_hinfo_area;
554 #define const_max(p, q) ((p > q) ? p : q)
557 DX_MAX_IKEY_SIZE = 32, /* be generous */
559 * Hack to avoid dynamic allocation and freeing of ipd.
561 DX_IPD_MAX_SIZE = const_max(sizeof(struct iam_path_compat),
562 DX_MAX_IKEY_SIZE * DX_SCRATCH_KEYS +
563 sizeof(struct iam_path_descr))
567 * iam cursor (iterator) api.
571 * States of iterator state machine.
576 /* iterator is above particular record in the container */
578 /* iterator is positioned before record */
583 * Flags controlling iterator functionality.
587 * this iterator will move (iam_it_next() will be called on it)
589 IAM_IT_MOVE = (1 << 0),
591 * tree can be updated through this iterator.
593 IAM_IT_WRITE = (1 << 1)
599 * Immediately after call to iam_it_init() iterator is in "detached"
600 * (IAM_IT_DETACHED) state: it is associated with given parent container, but
601 * doesn't point to any particular record in this container.
603 * After successful call to iam_it_get() and until corresponding call to
604 * iam_it_put() iterator is in one of "active" states: IAM_IT_ATTACHED or
607 * Active iterator can move through records in a container (provided
608 * IAM_IT_MOVE permission) in a key order, can get record and key values as it
609 * passes over them, and can modify container (provided IAM_IT_WRITE
612 * Iteration may reach the end of container, at which point iterator switches
613 * into IAM_IT_DETACHED state.
615 * Concurrency: iterators are supposed to be local to thread. Interfaces below
616 * do no internal serialization of access to the iterator fields.
618 * When in non-detached state, iterator keeps some container nodes pinned in
619 * memory and locked (that locking may be implemented at the container
620 * granularity though). In particular, clients may assume that pointers to
621 * records and keys obtained through iterator interface as valid until
622 * iterator is detached (except that they may be invalidated by sub-sequent
623 * operations done through the same iterator).
626 struct iam_iterator {
628 * iterator flags, taken from enum iam_it_flags.
631 enum iam_it_state ii_state;
633 * path to the record. Valid in IAM_IT_ATTACHED, and IAM_IT_SKEWED
636 struct iam_path ii_path;
639 void iam_path_init(struct iam_path *path, struct iam_container *c,
640 struct iam_path_descr *pd);
641 void iam_path_fini(struct iam_path *path);
642 void iam_path_release(struct iam_path *path);
644 void iam_path_compat_init(struct iam_path_compat *path, struct inode *inode);
645 void iam_path_compat_fini(struct iam_path_compat *path);
647 struct iam_path_descr *iam_ipd_alloc(void *area, int keysize);
648 void iam_ipd_free(struct iam_path_descr *ipd);
650 int iam_it_init(struct iam_iterator *it, struct iam_container *c, __u32 flags,
651 struct iam_path_descr *pd);
652 void iam_it_fini(struct iam_iterator *it);
653 int iam_it_get(struct iam_iterator *it, const struct iam_key *k);
654 int iam_it_get_at(struct iam_iterator *it, const struct iam_key *k);
655 void iam_it_dup(struct iam_iterator *dst, const struct iam_iterator *src);
656 void iam_it_put(struct iam_iterator *it);
657 int iam_it_next(struct iam_iterator *it);
658 struct iam_rec *iam_it_rec_get(const struct iam_iterator *it);
659 int iam_it_rec_set(handle_t *h,
660 struct iam_iterator *it, const struct iam_rec *r);
661 struct iam_key *iam_it_key_get(const struct iam_iterator *it);
662 int iam_it_key_size(const struct iam_iterator *it);
663 int iam_it_rec_insert(handle_t *h, struct iam_iterator *it,
664 const struct iam_key *k, const struct iam_rec *r);
665 int iam_it_rec_delete(handle_t *h, struct iam_iterator *it);
667 typedef __u64 iam_pos_t;
669 iam_pos_t iam_it_store(const struct iam_iterator *it);
670 int iam_it_load(struct iam_iterator *it, iam_pos_t pos);
672 int iam_lookup(struct iam_container *c, const struct iam_key *k,
673 struct iam_rec *r, struct iam_path_descr *pd);
674 int iam_delete(handle_t *h, struct iam_container *c, const struct iam_key *k,
675 struct iam_path_descr *pd);
676 int iam_update(handle_t *h, struct iam_container *c, const struct iam_key *k,
677 const struct iam_rec *r, struct iam_path_descr *pd);
678 int iam_insert(handle_t *handle, struct iam_container *c,
679 const struct iam_key *k,
680 const struct iam_rec *r, struct iam_path_descr *pd);
682 * Initialize container @c.
684 int iam_container_init(struct iam_container *c,
685 struct iam_descr *descr, struct inode *inode);
687 * Finalize container @c, release all resources.
689 void iam_container_fini(struct iam_container *c);
692 * Determine container format.
694 int iam_container_setup(struct iam_container *c);
696 static inline struct iam_descr *iam_container_descr(struct iam_container *c)
701 static inline struct iam_descr *iam_path_descr(const struct iam_path *p)
703 return p->ip_container->ic_descr;
706 static inline struct inode *iam_path_obj(struct iam_path *p)
708 return p->ip_container->ic_object;
711 static inline void iam_ikeycpy(const struct iam_container *c,
712 struct iam_ikey *k1, const struct iam_ikey *k2)
714 memcpy(k1, k2, c->ic_descr->id_ikey_size);
717 static inline size_t iam_entry_size(struct iam_path *p)
719 return iam_path_descr(p)->id_ikey_size + iam_path_descr(p)->id_ptr_size;
722 static inline struct iam_entry *iam_entry_shift(struct iam_path *p,
723 struct iam_entry *entry,
727 return e + shift * iam_entry_size(p);
730 static inline struct iam_ikey *dx_get_ikey(struct iam_path *p,
731 struct iam_entry *entry,
732 struct iam_ikey *key)
734 return memcpy(key, entry, iam_path_descr(p)->id_ikey_size);
737 static inline struct iam_ikey *iam_ikey_at(struct iam_path *p,
738 struct iam_entry *entry)
740 return (struct iam_ikey *)entry;
743 static inline ptrdiff_t iam_entry_diff(struct iam_path *p,
744 struct iam_entry *e1,
745 struct iam_entry *e2)
749 diff = (void *)e1 - (void *)e2;
750 assert_corr(diff / iam_entry_size(p) * iam_entry_size(p) == diff);
751 return diff / iam_entry_size(p);
755 * Helper for the frequent case, where key was already placed into @k1 by
758 static inline void iam_ikeycpy0(const struct iam_container *c,
759 struct iam_ikey *k1, const struct iam_ikey *k2)
762 iam_ikeycpy(c, k1, k2);
765 static inline int iam_ikeycmp(const struct iam_container *c,
766 const struct iam_ikey *k1,
767 const struct iam_ikey *k2)
769 return c->ic_descr->id_ops->id_ikeycmp(c, k1, k2);
772 static inline void *iam_entry_off(struct iam_entry *entry, size_t off)
774 return (void *)((char *)entry + off);
781 static inline struct iam_path *iam_leaf_path(const struct iam_leaf *leaf)
783 return leaf->il_path;
786 static inline struct iam_container *
787 iam_leaf_container(const struct iam_leaf *leaf)
789 return iam_leaf_path(leaf)->ip_container;
792 static inline struct iam_descr *iam_leaf_descr(const struct iam_leaf *leaf)
794 return iam_leaf_container(leaf)->ic_descr;
797 static inline struct iam_leaf_operations *
798 iam_leaf_ops(const struct iam_leaf *leaf)
800 return iam_leaf_descr(leaf)->id_leaf_ops;
803 static inline void iam_reccpy(const struct iam_leaf *leaf,
804 struct iam_rec *rec_dst)
806 iam_leaf_ops(leaf)->rec_get(leaf, rec_dst);
809 /*XXX These stuff put here, just because they are used by iam.c */
810 static inline unsigned dx_get_block(struct iam_path *p, struct iam_entry *entry)
814 addr = iam_entry_off(entry, iam_path_descr(p)->id_ikey_size);
815 return le32_to_cpu(get_unaligned(addr));
818 static inline void dx_set_block(struct iam_path *p,
819 struct iam_entry *entry, unsigned value)
823 addr = iam_entry_off(entry, iam_path_descr(p)->id_ikey_size);
824 put_unaligned(cpu_to_le32(value), addr);
827 static inline void dx_set_ikey(struct iam_path *p, struct iam_entry *entry,
828 const struct iam_ikey *key)
830 iam_ikeycpy(p->ip_container, iam_entry_off(entry, 0), key);
846 struct dx_countlimit {
852 * dx_root_info is laid out so that if it should somehow get overlaid by a
853 * dirent the two low bits of the hash version will be zero. Therefore, the
854 * hash version mod 4 should never be 0. Sincerely, the paranoia department.
858 struct fake_dirent dot;
860 struct fake_dirent dotdot;
864 __le32 reserved_zero;
866 u8 info_length; /* 8 */
871 struct {} entries[0];
876 struct fake_dirent fake;
877 struct {} entries[0];
881 static inline unsigned dx_get_count(struct iam_entry *entries)
883 return le16_to_cpu(((struct dx_countlimit *) entries)->count);
886 static inline unsigned dx_get_limit(struct iam_entry *entries)
888 return le16_to_cpu(((struct dx_countlimit *) entries)->limit);
891 static inline void dx_set_count(struct iam_entry *entries, unsigned value)
893 ((struct dx_countlimit *) entries)->count = cpu_to_le16(value);
896 static inline unsigned dx_node_limit(struct iam_path *p)
898 struct iam_descr *param = iam_path_descr(p);
899 unsigned entry_space = iam_path_obj(p)->i_sb->s_blocksize -
901 return entry_space / (param->id_ikey_size + param->id_ptr_size);
904 static inline unsigned dx_root_limit(struct iam_path *p)
906 struct iam_descr *param = iam_path_descr(p);
907 unsigned limit = iam_path_obj(p)->i_sb->s_blocksize -
909 limit /= (param->id_ikey_size + param->id_ptr_size);
910 if (limit == dx_node_limit(p))
916 static inline struct iam_entry *dx_get_entries(struct iam_path *path,
917 void *data, int root)
919 struct iam_descr *param = iam_path_descr(path);
920 return data + (root ? param->id_root_gap : param->id_node_gap);
924 static inline struct iam_entry *dx_node_get_entries(struct iam_path *path,
925 struct iam_frame *frame)
927 return dx_get_entries(path,
928 frame->bh->b_data, frame == path->ip_frames);
931 static inline struct iam_ikey *iam_path_ikey(const struct iam_path *path,
934 LASSERT(0 <= nr && nr < ARRAY_SIZE(path->ip_data->ipd_key_scratch));
935 return path->ip_data->ipd_key_scratch[nr];
938 static inline int iam_leaf_is_locked(const struct iam_leaf *leaf)
942 result = dynlock_is_locked(&iam_leaf_container(leaf)->ic_tree_lock,
949 static inline int iam_frame_is_locked(struct iam_path *path,
950 const struct iam_frame *frame)
954 result = dynlock_is_locked(&path->ip_container->ic_tree_lock,
961 int dx_lookup_lock(struct iam_path *path,
962 struct dynlock_handle **dl, enum dynlock_type lt);
964 void dx_insert_block(struct iam_path *path, struct iam_frame *frame,
965 u32 hash, u32 block);
966 int dx_index_is_compat(struct iam_path *path);
968 int ldiskfs_htree_next_block(struct inode *dir, __u32 hash,
969 struct iam_path *path, __u32 *start_hash);
971 int split_index_node(handle_t *handle, struct iam_path *path,
972 struct dynlock_handle **lh);
973 struct ldiskfs_dir_entry_2 *split_entry(struct inode *dir,
974 struct ldiskfs_dir_entry_2 *de,
975 unsigned long ino, mode_t mode,
976 const char *name, int namelen);
977 struct ldiskfs_dir_entry_2 *find_insertion_point(struct inode *dir,
978 struct buffer_head *bh,
979 const char *name, int namelen);
980 struct ldiskfs_dir_entry_2 *move_entries(struct inode *dir,
981 struct ldiskfs_dx_hash_info *hinfo,
982 struct buffer_head **bh1,
983 struct buffer_head **bh2,
986 extern struct iam_descr iam_htree_compat_param;
988 struct dynlock_handle *dx_lock_htree(struct inode *dir, unsigned long value,
989 enum dynlock_type lt);
990 void dx_unlock_htree(struct inode *dir, struct dynlock_handle *lh);
995 void iam_container_write_lock(struct iam_container *c);
996 void iam_container_write_unlock(struct iam_container *c);
998 void iam_container_read_lock(struct iam_container *c);
999 void iam_container_read_unlock(struct iam_container *c);
1001 int iam_index_next(struct iam_container *c, struct iam_path *p);
1002 int iam_read_leaf(struct iam_path *p);
1004 int iam_node_read(struct iam_container *c, iam_ptr_t ptr,
1005 handle_t *handle, struct buffer_head **bh);
1006 int iam_lvar_create(struct inode *obj,
1007 int keysize, int ptrsize, int recsize, handle_t *handle);
1010 #define swap(x, y) do { typeof(x) z = x; x = y; y = z; } while (0)
1014 #define dxtrace(command) command
1016 #define dxtrace(command)
1019 #define BH_DXLock (BH_BITMAP_UPTODATE + 1)
1020 #define DX_DEBUG (0)
1022 static struct iam_lock_stats {
1023 unsigned dls_bh_lock;
1024 unsigned dls_bh_busy;
1025 unsigned dls_bh_again;
1026 unsigned dls_bh_full_again;
1027 } iam_lock_stats = { 0, };
1028 #define DX_DEVAL(x) x
1033 static inline void iam_lock_bh(struct buffer_head volatile *bh)
1035 DX_DEVAL(iam_lock_stats.dls_bh_lock++);
1037 while (test_and_set_bit_lock(BH_DXLock, &bh->b_state)) {
1038 DX_DEVAL(iam_lock_stats.dls_bh_busy++);
1039 while (test_bit(BH_DXLock, &bh->b_state))
1045 static inline void iam_unlock_bh(struct buffer_head *bh)
1048 clear_bit_unlock(BH_DXLock, &bh->b_state);
1053 void iam_insert_key(struct iam_path *path, struct iam_frame *frame,
1054 const struct iam_ikey *key, iam_ptr_t ptr);
1056 void iam_insert_key_lock(struct iam_path *path, struct iam_frame *frame,
1057 const struct iam_ikey *key, iam_ptr_t ptr);
1060 int iam_leaf_at_end(const struct iam_leaf *l);
1061 void iam_leaf_next(struct iam_leaf *folio);
1062 int iam_leaf_can_add(const struct iam_leaf *l,
1063 const struct iam_key *k, const struct iam_rec *r);
1065 struct iam_path *iam_leaf_path(const struct iam_leaf *leaf);
1066 struct iam_container *iam_leaf_container(const struct iam_leaf *leaf);
1067 struct iam_descr *iam_leaf_descr(const struct iam_leaf *leaf);
1068 struct iam_leaf_operations *iam_leaf_ops(const struct iam_leaf *leaf);
1071 int iam_node_read(struct iam_container *c, iam_ptr_t ptr,
1072 handle_t *h, struct buffer_head **bh);
1079 * Method called to recognize container format. Should return true iff
1080 * container @c conforms to this format. This method may do IO to read
1083 * If container is recognized, this method sets operation vectors
1084 * ->id_ops and ->id_leaf_ops in container description (c->ic_descr),
1085 * and fills other description fields.
1087 int (*if_guess)(struct iam_container *c);
1089 * Linkage into global list of container formats.
1091 struct list_head if_linkage;
1094 void iam_format_register(struct iam_format *fmt);
1095 int iam_root_limit(int rootgap, int blocksize, int size);
1097 void iam_lfix_format_init(void);
1098 void iam_lvar_format_init(void);
1099 void iam_htree_format_init(void);
1101 int iam_lfix_create(struct inode *obj,
1102 int keysize, int ptrsize, int recsize, handle_t *handle);
1103 struct iam_private_info;
1105 void ldiskfs_iam_release(struct file *filp, struct inode *inode);
1107 int iam_uapi_ioctl(struct inode * inode, struct file * filp, unsigned int cmd,
1111 #if LDISKFS_INVARIANT_ON
1112 extern int ldiskfs_check_dir_entry(const char *, struct inode *,
1113 struct ldiskfs_dir_entry_2 *,
1114 struct buffer_head *, unsigned long);
1116 static inline int ldiskfs_check_dir_entry(const char * function,
1118 struct ldiskfs_dir_entry_2 * de,
1119 struct buffer_head * bh,
1120 unsigned long offset)
1130 * User level API. Copy exists in lustre/lustre/tests/iam_ut.c
1133 struct iam_uapi_info {
1138 char iui_fmt_name[DX_FMT_NAME_LEN];
1141 struct iam_uapi_op {
1146 struct iam_uapi_it {
1147 struct iam_uapi_op iui_op;
1151 enum iam_ioctl_cmd {
1152 IAM_IOC_INIT = _IOW('i', 1, struct iam_uapi_info),
1153 IAM_IOC_GETINFO = _IOR('i', 2, struct iam_uapi_info),
1154 IAM_IOC_INSERT = _IOR('i', 3, struct iam_uapi_op),
1155 IAM_IOC_LOOKUP = _IOWR('i', 4, struct iam_uapi_op),
1156 IAM_IOC_DELETE = _IOR('i', 5, struct iam_uapi_op),
1157 IAM_IOC_IT_START = _IOR('i', 6, struct iam_uapi_it),
1158 IAM_IOC_IT_NEXT = _IOW('i', 7, struct iam_uapi_it),
1159 IAM_IOC_IT_STOP = _IOR('i', 8, struct iam_uapi_it),
1161 IAM_IOC_POLYMORPH = _IOR('i', 9, unsigned long)
1164 /* __LINUX_LUSTRE_IAM_H__ */