tests/test_urcu_lfq.c

   1 /*
   2  * test_urcu_lfq.c
   3  *
   4  * Userspace RCU library - example RCU-based lock-free queue
   5  *
   6  * Copyright February 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   7  * Copyright February 2010 - Paolo Bonzini <pbonzini@redhat.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  */
  23
  24 #define _GNU_SOURCE
  25 #include "../config.h"
  26 #include <stdio.h>
  27 #include <pthread.h>
  28 #include <stdlib.h>
  29 #include <stdint.h>
  30 #include <stdbool.h>
  31 #include <string.h>
  32 #include <sys/types.h>
  33 #include <sys/wait.h>
  34 #include <unistd.h>
  35 #include <stdio.h>
  36 #include <assert.h>
  37 #include <sys/syscall.h>
  38 #include <sched.h>
  39 #include <errno.h>
  40
  41 #include <urcu/arch.h>
  42
  43 /* hardcoded number of CPUs */
  44 #define NR_CPUS 16384
  45
  46 #if defined(_syscall0)
  47 _syscall0(pid_t, gettid)
  48 #elif defined(__NR_gettid)
  49 static inline pid_t gettid(void)
  50 {
  51         return syscall(__NR_gettid);
  52 }
  53 #else
  54 #warning "use pid as tid"
  55 static inline pid_t gettid(void)
  56 {
  57         return getpid();
  58 }
  59 #endif
  60
  61 #ifndef DYNAMIC_LINK_TEST
  62 #define _LGPL_SOURCE
  63 #endif
  64 #include <urcu.h>
  65 #include <urcu/rculfqueue.h>
  66 #include <urcu-defer.h>
  67
  68 static volatile int test_go, test_stop;
  69
  70 static unsigned long rduration;
  71
  72 static unsigned long duration;
  73
  74 /* read-side C.S. duration, in loops */
  75 static unsigned long wdelay;
  76
  77 static inline void loop_sleep(unsigned long l)
  78 {
  79         while(l-- != 0)
  80                 caa_cpu_relax();
  81 }
  82
  83 static int verbose_mode;
  84
  85 #define printf_verbose(fmt, args...)            \
  86         do {                                    \
  87                 if (verbose_mode)               \
  88                         printf(fmt, args);      \
  89         } while (0)
  90
  91 static unsigned int cpu_affinities[NR_CPUS];
  92 static unsigned int next_aff = 0;
  93 static int use_affinity = 0;
  94
  95 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
  96
  97 #ifndef HAVE_CPU_SET_T
  98 typedef unsigned long cpu_set_t;
  99 # define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
 100 # define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
 101 #endif
 102
 103 static void set_affinity(void)
 104 {
 105         cpu_set_t mask;
 106         int cpu;
 107         int ret;
 108
 109         if (!use_affinity)
 110                 return;
 111
 112 #if HAVE_SCHED_SETAFFINITY
 113         ret = pthread_mutex_lock(&affinity_mutex);
 114         if (ret) {
 115                 perror("Error in pthread mutex lock");
 116                 exit(-1);
 117         }
 118         cpu = cpu_affinities[next_aff++];
 119         ret = pthread_mutex_unlock(&affinity_mutex);
 120         if (ret) {
 121                 perror("Error in pthread mutex unlock");
 122                 exit(-1);
 123         }
 124
 125         CPU_ZERO(&mask);
 126         CPU_SET(cpu, &mask);
 127 #if SCHED_SETAFFINITY_ARGS == 2
 128         sched_setaffinity(0, &mask);
 129 #else
 130         sched_setaffinity(0, sizeof(mask), &mask);
 131 #endif
 132 #endif /* HAVE_SCHED_SETAFFINITY */
 133 }
 134
 135 /*
 136  * returns 0 if test should end.
 137  */
 138 static int test_duration_dequeue(void)
 139 {
 140         return !test_stop;
 141 }
 142
 143 static int test_duration_enqueue(void)
 144 {
 145         return !test_stop;
 146 }
 147
 148 static unsigned long long __thread nr_dequeues;
 149 static unsigned long long __thread nr_enqueues;
 150
 151 static unsigned long long __thread nr_successful_dequeues;
 152 static unsigned long long __thread nr_successful_enqueues;
 153
 154 static unsigned int nr_enqueuers;
 155 static unsigned int nr_dequeuers;
 156
 157 static struct cds_lfq_queue_rcu q;
 158
 159 void *thr_enqueuer(void *_count)
 160 {
 161         unsigned long long *count = _count;
 162
 163         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 164                         "enqueuer", pthread_self(), (unsigned long)gettid());
 165
 166         set_affinity();
 167
 168         rcu_register_thread();
 169
 170         while (!test_go)
 171         {
 172         }
 173         cmm_smp_mb();
 174
 175         for (;;) {
 176                 struct cds_lfq_node_rcu *node = malloc(sizeof(*node));
 177                 if (!node)
 178                         goto fail;
 179                 cds_lfq_node_init_rcu(node);
 180                 cds_lfq_enqueue_rcu(&q, node);
 181                 nr_successful_enqueues++;
 182
 183                 if (unlikely(wdelay))
 184                         loop_sleep(wdelay);
 185 fail:
 186                 nr_enqueues++;
 187                 if (unlikely(!test_duration_enqueue()))
 188                         break;
 189         }
 190
 191         rcu_unregister_thread();
 192
 193         count[0] = nr_enqueues;
 194         count[1] = nr_successful_enqueues;
 195         printf_verbose("enqueuer thread_end, thread id : %lx, tid %lu, "
 196                        "enqueues %llu successful_enqueues %llu\n",
 197                        pthread_self(), (unsigned long)gettid(), nr_enqueues,
 198                        nr_successful_enqueues);
 199         return ((void*)1);
 200
 201 }
 202
 203 static void rcu_release_node(struct urcu_ref *ref)
 204 {
 205         struct cds_lfq_node_rcu *node = caa_container_of(ref, struct cds_lfq_node_rcu, ref);
 206         defer_rcu(free, node);
 207         //synchronize_rcu();
 208         //free(node);
 209 }
 210
 211 void *thr_dequeuer(void *_count)
 212 {
 213         unsigned long long *count = _count;
 214
 215         printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
 216                         "dequeuer", pthread_self(), (unsigned long)gettid());
 217
 218         set_affinity();
 219
 220         ret = rcu_defer_register_thread();
 221         if (ret) {
 222                 printf("Error in rcu_defer_register_thread\n");
 223                 exit(-1);
 224         }
 225         rcu_register_thread();
 226
 227         while (!test_go)
 228         {
 229         }
 230         cmm_smp_mb();
 231
 232         for (;;) {
 233                 struct cds_lfq_node_rcu *node = cds_lfq_dequeue_rcu(&q,
 234                                                             rcu_release_node);
 235
 236                 if (node) {
 237                         urcu_ref_put(&node->ref, rcu_release_node);
 238                         nr_successful_dequeues++;
 239                 }
 240
 241                 nr_dequeues++;
 242                 if (unlikely(!test_duration_dequeue()))
 243                         break;
 244                 if (unlikely(rduration))
 245                         loop_sleep(rduration);
 246         }
 247
 248         rcu_unregister_thread();
 249         rcu_defer_unregister_thread();
 250
 251         printf_verbose("dequeuer thread_end, thread id : %lx, tid %lu, "
 252                        "dequeues %llu, successful_dequeues %llu\n",
 253                        pthread_self(), (unsigned long)gettid(), nr_dequeues,
 254                        nr_successful_dequeues);
 255         count[0] = nr_dequeues;
 256         count[1] = nr_successful_dequeues;
 257         return ((void*)2);
 258 }
 259
 260 static void release_node(struct urcu_ref *ref)
 261 {
 262         struct cds_lfq_node_rcu *node = caa_container_of(ref, struct cds_lfq_node_rcu, ref);
 263         free(node);
 264 }
 265
 266 void test_end(struct cds_lfq_queue_rcu *q, unsigned long long *nr_dequeues)
 267 {
 268         struct cds_lfq_node_rcu *node;
 269
 270         do {
 271                 node = cds_lfq_dequeue_rcu(q, release_node);
 272                 if (node) {
 273                         urcu_ref_put(&node->ref, release_node);
 274                         (*nr_dequeues)++;
 275                 }
 276         } while (node);
 277 }
 278
 279 void show_usage(int argc, char **argv)
 280 {
 281         printf("Usage : %s nr_dequeuers nr_enqueuers duration (s)", argv[0]);
 282         printf(" [-d delay] (enqueuer period (in loops))");
 283         printf(" [-c duration] (dequeuer period (in loops))");
 284         printf(" [-v] (verbose output)");
 285         printf(" [-a cpu#] [-a cpu#]... (affinity)");
 286         printf("\n");
 287 }
 288
 289 int main(int argc, char **argv)
 290 {
 291         int err;
 292         pthread_t *tid_enqueuer, *tid_dequeuer;
 293         void *tret;
 294         unsigned long long *count_enqueuer, *count_dequeuer;
 295         unsigned long long tot_enqueues = 0, tot_dequeues = 0;
 296         unsigned long long tot_successful_enqueues = 0,
 297                            tot_successful_dequeues = 0;
 298         unsigned long long end_dequeues = 0;
 299         int i, a;
 300
 301         if (argc < 4) {
 302                 show_usage(argc, argv);
 303                 return -1;
 304         }
 305
 306         err = sscanf(argv[1], "%u", &nr_dequeuers);
 307         if (err != 1) {
 308                 show_usage(argc, argv);
 309                 return -1;
 310         }
 311
 312         err = sscanf(argv[2], "%u", &nr_enqueuers);
 313         if (err != 1) {
 314                 show_usage(argc, argv);
 315                 return -1;
 316         }
 317
 318         err = sscanf(argv[3], "%lu", &duration);
 319         if (err != 1) {
 320                 show_usage(argc, argv);
 321                 return -1;
 322         }
 323
 324         for (i = 4; i < argc; i++) {
 325                 if (argv[i][0] != '-')
 326                         continue;
 327                 switch (argv[i][1]) {
 328                 case 'a':
 329                         if (argc < i + 2) {
 330                                 show_usage(argc, argv);
 331                                 return -1;
 332                         }
 333                         a = atoi(argv[++i]);
 334                         cpu_affinities[next_aff++] = a;
 335                         use_affinity = 1;
 336                         printf_verbose("Adding CPU %d affinity\n", a);
 337                         break;
 338                 case 'c':
 339                         if (argc < i + 2) {
 340                                 show_usage(argc, argv);
 341                                 return -1;
 342                         }
 343                         rduration = atol(argv[++i]);
 344                         break;
 345                 case 'd':
 346                         if (argc < i + 2) {
 347                                 show_usage(argc, argv);
 348                                 return -1;
 349                         }
 350                         wdelay = atol(argv[++i]);
 351                         break;
 352                 case 'v':
 353                         verbose_mode = 1;
 354                         break;
 355                 }
 356         }
 357
 358         printf_verbose("running test for %lu seconds, %u enqueuers, "
 359                        "%u dequeuers.\n",
 360                        duration, nr_enqueuers, nr_dequeuers);
 361         printf_verbose("Writer delay : %lu loops.\n", rduration);
 362         printf_verbose("Reader duration : %lu loops.\n", wdelay);
 363         printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
 364                         "main", pthread_self(), (unsigned long)gettid());
 365
 366         tid_enqueuer = malloc(sizeof(*tid_enqueuer) * nr_enqueuers);
 367         tid_dequeuer = malloc(sizeof(*tid_dequeuer) * nr_dequeuers);
 368         count_enqueuer = malloc(2 * sizeof(*count_enqueuer) * nr_enqueuers);
 369         count_dequeuer = malloc(2 * sizeof(*count_dequeuer) * nr_dequeuers);
 370         cds_lfq_init_rcu(&q);
 371
 372         next_aff = 0;
 373
 374         for (i = 0; i < nr_enqueuers; i++) {
 375                 err = pthread_create(&tid_enqueuer[i], NULL, thr_enqueuer,
 376                                      &count_enqueuer[2 * i]);
 377                 if (err != 0)
 378                         exit(1);
 379         }
 380         for (i = 0; i < nr_dequeuers; i++) {
 381                 err = pthread_create(&tid_dequeuer[i], NULL, thr_dequeuer,
 382                                      &count_dequeuer[2 * i]);
 383                 if (err != 0)
 384                         exit(1);
 385         }
 386
 387         cmm_smp_mb();
 388
 389         test_go = 1;
 390
 391         for (i = 0; i < duration; i++) {
 392                 sleep(1);
 393                 if (verbose_mode)
 394                         write (1, ".", 1);
 395         }
 396
 397         test_stop = 1;
 398
 399         for (i = 0; i < nr_enqueuers; i++) {
 400                 err = pthread_join(tid_enqueuer[i], &tret);
 401                 if (err != 0)
 402                         exit(1);
 403                 tot_enqueues += count_enqueuer[2 * i];
 404                 tot_successful_enqueues += count_enqueuer[2 * i + 1];
 405         }
 406         for (i = 0; i < nr_dequeuers; i++) {
 407                 err = pthread_join(tid_dequeuer[i], &tret);
 408                 if (err != 0)
 409                         exit(1);
 410                 tot_dequeues += count_dequeuer[2 * i];
 411                 tot_successful_dequeues += count_dequeuer[2 * i + 1];
 412         }
 413
 414         test_end(&q, &end_dequeues);
 415
 416         printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
 417                        tot_enqueues, tot_dequeues);
 418         printf_verbose("total number of successful enqueues : %llu, "
 419                        "successful dequeues %llu\n",
 420                        tot_successful_enqueues, tot_successful_dequeues);
 421         printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
 422                 "nr_dequeuers %3u "
 423                 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
 424                 "successful enqueues %12llu successful dequeues %12llu "
 425                 "end_dequeues %llu nr_ops %12llu\n",
 426                 argv[0], duration, nr_enqueuers, wdelay,
 427                 nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
 428                 tot_successful_enqueues,
 429                 tot_successful_dequeues, end_dequeues,
 430                 tot_enqueues + tot_dequeues);
 431         if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues)
 432                 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
 433                        "succ. dequeues + end dequeues %llu.\n",
 434                        tot_successful_enqueues,
 435                        tot_successful_dequeues + end_dequeues);
 436
 437         free(count_enqueuer);
 438         free(count_dequeuer);
 439         free(tid_enqueuer);
 440         free(tid_dequeuer);
 441         return 0;
 442 }