idr.h 6.0 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__

15 16 17 18 19 20 21
#include <linux/radix-tree.h>
#include <linux/gfp.h>

struct idr {
	struct radix_tree_root	idr_rt;
	unsigned int		idr_next;
};
L
Linus Torvalds 已提交
22

T
Tejun Heo 已提交
23
/*
24 25
 * The IDR API does not expose the tagging functionality of the radix tree
 * to users.  Use tag 0 to track whether a node has free space below it.
T
Tejun Heo 已提交
26
 */
27
#define IDR_FREE	0
L
Linus Torvalds 已提交
28

29 30
/* Set the IDR flag and the IDR_FREE tag */
#define IDR_RT_MARKER		((__force gfp_t)(3 << __GFP_BITS_SHIFT))
L
Linus Torvalds 已提交
31

32
#define IDR_INIT							\
33
{									\
34
	.idr_rt = RADIX_TREE_INIT(IDR_RT_MARKER)			\
L
Linus Torvalds 已提交
35
}
36
#define DEFINE_IDR(name)	struct idr name = IDR_INIT
L
Linus Torvalds 已提交
37

38 39 40 41 42 43 44 45
/**
 * idr_get_cursor - Return the current position of the cyclic allocator
 * @idr: idr handle
 *
 * The value returned is the value that will be next returned from
 * idr_alloc_cyclic() if it is free (otherwise the search will start from
 * this position).
 */
46
static inline unsigned int idr_get_cursor(const struct idr *idr)
47
{
48
	return READ_ONCE(idr->idr_next);
49 50 51 52 53 54 55 56 57 58 59 60
}

/**
 * idr_set_cursor - Set the current position of the cyclic allocator
 * @idr: idr handle
 * @val: new position
 *
 * The next call to idr_alloc_cyclic() will return @val if it is free
 * (otherwise the search will start from this position).
 */
static inline void idr_set_cursor(struct idr *idr, unsigned int val)
{
61
	WRITE_ONCE(idr->idr_next, val);
62 63
}

N
Nadia Derbey 已提交
64
/**
65
 * DOC: idr sync
N
Nadia Derbey 已提交
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
 * 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).
 */

81
void idr_preload(gfp_t gfp_mask);
82 83 84
int idr_alloc(struct idr *, void *entry, int start, int end, gfp_t);
int idr_alloc_cyclic(struct idr *, void *entry, int start, int end, gfp_t);
int idr_for_each(const struct idr *,
K
Kristian Hoegsberg 已提交
85
		 int (*fn)(int id, void *p, void *data), void *data);
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
void *idr_get_next(struct idr *, int *nextid);
void *idr_replace(struct idr *, void *, int id);
void idr_destroy(struct idr *);

static inline void idr_remove(struct idr *idr, int id)
{
	radix_tree_delete(&idr->idr_rt, id);
}

static inline void idr_init(struct idr *idr)
{
	INIT_RADIX_TREE(&idr->idr_rt, IDR_RT_MARKER);
	idr->idr_next = 0;
}

static inline bool idr_is_empty(const struct idr *idr)
{
	return radix_tree_empty(&idr->idr_rt) &&
		radix_tree_tagged(&idr->idr_rt, IDR_FREE);
}
106

107 108 109 110 111 112 113 114 115 116 117
/**
 * idr_preload_end - end preload section started with idr_preload()
 *
 * Each idr_preload() should be matched with an invocation of this
 * function.  See idr_preload() for details.
 */
static inline void idr_preload_end(void)
{
	preempt_enable();
}

T
Tejun Heo 已提交
118 119
/**
 * idr_find - return pointer for given id
R
Randy Dunlap 已提交
120
 * @idr: idr handle
T
Tejun Heo 已提交
121 122 123 124 125 126 127 128 129
 * @id: lookup key
 *
 * Return the pointer given the id it has been registered with.  A %NULL
 * return indicates that @id is not valid or you passed %NULL in
 * idr_get_new().
 *
 * This function can be called under rcu_read_lock(), given that the leaf
 * pointers lifetimes are correctly managed.
 */
130
static inline void *idr_find(const struct idr *idr, int id)
T
Tejun Heo 已提交
131
{
132
	return radix_tree_lookup(&idr->idr_rt, id);
T
Tejun Heo 已提交
133 134
}

135 136
/**
 * idr_for_each_entry - iterate over an idr's elements of a given type
137
 * @idr:     idr handle
138 139
 * @entry:   the type * to use as cursor
 * @id:      id entry's key
140 141 142 143
 *
 * @entry and @id do not need to be initialized before the loop, and
 * after normal terminatinon @entry is left with the value NULL.  This
 * is convenient for a "not found" value.
144
 */
145 146
#define idr_for_each_entry(idr, entry, id)			\
	for (id = 0; ((entry) = idr_get_next(idr, &(id))) != NULL; ++id)
147

148
/**
149 150
 * idr_for_each_entry_continue - continue iteration over an idr's elements of a given type
 * @idr:     idr handle
151 152 153 154 155 156
 * @entry:   the type * to use as cursor
 * @id:      id entry's key
 *
 * Continue to iterate over list of given type, continuing after
 * the current position.
 */
157 158
#define idr_for_each_entry_continue(idr, entry, id)			\
	for ((entry) = idr_get_next((idr), &(id));			\
159
	     entry;							\
160
	     ++id, (entry) = idr_get_next((idr), &(id)))
161

162 163 164 165 166
/*
 * IDA - IDR based id allocator, use when translation from id to
 * pointer isn't necessary.
 */
#define IDA_CHUNK_SIZE		128	/* 128 bytes per chunk */
167
#define IDA_BITMAP_LONGS	(IDA_CHUNK_SIZE / sizeof(long))
168
#define IDA_BITMAP_BITS 	(IDA_BITMAP_LONGS * sizeof(long) * 8)
169 170 171 172 173 174

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

struct ida {
175
	struct radix_tree_root	ida_rt;
176 177 178
	struct ida_bitmap	*free_bitmap;
};

179 180 181 182
#define IDA_INIT	{						\
	.ida_rt = RADIX_TREE_INIT(IDR_RT_MARKER | GFP_NOWAIT),		\
}
#define DEFINE_IDA(name)	struct ida name = IDA_INIT
183 184 185 186 187 188

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);

189 190 191 192
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);

193 194 195 196 197 198
static inline void ida_init(struct ida *ida)
{
	INIT_RADIX_TREE(&ida->ida_rt, IDR_RT_MARKER | GFP_NOWAIT);
	ida->free_bitmap = NULL;
}

199
/**
200 201 202 203 204
 * 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.
205
 */
206 207 208 209 210
static inline int ida_get_new(struct ida *ida, int *p_id)
{
	return ida_get_new_above(ida, 0, p_id);
}

211
static inline bool ida_is_empty(const struct ida *ida)
M
Matthew Wilcox 已提交
212
{
213
	return radix_tree_empty(&ida->ida_rt);
M
Matthew Wilcox 已提交
214
}
215
#endif /* __IDR_H__ */