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