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