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