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