tests/test_urcu_rbtree.c

   1 /*
   2  * test_urcu_rbtree.c
   3  *
   4  * Userspace RCU library - test program for RB tree
   5  *
   6  * Copyright February 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   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 #ifndef DYNAMIC_LINK_TEST
  25 #define _LGPL_SOURCE
  26 #else
  27 #define debug_yield_read()
  28 #endif
  29 #include "../config.h"
  30 #include <stdio.h>
  31 #include <pthread.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #include <sys/types.h>
  35 #include <sys/wait.h>
  36 #include <unistd.h>
  37 #include <stdio.h>
  38 #include <assert.h>
  39 #include <sys/syscall.h>
  40 #include <sched.h>
  41 #include <errno.h>
  42 #include <time.h>
  43
  44 #include <urcu/arch.h>
  45
  46 /* hardcoded number of CPUs */
  47 #define NR_CPUS 16384
  48
  49 /* number of insert/delete */
  50 #define NR_RAND 4
  51
  52 #if defined(_syscall0)
  53 _syscall0(pid_t, gettid)
  54 #elif defined(__NR_gettid)
  55 static inline pid_t gettid(void)
  56 {
  57         return syscall(__NR_gettid);
  58 }
  59 #else
  60 #warning "use pid as tid"
  61 static inline pid_t gettid(void)
  62 {
  63         return getpid();
  64 }
  65 #endif
  66
  67 #include <urcu.h>
  68 #include <urcu/rcurbtree.h>
  69 #include <urcu-defer.h>
  70
  71 /* TODO: error handling testing for -ENOMEM */
  72 struct rcu_rbtree_node *rbtree_alloc(void)
  73 {
  74         return calloc(1, sizeof(struct rcu_rbtree_node));
  75 }
  76
  77 void rbtree_free(void *node)
  78 {
  79         free(node);
  80 }
  81
  82 int tree_comp(void *a, void *b)
  83 {
  84         if ((unsigned long)a < (unsigned long)b)
  85                 return -1;
  86         else if ((unsigned long)a > (unsigned long)b)
  87                 return 1;
  88         else
  89                 return 0;
  90 }
  91
  92 static DEFINE_RCU_RBTREE(rbtree, tree_comp, rbtree_alloc, rbtree_free);
  93
  94 static volatile int test_go, test_stop;
  95
  96 static unsigned long wdelay;
  97
  98 static unsigned long duration;
  99
 100 /* read-side C.S. duration, in loops */
 101 static unsigned long rduration;
 102
 103 /* write-side C.S. duration, in loops */
 104 static unsigned long wduration;
 105
 106 static inline void loop_sleep(unsigned long l)
 107 {
 108         while(l-- != 0)
 109                 caa_cpu_relax();
 110 }
 111
 112 static int verbose_mode;
 113
 114 #define printf_verbose(fmt, args...)            \
 115         do {                                    \
 116                 if (verbose_mode)               \
 117                         printf(fmt, args);      \
 118         } while (0)
 119
 120 static unsigned int cpu_affinities[NR_CPUS];
 121 static unsigned int next_aff = 0;
 122 static int use_affinity = 0;
 123
 124 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
 125
 126 #ifndef HAVE_CPU_SET_T
 127 typedef unsigned long cpu_set_t;
 128 # define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
 129 # define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
 130 #endif
 131
 132 static void set_affinity(void)
 133 {
 134         cpu_set_t mask;
 135         int cpu;
 136         int ret;
 137
 138         if (!use_affinity)
 139                 return;
 140
 141 #if HAVE_SCHED_SETAFFINITY
 142         ret = pthread_mutex_lock(&affinity_mutex);
 143         if (ret) {
 144                 perror("Error in pthread mutex lock");
 145                 exit(-1);
 146         }
 147         cpu = cpu_affinities[next_aff++];
 148         ret = pthread_mutex_unlock(&affinity_mutex);
 149         if (ret) {
 150                 perror("Error in pthread mutex unlock");
 151                 exit(-1);
 152         }
 153
 154         CPU_ZERO(&mask);
 155         CPU_SET(cpu, &mask);
 156 #if SCHED_SETAFFINITY_ARGS == 2
 157         sched_setaffinity(0, &mask);
 158 #else
 159         sched_setaffinity(0, sizeof(mask), &mask);
 160 #endif
 161 #endif /* HAVE_SCHED_SETAFFINITY */
 162 }
 163
 164 /*
 165  * returns 0 if test should end.
 166  */
 167 static int test_duration_write(void)
 168 {
 169         return !test_stop;
 170 }
 171
 172 static int test_duration_read(void)
 173 {
 174         return !test_stop;
 175 }
 176
 177 static unsigned long long __thread nr_writes;
 178 static unsigned long long __thread nr_reads;
 179
 180 static unsigned int nr_readers;
 181 static unsigned int nr_writers;
 182
 183 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
 184
 185 void rcu_copy_mutex_lock(void)
 186 {
 187         int ret;
 188         ret = pthread_mutex_lock(&rcu_copy_mutex);
 189         if (ret) {
 190                 perror("Error in pthread mutex lock");
 191                 exit(-1);
 192         }
 193 }
 194
 195 void rcu_copy_mutex_unlock(void)
 196 {
 197         int ret;
 198
 199         ret = pthread_mutex_unlock(&rcu_copy_mutex);
 200         if (ret) {
 201                 perror("Error in pthread mutex unlock");
 202                 exit(-1);
 203         }
 204 }
 205
 206 void *thr_reader(void *_count)
 207 {
 208         unsigned long long *count = _count;
 209
 210         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 211                         "reader", pthread_self(), (unsigned long)gettid());
 212
 213         set_affinity();
 214
 215         rcu_register_thread();
 216
 217         while (!test_go)
 218         {
 219         }
 220         cmm_smp_mb();
 221
 222         for (;;) {
 223                 rcu_read_lock();
 224
 225                 debug_yield_read();
 226                 if (unlikely(rduration))
 227                         loop_sleep(rduration);
 228                 rcu_read_unlock();
 229                 nr_reads++;
 230                 if (unlikely(!test_duration_read()))
 231                         break;
 232         }
 233
 234         rcu_unregister_thread();
 235
 236         /* test extra thread registration */
 237         rcu_register_thread();
 238         rcu_unregister_thread();
 239
 240         *count = nr_reads;
 241         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 242                         "reader", pthread_self(), (unsigned long)gettid());
 243         return ((void*)1);
 244
 245 }
 246
 247 void *thr_writer(void *_count)
 248 {
 249         unsigned long long *count = _count;
 250         struct rcu_rbtree_node *node;
 251         void *key[NR_RAND];
 252         int i;
 253
 254         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 255                         "writer", pthread_self(), (unsigned long)gettid());
 256
 257         set_affinity();
 258
 259         rcu_defer_register_thread();
 260
 261         while (!test_go)
 262         {
 263         }
 264         cmm_smp_mb();
 265
 266         for (;;) {
 267                 rcu_copy_mutex_lock();
 268                 rcu_read_lock();
 269
 270                 for (i = 0; i < NR_RAND; i++) {
 271                         node = rbtree_alloc();
 272                         key[i] = (void *)(unsigned long)(rand() % 2048);
 273                         node->key = key[i];
 274                         rcu_rbtree_insert(&rbtree, node);
 275                 }
 276
 277                 if (unlikely(wduration))
 278                         loop_sleep(wduration);
 279
 280                 for (i = 0; i < NR_RAND; i++) {
 281 #if 0
 282                         node = rcu_rbtree_min(rbtree, rbtree->root);
 283                         while (!rcu_rbtree_is_nil(node)) {
 284                                 printf("{ 0x%lX p:%lX r:%lX l:%lX %s %s %s} ",
 285                                         (unsigned long)node->key,
 286                                         node->p->key,
 287                                         node->right->key,
 288                                         node->left->key,
 289                                         node->color ? "red" : "black",
 290                                         node->pos ? "right" : "left",
 291                                         node->nil ? "nil" : "");
 292                                 node = rcu_rbtree_next(rbtree, node);
 293                         }
 294                         printf("\n");
 295 #endif
 296                         node = rcu_rbtree_search(&rbtree, rbtree.root, key[i]);
 297                         assert(!rcu_rbtree_is_nil(node));
 298                         rcu_rbtree_remove(&rbtree, node);
 299                         defer_rcu((void (*)(void *))rbtree_free, node);
 300                 }
 301
 302                 rcu_read_unlock();
 303                 rcu_copy_mutex_unlock();
 304                 nr_writes++;
 305                 if (unlikely(!test_duration_write()))
 306                         break;
 307                 if (unlikely(wdelay))
 308                         loop_sleep(wdelay);
 309         }
 310
 311         rcu_defer_unregister_thread();
 312
 313         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 314                         "writer", pthread_self(), (unsigned long)gettid());
 315         *count = nr_writes;
 316         return ((void*)2);
 317 }
 318
 319 void show_usage(int argc, char **argv)
 320 {
 321         printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
 322 #ifdef DEBUG_YIELD
 323         printf(" [-r] [-w] (yield reader and/or writer)");
 324 #endif
 325         printf(" [-d delay] (writer period (us))");
 326         printf(" [-c duration] (reader C.S. duration (in loops))");
 327         printf(" [-e duration] (writer C.S. duration (in loops))");
 328         printf(" [-v] (verbose output)");
 329         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 330         printf("\n");
 331 }
 332
 333 int main(int argc, char **argv)
 334 {
 335         int err;
 336         pthread_t *tid_reader, *tid_writer;
 337         void *tret;
 338         unsigned long long *count_reader, *count_writer;
 339         unsigned long long tot_reads = 0, tot_writes = 0;
 340         int i, a;
 341
 342         if (argc < 4) {
 343                 show_usage(argc, argv);
 344                 return -1;
 345         }
 346
 347         err = sscanf(argv[1], "%u", &nr_readers);
 348         if (err != 1) {
 349                 show_usage(argc, argv);
 350                 return -1;
 351         }
 352
 353         err = sscanf(argv[2], "%u", &nr_writers);
 354         if (err != 1) {
 355                 show_usage(argc, argv);
 356                 return -1;
 357         }
 358
 359         err = sscanf(argv[3], "%lu", &duration);
 360         if (err != 1) {
 361                 show_usage(argc, argv);
 362                 return -1;
 363         }
 364
 365         for (i = 4; i < argc; i++) {
 366                 if (argv[i][0] != '-')
 367                         continue;
 368                 switch (argv[i][1]) {
 369 #ifdef DEBUG_YIELD
 370                 case 'r':
 371                         yield_active |= YIELD_READ;
 372                         break;
 373                 case 'w':
 374                         yield_active |= YIELD_WRITE;
 375                         break;
 376 #endif
 377                 case 'a':
 378                         if (argc < i + 2) {
 379                                 show_usage(argc, argv);
 380                                 return -1;
 381                         }
 382                         a = atoi(argv[++i]);
 383                         cpu_affinities[next_aff++] = a;
 384                         use_affinity = 1;
 385                         printf_verbose("Adding CPU %d affinity\n", a);
 386                         break;
 387                 case 'c':
 388                         if (argc < i + 2) {
 389                                 show_usage(argc, argv);
 390                                 return -1;
 391                         }
 392                         rduration = atol(argv[++i]);
 393                         break;
 394                 case 'd':
 395                         if (argc < i + 2) {
 396                                 show_usage(argc, argv);
 397                                 return -1;
 398                         }
 399                         wdelay = atol(argv[++i]);
 400                         break;
 401                 case 'e':
 402                         if (argc < i + 2) {
 403                                 show_usage(argc, argv);
 404                                 return -1;
 405                         }
 406                         wduration = atol(argv[++i]);
 407                         break;
 408                 case 'v':
 409                         verbose_mode = 1;
 410                         break;
 411                 }
 412         }
 413
 414         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 415                 duration, nr_readers, nr_writers);
 416         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 417         printf_verbose("Reader duration : %lu loops.\n", rduration);
 418         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 419                         "main", pthread_self(), (unsigned long)gettid());
 420
 421         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 422         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 423         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 424         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 425
 426         srand(time(NULL));
 427
 428         next_aff = 0;
 429
 430         for (i = 0; i < nr_readers; i++) {
 431                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 432                                      &count_reader[i]);
 433                 if (err != 0)
 434                         exit(1);
 435         }
 436         for (i = 0; i < nr_writers; i++) {
 437                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 438                                      &count_writer[i]);
 439                 if (err != 0)
 440                         exit(1);
 441         }
 442
 443         cmm_smp_mb();
 444
 445         test_go = 1;
 446
 447         sleep(duration);
 448
 449         test_stop = 1;
 450
 451         for (i = 0; i < nr_readers; i++) {
 452                 err = pthread_join(tid_reader[i], &tret);
 453                 if (err != 0)
 454                         exit(1);
 455                 tot_reads += count_reader[i];
 456         }
 457         for (i = 0; i < nr_writers; i++) {
 458                 err = pthread_join(tid_writer[i], &tret);
 459                 if (err != 0)
 460                         exit(1);
 461                 tot_writes += count_writer[i];
 462         }
 463
 464         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 465                tot_writes);
 466         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 467                 "nr_writers %3u "
 468                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 469                 argv[0], duration, nr_readers, rduration, wduration,
 470                 nr_writers, wdelay, tot_reads, tot_writes,
 471                 tot_reads + tot_writes);
 472         free(tid_reader);
 473         free(tid_writer);
 474         free(count_reader);
 475         free(count_writer);
 476         return 0;
 477 }