tests/test_urcu_defer.c

   1 /*
   2  * test_urcu_defer.c
   3  *
   4  * Userspace RCU library - test program (with automatic reclamation)
   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
  36 #include "../arch.h"
  37
  38 /* Make this big enough to include the POWER5+ L3 cacheline size of 256B */
  39 #define CACHE_LINE_SIZE 4096
  40
  41 /* hardcoded number of CPUs */
  42 #define NR_CPUS 16384
  43
  44 #if defined(_syscall0)
  45 _syscall0(pid_t, gettid)
  46 #elif defined(__NR_gettid)
  47 static inline pid_t gettid(void)
  48 {
  49         return syscall(__NR_gettid);
  50 }
  51 #else
  52 #warning "use pid as tid"
  53 static inline pid_t gettid(void)
  54 {
  55         return getpid();
  56 }
  57 #endif
  58
  59 #ifndef DYNAMIC_LINK_TEST
  60 #define _LGPL_SOURCE
  61 #else
  62 #define debug_yield_read()
  63 #endif
  64 #include "../urcu.h"
  65 #include "../urcu-defer.h"
  66
  67 struct test_array {
  68         int a;
  69 };
  70
  71 static volatile int test_go, test_stop;
  72
  73 static unsigned long wdelay;
  74
  75 static struct test_array *test_rcu_pointer;
  76
  77 static unsigned long duration;
  78
  79 /* read-side C.S. duration, in loops */
  80 static unsigned long rduration;
  81
  82 static inline void loop_sleep(unsigned long l)
  83 {
  84         while(l-- != 0)
  85                 cpu_relax();
  86 }
  87
  88 static int verbose_mode;
  89
  90 #define printf_verbose(fmt, args...)            \
  91         do {                                    \
  92                 if (verbose_mode)               \
  93                         printf(fmt, args);      \
  94         } while (0)
  95
  96 static unsigned int cpu_affinities[NR_CPUS];
  97 static unsigned int next_aff = 0;
  98 static int use_affinity = 0;
  99
 100 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
 101
 102 static void set_affinity(void)
 103 {
 104         cpu_set_t mask;
 105         int cpu;
 106         int ret;
 107
 108         if (!use_affinity)
 109                 return;
 110
 111         ret = pthread_mutex_lock(&affinity_mutex);
 112         if (ret) {
 113                 perror("Error in pthread mutex lock");
 114                 exit(-1);
 115         }
 116         cpu = cpu_affinities[next_aff++];
 117         ret = pthread_mutex_unlock(&affinity_mutex);
 118         if (ret) {
 119                 perror("Error in pthread mutex unlock");
 120                 exit(-1);
 121         }
 122         CPU_ZERO(&mask);
 123         CPU_SET(cpu, &mask);
 124         sched_setaffinity(0, sizeof(mask), &mask);
 125 }
 126
 127 /*
 128  * returns 0 if test should end.
 129  */
 130 static int test_duration_write(void)
 131 {
 132         return !test_stop;
 133 }
 134
 135 static int test_duration_read(void)
 136 {
 137         return !test_stop;
 138 }
 139
 140 static unsigned long long __thread nr_writes;
 141 static unsigned long long __thread nr_reads;
 142
 143 static
 144 unsigned long long __attribute__((aligned(CACHE_LINE_SIZE))) *tot_nr_writes;
 145
 146 static unsigned int nr_readers;
 147 static unsigned int nr_writers;
 148
 149 pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
 150
 151 void rcu_copy_mutex_lock(void)
 152 {
 153         int ret;
 154         ret = pthread_mutex_lock(&rcu_copy_mutex);
 155         if (ret) {
 156                 perror("Error in pthread mutex lock");
 157                 exit(-1);
 158         }
 159 }
 160
 161 void rcu_copy_mutex_unlock(void)
 162 {
 163         int ret;
 164
 165         ret = pthread_mutex_unlock(&rcu_copy_mutex);
 166         if (ret) {
 167                 perror("Error in pthread mutex unlock");
 168                 exit(-1);
 169         }
 170 }
 171
 172 void *thr_reader(void *_count)
 173 {
 174         unsigned long long *count = _count;
 175         struct test_array *local_ptr;
 176
 177         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 178                         "reader", pthread_self(), (unsigned long)gettid());
 179
 180         set_affinity();
 181
 182         rcu_register_thread();
 183
 184         while (!test_go)
 185         {
 186         }
 187         smp_mb();
 188
 189         for (;;) {
 190                 rcu_read_lock();
 191                 local_ptr = rcu_dereference(test_rcu_pointer);
 192                 debug_yield_read();
 193                 if (local_ptr)
 194                         assert(local_ptr->a == 8);
 195                 if (unlikely(rduration))
 196                         loop_sleep(rduration);
 197                 rcu_read_unlock();
 198                 nr_reads++;
 199                 if (unlikely(!test_duration_read()))
 200                         break;
 201         }
 202
 203         rcu_unregister_thread();
 204
 205         *count = nr_reads;
 206         printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
 207                         "reader", pthread_self(), (unsigned long)gettid());
 208         return ((void*)1);
 209
 210 }
 211
 212 static void test_cb2(void *data)
 213 {
 214 }
 215
 216 static void test_cb1(void *data)
 217 {
 218 }
 219
 220 void *thr_writer(void *data)
 221 {
 222         unsigned long wtidx = (unsigned long)data;
 223         struct test_array *new, *old = NULL;
 224
 225         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 226                         "writer", pthread_self(), (unsigned long)gettid());
 227
 228         set_affinity();
 229
 230         rcu_defer_register_thread();
 231
 232         while (!test_go)
 233         {
 234         }
 235         smp_mb();
 236
 237         for (;;) {
 238                 new = malloc(sizeof(*new));
 239                 new->a = 8;
 240                 old = rcu_xchg_pointer(&test_rcu_pointer, new);
 241                 call_rcu(free, old);
 242 #if 0
 243                 call_rcu(test_cb1, old);
 244                 call_rcu(test_cb1, (void *)-2L);
 245                 call_rcu(test_cb1, (void *)-2L);
 246                 call_rcu(test_cb1, old);
 247                 call_rcu(test_cb2, (void *)-2L);
 248 #endif //0
 249                 call_rcu(test_cb2, (void *)-4L);
 250                 //call_rcu(test_cb2, (void *)-2L);
 251                 nr_writes++;
 252                 if (unlikely(!test_duration_write()))
 253                         break;
 254                 if (unlikely(wdelay))
 255                         loop_sleep(wdelay);
 256         }
 257
 258         rcu_defer_unregister_thread();
 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(" [-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 *count_reader;
 285         unsigned long long tot_reads = 0, tot_writes = 0;
 286         int i, a;
 287
 288         if (argc < 4) {
 289                 show_usage(argc, argv);
 290                 return -1;
 291         }
 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 'v':
 348                         verbose_mode = 1;
 349                         break;
 350                 }
 351         }
 352
 353         printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
 354                 duration, nr_readers, nr_writers);
 355         printf_verbose("Writer delay : %lu loops.\n", wdelay);
 356         printf_verbose("Reader duration : %lu loops.\n", rduration);
 357         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 358                         "main", pthread_self(), (unsigned long)gettid());
 359
 360         tid_reader = malloc(sizeof(*tid_reader) * nr_readers);
 361         tid_writer = malloc(sizeof(*tid_writer) * nr_writers);
 362         count_reader = malloc(sizeof(*count_reader) * nr_readers);
 363         tot_nr_writes = malloc(sizeof(*tot_nr_writes) * nr_writers);
 364
 365         next_aff = 0;
 366
 367         for (i = 0; i < nr_readers; i++) {
 368                 err = pthread_create(&tid_reader[i], NULL, thr_reader,
 369                                      &count_reader[i]);
 370                 if (err != 0)
 371                         exit(1);
 372         }
 373         for (i = 0; i < nr_writers; i++) {
 374                 err = pthread_create(&tid_writer[i], NULL, thr_writer,
 375                                      (void *)(long)i);
 376                 if (err != 0)
 377                         exit(1);
 378         }
 379
 380         smp_mb();
 381
 382         test_go = 1;
 383
 384         sleep(duration);
 385
 386         test_stop = 1;
 387
 388         for (i = 0; i < nr_readers; i++) {
 389                 err = pthread_join(tid_reader[i], &tret);
 390                 if (err != 0)
 391                         exit(1);
 392                 tot_reads += count_reader[i];
 393         }
 394         for (i = 0; i < nr_writers; i++) {
 395                 err = pthread_join(tid_writer[i], &tret);
 396                 if (err != 0)
 397                         exit(1);
 398                 tot_writes += tot_nr_writes[i];
 399         }
 400
 401         printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
 402                tot_writes);
 403         printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu "
 404                 "nr_writers %3u "
 405                 "wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
 406                 argv[0], duration, nr_readers, rduration,
 407                 nr_writers, wdelay, tot_reads, tot_writes,
 408                 tot_reads + tot_writes);
 409         free(tid_reader);
 410         free(tid_writer);
 411         free(count_reader);
 412         free(tot_nr_writes);
 413
 414         return 0;
 415 }