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

// SPDX-FileCopyrightText: 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
//
// SPDX-License-Identifier: GPL-2.0-or-later

/*
 * Userspace RCU library - test program
 */

#include <stdio.h>
#include <pthread.h>
#include <stdlib.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 "thread-id.h"
#include "../common/debug-yield.h"

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

#ifndef DYNAMIC_LINK_TEST
#define _LGPL_SOURCE
#endif
#include <urcu-bp.h>

static unsigned long wdelay;

static int *test_rcu_pointer;

static unsigned long duration;

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

/* write-side C.S. duration, in loops */
static unsigned long wduration;

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

static int verbose_mode;

#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 */
}

static DEFINE_URCU_TLS(unsigned long long, nr_writes);
static DEFINE_URCU_TLS(unsigned long long, nr_reads);

static unsigned int nr_readers;
static unsigned int nr_writers;

pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;

static
void *thr_reader(void *_count)
{
	unsigned long long *count = _count;
	int *local_ptr;

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

	set_affinity();

	rcu_register_thread();
	urcu_posix_assert(!rcu_read_ongoing());

	wait_until_go();

	for (;;) {
		rcu_read_lock();
		urcu_posix_assert(rcu_read_ongoing());
		local_ptr = rcu_dereference(test_rcu_pointer);
		rcu_debug_yield_read();
		if (local_ptr)
			urcu_posix_assert(*local_ptr == 8);
		if (caa_unlikely(rduration))
			loop_sleep(rduration);
		rcu_read_unlock();
		URCU_TLS(nr_reads)++;
		if (caa_unlikely(!test_duration_read()))
			break;
	}

	rcu_unregister_thread();

	*count = URCU_TLS(nr_reads);
	printf_verbose("thread_end %s, tid %lu\n",
			"reader", urcu_get_thread_id());
	return ((void*)1);

}

static
void *thr_writer(void *_count)
{
	unsigned long long *count = _count;
	int *new, *old;

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

	set_affinity();

	wait_until_go();

	for (;;) {
		new = malloc(sizeof(int));
		*new = 8;
		old = rcu_xchg_pointer(&test_rcu_pointer, new);
		if (caa_unlikely(wduration))
			loop_sleep(wduration);
		synchronize_rcu();
		if (old)
			*old = 0;
		free(old);
		URCU_TLS(nr_writes)++;
		if (caa_unlikely(!test_duration_write()))
			break;
		if (caa_unlikely(wdelay))
			loop_sleep(wdelay);
	}

	printf_verbose("thread_end %s, tid %lu\n",
			"writer", urcu_get_thread_id());
	*count = URCU_TLS(nr_writes);
	return ((void*)2);
}

static
void show_usage(char **argv)
{
	printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
		argv[0]);
	printf("OPTIONS:\n");
	printf("	[-r] [-w] (yield reader and/or writer)\n");
	printf("	[-d delay] (writer period (us))\n");
	printf("	[-c duration] (reader C.S. duration (in loops))\n");
	printf("	[-e duration] (writer C.S. duration (in loops))\n");
	printf("	[-v] (verbose output)\n");
	printf("	[-a cpu#] [-a cpu#]... (affinity)\n");
	printf("\n");
}

