rculfhash test: Check random pool size
[urcu.git] / tests / test_urcu_hash.c
1 /*
2 * test_urcu_hash.c
3 *
4 * Userspace RCU library - test program
5 *
6 * Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 */
22
23 #define _GNU_SOURCE
24 #include <stdio.h>
25 #include <pthread.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <sys/types.h>
29 #include <sys/wait.h>
30 #include <unistd.h>
31 #include <stdio.h>
32 #include <assert.h>
33 #include <sched.h>
34 #include <errno.h>
35
36 #ifdef __linux__
37 #include <syscall.h>
38 #endif
39
40 #define DEFAULT_HASH_SIZE 32
41 #define DEFAULT_RAND_POOL 1000000
42
43 /* Make this big enough to include the POWER5+ L3 cacheline size of 256B */
44 #define CACHE_LINE_SIZE 4096
45
46 /* hardcoded number of CPUs */
47 #define NR_CPUS 16384
48
49 #if defined(_syscall0)
50 _syscall0(pid_t, gettid)
51 #elif defined(__NR_gettid)
52 static inline pid_t gettid(void)
53 {
54 return syscall(__NR_gettid);
55 }
56 #else
57 #warning "use pid as tid"
58 static inline pid_t gettid(void)
59 {
60 return getpid();
61 }
62 #endif
63
64 #ifndef DYNAMIC_LINK_TEST
65 #define _LGPL_SOURCE
66 #else
67 #define debug_yield_read()
68 #endif
69 #include <urcu-qsbr.h>
70 #include <urcu/rculfhash.h>
71 #include <urcu-call-rcu.h>
72
73 struct wr_count {
74 unsigned long update_ops;
75 unsigned long add;
76 unsigned long add_exist;
77 unsigned long remove;
78 };
79
80 static unsigned int __thread rand_lookup;
81 static unsigned long __thread nr_add;
82 static unsigned long __thread nr_addexist;
83 static unsigned long __thread nr_del;
84 static unsigned long __thread nr_delnoent;
85 static unsigned long __thread lookup_fail;
86 static unsigned long __thread lookup_ok;
87
88 static struct cds_lfht *test_ht;
89
90 struct test_data {
91 int a;
92 int b;
93 };
94
95 static volatile int test_go, test_stop;
96
97 static unsigned long wdelay;
98
99 static unsigned long duration;
100
101 /* read-side C.S. duration, in loops */
102 static unsigned long rduration;
103
104 static unsigned long init_hash_size = DEFAULT_HASH_SIZE;
105 static unsigned long init_populate;
106 static unsigned long rand_pool = DEFAULT_RAND_POOL;
107 static int add_only, add_unique;
108
109 static inline void loop_sleep(unsigned long l)
110 {
111 while(l-- != 0)
112 caa_cpu_relax();
113 }
114
115 static int verbose_mode;
116
117 #define printf_verbose(fmt, args...) \
118 do { \
119 if (verbose_mode) \
120 printf(fmt, ## args); \
121 } while (0)
122
123 static unsigned int cpu_affinities[NR_CPUS];
124 static unsigned int next_aff = 0;
125 static int use_affinity = 0;
126
127 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
128
129 static void set_affinity(void)
130 {
131 cpu_set_t mask;
132 int cpu;
133 int ret;
134
135 if (!use_affinity)
136 return;
137
138 ret = pthread_mutex_lock(&affinity_mutex);
139 if (ret) {
140 perror("Error in pthread mutex lock");
141 exit(-1);
142 }
143 cpu = cpu_affinities[next_aff++];
144 ret = pthread_mutex_unlock(&affinity_mutex);
145 if (ret) {
146 perror("Error in pthread mutex unlock");
147 exit(-1);
148 }
149 CPU_ZERO(&mask);
150 CPU_SET(cpu, &mask);
151 sched_setaffinity(0, sizeof(mask), &mask);
152 }
153
154 /*
155 * returns 0 if test should end.
156 */
157 static int test_duration_write(void)
158 {
159 return !test_stop;
160 }
161
162 static int test_duration_read(void)
163 {
164 return !test_stop;
165 }
166
167 static unsigned long long __thread nr_writes;
168 static unsigned long long __thread nr_reads;
169
170 static unsigned int nr_readers;
171 static unsigned int nr_writers;
172
173 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
174
175 void rcu_copy_mutex_lock(void)
176 {
177 int ret;
178 ret = pthread_mutex_lock(&rcu_copy_mutex);
179 if (ret) {
180 perror("Error in pthread mutex lock");
181 exit(-1);
182 }
183 }
184
185 void rcu_copy_mutex_unlock(void)
186 {
187 int ret;
188
189 ret = pthread_mutex_unlock(&rcu_copy_mutex);
190 if (ret) {
191 perror("Error in pthread mutex unlock");
192 exit(-1);
193 }
194 }
195
196 /*
197 * Hash function
198 * Source: http://burtleburtle.net/bob/c/lookup3.c
199 * Originally Public Domain
200 */
201
202 #define rot(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
203
204 #define mix(a, b, c) \
205 do { \
206 a -= c; a ^= rot(c, 4); c += b; \
207 b -= a; b ^= rot(a, 6); a += c; \
208 c -= b; c ^= rot(b, 8); b += a; \
209 a -= c; a ^= rot(c, 16); c += b; \
210 b -= a; b ^= rot(a, 19); a += c; \
211 c -= b; c ^= rot(b, 4); b += a; \
212 } while (0)
213
214 #define final(a, b, c) \
215 { \
216 c ^= b; c -= rot(b, 14); \
217 a ^= c; a -= rot(c, 11); \
218 b ^= a; b -= rot(a, 25); \
219 c ^= b; c -= rot(b, 16); \
220 a ^= c; a -= rot(c, 4);\
221 b ^= a; b -= rot(a, 14); \
222 c ^= b; c -= rot(b, 24); \
223 }
224
225 static __attribute__((unused))
226 uint32_t hash_u32(
227 const uint32_t *k, /* the key, an array of uint32_t values */
228 size_t length, /* the length of the key, in uint32_ts */
229 uint32_t initval) /* the previous hash, or an arbitrary value */
230 {
231 uint32_t a, b, c;
232
233 /* Set up the internal state */
234 a = b = c = 0xdeadbeef + (((uint32_t) length) << 2) + initval;
235
236 /*----------------------------------------- handle most of the key */
237 while (length > 3) {
238 a += k[0];
239 b += k[1];
240 c += k[2];
241 mix(a, b, c);
242 length -= 3;
243 k += 3;
244 }
245
246 /*----------------------------------- handle the last 3 uint32_t's */
247 switch (length) { /* all the case statements fall through */
248 case 3: c += k[2];
249 case 2: b += k[1];
250 case 1: a += k[0];
251 final(a, b, c);
252 case 0: /* case 0: nothing left to add */
253 break;
254 }
255 /*---------------------------------------------- report the result */
256 return c;
257 }
258
259 static
260 void hashword2(
261 const uint32_t *k, /* the key, an array of uint32_t values */
262 size_t length, /* the length of the key, in uint32_ts */
263 uint32_t *pc, /* IN: seed OUT: primary hash value */
264 uint32_t *pb) /* IN: more seed OUT: secondary hash value */
265 {
266 uint32_t a, b, c;
267
268 /* Set up the internal state */
269 a = b = c = 0xdeadbeef + ((uint32_t) (length << 2)) + *pc;
270 c += *pb;
271
272 /*----------------------------------------- handle most of the key */
273 while (length > 3) {
274 a += k[0];
275 b += k[1];
276 c += k[2];
277 mix(a, b, c);
278 length -= 3;
279 k += 3;
280 }
281
282 /*----------------------------------- handle the last 3 uint32_t's */
283 switch (length) { /* all the case statements fall through */
284 case 3: c += k[2];
285 case 2: b += k[1];
286 case 1: a += k[0];
287 final(a, b, c);
288 case 0: /* case 0: nothing left to add */
289 break;
290 }
291 /*---------------------------------------------- report the result */
292 *pc = c;
293 *pb = b;
294 }
295
296 #if (CAA_BITS_PER_LONG == 32)
297 static
298 unsigned long test_hash(void *_key, size_t length, unsigned long seed)
299 {
300 unsigned long key = (unsigned long) _key;
301 unsigned long v;
302
303 assert(length == sizeof(unsigned long));
304 return hash_u32(&v, 1, seed);
305 }
306 #else
307 static
308 unsigned long test_hash(void *_key, size_t length, unsigned long seed)
309 {
310 union {
311 uint64_t v64;
312 uint32_t v32[2];
313 } v;
314 union {
315 uint64_t v64;
316 uint32_t v32[2];
317 } key;
318
319 assert(length == sizeof(unsigned long));
320 v.v64 = (uint64_t) seed;
321 key.v64 = (uint64_t) _key;
322 hashword2(key.v32, 2, &v.v32[0], &v.v32[1]);
323 return v.v64;
324 }
325 #endif
326
327 static
328 unsigned long test_compare(void *key1, size_t key1_len,
329 void *key2, size_t key2_len)
330 {
331 if (unlikely(key1_len != key2_len))
332 return -1;
333 assert(key1_len == sizeof(unsigned long));
334 if (key1 == key2)
335 return 0;
336 else
337 return 1;
338 }
339
340 void *thr_reader(void *_count)
341 {
342 unsigned long long *count = _count;
343 struct cds_lfht_node *node;
344
345 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
346 "reader", pthread_self(), (unsigned long)gettid());
347
348 set_affinity();
349
350 rcu_register_thread();
351
352 while (!test_go)
353 {
354 }
355 cmm_smp_mb();
356
357 for (;;) {
358 rcu_read_lock();
359 node = cds_lfht_lookup(test_ht,
360 (void *)(unsigned long)(rand_r(&rand_lookup) % rand_pool),
361 sizeof(void *));
362 if (node == NULL)
363 lookup_fail++;
364 else
365 lookup_ok++;
366 debug_yield_read();
367 if (unlikely(rduration))
368 loop_sleep(rduration);
369 rcu_read_unlock();
370 nr_reads++;
371 if (unlikely(!test_duration_read()))
372 break;
373 if (unlikely((nr_reads & ((1 << 10) - 1)) == 0))
374 rcu_quiescent_state();
375 }
376
377 rcu_unregister_thread();
378
379 *count = nr_reads;
380 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
381 "reader", pthread_self(), (unsigned long)gettid());
382 printf_verbose("readid : %lx, lookupfail %lu, lookupok %lu\n",
383 pthread_self(), lookup_fail, lookup_ok);
384 return ((void*)1);
385
386 }
387
388 static
389 void free_node_cb(struct rcu_head *head)
390 {
391 struct cds_lfht_node *node =
392 caa_container_of(head, struct cds_lfht_node, head);
393 free(node);
394 }
395
396 void *thr_writer(void *_count)
397 {
398 struct cds_lfht_node *node, *ret_node;
399 struct wr_count *count = _count;
400 int ret;
401
402 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
403 "writer", pthread_self(), (unsigned long)gettid());
404
405 set_affinity();
406
407 rcu_register_thread();
408
409 while (!test_go)
410 {
411 }
412 cmm_smp_mb();
413
414 for (;;) {
415 if (add_only || rand_r(&rand_lookup) & 1) {
416 node = malloc(sizeof(struct cds_lfht_node));
417 rcu_read_lock();
418 cds_lfht_node_init(node,
419 (void *)(unsigned long)(rand_r(&rand_lookup) % rand_pool),
420 sizeof(void *));
421 if (add_unique)
422 ret_node = cds_lfht_add_unique(test_ht, node);
423 else
424 cds_lfht_add(test_ht, node);
425 rcu_read_unlock();
426 if (add_unique && ret_node != node) {
427 free(node);
428 nr_addexist++;
429 } else
430 nr_add++;
431 } else {
432 /* May delete */
433 rcu_read_lock();
434 node = cds_lfht_lookup(test_ht,
435 (void *)(unsigned long)(rand_r(&rand_lookup) % rand_pool),
436 sizeof(void *));
437 if (node)
438 ret = cds_lfht_remove(test_ht, node);
439 else
440 ret = -ENOENT;
441 rcu_read_unlock();
442 if (ret == 0) {
443 call_rcu(&node->head, free_node_cb);
444 nr_del++;
445 } else
446 nr_delnoent++;
447 }
448 #if 0
449 //if (nr_writes % 100000 == 0) {
450 if (nr_writes % 1000 == 0) {
451 rcu_read_lock();
452 if (rand_r(&rand_lookup) & 1) {
453 ht_resize(test_ht, 1);
454 } else {
455 ht_resize(test_ht, -1);
456 }
457 rcu_read_unlock();
458 }
459 #endif //0
460 nr_writes++;
461 if (unlikely(!test_duration_write()))
462 break;
463 if (unlikely(wdelay))
464 loop_sleep(wdelay);
465 if (unlikely((nr_writes & ((1 << 10) - 1)) == 0))
466 rcu_quiescent_state();
467 }
468
469 rcu_unregister_thread();
470
471 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
472 "writer", pthread_self(), (unsigned long)gettid());
473 printf_verbose("info id %lx: nr_add %lu, nr_addexist %lu, nr_del %lu, "
474 "nr_delnoent %lu\n", pthread_self(), nr_add,
475 nr_addexist, nr_del, nr_delnoent);
476 count->update_ops = nr_writes;
477 count->add = nr_add;
478 count->add_exist = nr_addexist;
479 count->remove = nr_del;
480 return ((void*)2);
481 }
482
483 static int populate_hash(void)
484 {
485 struct cds_lfht_node *node, *ret_node;
486
487 if (!init_populate)
488 return 0;
489
490 if (add_unique && init_populate * 10 > rand_pool) {
491 printf("WARNING: required to populate %lu nodes (-k), but random "
492 "pool is quite small (%lu values) and we are in add_unique (-u) mode. Try with a "
493 "larger random pool (-p option).\n", init_populate, rand_pool);
494 return -1;
495 }
496
497 while (nr_add < init_populate) {
498 node = malloc(sizeof(struct cds_lfht_node));
499 cds_lfht_node_init(node,
500 (void *)(unsigned long)(rand_r(&rand_lookup) % rand_pool),
501 sizeof(void *));
502 if (add_unique)
503 ret_node = cds_lfht_add_unique(test_ht, node);
504 else
505 cds_lfht_add(test_ht, node);
506 if (add_unique && ret_node != node) {
507 free(node);
508 nr_addexist++;
509 } else
510 nr_add++;
511 nr_writes++;
512 }
513 return 0;
514 }
515
516 void show_usage(int argc, char **argv)
517 {
518 printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
519 #ifdef DEBUG_YIELD
520 printf(" [-r] [-w] (yield reader and/or writer)");
521 #endif
522 printf(" [-d delay] (writer period (us))");
523 printf(" [-c duration] (reader C.S. duration (in loops))");
524 printf(" [-v] (verbose output)");
525 printf(" [-a cpu#] [-a cpu#]... (affinity)");
526 printf(" [-p size] (random key value pool size)");
527 printf(" [-h size] (initial hash table size)");
528 printf(" [-u] Uniquify add.");
529 printf(" [-i] Add only (no removal).");
530 printf(" [-k nr_nodes] Number of nodes to insert initially.");
531 printf("\n");
532 }
533
534 int main(int argc, char **argv)
535 {
536 int err;
537 pthread_t *tid_reader, *tid_writer;
538 void *tret;
539 unsigned long long *count_reader;
540 struct wr_count *count_writer;
541 unsigned long long tot_reads = 0, tot_writes = 0,
542 tot_add = 0, tot_add_exist = 0, tot_remove = 0;
543 unsigned long count, removed;
544 int i, a, ret;
545
546 if (argc < 4) {
547 show_usage(argc, argv);
548 return -1;
549 }
550
551 err = sscanf(argv[1], "%u", &nr_readers);
552 if (err != 1) {
553 show_usage(argc, argv);
554 return -1;
555 }
556
557 err = sscanf(argv[2], "%u", &nr_writers);
558 if (err != 1) {
559 show_usage(argc, argv);
560 return -1;
561 }
562
563 err = sscanf(argv[3], "%lu", &duration);
564 if (err != 1) {
565 show_usage(argc, argv);
566 return -1;
567 }
568
569 for (i = 4; i < argc; i++) {
570 if (argv[i][0] != '-')
571 continue;
572 switch (argv[i][1]) {
573 #ifdef DEBUG_YIELD
574 case 'r':
575 yield_active |= YIELD_READ;
576 break;
577 case 'w':
578 yield_active |= YIELD_WRITE;
579 break;
580 #endif
581 case 'a':
582 if (argc < i + 2) {
583 show_usage(argc, argv);
584 return -1;
585 }
586 a = atoi(argv[++i]);
587 cpu_affinities[next_aff++] = a;
588 use_affinity = 1;
589 printf_verbose("Adding CPU %d affinity\n", a);
590 break;
591 case 'c':
592 if (argc < i + 2) {
593 show_usage(argc, argv);
594 return -1;
595 }
596 rduration = atol(argv[++i]);
597 break;
598 case 'd':
599 if (argc < i + 2) {
600 show_usage(argc, argv);
601 return -1;
602 }
603 wdelay = atol(argv[++i]);
604 break;
605 case 'v':
606 verbose_mode = 1;
607 break;
608 case 'p':
609 if (argc < i + 2) {
610 show_usage(argc, argv);
611 return -1;
612 }
613 rand_pool = atol(argv[++i]);
614 break;
615 case 'h':
616 if (argc < i + 2) {
617 show_usage(argc, argv);
618 return -1;
619 }
620 init_hash_size = atol(argv[++i]);
621 break;
622 case 'u':
623 add_unique = 1;
624 break;
625 case 'i':
626 add_only = 1;
627 break;
628 case 'k':
629 init_populate = atol(argv[++i]);
630 break;
631 }
632 }
633
634 /* Check if hash size is power of 2 */
635 if (init_hash_size && init_hash_size & (init_hash_size - 1)) {
636 printf("Error: Hash table size %lu is not a power of 2.\n",
637 init_hash_size);
638 return -1;
639 }
640
641 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
642 duration, nr_readers, nr_writers);
643 printf_verbose("Writer delay : %lu loops.\n", wdelay);
644 printf_verbose("Reader duration : %lu loops.\n", rduration);
645 printf_verbose("Random pool size : %lu.\n", rand_pool);
646 printf_verbose("Mode:%s%s.\n",
647 add_only ? " add only" : " add/remove",
648 add_unique ? " uniquify" : "");
649 printf_verbose("Initial hash table size: %lu buckets.\n", init_hash_size);
650 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
651 "main", pthread_self(), (unsigned long)gettid());
652
653 tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
654 tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
655 count_reader = malloc(sizeof(*count_reader) * nr_readers);
656 count_writer = malloc(sizeof(*count_writer) * nr_writers);
657 test_ht = cds_lfht_new(test_hash, test_compare, 0x42UL,
658 init_hash_size, call_rcu);
659 ret = populate_hash();
660 assert(!ret);
661 err = create_all_cpu_call_rcu_data(0);
662 assert(!err);
663
664 next_aff = 0;
665
666 for (i = 0; i < nr_readers; i++) {
667 err = pthread_create(&tid_reader[i], NULL, thr_reader,
668 &count_reader[i]);
669 if (err != 0)
670 exit(1);
671 }
672 for (i = 0; i < nr_writers; i++) {
673 err = pthread_create(&tid_writer[i], NULL, thr_writer,
674 &count_writer[i]);
675 if (err != 0)
676 exit(1);
677 }
678
679 cmm_smp_mb();
680
681 test_go = 1;
682
683 sleep(duration);
684
685 test_stop = 1;
686
687 for (i = 0; i < nr_readers; i++) {
688 err = pthread_join(tid_reader[i], &tret);
689 if (err != 0)
690 exit(1);
691 tot_reads += count_reader[i];
692 }
693 for (i = 0; i < nr_writers; i++) {
694 err = pthread_join(tid_writer[i], &tret);
695 if (err != 0)
696 exit(1);
697 tot_writes += count_writer[i].update_ops;
698 tot_add += count_writer[i].add;
699 tot_add_exist += count_writer[i].add_exist;
700 tot_remove += count_writer[i].remove;
701 }
702 printf("Counting nodes... ");
703 fflush(stdout);
704 cds_lfht_count_nodes(test_ht, &count, &removed);
705 printf("done.\n");
706 if (count || removed)
707 printf("WARNING: nodes left in the hash table upon destroy: "
708 "%lu nodes + %lu logically removed.\n", count, removed);
709 ret = cds_lfht_destroy(test_ht);
710
711 if (ret)
712 printf_verbose("final delete aborted\n");
713 else
714 printf_verbose("final delete success\n");
715 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
716 tot_writes);
717 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
718 "nr_writers %3u "
719 "wdelay %6lu rand_pool %12llu nr_reads %12llu nr_writes %12llu nr_ops %12llu "
720 "nr_add %12llu nr_add_fail %12llu nr_remove %12llu nr_leaked %12lld\n",
721 argv[0], duration, nr_readers, rduration,
722 nr_writers, wdelay, rand_pool, tot_reads, tot_writes,
723 tot_reads + tot_writes, tot_add, tot_add_exist, tot_remove,
724 (long long) tot_add + init_populate - tot_remove - count);
725 free(tid_reader);
726 free(tid_writer);
727 free(count_reader);
728 free(count_writer);
729 return 0;
730 }
This page took 0.044376 seconds and 5 git commands to generate.