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