[urcu.git] / tests / benchmark / test_urcu.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/assert.h>
#include <urcu/arch.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.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();

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