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         assert(!rcu_read_ongoing());
 191
 192         while (!test_go)
 193         {
 194         }
 195         cmm_smp_mb();
 196
 197         for (;;) {
 198                 rcu_read_lock();
 199                 assert(rcu_read_ongoing());
 200                 local_ptr = rcu_dereference(test_rcu_pointer);
 201                 rcu_debug_yield_read();
 202                 if (local_ptr)
 203                         assert(*local_ptr == 8);
 204                 if (caa_unlikely(rduration))
 205                         loop_sleep(rduration);
 206                 rcu_read_unlock();
 207                 URCU_TLS(nr_reads)++;
 208                 if (caa_unlikely(!test_duration_read()))
 209                         break;
 210         }
 211
 212         rcu_unregister_thread();
 213
 214         /* test extra thread registration */
 215         rcu_register_thread();
 216         rcu_unregister_thread();
 217
 218         *count = URCU_TLS(nr_reads);
 219         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 220                         "reader", (unsigned long) pthread_self(),
 221                         (unsigned long) gettid());
 222         return ((void*)1);
 223
 224 }
 225
 226 void *thr_writer(void *_count)
 227 {
 228         unsigned long long *count = _count;
 229         int *new, *old;
 230
 231         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 232                         "writer", (unsigned long) pthread_self(),
 233                         (unsigned long) gettid());
 234
 235         set_affinity();
 236
 237         while (!test_go)
 238         {
 239         }
 240         cmm_smp_mb();
 241
 242         for (;;) {
 243                 new = malloc(sizeof(int));
 244                 assert(new);
 245                 *new = 8;
 246                 old = rcu_xchg_pointer(&test_rcu_pointer, new);
 247                 if (caa_unlikely(wduration))
 248                         loop_sleep(wduration);
 249                 synchronize_rcu();
 250                 if (old)
 251                         *old = 0;
 252                 free(old);
 253                 URCU_TLS(nr_writes)++;
 254                 if (caa_unlikely(!test_duration_write()))
 255                         break;
 256                 if (caa_unlikely(wdelay))
 257                         loop_sleep(wdelay);
 258         }
 259
 260         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 261                         "writer", (unsigned long) pthread_self(),
 262                         (unsigned long) gettid());
 263         *count = URCU_TLS(nr_writes);
 264         return ((void*)2);
 265 }
 266
 267 void show_usage(int argc, char **argv)
 268 {
 269         printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
 270                 argv[0]);
 271         printf("OPTIONS:\n");
 272 #ifdef DEBUG_YIELD
 273         printf("        [-r] [-w] (yield reader and/or writer)\n");
 274 #endif
 275         printf("        [-d delay] (writer period (us))\n");
 276         printf("        [-c duration] (reader C.S. duration (in loops))\n");
 277         printf("        [-e duration] (writer C.S. duration (in loops))\n");
 278         printf("        [-v] (verbose output)\n");
 279         printf("        [-a cpu#] [-a cpu#]... (affinity)\n");
 280         printf("\n");
 281 }
 282
 283 int main(int argc, char **argv)
 284 {
 285         int err;
 286         pthread_t *tid_reader, *tid_writer;
 287         void *tret;
 288         unsigned long long *count_reader, *count_writer;
 289         unsigned long long tot_reads = 0, tot_writes = 0;
 290         int i, a;
 291
 292         if (argc < 4) {
 293                 show_usage(argc, argv);
 294                 return -1;
 295         }
 296
 297         err = sscanf(argv[1], "%u", &nr_readers);
 298         if (err != 1) {
 299                 show_usage(argc, argv);
 300                 return -1;
 301         }
 302
 303         err = sscanf(argv[2], "%u", &nr_writers);
 304         if (err != 1) {
 305                 show_usage(argc, argv);
 306                 return -1;
 307         }
 308
 309         err = sscanf(argv[3], "%lu", &duration);
 310         if (err != 1) {
 311                 show_usage(argc, argv);
 312                 return -1;
 313         }
 314
 315         for (i = 4; i < argc; i++) {
 316                 if (argv[i][0] != '-')
 317                         continue;
 318                 switch (argv[i][1]) {
 319 #ifdef DEBUG_YIELD
 320                 case 'r':
 321                         rcu_yield_active |= RCU_YIELD_READ;
 322                         break;
 323                 case 'w':
 324                         rcu_yield_active |= RCU_YIELD_WRITE;
 325                         break;
 326 #endif
 327                 case 'a':
 328                         if (argc < i + 2) {
 329                                 show_usage(argc, argv);
 330                                 return -1;
 331                         }
 332                         a = atoi(argv[++i]);
 333                         cpu_affinities[next_aff++] = a;
 334                         use_affinity = 1;
 335                         printf_verbose("Adding CPU %d affinity\n", a);
 336                         break;
 337                 case 'c':
 338                         if (argc < i + 2) {
 339                                 show_usage(argc, argv);
 340                                 return -1;
 341                         }
 342                         rduration = atol(argv[++i]);
 343                         break;
 344                 case 'd':
 345                         if (argc < i + 2) {
 346                                 show_usage(argc, argv);
 347                                 return -1;
 348                         }
 349                         wdelay = atol(argv[++i]);
 350                         break;
 351                 case 'e':
 352                         if (argc < i + 2) {
 353                                 show_usage(argc, argv);
 354                                 return -1;
 355                         }
 356                         wduration = atol(argv[++i]);
 357                         break;
 358                 case 'v':
 359                         verbose_mode = 1;
 360                         break;
 361                 }
 362         }
 363
 364         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 365                 duration, nr_readers, nr_writers);
 366         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 367         printf_verbose("Reader duration : %lu loops.\n", rduration);
 368         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 369                         "main", (unsigned long) pthread_self(),
 370                         (unsigned long)gettid());
 371
 372         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 373         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 374         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 375         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 376
 377         next_aff = 0;
 378
 379         for (i = 0; i < nr_readers; i++) {
 380                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 381                                      &count_reader[i]);
 382                 if (err != 0)
 383                         exit(1);
 384         }
 385         for (i = 0; i < nr_writers; i++) {
 386                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 387                                      &count_writer[i]);
 388                 if (err != 0)
 389                         exit(1);
 390         }
 391
 392         cmm_smp_mb();
 393
 394         test_go = 1;
 395
 396         sleep(duration);
 397
 398         test_stop = 1;
 399
 400         for (i = 0; i < nr_readers; i++) {
 401                 err = pthread_join(tid_reader[i], &tret);
 402                 if (err != 0)
 403                         exit(1);
 404                 tot_reads += count_reader[i];
 405         }
 406         for (i = 0; i < nr_writers; i++) {
 407                 err = pthread_join(tid_writer[i], &tret);
 408                 if (err != 0)
 409                         exit(1);
 410                 tot_writes += count_writer[i];
 411         }
 412
 413         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 414                tot_writes);
 415         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 416                 "nr_writers %3u "
 417                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 418                 argv[0], duration, nr_readers, rduration, wduration,
 419                 nr_writers, wdelay, tot_reads, tot_writes,
 420                 tot_reads + tot_writes);
 421         free(test_rcu_pointer);
 422         free(tid_reader);
 423         free(tid_writer);
 424         free(count_reader);
 425         free(count_writer);
 426         return 0;
 427 }