idr.h revision 1.11 1 1.11 riastrad /* $NetBSD: idr.h,v 1.11 2023/07/11 10:42:36 riastradh Exp $ */
2 1.2 riastrad
3 1.2 riastrad /*-
4 1.2 riastrad * Copyright (c) 2013 The NetBSD Foundation, Inc.
5 1.2 riastrad * All rights reserved.
6 1.2 riastrad *
7 1.2 riastrad * This code is derived from software contributed to The NetBSD Foundation
8 1.2 riastrad * by Taylor R. Campbell.
9 1.2 riastrad *
10 1.2 riastrad * Redistribution and use in source and binary forms, with or without
11 1.2 riastrad * modification, are permitted provided that the following conditions
12 1.2 riastrad * are met:
13 1.2 riastrad * 1. Redistributions of source code must retain the above copyright
14 1.2 riastrad * notice, this list of conditions and the following disclaimer.
15 1.2 riastrad * 2. Redistributions in binary form must reproduce the above copyright
16 1.2 riastrad * notice, this list of conditions and the following disclaimer in the
17 1.2 riastrad * documentation and/or other materials provided with the distribution.
18 1.2 riastrad *
19 1.2 riastrad * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.2 riastrad * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.2 riastrad * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.2 riastrad * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.2 riastrad * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.2 riastrad * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.2 riastrad * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.2 riastrad * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.2 riastrad * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.2 riastrad * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.2 riastrad * POSSIBILITY OF SUCH DAMAGE.
30 1.2 riastrad */
31 1.2 riastrad
32 1.2 riastrad #ifndef _LINUX_IDR_H_
33 1.2 riastrad #define _LINUX_IDR_H_
34 1.2 riastrad
35 1.2 riastrad #include <sys/types.h>
36 1.11 riastrad #include <sys/mutex.h>
37 1.2 riastrad #include <sys/rbtree.h>
38 1.3 riastrad
39 1.3 riastrad #include <linux/gfp.h>
40 1.2 riastrad
41 1.2 riastrad /* XXX Stupid expedient algorithm should be replaced by something better. */
42 1.2 riastrad
43 1.2 riastrad struct idr {
44 1.3 riastrad kmutex_t idr_lock;
45 1.3 riastrad rb_tree_t idr_tree;
46 1.8 riastrad int idr_base;
47 1.2 riastrad };
48 1.2 riastrad
49 1.2 riastrad /* XXX Make the nm output a little more greppable... */
50 1.4 riastrad #define idr_alloc linux_idr_alloc
51 1.4 riastrad #define idr_destroy linux_idr_destroy
52 1.4 riastrad #define idr_find linux_idr_find
53 1.4 riastrad #define idr_for_each linux_idr_for_each
54 1.5 riastrad #define idr_get_next linux_idr_get_next
55 1.2 riastrad #define idr_init linux_idr_init
56 1.8 riastrad #define idr_init_base linux_idr_init_base
57 1.3 riastrad #define idr_is_empty linux_idr_is_empty
58 1.3 riastrad #define idr_preload linux_idr_preload
59 1.3 riastrad #define idr_preload_end linux_idr_preload_end
60 1.4 riastrad #define idr_remove linux_idr_remove
61 1.4 riastrad #define idr_replace linux_idr_replace
62 1.2 riastrad
63 1.3 riastrad int linux_idr_module_init(void);
64 1.3 riastrad void linux_idr_module_fini(void);
65 1.3 riastrad
66 1.2 riastrad void idr_init(struct idr *);
67 1.8 riastrad void idr_init_base(struct idr *, int);
68 1.2 riastrad void idr_destroy(struct idr *);
69 1.3 riastrad bool idr_is_empty(struct idr *);
70 1.2 riastrad void *idr_find(struct idr *, int);
71 1.5 riastrad void *idr_get_next(struct idr *, int *);
72 1.2 riastrad void *idr_replace(struct idr *, void *, int);
73 1.9 riastrad void *idr_remove(struct idr *, int);
74 1.3 riastrad void idr_preload(gfp_t);
75 1.3 riastrad int idr_alloc(struct idr *, void *, int, int, gfp_t);
76 1.3 riastrad void idr_preload_end(void);
77 1.2 riastrad int idr_for_each(struct idr *, int (*)(int, void *, void *), void *);
78 1.2 riastrad
79 1.5 riastrad #define idr_for_each_entry(IDR, ENTRY, ID) \
80 1.5 riastrad for ((ID) = 0; ((ENTRY) = idr_get_next((IDR), &(ID))) != NULL; (ID)++)
81 1.5 riastrad
82 1.3 riastrad struct ida {
83 1.3 riastrad struct idr ida_idr;
84 1.3 riastrad };
85 1.3 riastrad
86 1.3 riastrad static inline void
87 1.3 riastrad ida_init(struct ida *ida)
88 1.3 riastrad {
89 1.3 riastrad
90 1.3 riastrad idr_init(&ida->ida_idr);
91 1.3 riastrad }
92 1.3 riastrad
93 1.3 riastrad static inline void
94 1.3 riastrad ida_destroy(struct ida *ida)
95 1.3 riastrad {
96 1.3 riastrad
97 1.3 riastrad idr_destroy(&ida->ida_idr);
98 1.3 riastrad }
99 1.3 riastrad
100 1.3 riastrad static inline void
101 1.10 riastrad ida_free(struct ida *ida, int id)
102 1.3 riastrad {
103 1.3 riastrad
104 1.3 riastrad idr_remove(&ida->ida_idr, id);
105 1.3 riastrad }
106 1.3 riastrad
107 1.3 riastrad static inline int
108 1.3 riastrad ida_simple_get(struct ida *ida, unsigned start, unsigned end, gfp_t gfp)
109 1.3 riastrad {
110 1.3 riastrad int id;
111 1.3 riastrad
112 1.3 riastrad KASSERT(start <= INT_MAX);
113 1.3 riastrad KASSERT(end <= INT_MAX);
114 1.3 riastrad
115 1.3 riastrad idr_preload(gfp);
116 1.3 riastrad id = idr_alloc(&ida->ida_idr, NULL, start, end, gfp);
117 1.3 riastrad idr_preload_end();
118 1.3 riastrad
119 1.3 riastrad return id;
120 1.3 riastrad }
121 1.3 riastrad
122 1.10 riastrad static inline int
123 1.10 riastrad ida_alloc_max(struct ida *ida, unsigned max, gfp_t gfp)
124 1.10 riastrad {
125 1.10 riastrad
126 1.10 riastrad return ida_simple_get(ida, 0, max + 1, gfp);
127 1.10 riastrad }
128 1.10 riastrad
129 1.6 riastrad static inline void
130 1.6 riastrad ida_simple_remove(struct ida *ida, unsigned int id)
131 1.6 riastrad {
132 1.6 riastrad
133 1.6 riastrad KASSERT((int)id >= 0);
134 1.10 riastrad ida_free(ida, id);
135 1.6 riastrad }
136 1.6 riastrad
137 1.2 riastrad #endif /* _LINUX_IDR_H_ */
138