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