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