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