int main(int argc, char **argv)
{
	int err;
	pthread_t *tid_reader, *tid_writer;
	void *tret;
	unsigned long long *count_reader, *count_writer;
	unsigned long long tot_reads = 0, tot_writes = 0;
	int i, a;
	unsigned int i_thr;

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

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

	err = sscanf(argv[2], "%u", &nr_writers);
	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 'r':
			rcu_debug_yield_enable(RCU_YIELD_READ);
			break;
		case 'w':
			rcu_debug_yield_enable(RCU_YIELD_WRITE);
			break;
		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 'e':
			if (argc < i + 2) {
				show_usage(argv);
				return -1;
			}
			wduration = atol(argv[++i]);
			break;
		case 'v':
			verbose_mode = 1;
			break;
		}
	}

	printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
		duration, nr_readers, nr_writers);
	printf_verbose("Writer delay : %lu loops.\n", wdelay);
	printf_verbose("Reader duration : %lu loops.\n", rduration);
	printf_verbose("thread %-6s, tid %lu\n",
			"main", urcu_get_thread_id());

	tid_reader = calloc(nr_readers, sizeof(*tid_reader));
	tid_writer = calloc(nr_writers, sizeof(*tid_writer));
	count_reader = calloc(nr_readers, sizeof(*count_reader));
	count_writer = calloc(nr_writers, sizeof(*count_writer));

	next_aff = 0;

	for (i_thr = 0; i_thr < nr_readers; i_thr++) {
		err = pthread_create(&tid_reader[i_thr], NULL, thr_reader,
				     &count_reader[i_thr]);
		if (err != 0)
			exit(1);
	}
	for (i_thr = 0; i_thr < nr_writers; i_thr++) {
		err = pthread_create(&tid_writer[i_thr], NULL, thr_writer,
				     &count_writer[i_thr]);
		if (err != 0)
			exit(1);
	}

	test_for(duration);

	for (i_thr = 0; i_thr < nr_readers; i_thr++) {
		err = pthread_join(tid_reader[i_thr], &tret);
		if (err != 0)
			exit(1);
		tot_reads += count_reader[i_thr];
	}
	for (i_thr = 0; i_thr < nr_writers; i_thr++) {
		err = pthread_join(tid_writer[i_thr], &tret);
		if (err != 0)
			exit(1);
		tot_writes += count_writer[i_thr];
	}

	printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
	       tot_writes);
	printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
		"nr_writers %3u "
		"wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
		argv[0], duration, nr_readers, rduration, wduration,
		nr_writers, wdelay, tot_reads, tot_writes,
		tot_reads + tot_writes);

	free(test_rcu_pointer);
	free(tid_reader);
	free(tid_writer);
	free(count_reader);
	free(count_writer);

	return 0;
}
Commit	Line	Data
ce29b371 MJ	1	// SPDX-FileCopyrightText: 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	2	//
	3	// SPDX-License-Identifier: GPL-2.0-or-later
	4
fdee2e6d	5	/*
fdee2e6d	6	* Userspace RCU library - test program
fdee2e6d MD	7	*/
fdee2e6d MD	8
fdee2e6d MD	9	#include <stdio.h>
	10	#include <pthread.h>
	11	#include <stdlib.h>
	12	#include <string.h>
	13	#include <sys/types.h>
	14	#include <sys/wait.h>
	15	#include <unistd.h>
	16	#include <stdio.h>
94b343fd	17	#include <errno.h>
fdee2e6d MD	18
fdee2e6d MD	19	#include <urcu/arch.h>
01477510	20	#include <urcu/assert.h>
bd252a04	21	#include <urcu/tls-compat.h>
94df6318	22	#include "thread-id.h"
2650042a	23	#include "../common/debug-yield.h"
65fcc7e9	24
fdee2e6d MD	25	/* hardcoded number of CPUs */
	26	#define NR_CPUS 16384
	27
fdee2e6d MD	28	#ifndef DYNAMIC_LINK_TEST
fdee2e6d MD	29	#define _LGPL_SOURCE
fdee2e6d MD	30	#endif
	31	#include <urcu-bp.h>
	32
fdee2e6d MD	33	static unsigned long wdelay;
fdee2e6d MD	34
bcc74df3	35	static int *test_rcu_pointer;
fdee2e6d MD	36
	37	static unsigned long duration;
	38
	39	/* read-side C.S. duration, in loops */
	40	static unsigned long rduration;
	41
31b598e0 MD	42	/* write-side C.S. duration, in loops */
	43	static unsigned long wduration;
	44
