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
  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
  68 struct test_array {
  69         int a;
  70 };
  71
  72 pthread_rwlock_t lock = PTHREAD_RWLOCK_INITIALIZER;
  73
  74 static volatile int test_go, test_stop;
  75
  76 static unsigned long wdelay;
  77
  78 static volatile struct test_array test_array = { 8 };
  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 unsigned long long __thread nr_writes;
 160 static unsigned long long __thread nr_reads;
 161
 162 static unsigned int nr_readers;
 163 static unsigned int nr_writers;
 164
 165 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
 166
 167 void rcu_copy_mutex_lock(void)
 168 {
 169         int ret;
 170         ret = pthread_mutex_lock(&rcu_copy_mutex);
 171         if (ret) {
 172                 perror("Error in pthread mutex lock");
 173                 exit(-1);
 174         }
 175 }
 176
 177 void rcu_copy_mutex_unlock(void)
 178 {
 179         int ret;
 180
 181         ret = pthread_mutex_unlock(&rcu_copy_mutex);
 182         if (ret) {
 183                 perror("Error in pthread mutex unlock");
 184                 exit(-1);
 185         }
 186 }
 187
 188 void *thr_reader(void *_count)
 189 {
 190         unsigned long long *count = _count;
 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         while (!test_go)
 198         {
 199         }
 200
 201         for (;;) {
 202                 pthread_rwlock_rdlock(&lock);
 203                 assert(test_array.a == 8);
 204                 if (caa_unlikely(rduration))
 205                         loop_sleep(rduration);
 206                 pthread_rwlock_unlock(&lock);
 207                 nr_reads++;
 208                 if (caa_unlikely(!test_duration_read()))
 209                         break;
 210         }
 211
 212         *count = nr_reads;
 213         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 214                         "reader", pthread_self(), (unsigned long)gettid());
 215         return ((void*)1);
 216
 217 }
 218
 219 void *thr_writer(void *_count)
 220 {
 221         unsigned long long *count = _count;
 222
 223         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 224                         "writer", pthread_self(), (unsigned long)gettid());
 225
 226         set_affinity();
 227
 228         while (!test_go)
 229         {
 230         }
 231         cmm_smp_mb();
 232
 233         for (;;) {
 234                 pthread_rwlock_wrlock(&lock);
 235                 test_array.a = 0;
 236                 test_array.a = 8;
 237                 if (caa_unlikely(wduration))
 238                         loop_sleep(wduration);
 239                 pthread_rwlock_unlock(&lock);
 240                 nr_writes++;
 241                 if (caa_unlikely(!test_duration_write()))
 242                         break;
 243                 if (caa_unlikely(wdelay))
 244                         loop_sleep(wdelay);
 245         }
 246
 247         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 248                         "writer", pthread_self(), (unsigned long)gettid());
 249         *count = nr_writes;
 250         return ((void*)2);
 251 }
 252
 253 void show_usage(int argc, char **argv)
 254 {
 255         printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
 256 #ifdef DEBUG_YIELD
 257         printf(" [-r] [-w] (yield reader and/or writer)");
 258 #endif
 259         printf(" [-d delay] (writer period (us))");
 260         printf(" [-c duration] (reader C.S. duration (in loops))");
 261         printf(" [-e duration] (writer C.S. duration (in loops))");
 262         printf(" [-v] (verbose output)");
 263         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 264         printf("\n");
 265 }
 266
 267 int main(int argc, char **argv)
 268 {
 269         int err;
 270         pthread_t *tid_reader, *tid_writer;
 271         void *tret;
 272         unsigned long long *count_reader, *count_writer;
 273         unsigned long long tot_reads = 0, tot_writes = 0;
 274         int i, a;
 275
 276         if (argc < 4) {
 277                 show_usage(argc, argv);
 278                 return -1;
 279         }
 280         cmm_smp_mb();
 281
 282         err = sscanf(argv[1], "%u", &nr_readers);
 283         if (err != 1) {
 284                 show_usage(argc, argv);
 285                 return -1;
 286         }
 287
 288         err = sscanf(argv[2], "%u", &nr_writers);
 289         if (err != 1) {
 290                 show_usage(argc, argv);
 291                 return -1;
 292         }
 293
 294         err = sscanf(argv[3], "%lu", &duration);
 295         if (err != 1) {
 296                 show_usage(argc, argv);
 297                 return -1;
 298         }
 299
 300         for (i = 4; i < argc; i++) {
 301                 if (argv[i][0] != '-')
 302                         continue;
 303                 switch (argv[i][1]) {
 304 #ifdef DEBUG_YIELD
 305                 case 'r':
 306                         yield_active |= YIELD_READ;
 307                         break;
 308                 case 'w':
 309                         yield_active |= YIELD_WRITE;
 310                         break;
 311 #endif
 312                 case 'a':
 313                         if (argc < i + 2) {
 314                                 show_usage(argc, argv);
 315                                 return -1;
 316                         }
 317                         a = atoi(argv[++i]);
 318                         cpu_affinities[next_aff++] = a;
 319                         use_affinity = 1;
 320                         printf_verbose("Adding CPU %d affinity\n", a);
 321                         break;
 322                 case 'c':
 323                         if (argc < i + 2) {
 324                                 show_usage(argc, argv);
 325                                 return -1;
 326                         }
 327                         rduration = atol(argv[++i]);
 328                         break;
 329                 case 'd':
 330                         if (argc < i + 2) {
 331                                 show_usage(argc, argv);
 332                                 return -1;
 333                         }
 334                         wdelay = atol(argv[++i]);
 335                         break;
 336                 case 'e':
 337                         if (argc < i + 2) {
 338                                 show_usage(argc, argv);
 339                                 return -1;
 340                         }
 341                         wduration = atol(argv[++i]);
 342                         break;
 343                 case 'v':
 344                         verbose_mode = 1;
 345                         break;
 346                 }
 347         }
 348
 349         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 350                 duration, nr_readers, nr_writers);
 351         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 352         printf_verbose("Reader duration : %lu loops.\n", rduration);
 353         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 354                         "main", pthread_self(), (unsigned long)gettid());
 355
 356         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 357         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 358         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 359         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 360
 361         next_aff = 0;
 362
 363         for (i = 0; i < nr_readers; i++) {
 364                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 365                                      &count_reader[i]);
 366                 if (err != 0)
 367                         exit(1);
 368         }
 369         for (i = 0; i < nr_writers; i++) {
 370                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 371                                      &count_writer[i]);
 372                 if (err != 0)
 373                         exit(1);
 374         }
 375
 376         cmm_smp_mb();
 377
 378         test_go = 1;
 379
 380         sleep(duration);
 381
 382         test_stop = 1;
 383
 384         for (i = 0; i < nr_readers; i++) {
 385                 err = pthread_join(tid_reader[i], &tret);
 386                 if (err != 0)
 387                         exit(1);
 388                 tot_reads += count_reader[i];
 389         }
 390         for (i = 0; i < nr_writers; i++) {
 391                 err = pthread_join(tid_writer[i], &tret);
 392                 if (err != 0)
 393                         exit(1);
 394                 tot_writes += count_writer[i];
 395         }
 396
 397         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 398                tot_writes);
 399         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 400                 "nr_writers %3u "
 401                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 402                 argv[0], duration, nr_readers, rduration, wduration,
 403                 nr_writers, wdelay, tot_reads, tot_writes,
 404                 tot_reads + tot_writes);
 405
 406         free(tid_reader);
 407         free(tid_writer);
 408         free(count_reader);
 409         free(count_writer);
 410         return 0;
 411 }