wfstack: return whether pop is popping the last element
[urcu.git] / tests / test_urcu_wfs.c
index 7746a1d17447e332c1e88b6cf18523c49c57f439..90b2c3892558c6db3a9e0550f9957fe4d6496569 100644 (file)
 #include <unistd.h>
 #include <stdio.h>
 #include <assert.h>
-#include <sched.h>
 #include <errno.h>
 
 #include <urcu/arch.h>
+#include <urcu/tls-compat.h>
+#include <urcu/uatomic.h>
+#include "cpuset.h"
 
 #ifdef __linux__
 #include <syscall.h>
@@ -64,10 +66,21 @@ static inline pid_t gettid(void)
 #ifndef DYNAMIC_LINK_TEST
 #define _LGPL_SOURCE
 #endif
-#include <urcu.h>
 #include <urcu/wfstack.h>
 
-static volatile int test_go, test_stop;
+/*
+ * External synchronization used.
+ */
+enum test_sync {
+       TEST_SYNC_NONE = 0,
+       TEST_SYNC_MUTEX,
+};
+
+static enum test_sync test_sync;
+
+static int test_force_sync;
+
+static volatile int test_go, test_stop_enqueue, test_stop_dequeue;
 
 static unsigned long rduration;
 
@@ -76,18 +89,21 @@ static unsigned long duration;
 /* read-side C.S. duration, in loops */
 static unsigned long wdelay;
 
-static inline void loop_sleep(unsigned long l)
+static inline void loop_sleep(unsigned long loops)
 {
-       while(l-- != 0)
+       while (loops-- != 0)
                caa_cpu_relax();
 }
 
 static int verbose_mode;
 
+static int test_pop, test_pop_all, test_wait_empty;
+static int test_enqueue_stopped;
+
 #define printf_verbose(fmt, args...)           \
        do {                                    \
                if (verbose_mode)               \
-                       printf(fmt, args);      \
+                       printf(fmt, ## args);   \
        } while (0)
 
 static unsigned int cpu_affinities[NR_CPUS];
@@ -96,17 +112,12 @@ static int use_affinity = 0;
 
 pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
 
-#ifndef HAVE_CPU_SET_T
-typedef unsigned long cpu_set_t;
-# define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
-# define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
-#endif
-
 static void set_affinity(void)
 {
+#if HAVE_SCHED_SETAFFINITY
        cpu_set_t mask;
-       int cpu;
-       int ret;
+       int cpu, ret;
+#endif /* HAVE_SCHED_SETAFFINITY */
 
        if (!use_affinity)
                return;
@@ -139,31 +150,35 @@ static void set_affinity(void)
  */
 static int test_duration_dequeue(void)
 {
-       return !test_stop;
+       return !test_stop_dequeue;
 }
 
 static int test_duration_enqueue(void)
 {
-       return !test_stop;
+       return !test_stop_enqueue;
 }
 
-static unsigned long long __thread nr_dequeues;
-static unsigned long long __thread nr_enqueues;
+static DEFINE_URCU_TLS(unsigned long long, nr_dequeues);
+static DEFINE_URCU_TLS(unsigned long long, nr_enqueues);
 
-static unsigned long long __thread nr_successful_dequeues;
-static unsigned long long __thread nr_successful_enqueues;
+static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues);
+static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues);
+static DEFINE_URCU_TLS(unsigned long long, nr_empty_dest_enqueues);
+static DEFINE_URCU_TLS(unsigned long long, nr_pop_all);
 
 static unsigned int nr_enqueuers;
 static unsigned int nr_dequeuers;
 
 static struct cds_wfs_stack s;
 
-void *thr_enqueuer(void *_count)
+static void *thr_enqueuer(void *_count)
 {
        unsigned long long *count = _count;
+       bool was_nonempty;
 
        printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
-                       "enqueuer", pthread_self(), (unsigned long)gettid());
+                       "enqueuer", (unsigned long) pthread_self(),
+                       (unsigned long) gettid());
 
        set_affinity();
 
@@ -177,33 +192,84 @@ void *thr_enqueuer(void *_count)
                if (!node)
                        goto fail;
                cds_wfs_node_init(node);
-               cds_wfs_push(&s, node);
-               nr_successful_enqueues++;
+               was_nonempty = cds_wfs_push(&s, node);
+               URCU_TLS(nr_successful_enqueues)++;
+               if (!was_nonempty)
+                       URCU_TLS(nr_empty_dest_enqueues)++;
 
                if (caa_unlikely(wdelay))
                        loop_sleep(wdelay);
 fail:
