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