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