-               nr_enqueues++;
+               URCU_TLS(nr_enqueues)++;
                if (caa_unlikely(!test_duration_enqueue()))
                        break;
        }
 
-       count[0] = nr_enqueues;
-       count[1] = nr_successful_enqueues;
+       uatomic_inc(&test_enqueue_stopped);
+       count[0] = URCU_TLS(nr_enqueues);
+       count[1] = URCU_TLS(nr_successful_enqueues);
+       count[2] = URCU_TLS(nr_empty_dest_enqueues);
        printf_verbose("enqueuer thread_end, thread id : %lx, tid %lu, "
-                      "enqueues %llu successful_enqueues %llu\n",
-                      pthread_self(), (unsigned long)gettid(), nr_enqueues,
-                      nr_successful_enqueues);
+                      "enqueues %llu successful_enqueues %llu, "
+                      "empty_dest_enqueues %llu\n",
+                      pthread_self(),
+                       (unsigned long) gettid(),
+                      URCU_TLS(nr_enqueues),
+                      URCU_TLS(nr_successful_enqueues),
+                      URCU_TLS(nr_empty_dest_enqueues));
        return ((void*)1);
 
 }
 
-void *thr_dequeuer(void *_count)
+static void do_test_pop(enum test_sync sync)
+{
+       struct cds_wfs_node *node;
+
+       if (sync == TEST_SYNC_MUTEX)
+               cds_wfs_pop_lock(&s);
+       node = __cds_wfs_pop_blocking(&s);
+       if (sync == TEST_SYNC_MUTEX)
+               cds_wfs_pop_unlock(&s);
+
+       if (node) {
+               free(node);
+               URCU_TLS(nr_successful_dequeues)++;
+       }
+       URCU_TLS(nr_dequeues)++;
+}
+
+static void do_test_pop_all(enum test_sync sync)
+{
+       struct cds_wfs_head *head;
+       struct cds_wfs_node *node, *n;
+
+       if (sync == TEST_SYNC_MUTEX)
+               cds_wfs_pop_lock(&s);
+       head = __cds_wfs_pop_all(&s);
+       if (sync == TEST_SYNC_MUTEX)
+               cds_wfs_pop_unlock(&s);
+
+       /* Check if empty */
+       if (cds_wfs_first(head) == NULL)
+               return;
+
+       URCU_TLS(nr_pop_all)++;
+
+       cds_wfs_for_each_blocking_safe(head, node, n) {
+               free(node);
+               URCU_TLS(nr_successful_dequeues)++;
+               URCU_TLS(nr_dequeues)++;
+       }
+}
+
+static void *thr_dequeuer(void *_count)
 {
        unsigned long long *count = _count;
+       unsigned int counter;
 
        printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
-                       "dequeuer", pthread_self(), (unsigned long)gettid());
+                       "dequeuer", (unsigned long) pthread_self(),
+                       (unsigned long) gettid());
 
        set_affinity();
 
@@ -212,15 +278,22 @@ void *thr_dequeuer(void *_count)
        }
        cmm_smp_mb();
 
-       for (;;) {
-               struct cds_wfs_node *node = cds_wfs_pop_blocking(&s);
+       assert(test_pop || test_pop_all);
 
-               if (node) {
-                       free(node);
-                       nr_successful_dequeues++;
+       for (;;) {
+               if (test_pop && test_pop_all) {
+                       if (counter & 1)
+                               do_test_pop(test_sync);
+                       else
+                               do_test_pop_all(test_sync);
+                       counter++;
+               } else {
+                       if (test_pop)
+                               do_test_pop(test_sync);
+                       else
+                               do_test_pop_all(test_sync);
                }
 
-               nr_dequeues++;
                if (caa_unlikely(!test_duration_dequeue()))
                        break;
                if (caa_unlikely(rduration))
@@ -228,15 +301,19 @@ void *thr_dequeuer(void *_count)
        }
 
        printf_verbose("dequeuer thread_end, thread id : %lx, tid %lu, "
-                      "dequeues %llu, successful_dequeues %llu\n",
-                      pthread_self(), (unsigned long)gettid(), nr_dequeues,
-                      nr_successful_dequeues);
-       count[0] = nr_dequeues;
-       count[1] = nr_successful_dequeues;
+                      "dequeues %llu, successful_dequeues %llu "
+                      "pop_all %llu\n",
+                      pthread_self(),
+                       (unsigned long) gettid(),
+                      URCU_TLS(nr_dequeues), URCU_TLS(nr_successful_dequeues),
+                      URCU_TLS(nr_pop_all));
+       count[0] = URCU_TLS(nr_dequeues);
+       count[1] = URCU_TLS(nr_successful_dequeues);
+       count[2] = URCU_TLS(nr_pop_all);
        return ((void*)2);
 }
 
