tests/test_rwlock.c

   1 /*
   2  * test_urcu.c
   3  *
   4  * Userspace RCU library - test program
   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
  69 struct test_array {
  70         int a;
  71 };
  72
  73 pthread_rwlock_t lock = PTHREAD_RWLOCK_INITIALIZER;
  74
  75 static volatile int test_go, test_stop;
  76
  77 static unsigned long wdelay;
  78
  79 static volatile struct test_array test_array = { 8 };
  80
  81 static unsigned long duration;
  82
  83 /* read-side C.S. duration, in loops */
  84 static unsigned long rduration;
  85
  86 /* write-side C.S. duration, in loops */
  87 static unsigned long wduration;
  88
  89 static inline void loop_sleep(unsigned long loops)
  90 {
  91         while (loops-- != 0)
  92                 caa_cpu_relax();
  93 }
  94
  95 static int verbose_mode;
  96
  97 #define printf_verbose(fmt, args...)            \
  98         do {                                    \
  99                 if (verbose_mode)               \
 100                         printf(fmt, args);      \
 101         } while (0)
 102
 103 static unsigned int cpu_affinities[NR_CPUS];
 104 static unsigned int next_aff = 0;
 105 static int use_affinity = 0;
 106
 107 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
 108
 109 #ifndef HAVE_CPU_SET_T
 110 typedef unsigned long cpu_set_t;
 111 # define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
 112 # define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
 113 #endif
 114
 115 static void set_affinity(void)
 116 {
 117 #if HAVE_SCHED_SETAFFINITY
 118         cpu_set_t mask;
 119         int cpu, ret;
 120 #endif /* HAVE_SCHED_SETAFFINITY */
 121
 122         if (!use_affinity)
 123                 return;
 124
 125 #if HAVE_SCHED_SETAFFINITY
 126         ret = pthread_mutex_lock(&affinity_mutex);
 127         if (ret) {
 128                 perror("Error in pthread mutex lock");
 129                 exit(-1);
 130         }
 131         cpu = cpu_affinities[next_aff++];
 132         ret = pthread_mutex_unlock(&affinity_mutex);
 133         if (ret) {
 134                 perror("Error in pthread mutex unlock");
 135                 exit(-1);
 136         }
 137
 138         CPU_ZERO(&mask);
 139         CPU_SET(cpu, &mask);
 140 #if SCHED_SETAFFINITY_ARGS == 2
 141         sched_setaffinity(0, &mask);
 142 #else
 143         sched_setaffinity(0, sizeof(mask), &mask);
 144 #endif
 145 #endif /* HAVE_SCHED_SETAFFINITY */
 146 }
 147
 148 /*
 149  * returns 0 if test should end.
 150  */
 151 static int test_duration_write(void)
 152 {
 153         return !test_stop;
 154 }
 155
 156 static int test_duration_read(void)
 157 {
 158         return !test_stop;
 159 }
 160
 161 static DEFINE_URCU_TLS(unsigned long long, nr_writes);
 162 static DEFINE_URCU_TLS(unsigned long long, nr_reads);
 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
 194         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 195                         "reader", pthread_self(), (unsigned long)gettid());
 196
 197         set_affinity();
 198
 199         while (!test_go)
 200         {
 201         }
 202
 203         for (;;) {
 204                 pthread_rwlock_rdlock(&lock);
 205                 assert(test_array.a == 8);
 206                 if (caa_unlikely(rduration))
 207                         loop_sleep(rduration);
 208                 pthread_rwlock_unlock(&lock);
 209                 URCU_TLS(nr_reads)++;
 210                 if (caa_unlikely(!test_duration_read()))
 211                         break;
 212         }
 213
 214         *count = URCU_TLS(nr_reads);
 215         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 216                         "reader", pthread_self(), (unsigned long)gettid());
 217         return ((void*)1);
 218
 219 }
 220
 221 void *thr_writer(void *_count)
 222 {
 223         unsigned long long *count = _count;
 224
 225         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 226                         "writer", pthread_self(), (unsigned long)gettid());
 227
 228         set_affinity();
 229
 230         while (!test_go)
 231         {
 232         }
 233         cmm_smp_mb();
 234
 235         for (;;) {
 236                 pthread_rwlock_wrlock(&lock);
 237                 test_array.a = 0;
 238                 test_array.a = 8;
 239                 if (caa_unlikely(wduration))
 240                         loop_sleep(wduration);
 241                 pthread_rwlock_unlock(&lock);
 242                 URCU_TLS(nr_writes)++;
 243                 if (caa_unlikely(!test_duration_write()))
 244                         break;
 245                 if (caa_unlikely(wdelay))
 246                         loop_sleep(wdelay);
 247         }
 248
 249         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 250                         "writer", pthread_self(), (unsigned long)gettid());
 251         *count = URCU_TLS(nr_writes);
 252         return ((void*)2);
 253 }
 254
 255 void show_usage(int argc, char **argv)
 256 {
 257         printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
 258 #ifdef DEBUG_YIELD
 259         printf(" [-r] [-w] (yield reader and/or writer)");
 260 #endif
 261         printf(" [-d delay] (writer period (us))");
 262         printf(" [-c duration] (reader C.S. duration (in loops))");
 263         printf(" [-e duration] (writer C.S. duration (in loops))");
 264         printf(" [-v] (verbose output)");
 265         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 266         printf("\n");
 267 }
 268
 269 int main(int argc, char **argv)
 270 {
 271         int err;
 272         pthread_t *tid_reader, *tid_writer;
 273         void *tret;
 274         unsigned long long *count_reader, *count_writer;
 275         unsigned long long tot_reads = 0, tot_writes = 0;
 276         int i, a;
 277
 278         if (argc < 4) {
 279                 show_usage(argc, argv);
 280                 return -1;
 281         }
 282         cmm_smp_mb();
 283
 284         err = sscanf(argv[1], "%u", &nr_readers);
 285         if (err != 1) {
 286                 show_usage(argc, argv);
 287                 return -1;
 288         }
 289
 290         err = sscanf(argv[2], "%u", &nr_writers);
 291         if (err != 1) {
 292                 show_usage(argc, argv);
 293                 return -1;
 294         }
 295
 296         err = sscanf(argv[3], "%lu", &duration);
 297         if (err != 1) {
 298                 show_usage(argc, argv);
 299                 return -1;
 300         }
 301
 302         for (i = 4; i < argc; i++) {
 303                 if (argv[i][0] != '-')
 304                         continue;
 305                 switch (argv[i][1]) {
 306 #ifdef DEBUG_YIELD
 307                 case 'r':
 308                         yield_active |= YIELD_READ;
 309                         break;
 310                 case 'w':
 311                         yield_active |= YIELD_WRITE;
 312                         break;
 313 #endif
 314                 case 'a':
 315                         if (argc < i + 2) {
 316                                 show_usage(argc, argv);
 317                                 return -1;
 318                         }
 319                         a = atoi(argv[++i]);
 320                         cpu_affinities[next_aff++] = a;
 321                         use_affinity = 1;
 322                         printf_verbose("Adding CPU %d affinity\n", a);
 323                         break;
 324                 case 'c':
 325                         if (argc < i + 2) {
 326                                 show_usage(argc, argv);
 327                                 return -1;
 328                         }
 329                         rduration = atol(argv[++i]);
 330                         break;
 331                 case 'd':
 332                         if (argc < i + 2) {
 333                                 show_usage(argc, argv);
 334                                 return -1;
 335                         }
 336                         wdelay = atol(argv[++i]);
 337                         break;
 338                 case 'e':
 339                         if (argc < i + 2) {
 340                                 show_usage(argc, argv);
 341                                 return -1;
 342                         }
 343                         wduration = atol(argv[++i]);
 344                         break;
 345                 case 'v':
 346                         verbose_mode = 1;
 347                         break;
 348                 }
 349         }
 350
 351         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 352                 duration, nr_readers, nr_writers);
 353         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 354         printf_verbose("Reader duration : %lu loops.\n", rduration);
 355         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 356                         "main", pthread_self(), (unsigned long)gettid());
 357
 358         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 359         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 360         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 361         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 362
 363         next_aff = 0;
 364
 365         for (i = 0; i < nr_readers; i++) {
 366                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 367                                      &count_reader[i]);
 368                 if (err != 0)
 369                         exit(1);
 370         }
 371         for (i = 0; i < nr_writers; i++) {
 372                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 373                                      &count_writer[i]);
 374                 if (err != 0)
 375                         exit(1);
 376         }
 377
 378         cmm_smp_mb();
 379
 380         test_go = 1;
 381
 382         sleep(duration);
 383
 384         test_stop = 1;
 385
 386         for (i = 0; i < nr_readers; i++) {
 387                 err = pthread_join(tid_reader[i], &tret);
 388                 if (err != 0)
 389                         exit(1);
 390                 tot_reads += count_reader[i];
 391         }
 392         for (i = 0; i < nr_writers; i++) {
 393                 err = pthread_join(tid_writer[i], &tret);
 394                 if (err != 0)
 395                         exit(1);
 396                 tot_writes += count_writer[i];
 397         }
 398
 399         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 400                tot_writes);
 401         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 402                 "nr_writers %3u "
 403                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 404                 argv[0], duration, nr_readers, rduration, wduration,
 405                 nr_writers, wdelay, tot_reads, tot_writes,
 406                 tot_reads + tot_writes);
 407
 408         free(tid_reader);
 409         free(tid_writer);
 410         free(count_reader);
 411         free(count_writer);
 412         return 0;
 413 }