[urcu.git] / tests / benchmark / test_urcu_wfs.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 stack
 */

#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/wfstack.h>

/*
 * 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;

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_pop, test_pop_all, 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 !test_stop_dequeue;
}

static int test_duration_enqueue(void)
{
	return !test_stop_enqueue;
}

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_pop_all);
static DEFINE_URCU_TLS(unsigned long long, nr_pop_last);

static unsigned int nr_enqueuers;
static unsigned int nr_dequeuers;

static struct cds_wfs_stack s;

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();

	while (!test_go)
	{
	}
	cmm_smp_mb();

	for (;;) {
		struct cds_wfs_node *node = malloc(sizeof(*node));
		if (!node)
			goto fail;
		cds_wfs_node_init(node);
		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:
		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_pop(enum test_sync sync)
{
	struct cds_wfs_node *node;
	int state;

	if (sync == TEST_SYNC_MUTEX)
		cds_wfs_pop_lock(&s);
	node = __cds_wfs_pop_with_state_blocking(&s, &state);
	if (sync == TEST_SYNC_MUTEX)
		cds_wfs_pop_unlock(&s);

	if (node) {
		if (state & CDS_WFS_STATE_LAST)
			URCU_TLS(nr_pop_last)++;
		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)++;
	URCU_TLS(nr_pop_last)++;

	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 = 0;

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

	set_affinity();

	while (!test_go)
	{
	}
	cmm_smp_mb();

	urcu_posix_assert(test_pop || test_pop_all);

	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);
		}

		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 "
			"pop_all %llu pop_last %llu\n",
			urcu_get_thread_id(),
			URCU_TLS(nr_dequeues), URCU_TLS(nr_successful_dequeues),
			URCU_TLS(nr_pop_all),
			URCU_TLS(nr_pop_last));
	count[0] = URCU_TLS(nr_dequeues);
	count[1] = URCU_TLS(nr_successful_dequeues);
	count[2] = URCU_TLS(nr_pop_all);
	count[3] = URCU_TLS(nr_pop_last);
	return ((void*)2);
}

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

	do {
		node = cds_wfs_pop_with_state_blocking(&s, &state);
		if (node) {
			if (state & CDS_WFS_STATE_LAST)
				(*nr_pop_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("	[-p] (test pop)\n");
	printf("	[-P] (test pop_all, 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 stack\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_pop_all = 0, tot_pop_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 '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, 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_wfs_init(&s);

	next_aff = 0;

	for (i_thr = 0; i_thr < nr_enqueuers; i_thr++) {
		err = pthread_create(&tid_enqueuer[i], 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();

	test_go = 1;

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

	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_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_pop_all += count_dequeuer[4 * i_thr + 2];
		tot_pop_last += count_dequeuer[4 * i_thr + 3];
	}

	test_end(&end_dequeues, &tot_pop_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, "
		       "pop_all : %llu, pop_last : %llu\n",
		       tot_successful_enqueues,
		       tot_empty_dest_enqueues,
		       tot_successful_dequeues,
		       tot_pop_all, tot_pop_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 pop_all %12llu "
		"pop_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_pop_all, tot_pop_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;
	}
	/*
	 * The enqueuer should see exactly as many empty queues than the
	 * number of non-empty stacks dequeued.
	 */
	if (tot_empty_dest_enqueues != tot_pop_last) {
		printf("WARNING! Discrepancy between empty enqueue (%llu) and "
			"number of pop last (%llu)\n",
			tot_empty_dest_enqueues,
			tot_pop_last);
		retval = 1;
	}

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