-void test_end(struct cds_wfs_stack *s, unsigned long long *nr_dequeues)
+static void test_end(struct cds_wfs_stack *s, unsigned long long *nr_dequeues)
 {
        struct cds_wfs_node *node;
 
@@ -249,13 +326,19 @@ void test_end(struct cds_wfs_stack *s, unsigned long long *nr_dequeues)
        } while (node);
 }
 
-void show_usage(int argc, char **argv)
+static void show_usage(int argc, char **argv)
 {
        printf("Usage : %s nr_dequeuers nr_enqueuers duration (s)", argv[0]);
        printf(" [-d delay] (enqueuer period (in loops))");
        printf(" [-c duration] (dequeuer period (in loops))");
        printf(" [-v] (verbose output)");
        printf(" [-a cpu#] [-a cpu#]... (affinity)");
+       printf(" [-p] (test pop)");
+       printf(" [-P] (test pop_all, enabled by default)");
+       printf(" [-M] (use mutex external synchronization)");
+       printf("      Note: default: no external synchronization used.");
+       printf(" [-f] (force user-provided synchronization)");
+       printf(" [-w] Wait for dequeuer to empty stack");
        printf("\n");
 }
 
@@ -267,9 +350,11 @@ int main(int argc, char **argv)
        unsigned long long *count_enqueuer, *count_dequeuer;
        unsigned long long tot_enqueues = 0, tot_dequeues = 0;
        unsigned long long tot_successful_enqueues = 0,
-                          tot_successful_dequeues = 0;
+                          tot_successful_dequeues = 0,
+                          tot_empty_dest_enqueues = 0,
+                          tot_pop_all = 0;
        unsigned long long end_dequeues = 0;
-       int i, a;
+       int i, a, retval = 0;
 
        if (argc < 4) {
                show_usage(argc, argv);
@@ -325,34 +410,75 @@ int main(int argc, char **argv)
                case 'v':
                        verbose_mode = 1;
                        break;
+               case 'p':
+                       test_pop = 1;
+                       break;
+               case 'P':
+                       test_pop_all = 1;
+                       break;
+               case 'M':
+                       test_sync = TEST_SYNC_MUTEX;
+                       break;
+               case 'w':
+                       test_wait_empty = 1;
+                       break;
+               case 'f':
+                       test_force_sync = 1;
+                       break;
+               }
+       }
+
+       /* activate pop_all test by default */
+       if (!test_pop && !test_pop_all)
+               test_pop_all = 1;
+
+       if (test_sync == TEST_SYNC_NONE && nr_dequeuers > 1 && test_pop) {
+               if (test_force_sync) {
+                       fprintf(stderr, "[WARNING] Using pop concurrently "
+                               "with other pop or pop_all without external "
+                               "synchronization. Expect run-time failure.\n");
+               } else {
+                       printf("Enforcing mutex synchronization\n");
+                       test_sync = TEST_SYNC_MUTEX;
                }
        }
 
        printf_verbose("running test for %lu seconds, %u enqueuers, "
                       "%u dequeuers.\n",
                       duration, nr_enqueuers, nr_dequeuers);
+       if (test_pop)
+               printf_verbose("pop test activated.\n");
+       if (test_pop_all)
+               printf_verbose("pop_all test activated.\n");
+       if (test_sync == TEST_SYNC_MUTEX)
+               printf_verbose("External sync: mutex.\n");
+       else
+               printf_verbose("External sync: none.\n");
+       if (test_wait_empty)
+               printf_verbose("Wait for dequeuers to empty stack.\n");
        printf_verbose("Writer delay : %lu loops.\n", rduration);
        printf_verbose("Reader duration : %lu loops.\n", wdelay);
        printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
-                       "main", pthread_self(), (unsigned long)gettid());
+                       "main", (unsigned long) pthread_self(),
+                       (unsigned long) gettid());
 
        tid_enqueuer = malloc(sizeof(*tid_enqueuer) * nr_enqueuers);
        tid_dequeuer = malloc(sizeof(*tid_dequeuer) * nr_dequeuers);
