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