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