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 <errno.h>
  38
  39 #include <urcu/arch.h>
  40 #include <urcu/tls-compat.h>
  41 #include "cpuset.h"
  42 #include "thread-id.h"
  43
  44 /* hardcoded number of CPUs */
  45 #define NR_CPUS 16384
  46
  47 #ifndef DYNAMIC_LINK_TEST
  48 #define _LGPL_SOURCE
  49 #endif
  50 #include <urcu.h>
  51 #include <urcu/cds.h>
  52
  53 static volatile int test_go, test_stop;
  54
  55 static unsigned long rduration;
  56
  57 static unsigned long duration;
  58
  59 /* read-side C.S. duration, in loops */
  60 static unsigned long wdelay;
  61
  62 static inline void loop_sleep(unsigned long loops)
  63 {
  64         while (loops-- != 0)
  65                 caa_cpu_relax();
  66 }
  67
  68 static int verbose_mode;
  69
  70 #define printf_verbose(fmt, args...)            \
  71         do {                                    \
  72                 if (verbose_mode)               \
  73                         printf(fmt, args);      \
  74         } while (0)
  75
  76 static unsigned int cpu_affinities[NR_CPUS];
  77 static unsigned int next_aff = 0;
  78 static int use_affinity = 0;
  79
  80 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
  81
  82 static void set_affinity(void)
  83 {
  84 #if HAVE_SCHED_SETAFFINITY
  85         cpu_set_t mask;
  86         int cpu, ret;
  87 #endif /* HAVE_SCHED_SETAFFINITY */
  88
  89         if (!use_affinity)
  90                 return;
  91
  92 #if HAVE_SCHED_SETAFFINITY
  93         ret = pthread_mutex_lock(&affinity_mutex);
  94         if (ret) {
  95                 perror("Error in pthread mutex lock");
  96                 exit(-1);
  97         }
  98         cpu = cpu_affinities[next_aff++];
  99         ret = pthread_mutex_unlock(&affinity_mutex);
 100         if (ret) {
 101                 perror("Error in pthread mutex unlock");
 102                 exit(-1);
 103         }
 104
 105         CPU_ZERO(&mask);
 106         CPU_SET(cpu, &mask);
 107 #if SCHED_SETAFFINITY_ARGS == 2
 108         sched_setaffinity(0, &mask);
 109 #else
 110         sched_setaffinity(0, sizeof(mask), &mask);
 111 #endif
 112 #endif /* HAVE_SCHED_SETAFFINITY */
 113 }
 114
 115 /*
 116  * returns 0 if test should end.
 117  */
 118 static int test_duration_dequeue(void)
 119 {
 120         return !test_stop;
 121 }
 122
 123 static int test_duration_enqueue(void)
 124 {
 125         return !test_stop;
 126 }
 127
 128 static DEFINE_URCU_TLS(unsigned long long, nr_dequeues);
 129 static DEFINE_URCU_TLS(unsigned long long, nr_enqueues);
 130
 131 static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues);
 132 static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues);
 133
 134 static unsigned int nr_enqueuers;
 135 static unsigned int nr_dequeuers;
 136
 137 struct test {
 138         struct cds_lfq_node_rcu list;
 139         struct rcu_head rcu;
 140 };
 141
 142 static struct cds_lfq_queue_rcu q;
 143
 144 void *thr_enqueuer(void *_count)
 145 {
 146         unsigned long long *count = _count;
 147
 148         printf_verbose("thread_begin %s, tid %lu\n",
 149                         "enqueuer", urcu_get_thread_id());
 150
 151         set_affinity();
 152
 153         rcu_register_thread();
 154
 155         while (!test_go)
 156         {
 157         }
 158         cmm_smp_mb();
 159
 160         for (;;) {
 161                 struct test *node = malloc(sizeof(*node));
 162                 if (!node)
 163                         goto fail;
 164                 cds_lfq_node_init_rcu(&node->list);
 165                 rcu_read_lock();
 166                 cds_lfq_enqueue_rcu(&q, &node->list);
 167                 rcu_read_unlock();
 168                 URCU_TLS(nr_successful_enqueues)++;
 169
 170                 if (caa_unlikely(wdelay))
 171                         loop_sleep(wdelay);
 172 fail:
 173                 URCU_TLS(nr_enqueues)++;
 174                 if (caa_unlikely(!test_duration_enqueue()))
 175                         break;
 176         }
 177
 178         rcu_unregister_thread();
 179
 180         count[0] = URCU_TLS(nr_enqueues);
 181         count[1] = URCU_TLS(nr_successful_enqueues);
 182         printf_verbose("enqueuer thread_end, tid %lu, "
 183                         "enqueues %llu successful_enqueues %llu\n",
 184                         urcu_get_thread_id(),
 185                         URCU_TLS(nr_enqueues),
 186                         URCU_TLS(nr_successful_enqueues));
 187         return ((void*)1);
 188
 189 }
 190
 191 static
 192 void free_node_cb(struct rcu_head *head)
 193 {
 194         struct test *node =
 195                 caa_container_of(head, struct test, rcu);
 196         free(node);
 197 }
 198
 199 void *thr_dequeuer(void *_count)
 200 {
 201         unsigned long long *count = _count;
 202
 203         printf_verbose("thread_begin %s, tid %lu\n",
 204                         "dequeuer", urcu_get_thread_id());
 205
 206         set_affinity();
 207
 208         rcu_register_thread();
 209
 210         while (!test_go)
 211         {
 212         }
 213         cmm_smp_mb();
 214
 215         for (;;) {
 216                 struct cds_lfq_node_rcu *qnode;
 217
 218                 rcu_read_lock();
 219                 qnode = cds_lfq_dequeue_rcu(&q);
 220                 rcu_read_unlock();
 221
 222                 if (qnode) {
 223                         struct test *node;
 224
 225                         node = caa_container_of(qnode, struct test, list);
 226                         call_rcu(&node->rcu, free_node_cb);
 227                         URCU_TLS(nr_successful_dequeues)++;
 228                 }
 229
 230                 URCU_TLS(nr_dequeues)++;
 231                 if (caa_unlikely(!test_duration_dequeue()))
 232                         break;
 233                 if (caa_unlikely(rduration))
 234                         loop_sleep(rduration);
 235         }
 236
 237         rcu_unregister_thread();
 238         printf_verbose("dequeuer thread_end, tid %lu, "
 239                         "dequeues %llu, successful_dequeues %llu\n",
 240                         urcu_get_thread_id(),
 241                         URCU_TLS(nr_dequeues),
 242                         URCU_TLS(nr_successful_dequeues));
 243         count[0] = URCU_TLS(nr_dequeues);
 244         count[1] = URCU_TLS(nr_successful_dequeues);
 245         return ((void*)2);
 246 }
 247
 248 void test_end(struct cds_lfq_queue_rcu *q, unsigned long long *nr_dequeues)
 249 {
 250         struct cds_lfq_node_rcu *snode;
 251
 252         do {
 253                 snode = cds_lfq_dequeue_rcu(q);
 254                 if (snode) {
 255                         struct test *node;
 256
 257                         node = caa_container_of(snode, struct test, list);
 258                         free(node);     /* no more concurrent access */
 259                         (*nr_dequeues)++;
 260                 }
 261         } while (snode);
 262 }
 263
 264 void show_usage(int argc, char **argv)
 265 {
 266         printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
 267                 argv[0]);
 268         printf("OPTIONS:\n");
 269         printf("        [-d delay] (enqueuer period (in loops))\n");
 270         printf("        [-c duration] (dequeuer period (in loops))\n");
 271         printf("        [-v] (verbose output)\n");
 272         printf("        [-a cpu#] [-a cpu#]... (affinity)\n");
 273         printf("\n");
 274 }
 275
 276 int main(int argc, char **argv)
 277 {
 278         int err;
 279         pthread_t *tid_enqueuer, *tid_dequeuer;
 280         void *tret;
 281         unsigned long long *count_enqueuer, *count_dequeuer;
 282         unsigned long long tot_enqueues = 0, tot_dequeues = 0;
 283         unsigned long long tot_successful_enqueues = 0,
 284                            tot_successful_dequeues = 0;
 285         unsigned long long end_dequeues = 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_dequeuers);
 294         if (err != 1) {
 295                 show_usage(argc, argv);
 296                 return -1;
 297         }
 298
 299         err = sscanf(argv[2], "%u", &nr_enqueuers);
 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                 case 'a':
 316                         if (argc < i + 2) {
 317                                 show_usage(argc, argv);
 318                                 return -1;
 319                         }
 320                         a = atoi(argv[++i]);
 321                         cpu_affinities[next_aff++] = a;
 322                         use_affinity = 1;
 323                         printf_verbose("Adding CPU %d affinity\n", a);
 324                         break;
 325                 case 'c':
 326                         if (argc < i + 2) {
 327                                 show_usage(argc, argv);
 328                                 return -1;
 329                         }
 330                         rduration = atol(argv[++i]);
 331                         break;
 332                 case 'd':
 333                         if (argc < i + 2) {
 334                                 show_usage(argc, argv);
 335                                 return -1;
 336                         }
 337                         wdelay = atol(argv[++i]);
 338                         break;
 339                 case 'v':
 340                         verbose_mode = 1;
 341                         break;
 342                 }
 343         }
 344
 345         printf_verbose("running test for %lu seconds, %u enqueuers, "
 346                        "%u dequeuers.\n",
 347                        duration, nr_enqueuers, nr_dequeuers);
 348         printf_verbose("Writer delay : %lu loops.\n", rduration);
 349         printf_verbose("Reader duration : %lu loops.\n", wdelay);
 350         printf_verbose("thread %-6s, tid %lu\n",
 351                         "main", urcu_get_thread_id());
 352
 353         tid_enqueuer = malloc(sizeof(*tid_enqueuer) * nr_enqueuers);
 354         tid_dequeuer = malloc(sizeof(*tid_dequeuer) * nr_dequeuers);
 355         count_enqueuer = malloc(2 * sizeof(*count_enqueuer) * nr_enqueuers);
 356         count_dequeuer = malloc(2 * sizeof(*count_dequeuer) * nr_dequeuers);
 357         cds_lfq_init_rcu(&q, call_rcu);
 358         err = create_all_cpu_call_rcu_data(0);
 359         if (err) {
 360                 printf("Per-CPU call_rcu() worker threads unavailable. Using default global worker thread.\n");
 361         }
 362
 363         next_aff = 0;
 364
 365         for (i = 0; i < nr_enqueuers; i++) {
 366                 err = pthread_create(&tid_enqueuer[i], NULL, thr_enqueuer,
 367                                      &count_enqueuer[2 * i]);
 368                 if (err != 0)
 369                         exit(1);
 370         }
 371         for (i = 0; i < nr_dequeuers; i++) {
 372                 err = pthread_create(&tid_dequeuer[i], NULL, thr_dequeuer,
 373                                      &count_dequeuer[2 * i]);
 374                 if (err != 0)
 375                         exit(1);
 376         }
 377
 378         cmm_smp_mb();
 379
 380         test_go = 1;
 381
 382         for (i = 0; i < duration; i++) {
 383                 sleep(1);
 384                 if (verbose_mode)
 385                         write (1, ".", 1);
 386         }
 387
 388         test_stop = 1;
 389
 390         for (i = 0; i < nr_enqueuers; i++) {
 391                 err = pthread_join(tid_enqueuer[i], &tret);
 392                 if (err != 0)
 393                         exit(1);
 394                 tot_enqueues += count_enqueuer[2 * i];
 395                 tot_successful_enqueues += count_enqueuer[2 * i + 1];
 396         }
 397         for (i = 0; i < nr_dequeuers; i++) {
 398                 err = pthread_join(tid_dequeuer[i], &tret);
 399                 if (err != 0)
 400                         exit(1);
 401                 tot_dequeues += count_dequeuer[2 * i];
 402                 tot_successful_dequeues += count_dequeuer[2 * i + 1];
 403         }
 404
 405         test_end(&q, &end_dequeues);
 406         err = cds_lfq_destroy_rcu(&q);
 407         assert(!err);
 408
 409         printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
 410                        tot_enqueues, tot_dequeues);
 411         printf_verbose("total number of successful enqueues : %llu, "
 412                        "successful dequeues %llu\n",
 413                        tot_successful_enqueues, tot_successful_dequeues);
 414         printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
 415                 "nr_dequeuers %3u "
 416                 "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
 417                 "successful enqueues %12llu successful dequeues %12llu "
 418                 "end_dequeues %llu nr_ops %12llu\n",
 419                 argv[0], duration, nr_enqueuers, wdelay,
 420                 nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
 421                 tot_successful_enqueues,
 422                 tot_successful_dequeues, end_dequeues,
 423                 tot_enqueues + tot_dequeues);
 424         if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues)
 425                 printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
 426                        "succ. dequeues + end dequeues %llu.\n",
 427                        tot_successful_enqueues,
 428                        tot_successful_dequeues + end_dequeues);
 429
 430         free_all_cpu_call_rcu_data();
 431         free(count_enqueuer);
 432         free(count_dequeuer);
 433         free(tid_enqueuer);
 434         free(tid_dequeuer);
 435         return 0;
 436 }