idr.h 5.7 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10
/*
 * include/linux/idr.h
 * 
 * 2002-10-18  written by Jim Houston jim.houston@ccur.com
 *	Copyright (C) 2002 by Concurrent Computer Corporation
 *	Distributed under the GNU GPL license version 2.
 *
 * Small id to pointer translation service avoiding fixed sized
 * tables.
 */
11 12 13 14

#ifndef __IDR_H__
#define __IDR_H__

L
Linus Torvalds 已提交
15 16
#include <linux/types.h>
#include <linux/bitops.h>
17
#include <linux/init.h>
N
Nadia Derbey 已提交
18
#include <linux/rcupdate.h>
L
Linus Torvalds 已提交
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

#if BITS_PER_LONG == 32
# define IDR_BITS 5
# define IDR_FULL 0xfffffffful
/* We can only use two of the bits in the top level because there is
   only one possible bit in the top level (5 bits * 7 levels = 35
   bits, but you only use 31 bits in the id). */
# define TOP_LEVEL_FULL (IDR_FULL >> 30)
#elif BITS_PER_LONG == 64
# define IDR_BITS 6
# define IDR_FULL 0xfffffffffffffffful
/* We can only use two of the bits in the top level because there is
   only one possible bit in the top level (6 bits * 6 levels = 36
   bits, but you only use 31 bits in the id). */
# define TOP_LEVEL_FULL (IDR_FULL >> 62)
#else
# error "BITS_PER_LONG is not 32 or 64"
#endif

#define IDR_SIZE (1 << IDR_BITS)
#define IDR_MASK ((1 << IDR_BITS)-1)

41 42 43
#define MAX_IDR_SHIFT (sizeof(int)*8 - 1)
#define MAX_IDR_BIT (1U << MAX_IDR_SHIFT)
#define MAX_IDR_MASK (MAX_IDR_BIT - 1)
L
Linus Torvalds 已提交
44 45

/* Leave the possibility of an incomplete final layer */
46
#define MAX_IDR_LEVEL ((MAX_IDR_SHIFT + IDR_BITS - 1) / IDR_BITS)
L
Linus Torvalds 已提交
47 48

/* Number of id_layer structs to leave in free list */
49
#define MAX_IDR_FREE (MAX_IDR_LEVEL * 2)
L
Linus Torvalds 已提交
50 51

struct idr_layer {
52
	unsigned long		bitmap;	/* A zero bit means "space here" */
A
Arnd Bergmann 已提交
53
	struct idr_layer __rcu	*ary[1<<IDR_BITS];
54 55 56
	int			count;	/* When zero, we can release it */
	int			layer;	/* distance from leaf */
	struct rcu_head		rcu_head;
L
Linus Torvalds 已提交
57 58 59
};

struct idr {
60 61 62 63 64
	struct idr_layer __rcu	*top;
	struct idr_layer	*id_free;
	int			layers;	/* only valid w/o concurrent changes */
	int			id_free_cnt;
	spinlock_t		lock;
L
Linus Torvalds 已提交
65 66
};

67 68 69
#define IDR_INIT(name)							\
{									\
	.lock			= __SPIN_LOCK_UNLOCKED(name.lock),	\
L
Linus Torvalds 已提交
70 71 72
}
#define DEFINE_IDR(name)	struct idr name = IDR_INIT(name)

N
Nadia Derbey 已提交
73
/**
74
 * DOC: idr sync
N
Nadia Derbey 已提交
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
 * idr synchronization (stolen from radix-tree.h)
 *
 * idr_find() is able to be called locklessly, using RCU. The caller must
 * ensure calls to this function are made within rcu_read_lock() regions.
 * Other readers (lock-free or otherwise) and modifications may be running
 * concurrently.
 *
 * It is still required that the caller manage the synchronization and
 * lifetimes of the items. So if RCU lock-free lookups are used, typically
 * this would mean that the items have their own locks, or are amenable to
 * lock-free access; and that the items are freed by RCU (or only freed after
 * having been deleted from the idr tree *and* a synchronize_rcu() grace
 * period).
 */

L
Linus Torvalds 已提交
90 91 92 93 94
/*
 * This is what we export.
 */

