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