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