tests/benchmark/test_urcu.c

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