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