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