[urcu.git] / tests / benchmark / test_urcu_wfcq.c

// SPDX-FileCopyrightText: 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
// SPDX-FileCopyrightText: 2010 Paolo Bonzini <pbonzini@redhat.com>
//
// SPDX-License-Identifier: GPL-2.0-or-later

/*
 * Userspace RCU library - example RCU-based lock-free concurrent queue
 */

#include <stdio.h>
#include <pthread.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <unistd.h>
#include <stdio.h>
#include <errno.h>

#include <urcu/arch.h>
#include <urcu/assert.h>
#include <urcu/tls-compat.h>
#include <urcu/uatomic.h>
#include "thread-id.h"

/* hardcoded number of CPUs */
#define NR_CPUS 16384

#ifndef DYNAMIC_LINK_TEST
#define _LGPL_SOURCE
#endif
#include <urcu/wfcqueue.h>

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_stop_enqueue, test_stop_dequeue;

static unsigned long rduration;

static unsigned long duration;

/* read-side C.S. duration, in loops */
static unsigned long wdelay;

static inline void loop_sleep(unsigned long loops)
{
	while (loops-- != 0)
		caa_cpu_relax();
}

static int verbose_mode;

static int test_dequeue, test_splice, test_wait_empty;
static unsigned int test_enqueue_stopped;

#define printf_verbose(fmt, args...)		\
	do {					\
		if (verbose_mode)		\
			printf(fmt, ## args);	\
	} while (0)

static unsigned int cpu_affinities[NR_CPUS];
static unsigned int next_aff = 0;
static int use_affinity = 0;

pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;

static void set_affinity(void)
{
#ifdef HAVE_SCHED_SETAFFINITY
	cpu_set_t mask;
	int cpu, ret;
#endif /* HAVE_SCHED_SETAFFINITY */

	if (!use_affinity)
		return;

#ifdef HAVE_SCHED_SETAFFINITY
	ret = pthread_mutex_lock(&affinity_mutex);
	if (ret) {
		perror("Error in pthread mutex lock");
		exit(-1);
	}
	cpu = cpu_affinities[next_aff++];
	ret = pthread_mutex_unlock(&affinity_mutex);
	if (ret) {
		perror("Error in pthread mutex unlock");
		exit(-1);
	}

	CPU_ZERO(&mask);
	CPU_SET(cpu, &mask);
	sched_setaffinity(0, sizeof(mask), &mask);
#endif /* HAVE_SCHED_SETAFFINITY */
}

/*
 * returns 0 if test should end.
 */
static int test_duration_dequeue(void)
{
	return !uatomic_load(&test_stop_dequeue, CMM_RELAXED);
}

static int test_duration_enqueue(void)
{
	return !uatomic_load(&test_stop_enqueue, CMM_RELAXED);
}

static DEFINE_URCU_TLS(unsigned long long, nr_dequeues);
static DEFINE_URCU_TLS(unsigned long long, nr_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_splice);
static DEFINE_URCU_TLS(unsigned long long, nr_dequeue_last);

static unsigned int nr_enqueuers;
static unsigned int nr_dequeuers;

static struct cds_wfcq_head __attribute__((aligned(CAA_CACHE_LINE_SIZE))) head;
static struct cds_wfcq_tail __attribute__((aligned(CAA_CACHE_LINE_SIZE))) tail;

static void *thr_enqueuer(void *_count)
{
	unsigned long long *count = _count;
	bool was_nonempty;

	printf_verbose("thread_begin %s, tid %lu\n",
			"enqueuer", urcu_get_thread_id());

	set_affinity();

	wait_until_go();

	for (;;) {
		struct cds_wfcq_node *node = malloc(sizeof(*node));
		if (!node)
			goto fail;
		cds_wfcq_node_init(node);
		was_nonempty = cds_wfcq_enqueue(&head, &tail, node);
		URCU_TLS(nr_successful_enqueues)++;
		if (!was_nonempty)
			URCU_TLS(nr_empty_dest_enqueues)++;

		if (caa_unlikely(wdelay))
			loop_sleep(wdelay);
fail:
		URCU_TLS(nr_enqueues)++;
		if (caa_unlikely(!test_duration_enqueue()))
			break;
	}

	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, tid %lu, "
			"enqueues %llu successful_enqueues %llu, "
			"empty_dest_enqueues %llu\n",
			urcu_get_thread_id(),
			URCU_TLS(nr_enqueues),
			URCU_TLS(nr_successful_enqueues),
			URCU_TLS(nr_empty_dest_enqueues));
	return ((void*)1);

}

static void do_test_dequeue(enum test_sync sync)
{
	struct cds_wfcq_node *node;
	int state;

	if (sync == TEST_SYNC_MUTEX)
		node = cds_wfcq_dequeue_with_state_blocking(&head, &tail,
				&state);
	else
		node = __cds_wfcq_dequeue_with_state_blocking(&head, &tail,
				&state);

	if (state & CDS_WFCQ_STATE_LAST)
		URCU_TLS(nr_dequeue_last)++;

	if (node) {
		free(node);
		URCU_TLS(nr_successful_dequeues)++;
	}
	URCU_TLS(nr_dequeues)++;
}

