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/bitops.h>
  17 #include <linux/init.h>
  18 #include <linux/rcupdate.h>
  19
  20 /*
  21  * We want shallower trees and thus more bits covered at each layer.  8
  22  * bits gives us large enough first layer for most use cases and maximum
  23  * tree depth of 4.  Each idr_layer is slightly larger than 2k on 64bit and
  24  * 1k on 32bit.
  25  */
  26 #define IDR_BITS 8
  27 #define IDR_SIZE (1 << IDR_BITS)
  28 #define IDR_MASK ((1 << IDR_BITS)-1)
  29
  30 struct idr_layer {
  31         DECLARE_BITMAP(bitmap, IDR_SIZE); /* A zero bit means "space here" */
  32         struct idr_layer __rcu  *ary[1<<IDR_BITS];
  33         int                     count;  /* When zero, we can release it */
  34         int                     layer;  /* distance from leaf */
  35         struct rcu_head         rcu_head;
  36 };
  37
  38 struct idr {
  39         struct idr_layer __rcu  *top;
  40         struct idr_layer        *id_free;
  41         int                     layers; /* only valid w/o concurrent changes */
  42         int                     id_free_cnt;
  43         spinlock_t              lock;
  44 };
  45
  46 #define IDR_INIT(name)                                                  \
  47 {                                                                       \
  48         .lock                   = __SPIN_LOCK_UNLOCKED(name.lock),      \
  49 }
  50 #define DEFINE_IDR(name)        struct idr name = IDR_INIT(name)
  51
  52 /**
  53  * DOC: idr sync
  54  * idr synchronization (stolen from radix-tree.h)
  55  *
  56  * idr_find() is able to be called locklessly, using RCU. The caller must
  57  * ensure calls to this function are made within rcu_read_lock() regions.
  58  * Other readers (lock-free or otherwise) and modifications may be running
  59  * concurrently.
  60  *
  61  * It is still required that the caller manage the synchronization and
  62  * lifetimes of the items. So if RCU lock-free lookups are used, typically
  63  * this would mean that the items have their own locks, or are amenable to
  64  * lock-free access; and that the items are freed by RCU (or only freed after
  65  * having been deleted from the idr tree *and* a synchronize_rcu() grace
  66  * period).
  67  */
  68
  69 /*
  70  * This is what we export.
  71  */
  72
  73 void *idr_find(struct idr *idp, int id);
  74 int idr_pre_get(struct idr *idp, gfp_t gfp_mask);
  75 int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id);
  76 void idr_preload(gfp_t gfp_mask);
  77 int idr_alloc(struct idr *idp, void *ptr, int start, int end, gfp_t gfp_mask);
  78 int idr_for_each(struct idr *idp,
  79                  int (*fn)(int id, void *p, void *data), void *data);
  80 void *idr_get_next(struct idr *idp, int *nextid);
  81 void *idr_replace(struct idr *idp, void *ptr, int id);
  82 void idr_remove(struct idr *idp, int id);
  83 void idr_free(struct idr *idp, int id);
  84 void idr_destroy(struct idr *idp);
  85 void idr_init(struct idr *idp);
  86
  87 /**
  88  * idr_preload_end - end preload section started with idr_preload()
  89  *
  90  * Each idr_preload() should be matched with an invocation of this
  91  * function.  See idr_preload() for details.
  92  */
  93 static inline void idr_preload_end(void)
  94 {
  95         preempt_enable();
  96 }
  97
  98 /**
  99  * idr_get_new - allocate new idr entry
 100  * @idp: idr handle
 101  * @ptr: pointer you want associated with the id
 102  * @id: pointer to the allocated handle
 103  *
 104  * Simple wrapper around idr_get_new_above() w/ @starting_id of zero.
 105  */
 106 static inline int idr_get_new(struct idr *idp, void *ptr, int *id)
 107 {
 108         return idr_get_new_above(idp, ptr, 0, id);
 109 }
 110
 111 /**
 112  * idr_for_each_entry - iterate over an idr's elements of a given type
 113  * @idp:     idr handle
 114  * @entry:   the type * to use as cursor
 115  * @id:      id entry's key
 116  */
 117 #define idr_for_each_entry(idp, entry, id)                              \
 118         for (id = 0, entry = (typeof(entry))idr_get_next((idp), &(id)); \
 119              entry != NULL;                                             \
 120              ++id, entry = (typeof(entry))idr_get_next((idp), &(id)))
 121
 122 void __idr_remove_all(struct idr *idp); /* don't use */
 123
 124 /**
 125  * idr_remove_all - remove all ids from the given idr tree
 126  * @idp: idr handle
 127  *
 128  * If you're trying to destroy @idp, calling idr_destroy() is enough.
 129  * This is going away.  Don't use.
 130  */
 131 static inline void __deprecated idr_remove_all(struct idr *idp)
 132 {
 133         __idr_remove_all(idp);
 134 }
 135
 136 /*
 137  * IDA - IDR based id allocator, use when translation from id to
 138  * pointer isn't necessary.
 139  *
 140  * IDA_BITMAP_LONGS is calculated to be one less to accommodate
 141  * ida_bitmap->nr_busy so that the whole struct fits in 128 bytes.
 142  */
 143 #define IDA_CHUNK_SIZE          128     /* 128 bytes per chunk */
 144 #define IDA_BITMAP_LONGS        (IDA_CHUNK_SIZE / sizeof(long) - 1)
 145 #define IDA_BITMAP_BITS         (IDA_BITMAP_LONGS * sizeof(long) * 8)
 146
 147 struct ida_bitmap {
 148         long                    nr_busy;
 149         unsigned long           bitmap[IDA_BITMAP_LONGS];
 150 };
 151
 152 struct ida {
 153         struct idr              idr;
 154         struct ida_bitmap       *free_bitmap;
 155 };
 156
 157 #define IDA_INIT(name)          { .idr = IDR_INIT((name).idr), .free_bitmap = NULL, }
 158 #define DEFINE_IDA(name)        struct ida name = IDA_INIT(name)
 159
 160 int ida_pre_get(struct ida *ida, gfp_t gfp_mask);
 161 int ida_get_new_above(struct ida *ida, int starting_id, int *p_id);
 162 void ida_remove(struct ida *ida, int id);
 163 void ida_destroy(struct ida *ida);
 164 void ida_init(struct ida *ida);
 165
 166 int ida_simple_get(struct ida *ida, unsigned int start, unsigned int end,
 167                    gfp_t gfp_mask);
 168 void ida_simple_remove(struct ida *ida, unsigned int id);
 169
 170 /**
 171  * ida_get_new - allocate new ID
 172  * @ida:        idr handle
 173  * @p_id:       pointer to the allocated handle
 174  *
 175  * Simple wrapper around ida_get_new_above() w/ @starting_id of zero.
 176  */
 177 static inline int ida_get_new(struct ida *ida, int *p_id)
 178 {
 179         return ida_get_new_above(ida, 0, p_id);
 180 }
 181
 182 void __init idr_init_cache(void);
 183
 184 #endif /* __IDR_H__ */