[urcu.git] / tests / test_urcu_wfs.c

/*
 * test_urcu_wfs.c
 *
 * Userspace RCU library - example RCU-based lock-free stack
 *
 * Copyright February 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 * Copyright February 2010 - Paolo Bonzini <pbonzini@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#define _GNU_SOURCE
#include "../config.h"
#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 <assert.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>
#endif

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

#if defined(_syscall0)
_syscall0(pid_t, gettid)
#elif defined(__NR_gettid)
static inline pid_t gettid(void)
{
	return syscall(__NR_gettid);
}
#else
#warning "use pid as tid"
static inline pid_t gettid(void)
{
	return getpid();
}
#endif

#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 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)
{
#if HAVE_SCHED_SETAFFINITY
	cpu_set_t mask;
	int cpu, ret;
#endif /* HAVE_SCHED_SETAFFINITY */

	if (!use_affinity)
		return;

#if 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);
#if SCHED_SETAFFINITY_ARGS == 2
	sched_setaffinity(0, &mask);
#else
	sched_setaffinity(0, sizeof(mask), &mask);
#endif
#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, thread id : %lx, tid %lu\n",
			"enqueuer", (unsigned long) pthread_self(),
			(unsigned long) gettid());

	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, thread id : %lx, tid %lu, "
		       "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);

}

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;

	printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
			"dequeuer", (unsigned long) pthread_self(),
			(unsigned long) gettid());

	set_affinity();

	while (!test_go)
	{
	}
	cmm_smp_mb();

	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, thread id : %lx, tid %lu, "
		       "dequeues %llu, successful_dequeues %llu "
		       "pop_all %llu pop_last %llu\n",
		       pthread_self(),
			(unsigned long) gettid(),
		       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(struct cds_wfs_stack *s, unsigned long long *nr_dequeues,
		unsigned long long *nr_pop_last)
{
	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)++;
			free(node);
			(*nr_dequeues)++;
		}
	} while (node);
}

static void show_usage(int argc, 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;

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

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

	err = sscanf(argv[2], "%u", &nr_enqueuers);
	if (err != 1) {
		show_usage(argc, argv);
		return -1;
	}
	
	err = sscanf(argv[3], "%lu", &duration);
	if (err != 1) {
		show_usage(argc, 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(argc, 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(argc, argv);
				return -1;
			}
			rduration = atol(argv[++i]);
			break;
		case 'd':
			if (argc < i + 2) {
				show_usage(argc, 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, thread id : %lx, tid %lu\n",
			"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(3 * sizeof(*count_enqueuer) * nr_enqueuers);
	count_dequeuer = malloc(4 * 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[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[4 * i]);
		if (err != 0)
			exit(1);
	}

	cmm_smp_mb();

	test_go = 1;

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