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