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 <errno.h>
  35
  36 #include <urcu/arch.h>
  37 #include <urcu/tls-compat.h>
  38 #include "cpuset.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 static void set_affinity(void)
 110 {
 111 #if HAVE_SCHED_SETAFFINITY
 112         cpu_set_t mask;
 113         int cpu, ret;
 114 #endif /* HAVE_SCHED_SETAFFINITY */
 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 DEFINE_URCU_TLS(unsigned long long, nr_writes);
 156 static DEFINE_URCU_TLS(unsigned long long, nr_reads);
 157
 158 static unsigned int nr_readers;
 159 static unsigned int nr_writers;
 160
 161 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
 162
 163 void rcu_copy_mutex_lock(void)
 164 {
 165         int ret;
 166         ret = pthread_mutex_lock(&rcu_copy_mutex);
 167         if (ret) {
 168                 perror("Error in pthread mutex lock");
 169                 exit(-1);
 170         }
 171 }
 172
 173 void rcu_copy_mutex_unlock(void)
 174 {
 175         int ret;
 176
 177         ret = pthread_mutex_unlock(&rcu_copy_mutex);
 178         if (ret) {
 179                 perror("Error in pthread mutex unlock");
 180                 exit(-1);
 181         }
 182 }
 183
 184 void *thr_reader(void *_count)
 185 {
 186         unsigned long long *count = _count;
 187
 188         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 189                         "reader", (unsigned long) pthread_self(),
 190                         (unsigned long) gettid());
 191
 192         set_affinity();
 193
 194         while (!test_go)
 195         {
 196         }
 197
 198         for (;;) {
 199                 pthread_rwlock_rdlock(&lock);
 200                 assert(test_array.a == 8);
 201                 if (caa_unlikely(rduration))
 202                         loop_sleep(rduration);
 203                 pthread_rwlock_unlock(&lock);
 204                 URCU_TLS(nr_reads)++;
 205                 if (caa_unlikely(!test_duration_read()))
 206                         break;
 207         }
 208
 209         *count = URCU_TLS(nr_reads);
 210         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 211                         "reader", (unsigned long) pthread_self(),
 212                         (unsigned long) gettid());
 213         return ((void*)1);
 214
 215 }
 216
 217 void *thr_writer(void *_count)
 218 {
 219         unsigned long long *count = _count;
 220
 221         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 222                         "writer", (unsigned long) pthread_self(),
 223                         (unsigned long) gettid());
 224
 225         set_affinity();
 226
 227         while (!test_go)
 228         {
 229         }
 230         cmm_smp_mb();
 231
 232         for (;;) {
 233                 pthread_rwlock_wrlock(&lock);
 234                 test_array.a = 0;
 235                 test_array.a = 8;
 236                 if (caa_unlikely(wduration))
 237                         loop_sleep(wduration);
 238                 pthread_rwlock_unlock(&lock);
 239                 URCU_TLS(nr_writes)++;
 240                 if (caa_unlikely(!test_duration_write()))
 241                         break;
 242                 if (caa_unlikely(wdelay))
 243                         loop_sleep(wdelay);
 244         }
 245
 246         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 247                         "writer", (unsigned long) pthread_self(),
 248                         (unsigned long) gettid());
 249         *count = URCU_TLS(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) <OPTIONS>\n",
 256                 argv[0]);
 257         printf("OPTIONS:\n");
 258 #ifdef DEBUG_YIELD
 259         printf("        [-r] [-w] (yield reader and/or writer)\n");
 260 #endif
 261         printf("        [-d delay] (writer period (us))\n");
 262         printf("        [-c duration] (reader C.S. duration (in loops))\n");
 263         printf("        [-e duration] (writer C.S. duration (in loops))\n");
 264         printf("        [-v] (verbose output)\n");
 265         printf("        [-a cpu#] [-a cpu#]... (affinity)\n");
 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", (unsigned long) pthread_self(),
 357                         (unsigned long) gettid());
 358
 359         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 360         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 361         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 362         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 363
 364         next_aff = 0;
 365
 366         for (i = 0; i < nr_readers; i++) {
 367                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 368                                      &count_reader[i]);
 369                 if (err != 0)
 370                         exit(1);
 371         }
 372         for (i = 0; i < nr_writers; i++) {
 373                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 374                                      &count_writer[i]);
 375                 if (err != 0)
 376                         exit(1);
 377         }
 378
 379         cmm_smp_mb();
 380
 381         test_go = 1;
 382
 383         sleep(duration);
 384
 385         test_stop = 1;
 386
 387         for (i = 0; i < nr_readers; i++) {
 388                 err = pthread_join(tid_reader[i], &tret);
 389                 if (err != 0)
 390                         exit(1);
 391                 tot_reads += count_reader[i];
 392         }
 393         for (i = 0; i < nr_writers; i++) {
 394                 err = pthread_join(tid_writer[i], &tret);
 395                 if (err != 0)
 396                         exit(1);
 397                 tot_writes += count_writer[i];
 398         }
 399
 400         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 401                tot_writes);
 402         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 403                 "nr_writers %3u "
 404                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 405                 argv[0], duration, nr_readers, rduration, wduration,
 406                 nr_writers, wdelay, tot_reads, tot_writes,
 407                 tot_reads + tot_writes);
 408
 409         free(tid_reader);
 410         free(tid_writer);
 411         free(count_reader);
 412         free(count_writer);
 413         return 0;
 414 }