void *idr_find(struct idr *idp, int id);
A
Al Viro 已提交
95
int idr_pre_get(struct idr *idp, gfp_t gfp_mask);
L
Linus Torvalds 已提交
96
int idr_get_new_above(struct idr *idp, void *ptr, int starting_id, int *id);
K
Kristian Hoegsberg 已提交
97 98
int idr_for_each(struct idr *idp,
		 int (*fn)(int id, void *p, void *data), void *data);
K
KAMEZAWA Hiroyuki 已提交
99
void *idr_get_next(struct idr *idp, int *nextid);
J
Jeff Mahoney 已提交
100
void *idr_replace(struct idr *idp, void *ptr, int id);
L
Linus Torvalds 已提交
101
void idr_remove(struct idr *idp, int id);
A
Andrew Morton 已提交
102
void idr_destroy(struct idr *idp);
L
Linus Torvalds 已提交
103
void idr_init(struct idr *idp);
104

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
/**
 * idr_get_new - allocate new idr entry
 * @idp: idr handle
 * @ptr: pointer you want associated with the id
 * @id: pointer to the allocated handle
 *
 * Simple wrapper around idr_get_new_above() w/ @starting_id of zero.
 */
static inline int idr_get_new(struct idr *idp, void *ptr, int *id)
{
	return idr_get_new_above(idp, ptr, 0, id);
}

/**
 * idr_for_each_entry - iterate over an idr's elements of a given type
 * @idp:     idr handle
 * @entry:   the type * to use as cursor
 * @id:      id entry's key
 */
#define idr_for_each_entry(idp, entry, id)				\
	for (id = 0, entry = (typeof(entry))idr_get_next((idp), &(id)); \
	     entry != NULL;                                             \
	     ++id, entry = (typeof(entry))idr_get_next((idp), &(id)))

T
Tejun Heo 已提交
129 130 131 132 133 134 135 136 137 138 139 140 141
void __idr_remove_all(struct idr *idp);	/* don't use */

/**
 * idr_remove_all - remove all ids from the given idr tree
 * @idp: idr handle
 *
 * If you're trying to destroy @idp, calling idr_destroy() is enough.
 * This is going away.  Don't use.
 */
static inline void __deprecated idr_remove_all(struct idr *idp)
{
	__idr_remove_all(idp);
}
142 143 144 145

/*
 * IDA - IDR based id allocator, use when translation from id to
 * pointer isn't necessary.
146 147 148
 *
 * IDA_BITMAP_LONGS is calculated to be one less to accommodate
 * ida_bitmap->nr_busy so that the whole struct fits in 128 bytes.
149 150
 */
#define IDA_CHUNK_SIZE		128	/* 128 bytes per chunk */
151 152
#define IDA_BITMAP_LONGS	(IDA_CHUNK_SIZE / sizeof(long) - 1)
#define IDA_BITMAP_BITS 	(IDA_BITMAP_LONGS * sizeof(long) * 8)
153 154 155 156 157 158 159 160 161 162 163

struct ida_bitmap {
	long			nr_busy;
	unsigned long		bitmap[IDA_BITMAP_LONGS];
};

struct ida {
	struct idr		idr;
	struct ida_bitmap	*free_bitmap;
};

164
#define IDA_INIT(name)		{ .idr = IDR_INIT((name).idr), .free_bitmap = NULL, }
165 166 167 168 169 170 171 172
#define DEFINE_IDA(name)	struct ida name = IDA_INIT(name)

int ida_pre_get(struct ida *ida, gfp_t gfp_mask);
int ida_get_new_above(struct ida *ida, int starting_id, int *p_id);
void ida_remove(struct ida *ida, int id);
void ida_destroy(struct ida *ida);
void ida_init(struct ida *ida);

173 174 175 176
int ida_simple_get(struct ida *ida, unsigned int start, unsigned int end,
		   gfp_t gfp_mask);
void ida_simple_remove(struct ida *ida, unsigned int id);

177
/**
178 179 180 181 182
 * ida_get_new - allocate new ID
 * @ida:	idr handle
 * @p_id:	pointer to the allocated handle
 *
 * Simple wrapper around ida_get_new_above() w/ @starting_id of zero.
183
 */
184 185 186 187 188 189
static inline int ida_get_new(struct ida *ida, int *p_id)
{
	return ida_get_new_above(ida, 0, p_id);
}

void __init idr_init_cache(void);
190

191
#endif /* __IDR_H__ */