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 #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 #else
  47 #define debug_yield_read()
  48 #endif
  49 #include <urcu.h>
  50
  51 struct test_array {
  52         int a;
  53 };
  54
  55 pthread_rwlock_t lock = PTHREAD_RWLOCK_INITIALIZER;
  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                 pthread_rwlock_rdlock(&lock);
 181                 assert(test_array.a == 8);
 182                 if (caa_unlikely(rduration))
 183                         loop_sleep(rduration);
 184                 pthread_rwlock_unlock(&lock);
 185                 URCU_TLS(nr_reads)++;
 186                 if (caa_unlikely(!test_duration_read()))
 187                         break;
 188         }
 189
 190         *count = URCU_TLS(nr_reads);
 191         printf_verbose("thread_end %s, tid %lu\n",
 192                         "reader", urcu_get_thread_id());
 193         return ((void*)1);
 194
 195 }
 196
 197 void *thr_writer(void *_count)
 198 {
 199         unsigned long long *count = _count;
 200
 201         printf_verbose("thread_begin %s, tid %lu\n",
 202                         "writer", urcu_get_thread_id());
 203
 204         set_affinity();
 205
 206         while (!test_go)
 207         {
 208         }
 209         cmm_smp_mb();
 210
 211         for (;;) {
 212                 pthread_rwlock_wrlock(&lock);
 213                 test_array.a = 0;
 214                 test_array.a = 8;
 215                 if (caa_unlikely(wduration))
 216                         loop_sleep(wduration);
 217                 pthread_rwlock_unlock(&lock);
 218                 URCU_TLS(nr_writes)++;
 219                 if (caa_unlikely(!test_duration_write()))
 220                         break;
 221                 if (caa_unlikely(wdelay))
 222                         loop_sleep(wdelay);
 223         }
 224
 225         printf_verbose("thread_end %s, tid %lu\n",
 226                         "writer", urcu_get_thread_id());
 227         *count = URCU_TLS(nr_writes);
 228         return ((void*)2);
 229 }
 230
 231 void show_usage(int argc, char **argv)
 232 {
 233         printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
 234                 argv[0]);
 235         printf("OPTIONS:\n");
 236 #ifdef DEBUG_YIELD
 237         printf("        [-r] [-w] (yield reader and/or writer)\n");
 238 #endif
 239         printf("        [-d delay] (writer period (us))\n");
 240         printf("        [-c duration] (reader C.S. duration (in loops))\n");
 241         printf("        [-e duration] (writer C.S. duration (in loops))\n");
 242         printf("        [-v] (verbose output)\n");
 243         printf("        [-a cpu#] [-a cpu#]... (affinity)\n");
 244         printf("\n");
 245 }
 246
 247 int main(int argc, char **argv)
 248 {
 249         int err;
 250         pthread_t *tid_reader, *tid_writer;
 251         void *tret;
 252         unsigned long long *count_reader, *count_writer;
 253         unsigned long long tot_reads = 0, tot_writes = 0;
 254         int i, a;
 255
 256         if (argc < 4) {
 257                 show_usage(argc, argv);
 258                 return -1;
 259         }
 260         cmm_smp_mb();
 261
 262         err = sscanf(argv[1], "%u", &nr_readers);
 263         if (err != 1) {
 264                 show_usage(argc, argv);
 265                 return -1;
 266         }
 267
 268         err = sscanf(argv[2], "%u", &nr_writers);
 269         if (err != 1) {
 270                 show_usage(argc, argv);
 271                 return -1;
 272         }
 273
 274         err = sscanf(argv[3], "%lu", &duration);
 275         if (err != 1) {
 276                 show_usage(argc, argv);
 277                 return -1;
 278         }
 279
 280         for (i = 4; i < argc; i++) {
 281                 if (argv[i][0] != '-')
 282                         continue;
 283                 switch (argv[i][1]) {
 284 #ifdef DEBUG_YIELD
 285                 case 'r':
 286                         yield_active |= YIELD_READ;
 287                         break;
 288                 case 'w':
 289                         yield_active |= YIELD_WRITE;
 290                         break;
 291 #endif
 292                 case 'a':
 293                         if (argc < i + 2) {
 294                                 show_usage(argc, argv);
 295                                 return -1;
 296                         }
 297                         a = atoi(argv[++i]);
 298                         cpu_affinities[next_aff++] = a;
 299                         use_affinity = 1;
 300                         printf_verbose("Adding CPU %d affinity\n", a);
 301                         break;
 302                 case 'c':
 303                         if (argc < i + 2) {
 304                                 show_usage(argc, argv);
 305                                 return -1;
 306                         }
 307                         rduration = atol(argv[++i]);
 308                         break;
 309                 case 'd':
 310                         if (argc < i + 2) {
 311                                 show_usage(argc, argv);
 312                                 return -1;
 313                         }
 314                         wdelay = atol(argv[++i]);
 315                         break;
 316                 case 'e':
 317                         if (argc < i + 2) {
 318                                 show_usage(argc, argv);
 319                                 return -1;
 320                         }
 321                         wduration = atol(argv[++i]);
 322                         break;
 323                 case 'v':
 324                         verbose_mode = 1;
 325                         break;
 326                 }
 327         }
 328
 329         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 330                 duration, nr_readers, nr_writers);
 331         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 332         printf_verbose("Reader duration : %lu loops.\n", rduration);
 333         printf_verbose("thread %-6s, tid %lu\n",
 334                         "main", urcu_get_thread_id());
 335
 336         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 337         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 338         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 339         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 340
 341         next_aff = 0;
 342
 343         for (i = 0; i < nr_readers; i++) {
 344                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 345                                      &count_reader[i]);
 346                 if (err != 0)
 347                         exit(1);
 348         }
 349         for (i = 0; i < nr_writers; i++) {
 350                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 351                                      &count_writer[i]);
 352                 if (err != 0)
 353                         exit(1);
 354         }
 355
 356         cmm_smp_mb();
 357
 358         test_go = 1;
 359
 360         sleep(duration);
 361
 362         test_stop = 1;
 363
 364         for (i = 0; i < nr_readers; i++) {
 365                 err = pthread_join(tid_reader[i], &tret);
 366                 if (err != 0)
 367                         exit(1);
 368                 tot_reads += count_reader[i];
 369         }
 370         for (i = 0; i < nr_writers; i++) {
 371                 err = pthread_join(tid_writer[i], &tret);
 372                 if (err != 0)
 373                         exit(1);
 374                 tot_writes += count_writer[i];
 375         }
 376
 377         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 378                tot_writes);
 379         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 380                 "nr_writers %3u "
 381                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 382                 argv[0], duration, nr_readers, rduration, wduration,
 383                 nr_writers, wdelay, tot_reads, tot_writes,
 384                 tot_reads + tot_writes);
 385
 386         free(tid_reader);
 387         free(tid_writer);
 388         free(count_reader);
 389         free(count_writer);
 390         return 0;
 391 }