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                 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(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         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
 240         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 241                         "writer", pthread_self(), (unsigned long)gettid());
 242
 243         set_affinity();
 244
 245         rcu_defer_register_thread();
 246
 247         while (!test_go)
 248         {
 249         }
 250         smp_mb();
 251
 252         for (;;) {
 253                 new = malloc(sizeof(*new));
 254                 new->a = 8;
 255                 old = rcu_xchg_pointer(&test_rcu_pointer, new);
 256                 if (unlikely(wduration))
 257                         loop_sleep(wduration);
 258                 defer_rcu(free, old);
 259                 defer_rcu(test_cb1, old);
 260                 defer_rcu(test_cb1, (void *)-2L);
 261                 defer_rcu(test_cb1, (void *)-2L);
 262                 defer_rcu(test_cb1, old);
 263                 defer_rcu(test_cb2, (void *)-2L);
 264                 defer_rcu(test_cb2, (void *)-4L);
 265                 defer_rcu(test_cb2, (void *)-2L);
 266                 nr_writes++;
 267                 if (unlikely(!test_duration_write()))
 268                         break;
 269                 if (unlikely(wdelay))
 270                         loop_sleep(wdelay);
 271         }
 272
 273         rcu_defer_unregister_thread();
 274
 275         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 276                         "writer", pthread_self(), (unsigned long)gettid());
 277         tot_nr_writes[wtidx] = nr_writes;
 278         return ((void*)2);
 279 }
 280
 281 void show_usage(int argc, char **argv)
 282 {
 283         printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
 284 #ifdef DEBUG_YIELD
 285         printf(" [-r] [-w] (yield reader and/or writer)");
 286 #endif
 287         printf(" [-d delay] (writer period (us))");
 288         printf(" [-c duration] (reader C.S. duration (in loops))");
 289         printf(" [-e duration] (writer C.S. duration (in loops))");
 290         printf(" [-v] (verbose output)");
 291         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 292         printf("\n");
 293 }
 294
 295 int main(int argc, char **argv)
 296 {
 297         int err;
 298         pthread_t *tid_reader, *tid_writer;
 299         void *tret;
 300         unsigned long long *count_reader;
 301         unsigned long long tot_reads = 0, tot_writes = 0;
 302         int i, a;
 303
 304         if (argc < 4) {
 305                 show_usage(argc, argv);
 306                 return -1;
 307         }
 308
 309         err = sscanf(argv[1], "%u", &nr_readers);
 310         if (err != 1) {
 311                 show_usage(argc, argv);
 312                 return -1;
 313         }
 314
 315         err = sscanf(argv[2], "%u", &nr_writers);
 316         if (err != 1) {
 317                 show_usage(argc, argv);
 318                 return -1;
 319         }
 320
 321         err = sscanf(argv[3], "%lu", &duration);
 322         if (err != 1) {
 323                 show_usage(argc, argv);
 324                 return -1;
 325         }
 326
 327         for (i = 4; i < argc; i++) {
 328                 if (argv[i][0] != '-')
 329                         continue;
 330                 switch (argv[i][1]) {
 331 #ifdef DEBUG_YIELD
 332                 case 'r':
 333                         yield_active |= YIELD_READ;
 334                         break;
 335                 case 'w':
 336                         yield_active |= YIELD_WRITE;
 337                         break;
 338 #endif
 339                 case 'a':
 340                         if (argc < i + 2) {
 341                                 show_usage(argc, argv);
 342                                 return -1;
 343                         }
 344                         a = atoi(argv[++i]);
 345                         cpu_affinities[next_aff++] = a;
 346                         use_affinity = 1;
 347                         printf_verbose("Adding CPU %d affinity\n", a);
 348                         break;
 349                 case 'c':
 350                         if (argc < i + 2) {
 351                                 show_usage(argc, argv);
 352                                 return -1;
 353                         }
 354                         rduration = atol(argv[++i]);
 355                         break;
 356                 case 'd':
 357                         if (argc < i + 2) {
 358                                 show_usage(argc, argv);
 359                                 return -1;
 360                         }
 361                         wdelay = atol(argv[++i]);
 362                         break;
 363                 case 'e':
 364                         if (argc < i + 2) {
 365                                 show_usage(argc, argv);
 366                                 return -1;
 367                         }
 368                         wduration = atol(argv[++i]);
 369                         break;
 370                 case 'v':
 371                         verbose_mode = 1;
 372                         break;
 373                 }
 374         }
 375
 376         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 377                 duration, nr_readers, nr_writers);
 378         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 379         printf_verbose("Reader duration : %lu loops.\n", rduration);
 380         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 381                         "main", pthread_self(), (unsigned long)gettid());
 382
 383         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 384         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 385         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 386         tot_nr_writes = malloc(sizeof(*tot_nr_writes) * nr_writers);
 387
 388         next_aff = 0;
 389
 390         for (i = 0; i < nr_readers; i++) {
 391                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 392                                      &count_reader[i]);
 393                 if (err != 0)
 394                         exit(1);
 395         }
 396         for (i = 0; i < nr_writers; i++) {
 397                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 398                                      (void *)(long)i);
 399                 if (err != 0)
 400                         exit(1);
 401         }
 402
 403         smp_mb();
 404
 405         test_go = 1;
 406
 407         sleep(duration);
 408
 409         test_stop = 1;
 410
 411         for (i = 0; i < nr_readers; i++) {
 412                 err = pthread_join(tid_reader[i], &tret);
 413                 if (err != 0)
 414                         exit(1);
 415                 tot_reads += count_reader[i];
 416         }
 417         for (i = 0; i < nr_writers; i++) {
 418                 err = pthread_join(tid_writer[i], &tret);
 419                 if (err != 0)
 420                         exit(1);
 421                 tot_writes += tot_nr_writes[i];
 422         }
 423
 424         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 425                tot_writes);
 426         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 427                 "nr_writers %3u "
 428                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 429                 argv[0], duration, nr_readers, rduration, wduration,
 430                 nr_writers, wdelay, tot_reads, tot_writes,
 431                 tot_reads + tot_writes);
 432         free(tid_reader);
 433         free(tid_writer);
 434         free(count_reader);
 435         free(tot_nr_writes);
 436
 437         return 0;
 438 }