static void do_test_splice(enum test_sync sync)
{
	struct cds_wfcq_head tmp_head;
	struct cds_wfcq_tail tmp_tail;
	struct cds_wfcq_node *node, *n;
	enum cds_wfcq_ret ret;

	cds_wfcq_init(&tmp_head, &tmp_tail);

	if (sync == TEST_SYNC_MUTEX)
		ret = cds_wfcq_splice_blocking(&tmp_head, &tmp_tail,
			&head, &tail);
	else
		ret = __cds_wfcq_splice_blocking(&tmp_head, &tmp_tail,
			&head, &tail);

	switch (ret) {
	case CDS_WFCQ_RET_WOULDBLOCK:
		urcu_posix_assert(0);	/* blocking call */
		break;
	case CDS_WFCQ_RET_DEST_EMPTY:
		URCU_TLS(nr_splice)++;
		URCU_TLS(nr_dequeue_last)++;
		/* ok */
		break;
	case CDS_WFCQ_RET_DEST_NON_EMPTY:
		urcu_posix_assert(0);	/* entirely unexpected */
		break;
	case CDS_WFCQ_RET_SRC_EMPTY:
		/* ok, we could even skip iteration on dest if we wanted */
		break;
	}

	__cds_wfcq_for_each_blocking_safe(&tmp_head, &tmp_tail, node, n) {
		free(node);
		URCU_TLS(nr_successful_dequeues)++;
		URCU_TLS(nr_dequeues)++;
	}
	cds_wfcq_destroy(&tmp_head, &tmp_tail);
}

static void *thr_dequeuer(void *_count)
{
	unsigned long long *count = _count;
	unsigned int counter = 0;

	printf_verbose("thread_begin %s, tid %lu\n",
			"dequeuer", urcu_get_thread_id());

	set_affinity();

	wait_until_go();

	for (;;) {
		if (test_dequeue && test_splice) {
			if (counter & 1)
				do_test_dequeue(test_sync);
			else
				do_test_splice(test_sync);
			counter++;
		} else {
			if (test_dequeue)
				do_test_dequeue(test_sync);
			else
				do_test_splice(test_sync);
		}
		if (caa_unlikely(!test_duration_dequeue()))
			break;
		if (caa_unlikely(rduration))
			loop_sleep(rduration);
	}

	printf_verbose("dequeuer thread_end, tid %lu, "
			"dequeues %llu, successful_dequeues %llu, "
			"nr_splice %llu\n",
			urcu_get_thread_id(),
			URCU_TLS(nr_dequeues), URCU_TLS(nr_successful_dequeues),
			URCU_TLS(nr_splice));
	count[0] = URCU_TLS(nr_dequeues);
	count[1] = URCU_TLS(nr_successful_dequeues);
	count[2] = URCU_TLS(nr_splice);
	count[3] = URCU_TLS(nr_dequeue_last);
	return ((void*)2);
}

static void test_end(unsigned long long *nr_dequeues_l,
		unsigned long long *nr_dequeue_last_l)
{
	struct cds_wfcq_node *node;
	int state;

	do {
		node = cds_wfcq_dequeue_with_state_blocking(&head, &tail,
				&state);
		if (node) {
			if (state & CDS_WFCQ_STATE_LAST)
				(*nr_dequeue_last_l)++;
			free(node);
			(*nr_dequeues_l)++;
		}
	} while (node);
}

static void show_usage(char **argv)
{
	printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
		argv[0]);
	printf("OPTIONS:\n");
	printf("	[-d delay] (enqueuer period (in loops))\n");
	printf("	[-c duration] (dequeuer period (in loops))\n");
	printf("	[-v] (verbose output)\n");
	printf("	[-a cpu#] [-a cpu#]... (affinity)\n");
	printf("	[-q] (test dequeue)\n");
	printf("	[-s] (test splice, enabled by default)\n");
	printf("	[-M] (use mutex external synchronization)\n");
	printf("		Note: default: no external synchronization used.\n");
	printf("	[-f] (force user-provided synchronization)\n");
	printf("	[-w] Wait for dequeuer to empty queue\n");
	printf("\n");
}

