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