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