ab0aacbe	45	static inline void loop_sleep(unsigned long loops)
fdee2e6d	46	{
ab0aacbe	47	while (loops-- != 0)
06f22bdb	48	caa_cpu_relax();
fdee2e6d MD	49	}
	50
	51	static int verbose_mode;
	52
	53	#define printf_verbose(fmt, args...) \
	54	do { \
	55	if (verbose_mode) \
	56	printf(fmt, args); \
	57	} while (0)
	58
	59	static unsigned int cpu_affinities[NR_CPUS];
	60	static unsigned int next_aff = 0;
	61	static int use_affinity = 0;
	62
	63	pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
	64
	65	static void set_affinity(void)
	66	{
2388c075	67	#ifdef HAVE_SCHED_SETAFFINITY
fdee2e6d	68	cpu_set_t mask;
95bc7fb9 MD	69	int cpu, ret;
95bc7fb9 MD	70	#endif /* HAVE_SCHED_SETAFFINITY */
fdee2e6d MD	71
	72	if (!use_affinity)
	73	return;
	74
2388c075	75	#ifdef HAVE_SCHED_SETAFFINITY
fdee2e6d MD	76	ret = pthread_mutex_lock(&affinity_mutex);
	77	if (ret) {
	78	perror("Error in pthread mutex lock");
	79	exit(-1);
	80	}
	81	cpu = cpu_affinities[next_aff++];
	82	ret = pthread_mutex_unlock(&affinity_mutex);
	83	if (ret) {
	84	perror("Error in pthread mutex unlock");
	85	exit(-1);
	86	}
d8540fc5	87
fdee2e6d MD	88	CPU_ZERO(&mask);
	89	CPU_SET(cpu, &mask);
	90	sched_setaffinity(0, sizeof(mask), &mask);
d8540fc5	91	#endif /* HAVE_SCHED_SETAFFINITY */
fdee2e6d MD	92	}
fdee2e6d MD	93
bd252a04 MD	94	static DEFINE_URCU_TLS(unsigned long long, nr_writes);
bd252a04 MD	95	static DEFINE_URCU_TLS(unsigned long long, nr_reads);
fdee2e6d MD	96
	97	static unsigned int nr_readers;
	98	static unsigned int nr_writers;
	99
	100	pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
	101
61c3fb60	102	static
fdee2e6d MD	103	void thr_reader(void _count)
	104	{
	105	unsigned long long *count = _count;
bcc74df3	106	int *local_ptr;
fdee2e6d	107
94df6318 MD	108	printf_verbose("thread_begin %s, tid %lu\n",
94df6318 MD	109	"reader", urcu_get_thread_id());
fdee2e6d MD	110
	111	set_affinity();
	112
	113	rcu_register_thread();
01477510	114	urcu_posix_assert(!rcu_read_ongoing());
fdee2e6d	115
9e4e7ad1	116	wait_until_go();
fdee2e6d MD	117
	118	for (;;) {
	119	rcu_read_lock();
01477510	120	urcu_posix_assert(rcu_read_ongoing());
fdee2e6d	121	local_ptr = rcu_dereference(test_rcu_pointer);
1de4df4b	122	rcu_debug_yield_read();
fdee2e6d	123	if (local_ptr)
01477510	124	urcu_posix_assert(*local_ptr == 8);
a0b7f7ea	125	if (caa_unlikely(rduration))
fdee2e6d MD	126	loop_sleep(rduration);
fdee2e6d MD	127	rcu_read_unlock();
bd252a04	128	URCU_TLS(nr_reads)++;
a0b7f7ea	129	if (caa_unlikely(!test_duration_read()))
fdee2e6d MD	130	break;
	131	}
	132
	133	rcu_unregister_thread();
	134
bd252a04	135	*count = URCU_TLS(nr_reads);
94df6318 MD	136	printf_verbose("thread_end %s, tid %lu\n",
94df6318 MD	137	"reader", urcu_get_thread_id());
fdee2e6d MD	138	return ((void*)1);
	139
	140	}
	141
