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