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