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                 int v;
 183
 184                 pthread_mutex_lock(&lock);
 185                 v = test_array.a;
 186                 assert(v == 8);
 187                 if (caa_unlikely(rduration))
 188                         loop_sleep(rduration);
 189                 pthread_mutex_unlock(&lock);
 190                 URCU_TLS(nr_reads)++;
 191                 if (caa_unlikely(!test_duration_read()))
 192                         break;
 193         }
 194
 195         tot_nr_reads[tidx] = URCU_TLS(nr_reads);
 196         printf_verbose("thread_end %s, tid %lu\n",
 197                         "reader", urcu_get_thread_id());
 198         return ((void*)1);
 199
 200 }
 201
 202 void *thr_writer(void *data)
 203 {
 204         unsigned long wtidx = (unsigned long)data;
 205
 206         printf_verbose("thread_begin %s, tid %lu\n",
 207                         "writer", urcu_get_thread_id());
 208
 209         set_affinity();
 210
 211         while (!test_go)
 212         {
 213         }
 214         cmm_smp_mb();
 215
 216         for (;;) {
 217                 pthread_mutex_lock(&lock);
 218                 test_array.a = 0;
 219                 test_array.a = 8;
 220                 if (caa_unlikely(wduration))
 221                         loop_sleep(wduration);
 222                 pthread_mutex_unlock(&lock);
 223                 URCU_TLS(nr_writes)++;
 224                 if (caa_unlikely(!test_duration_write()))
 225                         break;
 226                 if (caa_unlikely(wdelay))
 227                         loop_sleep(wdelay);
 228         }
 229
 230         printf_verbose("thread_end %s, tid %lu\n",
 231                         "writer", urcu_get_thread_id());
 232         tot_nr_writes[wtidx] = URCU_TLS(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) <OPTIONS>\n",
 239                 argv[0]);
 240         printf("OPTIONS:\n");
 241         printf("        [-d delay] (writer period (us))\n");
 242         printf("        [-c duration] (reader C.S. duration (in loops))\n");
 243         printf("        [-e duration] (writer C.S. duration (in loops))\n");
 244         printf("        [-v] (verbose output)\n");
 245         printf("        [-a cpu#] [-a cpu#]... (affinity)\n");
 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         cmm_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                 case 'a':
 287                         if (argc < i + 2) {
 288                                 show_usage(argc, argv);
 289                                 return -1;
 290                         }
 291                         a = atoi(argv[++i]);
 292                         cpu_affinities[next_aff++] = a;
 293                         use_affinity = 1;
 294                         printf_verbose("Adding CPU %d affinity\n", a);
 295                         break;
 296                 case 'c':
 297                         if (argc < i + 2) {
 298                                 show_usage(argc, argv);
 299                                 return -1;
 300                         }
 301                         rduration = atol(argv[++i]);
 302                         break;
 303                 case 'd':
 304                         if (argc < i + 2) {
 305                                 show_usage(argc, argv);
 306                                 return -1;
 307                         }
 308                         wdelay = atol(argv[++i]);
 309                         break;
 310                 case 'e':
 311                         if (argc < i + 2) {
 312                                 show_usage(argc, argv);
 313                                 return -1;
 314                         }
 315                         wduration = atol(argv[++i]);
 316                         break;
 317                 case 'v':
 318                         verbose_mode = 1;
 319                         break;
 320                 }
 321         }
 322
 323         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 324                 duration, nr_readers, nr_writers);
 325         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 326         printf_verbose("Reader duration : %lu loops.\n", rduration);
 327         printf_verbose("thread %-6s, tid %lu\n",
 328                         "main", urcu_get_thread_id());
 329
 330         tid_reader = calloc(nr_readers, sizeof(*tid_reader));
 331         tid_writer = calloc(nr_writers, sizeof(*tid_writer));
 332         count_reader = calloc(nr_readers, sizeof(*count_reader));
 333         count_writer = calloc(nr_writers, sizeof(*count_writer));
 334         tot_nr_reads = calloc(nr_readers, sizeof(*tot_nr_reads));
 335         tot_nr_writes = calloc(nr_writers, sizeof(*tot_nr_writes));
 336
 337         next_aff = 0;
 338
 339         for (i = 0; i < nr_readers; i++) {
 340                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 341                                      (void *)(long)i);
 342                 if (err != 0)
 343                         exit(1);
 344         }
 345         for (i = 0; i < nr_writers; i++) {
 346                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 347                                      (void *)(long)i);
 348                 if (err != 0)
 349                         exit(1);
 350         }
 351
 352         cmm_smp_mb();
 353
 354         test_go = 1;
 355
 356         sleep(duration);
 357
 358         test_stop = 1;
 359
 360         for (i = 0; i < nr_readers; i++) {
 361                 err = pthread_join(tid_reader[i], &tret);
 362                 if (err != 0)
 363                         exit(1);
 364                 tot_reads += tot_nr_reads[i];
 365         }
 366         for (i = 0; i < nr_writers; i++) {
 367                 err = pthread_join(tid_writer[i], &tret);
 368                 if (err != 0)
 369                         exit(1);
 370                 tot_writes += tot_nr_writes[i];
 371         }
 372
 373         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 374                tot_writes);
 375         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 376                 "nr_writers %3u "
 377                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 378                 argv[0], duration, nr_readers, rduration, wduration,
 379                 nr_writers, wdelay, tot_reads, tot_writes,
 380                 tot_reads + tot_writes);
 381
 382         free(tid_reader);
 383         free(tid_writer);
 384         free(count_reader);
 385         free(count_writer);
 386         free(tot_nr_reads);
 387         free(tot_nr_writes);
 388         return 0;
 389 }