git.sesse.net Git - bcachefs-tools-debian/blob - include/linux/idr.h

   1 /*
   2  * include/linux/idr.h
   3  *
   4  * 2002-10-18  written by Jim Houston jim.houston@ccur.com
   5  *      Copyright (C) 2002 by Concurrent Computer Corporation
   6  *      Distributed under the GNU GPL license version 2.
   7  *
   8  * Small id to pointer translation service avoiding fixed sized
   9  * tables.
  10  */
  11
  12 #ifndef __IDR_H__
  13 #define __IDR_H__
  14
  15 #include <linux/types.h>
  16 #include <linux/bitmap.h>
  17 #include <linux/bitops.h>
  18 #include <linux/preempt.h>
  19 #include <linux/rcupdate.h>
  20 #include <linux/spinlock.h>
  21
  22 /*
  23  * We want shallower trees and thus more bits covered at each layer.  8
  24  * bits gives us large enough first layer for most use cases and maximum
  25  * tree depth of 4.  Each idr_layer is slightly larger than 2k on 64bit and
  26  * 1k on 32bit.
  27  */
  28 #define IDR_BITS 8
  29 #define IDR_SIZE (1 << IDR_BITS)
  30 #define IDR_MASK ((1 << IDR_BITS)-1)
  31
  32 struct idr_layer {
  33         int                     prefix; /* the ID prefix of this idr_layer */
  34         int                     layer;  /* distance from leaf */
  35         struct idr_layer __rcu  *ary[1<<IDR_BITS];
  36         int                     count;  /* When zero, we can release it */
  37         union {
  38                 /* A zero bit means "space here" */
  39                 DECLARE_BITMAP(bitmap, IDR_SIZE);
  40                 struct rcu_head         rcu_head;
  41         };
  42 };
  43
  44 struct idr {
  45         struct idr_layer __rcu  *hint;  /* the last layer allocated from */
  46         struct idr_layer __rcu  *top;
  47         int                     layers; /* only valid w/o concurrent changes */
  48         int                     cur;    /* current pos for cyclic allocation */
  49         spinlock_t              lock;
  50         int                     id_free_cnt;
  51         struct idr_layer        *id_free;
  52 };
  53
  54 #define IDR_INIT(name)                                                  \
  55 {                                                                       \
  56         .lock                   = __SPIN_LOCK_UNLOCKED(name.lock),      \
  57 }
  58 #define DEFINE_IDR(name)        struct idr name = IDR_INIT(name)
  59
  60 /**
  61  * DOC: idr sync
  62  * idr synchronization (stolen from radix-tree.h)
  63  *
  64  * idr_find() is able to be called locklessly, using RCU. The caller must
  65  * ensure calls to this function are made within rcu_read_lock() regions.
  66  * Other readers (lock-free or otherwise) and modifications may be running
  67  * concurrently.
  68  *
  69  * It is still required that the caller manage the synchronization and
  70  * lifetimes of the items. So if RCU lock-free lookups are used, typically
  71  * this would mean that the items have their own locks, or are amenable to
  72  * lock-free access; and that the items are freed by RCU (or only freed after
  73  * having been deleted from the idr tree *and* a synchronize_rcu() grace
  74  * period).
  75  */
  76
  77 /*
  78  * This is what we export.
  79  */
  80
  81 void *idr_find_slowpath(struct idr *idp, int id);
  82 void idr_preload(gfp_t gfp_mask);
  83
  84 static inline int idr_alloc(struct idr *idp, void *ptr, int start, int end, gfp_t gfp_mask)
  85 {
  86         return 0;
  87 }
  88
  89 static inline void idr_remove(struct idr *idp, int id) {}
  90
  91 int idr_alloc_cyclic(struct idr *idr, void *ptr, int start, int end, gfp_t gfp_mask);
  92 int idr_for_each(struct idr *idp,
  93                  int (*fn)(int id, void *p, void *data), void *data);
  94 void *idr_get_next(struct idr *idp, int *nextid);
  95 void *idr_replace(struct idr *idp, void *ptr, int id);
  96 void idr_destroy(struct idr *idp);
  97 void idr_init(struct idr *idp);
  98 bool idr_is_empty(struct idr *idp);
  99
 100 /**
 101  * idr_preload_end - end preload section started with idr_preload()
 102  *
 103  * Each idr_preload() should be matched with an invocation of this
 104  * function.  See idr_preload() for details.
 105  */
 106 static inline void idr_preload_end(void)
 107 {
 108         preempt_enable();
 109 }
 110
 111 /**
 112  * idr_find - return pointer for given id
 113  * @idr: idr handle
 114  * @id: lookup key
 115  *
 116  * Return the pointer given the id it has been registered with.  A %NULL
 117  * return indicates that @id is not valid or you passed %NULL in
 118  * idr_get_new().
 119  *
 120  * This function can be called under rcu_read_lock(), given that the leaf
 121  * pointers lifetimes are correctly managed.
 122  */
 123 static inline void *idr_find(struct idr *idr, int id)
 124 {
 125         struct idr_layer *hint = rcu_dereference_raw(idr->hint);
 126
 127         if (hint && (id & ~IDR_MASK) == hint->prefix)
 128                 return rcu_dereference_raw(hint->ary[id & IDR_MASK]);
 129
 130         return idr_find_slowpath(idr, id);
 131 }
 132
 133 /**
 134  * idr_for_each_entry - iterate over an idr's elements of a given type
 135  * @idp:     idr handle
 136  * @entry:   the type * to use as cursor
 137  * @id:      id entry's key
 138  *
 139  * @entry and @id do not need to be initialized before the loop, and
 140  * after normal terminatinon @entry is left with the value NULL.  This
 141  * is convenient for a "not found" value.
 142  */
 143 #define idr_for_each_entry(idp, entry, id)                      \
 144         for (id = 0; ((entry) = idr_get_next(idp, &(id))) != NULL; ++id)
 145
 146 /**
 147  * idr_for_each_entry - continue iteration over an idr's elements of a given type
 148  * @idp:     idr handle
 149  * @entry:   the type * to use as cursor
 150  * @id:      id entry's key
 151  *
 152  * Continue to iterate over list of given type, continuing after
 153  * the current position.
 154  */
 155 #define idr_for_each_entry_continue(idp, entry, id)                     \
 156         for ((entry) = idr_get_next((idp), &(id));                      \
 157              entry;                                                     \
 158              ++id, (entry) = idr_get_next((idp), &(id)))
 159
 160 /*
 161  * IDA - IDR based id allocator, use when translation from id to
 162  * pointer isn't necessary.
 163  *
 164  * IDA_BITMAP_LONGS is calculated to be one less to accommodate
 165  * ida_bitmap->nr_busy so that the whole struct fits in 128 bytes.
 166  */
 167 #define IDA_CHUNK_SIZE          128     /* 128 bytes per chunk */
 168 #define IDA_BITMAP_LONGS        (IDA_CHUNK_SIZE / sizeof(long) - 1)
 169 #define IDA_BITMAP_BITS         (IDA_BITMAP_LONGS * sizeof(long) * 8)
 170
 171 struct ida_bitmap {
 172         long                    nr_busy;
 173         unsigned long           bitmap[IDA_BITMAP_LONGS];
 174 };
 175
 176 struct ida {
 177         struct idr              idr;
 178         struct ida_bitmap       *free_bitmap;
 179 };
 180
 181 #define IDA_INIT(name)          { .idr = IDR_INIT((name).idr), .free_bitmap = NULL, }
 182 #define DEFINE_IDA(name)        struct ida name = IDA_INIT(name)
 183
 184 int ida_pre_get(struct ida *ida, gfp_t gfp_mask);
 185 int ida_get_new_above(struct ida *ida, int starting_id, int *p_id);
 186 void ida_remove(struct ida *ida, int id);
 187 void ida_destroy(struct ida *ida);
 188 void ida_init(struct ida *ida);
 189
 190 int ida_simple_get(struct ida *ida, unsigned int start, unsigned int end,
 191                    gfp_t gfp_mask);
 192 void ida_simple_remove(struct ida *ida, unsigned int id);
 193
 194 /**
 195  * ida_get_new - allocate new ID
 196  * @ida:        idr handle
 197  * @p_id:       pointer to the allocated handle
 198  *
 199  * Simple wrapper around ida_get_new_above() w/ @starting_id of zero.
 200  */
 201 static inline int ida_get_new(struct ida *ida, int *p_id)
 202 {
 203         return ida_get_new_above(ida, 0, p_id);
 204 }
 205
 206 void __init idr_init_cache(void);
 207
 208 #endif /* __IDR_H__ */