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