tests/benchmark/test_urcu_gc.c

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