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