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