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