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