tests/test_urcu.c

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