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