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