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