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
  39 #ifdef __linux__
  40 #include <syscall.h>
  41 #endif
  42
  43 /* hardcoded number of CPUs */
  44 #define NR_CPUS 16384
  45
  46 #if defined(_syscall0)
  47 _syscall0(pid_t, gettid)
  48 #elif defined(__NR_gettid)
  49 static inline pid_t gettid(void)
  50 {
  51         return syscall(__NR_gettid);
  52 }
  53 #else
  54 #warning "use pid as tid"
  55 static inline pid_t gettid(void)
  56 {
  57         return getpid();
  58 }
  59 #endif
  60
  61 #ifndef DYNAMIC_LINK_TEST
  62 #define _LGPL_SOURCE
  63 #else
  64 #define debug_yield_read()
  65 #endif
  66 #include <urcu.h>
  67
  68 struct test_array {
  69         int a;
  70 };
  71
  72 static pthread_mutex_t lock;
  73
  74 static volatile int test_go, test_stop;
  75
  76 static unsigned long wdelay;
  77
  78 static volatile struct test_array test_array = { 8 };
  79
  80 static unsigned long duration;
  81
  82 /* read-side C.S. duration, in loops */
  83 static unsigned long rduration;
  84
  85 /* write-side C.S. duration, in loops */
  86 static unsigned long wduration;
  87
  88 static inline void loop_sleep(unsigned long l)
  89 {
  90         while(l-- != 0)
  91                 caa_cpu_relax();
  92 }
  93
  94 static int verbose_mode;
  95
  96 #define printf_verbose(fmt, args...)            \
  97         do {                                    \
  98                 if (verbose_mode)               \
  99                         printf(fmt, args);      \
 100         } while (0)
 101
 102 static unsigned int cpu_affinities[NR_CPUS];
 103 static unsigned int next_aff = 0;
 104 static int use_affinity = 0;
 105
 106 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
 107
 108 #ifndef HAVE_CPU_SET_T
 109 typedef unsigned long cpu_set_t;
 110 # define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
 111 # define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
 112 #endif
 113
 114 static void set_affinity(void)
 115 {
 116         cpu_set_t mask;
 117         int cpu;
 118         int ret;
 119
 120         if (!use_affinity)
 121                 return;
 122
 123 #if HAVE_SCHED_SETAFFINITY
 124         ret = pthread_mutex_lock(&affinity_mutex);
 125         if (ret) {
 126                 perror("Error in pthread mutex lock");
 127                 exit(-1);
 128         }
 129         cpu = cpu_affinities[next_aff++];
 130         ret = pthread_mutex_unlock(&affinity_mutex);
 131         if (ret) {
 132                 perror("Error in pthread mutex unlock");
 133                 exit(-1);
 134         }
 135         CPU_ZERO(&mask);
 136         CPU_SET(cpu, &mask);
 137 #if SCHED_SETAFFINITY_ARGS == 2
 138         sched_setaffinity(0, &mask);
 139 #else
 140         sched_setaffinity(0, sizeof(mask), &mask);
 141 #endif
 142 #endif /* HAVE_SCHED_SETAFFINITY */
 143 }
 144
 145 /*
 146  * returns 0 if test should end.
 147  */
 148 static int test_duration_write(void)
 149 {
 150         return !test_stop;
 151 }
 152
 153 static int test_duration_read(void)
 154 {
 155         return !test_stop;
 156 }
 157
 158 static unsigned long long __thread nr_writes;
 159 static unsigned long long __thread nr_reads;
 160
 161 static
 162 unsigned long long __attribute__((aligned(CAA_CACHE_LINE_SIZE))) *tot_nr_writes;
 163 static
 164 unsigned long long __attribute__((aligned(CAA_CACHE_LINE_SIZE))) *tot_nr_reads;
 165
 166 static unsigned int nr_readers;
 167 static unsigned int nr_writers;
 168
 169 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
 170
 171 void rcu_copy_mutex_lock(void)
 172 {
 173         int ret;
 174         ret = pthread_mutex_lock(&rcu_copy_mutex);
 175         if (ret) {
 176                 perror("Error in pthread mutex lock");
 177                 exit(-1);
 178         }
 179 }
 180
 181 void rcu_copy_mutex_unlock(void)
 182 {
 183         int ret;
 184
 185         ret = pthread_mutex_unlock(&rcu_copy_mutex);
 186         if (ret) {
 187                 perror("Error in pthread mutex unlock");
 188                 exit(-1);
 189         }
 190 }
 191
 192 void *thr_reader(void *data)
 193 {
 194         unsigned long tidx = (unsigned long)data;
 195
 196         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 197                         "reader", pthread_self(), (unsigned long)gettid());
 198
 199         set_affinity();
 200
 201         while (!test_go)
 202         {
 203         }
 204
 205         for (;;) {
 206                 pthread_mutex_lock(&lock);
 207                 assert(test_array.a == 8);
 208                 if (caa_unlikely(rduration))
 209                         loop_sleep(rduration);
 210                 pthread_mutex_unlock(&lock);
 211                 nr_reads++;
 212                 if (caa_unlikely(!test_duration_read()))
 213                         break;
 214         }
 215
 216         tot_nr_reads[tidx] = nr_reads;
 217         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 218                         "reader", pthread_self(), (unsigned long)gettid());
 219         return ((void*)1);
 220
 221 }
 222
 223 void *thr_writer(void *data)
 224 {
 225         unsigned long wtidx = (unsigned long)data;
 226
 227         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 228                         "writer", pthread_self(), (unsigned long)gettid());
 229
 230         set_affinity();
 231
 232         while (!test_go)
 233         {
 234         }
 235         cmm_smp_mb();
 236
 237         for (;;) {
 238                 pthread_mutex_lock(&lock);
 239                 test_array.a = 0;
 240                 test_array.a = 8;
 241                 if (caa_unlikely(wduration))
 242                         loop_sleep(wduration);
 243                 pthread_mutex_unlock(&lock);
 244                 nr_writes++;
 245                 if (caa_unlikely(!test_duration_write()))
 246                         break;
 247                 if (caa_unlikely(wdelay))
 248                         loop_sleep(wdelay);
 249         }
 250
 251         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 252                         "writer", pthread_self(), (unsigned long)gettid());
 253         tot_nr_writes[wtidx] = nr_writes;
 254         return ((void*)2);
 255 }
 256
 257 void show_usage(int argc, char **argv)
 258 {
 259         printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
 260 #ifdef DEBUG_YIELD
 261         printf(" [-r] [-w] (yield reader and/or writer)");
 262 #endif
 263         printf(" [-d delay] (writer period (us))");
 264         printf(" [-c duration] (reader C.S. duration (in loops))");
 265         printf(" [-e duration] (writer C.S. duration (in loops))");
 266         printf(" [-v] (verbose output)");
 267         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 268         printf("\n");
 269 }
 270
 271 int main(int argc, char **argv)
 272 {
 273         int err;
 274         pthread_t *tid_reader, *tid_writer;
 275         void *tret;
 276         unsigned long long *count_reader, *count_writer;
 277         unsigned long long tot_reads = 0, tot_writes = 0;
 278         int i, a;
 279
 280         if (argc < 4) {
 281                 show_usage(argc, argv);
 282                 return -1;
 283         }
 284         cmm_smp_mb();
 285
 286         err = sscanf(argv[1], "%u", &nr_readers);
 287         if (err != 1) {
 288                 show_usage(argc, argv);
 289                 return -1;
 290         }
 291
 292         err = sscanf(argv[2], "%u", &nr_writers);
 293         if (err != 1) {
 294                 show_usage(argc, argv);
 295                 return -1;
 296         }
 297
 298         err = sscanf(argv[3], "%lu", &duration);
 299         if (err != 1) {
 300                 show_usage(argc, argv);
 301                 return -1;
 302         }
 303
 304         for (i = 4; i < argc; i++) {
 305                 if (argv[i][0] != '-')
 306                         continue;
 307                 switch (argv[i][1]) {
 308 #ifdef DEBUG_YIELD
 309                 case 'r':
 310                         yield_active |= YIELD_READ;
 311                         break;
 312                 case 'w':
 313                         yield_active |= YIELD_WRITE;
 314                         break;
 315 #endif
 316                 case 'a':
 317                         if (argc < i + 2) {
 318                                 show_usage(argc, argv);
 319                                 return -1;
 320                         }
 321                         a = atoi(argv[++i]);
 322                         cpu_affinities[next_aff++] = a;
 323                         use_affinity = 1;
 324                         printf_verbose("Adding CPU %d affinity\n", a);
 325                         break;
 326                 case 'c':
 327                         if (argc < i + 2) {
 328                                 show_usage(argc, argv);
 329                                 return -1;
 330                         }
 331                         rduration = atol(argv[++i]);
 332                         break;
 333                 case 'd':
 334                         if (argc < i + 2) {
 335                                 show_usage(argc, argv);
 336                                 return -1;
 337                         }
 338                         wdelay = atol(argv[++i]);
 339                         break;
 340                 case 'e':
 341                         if (argc < i + 2) {
 342                                 show_usage(argc, argv);
 343                                 return -1;
 344                         }
 345                         wduration = atol(argv[++i]);
 346                         break;
 347                 case 'v':
 348                         verbose_mode = 1;
 349                         break;
 350                 }
 351         }
 352
 353         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 354                 duration, nr_readers, nr_writers);
 355         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 356         printf_verbose("Reader duration : %lu loops.\n", rduration);
 357         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 358                         "main", pthread_self(), (unsigned long)gettid());
 359
 360         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 361         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 362         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 363         count_writer = malloc(sizeof(*count_writer) * nr_writers);
 364         tot_nr_reads = malloc(sizeof(*tot_nr_reads) * nr_readers);
 365         tot_nr_writes = malloc(sizeof(*tot_nr_writes) * nr_writers);
 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 }