1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2013 EMC Corp.
5 * Copyright (c) 2011 Jeffrey Roberson <jeff@freebsd.org>
6 * Copyright (c) 2008 Mayur Shardul <mayur.shardul@gmail.com>
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 */
30
31 #ifndef _SYS_PCTRIE_H_
32 #define _SYS_PCTRIE_H_
33
34 #include <sys/_pctrie.h>
35 #include <sys/_smr.h>
36
37 struct pctrie_iter {
38 struct pctrie *ptree;
39 struct pctrie_node *node;
40 uint64_t index;
41 uint64_t limit;
42 };
43
44 static __inline void
pctrie_iter_reset(struct pctrie_iter * it)45 pctrie_iter_reset(struct pctrie_iter *it)
46 {
47 it->node = NULL;
48 }
49
50 static __inline bool
pctrie_iter_is_reset(struct pctrie_iter * it)51 pctrie_iter_is_reset(struct pctrie_iter *it)
52 {
53 return (it->node == NULL);
54 }
55
56 static __inline void
pctrie_iter_init(struct pctrie_iter * it,struct pctrie * ptree)57 pctrie_iter_init(struct pctrie_iter *it, struct pctrie *ptree)
58 {
59 it->ptree = ptree;
60 it->node = NULL;
61 it->limit = 0;
62 }
63
64 static __inline void
pctrie_iter_limit_init(struct pctrie_iter * it,struct pctrie * ptree,uint64_t limit)65 pctrie_iter_limit_init(struct pctrie_iter *it, struct pctrie *ptree,
66 uint64_t limit)
67 {
68 pctrie_iter_init(it, ptree);
69 it->limit = limit;
70 }
71
72 #ifdef _KERNEL
73
74 typedef void (*pctrie_cb_t)(void *ptr, void *arg);
75
76 #define PCTRIE_DEFINE_SMR(name, type, field, allocfn, freefn, smr) \
77 PCTRIE_DEFINE(name, type, field, allocfn, freefn) \
78 \
79 static __inline struct type * \
80 name##_PCTRIE_LOOKUP_UNLOCKED(struct pctrie *ptree, uint64_t key) \
81 { \
82 \
83 return name##_PCTRIE_VAL2PTR(pctrie_lookup_unlocked(ptree, \
84 key, (smr))); \
85 } \
86 \
87 static __inline __unused int \
88 name##_PCTRIE_LOOKUP_RANGE_UNLOCKED(struct pctrie *ptree, uint64_t key, \
89 struct type *value[], int count) \
90 { \
91 uint64_t **data = (uint64_t **)value; \
92 \
93 count = pctrie_lookup_range_unlocked(ptree, key, data, count, \
94 (smr)); \
95 for (int i = 0; i < count; i++) \
96 value[i] = name##_PCTRIE_NZVAL2PTR(data[i]); \
97 return (count); \
98 } \
99
100 #define PCTRIE_DEFINE(name, type, field, allocfn, freefn) \
101 \
102 CTASSERT(sizeof(((struct type *)0)->field) == sizeof(uint64_t)); \
103 /* \
104 * XXX This assert protects flag bits, it does not enforce natural \
105 * alignment. 32bit architectures do not naturally align 64bit fields. \
106 */ \
107 CTASSERT((__offsetof(struct type, field) & (sizeof(uint32_t) - 1)) == 0); \
108 \
109 static __inline struct type * \
110 name##_PCTRIE_NZVAL2PTR(uint64_t *val) \
111 { \
112 return (struct type *) \
113 ((uintptr_t)val - __offsetof(struct type, field)); \
114 } \
115 \
116 static __inline struct type * \
117 name##_PCTRIE_VAL2PTR(uint64_t *val) \
118 { \
119 if (val == NULL) \
120 return (NULL); \
121 return (name##_PCTRIE_NZVAL2PTR(val)); \
122 } \
123 \
124 static __inline uint64_t * \
125 name##_PCTRIE_PTR2VAL(struct type *ptr) \
126 { \
127 \
128 return &ptr->field; \
129 } \
130 \
131 static __inline __unused int \
132 name##_PCTRIE_INSERT_BASE(struct pctrie *ptree, uint64_t *val, \
133 struct pctrie_node *parent, void *parentp, \
134 uint64_t *found, struct type **found_out) \
135 { \
136 struct pctrie_node *child; \
137 \
138 if (__predict_false(found != NULL)) { \
139 *found_out = name##_PCTRIE_VAL2PTR(found); \
140 return (EEXIST); \
141 } \
142 if (parentp != NULL) { \
143 child = allocfn(ptree); \
144 if (__predict_false(child == NULL)) { \
145 if (found_out != NULL) \
146 *found_out = NULL; \
147 return (ENOMEM); \
148 } \
149 pctrie_insert_node(val, parent, parentp, child); \
150 } \
151 return (0); \
152 } \
153 \
154 static __inline __unused int \
155 name##_PCTRIE_INSERT(struct pctrie *ptree, struct type *ptr) \
156 { \
157 void *parentp; \
158 struct pctrie_node *parent; \
159 uint64_t *val = name##_PCTRIE_PTR2VAL(ptr); \
160 \
161 parentp = pctrie_insert_lookup_strict(ptree, val, &parent); \
162 return (name##_PCTRIE_INSERT_BASE(ptree, val, parent, parentp, \
163 NULL, NULL)); \
164 } \
165 \
166 static __inline __unused int \
167 name##_PCTRIE_FIND_OR_INSERT(struct pctrie *ptree, struct type *ptr, \
168 struct type **found_out_opt) \
169 { \
170 void *parentp; \
171 struct pctrie_node *parent; \
172 uint64_t *val = name##_PCTRIE_PTR2VAL(ptr); \
173 uint64_t *found; \
174 \
175 parentp = pctrie_insert_lookup(ptree, val, &parent, &found); \
176 return (name##_PCTRIE_INSERT_BASE(ptree, val, parent, parentp, \
177 found, found_out_opt)); \
178 } \
179 \
180 static __inline __unused int \
181 name##_PCTRIE_INSERT_LOOKUP_LE(struct pctrie *ptree, struct type *ptr, \
182 struct type **found_out) \
183 { \
184 struct pctrie_node *parent; \
185 void *parentp; \
186 uint64_t *val = name##_PCTRIE_PTR2VAL(ptr); \
187 uint64_t *found; \
188 int retval; \
189 \
190 parentp = pctrie_insert_lookup(ptree, val, &parent, &found); \
191 retval = name##_PCTRIE_INSERT_BASE(ptree, val, parent, parentp, \
192 found, found_out); \
193 if (retval != 0) \
194 return (retval); \
195 found = pctrie_subtree_lookup_lt(ptree, parent, *val); \
196 *found_out = name##_PCTRIE_VAL2PTR(found); \
197 return (0); \
198 } \
199 \
200 static __inline __unused int \
201 name##_PCTRIE_ITER_INSERT(struct pctrie_iter *it, struct type *ptr) \
202 { \
203 void *parentp; \
204 uint64_t *val = name##_PCTRIE_PTR2VAL(ptr); \
205 \
206 parentp = pctrie_iter_insert_lookup(it, val); \
207 return (name##_PCTRIE_INSERT_BASE(it->ptree, val, it->node, \
208 parentp, NULL, NULL)); \
209 } \
210 \
211 static __inline __unused struct type * \
212 name##_PCTRIE_LOOKUP(struct pctrie *ptree, uint64_t key) \
213 { \
214 \
215 return name##_PCTRIE_VAL2PTR(pctrie_lookup(ptree, key)); \
216 } \
217 \
218 static __inline __unused int \
219 name##_PCTRIE_LOOKUP_RANGE(struct pctrie *ptree, uint64_t key, \
220 struct type *value[], int count) \
221 { \
222 uint64_t **data = (uint64_t **)value; \
223 \
224 count = pctrie_lookup_range(ptree, key, data, count); \
225 for (int i = 0; i < count; i++) \
226 value[i] = name##_PCTRIE_NZVAL2PTR(data[i]); \
227 return (count); \
228 } \
229 \
230 static __inline __unused struct type * \
231 name##_PCTRIE_LOOKUP_LE(struct pctrie *ptree, uint64_t key) \
232 { \
233 \
234 return name##_PCTRIE_VAL2PTR(pctrie_lookup_le(ptree, key)); \
235 } \
236 \
237 static __inline __unused struct type * \
238 name##_PCTRIE_LOOKUP_GE(struct pctrie *ptree, uint64_t key) \
239 { \
240 \
241 return name##_PCTRIE_VAL2PTR(pctrie_lookup_ge(ptree, key)); \
242 } \
243 \
244 static __inline __unused void \
245 name##_PCTRIE_RECLAIM(struct pctrie *ptree) \
246 { \
247 struct pctrie_node *freenode, *node; \
248 \
249 for (freenode = pctrie_reclaim_begin(&node, ptree); \
250 freenode != NULL; \
251 freenode = pctrie_reclaim_resume(&node)) \
252 freefn(ptree, freenode); \
253 } \
254 \
255 /* \
256 * While reclaiming all internal trie nodes, invoke callback(leaf, arg) \
257 * on every leaf in the trie, in order. \
258 */ \
259 static __inline __unused void \
260 name##_PCTRIE_RECLAIM_CALLBACK(struct pctrie *ptree, \
261 void (*typed_cb)(struct type *, void *), void *arg) \
262 { \
263 struct pctrie_node *freenode, *node; \
264 pctrie_cb_t callback = (pctrie_cb_t)typed_cb; \
265 \
266 for (freenode = pctrie_reclaim_begin_cb(&node, ptree, \
267 callback, __offsetof(struct type, field), arg); \
268 freenode != NULL; \
269 freenode = pctrie_reclaim_resume_cb(&node, \
270 callback, __offsetof(struct type, field), arg)) \
271 freefn(ptree, freenode); \
272 } \
273 \
274 static __inline __unused struct type * \
275 name##_PCTRIE_ITER_LOOKUP(struct pctrie_iter *it, uint64_t index) \
276 { \
277 return name##_PCTRIE_VAL2PTR(pctrie_iter_lookup(it, index)); \
278 } \
279 \
280 static __inline __unused struct type * \
281 name##_PCTRIE_ITER_STRIDE(struct pctrie_iter *it, int stride) \
282 { \
283 return name##_PCTRIE_VAL2PTR(pctrie_iter_stride(it, stride)); \
284 } \
285 \
286 static __inline __unused struct type * \
287 name##_PCTRIE_ITER_NEXT(struct pctrie_iter *it) \
288 { \
289 return name##_PCTRIE_VAL2PTR(pctrie_iter_next(it)); \
290 } \
291 \
292 static __inline __unused struct type * \
293 name##_PCTRIE_ITER_PREV(struct pctrie_iter *it) \
294 { \
295 return name##_PCTRIE_VAL2PTR(pctrie_iter_prev(it)); \
296 } \
297 \
298 static __inline __unused struct type * \
299 name##_PCTRIE_ITER_VALUE(struct pctrie_iter *it) \
300 { \
301 return name##_PCTRIE_VAL2PTR(pctrie_iter_value(it)); \
302 } \
303 \
304 static __inline __unused struct type * \
305 name##_PCTRIE_ITER_LOOKUP_GE(struct pctrie_iter *it, uint64_t index) \
306 { \
307 return name##_PCTRIE_VAL2PTR(pctrie_iter_lookup_ge(it, index)); \
308 } \
309 \
310 static __inline __unused struct type * \
311 name##_PCTRIE_ITER_JUMP_GE(struct pctrie_iter *it, int64_t jump) \
312 { \
313 return name##_PCTRIE_VAL2PTR(pctrie_iter_jump_ge(it, jump)); \
314 } \
315 \
316 static __inline __unused struct type * \
317 name##_PCTRIE_ITER_STEP_GE(struct pctrie_iter *it) \
318 { \
319 return name##_PCTRIE_VAL2PTR(pctrie_iter_jump_ge(it, 1)); \
320 } \
321 \
322 static __inline __unused struct type * \
323 name##_PCTRIE_ITER_LOOKUP_LE(struct pctrie_iter *it, uint64_t index) \
324 { \
325 return name##_PCTRIE_VAL2PTR(pctrie_iter_lookup_le(it, index)); \
326 } \
327 \
328 static __inline __unused struct type * \
329 name##_PCTRIE_ITER_JUMP_LE(struct pctrie_iter *it, int64_t jump) \
330 { \
331 return name##_PCTRIE_VAL2PTR(pctrie_iter_jump_le(it, jump)); \
332 } \
333 \
334 static __inline __unused struct type * \
335 name##_PCTRIE_ITER_STEP_LE(struct pctrie_iter *it) \
336 { \
337 return name##_PCTRIE_VAL2PTR(pctrie_iter_jump_le(it, 1)); \
338 } \
339 \
340 static __inline __unused void \
341 name##_PCTRIE_REMOVE_BASE(struct pctrie *ptree, \
342 struct pctrie_node *freenode) \
343 { \
344 if (freenode != NULL) \
345 freefn(ptree, freenode); \
346 } \
347 \
348 static __inline __unused void \
349 name##_PCTRIE_ITER_REMOVE(struct pctrie_iter *it) \
350 { \
351 struct pctrie_node *freenode; \
352 \
353 pctrie_iter_remove(it, &freenode); \
354 name##_PCTRIE_REMOVE_BASE(it->ptree, freenode); \
355 } \
356 \
357 static __inline __unused struct type * \
358 name##_PCTRIE_REPLACE(struct pctrie *ptree, struct type *ptr) \
359 { \
360 \
361 return name##_PCTRIE_VAL2PTR( \
362 pctrie_replace(ptree, name##_PCTRIE_PTR2VAL(ptr))); \
363 } \
364 \
365 static __inline __unused void \
366 name##_PCTRIE_REMOVE(struct pctrie *ptree, uint64_t key) \
367 { \
368 uint64_t *val; \
369 struct pctrie_node *freenode; \
370 \
371 val = pctrie_remove_lookup(ptree, key, &freenode); \
372 if (val == NULL) \
373 panic("%s: key not found", __func__); \
374 name##_PCTRIE_REMOVE_BASE(ptree, freenode); \
375 } \
376 \
377 static __inline __unused struct type * \
378 name##_PCTRIE_REMOVE_LOOKUP(struct pctrie *ptree, uint64_t key) \
379 { \
380 uint64_t *val; \
381 struct pctrie_node *freenode; \
382 \
383 val = pctrie_remove_lookup(ptree, key, &freenode); \
384 name##_PCTRIE_REMOVE_BASE(ptree, freenode); \
385 return name##_PCTRIE_VAL2PTR(val); \
386 }
387
388 struct pctrie_iter;
389 void *pctrie_insert_lookup(struct pctrie *ptree, uint64_t *val,
390 struct pctrie_node **parent_out, uint64_t **found_out);
391 void *pctrie_insert_lookup_strict(struct pctrie *ptree, uint64_t *val,
392 struct pctrie_node **parent_out);
393 void pctrie_insert_node(uint64_t *val, struct pctrie_node *parent,
394 void *parentp, struct pctrie_node *child);
395 uint64_t *pctrie_lookup(struct pctrie *ptree, uint64_t key);
396 uint64_t *pctrie_lookup_unlocked(struct pctrie *ptree, uint64_t key,
397 smr_t smr);
398 int pctrie_lookup_range(struct pctrie *ptree,
399 uint64_t index, uint64_t *value[], int count);
400 int pctrie_lookup_range_unlocked(struct pctrie *ptree,
401 uint64_t index, uint64_t *value[], int count, smr_t smr);
402 uint64_t *pctrie_iter_lookup(struct pctrie_iter *it, uint64_t index);
403 uint64_t *pctrie_iter_stride(struct pctrie_iter *it, int stride);
404 uint64_t *pctrie_iter_next(struct pctrie_iter *it);
405 uint64_t *pctrie_iter_prev(struct pctrie_iter *it);
406 void *pctrie_iter_insert_lookup(struct pctrie_iter *it,
407 uint64_t *val);
408 uint64_t *pctrie_lookup_ge(struct pctrie *ptree, uint64_t key);
409 uint64_t *pctrie_iter_lookup_ge(struct pctrie_iter *it, uint64_t index);
410 uint64_t *pctrie_iter_jump_ge(struct pctrie_iter *it, int64_t jump);
411 uint64_t *pctrie_lookup_le(struct pctrie *ptree, uint64_t key);
412 uint64_t *pctrie_subtree_lookup_lt(struct pctrie *ptree,
413 struct pctrie_node *node, uint64_t key);
414 uint64_t *pctrie_iter_lookup_le(struct pctrie_iter *it, uint64_t index);
415 uint64_t *pctrie_iter_jump_le(struct pctrie_iter *it, int64_t jump);
416 struct pctrie_node *pctrie_reclaim_begin(struct pctrie_node **pnode,
417 struct pctrie *ptree);
418 struct pctrie_node *pctrie_reclaim_resume(struct pctrie_node **pnode);
419 struct pctrie_node *pctrie_reclaim_begin_cb(struct pctrie_node **pnode,
420 struct pctrie *ptree,
421 pctrie_cb_t callback, int keyoff, void *arg);
422 struct pctrie_node *pctrie_reclaim_resume_cb(struct pctrie_node **pnode,
423 pctrie_cb_t callback, int keyoff, void *arg);
424 uint64_t *pctrie_remove_lookup(struct pctrie *ptree, uint64_t index,
425 struct pctrie_node **killnode);
426 void pctrie_iter_remove(struct pctrie_iter *it,
427 struct pctrie_node **freenode);
428 uint64_t *pctrie_iter_value(struct pctrie_iter *it);
429 uint64_t *pctrie_replace(struct pctrie *ptree, uint64_t *newval);
430 size_t pctrie_node_size(void);
431 int pctrie_zone_init(void *mem, int size, int flags);
432
433 /*
434 * Each search path in the trie terminates at a leaf, which is a pointer to a
435 * value marked with a set 1-bit. A leaf may be associated with a null pointer
436 * to indicate no value there.
437 */
438 #define PCTRIE_ISLEAF 0x1
439 #define PCTRIE_NULL (struct pctrie_node *)PCTRIE_ISLEAF
440
441 static __inline void
pctrie_init(struct pctrie * ptree)442 pctrie_init(struct pctrie *ptree)
443 {
444 ptree->pt_root = PCTRIE_NULL;
445 }
446
447 static __inline bool
pctrie_is_empty(struct pctrie * ptree)448 pctrie_is_empty(struct pctrie *ptree)
449 {
450 return (ptree->pt_root == PCTRIE_NULL);
451 }
452
453 /* Set of all flag bits stored in node pointers. */
454 #define PCTRIE_FLAGS (PCTRIE_ISLEAF)
455 /* Minimum align parameter for uma_zcreate. */
456 #define PCTRIE_PAD PCTRIE_FLAGS
457
458 /*
459 * These widths should allow the pointers to a node's children to fit within
460 * a single cache line. The extra levels from a narrow width should not be
461 * a problem thanks to path compression.
462 */
463 #ifdef __LP64__
464 #define PCTRIE_WIDTH 4
465 #else
466 #define PCTRIE_WIDTH 3
467 #endif
468
469 #define PCTRIE_COUNT (1 << PCTRIE_WIDTH)
470
471 #endif /* _KERNEL */
472 #endif /* !_SYS_PCTRIE_H_ */
473