int main(int argc, char **argv)
{
	int err;
	pthread_t *tid_enqueuer, *tid_dequeuer;
	void *tret;
	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_empty_dest_enqueues = 0,
			   tot_splice = 0, tot_dequeue_last = 0;
	unsigned long long end_dequeues = 0;
	int i, a, retval = 0;
	unsigned int i_thr;

	if (argc < 4) {
		show_usage(argv);
		return -1;
	}

	err = sscanf(argv[1], "%u", &nr_dequeuers);
	if (err != 1) {
		show_usage(argv);
		return -1;
	}

	err = sscanf(argv[2], "%u", &nr_enqueuers);
	if (err != 1) {
		show_usage(argv);
		return -1;
	}

	err = sscanf(argv[3], "%lu", &duration);
	if (err != 1) {
		show_usage(argv);
		return -1;
	}

	for (i = 4; i < argc; i++) {
		if (argv[i][0] != '-')
			continue;
		switch (argv[i][1]) {
		case 'a':
			if (argc < i + 2) {
				show_usage(argv);
				return -1;
			}
			a = atoi(argv[++i]);
			cpu_affinities[next_aff++] = a;
			use_affinity = 1;
			printf_verbose("Adding CPU %d affinity\n", a);
			break;
		case 'c':
			if (argc < i + 2) {
				show_usage(argv);
				return -1;
			}
			rduration = atol(argv[++i]);
			break;
		case 'd':
			if (argc < i + 2) {
				show_usage(argv);
				return -1;
			}
			wdelay = atol(argv[++i]);
			break;
		case 'v':
			verbose_mode = 1;
			break;
		case 'q':
			test_dequeue = 1;
			break;
		case 's':
			test_splice = 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 splice test by default */
	if (!test_dequeue && !test_splice)
		test_splice = 1;

	if (test_sync == TEST_SYNC_NONE && nr_dequeuers > 1 && test_dequeue) {
		if (test_force_sync) {
			fprintf(stderr, "[WARNING] Using dequeue concurrently "
				"with other dequeue or splice 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_dequeue)
		printf_verbose("dequeue test activated.\n");
	else
		printf_verbose("splice 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 queue.\n");
	printf_verbose("Writer delay : %lu loops.\n", rduration);
	printf_verbose("Reader duration : %lu loops.\n", wdelay);
	printf_verbose("thread %-6s, tid %lu\n",
			"main", urcu_get_thread_id());

	tid_enqueuer = calloc(nr_enqueuers, sizeof(*tid_enqueuer));
	tid_dequeuer = calloc(nr_dequeuers, sizeof(*tid_dequeuer));
	count_enqueuer = calloc(nr_enqueuers, 3 * sizeof(*count_enqueuer));
	count_dequeuer = calloc(nr_dequeuers, 4 * sizeof(*count_dequeuer));
	cds_wfcq_init(&head, &tail);

	next_aff = 0;

	for (i_thr = 0; i_thr < nr_enqueuers; i_thr++) {
		err = pthread_create(&tid_enqueuer[i_thr], NULL, thr_enqueuer,
				     &count_enqueuer[3 * i_thr]);
		if (err != 0)
			exit(1);
	}
	for (i_thr = 0; i_thr < nr_dequeuers; i_thr++) {
		err = pthread_create(&tid_dequeuer[i_thr], NULL, thr_dequeuer,
				     &count_dequeuer[4 * i_thr]);
		if (err != 0)
			exit(1);
	}

	cmm_smp_mb();

	begin_test();

	for (i_thr = 0; i_thr < duration; i_thr++) {
		sleep(1);
		if (verbose_mode) {
			fwrite(".", sizeof(char), 1, stdout);
			fflush(stdout);
		}
	}

	uatomic_store(&test_stop_enqueue, 1, CMM_RELEASE);

	if (test_wait_empty) {
		while (nr_enqueuers != uatomic_read(&test_enqueue_stopped)) {
			sleep(1);
		}
		while (!cds_wfcq_empty(&head, &tail)) {
			sleep(1);
		}
	}

	uatomic_store(&test_stop_dequeue, 1, CMM_RELAXED);

	for (i_thr = 0; i_thr < nr_enqueuers; i_thr++) {
		err = pthread_join(tid_enqueuer[i_thr], &tret);
		if (err != 0)
			exit(1);
		tot_enqueues += count_enqueuer[3 * i_thr];
		tot_successful_enqueues += count_enqueuer[3 * i_thr + 1];
		tot_empty_dest_enqueues += count_enqueuer[3 * i_thr + 2];
	}
	for (i_thr = 0; i_thr < nr_dequeuers; i_thr++) {
		err = pthread_join(tid_dequeuer[i_thr], &tret);
		if (err != 0)
			exit(1);
		tot_dequeues += count_dequeuer[4 * i_thr];
		tot_successful_dequeues += count_dequeuer[4 * i_thr + 1];
		tot_splice += count_dequeuer[4 * i_thr + 2];
		tot_dequeue_last += count_dequeuer[4 * i_thr + 3];
	}

	test_end(&end_dequeues, &tot_dequeue_last);

	printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
		       tot_enqueues, tot_dequeues);
	printf_verbose("total number of successful enqueues : %llu, "
		       "enqueues to empty dest : %llu, "
		       "successful dequeues %llu, "
		       "splice : %llu, dequeue_last : %llu\n",
		       tot_successful_enqueues,
		       tot_empty_dest_enqueues,
		       tot_successful_dequeues,
		       tot_splice, tot_dequeue_last);
	printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
		"nr_dequeuers %3u "
		"rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
		"successful enqueues %12llu enqueues to empty dest %12llu "
		"successful dequeues %12llu splice %12llu "
		"dequeue_last %llu "
		"end_dequeues %llu nr_ops %12llu\n",
		argv[0], duration, nr_enqueuers, wdelay,
		nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
		tot_successful_enqueues,
		tot_empty_dest_enqueues,
		tot_successful_dequeues, tot_splice, tot_dequeue_last,
		end_dequeues,
		tot_enqueues + tot_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 splice to dequeue, the enqueuer should see
	 * exactly as many empty queues than the number of non-empty
	 * src splice.
	 */
	if (tot_empty_dest_enqueues != tot_dequeue_last) {
		printf("WARNING! Discrepancy between empty enqueue (%llu) and "
			"number of dequeue of last element (%llu)\n",
			tot_empty_dest_enqueues,
			tot_dequeue_last);
		retval = 1;
	}
	cds_wfcq_destroy(&head, &tail);
	free(count_enqueuer);
	free(count_dequeuer);
	free(tid_enqueuer);
	free(tid_dequeuer);

	return retval;
}
Commit	Line	Data
ce29b371 MJ	1	// SPDX-FileCopyrightText: 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	2	// SPDX-FileCopyrightText: 2010 Paolo Bonzini <pbonzini@redhat.com>
	3	//
	4	// SPDX-License-Identifier: GPL-2.0-or-later
	5
5e70d572	6	/*
5e70d572	7	* Userspace RCU library - example RCU-based lock-free concurrent queue
5e70d572 MD	8	*/
5e70d572 MD	9
5e70d572 MD	10	#include <stdio.h>
	11	#include <pthread.h>
	12	#include <stdlib.h>
	13	#include <stdint.h>
	14	#include <stdbool.h>
	15	#include <string.h>
	16	#include <sys/types.h>
	17	#include <sys/wait.h>
	18	#include <unistd.h>
	19	#include <stdio.h>
5e70d572 MD	20	#include <errno.h>
	21
	22	#include <urcu/arch.h>
01477510	23	#include <urcu/assert.h>
5e70d572	24	#include <urcu/tls-compat.h>
985c3168	25	#include <urcu/uatomic.h>
94df6318	26	#include "thread-id.h"
5e70d572 MD	27
	28	/* hardcoded number of CPUs */
	29	#define NR_CPUS 16384
	30
5e70d572 MD	31	#ifndef DYNAMIC_LINK_TEST
	32	#define _LGPL_SOURCE
	33	#endif
5e70d572 MD	34	#include <urcu/wfcqueue.h>
5e70d572 MD	35
f5d36fed	36	enum test_sync {
372b9ad7 MD	37	TEST_SYNC_NONE = 0,
372b9ad7 MD	38	TEST_SYNC_MUTEX,
f5d36fed MD	39	};
	40
	41	static enum test_sync test_sync;
	42
372b9ad7 MD	43	static int test_force_sync;
372b9ad7 MD	44
9e4e7ad1	45	static volatile int test_stop_enqueue, test_stop_dequeue;
5e70d572 MD	46
	47	static unsigned long rduration;
	48
	49	static unsigned long duration;
	50
	51	/* read-side C.S. duration, in loops */
	52	static unsigned long wdelay;
	53
ab0aacbe	54	static inline void loop_sleep(unsigned long loops)
5e70d572	55	{
ab0aacbe	56	while (loops-- != 0)
5e70d572 MD	57	caa_cpu_relax();
	58	}
	59
	60	static int verbose_mode;
	61
cf9451dc	62	static int test_dequeue, test_splice, test_wait_empty;
83e334d0	63	static unsigned int test_enqueue_stopped;
f5d36fed	64
5e70d572 MD	65	#define printf_verbose(fmt, args...) \
	66	do { \
	67	if (verbose_mode) \
f5d36fed	68	printf(fmt, ## args); \
5e70d572 MD	69	} while (0)
	70
	71	static unsigned int cpu_affinities[NR_CPUS];
	72	static unsigned int next_aff = 0;
	73	static int use_affinity = 0;
	74
	75	pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
	76
5e70d572 MD	77	static void set_affinity(void)
5e70d572 MD	78	{
2388c075	79	#ifdef HAVE_SCHED_SETAFFINITY
5e70d572	80	cpu_set_t mask;
95bc7fb9 MD	81	int cpu, ret;
95bc7fb9 MD	82	#endif /* HAVE_SCHED_SETAFFINITY */
5e70d572 MD	83
	84	if (!use_affinity)
	85	return;
	86
2388c075	87	#ifdef HAVE_SCHED_SETAFFINITY
5e70d572 MD	88	ret = pthread_mutex_lock(&affinity_mutex);
	89	if (ret) {
	90	perror("Error in pthread mutex lock");
	91	exit(-1);
	92	}
	93	cpu = cpu_affinities[next_aff++];
	94	ret = pthread_mutex_unlock(&affinity_mutex);
	95	if (ret) {
	96	perror("Error in pthread mutex unlock");
	97	exit(-1);
	98	}
	99
	100	CPU_ZERO(&mask);
	101	CPU_SET(cpu, &mask);
5e70d572	102	sched_setaffinity(0, sizeof(mask), &mask);
5e70d572 MD	103	#endif /* HAVE_SCHED_SETAFFINITY */
	104	}
	105
	106	/*
	107	* returns 0 if test should end.
	108	*/
	109	static int test_duration_dequeue(void)
	110	{
9e4e7ad1	111	return !uatomic_load(&test_stop_dequeue, CMM_RELAXED);
5e70d572 MD	112	}
	113
	114	static int test_duration_enqueue(void)
	115	{
9e4e7ad1	116	return !uatomic_load(&test_stop_enqueue, CMM_RELAXED);
5e70d572 MD	117	}
	118
	119	static DEFINE_URCU_TLS(unsigned long long, nr_dequeues);
	120	static DEFINE_URCU_TLS(unsigned long long, nr_enqueues);
	121
	122	static DEFINE_URCU_TLS(unsigned long long, nr_successful_dequeues);
	123	static DEFINE_URCU_TLS(unsigned long long, nr_successful_enqueues);
cf9451dc MD	124	static DEFINE_URCU_TLS(unsigned long long, nr_empty_dest_enqueues);
cf9451dc MD	125	static DEFINE_URCU_TLS(unsigned long long, nr_splice);
db182e31	126	static DEFINE_URCU_TLS(unsigned long long, nr_dequeue_last);
5e70d572 MD	127
	128	static unsigned int nr_enqueuers;
	129	static unsigned int nr_dequeuers;
	130
	131	static struct cds_wfcq_head __attribute__((aligned(CAA_CACHE_LINE_SIZE))) head;
	132	static struct cds_wfcq_tail __attribute__((aligned(CAA_CACHE_LINE_SIZE))) tail;
	133
f5d36fed	134	static void thr_enqueuer(void _count)
5e70d572 MD	135	{
5e70d572 MD	136	unsigned long long *count = _count;
cf9451dc	137	bool was_nonempty;
5e70d572	138
94df6318 MD	139	printf_verbose("thread_begin %s, tid %lu\n",
94df6318 MD	140	"enqueuer", urcu_get_thread_id());
5e70d572 MD	141
	142	set_affinity();
	143
9e4e7ad1	144	wait_until_go();
5e70d572 MD	145
	146	for (;;) {
	147	struct cds_wfcq_node node = malloc(sizeof(node));
	148	if (!node)
	149	goto fail;
	150	cds_wfcq_node_init(node);
cf9451dc	151	was_nonempty = cds_wfcq_enqueue(&head, &tail, node);
5e70d572	152	URCU_TLS(nr_successful_enqueues)++;
cf9451dc MD	153	if (!was_nonempty)
cf9451dc MD	154	URCU_TLS(nr_empty_dest_enqueues)++;
5e70d572 MD	155
	156	if (caa_unlikely(wdelay))
	157	loop_sleep(wdelay);
	158	fail:
	159	URCU_TLS(nr_enqueues)++;
	160	if (caa_unlikely(!test_duration_enqueue()))
	161	break;
	162	}
	163
cf9451dc	164	uatomic_inc(&test_enqueue_stopped);
5e70d572 MD	165	count[0] = URCU_TLS(nr_enqueues);
5e70d572 MD	166	count[1] = URCU_TLS(nr_successful_enqueues);
cf9451dc	167	count[2] = URCU_TLS(nr_empty_dest_enqueues);
94df6318 MD	168	printf_verbose("enqueuer thread_end, tid %lu, "
	169	"enqueues %llu successful_enqueues %llu, "
	170	"empty_dest_enqueues %llu\n",
	171	urcu_get_thread_id(),
	172	URCU_TLS(nr_enqueues),
	173	URCU_TLS(nr_successful_enqueues),
	174	URCU_TLS(nr_empty_dest_enqueues));
5e70d572 MD	175	return ((void*)1);
	176
	177	}
	178
f5d36fed MD	179	static void do_test_dequeue(enum test_sync sync)
	180	{
	181	struct cds_wfcq_node *node;
db182e31	182	int state;
f5d36fed MD	183
f5d36fed MD	184	if (sync == TEST_SYNC_MUTEX)
db182e31 MD	185	node = cds_wfcq_dequeue_with_state_blocking(&head, &tail,
db182e31 MD	186	&state);
f5d36fed	187	else
db182e31 MD	188	node = __cds_wfcq_dequeue_with_state_blocking(&head, &tail,
	189	&state);
	190
	191	if (state & CDS_WFCQ_STATE_LAST)
	192	URCU_TLS(nr_dequeue_last)++;
f5d36fed MD	193
	194	if (node) {
	195	free(node);
	196	URCU_TLS(nr_successful_dequeues)++;
	197	}
	198	URCU_TLS(nr_dequeues)++;
	199	}
	200
	201	static void do_test_splice(enum test_sync sync)
	202	{
	203	struct cds_wfcq_head tmp_head;
	204	struct cds_wfcq_tail tmp_tail;
	205	struct cds_wfcq_node node, n;
cf9451dc	206	enum cds_wfcq_ret ret;
f5d36fed MD	207
	208	cds_wfcq_init(&tmp_head, &tmp_tail);
	209
	210	if (sync == TEST_SYNC_MUTEX)
cf9451dc	211	ret = cds_wfcq_splice_blocking(&tmp_head, &tmp_tail,
f5d36fed MD	212	&head, &tail);
f5d36fed MD	213	else
cf9451dc	214	ret = __cds_wfcq_splice_blocking(&tmp_head, &tmp_tail,
f5d36fed MD	215	&head, &tail);
f5d36fed MD	216
cf9451dc MD	217	switch (ret) {
cf9451dc MD	218	case CDS_WFCQ_RET_WOULDBLOCK:
01477510	219	urcu_posix_assert(0); /* blocking call */
cf9451dc MD	220	break;
	221	case CDS_WFCQ_RET_DEST_EMPTY:
	222	URCU_TLS(nr_splice)++;
db182e31	223	URCU_TLS(nr_dequeue_last)++;
cf9451dc MD	224	/* ok */
	225	break;
	226	case CDS_WFCQ_RET_DEST_NON_EMPTY:
01477510	227	urcu_posix_assert(0); /* entirely unexpected */
cf9451dc MD	228	break;
	229	case CDS_WFCQ_RET_SRC_EMPTY:
	230	/* ok, we could even skip iteration on dest if we wanted */
	231	break;
	232	}
	233
f5d36fed MD	234	__cds_wfcq_for_each_blocking_safe(&tmp_head, &tmp_tail, node, n) {
	235	free(node);
	236	URCU_TLS(nr_successful_dequeues)++;
	237	URCU_TLS(nr_dequeues)++;
	238	}
2af1c19e	239	cds_wfcq_destroy(&tmp_head, &tmp_tail);
f5d36fed MD	240	}
	241
	242	static void thr_dequeuer(void _count)
5e70d572 MD	243	{
5e70d572 MD	244	unsigned long long *count = _count;
f42bc7ef	245	unsigned int counter = 0;
5e70d572	246
94df6318 MD	247	printf_verbose("thread_begin %s, tid %lu\n",
94df6318 MD	248	"dequeuer", urcu_get_thread_id());
5e70d572 MD	249
	250	set_affinity();
	251
9e4e7ad1	252	wait_until_go();
5e70d572 MD	253
5e70d572 MD	254	for (;;) {
f5d36fed MD	255	if (test_dequeue && test_splice) {
	256	if (counter & 1)
	257	do_test_dequeue(test_sync);
	258	else
	259	do_test_splice(test_sync);
	260	counter++;
	261	} else {
	262	if (test_dequeue)
	263	do_test_dequeue(test_sync);
	264	else
	265	do_test_splice(test_sync);
5e70d572	266	}
5e70d572 MD	267	if (caa_unlikely(!test_duration_dequeue()))
	268	break;
	269	if (caa_unlikely(rduration))
	270	loop_sleep(rduration);
	271	}
	272
94df6318 MD	273	printf_verbose("dequeuer thread_end, tid %lu, "
	274	"dequeues %llu, successful_dequeues %llu, "
	275	"nr_splice %llu\n",
	276	urcu_get_thread_id(),
	277	URCU_TLS(nr_dequeues), URCU_TLS(nr_successful_dequeues),
	278	URCU_TLS(nr_splice));
5e70d572 MD	279	count[0] = URCU_TLS(nr_dequeues);
5e70d572 MD	280	count[1] = URCU_TLS(nr_successful_dequeues);
cf9451dc	281	count[2] = URCU_TLS(nr_splice);
db182e31	282	count[3] = URCU_TLS(nr_dequeue_last);
5e70d572 MD	283	return ((void*)2);
	284	}
	285
bd23a6c6 MJ	286	static void test_end(unsigned long long *nr_dequeues_l,
bd23a6c6 MJ	287	unsigned long long *nr_dequeue_last_l)
5e70d572 MD	288	{
5e70d572 MD	289	struct cds_wfcq_node *node;
db182e31	290	int state;
5e70d572 MD	291
5e70d572 MD	292	do {
db182e31 MD	293	node = cds_wfcq_dequeue_with_state_blocking(&head, &tail,
db182e31 MD	294	&state);
5e70d572	295	if (node) {
db182e31	296	if (state & CDS_WFCQ_STATE_LAST)
bd23a6c6	297	(*nr_dequeue_last_l)++;
5e70d572	298	free(node);
bd23a6c6	299	(*nr_dequeues_l)++;
5e70d572 MD	300	}
	301	} while (node);
	302	}
	303
70469b43	304	static void show_usage(char **argv)
5e70d572	305	{
06637138 MD	306	printf("Usage : %s nr_dequeuers nr_enqueuers duration (s) <OPTIONS>\n",
	307	argv[0]);
	308	printf("OPTIONS:\n");
	309	printf(" [-d delay] (enqueuer period (in loops))\n");
	310	printf(" [-c duration] (dequeuer period (in loops))\n");
	311	printf(" [-v] (verbose output)\n");
	312	printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
	313	printf(" [-q] (test dequeue)\n");
	314	printf(" [-s] (test splice, enabled by default)\n");
	315	printf(" [-M] (use mutex external synchronization)\n");
	316	printf(" Note: default: no external synchronization used.\n");
	317	printf(" [-f] (force user-provided synchronization)\n");
	318	printf(" [-w] Wait for dequeuer to empty queue\n");
5e70d572 MD	319	printf("\n");
	320	}
	321
	322	int main(int argc, char **argv)
	323	{
	324	int err;
	325	pthread_t tid_enqueuer, tid_dequeuer;
	326	void *tret;
	327	unsigned long long count_enqueuer, count_dequeuer;
	328	unsigned long long tot_enqueues = 0, tot_dequeues = 0;
	329	unsigned long long tot_successful_enqueues = 0,
cf9451dc MD	330	tot_successful_dequeues = 0,
cf9451dc MD	331	tot_empty_dest_enqueues = 0,
db182e31	332	tot_splice = 0, tot_dequeue_last = 0;
5e70d572	333	unsigned long long end_dequeues = 0;
cf9451dc	334	int i, a, retval = 0;
83e334d0	335	unsigned int i_thr;
5e70d572 MD	336
5e70d572 MD	337	if (argc < 4) {
70469b43	338	show_usage(argv);
5e70d572 MD	339	return -1;
	340	}
	341
	342	err = sscanf(argv[1], "%u", &nr_dequeuers);
	343	if (err != 1) {
70469b43	344	show_usage(argv);
5e70d572 MD	345	return -1;
	346	}
	347
	348	err = sscanf(argv[2], "%u", &nr_enqueuers);
	349	if (err != 1) {
70469b43	350	show_usage(argv);
5e70d572 MD	351	return -1;
5e70d572 MD	352	}
83e334d0	353
5e70d572 MD	354	err = sscanf(argv[3], "%lu", &duration);
5e70d572 MD	355	if (err != 1) {
70469b43	356	show_usage(argv);
5e70d572 MD	357	return -1;
	358	}
	359
	360	for (i = 4; i < argc; i++) {
	361	if (argv[i][0] != '-')
	362	continue;
	363	switch (argv[i][1]) {
	364	case 'a':
	365	if (argc < i + 2) {
70469b43	366	show_usage(argv);
5e70d572 MD	367	return -1;
	368	}
	369	a = atoi(argv[++i]);
	370	cpu_affinities[next_aff++] = a;
	371	use_affinity = 1;
	372	printf_verbose("Adding CPU %d affinity\n", a);
	373	break;
	374	case 'c':
	375	if (argc < i + 2) {
70469b43	376	show_usage(argv);
5e70d572 MD	377	return -1;
	378	}
	379	rduration = atol(argv[++i]);
	380	break;
	381	case 'd':
	382	if (argc < i + 2) {
70469b43	383	show_usage(argv);
5e70d572 MD	384	return -1;
	385	}
	386	wdelay = atol(argv[++i]);
	387	break;
	388	case 'v':
	389	verbose_mode = 1;
	390	break;
f5d36fed MD	391	case 'q':
	392	test_dequeue = 1;
	393	break;
	394	case 's':
	395	test_splice = 1;
	396	break;
	397	case 'M':
	398	test_sync = TEST_SYNC_MUTEX;
	399	break;
cf9451dc MD	400	case 'w':
	401	test_wait_empty = 1;
	402	break;
372b9ad7 MD	403	case 'f':
	404	test_force_sync = 1;
	405	break;
5e70d572 MD	406	}
	407	}
	408
f5d36fed MD	409	/* activate splice test by default */
	410	if (!test_dequeue && !test_splice)
	411	test_splice = 1;
	412
372b9ad7 MD	413	if (test_sync == TEST_SYNC_NONE && nr_dequeuers > 1 && test_dequeue) {
	414	if (test_force_sync) {
	415	fprintf(stderr, "[WARNING] Using dequeue concurrently "
	416	"with other dequeue or splice without external "
	417	"synchronization. Expect run-time failure.\n");
	418	} else {
	419	printf("Enforcing mutex synchronization\n");
	420	test_sync = TEST_SYNC_MUTEX;
	421	}
	422	}
	423
5e70d572 MD	424	printf_verbose("running test for %lu seconds, %u enqueuers, "
	425	"%u dequeuers.\n",
	426	duration, nr_enqueuers, nr_dequeuers);
f5d36fed MD	427	if (test_dequeue)
	428	printf_verbose("dequeue test activated.\n");
	429	else
	430	printf_verbose("splice test activated.\n");
	431	if (test_sync == TEST_SYNC_MUTEX)
	432	printf_verbose("External sync: mutex.\n");
	433	else
	434	printf_verbose("External sync: none.\n");
cf9451dc MD	435	if (test_wait_empty)
cf9451dc MD	436	printf_verbose("Wait for dequeuers to empty queue.\n");
5e70d572 MD	437	printf_verbose("Writer delay : %lu loops.\n", rduration);
5e70d572 MD	438	printf_verbose("Reader duration : %lu loops.\n", wdelay);
94df6318 MD	439	printf_verbose("thread %-6s, tid %lu\n",
94df6318 MD	440	"main", urcu_get_thread_id());
5e70d572	441
9aa14175 MD	442	tid_enqueuer = calloc(nr_enqueuers, sizeof(*tid_enqueuer));
	443	tid_dequeuer = calloc(nr_dequeuers, sizeof(*tid_dequeuer));
	444	count_enqueuer = calloc(nr_enqueuers, 3 * sizeof(*count_enqueuer));
	445	count_dequeuer = calloc(nr_dequeuers, 4 * sizeof(*count_dequeuer));
5e70d572 MD	446	cds_wfcq_init(&head, &tail);
	447
	448	next_aff = 0;
	449
83e334d0 MJ	450	for (i_thr = 0; i_thr < nr_enqueuers; i_thr++) {
	451	err = pthread_create(&tid_enqueuer[i_thr], NULL, thr_enqueuer,
	452	&count_enqueuer[3 * i_thr]);
5e70d572 MD	453	if (err != 0)
	454	exit(1);
	455	}
83e334d0 MJ	456	for (i_thr = 0; i_thr < nr_dequeuers; i_thr++) {
	457	err = pthread_create(&tid_dequeuer[i_thr], NULL, thr_dequeuer,
	458	&count_dequeuer[4 * i_thr]);
5e70d572 MD	459	if (err != 0)
	460	exit(1);
	461	}
	462
	463	cmm_smp_mb();
	464
9e4e7ad1	465	begin_test();
5e70d572	466
83e334d0	467	for (i_thr = 0; i_thr < duration; i_thr++) {
5e70d572	468	sleep(1);
4b665350 MD	469	if (verbose_mode) {
	470	fwrite(".", sizeof(char), 1, stdout);
	471	fflush(stdout);
	472	}
5e70d572 MD	473	}
5e70d572 MD	474
9e4e7ad1	475	uatomic_store(&test_stop_enqueue, 1, CMM_RELEASE);
cf9451dc MD	476
	477	if (test_wait_empty) {
	478	while (nr_enqueuers != uatomic_read(&test_enqueue_stopped)) {
	479	sleep(1);
	480	}
	481	while (!cds_wfcq_empty(&head, &tail)) {
	482	sleep(1);
	483	}
	484	}
	485
9e4e7ad1	486	uatomic_store(&test_stop_dequeue, 1, CMM_RELAXED);
5e70d572	487
83e334d0 MJ	488	for (i_thr = 0; i_thr < nr_enqueuers; i_thr++) {
83e334d0 MJ	489	err = pthread_join(tid_enqueuer[i_thr], &tret);
5e70d572 MD	490	if (err != 0)
5e70d572 MD	491	exit(1);
83e334d0 MJ	492	tot_enqueues += count_enqueuer[3 * i_thr];
	493	tot_successful_enqueues += count_enqueuer[3 * i_thr + 1];
	494	tot_empty_dest_enqueues += count_enqueuer[3 * i_thr + 2];
5e70d572	495	}
83e334d0 MJ	496	for (i_thr = 0; i_thr < nr_dequeuers; i_thr++) {
83e334d0 MJ	497	err = pthread_join(tid_dequeuer[i_thr], &tret);
5e70d572 MD	498	if (err != 0)
5e70d572 MD	499	exit(1);
83e334d0 MJ	500	tot_dequeues += count_dequeuer[4 * i_thr];
	501	tot_successful_dequeues += count_dequeuer[4 * i_thr + 1];
	502	tot_splice += count_dequeuer[4 * i_thr + 2];
	503	tot_dequeue_last += count_dequeuer[4 * i_thr + 3];
5e70d572	504	}
83e334d0	505
db182e31	506	test_end(&end_dequeues, &tot_dequeue_last);
5e70d572 MD	507
	508	printf_verbose("total number of enqueues : %llu, dequeues %llu\n",
	509	tot_enqueues, tot_dequeues);
	510	printf_verbose("total number of successful enqueues : %llu, "
cf9451dc	511	"enqueues to empty dest : %llu, "
23ae48ef	512	"successful dequeues %llu, "
db182e31	513	"splice : %llu, dequeue_last : %llu\n",
cf9451dc MD	514	tot_successful_enqueues,
	515	tot_empty_dest_enqueues,
	516	tot_successful_dequeues,
db182e31	517	tot_splice, tot_dequeue_last);
5e70d572 MD	518	printf("SUMMARY %-25s testdur %4lu nr_enqueuers %3u wdelay %6lu "
	519	"nr_dequeuers %3u "
	520	"rdur %6lu nr_enqueues %12llu nr_dequeues %12llu "
cf9451dc MD	521	"successful enqueues %12llu enqueues to empty dest %12llu "
cf9451dc MD	522	"successful dequeues %12llu splice %12llu "
db182e31	523	"dequeue_last %llu "
5e70d572 MD	524	"end_dequeues %llu nr_ops %12llu\n",
	525	argv[0], duration, nr_enqueuers, wdelay,
	526	nr_dequeuers, rduration, tot_enqueues, tot_dequeues,
	527	tot_successful_enqueues,
cf9451dc	528	tot_empty_dest_enqueues,
db182e31 MD	529	tot_successful_dequeues, tot_splice, tot_dequeue_last,
db182e31 MD	530	end_dequeues,
5e70d572	531	tot_enqueues + tot_dequeues);
cf9451dc MD	532
cf9451dc MD	533	if (tot_successful_enqueues != tot_successful_dequeues + end_dequeues) {
5e70d572 MD	534	printf("WARNING! Discrepancy between nr succ. enqueues %llu vs "
	535	"succ. dequeues + end dequeues %llu.\n",
	536	tot_successful_enqueues,
	537	tot_successful_dequeues + end_dequeues);
cf9451dc MD	538	retval = 1;
cf9451dc MD	539	}
5e70d572	540
cf9451dc MD	541	/*
	542	* If only using splice to dequeue, the enqueuer should see
	543	* exactly as many empty queues than the number of non-empty
	544	* src splice.
	545	*/
db182e31	546	if (tot_empty_dest_enqueues != tot_dequeue_last) {
cf9451dc	547	printf("WARNING! Discrepancy between empty enqueue (%llu) and "
db182e31	548	"number of dequeue of last element (%llu)\n",
cf9451dc	549	tot_empty_dest_enqueues,
db182e31	550	tot_dequeue_last);
cf9451dc MD	551	retval = 1;
cf9451dc MD	552	}
2af1c19e	553	cds_wfcq_destroy(&head, &tail);
5e70d572 MD	554	free(count_enqueuer);
	555	free(count_dequeuer);
	556	free(tid_enqueuer);
	557	free(tid_dequeuer);
83e334d0	558
cf9451dc	559	return retval;
5e70d572	560	}