tests/benchmark/test_urcu_defer.c

   1 /*
   2  * test_urcu_defer.c
   3  *
   4  * Userspace RCU library - test program (with automatic reclamation)
   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 #include <urcu-defer.h>
  47
  48 struct test_array {
  49         int a;
  50 };
  51
  52 static volatile int test_go, test_stop;
  53
  54 static unsigned long wdelay;
  55
  56 static struct test_array *test_rcu_pointer;
  57
  58 static unsigned long duration;
  59
  60 /* read-side C.S. duration, in loops */
  61 static unsigned long rduration;
  62
  63 /* write-side C.S. duration, in loops */
  64 static unsigned long wduration;
  65
  66 static inline void loop_sleep(unsigned long loops)
  67 {
  68         while (loops-- != 0)
  69                 caa_cpu_relax();
  70 }
  71
  72 static int verbose_mode;
  73
  74 #define printf_verbose(fmt, args...)            \
  75         do {                                    \
  76                 if (verbose_mode)               \
  77                         printf(fmt, args);      \
  78         } while (0)
  79
  80 static unsigned int cpu_affinities[NR_CPUS];
  81 static unsigned int next_aff = 0;
  82 static int use_affinity = 0;
  83
  84 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
  85
  86 static void set_affinity(void)
  87 {
  88 #ifdef HAVE_SCHED_SETAFFINITY
  89         cpu_set_t mask;
  90         int cpu, ret;
  91 #endif /* HAVE_SCHED_SETAFFINITY */
  92
  93         if (!use_affinity)
  94                 return;
  95
  96 #ifdef HAVE_SCHED_SETAFFINITY
  97         ret = pthread_mutex_lock(&affinity_mutex);
  98         if (ret) {
  99                 perror("Error in pthread mutex lock");
 100                 exit(-1);
 101         }
 102         cpu = cpu_affinities[next_aff++];
 103         ret = pthread_mutex_unlock(&affinity_mutex);
 104         if (ret) {
 105                 perror("Error in pthread mutex unlock");
 106                 exit(-1);
 107         }
 108
 109         CPU_ZERO(&mask);
 110         CPU_SET(cpu, &mask);
 111         sched_setaffinity(0, sizeof(mask), &mask);
 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
 132 unsigned long long __attribute__((aligned(CAA_CACHE_LINE_SIZE))) *tot_nr_writes;
 133
 134 static unsigned int nr_readers;
 135 static unsigned int nr_writers;
 136
 137 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
 138
 139 static
 140 void *thr_reader(void *_count)
 141 {
 142         unsigned long long *count = _count;
 143         struct test_array *local_ptr;
 144
 145         printf_verbose("thread_begin %s, tid %lu\n",
 146                         "reader", urcu_get_thread_id());
 147
 148         set_affinity();
 149
 150         rcu_register_thread();
 151
 152         while (!test_go)
 153         {
 154         }
 155         cmm_smp_mb();
 156
 157         for (;;) {
 158                 rcu_read_lock();
 159                 local_ptr = rcu_dereference(test_rcu_pointer);
 160                 rcu_debug_yield_read();
 161                 if (local_ptr)
 162                         assert(local_ptr->a == 8);
 163                 if (caa_unlikely(rduration))
 164                         loop_sleep(rduration);
 165                 rcu_read_unlock();
 166                 URCU_TLS(nr_reads)++;
 167                 if (caa_unlikely(!test_duration_read()))
 168                         break;
 169         }
 170
 171         rcu_unregister_thread();
 172
 173         *count = URCU_TLS(nr_reads);
 174         printf_verbose("thread_end %s, tid %lu\n",
 175                         "reader", urcu_get_thread_id());
 176         return ((void*)1);
 177
 178 }
 179
 180 static void test_cb2(void *data __attribute__((unused)))
 181 {
 182 }
 183
 184 static void test_cb1(void *data __attribute__((unused)))
 185 {
 186 }
 187
 188 static
 189 void *thr_writer(void *data)
 190 {
 191         unsigned long wtidx = (unsigned long)data;
 192         struct test_array *new, *old = NULL;
 193         int ret;
 194
 195         printf_verbose("thread_begin %s, tid %lu\n",
 196                         "writer", urcu_get_thread_id());
 197
 198         set_affinity();
 199
 200         ret = rcu_defer_register_thread();
 201         if (ret) {
 202                 printf("Error in rcu_defer_register_thread\n");
 203                 exit(-1);
 204         }
 205
 206         while (!test_go)
 207         {
 208         }
 209         cmm_smp_mb();
 210
 211         for (;;) {
 212                 new = malloc(sizeof(*new));
 213                 new->a = 8;
 214                 old = rcu_xchg_pointer(&test_rcu_pointer, new);
 215                 if (caa_unlikely(wduration))
 216                         loop_sleep(wduration);
 217                 defer_rcu(free, old);
 218                 defer_rcu(test_cb1, old);
 219                 defer_rcu(test_cb1, (void *)-2L);
 220                 defer_rcu(test_cb1, (void *)-2L);
 221                 defer_rcu(test_cb1, old);
 222                 defer_rcu(test_cb2, (void *)-2L);
 223                 defer_rcu(test_cb2, (void *)-4L);
 224                 defer_rcu(test_cb2, (void *)-2L);
 225                 URCU_TLS(nr_writes)++;
 226                 if (caa_unlikely(!test_duration_write()))
 227                         break;
 228                 if (caa_unlikely(wdelay))
 229                         loop_sleep(wdelay);
 230         }
 231
 232         rcu_defer_unregister_thread();
 233
 234         printf_verbose("thread_end %s, tid %lu\n",
 235                         "writer", urcu_get_thread_id());
 236         tot_nr_writes[wtidx] = URCU_TLS(nr_writes);
 237         return ((void*)2);
 238 }
 239
 240 static
 241 void show_usage(char **argv)
 242 {
 243         printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
 244                 argv[0]);
 245         printf("OPTIONS:\n");
 246         printf("        [-r] [-w] (yield reader and/or writer)\n");
 247         printf("        [-d delay] (writer period (us))\n");
 248         printf("        [-c duration] (reader C.S. duration (in loops))\n");
 249         printf("        [-e duration] (writer C.S. duration (in loops))\n");
 250         printf("        [-v] (verbose output)\n");
 251         printf("        [-a cpu#] [-a cpu#]... (affinity)\n");
 252         printf("\n");
 253 }
 254
 255 int main(int argc, char **argv)
 256 {
 257         int err;
 258         pthread_t *tid_reader, *tid_writer;
 259         void *tret;
 260         unsigned long long *count_reader;
 261         unsigned long long tot_reads = 0, tot_writes = 0;
 262         int i, a;
 263         unsigned int i_thr;
 264
 265         if (argc < 4) {
 266                 show_usage(argv);
 267                 return -1;
 268         }
 269
 270         err = sscanf(argv[1], "%u", &nr_readers);
 271         if (err != 1) {
 272                 show_usage(argv);
 273                 return -1;
 274         }
 275
 276         err = sscanf(argv[2], "%u", &nr_writers);
 277         if (err != 1) {
 278                 show_usage(argv);
 279                 return -1;
 280         }
 281
 282         err = sscanf(argv[3], "%lu", &duration);
 283         if (err != 1) {
 284                 show_usage(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(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(argv);
 311                                 return -1;
 312                         }
 313                         rduration = atol(argv[++i]);
 314                         break;
 315                 case 'd':
 316                         if (argc < i + 2) {
 317                                 show_usage(argv);
 318                                 return -1;
 319                         }
 320                         wdelay = atol(argv[++i]);
 321                         break;
 322                 case 'e':
 323                         if (argc < i + 2) {
 324                                 show_usage(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         tot_nr_writes = calloc(nr_writers, sizeof(*tot_nr_writes));
 346
 347         next_aff = 0;
 348
 349         for (i_thr = 0; i_thr < nr_readers; i_thr++) {
 350                 err = pthread_create(&tid_reader[i_thr], NULL, thr_reader,
 351                                      &count_reader[i_thr]);
 352                 if (err != 0)
 353                         exit(1);
 354         }
 355         for (i_thr = 0; i_thr < nr_writers; i_thr++) {
 356                 err = pthread_create(&tid_writer[i_thr], NULL, thr_writer,
 357                                      (void *)(long)i_thr);
 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_thr = 0; i_thr < nr_readers; i_thr++) {
 371                 err = pthread_join(tid_reader[i_thr], &tret);
 372                 if (err != 0)
 373                         exit(1);
 374                 tot_reads += count_reader[i_thr];
 375         }
 376         for (i_thr = 0; i_thr < nr_writers; i_thr++) {
 377                 err = pthread_join(tid_writer[i_thr], &tret);
 378                 if (err != 0)
 379                         exit(1);
 380                 tot_writes += tot_nr_writes[i_thr];
 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(tid_reader);
 392         free(tid_writer);
 393         free(count_reader);
 394         free(tot_nr_writes);
 395
 396         return 0;
 397 }