rculfhash: add unique
[urcu.git] / tests / test_urcu_hash.c
1 /*
2 * test_ht.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 HASH_SIZE 32
41 #define RAND_POOL 1000
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.h>
70 #include <urcu/rculfhash.h>
71 #include <urcu-call-rcu.h>
72
73 static unsigned int __thread rand_lookup;
74 static unsigned long __thread nr_add;
75 static unsigned long __thread nr_addexist;
76 static unsigned long __thread nr_del;
77 static unsigned long __thread nr_delnoent;
78 static unsigned long __thread lookup_fail;
79 static unsigned long __thread lookup_ok;
80
81 static struct rcu_ht *test_ht;
82
83 struct test_data {
84 int a;
85 int b;
86 };
87
88 static volatile int test_go, test_stop;
89
90 static unsigned long wdelay;
91
92 static unsigned long duration;
93
94 /* read-side C.S. duration, in loops */
95 static unsigned long rduration;
96
97 static inline void loop_sleep(unsigned long l)
98 {
99 while(l-- != 0)
100 caa_cpu_relax();
101 }
102
103 static int verbose_mode;
104
105 #define printf_verbose(fmt, args...) \
106 do { \
107 if (verbose_mode) \
108 printf(fmt, args); \
109 } while (0)
110
111 static unsigned int cpu_affinities[NR_CPUS];
112 static unsigned int next_aff = 0;
113 static int use_affinity = 0;
114
115 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
116
117 static void set_affinity(void)
118 {
119 cpu_set_t mask;
120 int cpu;
121 int ret;
122
123 if (!use_affinity)
124 return;
125
126 ret = pthread_mutex_lock(&affinity_mutex);
127 if (ret) {
128 perror("Error in pthread mutex lock");
129 exit(-1);
130 }
131 cpu = cpu_affinities[next_aff++];
132 ret = pthread_mutex_unlock(&affinity_mutex);
133 if (ret) {
134 perror("Error in pthread mutex unlock");
135 exit(-1);
136 }
137 CPU_ZERO(&mask);
138 CPU_SET(cpu, &mask);
139 sched_setaffinity(0, sizeof(mask), &mask);
140 }
141
142 /*
143 * returns 0 if test should end.
144 */
145 static int test_duration_write(void)
146 {
147 return !test_stop;
148 }
149
150 static int test_duration_read(void)
151 {
152 return !test_stop;
153 }
154
155 static unsigned long long __thread nr_writes;
156 static unsigned long long __thread nr_reads;
157
158 static unsigned int nr_readers;
159 static unsigned int nr_writers;
160
161 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
162
163 void rcu_copy_mutex_lock(void)
164 {
165 int ret;
166 ret = pthread_mutex_lock(&rcu_copy_mutex);
167 if (ret) {
168 perror("Error in pthread mutex lock");
169 exit(-1);
170 }
171 }
172
173 void rcu_copy_mutex_unlock(void)
174 {
175 int ret;
176
177 ret = pthread_mutex_unlock(&rcu_copy_mutex);
178 if (ret) {
179 perror("Error in pthread mutex unlock");
180 exit(-1);
181 }
182 }
183
184 /*
185 * Hash function
186 * Source: http://burtleburtle.net/bob/c/lookup3.c
187 * Originally Public Domain
188 */
189
190 #define rot(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
191
192 #define mix(a, b, c) \
193 do { \
194 a -= c; a ^= rot(c, 4); c += b; \
195 b -= a; b ^= rot(a, 6); a += c; \
196 c -= b; c ^= rot(b, 8); b += a; \
197 a -= c; a ^= rot(c, 16); c += b; \
198 b -= a; b ^= rot(a, 19); a += c; \
199 c -= b; c ^= rot(b, 4); b += a; \
200 } while (0)
201
202 #define final(a, b, c) \
203 { \
204 c ^= b; c -= rot(b, 14); \
205 a ^= c; a -= rot(c, 11); \
206 b ^= a; b -= rot(a, 25); \
207 c ^= b; c -= rot(b, 16); \
208 a ^= c; a -= rot(c, 4);\
209 b ^= a; b -= rot(a, 14); \
210 c ^= b; c -= rot(b, 24); \
211 }
212
213 static __attribute__((unused))
214 uint32_t hash_u32(
215 const uint32_t *k, /* the key, an array of uint32_t values */
216 size_t length, /* the length of the key, in uint32_ts */
217 uint32_t initval) /* the previous hash, or an arbitrary value */
218 {
219 uint32_t a, b, c;
220
221 /* Set up the internal state */
222 a = b = c = 0xdeadbeef + (((uint32_t) length) << 2) + initval;
223
224 /*----------------------------------------- handle most of the key */
225 while (length > 3) {
226 a += k[0];
227 b += k[1];
228 c += k[2];
229 mix(a, b, c);
230 length -= 3;
231 k += 3;
232 }
233
234 /*----------------------------------- handle the last 3 uint32_t's */
235 switch (length) { /* all the case statements fall through */
236 case 3: c += k[2];
237 case 2: b += k[1];
238 case 1: a += k[0];
239 final(a, b, c);
240 case 0: /* case 0: nothing left to add */
241 break;
242 }
243 /*---------------------------------------------- report the result */
244 return c;
245 }
246
247 static
248 void hashword2(
249 const uint32_t *k, /* the key, an array of uint32_t values */
250 size_t length, /* the length of the key, in uint32_ts */
251 uint32_t *pc, /* IN: seed OUT: primary hash value */
252 uint32_t *pb) /* IN: more seed OUT: secondary hash value */
253 {
254 uint32_t a, b, c;
255
256 /* Set up the internal state */
257 a = b = c = 0xdeadbeef + ((uint32_t) (length << 2)) + *pc;
258 c += *pb;
259
260 /*----------------------------------------- handle most of the key */
261 while (length > 3) {
262 a += k[0];
263 b += k[1];
264 c += k[2];
265 mix(a, b, c);
266 length -= 3;
267 k += 3;
268 }
269
270 /*----------------------------------- handle the last 3 uint32_t's */
271 switch (length) { /* all the case statements fall through */
272 case 3: c += k[2];
273 case 2: b += k[1];
274 case 1: a += k[0];
275 final(a, b, c);
276 case 0: /* case 0: nothing left to add */
277 break;
278 }
279 /*---------------------------------------------- report the result */
280 *pc = c;
281 *pb = b;
282 }
283
284 #if (CAA_BITS_PER_LONG == 32)
285 static
286 unsigned long test_hash(void *_key, size_t length, unsigned long seed)
287 {
288 unsigned long key = (unsigned long) _key;
289 unsigned long v;
290
291 assert(length == sizeof(unsigned long));
292 return hash_u32(&v, 1, seed);
293 }
294 #else
295 static
296 unsigned long test_hash(void *_key, size_t length, unsigned long seed)
297 {
298 union {
299 uint64_t v64;
300 uint32_t v32[2];
301 } v;
302 union {
303 uint64_t v64;
304 uint32_t v32[2];
305 } key;
306
307 assert(length == sizeof(unsigned long));
308 v.v64 = (uint64_t) seed;
309 key.v64 = (uint64_t) _key;
310 hashword2(key.v32, 2, &v.v32[0], &v.v32[1]);
311 return v.v64;
312 }
313 #endif
314
315 static
316 unsigned long test_compare(void *key1, size_t key1_len,
317 void *key2, size_t key2_len)
318 {
319 if (unlikely(key1_len != key2_len))
320 return -1;
321 assert(key1_len == sizeof(unsigned long));
322 if (key1 == key2)
323 return 0;
324 else
325 return 1;
326 }
327
328 void *thr_reader(void *_count)
329 {
330 unsigned long long *count = _count;
331 struct rcu_ht_node *node;
332
333 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
334 "reader", pthread_self(), (unsigned long)gettid());
335
336 set_affinity();
337
338 rcu_register_thread();
339
340 while (!test_go)
341 {
342 }
343 cmm_smp_mb();
344
345 for (;;) {
346 rcu_read_lock();
347 node = ht_lookup(test_ht,
348 (void *)(unsigned long)(rand_r(&rand_lookup) % RAND_POOL),
349 sizeof(void *));
350 if (node == NULL)
351 lookup_fail++;
352 else
353 lookup_ok++;
354 debug_yield_read();
355 if (unlikely(rduration))
356 loop_sleep(rduration);
357 rcu_read_unlock();
358 nr_reads++;
359 if (unlikely(!test_duration_read()))
360 break;
361 }
362
363 rcu_unregister_thread();
364
365 *count = nr_reads;
366 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
367 "reader", pthread_self(), (unsigned long)gettid());
368 printf_verbose("readid : %lx, lookupfail %lu, lookupok %lu\n",
369 pthread_self(), lookup_fail, lookup_ok);
370 return ((void*)1);
371
372 }
373
374 static
375 void free_node_cb(struct rcu_head *head)
376 {
377 struct rcu_ht_node *node =
378 caa_container_of(head, struct rcu_ht_node, head);
379 free(node);
380 }
381
382 void *thr_writer(void *_count)
383 {
384 struct rcu_ht_node *node;
385 unsigned long long *count = _count;
386 int ret;
387
388 printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
389 "writer", pthread_self(), (unsigned long)gettid());
390
391 set_affinity();
392
393 rcu_register_thread();
394
395 while (!test_go)
396 {
397 }
398 cmm_smp_mb();
399
400 for (;;) {
401 if (rand_r(&rand_lookup) & 1) {
402 node = malloc(sizeof(struct rcu_ht_node));
403 rcu_read_lock();
404 ht_node_init(node,
405 (void *)(unsigned long)(rand_r(&rand_lookup) % RAND_POOL),
406 sizeof(void *),
407 (void *) 0x42);
408 ret = ht_add_unique(test_ht, node);
409 rcu_read_unlock();
410 if (ret)
411 nr_addexist++;
412 else
413 nr_add++;
414 } else {
415 /* May delete */
416 rcu_read_lock();
417 node = ht_lookup(test_ht,
418 (void *)(unsigned long)(rand_r(&rand_lookup) % RAND_POOL),
419 sizeof(void *));
420 if (node)
421 ret = ht_remove(test_ht, node);
422 else
423 ret = -ENOENT;
424 rcu_read_unlock();
425 if (ret == 0) {
426 call_rcu(&node->head, free_node_cb);
427 nr_del++;
428 } else
429 nr_delnoent++;
430 }
431 #if 0
432 //if (nr_writes % 100000 == 0) {
433 if (nr_writes % 1000 == 0) {
434 rcu_read_lock();
435 if (rand_r(&rand_lookup) & 1) {
436 ht_resize(test_ht, 1);
437 } else {
438 ht_resize(test_ht, -1);
439 }
440 rcu_read_unlock();
441 }
442 #endif //0
443 nr_writes++;
444 if (unlikely(!test_duration_write()))
445 break;
446 if (unlikely(wdelay))
447 loop_sleep(wdelay);
448 }
449
450 rcu_unregister_thread();
451
452 printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
453 "writer", pthread_self(), (unsigned long)gettid());
454 printf_verbose("info id %lx: nr_add %lu, nr_addexist %lu, nr_del %lu, "
455 "nr_delnoent %lu\n", pthread_self(), nr_add,
456 nr_addexist, nr_del, nr_delnoent);
457 *count = nr_writes;
458 return ((void*)2);
459 }
460
461 void show_usage(int argc, char **argv)
462 {
463 printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
464 #ifdef DEBUG_YIELD
465 printf(" [-r] [-w] (yield reader and/or writer)");
466 #endif
467 printf(" [-d delay] (writer period (us))");
468 printf(" [-c duration] (reader C.S. duration (in loops))");
469 printf(" [-v] (verbose output)");
470 printf(" [-a cpu#] [-a cpu#]... (affinity)");
471 printf("\n");
472 }
473
474 int main(int argc, char **argv)
475 {
476 int err;
477 pthread_t *tid_reader, *tid_writer;
478 void *tret;
479 unsigned long long *count_reader, *count_writer;
480 unsigned long long tot_reads = 0, tot_writes = 0;
481 int i, a, ret;
482
483 if (argc < 4) {
484 show_usage(argc, argv);
485 return -1;
486 }
487
488 err = sscanf(argv[1], "%u", &nr_readers);
489 if (err != 1) {
490 show_usage(argc, argv);
491 return -1;
492 }
493
494 err = sscanf(argv[2], "%u", &nr_writers);
495 if (err != 1) {
496 show_usage(argc, argv);
497 return -1;
498 }
499
500 err = sscanf(argv[3], "%lu", &duration);
501 if (err != 1) {
502 show_usage(argc, argv);
503 return -1;
504 }
505
506 for (i = 4; i < argc; i++) {
507 if (argv[i][0] != '-')
508 continue;
509 switch (argv[i][1]) {
510 #ifdef DEBUG_YIELD
511 case 'r':
512 yield_active |= YIELD_READ;
513 break;
514 case 'w':
515 yield_active |= YIELD_WRITE;
516 break;
517 #endif
518 case 'a':
519 if (argc < i + 2) {
520 show_usage(argc, argv);
521 return -1;
522 }
523 a = atoi(argv[++i]);
524 cpu_affinities[next_aff++] = a;
525 use_affinity = 1;
526 printf_verbose("Adding CPU %d affinity\n", a);
527 break;
528 case 'c':
529 if (argc < i + 2) {
530 show_usage(argc, argv);
531 return -1;
532 }
533 rduration = atol(argv[++i]);
534 break;
535 case 'd':
536 if (argc < i + 2) {
537 show_usage(argc, argv);
538 return -1;
539 }
540 wdelay = atol(argv[++i]);
541 break;
542 case 'v':
543 verbose_mode = 1;
544 break;
545 }
546 }
547
548 printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
549 duration, nr_readers, nr_writers);
550 printf_verbose("Writer delay : %lu loops.\n", wdelay);
551 printf_verbose("Reader duration : %lu loops.\n", rduration);
552 printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
553 "main", pthread_self(), (unsigned long)gettid());
554
555 tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
556 tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
557 count_reader = malloc(sizeof(*count_reader) * nr_readers);
558 count_writer = malloc(sizeof(*count_writer) * nr_writers);
559 test_ht = ht_new(test_hash, test_compare, 0x42UL,
560 HASH_SIZE, call_rcu);
561 next_aff = 0;
562
563 for (i = 0; i < nr_readers; i++) {
564 err = pthread_create(&tid_reader[i], NULL, thr_reader,
565 &count_reader[i]);
566 if (err != 0)
567 exit(1);
568 }
569 for (i = 0; i < nr_writers; i++) {
570 err = pthread_create(&tid_writer[i], NULL, thr_writer,
571 &count_writer[i]);
572 if (err != 0)
573 exit(1);
574 }
575
576 cmm_smp_mb();
577
578 test_go = 1;
579
580 sleep(duration);
581
582 test_stop = 1;
583
584 for (i = 0; i < nr_readers; i++) {
585 err = pthread_join(tid_reader[i], &tret);
586 if (err != 0)
587 exit(1);
588 tot_reads += count_reader[i];
589 }
590 for (i = 0; i < nr_writers; i++) {
591 err = pthread_join(tid_writer[i], &tret);
592 if (err != 0)
593 exit(1);
594 tot_writes += count_writer[i];
595 }
596 ret = ht_destroy(test_ht);
597 if (ret)
598 printf("WARNING: nodes left in the hash table upon destroy\n");
599
600 printf_verbose("final delete: %d items\n", ret);
601 printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
602 tot_writes);
603 printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
604 "nr_writers %3u "
605 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
606 argv[0], duration, nr_readers, rduration,
607 nr_writers, wdelay, tot_reads, tot_writes,
608 tot_reads + tot_writes);
609 free(tid_reader);
610 free(tid_writer);
611 free(count_reader);
612 free(count_writer);
613 return 0;
614 }
This page took 0.07166 seconds and 4 git commands to generate.