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@polymtl.ca>
   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 <stdio.h>
  25 #include <pthread.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <sys/types.h>
  29 #include <sys/wait.h>
  30 #include <unistd.h>
  31 #include <stdio.h>
  32 #include <assert.h>
  33 #include <sys/syscall.h>
  34 #include <sched.h>
  35 #include <errno.h>
  36
  37 #include <urcu/arch.h>
  38
  39 /* hardcoded number of CPUs */
  40 #define NR_CPUS 16384
  41
  42 #if defined(_syscall0)
  43 _syscall0(pid_t, gettid)
  44 #elif defined(__NR_gettid)
  45 static inline pid_t gettid(void)
  46 {
  47         return syscall(__NR_gettid);
  48 }
  49 #else
  50 #warning "use pid as tid"
  51 static inline pid_t gettid(void)
  52 {
  53         return getpid();
  54 }
  55 #endif
  56
  57 #ifndef DYNAMIC_LINK_TEST
  58 #define _LGPL_SOURCE
  59 #else
  60 #define debug_yield_read()
  61 #endif
  62 #include <urcu.h>
  63
  64 struct test_array {
  65         int a;
  66 };
  67
  68 pthread_rwlock_t lock = PTHREAD_RWLOCK_INITIALIZER;
  69
  70 static volatile int test_go, test_stop;
  71
  72 static unsigned long wdelay;
  73
  74 static volatile struct test_array test_array = { 8 };
  75
  76 static unsigned long duration;
  77
  78 /* read-side C.S. duration, in loops */
  79 static unsigned long rduration;
  80
  81 static inline void loop_sleep(unsigned long l)
  82 {
  83         while(l-- != 0)
  84                 cpu_relax();
  85 }
  86
  87 static int verbose_mode;
  88
  89 #define printf_verbose(fmt, args...)            \
  90         do {                                    \
  91                 if (verbose_mode)               \
  92                         printf(fmt, args);      \
  93         } while (0)
  94
  95 static unsigned int cpu_affinities[NR_CPUS];
  96 static unsigned int next_aff = 0;
  97 static int use_affinity = 0;
  98
  99 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
 100
 101 static void set_affinity(void)
 102 {
 103         cpu_set_t mask;
 104         int cpu;
 105         int ret;
 106
 107         if (!use_affinity)
 108                 return;
 109
 110         ret = pthread_mutex_lock(&affinity_mutex);
 111         if (ret) {
 112                 perror("Error in pthread mutex lock");
 113                 exit(-1);
 114         }
 115         cpu = cpu_affinities[next_aff++];
 116         ret = pthread_mutex_unlock(&affinity_mutex);
 117         if (ret) {
 118                 perror("Error in pthread mutex unlock");
 119                 exit(-1);
 120         }
 121         CPU_ZERO(&mask);
 122         CPU_SET(cpu, &mask);
 123         sched_setaffinity(0, sizeof(mask), &mask);
 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 unsigned long long __thread nr_writes;
 140 static unsigned long long __thread 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, thread id : %lx, tid %lu\n",
 173                         "reader", pthread_self(), (unsigned long)gettid());
 174
 175         set_affinity();
 176
 177         while (!test_go)
 178         {
 179         }
 180
 181         for (;;) {
 182                 pthread_rwlock_rdlock(&lock);
 183                 assert(test_array.a == 8);
 184                 if (unlikely(rduration))
 185                         loop_sleep(rduration);
 186                 pthread_rwlock_unlock(&lock);
 187                 nr_reads++;
 188                 if (unlikely(!test_duration_read()))
 189                         break;
 190         }
 191
 192         *count = nr_reads;
 193         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 194                         "reader", pthread_self(), (unsigned long)gettid());
 195         return ((void*)1);
 196
 197 }
 198
 199 void *thr_writer(void *_count)
 200 {
 201         unsigned long long *count = _count;
 202
 203         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 204                         "writer", pthread_self(), (unsigned long)gettid());
 205
 206         set_affinity();
 207
 208         while (!test_go)
 209         {
 210         }
 211         smp_mb();
 212
 213         for (;;) {
 214                 pthread_rwlock_wrlock(&lock);
 215                 test_array.a = 0;
 216                 test_array.a = 8;
 217                 pthread_rwlock_unlock(&lock);
 218                 nr_writes++;
 219                 if (unlikely(!test_duration_write()))
 220                         break;
 221                 if (unlikely(wdelay))
 222                         loop_sleep(wdelay);
 223         }
 224
 225         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 226                         "writer", pthread_self(), (unsigned long)gettid());
 227         *count = 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)", argv[0]);
 234 #ifdef DEBUG_YIELD
 235         printf(" [-r] [-w] (yield reader and/or writer)");
 236 #endif
 237         printf(" [-d delay] (writer period (us))");
 238         printf(" [-c duration] (reader C.S. duration (in loops))");
 239         printf(" [-v] (verbose output)");
 240         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 241         printf("\n");
 242 }
 243
 244 int main(int argc, char **argv)
 245 {
 246         int err;
 247         pthread_t *tid_reader, *tid_writer;
 248         void *tret;
 249         unsigned long long *count_reader, *count_writer;
 250         unsigned long long tot_reads = 0, tot_writes = 0;
 251         int i, a;
 252
 253         if (argc < 4) {
 254                 show_usage(argc, argv);
 255                 return -1;
 256         }
 257         smp_mb();
 258
 259         err = sscanf(argv[1], "%u", &nr_readers);
 260         if (err != 1) {
 261                 show_usage(argc, argv);
 262                 return -1;
 263         }
 264
 265         err = sscanf(argv[2], "%u", &nr_writers);
 266         if (err != 1) {
 267                 show_usage(argc, argv);
 268                 return -1;
 269         }
 270
 271         err = sscanf(argv[3], "%lu", &duration);
 272         if (err != 1) {
 273                 show_usage(argc, argv);
 274                 return -1;
 275         }
 276
 277         for (i = 4; i < argc; i++) {
 278                 if (argv[i][0] != '-')
 279                         continue;
 280                 switch (argv[i][1]) {
 281 #ifdef DEBUG_YIELD
 282                 case 'r':
 283                         yield_active |= YIELD_READ;
 284                         break;
 285                 case 'w':
 286                         yield_active |= YIELD_WRITE;
 287                         break;
 288 #endif
 289                 case 'a':
 290                         if (argc < i + 2) {
 291                                 show_usage(argc, argv);
 292                                 return -1;
 293                         }
 294                         a = atoi(argv[++i]);
 295                         cpu_affinities[next_aff++] = a;
 296                         use_affinity = 1;
 297                         printf_verbose("Adding CPU %d affinity\n", a);
 298                         break;
 299                 case 'c':
 300                         if (argc < i + 2) {
 301                                 show_usage(argc, argv);
 302                                 return -1;
 303                         }
 304                         rduration = atol(argv[++i]);
 305                         break;
 306                 case 'd':
 307                         if (argc < i + 2) {
 308                                 show_usage(argc, argv);
 309                                 return -1;
 310                         }
 311                         wdelay = atol(argv[++i]);
 312                         break;
 313                 case 'v':
 314                         verbose_mode = 1;
 315                         break;
 316                 }
 317         }
 318
 319         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 320                 duration, nr_readers, nr_writers);
 321         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 322         printf_verbose("Reader duration : %lu loops.\n", rduration);
 323         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 324                         "main", pthread_self(), (unsigned long)gettid());
 325
 326         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 327         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 328         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 329         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 330
 331         next_aff = 0;
 332
 333         for (i = 0; i < nr_readers; i++) {
 334                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 335                                      &count_reader[i]);
 336                 if (err != 0)
 337                         exit(1);
 338         }
 339         for (i = 0; i < nr_writers; i++) {
 340                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 341                                      &count_writer[i]);
 342                 if (err != 0)
 343                         exit(1);
 344         }
 345
 346         smp_mb();
 347
 348         test_go = 1;
 349
 350         sleep(duration);
 351
 352         test_stop = 1;
 353
 354         for (i = 0; i < nr_readers; i++) {
 355                 err = pthread_join(tid_reader[i], &tret);
 356                 if (err != 0)
 357                         exit(1);
 358                 tot_reads += count_reader[i];
 359         }
 360         for (i = 0; i < nr_writers; i++) {
 361                 err = pthread_join(tid_writer[i], &tret);
 362                 if (err != 0)
 363                         exit(1);
 364                 tot_writes += count_writer[i];
 365         }
 366
 367         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 368                tot_writes);
 369         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
 370                 "nr_writers %3u "
 371                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 372                 argv[0], duration, nr_readers, rduration,
 373                 nr_writers, wdelay, tot_reads, tot_writes,
 374                 tot_reads + tot_writes);
 375
 376         free(tid_reader);
 377         free(tid_writer);
 378         free(count_reader);
 379         free(count_writer);
 380         return 0;
 381 }