61c3fb60	142	static
fdee2e6d MD	143	void thr_writer(void _count)
	144	{
	145	unsigned long long *count = _count;
bcc74df3	146	int new, old;
fdee2e6d	147
94df6318 MD	148	printf_verbose("thread_begin %s, tid %lu\n",
94df6318 MD	149	"writer", urcu_get_thread_id());
fdee2e6d MD	150
	151	set_affinity();
	152
9e4e7ad1	153	wait_until_go();
fdee2e6d MD	154
fdee2e6d MD	155	for (;;) {
bcc74df3 MD	156	new = malloc(sizeof(int));
bcc74df3 MD	157	*new = 8;
d2835e6f	158	old = rcu_xchg_pointer(&test_rcu_pointer, new);
a0b7f7ea	159	if (caa_unlikely(wduration))
31b598e0	160	loop_sleep(wduration);
d2835e6f	161	synchronize_rcu();
fdee2e6d	162	if (old)
bcc74df3 MD	163	*old = 0;
bcc74df3 MD	164	free(old);
bd252a04	165	URCU_TLS(nr_writes)++;
a0b7f7ea	166	if (caa_unlikely(!test_duration_write()))
fdee2e6d	167	break;
a0b7f7ea	168	if (caa_unlikely(wdelay))
fdee2e6d MD	169	loop_sleep(wdelay);
	170	}
	171
94df6318 MD	172	printf_verbose("thread_end %s, tid %lu\n",
94df6318 MD	173	"writer", urcu_get_thread_id());
bd252a04	174	*count = URCU_TLS(nr_writes);
fdee2e6d MD	175	return ((void*)2);
	176	}
	177
61c3fb60	178	static
70469b43	179	void show_usage(char **argv)
fdee2e6d	180	{
06637138 MD	181	printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
	182	argv[0]);
	183	printf("OPTIONS:\n");
06637138	184	printf(" [-r] [-w] (yield reader and/or writer)\n");
06637138 MD	185	printf(" [-d delay] (writer period (us))\n");
	186	printf(" [-c duration] (reader C.S. duration (in loops))\n");
	187	printf(" [-e duration] (writer C.S. duration (in loops))\n");
	188	printf(" [-v] (verbose output)\n");
	189	printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
fdee2e6d MD	190	printf("\n");
	191	}
	192
	193	int main(int argc, char **argv)
	194	{
	195	int err;
	196	pthread_t tid_reader, tid_writer;
	197	void *tret;
	198	unsigned long long count_reader, count_writer;
	199	unsigned long long tot_reads = 0, tot_writes = 0;
	200	int i, a;
83e334d0	201	unsigned int i_thr;
fdee2e6d MD	202
fdee2e6d MD	203	if (argc < 4) {
70469b43	204	show_usage(argv);
fdee2e6d MD	205	return -1;
	206	}
	207
	208	err = sscanf(argv[1], "%u", &nr_readers);
	209	if (err != 1) {
70469b43	210	show_usage(argv);
fdee2e6d MD	211	return -1;
	212	}
	213
	214	err = sscanf(argv[2], "%u", &nr_writers);
	215	if (err != 1) {
70469b43	216	show_usage(argv);
fdee2e6d MD	217	return -1;
fdee2e6d MD	218	}
83e334d0	219
fdee2e6d MD	220	err = sscanf(argv[3], "%lu", &duration);
fdee2e6d MD	221	if (err != 1) {
70469b43	222	show_usage(argv);
fdee2e6d MD	223	return -1;
	224	}
	225
	226	for (i = 4; i < argc; i++) {
	227	if (argv[i][0] != '-')
	228	continue;
	229	switch (argv[i][1]) {
fdee2e6d	230	case 'r':
2650042a	231	rcu_debug_yield_enable(RCU_YIELD_READ);
fdee2e6d MD	232	break;
fdee2e6d MD	233	case 'w':
2650042a	234	rcu_debug_yield_enable(RCU_YIELD_WRITE);
fdee2e6d	235	break;
fdee2e6d MD	236	case 'a':
fdee2e6d MD	237	if (argc < i + 2) {
70469b43	238	show_usage(argv);
fdee2e6d MD	239	return -1;
	240	}
	241	a = atoi(argv[++i]);
	242	cpu_affinities[next_aff++] = a;
	243	use_affinity = 1;
	244	printf_verbose("Adding CPU %d affinity\n", a);
	245	break;
	246	case 'c':
	247	if (argc < i + 2) {
70469b43	248	show_usage(argv);
fdee2e6d MD	249	return -1;
	250	}
	251	rduration = atol(argv[++i]);
	252	break;
	253	case 'd':
	254	if (argc < i + 2) {
70469b43	255	show_usage(argv);
fdee2e6d MD	256	return -1;
	257	}
	258	wdelay = atol(argv[++i]);
	259	break;
31b598e0 MD	260	case 'e':
31b598e0 MD	261	if (argc < i + 2) {
70469b43	262	show_usage(argv);
31b598e0 MD	263	return -1;
	264	}
	265	wduration = atol(argv[++i]);
	266	break;
fdee2e6d MD	267	case 'v':
	268	verbose_mode = 1;
	269	break;
	270	}
	271	}
	272
	273	printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
	274	duration, nr_readers, nr_writers);
	275	printf_verbose("Writer delay : %lu loops.\n", wdelay);
	276	printf_verbose("Reader duration : %lu loops.\n", rduration);