-       count_enqueuer = malloc(2 * sizeof(*count_enqueuer) * nr_enqueuers);
-       count_dequeuer = malloc(2 * sizeof(*count_dequeuer) * nr_dequeuers);
+       count_enqueuer = malloc(3 * sizeof(*count_enqueuer) * nr_enqueuers);
+       count_dequeuer = malloc(3 * sizeof(*count_dequeuer) * nr_dequeuers);
        cds_wfs_init(&s);
 
        next_aff = 0;
 
        for (i = 0; i < nr_enqueuers; i++) {
                err = pthread_create(&tid_enqueuer[i], NULL, thr_enqueuer,
-                                    &count_enqueuer[2 * i]);
+                                    &count_enqueuer[3 * i]);
                if (err != 0)
                        exit(1);
        }
        for (i = 0; i < nr_dequeuers; i++) {
                err = pthread_create(&tid_dequeuer[i], NULL, thr_dequeuer,
-                                    &count_dequeuer[2 * i]);
+                                    &count_dequeuer[3 * i]);
                if (err != 0)
                        exit(1);
        }
@@ -367,21 +493,34 @@ int main(int argc, char **argv)
                        write (1, ".", 1);
        }
 
-       test_stop = 1;
+       test_stop_enqueue = 1;
+
+       if (test_wait_empty) {
+               while (nr_enqueuers != uatomic_read(&test_enqueue_stopped)) {
+                       sleep(1);
+               }
+               while (!cds_wfs_empty(&s)) {
+                       sleep(1);
+               }
+       }
+
+       test_stop_dequeue = 1;
 
        for (i = 0; i < nr_enqueuers; i++) {
                err = pthread_join(tid_enqueuer[i], &tret);
                if (err != 0)
                        exit(1);
-               tot_enqueues += count_enqueuer[2 * i];
-               tot_successful_enqueues += count_enqueuer[2 * i + 1];
+               tot_enqueues += count_enqueuer[3 * i];
+               tot_successful_enqueues += count_enqueuer[3 * i + 1];
+               tot_empty_dest_enqueues += count_enqueuer[3 * i + 2];
        }
        for (i = 0; i < nr_dequeuers; i++) {
                err = pthread_join(tid_dequeuer[i], &tret);
                if (err != 0)
                        exit(1);
-               tot_dequeues += count_dequeuer[2 * i];
-               tot_successful_dequeues += count_dequeuer[2 * i + 1];
+               tot_dequeues += count_dequeuer[3 * i];
+               tot_successful_dequeues += count_dequeuer[3 * i + 1];
+               tot_pop_all += count_dequeuer[3 * i + 2];
        }
        
        test_end(&s, &end_dequeues);
@@ -389,27 +528,48 @@ int main(int argc, char **argv)
        printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
                       tot_enqueues, tot_dequeues);
        printf_verbose("total number of successful enqueues : %llu, "
-                      "successful dequeues %llu\n",
-                      tot_successful_enqueues, tot_successful_dequeues);
+                      "enqueues to empty dest : %llu, "
+                      "successful dequeues %llu, "
+                      "pop_all : %llu\n",
+                      tot_successful_enqueues,
+                      tot_empty_dest_enqueues,
+                      tot_successful_dequeues,
+                      tot_pop_all);
        printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
                "nr_dequeuers %3u "
                "rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
-               "successful enqueues %12llu successful dequeues %12llu "
+               "successful enqueues %12llu enqueues to empty dest %12llu "
+               "successful dequeues %12llu pop_all %12llu "
                "end_dequeues %llu nr_ops %12llu\n",
                argv[0], duration, nr_enqueuers, wdelay,
                nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
                tot_successful_enqueues,
-               tot_successful_dequeues, end_dequeues,
+               tot_empty_dest_enqueues,
+               tot_successful_dequeues, tot_pop_all, end_dequeues,
                tot_enqueues + tot_dequeues);
-       if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues)
+       if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues) {
                printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
                       "succ. dequeues + end dequeues %llu.\n",
                       tot_successful_enqueues,
                       tot_successful_dequeues + end_dequeues);
-
+               retval = 1;
+       }
+       /*
+        * If only using pop_all to dequeue, the enqueuer should see
+        * exactly as many empty queues than the number of non-empty
+        * stacks dequeued.
+        */
+       if (test_wait_empty && test_pop_all && !test_pop
+                       && tot_empty_dest_enqueues != tot_pop_all) {
+               printf("WARNING! Discrepancy between empty enqueue (%llu) and "
+                       "number of non-empty pop_all (%llu)\n",
+                       tot_empty_dest_enqueues,
+                       tot_pop_all);
+               retval = 1;
+       }
        free(count_enqueuer);
        free(count_dequeuer);
        free(tid_enqueuer);
        free(tid_dequeuer);
-       return 0;
+       return retval;
 }
This page took 0.027859 seconds and 4 git commands to generate.