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