blob: b7055b2a07d37ad577c2845cc2088108181764db [file] [log] [blame]
Michel Lespinasse910a7422012-10-08 16:30:39 -07001#include <linux/module.h>
Davidlohr Bueso223f8912017-09-08 16:14:46 -07002#include <linux/moduleparam.h>
Michel Lespinasse9c079ad2012-10-08 16:31:33 -07003#include <linux/rbtree_augmented.h>
Michel Lespinasse910a7422012-10-08 16:30:39 -07004#include <linux/random.h>
Davidlohr Bueso223f8912017-09-08 16:14:46 -07005#include <linux/slab.h>
Michel Lespinasse910a7422012-10-08 16:30:39 -07006#include <asm/timex.h>
7
Davidlohr Bueso223f8912017-09-08 16:14:46 -07008#define __param(type, name, init, msg) \
9 static type name = init; \
10 module_param(name, type, 0444); \
11 MODULE_PARM_DESC(name, msg);
12
13__param(int, nnodes, 100, "Number of nodes in the rb-tree");
Davidlohr Bueso0b548e32017-11-17 15:28:27 -080014__param(int, perf_loops, 1000, "Number of iterations modifying the rb-tree");
Davidlohr Bueso223f8912017-09-08 16:14:46 -070015__param(int, check_loops, 100, "Number of iterations modifying and verifying the rb-tree");
Michel Lespinasse910a7422012-10-08 16:30:39 -070016
17struct test_node {
Michel Lespinasse910a7422012-10-08 16:30:39 -070018 u32 key;
Cody P Schaferdbf128c2014-01-23 15:56:05 -080019 struct rb_node rb;
Michel Lespinassedadf9352012-10-08 16:31:15 -070020
21 /* following fields used for testing augmented rbtree functionality */
22 u32 val;
23 u32 augmented;
Michel Lespinasse910a7422012-10-08 16:30:39 -070024};
25
Davidlohr Buesob10d43f2017-09-08 16:14:52 -070026static struct rb_root_cached root = RB_ROOT_CACHED;
Davidlohr Bueso223f8912017-09-08 16:14:46 -070027static struct test_node *nodes = NULL;
Michel Lespinasse910a7422012-10-08 16:30:39 -070028
29static struct rnd_state rnd;
30
Davidlohr Buesob10d43f2017-09-08 16:14:52 -070031static void insert(struct test_node *node, struct rb_root_cached *root)
Michel Lespinasse910a7422012-10-08 16:30:39 -070032{
Davidlohr Buesob10d43f2017-09-08 16:14:52 -070033 struct rb_node **new = &root->rb_root.rb_node, *parent = NULL;
Michel Lespinassedadf9352012-10-08 16:31:15 -070034 u32 key = node->key;
Michel Lespinasse910a7422012-10-08 16:30:39 -070035
36 while (*new) {
37 parent = *new;
Michel Lespinassedadf9352012-10-08 16:31:15 -070038 if (key < rb_entry(parent, struct test_node, rb)->key)
Michel Lespinasse910a7422012-10-08 16:30:39 -070039 new = &parent->rb_left;
40 else
41 new = &parent->rb_right;
42 }
43
44 rb_link_node(&node->rb, parent, new);
Davidlohr Buesob10d43f2017-09-08 16:14:52 -070045 rb_insert_color(&node->rb, &root->rb_root);
Michel Lespinasse910a7422012-10-08 16:30:39 -070046}
47
Davidlohr Buesob10d43f2017-09-08 16:14:52 -070048static void insert_cached(struct test_node *node, struct rb_root_cached *root)
Michel Lespinasse910a7422012-10-08 16:30:39 -070049{
Davidlohr Buesob10d43f2017-09-08 16:14:52 -070050 struct rb_node **new = &root->rb_root.rb_node, *parent = NULL;
51 u32 key = node->key;
52 bool leftmost = true;
53
54 while (*new) {
55 parent = *new;
56 if (key < rb_entry(parent, struct test_node, rb)->key)
57 new = &parent->rb_left;
58 else {
59 new = &parent->rb_right;
60 leftmost = false;
61 }
62 }
63
64 rb_link_node(&node->rb, parent, new);
65 rb_insert_color_cached(&node->rb, root, leftmost);
Michel Lespinasse910a7422012-10-08 16:30:39 -070066}
67
Davidlohr Buesob10d43f2017-09-08 16:14:52 -070068static inline void erase(struct test_node *node, struct rb_root_cached *root)
69{
70 rb_erase(&node->rb, &root->rb_root);
71}
72
73static inline void erase_cached(struct test_node *node, struct rb_root_cached *root)
74{
75 rb_erase_cached(&node->rb, root);
76}
77
78
Michel Lespinassedadf9352012-10-08 16:31:15 -070079static inline u32 augment_recompute(struct test_node *node)
80{
81 u32 max = node->val, child_augmented;
82 if (node->rb.rb_left) {
83 child_augmented = rb_entry(node->rb.rb_left, struct test_node,
84 rb)->augmented;
85 if (max < child_augmented)
86 max = child_augmented;
87 }
88 if (node->rb.rb_right) {
89 child_augmented = rb_entry(node->rb.rb_right, struct test_node,
90 rb)->augmented;
91 if (max < child_augmented)
92 max = child_augmented;
93 }
94 return max;
95}
96
Michel Lespinasse39088362012-10-08 16:31:21 -070097RB_DECLARE_CALLBACKS(static, augment_callbacks, struct test_node, rb,
98 u32, augmented, augment_recompute)
Michel Lespinasse14b94af2012-10-08 16:31:17 -070099
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700100static void insert_augmented(struct test_node *node,
101 struct rb_root_cached *root)
Michel Lespinassedadf9352012-10-08 16:31:15 -0700102{
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700103 struct rb_node **new = &root->rb_root.rb_node, *rb_parent = NULL;
Michel Lespinassedadf9352012-10-08 16:31:15 -0700104 u32 key = node->key;
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700105 u32 val = node->val;
106 struct test_node *parent;
Michel Lespinassedadf9352012-10-08 16:31:15 -0700107
108 while (*new) {
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700109 rb_parent = *new;
110 parent = rb_entry(rb_parent, struct test_node, rb);
111 if (parent->augmented < val)
112 parent->augmented = val;
113 if (key < parent->key)
114 new = &parent->rb.rb_left;
Michel Lespinassedadf9352012-10-08 16:31:15 -0700115 else
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700116 new = &parent->rb.rb_right;
Michel Lespinassedadf9352012-10-08 16:31:15 -0700117 }
118
Michel Lespinasse14b94af2012-10-08 16:31:17 -0700119 node->augmented = val;
120 rb_link_node(&node->rb, rb_parent, new);
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700121 rb_insert_augmented(&node->rb, &root->rb_root, &augment_callbacks);
Michel Lespinassedadf9352012-10-08 16:31:15 -0700122}
123
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700124static void insert_augmented_cached(struct test_node *node,
125 struct rb_root_cached *root)
Michel Lespinassedadf9352012-10-08 16:31:15 -0700126{
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700127 struct rb_node **new = &root->rb_root.rb_node, *rb_parent = NULL;
128 u32 key = node->key;
129 u32 val = node->val;
130 struct test_node *parent;
131 bool leftmost = true;
132
133 while (*new) {
134 rb_parent = *new;
135 parent = rb_entry(rb_parent, struct test_node, rb);
136 if (parent->augmented < val)
137 parent->augmented = val;
138 if (key < parent->key)
139 new = &parent->rb.rb_left;
140 else {
141 new = &parent->rb.rb_right;
142 leftmost = false;
143 }
144 }
145
146 node->augmented = val;
147 rb_link_node(&node->rb, rb_parent, new);
148 rb_insert_augmented_cached(&node->rb, root,
149 leftmost, &augment_callbacks);
150}
151
152
153static void erase_augmented(struct test_node *node, struct rb_root_cached *root)
154{
155 rb_erase_augmented(&node->rb, &root->rb_root, &augment_callbacks);
156}
157
158static void erase_augmented_cached(struct test_node *node,
159 struct rb_root_cached *root)
160{
161 rb_erase_augmented_cached(&node->rb, root, &augment_callbacks);
Michel Lespinassedadf9352012-10-08 16:31:15 -0700162}
163
Michel Lespinasse910a7422012-10-08 16:30:39 -0700164static void init(void)
165{
166 int i;
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700167 for (i = 0; i < nnodes; i++) {
Akinobu Mita496f2f92012-12-17 16:04:23 -0800168 nodes[i].key = prandom_u32_state(&rnd);
169 nodes[i].val = prandom_u32_state(&rnd);
Michel Lespinassedadf9352012-10-08 16:31:15 -0700170 }
Michel Lespinasse910a7422012-10-08 16:30:39 -0700171}
172
173static bool is_red(struct rb_node *rb)
174{
175 return !(rb->__rb_parent_color & 1);
176}
177
178static int black_path_count(struct rb_node *rb)
179{
180 int count;
181 for (count = 0; rb; rb = rb_parent(rb))
182 count += !is_red(rb);
183 return count;
184}
185
Cody P Schafer964fe942014-01-23 15:56:06 -0800186static void check_postorder_foreach(int nr_nodes)
187{
188 struct test_node *cur, *n;
189 int count = 0;
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700190 rbtree_postorder_for_each_entry_safe(cur, n, &root.rb_root, rb)
Cody P Schafer964fe942014-01-23 15:56:06 -0800191 count++;
192
193 WARN_ON_ONCE(count != nr_nodes);
194}
195
Cody P Schafera791a622013-09-11 14:25:17 -0700196static void check_postorder(int nr_nodes)
197{
198 struct rb_node *rb;
199 int count = 0;
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700200 for (rb = rb_first_postorder(&root.rb_root); rb; rb = rb_next_postorder(rb))
Cody P Schafera791a622013-09-11 14:25:17 -0700201 count++;
202
203 WARN_ON_ONCE(count != nr_nodes);
204}
205
Michel Lespinasse910a7422012-10-08 16:30:39 -0700206static void check(int nr_nodes)
207{
208 struct rb_node *rb;
Davidlohr Bueso4130f0e2013-04-30 15:28:24 -0700209 int count = 0, blacks = 0;
Michel Lespinasse910a7422012-10-08 16:30:39 -0700210 u32 prev_key = 0;
211
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700212 for (rb = rb_first(&root.rb_root); rb; rb = rb_next(rb)) {
Michel Lespinasse910a7422012-10-08 16:30:39 -0700213 struct test_node *node = rb_entry(rb, struct test_node, rb);
214 WARN_ON_ONCE(node->key < prev_key);
215 WARN_ON_ONCE(is_red(rb) &&
216 (!rb_parent(rb) || is_red(rb_parent(rb))));
217 if (!count)
218 blacks = black_path_count(rb);
219 else
220 WARN_ON_ONCE((!rb->rb_left || !rb->rb_right) &&
221 blacks != black_path_count(rb));
222 prev_key = node->key;
223 count++;
224 }
Davidlohr Bueso4130f0e2013-04-30 15:28:24 -0700225
Michel Lespinasse910a7422012-10-08 16:30:39 -0700226 WARN_ON_ONCE(count != nr_nodes);
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700227 WARN_ON_ONCE(count < (1 << black_path_count(rb_last(&root.rb_root))) - 1);
Cody P Schafera791a622013-09-11 14:25:17 -0700228
229 check_postorder(nr_nodes);
Cody P Schafer964fe942014-01-23 15:56:06 -0800230 check_postorder_foreach(nr_nodes);
Michel Lespinasse910a7422012-10-08 16:30:39 -0700231}
232
Michel Lespinassedadf9352012-10-08 16:31:15 -0700233static void check_augmented(int nr_nodes)
234{
235 struct rb_node *rb;
236
237 check(nr_nodes);
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700238 for (rb = rb_first(&root.rb_root); rb; rb = rb_next(rb)) {
Michel Lespinassedadf9352012-10-08 16:31:15 -0700239 struct test_node *node = rb_entry(rb, struct test_node, rb);
240 WARN_ON_ONCE(node->augmented != augment_recompute(node));
241 }
242}
243
Davidlohr Buesoc75aaa82013-04-30 15:28:25 -0700244static int __init rbtree_test_init(void)
Michel Lespinasse910a7422012-10-08 16:30:39 -0700245{
246 int i, j;
247 cycles_t time1, time2, time;
Davidlohr Bueso977bd8d2017-09-08 16:14:49 -0700248 struct rb_node *node;
Michel Lespinasse910a7422012-10-08 16:30:39 -0700249
Kees Cook6da2ec52018-06-12 13:55:00 -0700250 nodes = kmalloc_array(nnodes, sizeof(*nodes), GFP_KERNEL);
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700251 if (!nodes)
252 return -ENOMEM;
253
Michel Lespinasse910a7422012-10-08 16:30:39 -0700254 printk(KERN_ALERT "rbtree testing");
255
Akinobu Mita496f2f92012-12-17 16:04:23 -0800256 prandom_seed_state(&rnd, 3141592653589793238ULL);
Michel Lespinasse910a7422012-10-08 16:30:39 -0700257 init();
258
259 time1 = get_cycles();
260
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700261 for (i = 0; i < perf_loops; i++) {
262 for (j = 0; j < nnodes; j++)
Michel Lespinasse910a7422012-10-08 16:30:39 -0700263 insert(nodes + j, &root);
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700264 for (j = 0; j < nnodes; j++)
Michel Lespinasse910a7422012-10-08 16:30:39 -0700265 erase(nodes + j, &root);
266 }
267
268 time2 = get_cycles();
269 time = time2 - time1;
270
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700271 time = div_u64(time, perf_loops);
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700272 printk(" -> test 1 (latency of nnodes insert+delete): %llu cycles\n",
273 (unsigned long long)time);
274
275 time1 = get_cycles();
276
277 for (i = 0; i < perf_loops; i++) {
278 for (j = 0; j < nnodes; j++)
279 insert_cached(nodes + j, &root);
280 for (j = 0; j < nnodes; j++)
281 erase_cached(nodes + j, &root);
282 }
283
284 time2 = get_cycles();
285 time = time2 - time1;
286
287 time = div_u64(time, perf_loops);
288 printk(" -> test 2 (latency of nnodes cached insert+delete): %llu cycles\n",
289 (unsigned long long)time);
Michel Lespinasse910a7422012-10-08 16:30:39 -0700290
Davidlohr Bueso977bd8d2017-09-08 16:14:49 -0700291 for (i = 0; i < nnodes; i++)
292 insert(nodes + i, &root);
293
294 time1 = get_cycles();
295
296 for (i = 0; i < perf_loops; i++) {
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700297 for (node = rb_first(&root.rb_root); node; node = rb_next(node))
Davidlohr Bueso977bd8d2017-09-08 16:14:49 -0700298 ;
299 }
300
301 time2 = get_cycles();
302 time = time2 - time1;
303
304 time = div_u64(time, perf_loops);
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700305 printk(" -> test 3 (latency of inorder traversal): %llu cycles\n",
306 (unsigned long long)time);
307
308 time1 = get_cycles();
309
310 for (i = 0; i < perf_loops; i++)
311 node = rb_first(&root.rb_root);
312
313 time2 = get_cycles();
314 time = time2 - time1;
315
316 time = div_u64(time, perf_loops);
317 printk(" -> test 4 (latency to fetch first node)\n");
318 printk(" non-cached: %llu cycles\n", (unsigned long long)time);
319
320 time1 = get_cycles();
321
322 for (i = 0; i < perf_loops; i++)
323 node = rb_first_cached(&root);
324
325 time2 = get_cycles();
326 time = time2 - time1;
327
328 time = div_u64(time, perf_loops);
329 printk(" cached: %llu cycles\n", (unsigned long long)time);
Davidlohr Bueso977bd8d2017-09-08 16:14:49 -0700330
331 for (i = 0; i < nnodes; i++)
332 erase(nodes + i, &root);
333
334 /* run checks */
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700335 for (i = 0; i < check_loops; i++) {
Michel Lespinasse910a7422012-10-08 16:30:39 -0700336 init();
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700337 for (j = 0; j < nnodes; j++) {
Michel Lespinasse910a7422012-10-08 16:30:39 -0700338 check(j);
339 insert(nodes + j, &root);
340 }
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700341 for (j = 0; j < nnodes; j++) {
342 check(nnodes - j);
Michel Lespinasse910a7422012-10-08 16:30:39 -0700343 erase(nodes + j, &root);
344 }
345 check(0);
346 }
347
Michel Lespinassedadf9352012-10-08 16:31:15 -0700348 printk(KERN_ALERT "augmented rbtree testing");
349
350 init();
351
352 time1 = get_cycles();
353
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700354 for (i = 0; i < perf_loops; i++) {
355 for (j = 0; j < nnodes; j++)
Michel Lespinassedadf9352012-10-08 16:31:15 -0700356 insert_augmented(nodes + j, &root);
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700357 for (j = 0; j < nnodes; j++)
Michel Lespinassedadf9352012-10-08 16:31:15 -0700358 erase_augmented(nodes + j, &root);
359 }
360
361 time2 = get_cycles();
362 time = time2 - time1;
363
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700364 time = div_u64(time, perf_loops);
Davidlohr Bueso977bd8d2017-09-08 16:14:49 -0700365 printk(" -> test 1 (latency of nnodes insert+delete): %llu cycles\n", (unsigned long long)time);
Michel Lespinassedadf9352012-10-08 16:31:15 -0700366
Davidlohr Buesob10d43f2017-09-08 16:14:52 -0700367 time1 = get_cycles();
368
369 for (i = 0; i < perf_loops; i++) {
370 for (j = 0; j < nnodes; j++)
371 insert_augmented_cached(nodes + j, &root);
372 for (j = 0; j < nnodes; j++)
373 erase_augmented_cached(nodes + j, &root);
374 }
375
376 time2 = get_cycles();
377 time = time2 - time1;
378
379 time = div_u64(time, perf_loops);
380 printk(" -> test 2 (latency of nnodes cached insert+delete): %llu cycles\n", (unsigned long long)time);
381
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700382 for (i = 0; i < check_loops; i++) {
Michel Lespinassedadf9352012-10-08 16:31:15 -0700383 init();
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700384 for (j = 0; j < nnodes; j++) {
Michel Lespinassedadf9352012-10-08 16:31:15 -0700385 check_augmented(j);
386 insert_augmented(nodes + j, &root);
387 }
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700388 for (j = 0; j < nnodes; j++) {
389 check_augmented(nnodes - j);
Michel Lespinassedadf9352012-10-08 16:31:15 -0700390 erase_augmented(nodes + j, &root);
391 }
392 check_augmented(0);
393 }
394
Davidlohr Bueso223f8912017-09-08 16:14:46 -0700395 kfree(nodes);
396
Michel Lespinasse910a7422012-10-08 16:30:39 -0700397 return -EAGAIN; /* Fail will directly unload the module */
398}
399
Davidlohr Buesoc75aaa82013-04-30 15:28:25 -0700400static void __exit rbtree_test_exit(void)
Michel Lespinasse910a7422012-10-08 16:30:39 -0700401{
402 printk(KERN_ALERT "test exit\n");
403}
404
405module_init(rbtree_test_init)
406module_exit(rbtree_test_exit)
407
408MODULE_LICENSE("GPL");
409MODULE_AUTHOR("Michel Lespinasse");
410MODULE_DESCRIPTION("Red Black Tree test");