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 void rcu_copy_mutex_lock(void)
 146 {
 147         int ret;
 148         ret = pthread_mutex_lock(&rcu_copy_mutex);
 149         if (ret) {
 150                 perror("Error in pthread mutex lock");
 151                 exit(-1);
 152         }
 153 }
 154
 155 void rcu_copy_mutex_unlock(void)
 156 {
 157         int ret;
 158
 159         ret = pthread_mutex_unlock(&rcu_copy_mutex);
 160         if (ret) {
 161                 perror("Error in pthread mutex unlock");
 162                 exit(-1);
 163         }
 164 }
 165
 166 void *thr_reader(void *data)
 167 {
 168         unsigned long tidx = (unsigned long)data;
 169
 170         printf_verbose("thread_begin %s, tid %lu\n",
 171                         "reader", urcu_get_thread_id());
 172
 173         set_affinity();
 174
 175         while (!test_go)
 176         {
 177         }
 178
 179         for (;;) {
 180                 int v;
 181
 182                 pthread_mutex_lock(&lock);
 183                 v = test_array.a;
 184                 assert(v == 8);
 185                 if (caa_unlikely(rduration))
 186                         loop_sleep(rduration);
 187                 pthread_mutex_unlock(&lock);
 188                 URCU_TLS(nr_reads)++;
 189                 if (caa_unlikely(!test_duration_read()))
 190                         break;
 191         }
 192
 193         tot_nr_reads[tidx] = URCU_TLS(nr_reads);
 194         printf_verbose("thread_end %s, tid %lu\n",
 195                         "reader", urcu_get_thread_id());
 196         return ((void*)1);
 197
 198 }
 199
 200 void *thr_writer(void *data)
 201 {
 202         unsigned long wtidx = (unsigned long)data;
 203
 204         printf_verbose("thread_begin %s, tid %lu\n",
 205                         "writer", urcu_get_thread_id());
 206
 207         set_affinity();
 208
 209         while (!test_go)
 210         {
 211         }
 212         cmm_smp_mb();
 213
 214         for (;;) {
 215                 pthread_mutex_lock(&lock);
 216                 test_array.a = 0;
 217                 test_array.a = 8;
 218                 if (caa_unlikely(wduration))
 219                         loop_sleep(wduration);
 220                 pthread_mutex_unlock(&lock);
 221                 URCU_TLS(nr_writes)++;
 222                 if (caa_unlikely(!test_duration_write()))
 223                         break;
 224                 if (caa_unlikely(wdelay))
 225                         loop_sleep(wdelay);
 226         }
 227
 228         printf_verbose("thread_end %s, tid %lu\n",
 229                         "writer", urcu_get_thread_id());
 230         tot_nr_writes[wtidx] = URCU_TLS(nr_writes);
 231         return ((void*)2);
 232 }
 233
 234 void show_usage(int argc, char **argv)
 235 {
 236         printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
 237                 argv[0]);
 238         printf("OPTIONS:\n");
 239         printf("        [-d delay] (writer period (us))\n");
 240         printf("        [-c duration] (reader C.S. duration (in loops))\n");
 241         printf("        [-e duration] (writer C.S. duration (in loops))\n");
 242         printf("        [-v] (verbose output)\n");
 243         printf("        [-a cpu#] [-a cpu#]... (affinity)\n");
 244         printf("\n");
 245 }
 246
 247 int main(int argc, char **argv)
 248 {
 249         int err;
 250         pthread_t *tid_reader, *tid_writer;
 251         void *tret;
 252         unsigned long long *count_reader, *count_writer;
 253         unsigned long long tot_reads = 0, tot_writes = 0;
 254         int i, a;
 255         unsigned int i_thr;
 256
 257         if (argc < 4) {
 258                 show_usage(argc, argv);
 259                 return -1;
 260         }
 261         cmm_smp_mb();
 262
 263         err = sscanf(argv[1], "%u", &nr_readers);
 264         if (err != 1) {
 265                 show_usage(argc, argv);
 266                 return -1;
 267         }
 268
 269         err = sscanf(argv[2], "%u", &nr_writers);
 270         if (err != 1) {
 271                 show_usage(argc, argv);
 272                 return -1;
 273         }
 274
 275         err = sscanf(argv[3], "%lu", &duration);
 276         if (err != 1) {
 277                 show_usage(argc, argv);
 278                 return -1;
 279         }
 280
 281         for (i = 4; i < argc; i++) {
 282                 if (argv[i][0] != '-')
 283                         continue;
 284                 switch (argv[i][1]) {
 285                 case 'a':
 286                         if (argc < i + 2) {
 287                                 show_usage(argc, argv);
 288                                 return -1;
 289                         }
 290                         a = atoi(argv[++i]);
 291                         cpu_affinities[next_aff++] = a;
 292                         use_affinity = 1;
 293                         printf_verbose("Adding CPU %d affinity\n", a);
 294                         break;
 295                 case 'c':
 296                         if (argc < i + 2) {
 297                                 show_usage(argc, argv);
 298                                 return -1;
 299                         }
 300                         rduration = atol(argv[++i]);
 301                         break;
 302                 case 'd':
 303                         if (argc < i + 2) {
 304                                 show_usage(argc, argv);
 305                                 return -1;
 306                         }
 307                         wdelay = atol(argv[++i]);
 308                         break;
 309                 case 'e':
 310                         if (argc < i + 2) {
 311                                 show_usage(argc, argv);
 312                                 return -1;
 313                         }
 314                         wduration = atol(argv[++i]);
 315                         break;
 316                 case 'v':
 317                         verbose_mode = 1;
 318                         break;
 319                 }
 320         }
 321
 322         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 323                 duration, nr_readers, nr_writers);
 324         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 325         printf_verbose("Reader duration : %lu loops.\n", rduration);
 326         printf_verbose("thread %-6s, tid %lu\n",
 327                         "main", urcu_get_thread_id());
 328
 329         tid_reader = calloc(nr_readers, sizeof(*tid_reader));
 330         tid_writer = calloc(nr_writers, sizeof(*tid_writer));
 331         count_reader = calloc(nr_readers, sizeof(*count_reader));
 332         count_writer = calloc(nr_writers, sizeof(*count_writer));
 333         tot_nr_reads = calloc(nr_readers, sizeof(*tot_nr_reads));
 334         tot_nr_writes = calloc(nr_writers, sizeof(*tot_nr_writes));
 335
 336         next_aff = 0;
 337
 338         for (i_thr = 0; i_thr < nr_readers; i_thr++) {
 339                 err = pthread_create(&tid_reader[i_thr], NULL, thr_reader,
 340                                      (void *)(long)i_thr);
 341                 if (err != 0)
 342                         exit(1);
 343         }
 344         for (i_thr = 0; i_thr < nr_writers; i_thr++) {
 345                 err = pthread_create(&tid_writer[i_thr], NULL, thr_writer,
 346                                      (void *)(long)i_thr);
 347                 if (err != 0)
 348                         exit(1);
 349         }
 350
 351         cmm_smp_mb();
 352
 353         test_go = 1;
 354
 355         sleep(duration);
 356
 357         test_stop = 1;
 358
 359         for (i_thr = 0; i_thr < nr_readers; i_thr++) {
 360                 err = pthread_join(tid_reader[i_thr], &tret);
 361                 if (err != 0)
 362                         exit(1);
 363                 tot_reads += tot_nr_reads[i_thr];
 364         }
 365         for (i_thr = 0; i_thr < nr_writers; i_thr++) {
 366                 err = pthread_join(tid_writer[i_thr], &tret);
 367                 if (err != 0)
 368                         exit(1);
 369                 tot_writes += tot_nr_writes[i_thr];
 370         }
 371
 372         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 373                tot_writes);
 374         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
 375                 "nr_writers %3u "
 376                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 377                 argv[0], duration, nr_readers, rduration, wduration,
 378                 nr_writers, wdelay, tot_reads, tot_writes,
 379                 tot_reads + tot_writes);
 380
 381         free(tid_reader);
 382         free(tid_writer);
 383         free(count_reader);
 384         free(count_writer);
 385         free(tot_nr_reads);
 386         free(tot_nr_writes);
 387         return 0;
 388 }