tests/benchmark/test_urcu_wfq.c

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