tests/benchmark/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 #include <stdio.h>
  24 #include <pthread.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <sys/types.h>
  28 #include <sys/wait.h>
  29 #include <unistd.h>
  30 #include <stdio.h>
  31 #include <assert.h>
  32 #include <errno.h>
  33
  34 #include <urcu/arch.h>
  35 #include <urcu/tls-compat.h>
  36 #include "thread-id.h"
  37 #include "../common/debug-yield.h"
  38
  39 /* hardcoded number of CPUs */
  40 #define NR_CPUS 16384
  41
  42 #ifndef DYNAMIC_LINK_TEST
  43 #define _LGPL_SOURCE
  44 #endif
  45 #include "urcu-qsbr.h"
  46
  47 static volatile int test_go, test_stop;
  48
  49 static unsigned long wdelay;
  50
  51 static int *test_rcu_pointer;
  52
  53 static unsigned long duration;
  54
  55 /* read-side C.S. duration, in loops */
  56 static unsigned long rduration;
  57
  58 /* write-side C.S. duration, in loops */
  59 static unsigned long wduration;
  60
  61 static inline void loop_sleep(unsigned long loops)
  62 {
  63         while (loops-- != 0)
  64                 caa_cpu_relax();
  65 }
  66
  67 static int verbose_mode;
  68
  69 #define printf_verbose(fmt, args...)            \
  70         do {                                    \
  71                 if (verbose_mode)               \
  72                         printf(fmt, args);      \
  73         } while (0)
  74
  75 static unsigned int cpu_affinities[NR_CPUS];
  76 static unsigned int next_aff = 0;
  77 static int use_affinity = 0;
  78
  79 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
  80
  81 static void set_affinity(void)
  82 {
  83 #if HAVE_SCHED_SETAFFINITY
  84         cpu_set_t mask;
  85         int cpu, ret;
  86 #endif /* HAVE_SCHED_SETAFFINITY */
  87
  88         if (!use_affinity)
  89                 return;
  90
  91 #if HAVE_SCHED_SETAFFINITY
  92         ret = pthread_mutex_lock(&affinity_mutex);
  93         if (ret) {
  94                 perror("Error in pthread mutex lock");
  95                 exit(-1);
  96         }
  97         cpu = cpu_affinities[next_aff++];
  98         ret = pthread_mutex_unlock(&affinity_mutex);
  99         if (ret) {
 100                 perror("Error in pthread mutex unlock");
 101                 exit(-1);
 102         }
 103         CPU_ZERO(&mask);
 104         CPU_SET(cpu, &mask);
 105         sched_setaffinity(0, sizeof(mask), &mask);
 106 #endif /* HAVE_SCHED_SETAFFINITY */
 107 }
 108
 109 /*
 110  * returns 0 if test should end.
 111  */
 112 static int test_duration_write(void)
 113 {
 114         return !test_stop;
 115 }
 116
 117 static int test_duration_read(void)
 118 {
 119         return !test_stop;
 120 }
 121
 122 static DEFINE_URCU_TLS(unsigned long long, nr_writes);
 123 static DEFINE_URCU_TLS(unsigned long long, nr_reads);
 124
 125 static unsigned int nr_readers;
 126 static unsigned int nr_writers;
 127
 128 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
 129
 130 void rcu_copy_mutex_lock(void)
 131 {
 132         int ret;
 133         ret = pthread_mutex_lock(&rcu_copy_mutex);
 134         if (ret) {
 135                 perror("Error in pthread mutex lock");
 136                 exit(-1);
 137         }
 138 }
 139
 140 void rcu_copy_mutex_unlock(void)
 141 {
 142         int ret;
 143
 144         ret = pthread_mutex_unlock(&rcu_copy_mutex);
 145         if (ret) {
 146                 perror("Error in pthread mutex unlock");
 147                 exit(-1);
 148         }
 149 }
 150
 151 void *thr_reader(void *_count)
 152 {
 153         unsigned long long *count = _count;
 154         int *local_ptr;
 155
 156         printf_verbose("thread_begin %s, tid %lu\n",
 157                         "reader", urcu_get_thread_id());
 158
 159         set_affinity();
 160
 161         rcu_register_thread();
 162
 163         assert(rcu_read_ongoing());
 164         rcu_thread_offline();
 165         assert(!rcu_read_ongoing());
 166         rcu_thread_online();
 167
 168         while (!test_go)
 169         {
 170         }
 171         cmm_smp_mb();
 172
 173         for (;;) {
 174                 rcu_read_lock();
 175                 assert(rcu_read_ongoing());
 176                 local_ptr = rcu_dereference(test_rcu_pointer);
 177                 rcu_debug_yield_read();
 178                 if (local_ptr)
 179                         assert(*local_ptr == 8);
 180                 if (caa_unlikely(rduration))
 181                         loop_sleep(rduration);
 182                 rcu_read_unlock();
 183                 URCU_TLS(nr_reads)++;
 184                 /* QS each 1024 reads */
 185                 if (caa_unlikely((URCU_TLS(nr_reads) & ((1 << 10) - 1)) == 0))
 186                         rcu_quiescent_state();
 187                 if (caa_unlikely(!test_duration_read()))
 188                         break;
 189         }
 190
 191         rcu_unregister_thread();
 192
 193         /* test extra thread registration */
 194         rcu_register_thread();
 195         rcu_unregister_thread();
 196
 197         *count = URCU_TLS(nr_reads);
 198         printf_verbose("thread_end %s, tid %lu\n",
 199                         "reader", urcu_get_thread_id());
 200         return ((void*)1);
 201
 202 }
 203
 204 void *thr_writer(void *_count)
 205 {
 206         unsigned long long *count = _count;
 207         int *new, *old;
 208
 209         printf_verbose("thread_begin %s, tid %lu\n",
 210                         "writer", urcu_get_thread_id());
 211
 212         set_affinity();
 213
 214         while (!test_go)
 215         {
 216         }
 217         cmm_smp_mb();
 218
 219         for (;;) {
 220                 new = malloc(sizeof(int));
 221                 assert(new);
 222                 *new = 8;
 223                 old = rcu_xchg_pointer(&test_rcu_pointer, new);
 224                 if (caa_unlikely(wduration))
 225                         loop_sleep(wduration);
 226                 synchronize_rcu();
 227                 if (old)
 228                         *old = 0;
 229                 free(old);
 230                 URCU_TLS(nr_writes)++;
 231                 if (caa_unlikely(!test_duration_write()))
 232                         break;
 233                 if (caa_unlikely(wdelay))
 234                         loop_sleep(wdelay);
 235         }
 236
 237         printf_verbose("thread_end %s, tid %lu\n",
 238                         "writer", urcu_get_thread_id());
 239         *count = URCU_TLS(nr_writes);
 240         return ((void*)2);
 241 }
 242
 243 void show_usage(int argc, char **argv)
 244 {
 245         printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
 246                 argv[0]);
 247         printf("OPTIONS:\n");
 248         printf("        [-r] [-w] (yield reader and/or writer)\n");
 249         printf("        [-d delay] (writer period (us))\n");
 250         printf("        [-c duration] (reader C.S. duration (in loops))\n");
 251         printf("        [-e duration] (writer C.S. duration (in loops))\n");
 252         printf("        [-v] (verbose output)\n");
 253         printf("        [-a cpu#] [-a cpu#]... (affinity)\n");
 254         printf("\n");
 255 }
 256
 257 int main(int argc, char **argv)
 258 {
 259         int err;
 260         pthread_t *tid_reader, *tid_writer;
 261         void *tret;
 262         unsigned long long *count_reader, *count_writer;
 263         unsigned long long tot_reads = 0, tot_writes = 0;
 264         int i, a;
 265         unsigned int i_thr;
 266
 267         if (argc < 4) {
 268                 show_usage(argc, argv);
 269                 return -1;
 270         }
 271
 272         err = sscanf(argv[1], "%u", &nr_readers);
 273         if (err != 1) {
 274                 show_usage(argc, argv);
 275                 return -1;
 276         }
 277
 278         err = sscanf(argv[2], "%u", &nr_writers);
 279         if (err != 1) {
 280                 show_usage(argc, argv);
 281                 return -1;
 282         }
 283
 284         err = sscanf(argv[3], "%lu", &duration);
 285         if (err != 1) {
 286                 show_usage(argc, argv);
 287                 return -1;
 288         }
 289
 290         for (i = 4; i < argc; i++) {
 291                 if (argv[i][0] != '-')
 292                         continue;
 293                 switch (argv[i][1]) {
 294                 case 'r':
 295                         rcu_debug_yield_enable(RCU_YIELD_READ);
 296                         break;
 297                 case 'w':
 298                         rcu_debug_yield_enable(RCU_YIELD_WRITE);
 299                         break;
 300                 case 'a':
 301                         if (argc < i + 2) {
 302                                 show_usage(argc, argv);
 303                                 return -1;
 304                         }
 305                         a = atoi(argv[++i]);
 306                         cpu_affinities[next_aff++] = a;
 307                         use_affinity = 1;
 308                         printf_verbose("Adding CPU %d affinity\n", a);
 309                         break;
 310                 case 'c':
 311                         if (argc < i + 2) {
 312                                 show_usage(argc, argv);
 313                                 return -1;
 314                         }
 315                         rduration = atol(argv[++i]);
 316                         break;
 317                 case 'd':
 318                         if (argc < i + 2) {
 319                                 show_usage(argc, argv);
 320                                 return -1;
 321                         }
 322                         wdelay = atol(argv[++i]);
 323                         break;
 324                 case 'e':
 325                         if (argc < i + 2) {
 326                                 show_usage(argc, argv);
 327                                 return -1;
 328                         }
 329                         wduration = atol(argv[++i]);
 330                         break;
 331                 case 'v':
 332                         verbose_mode = 1;
 333                         break;
 334                 }
 335         }
 336
 337         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 338                 duration, nr_readers, nr_writers);
 339         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 340         printf_verbose("Reader duration : %lu loops.\n", rduration);
 341         printf_verbose("thread %-6s, tid %lu\n",
 342                         "main", urcu_get_thread_id());
 343
 344         tid_reader = calloc(nr_readers, sizeof(*tid_reader));
 345         tid_writer = calloc(nr_writers, sizeof(*tid_writer));
 346         count_reader = calloc(nr_readers, sizeof(*count_reader));
 347         count_writer = calloc(nr_writers, sizeof(*count_writer));
 348
 349         next_aff = 0;
 350
 351         for (i_thr = 0; i_thr < nr_readers; i_thr++) {
 352                 err = pthread_create(&tid_reader[i_thr], NULL, thr_reader,
 353                                      &count_reader[i_thr]);
 354                 if (err != 0)
 355                         exit(1);
 356         }
 357         for (i_thr = 0; i_thr < nr_writers; i_thr++) {
 358                 err = pthread_create(&tid_writer[i_thr], NULL, thr_writer,
 359                                      &count_writer[i_thr]);
 360                 if (err != 0)
 361                         exit(1);
 362         }
 363
 364         cmm_smp_mb();
 365
 366         test_go = 1;
 367
 368         sleep(duration);
 369
 370         test_stop = 1;
 371
 372         for (i_thr = 0; i_thr < nr_readers; i_thr++) {
 373                 err = pthread_join(tid_reader[i_thr], &tret);
 374                 if (err != 0)
 375                         exit(1);
 376                 tot_reads += count_reader[i_thr];
 377         }
 378         for (i_thr = 0; i_thr < nr_writers; i_thr++) {
 379                 err = pthread_join(tid_writer[i_thr], &tret);
 380                 if (err != 0)
 381                         exit(1);
 382                 tot_writes += count_writer[i_thr];
 383         }
 384
 385         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 386                tot_writes);
 387         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 388                 "nr_writers %3u "
 389                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 390                 argv[0], duration, nr_readers, rduration, wduration,
 391                 nr_writers, wdelay, tot_reads, tot_writes,
 392                 tot_reads + tot_writes);
 393         free(test_rcu_pointer);
 394         free(tid_reader);
 395         free(tid_writer);
 396         free(count_reader);
 397         free(count_writer);
 398         return 0;
 399 }