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 l)
  90 {
  91         while(l-- != 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         cpu_set_t mask;
 112         int cpu;
 113         int ret;
 114
 115         if (!use_affinity)
 116                 return;
 117
 118 #if HAVE_SCHED_SETAFFINITY
 119         ret = pthread_mutex_lock(&affinity_mutex);
 120         if (ret) {
 121                 perror("Error in pthread mutex lock");
 122                 exit(-1);
 123         }
 124         cpu = cpu_affinities[next_aff++];
 125         ret = pthread_mutex_unlock(&affinity_mutex);
 126         if (ret) {
 127                 perror("Error in pthread mutex unlock");
 128                 exit(-1);
 129         }
 130
 131         CPU_ZERO(&mask);
 132         CPU_SET(cpu, &mask);
 133 #if SCHED_SETAFFINITY_ARGS == 2
 134         sched_setaffinity(0, &mask);
 135 #else
 136         sched_setaffinity(0, sizeof(mask), &mask);
 137 #endif
 138 #endif /* HAVE_SCHED_SETAFFINITY */
 139 }
 140
 141 /*
 142  * returns 0 if test should end.
 143  */
 144 static int test_duration_write(void)
 145 {
 146         return !test_stop;
 147 }
 148
 149 static int test_duration_read(void)
 150 {
 151         return !test_stop;
 152 }
 153
 154 static DEFINE_URCU_TLS(unsigned long long, nr_writes);
 155 static DEFINE_URCU_TLS(unsigned long long, nr_reads);
 156
 157 static unsigned int nr_readers;
 158 static unsigned int nr_writers;
 159
 160 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
 161
 162 void rcu_copy_mutex_lock(void)
 163 {
 164         int ret;
 165         ret = pthread_mutex_lock(&rcu_copy_mutex);
 166         if (ret) {
 167                 perror("Error in pthread mutex lock");
 168                 exit(-1);
 169         }
 170 }
 171
 172 void rcu_copy_mutex_unlock(void)
 173 {
 174         int ret;
 175
 176         ret = pthread_mutex_unlock(&rcu_copy_mutex);
 177         if (ret) {
 178                 perror("Error in pthread mutex unlock");
 179                 exit(-1);
 180         }
 181 }
 182
 183 void *thr_reader(void *_count)
 184 {
 185         unsigned long long *count = _count;
 186
 187         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 188                         "reader", (unsigned long) pthread_self(),
 189                         (unsigned long) gettid());
 190
 191         set_affinity();
 192
 193         while (!test_go)
 194         {
 195         }
 196
 197         for (;;) {
 198                 pthread_rwlock_rdlock(&lock);
 199                 assert(test_array.a == 8);
 200                 if (caa_unlikely(rduration))
 201                         loop_sleep(rduration);
 202                 pthread_rwlock_unlock(&lock);
 203                 URCU_TLS(nr_reads)++;
 204                 if (caa_unlikely(!test_duration_read()))
 205                         break;
 206         }
 207
 208         *count = URCU_TLS(nr_reads);
 209         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 210                         "reader", (unsigned long) pthread_self(),
 211                         (unsigned long) gettid());
 212         return ((void*)1);
 213
 214 }
 215
 216 void *thr_writer(void *_count)
 217 {
 218         unsigned long long *count = _count;
 219
 220         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 221                         "writer", (unsigned long) pthread_self(),
 222                         (unsigned long) gettid());
 223
 224         set_affinity();
 225
 226         while (!test_go)
 227         {
 228         }
 229         cmm_smp_mb();
 230
 231         for (;;) {
 232                 pthread_rwlock_wrlock(&lock);
 233                 test_array.a = 0;
 234                 test_array.a = 8;
 235                 if (caa_unlikely(wduration))
 236                         loop_sleep(wduration);
 237                 pthread_rwlock_unlock(&lock);
 238                 URCU_TLS(nr_writes)++;
 239                 if (caa_unlikely(!test_duration_write()))
 240                         break;
 241                 if (caa_unlikely(wdelay))
 242                         loop_sleep(wdelay);
 243         }
 244
 245         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 246                         "writer", (unsigned long) pthread_self(),
 247                         (unsigned long) gettid());
 248         *count = URCU_TLS(nr_writes);
 249         return ((void*)2);
 250 }
 251
 252 void show_usage(int argc, char **argv)
 253 {
 254         printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
 255 #ifdef DEBUG_YIELD
 256         printf(" [-r] [-w] (yield reader and/or writer)");
 257 #endif
 258         printf(" [-d delay] (writer period (us))");
 259         printf(" [-c duration] (reader C.S. duration (in loops))");
 260         printf(" [-e duration] (writer C.S. duration (in loops))");
 261         printf(" [-v] (verbose output)");
 262         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 263         printf("\n");
 264 }
 265
 266 int main(int argc, char **argv)
 267 {
 268         int err;
 269         pthread_t *tid_reader, *tid_writer;
 270         void *tret;
 271         unsigned long long *count_reader, *count_writer;
 272         unsigned long long tot_reads = 0, tot_writes = 0;
 273         int i, a;
 274
 275         if (argc < 4) {
 276                 show_usage(argc, argv);
 277                 return -1;
 278         }
 279         cmm_smp_mb();
 280
 281         err = sscanf(argv[1], "%u", &nr_readers);
 282         if (err != 1) {
 283                 show_usage(argc, argv);
 284                 return -1;
 285         }
 286
 287         err = sscanf(argv[2], "%u", &nr_writers);
 288         if (err != 1) {
 289                 show_usage(argc, argv);
 290                 return -1;
 291         }
 292
 293         err = sscanf(argv[3], "%lu", &duration);
 294         if (err != 1) {
 295                 show_usage(argc, argv);
 296                 return -1;
 297         }
 298
 299         for (i = 4; i < argc; i++) {
 300                 if (argv[i][0] != '-')
 301                         continue;
 302                 switch (argv[i][1]) {
 303 #ifdef DEBUG_YIELD
 304                 case 'r':
 305                         yield_active |= YIELD_READ;
 306                         break;
 307                 case 'w':
 308                         yield_active |= YIELD_WRITE;
 309                         break;
 310 #endif
 311                 case 'a':
 312                         if (argc < i + 2) {
 313                                 show_usage(argc, argv);
 314                                 return -1;
 315                         }
 316                         a = atoi(argv[++i]);
 317                         cpu_affinities[next_aff++] = a;
 318                         use_affinity = 1;
 319                         printf_verbose("Adding CPU %d affinity\n", a);
 320                         break;
 321                 case 'c':
 322                         if (argc < i + 2) {
 323                                 show_usage(argc, argv);
 324                                 return -1;
 325                         }
 326                         rduration = atol(argv[++i]);
 327                         break;
 328                 case 'd':
 329                         if (argc < i + 2) {
 330                                 show_usage(argc, argv);
 331                                 return -1;
 332                         }
 333                         wdelay = atol(argv[++i]);
 334                         break;
 335                 case 'e':
 336                         if (argc < i + 2) {
 337                                 show_usage(argc, argv);
 338                                 return -1;
 339                         }
 340                         wduration = atol(argv[++i]);
 341                         break;
 342                 case 'v':
 343                         verbose_mode = 1;
 344                         break;
 345                 }
 346         }
 347
 348         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 349                 duration, nr_readers, nr_writers);
 350         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 351         printf_verbose("Reader duration : %lu loops.\n", rduration);
 352         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 353                         "main", (unsigned long) pthread_self(),
 354                         (unsigned long) gettid());
 355
 356         tid_reader = calloc(nr_readers, sizeof(*tid_reader));
 357         tid_writer = calloc(nr_writers, sizeof(*tid_writer));
 358         count_reader = calloc(nr_readers, sizeof(*count_reader));
 359         count_writer = calloc(nr_writers, sizeof(*count_writer));
 360
 361         next_aff = 0;
 362
 363         for (i = 0; i < nr_readers; i++) {
 364                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 365                                      &count_reader[i]);
 366                 if (err != 0)
 367                         exit(1);
 368         }
 369         for (i = 0; i < nr_writers; i++) {
 370                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 371                                      &count_writer[i]);
 372                 if (err != 0)
 373                         exit(1);
 374         }
 375
 376         cmm_smp_mb();
 377
 378         test_go = 1;
 379
 380         sleep(duration);
 381
 382         test_stop = 1;
 383
 384         for (i = 0; i < nr_readers; i++) {
 385                 err = pthread_join(tid_reader[i], &tret);
 386                 if (err != 0)
 387                         exit(1);
 388                 tot_reads += count_reader[i];
 389         }
 390         for (i = 0; i < nr_writers; i++) {
 391                 err = pthread_join(tid_writer[i], &tret);
 392                 if (err != 0)
 393                         exit(1);
 394                 tot_writes += count_writer[i];
 395         }
 396
 397         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 398                tot_writes);
 399         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 400                 "nr_writers %3u "
 401                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 402                 argv[0], duration, nr_readers, rduration, wduration,
 403                 nr_writers, wdelay, tot_reads, tot_writes,
 404                 tot_reads + tot_writes);
 405
 406         free(tid_reader);
 407         free(tid_writer);
 408         free(count_reader);
 409         free(count_writer);
 410         return 0;
 411 }