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