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

/*
 * test_urcu.c
 *
 * Userspace RCU library - test program
 *
 * Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@efficios.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 <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 "cpuset.h"
#include "thread-id.h"

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

#ifndef DYNAMIC_LINK_TEST
#define _LGPL_SOURCE
#else
#define rcu_debug_yield_read()
#endif
#include <urcu-bp.h>

static volatile int test_go, test_stop;

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)
{
#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_write(void)
{
	return !test_stop;
}

static int test_duration_read(void)
{
	return !test_stop;
}

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;

void rcu_copy_mutex_lock(void)
{
	int ret;
	ret = pthread_mutex_lock(&rcu_copy_mutex);
	if (ret) {
		perror("Error in pthread mutex lock");
		exit(-1);
	}
}

void rcu_copy_mutex_unlock(void)
{
	int ret;

	ret = pthread_mutex_unlock(&rcu_copy_mutex);
	if (ret) {
		perror("Error in pthread mutex unlock");
		exit(-1);
	}
}

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();
	assert(!rcu_read_ongoing());

	while (!test_go)
	{
	}
	cmm_smp_mb();

	for (;;) {
		rcu_read_lock();
		assert(rcu_read_ongoing());
		local_ptr = rcu_dereference(test_rcu_pointer);
		rcu_debug_yield_read();
		if (local_ptr)
			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);

}

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

	while (!test_go)
	{
	}
	cmm_smp_mb();

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

void show_usage(int argc, char **argv)
{
	printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
		argv[0]);
	printf("OPTIONS:\n");
#ifdef DEBUG_YIELD
	printf("	[-r] [-w] (yield reader and/or writer)\n");
#endif
	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;

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

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

	err = sscanf(argv[2], "%u", &nr_writers);
	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]) {
#ifdef DEBUG_YIELD
		case 'r':
			rcu_yield_active |= RCU_YIELD_READ;
			break;
		case 'w':
			rcu_yield_active |= RCU_YIELD_WRITE;
			break;
#endif
		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 'e':
			if (argc < i + 2) {
				show_usage(argc, 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 = 0; i < nr_readers; i++) {
		err = pthread_create(&tid_reader[i], NULL, thr_reader,
				     &count_reader[i]);
		if (err != 0)
			exit(1);
	}
	for (i = 0; i < nr_writers; i++) {
		err = pthread_create(&tid_writer[i], NULL, thr_writer,
				     &count_writer[i]);
		if (err != 0)
			exit(1);
	}

	cmm_smp_mb();

	test_go = 1;

	sleep(duration);

	test_stop = 1;

	for (i = 0; i < nr_readers; i++) {
		err = pthread_join(tid_reader[i], &tret);
		if (err != 0)
			exit(1);
		tot_reads += count_reader[i];
	}
	for (i = 0; i < nr_writers; i++) {
		err = pthread_join(tid_writer[i], &tret);
		if (err != 0)
			exit(1);
		tot_writes += count_writer[i];
	}
	
	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
	1	/*
	2	* test_urcu.c
	3	*
	4	* Userspace RCU library - test program
	5	*
	6	* Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License along
	19	* with this program; if not, write to the Free Software Foundation, Inc.,
	20	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	21	*/
	22
	23	#define _GNU_SOURCE
	24	#include "config.h"
	25	#include <stdio.h>
	26	#include <pthread.h>
	27	#include <stdlib.h>
	28	#include <string.h>
	29	#include <sys/types.h>
	30	#include <sys/wait.h>
	31	#include <unistd.h>
	32	#include <stdio.h>
	33	#include <assert.h>
	34	#include <errno.h>
	35
	36	#include <urcu/arch.h>
	37	#include <urcu/tls-compat.h>
	38	#include "cpuset.h"
	39	#include "thread-id.h"
	40
	41	/* hardcoded number of CPUs */
	42	#define NR_CPUS 16384
	43
	44	#ifndef DYNAMIC_LINK_TEST
	45	#define _LGPL_SOURCE
	46	#else
	47	#define rcu_debug_yield_read()
	48	#endif
	49	#include <urcu-bp.h>
	50
	51	static volatile int test_go, test_stop;
	52
	53	static unsigned long wdelay;
	54
	55	static int *test_rcu_pointer;
	56
	57	static unsigned long duration;
	58
	59	/* read-side C.S. duration, in loops */
	60	static unsigned long rduration;
	61
	62	/* write-side C.S. duration, in loops */
	63	static unsigned long wduration;
	64
	65	static inline void loop_sleep(unsigned long loops)
	66	{
	67	while (loops-- != 0)
	68	caa_cpu_relax();
	69	}
	70
	71	static int verbose_mode;
	72
	73	#define printf_verbose(fmt, args...) \
	74	do { \
	75	if (verbose_mode) \
	76	printf(fmt, args); \
	77	} while (0)
	78
	79	static unsigned int cpu_affinities[NR_CPUS];
	80	static unsigned int next_aff = 0;
	81	static int use_affinity = 0;
	82
	83	pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
	84
	85	static void set_affinity(void)
	86	{
	87	#if HAVE_SCHED_SETAFFINITY
	88	cpu_set_t mask;
	89	int cpu, ret;
	90	#endif /* HAVE_SCHED_SETAFFINITY */
	91
	92	if (!use_affinity)
	93	return;
	94
	95	#if HAVE_SCHED_SETAFFINITY
	96	ret = pthread_mutex_lock(&affinity_mutex);
	97	if (ret) {
	98	perror("Error in pthread mutex lock");
	99	exit(-1);
	100	}
	101	cpu = cpu_affinities[next_aff++];
	102	ret = pthread_mutex_unlock(&affinity_mutex);
	103	if (ret) {
	104	perror("Error in pthread mutex unlock");
	105	exit(-1);
	106	}
	107
	108	CPU_ZERO(&mask);
	109	CPU_SET(cpu, &mask);
	110	#if SCHED_SETAFFINITY_ARGS == 2
	111	sched_setaffinity(0, &mask);
	112	#else
	113	sched_setaffinity(0, sizeof(mask), &mask);
	114	#endif
	115	#endif /* HAVE_SCHED_SETAFFINITY */
	116	}
	117
	118	/*
	119	* returns 0 if test should end.
	120	*/
	121	static int test_duration_write(void)
	122	{
	123	return !test_stop;
	124	}
	125
	126	static int test_duration_read(void)
	127	{
	128	return !test_stop;
	129	}
	130
	131	static DEFINE_URCU_TLS(unsigned long long, nr_writes);
	132	static DEFINE_URCU_TLS(unsigned long long, nr_reads);
	133
	134	static unsigned int nr_readers;
	135	static unsigned int nr_writers;
	136
	137	pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
	138
	139	void rcu_copy_mutex_lock(void)
	140	{
	141	int ret;
	142	ret = pthread_mutex_lock(&rcu_copy_mutex);
	143	if (ret) {
	144	perror("Error in pthread mutex lock");
	145	exit(-1);
	146	}
	147	}
	148
	149	void rcu_copy_mutex_unlock(void)
	150	{
	151	int ret;
	152
	153	ret = pthread_mutex_unlock(&rcu_copy_mutex);
	154	if (ret) {
	155	perror("Error in pthread mutex unlock");
	156	exit(-1);
	157	}
	158	}
	159
	160	void thr_reader(void _count)
	161	{
	162	unsigned long long *count = _count;
	163	int *local_ptr;
	164
	165	printf_verbose("thread_begin %s, tid %lu\n",
	166	"reader", urcu_get_thread_id());
	167
	168	set_affinity();
	169
	170	rcu_register_thread();
	171	assert(!rcu_read_ongoing());
	172
	173	while (!test_go)
	174	{
	175	}
	176	cmm_smp_mb();
	177
	178	for (;;) {
	179	rcu_read_lock();
	180	assert(rcu_read_ongoing());
	181	local_ptr = rcu_dereference(test_rcu_pointer);
	182	rcu_debug_yield_read();
	183	if (local_ptr)
	184	assert(*local_ptr == 8);
	185	if (caa_unlikely(rduration))
	186	loop_sleep(rduration);
	187	rcu_read_unlock();
	188	URCU_TLS(nr_reads)++;
	189	if (caa_unlikely(!test_duration_read()))
	190	break;
	191	}
	192
	193	rcu_unregister_thread();
	194
	195	*count = URCU_TLS(nr_reads);
	196	printf_verbose("thread_end %s, tid %lu\n",
	197	"reader", urcu_get_thread_id());
	198	return ((void*)1);
	199
	200	}
	201
	202	void thr_writer(void _count)
	203	{
	204	unsigned long long *count = _count;
	205	int new, old;
	206
	207	printf_verbose("thread_begin %s, tid %lu\n",
	208	"writer", urcu_get_thread_id());
	209
	210	set_affinity();
	211
	212	while (!test_go)
	213	{
	214	}
	215	cmm_smp_mb();
	216
	217	for (;;) {
	218	new = malloc(sizeof(int));
	219	*new = 8;
	220	old = rcu_xchg_pointer(&test_rcu_pointer, new);
	221	if (caa_unlikely(wduration))
	222	loop_sleep(wduration);
	223	synchronize_rcu();
	224	if (old)
	225	*old = 0;
	226	free(old);
	227	URCU_TLS(nr_writes)++;
	228	if (caa_unlikely(!test_duration_write()))
	229	break;
	230	if (caa_unlikely(wdelay))
	231	loop_sleep(wdelay);
	232	}
	233
	234	printf_verbose("thread_end %s, tid %lu\n",
	235	"writer", urcu_get_thread_id());
	236	*count = URCU_TLS(nr_writes);
	237	return ((void*)2);
	238	}
	239
	240	void show_usage(int argc, char **argv)
	241	{
	242	printf("Usage : %s nr_readers nr_writers duration (s) <OPTIONS>\n",
	243	argv[0]);
	244	printf("OPTIONS:\n");
	245	#ifdef DEBUG_YIELD
	246	printf(" [-r] [-w] (yield reader and/or writer)\n");
	247	#endif
	248	printf(" [-d delay] (writer period (us))\n");
	249	printf(" [-c duration] (reader C.S. duration (in loops))\n");
	250	printf(" [-e duration] (writer C.S. duration (in loops))\n");
	251	printf(" [-v] (verbose output)\n");
	252	printf(" [-a cpu#] [-a cpu#]... (affinity)\n");
	253	printf("\n");
	254	}
	255
	256	int main(int argc, char **argv)
	257	{
	258	int err;
	259	pthread_t tid_reader, tid_writer;
	260	void *tret;
	261	unsigned long long count_reader, count_writer;
	262	unsigned long long tot_reads = 0, tot_writes = 0;
	263	int i, a;
	264
	265	if (argc < 4) {
	266	show_usage(argc, argv);
	267	return -1;
	268	}
	269
	270	err = sscanf(argv[1], "%u", &nr_readers);
	271	if (err != 1) {
	272	show_usage(argc, argv);
	273	return -1;
	274	}
	275
	276	err = sscanf(argv[2], "%u", &nr_writers);
	277	if (err != 1) {
	278	show_usage(argc, argv);
	279	return -1;
	280	}
	281
	282	err = sscanf(argv[3], "%lu", &duration);
	283	if (err != 1) {
	284	show_usage(argc, argv);
	285	return -1;
	286	}
	287
	288	for (i = 4; i < argc; i++) {
	289	if (argv[i][0] != '-')
	290	continue;
	291	switch (argv[i][1]) {
	292	#ifdef DEBUG_YIELD
	293	case 'r':
	294	rcu_yield_active \|= RCU_YIELD_READ;
	295	break;
	296	case 'w':
	297	rcu_yield_active \|= RCU_YIELD_WRITE;
	298	break;
	299	#endif
	300	case 'a':
	301	if (argc < i + 2) {
	302	show_usage(argc, argv);
	303	return -1;
	304	}
	305	a = atoi(argv[++i]);
	306	cpu_affinities[next_aff++] = a;
	307	use_affinity = 1;
	308	printf_verbose("Adding CPU %d affinity\n", a);
	309	break;
	310	case 'c':
	311	if (argc < i + 2) {
	312	show_usage(argc, argv);
	313	return -1;
	314	}
	315	rduration = atol(argv[++i]);
	316	break;
	317	case 'd':
	318	if (argc < i + 2) {
	319	show_usage(argc, argv);
	320	return -1;
	321	}
	322	wdelay = atol(argv[++i]);
	323	break;
	324	case 'e':
	325	if (argc < i + 2) {
	326	show_usage(argc, argv);
	327	return -1;
	328	}
	329	wduration = atol(argv[++i]);
	330	break;
	331	case 'v':
	332	verbose_mode = 1;
	333	break;
	334	}
	335	}
	336
	337	printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
	338	duration, nr_readers, nr_writers);
	339	printf_verbose("Writer delay : %lu loops.\n", wdelay);
	340	printf_verbose("Reader duration : %lu loops.\n", rduration);
	341	printf_verbose("thread %-6s, tid %lu\n",
	342	"main", urcu_get_thread_id());
	343
	344	tid_reader = calloc(nr_readers, sizeof(*tid_reader));
	345	tid_writer = calloc(nr_writers, sizeof(*tid_writer));
	346	count_reader = calloc(nr_readers, sizeof(*count_reader));
	347	count_writer = calloc(nr_writers, sizeof(*count_writer));
	348
	349	next_aff = 0;
	350
	351	for (i = 0; i < nr_readers; i++) {
	352	err = pthread_create(&tid_reader[i], NULL, thr_reader,
	353	&count_reader[i]);
	354	if (err != 0)
	355	exit(1);
	356	}
	357	for (i = 0; i < nr_writers; i++) {
	358	err = pthread_create(&tid_writer[i], NULL, thr_writer,
	359	&count_writer[i]);
	360	if (err != 0)
	361	exit(1);
	362	}
	363
	364	cmm_smp_mb();
	365
	366	test_go = 1;
	367
	368	sleep(duration);
	369
	370	test_stop = 1;
	371
	372	for (i = 0; i < nr_readers; i++) {
	373	err = pthread_join(tid_reader[i], &tret);
	374	if (err != 0)
	375	exit(1);
	376	tot_reads += count_reader[i];
	377	}
	378	for (i = 0; i < nr_writers; i++) {
	379	err = pthread_join(tid_writer[i], &tret);
	380	if (err != 0)
	381	exit(1);
	382	tot_writes += count_writer[i];
	383	}
	384
	385	printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
	386	tot_writes);
	387	printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
	388	"nr_writers %3u "
	389	"wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
	390	argv[0], duration, nr_readers, rduration, wduration,
	391	nr_writers, wdelay, tot_reads, tot_writes,
	392	tot_reads + tot_writes);
	393	free(test_rcu_pointer);
	394	free(tid_reader);
	395	free(tid_writer);
	396	free(count_reader);
	397	free(count_writer);
	398	return 0;
	399	}