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