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       10000
  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                                 free(node);
 412                                 nr_addexist++;
 413                         } else
 414                                 nr_add++;
 415                 } else {
 416                         /* May delete */
 417                         rcu_read_lock();
 418                         node = ht_lookup(test_ht,
 419                                 (void *)(unsigned long)(rand_r(&rand_lookup) % RAND_POOL),
 420                                 sizeof(void *));
 421                         if (node)
 422                                 ret = ht_remove(test_ht, node);
 423                         else
 424                                 ret = -ENOENT;
 425                         rcu_read_unlock();
 426                         if (ret == 0) {
 427                                 call_rcu(&node->head, free_node_cb);
 428                                 nr_del++;
 429                         } else
 430                                 nr_delnoent++;
 431                 }
 432 #if 0
 433                 //if (nr_writes % 100000 == 0) {
 434                 if (nr_writes % 1000 == 0) {
 435                         rcu_read_lock();
 436                         if (rand_r(&rand_lookup) & 1) {
 437                                 ht_resize(test_ht, 1);
 438                         } else {
 439                                 ht_resize(test_ht, -1);
 440                         }
 441                         rcu_read_unlock();
 442                 }
 443 #endif //0
 444                 nr_writes++;
 445                 if (unlikely(!test_duration_write()))
 446                         break;
 447                 if (unlikely(wdelay))
 448                         loop_sleep(wdelay);
 449         }
 450
 451         rcu_unregister_thread();
 452
 453         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 454                         "writer", pthread_self(), (unsigned long)gettid());
 455         printf_verbose("info id %lx: nr_add %lu, nr_addexist %lu, nr_del %lu, "
 456                         "nr_delnoent %lu\n", pthread_self(), nr_add,
 457                         nr_addexist, nr_del, nr_delnoent);
 458         *count = nr_writes;
 459         return ((void*)2);
 460 }
 461
 462 void show_usage(int argc, char **argv)
 463 {
 464         printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
 465 #ifdef DEBUG_YIELD
 466         printf(" [-r] [-w] (yield reader and/or writer)");
 467 #endif
 468         printf(" [-d delay] (writer period (us))");
 469         printf(" [-c duration] (reader C.S. duration (in loops))");
 470         printf(" [-v] (verbose output)");
 471         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 472         printf("\n");
 473 }
 474
 475 int main(int argc, char **argv)
 476 {
 477         int err;
 478         pthread_t *tid_reader, *tid_writer;
 479         void *tret;
 480         unsigned long long *count_reader, *count_writer;
 481         unsigned long long tot_reads = 0, tot_writes = 0;
 482         int i, a, ret;
 483
 484         if (argc < 4) {
 485                 show_usage(argc, argv);
 486                 return -1;
 487         }
 488
 489         err = sscanf(argv[1], "%u", &nr_readers);
 490         if (err != 1) {
 491                 show_usage(argc, argv);
 492                 return -1;
 493         }
 494
 495         err = sscanf(argv[2], "%u", &nr_writers);
 496         if (err != 1) {
 497                 show_usage(argc, argv);
 498                 return -1;
 499         }
 500
 501         err = sscanf(argv[3], "%lu", &duration);
 502         if (err != 1) {
 503                 show_usage(argc, argv);
 504                 return -1;
 505         }
 506
 507         for (i = 4; i < argc; i++) {
 508                 if (argv[i][0] != '-')
 509                         continue;
 510                 switch (argv[i][1]) {
 511 #ifdef DEBUG_YIELD
 512                 case 'r':
 513                         yield_active |= YIELD_READ;
 514                         break;
 515                 case 'w':
 516                         yield_active |= YIELD_WRITE;
 517                         break;
 518 #endif
 519                 case 'a':
 520                         if (argc < i + 2) {
 521                                 show_usage(argc, argv);
 522                                 return -1;
 523                         }
 524                         a = atoi(argv[++i]);
 525                         cpu_affinities[next_aff++] = a;
 526                         use_affinity = 1;
 527                         printf_verbose("Adding CPU %d affinity\n", a);
 528                         break;
 529                 case 'c':
 530                         if (argc < i + 2) {
 531                                 show_usage(argc, argv);
 532                                 return -1;
 533                         }
 534                         rduration = atol(argv[++i]);
 535                         break;
 536                 case 'd':
 537                         if (argc < i + 2) {
 538                                 show_usage(argc, argv);
 539                                 return -1;
 540                         }
 541                         wdelay = atol(argv[++i]);
 542                         break;
 543                 case 'v':
 544                         verbose_mode = 1;
 545                         break;
 546                 }
 547         }
 548
 549         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 550                 duration, nr_readers, nr_writers);
 551         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 552         printf_verbose("Reader duration : %lu loops.\n", rduration);
 553         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 554                         "main", pthread_self(), (unsigned long)gettid());
 555
 556         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 557         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 558         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 559         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 560         test_ht = ht_new(test_hash, test_compare, 0x42UL,
 561                          HASH_SIZE, call_rcu);
 562         next_aff = 0;
 563
 564         for (i = 0; i < nr_readers; i++) {
 565                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 566                                      &count_reader[i]);
 567                 if (err != 0)
 568                         exit(1);
 569         }
 570         for (i = 0; i < nr_writers; i++) {
 571                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 572                                      &count_writer[i]);
 573                 if (err != 0)
 574                         exit(1);
 575         }
 576
 577         cmm_smp_mb();
 578
 579         test_go = 1;
 580
 581         sleep(duration);
 582
 583         test_stop = 1;
 584
 585         for (i = 0; i < nr_readers; i++) {
 586                 err = pthread_join(tid_reader[i], &tret);
 587                 if (err != 0)
 588                         exit(1);
 589                 tot_reads += count_reader[i];
 590         }
 591         for (i = 0; i < nr_writers; i++) {
 592                 err = pthread_join(tid_writer[i], &tret);
 593                 if (err != 0)
 594                         exit(1);
 595                 tot_writes += count_writer[i];
 596         }
 597         ret = ht_destroy(test_ht);
 598         if (ret)
 599                 printf("WARNING: nodes left in the hash table upon destroy\n");
 600
 601         printf_verbose("final delete: %d items\n", ret);
 602         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 603                tot_writes);
 604         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
 605                 "nr_writers %3u "
 606                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 607                 argv[0], duration, nr_readers, rduration,
 608                 nr_writers, wdelay, tot_reads, tot_writes,
 609                 tot_reads + tot_writes);
 610         free(tid_reader);
 611         free(tid_writer);
 612         free(count_reader);
 613         free(count_writer);
 614         return 0;
 615 }