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 static
 185 unsigned long test_hash(void *_hashseed, void *_key)
 186 {
 187         unsigned long seed = (unsigned long) _hashseed;
 188         unsigned long key = (unsigned long) _key;
 189         unsigned long v;
 190
 191         v = key ^ seed;
 192         v ^= v << 8;
 193         v ^= v << 16;
 194         v ^= v << 27;
 195         v ^= v >> 8;
 196         v ^= v >> 16;
 197         v ^= v >> 27;
 198
 199         return v;
 200 }
 201
 202 void *thr_reader(void *_count)
 203 {
 204         unsigned long long *count = _count;
 205         struct rcu_ht_node *node;
 206
 207         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 208                         "reader", pthread_self(), (unsigned long)gettid());
 209
 210         set_affinity();
 211
 212         rcu_register_thread();
 213
 214         while (!test_go)
 215         {
 216         }
 217         cmm_smp_mb();
 218
 219         for (;;) {
 220                 rcu_read_lock();
 221                 node = ht_lookup(test_ht,
 222                         (void *)(unsigned long)(rand_r(&rand_lookup) % RAND_POOL));
 223                 if (node == NULL)
 224                         lookup_fail++;
 225                 else
 226                         lookup_ok++;
 227                 debug_yield_read();
 228                 if (unlikely(rduration))
 229                         loop_sleep(rduration);
 230                 rcu_read_unlock();
 231                 nr_reads++;
 232                 if (unlikely(!test_duration_read()))
 233                         break;
 234         }
 235
 236         rcu_unregister_thread();
 237
 238         *count = nr_reads;
 239         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 240                         "reader", pthread_self(), (unsigned long)gettid());
 241         printf_verbose("readid : %lx, lookupfail %lu, lookupok %lu\n",
 242                         pthread_self(), lookup_fail, lookup_ok);
 243         return ((void*)1);
 244
 245 }
 246
 247 static
 248 void free_node_cb(struct rcu_head *head)
 249 {
 250         struct rcu_ht_node *node =
 251                 caa_container_of(head, struct rcu_ht_node, head);
 252         free(node);
 253 }
 254
 255 void *thr_writer(void *_count)
 256 {
 257         struct rcu_ht_node *node;
 258         unsigned long long *count = _count;
 259         int ret;
 260
 261         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 262                         "writer", pthread_self(), (unsigned long)gettid());
 263
 264         set_affinity();
 265
 266         rcu_register_thread();
 267
 268         while (!test_go)
 269         {
 270         }
 271         cmm_smp_mb();
 272
 273         for (;;) {
 274                 if (rand_r(&rand_lookup) & 1) {
 275                         node = malloc(sizeof(struct rcu_ht_node));
 276                         rcu_read_lock();
 277                         ht_node_init(node,
 278                                 (void *)(unsigned long)(rand_r(&rand_lookup) % RAND_POOL),
 279                                 (void *) 0x42);
 280                         ht_add(test_ht, node);
 281                         rcu_read_unlock();
 282                         nr_add++;
 283                 } else {
 284                         /* May delete */
 285                         rcu_read_lock();
 286                         node = ht_lookup(test_ht,
 287                                 (void *)(unsigned long)(rand_r(&rand_lookup) % RAND_POOL));
 288                         if (node)
 289                                 ret = ht_remove(test_ht, node);
 290                         else
 291                                 ret = -ENOENT;
 292                         rcu_read_unlock();
 293                         if (ret == 0) {
 294                                 call_rcu(&node->head, free_node_cb);
 295                                 nr_del++;
 296                         } else
 297                                 nr_delnoent++;
 298                 }
 299 #if 0
 300                 //if (nr_writes % 100000 == 0) {
 301                 if (nr_writes % 1000 == 0) {
 302                         rcu_read_lock();
 303                         if (rand_r(&rand_lookup) & 1) {
 304                                 ht_resize(test_ht, 1);
 305                         } else {
 306                                 ht_resize(test_ht, -1);
 307                         }
 308                         rcu_read_unlock();
 309                 }
 310 #endif //0
 311                 nr_writes++;
 312                 if (unlikely(!test_duration_write()))
 313                         break;
 314                 if (unlikely(wdelay))
 315                         loop_sleep(wdelay);
 316         }
 317
 318         rcu_unregister_thread();
 319
 320         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 321                         "writer", pthread_self(), (unsigned long)gettid());
 322         printf_verbose("info id %lx: nr_add %lu, nr_addexist %lu, nr_del %lu, "
 323                         "nr_delnoent %lu\n", pthread_self(), nr_add,
 324                         nr_addexist, nr_del, nr_delnoent);
 325         *count = nr_writes;
 326         return ((void*)2);
 327 }
 328
 329 void show_usage(int argc, char **argv)
 330 {
 331         printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
 332 #ifdef DEBUG_YIELD
 333         printf(" [-r] [-w] (yield reader and/or writer)");
 334 #endif
 335         printf(" [-d delay] (writer period (us))");
 336         printf(" [-c duration] (reader C.S. duration (in loops))");
 337         printf(" [-v] (verbose output)");
 338         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 339         printf("\n");
 340 }
 341
 342 int main(int argc, char **argv)
 343 {
 344         int err;
 345         pthread_t *tid_reader, *tid_writer;
 346         void *tret;
 347         unsigned long long *count_reader, *count_writer;
 348         unsigned long long tot_reads = 0, tot_writes = 0;
 349         int i, a, ret;
 350
 351         if (argc < 4) {
 352                 show_usage(argc, argv);
 353                 return -1;
 354         }
 355
 356         err = sscanf(argv[1], "%u", &nr_readers);
 357         if (err != 1) {
 358                 show_usage(argc, argv);
 359                 return -1;
 360         }
 361
 362         err = sscanf(argv[2], "%u", &nr_writers);
 363         if (err != 1) {
 364                 show_usage(argc, argv);
 365                 return -1;
 366         }
 367
 368         err = sscanf(argv[3], "%lu", &duration);
 369         if (err != 1) {
 370                 show_usage(argc, argv);
 371                 return -1;
 372         }
 373
 374         for (i = 4; i < argc; i++) {
 375                 if (argv[i][0] != '-')
 376                         continue;
 377                 switch (argv[i][1]) {
 378 #ifdef DEBUG_YIELD
 379                 case 'r':
 380                         yield_active |= YIELD_READ;
 381                         break;
 382                 case 'w':
 383                         yield_active |= YIELD_WRITE;
 384                         break;
 385 #endif
 386                 case 'a':
 387                         if (argc < i + 2) {
 388                                 show_usage(argc, argv);
 389                                 return -1;
 390                         }
 391                         a = atoi(argv[++i]);
 392                         cpu_affinities[next_aff++] = a;
 393                         use_affinity = 1;
 394                         printf_verbose("Adding CPU %d affinity\n", a);
 395                         break;
 396                 case 'c':
 397                         if (argc < i + 2) {
 398                                 show_usage(argc, argv);
 399                                 return -1;
 400                         }
 401                         rduration = atol(argv[++i]);
 402                         break;
 403                 case 'd':
 404                         if (argc < i + 2) {
 405                                 show_usage(argc, argv);
 406                                 return -1;
 407                         }
 408                         wdelay = atol(argv[++i]);
 409                         break;
 410                 case 'v':
 411                         verbose_mode = 1;
 412                         break;
 413                 }
 414         }
 415
 416         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 417                 duration, nr_readers, nr_writers);
 418         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 419         printf_verbose("Reader duration : %lu loops.\n", rduration);
 420         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 421                         "main", pthread_self(), (unsigned long)gettid());
 422
 423         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 424         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 425         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 426         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 427         test_ht = ht_new(test_hash, (void *) 0x42,
 428                          HASH_SIZE, call_rcu);
 429         next_aff = 0;
 430
 431         for (i = 0; i < nr_readers; i++) {
 432                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 433                                      &count_reader[i]);
 434                 if (err != 0)
 435                         exit(1);
 436         }
 437         for (i = 0; i < nr_writers; i++) {
 438                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 439                                      &count_writer[i]);
 440                 if (err != 0)
 441                         exit(1);
 442         }
 443
 444         cmm_smp_mb();
 445
 446         test_go = 1;
 447
 448         sleep(duration);
 449
 450         test_stop = 1;
 451
 452         for (i = 0; i < nr_readers; i++) {
 453                 err = pthread_join(tid_reader[i], &tret);
 454                 if (err != 0)
 455                         exit(1);
 456                 tot_reads += count_reader[i];
 457         }
 458         for (i = 0; i < nr_writers; i++) {
 459                 err = pthread_join(tid_writer[i], &tret);
 460                 if (err != 0)
 461                         exit(1);
 462                 tot_writes += count_writer[i];
 463         }
 464         ret = ht_destroy(test_ht);
 465         if (ret)
 466                 printf("WARNING: nodes left in the hash table upon destroy\n");
 467
 468         printf_verbose("final delete: %d items\n", ret);
 469         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 470                tot_writes);
 471         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
 472                 "nr_writers %3u "
 473                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 474                 argv[0], duration, nr_readers, rduration,
 475                 nr_writers, wdelay, tot_reads, tot_writes,
 476                 tot_reads + tot_writes);
 477         free(tid_reader);
 478         free(tid_writer);
 479         free(count_reader);
 480         free(count_writer);
 481         return 0;
 482 }