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