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