idr.h 6.07 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
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
#include <linux/radix-tree.h>
#include <linux/gfp.h>
17
#include <linux/percpu.h>
18
19
20
21
22

struct idr {
	struct radix_tree_root	idr_rt;
	unsigned int		idr_next;
};
Linus Torvalds's avatar
Linus Torvalds committed
23

Tejun Heo's avatar
Tejun Heo committed
24
/*
25
26
 * 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.
Tejun Heo's avatar
Tejun Heo committed
27
 */
28
#define IDR_FREE	0
Linus Torvalds's avatar
Linus Torvalds committed
29

30
31
/* Set the IDR flag and the IDR_FREE tag */
#define IDR_RT_MARKER		((__force gfp_t)(3 << __GFP_BITS_SHIFT))
Linus Torvalds's avatar
Linus Torvalds committed
32

33
#define IDR_INIT							\
34
{									\
35
	.idr_rt = RADIX_TREE_INIT(IDR_RT_MARKER)			\
Linus Torvalds's avatar
Linus Torvalds committed
36
}
37
#define DEFINE_IDR(name)	struct idr name = IDR_INIT
Linus Torvalds's avatar
Linus Torvalds committed
38

39
40
41
42
43
44
45
46
/**
 * 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).
 */
47
static inline unsigned int idr_get_cursor(const struct idr *idr)
48
{
49
	return READ_ONCE(idr->idr_next);
50
51
52
53
54
55
56
57
58
59
60
61
}

/**
 * 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)
{
62
	WRITE_ONCE(idr->idr_next, val);
63
64
}

Nadia Derbey's avatar
Nadia Derbey committed
65
/**
66
 * DOC: idr sync
Nadia Derbey's avatar
Nadia Derbey committed
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 * 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).
 */

82
void idr_preload(gfp_t gfp_mask);
83
84
85
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 *,
Kristian Hoegsberg's avatar
Kristian Hoegsberg committed
86
		 int (*fn)(int id, void *p, void *data), void *data);
87
88
89
90
void *idr_get_next(struct idr *, int *nextid);
void *idr_replace(struct idr *, void *, int id);
void idr_destroy(struct idr *);

91
static inline void *idr_remove(struct idr *idr, int id)
92
{
93
	return radix_tree_delete_item(&idr->idr_rt, id, NULL);
94
95
96
97
98
99
100
101
102
103
104
105
106
}

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

108
109
110
111
112
113
114
115
116
117
118
/**
 * 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();
}

Tejun Heo's avatar
Tejun Heo committed
119
120
/**
 * idr_find - return pointer for given id
121
 * @idr: idr handle
Tejun Heo's avatar
Tejun Heo committed
122
123
124
125
126
127
128
129
130
 * @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.
 */
131
static inline void *idr_find(const struct idr *idr, int id)
Tejun Heo's avatar
Tejun Heo committed
132
{
133
	return radix_tree_lookup(&idr->idr_rt, id);
Tejun Heo's avatar
Tejun Heo committed
134
135
}

136
137
/**
 * idr_for_each_entry - iterate over an idr's elements of a given type
138
 * @idr:     idr handle
139
140
 * @entry:   the type * to use as cursor
 * @id:      id entry's key
141
142
143
144
 *
 * @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.
145
 */
146
147
#define idr_for_each_entry(idr, entry, id)			\
	for (id = 0; ((entry) = idr_get_next(idr, &(id))) != NULL; ++id)
148

149
/**
150
151
 * idr_for_each_entry_continue - continue iteration over an idr's elements of a given type
 * @idr:     idr handle
152
153
154
155
156
157
 * @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.
 */
158
159
#define idr_for_each_entry_continue(idr, entry, id)			\
	for ((entry) = idr_get_next((idr), &(id));			\
160
	     entry;							\
161
	     ++id, (entry) = idr_get_next((idr), &(id)))
162

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

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

175
176
DECLARE_PER_CPU(struct ida_bitmap *, ida_bitmap);

177
struct ida {
178
	struct radix_tree_root	ida_rt;
179
180
};

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

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

191
192
193
194
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);

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

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

212
static inline bool ida_is_empty(const struct ida *ida)
Matthew Wilcox's avatar
Matthew Wilcox committed
213
{
214
	return radix_tree_empty(&ida->ida_rt);
Matthew Wilcox's avatar
Matthew Wilcox committed
215
}
216
#endif /* __IDR_H__ */