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