94df6318 MD	277	printf_verbose("thread %-6s, tid %lu\n",
94df6318 MD	278	"main", urcu_get_thread_id());
fdee2e6d	279
9aa14175 MD	280	tid_reader = calloc(nr_readers, sizeof(*tid_reader));
	281	tid_writer = calloc(nr_writers, sizeof(*tid_writer));
	282	count_reader = calloc(nr_readers, sizeof(*count_reader));
	283	count_writer = calloc(nr_writers, sizeof(*count_writer));
fdee2e6d MD	284
	285	next_aff = 0;
	286
83e334d0 MJ	287	for (i_thr = 0; i_thr < nr_readers; i_thr++) {
	288	err = pthread_create(&tid_reader[i_thr], NULL, thr_reader,
	289	&count_reader[i_thr]);
fdee2e6d MD	290	if (err != 0)
	291	exit(1);
	292	}
83e334d0 MJ	293	for (i_thr = 0; i_thr < nr_writers; i_thr++) {
	294	err = pthread_create(&tid_writer[i_thr], NULL, thr_writer,
	295	&count_writer[i_thr]);
fdee2e6d MD	296	if (err != 0)
	297	exit(1);
	298	}
	299
9e4e7ad1	300	test_for(duration);
fdee2e6d	301
83e334d0 MJ	302	for (i_thr = 0; i_thr < nr_readers; i_thr++) {
83e334d0 MJ	303	err = pthread_join(tid_reader[i_thr], &tret);
fdee2e6d MD	304	if (err != 0)
fdee2e6d MD	305	exit(1);
83e334d0	306	tot_reads += count_reader[i_thr];
fdee2e6d	307	}
83e334d0 MJ	308	for (i_thr = 0; i_thr < nr_writers; i_thr++) {
83e334d0 MJ	309	err = pthread_join(tid_writer[i_thr], &tret);
fdee2e6d MD	310	if (err != 0)
fdee2e6d MD	311	exit(1);
83e334d0	312	tot_writes += count_writer[i_thr];
fdee2e6d	313	}
83e334d0	314
fdee2e6d MD	315	printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
fdee2e6d MD	316	tot_writes);
a50a7b43	317	printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
fdee2e6d MD	318	"nr_writers %3u "
fdee2e6d MD	319	"wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
a50a7b43	320	argv[0], duration, nr_readers, rduration, wduration,
fdee2e6d MD	321	nr_writers, wdelay, tot_reads, tot_writes,
fdee2e6d MD	322	tot_reads + tot_writes);
83e334d0	323
bcc74df3	324	free(test_rcu_pointer);
fdee2e6d MD	325	free(tid_reader);
	326	free(tid_writer);
	327	free(count_reader);
	328	free(count_writer);
83e334d0	329
fdee2e6d MD	330	return 0;
fdee2e6d MD	331	}