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