[userspace-rcu.git] / tests / test_rwlock.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 <sched.h>
#include <errno.h>

#include <urcu/arch.h>
#include <urcu/tls-compat.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
#else
#define debug_yield_read()
#endif
#include <urcu.h>

struct test_array {
	int a;
};

pthread_rwlock_t lock = PTHREAD_RWLOCK_INITIALIZER;

static volatile int test_go, test_stop;

static unsigned long wdelay;

static volatile struct test_array test_array = { 8 };

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 l)
{
	while(l-- != 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;

#ifndef HAVE_CPU_SET_T
typedef unsigned long cpu_set_t;
# define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
# define CPU_SET(cpu, cpuset) do { *(cpuset) |= (1UL << (cpu)); } while(0)
#endif

static void set_affinity(void)
{
	cpu_set_t mask;
	int cpu;
	int ret;

	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;

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

	set_affinity();

	while (!test_go)
	{
	}

	for (;;) {
		pthread_rwlock_rdlock(&lock);
		assert(test_array.a == 8);
		if (caa_unlikely(rduration))
			loop_sleep(rduration);
		pthread_rwlock_unlock(&lock);
		URCU_TLS(nr_reads)++;
		if (caa_unlikely(!test_duration_read()))
			break;
	}

	*count = URCU_TLS(nr_reads);
	printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
			"reader", pthread_self(), (unsigned long)gettid());
	return ((void*)1);

}

void *thr_writer(void *_count)
{
	unsigned long long *count = _count;

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

	set_affinity();

	while (!test_go)
	{
	}
	cmm_smp_mb();

	for (;;) {
		pthread_rwlock_wrlock(&lock);
		test_array.a = 0;
		test_array.a = 8;
		if (caa_unlikely(wduration))
			loop_sleep(wduration);
		pthread_rwlock_unlock(&lock);
		URCU_TLS(nr_writes)++;
		if (caa_unlikely(!test_duration_write()))
			break;
		if (caa_unlikely(wdelay))
			loop_sleep(wdelay);
	}

	printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
			"writer", pthread_self(), (unsigned long)gettid());
	*count = URCU_TLS(nr_writes);
	return ((void*)2);
}

void show_usage(int argc, char **argv)
{
	printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
#ifdef DEBUG_YIELD
	printf(" [-r] [-w] (yield reader and/or writer)");
#endif
	printf(" [-d delay] (writer period (us))");
	printf(" [-c duration] (reader C.S. duration (in loops))");
	printf(" [-e duration] (writer C.S. duration (in loops))");
	printf(" [-v] (verbose output)");
	printf(" [-a cpu#] [-a cpu#]... (affinity)");
	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;
	}
	cmm_smp_mb();

	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':
			yield_active |= YIELD_READ;
			break;
		case 'w':
			yield_active |= 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, thread id : %lx, tid %lu\n",
			"main", pthread_self(), (unsigned long)gettid());

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

	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(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 <sched.h>
	35	#include <errno.h>
	36
	37	#include <urcu/arch.h>
	38	#include <urcu/tls-compat.h>
	39
	40	#ifdef __linux__
	41	#include <syscall.h>
	42	#endif
	43
	44	/* hardcoded number of CPUs */
	45	#define NR_CPUS 16384
	46
	47	#if defined(_syscall0)
	48	_syscall0(pid_t, gettid)
	49	#elif defined(__NR_gettid)
	50	static inline pid_t gettid(void)
	51	{
	52	return syscall(__NR_gettid);
	53	}
	54	#else
	55	#warning "use pid as tid"
	56	static inline pid_t gettid(void)
	57	{
	58	return getpid();
	59	}
	60	#endif
	61
	62	#ifndef DYNAMIC_LINK_TEST
	63	#define _LGPL_SOURCE
	64	#else
	65	#define debug_yield_read()
	66	#endif
	67	#include <urcu.h>
	68
	69	struct test_array {
	70	int a;
	71	};
	72
	73	pthread_rwlock_t lock = PTHREAD_RWLOCK_INITIALIZER;
	74
	75	static volatile int test_go, test_stop;
	76
	77	static unsigned long wdelay;
	78
	79	static volatile struct test_array test_array = { 8 };
	80
	81	static unsigned long duration;
	82
	83	/* read-side C.S. duration, in loops */
	84	static unsigned long rduration;
	85
	86	/* write-side C.S. duration, in loops */
	87	static unsigned long wduration;
	88
	89	static inline void loop_sleep(unsigned long l)
	90	{
	91	while(l-- != 0)
	92	caa_cpu_relax();
	93	}
	94
	95	static int verbose_mode;
	96
	97	#define printf_verbose(fmt, args...) \
	98	do { \
	99	if (verbose_mode) \
	100	printf(fmt, args); \
	101	} while (0)
	102
	103	static unsigned int cpu_affinities[NR_CPUS];
	104	static unsigned int next_aff = 0;
	105	static int use_affinity = 0;
	106
	107	pthread_mutex_t affinity_mutex = PTHREAD_MUTEX_INITIALIZER;
	108
	109	#ifndef HAVE_CPU_SET_T
	110	typedef unsigned long cpu_set_t;
	111	# define CPU_ZERO(cpuset) do { *(cpuset) = 0; } while(0)
	112	# define CPU_SET(cpu, cpuset) do { *(cpuset) \|= (1UL << (cpu)); } while(0)
	113	#endif
	114
	115	static void set_affinity(void)
	116	{
	117	cpu_set_t mask;
	118	int cpu;
	119	int ret;
	120
	121	if (!use_affinity)
	122	return;
	123
	124	#if HAVE_SCHED_SETAFFINITY
	125	ret = pthread_mutex_lock(&affinity_mutex);
	126	if (ret) {
	127	perror("Error in pthread mutex lock");
	128	exit(-1);
	129	}
	130	cpu = cpu_affinities[next_aff++];
	131	ret = pthread_mutex_unlock(&affinity_mutex);
	132	if (ret) {
	133	perror("Error in pthread mutex unlock");
	134	exit(-1);
	135	}
	136
	137	CPU_ZERO(&mask);
	138	CPU_SET(cpu, &mask);
	139	#if SCHED_SETAFFINITY_ARGS == 2
	140	sched_setaffinity(0, &mask);
	141	#else
	142	sched_setaffinity(0, sizeof(mask), &mask);
	143	#endif
	144	#endif /* HAVE_SCHED_SETAFFINITY */
	145	}
	146
	147	/*
	148	* returns 0 if test should end.
	149	*/
	150	static int test_duration_write(void)
	151	{
	152	return !test_stop;
	153	}
	154
	155	static int test_duration_read(void)
	156	{
	157	return !test_stop;
	158	}
	159
	160	static DEFINE_URCU_TLS(unsigned long long, nr_writes);
	161	static DEFINE_URCU_TLS(unsigned long long, nr_reads);
	162
	163	static unsigned int nr_readers;
	164	static unsigned int nr_writers;
	165
	166	pthread_mutex_t rcu_copy_mutex = PTHREAD_MUTEX_INITIALIZER;
	167
	168	void rcu_copy_mutex_lock(void)
	169	{
	170	int ret;
	171	ret = pthread_mutex_lock(&rcu_copy_mutex);
	172	if (ret) {
	173	perror("Error in pthread mutex lock");
	174	exit(-1);
	175	}
	176	}
	177
	178	void rcu_copy_mutex_unlock(void)
	179	{
	180	int ret;
	181
	182	ret = pthread_mutex_unlock(&rcu_copy_mutex);
	183	if (ret) {
	184	perror("Error in pthread mutex unlock");
	185	exit(-1);
	186	}
	187	}
	188
	189	void thr_reader(void _count)
	190	{
	191	unsigned long long *count = _count;
	192
	193	printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
	194	"reader", pthread_self(), (unsigned long)gettid());
	195
	196	set_affinity();
	197
	198	while (!test_go)
	199	{
	200	}
	201
	202	for (;;) {
	203	pthread_rwlock_rdlock(&lock);
	204	assert(test_array.a == 8);
	205	if (caa_unlikely(rduration))
	206	loop_sleep(rduration);
	207	pthread_rwlock_unlock(&lock);
	208	URCU_TLS(nr_reads)++;
	209	if (caa_unlikely(!test_duration_read()))
	210	break;
	211	}
	212
	213	*count = URCU_TLS(nr_reads);
	214	printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
	215	"reader", pthread_self(), (unsigned long)gettid());
	216	return ((void*)1);
	217
	218	}
	219
	220	void thr_writer(void _count)
	221	{
	222	unsigned long long *count = _count;
	223
	224	printf_verbose("thread_begin %s, thread id : %lx, tid %lu\n",
	225	"writer", pthread_self(), (unsigned long)gettid());
	226
	227	set_affinity();
	228
	229	while (!test_go)
	230	{
	231	}
	232	cmm_smp_mb();
	233
	234	for (;;) {
	235	pthread_rwlock_wrlock(&lock);
	236	test_array.a = 0;
	237	test_array.a = 8;
	238	if (caa_unlikely(wduration))
	239	loop_sleep(wduration);
	240	pthread_rwlock_unlock(&lock);
	241	URCU_TLS(nr_writes)++;
	242	if (caa_unlikely(!test_duration_write()))
	243	break;
	244	if (caa_unlikely(wdelay))
	245	loop_sleep(wdelay);
	246	}
	247
	248	printf_verbose("thread_end %s, thread id : %lx, tid %lu\n",
	249	"writer", pthread_self(), (unsigned long)gettid());
	250	*count = URCU_TLS(nr_writes);
	251	return ((void*)2);
	252	}
	253
	254	void show_usage(int argc, char **argv)
	255	{
	256	printf("Usage : %s nr_readers nr_writers duration (s)", argv[0]);
	257	#ifdef DEBUG_YIELD
	258	printf(" [-r] [-w] (yield reader and/or writer)");
	259	#endif
	260	printf(" [-d delay] (writer period (us))");
	261	printf(" [-c duration] (reader C.S. duration (in loops))");
	262	printf(" [-e duration] (writer C.S. duration (in loops))");
	263	printf(" [-v] (verbose output)");
	264	printf(" [-a cpu#] [-a cpu#]... (affinity)");
	265	printf("\n");
	266	}
	267
	268	int main(int argc, char **argv)
	269	{
	270	int err;
	271	pthread_t tid_reader, tid_writer;
	272	void *tret;
	273	unsigned long long count_reader, count_writer;
	274	unsigned long long tot_reads = 0, tot_writes = 0;
	275	int i, a;
	276
	277	if (argc < 4) {
	278	show_usage(argc, argv);
	279	return -1;
	280	}
	281	cmm_smp_mb();
	282
	283	err = sscanf(argv[1], "%u", &nr_readers);
	284	if (err != 1) {
	285	show_usage(argc, argv);
	286	return -1;
	287	}
	288
	289	err = sscanf(argv[2], "%u", &nr_writers);
	290	if (err != 1) {
	291	show_usage(argc, argv);
	292	return -1;
	293	}
	294
	295	err = sscanf(argv[3], "%lu", &duration);
	296	if (err != 1) {
	297	show_usage(argc, argv);
	298	return -1;
	299	}
	300
	301	for (i = 4; i < argc; i++) {
	302	if (argv[i][0] != '-')
	303	continue;
	304	switch (argv[i][1]) {
	305	#ifdef DEBUG_YIELD
	306	case 'r':
	307	yield_active \|= YIELD_READ;
	308	break;
	309	case 'w':
	310	yield_active \|= YIELD_WRITE;
	311	break;
	312	#endif
	313	case 'a':
	314	if (argc < i + 2) {
	315	show_usage(argc, argv);
	316	return -1;
	317	}
	318	a = atoi(argv[++i]);
	319	cpu_affinities[next_aff++] = a;
	320	use_affinity = 1;
	321	printf_verbose("Adding CPU %d affinity\n", a);
	322	break;
	323	case 'c':
	324	if (argc < i + 2) {
	325	show_usage(argc, argv);
	326	return -1;
	327	}
	328	rduration = atol(argv[++i]);
	329	break;
	330	case 'd':
	331	if (argc < i + 2) {
	332	show_usage(argc, argv);
	333	return -1;
	334	}
	335	wdelay = atol(argv[++i]);
	336	break;
	337	case 'e':
	338	if (argc < i + 2) {
	339	show_usage(argc, argv);
	340	return -1;
	341	}
	342	wduration = atol(argv[++i]);
	343	break;
	344	case 'v':
	345	verbose_mode = 1;
	346	break;
	347	}
	348	}
	349
	350	printf_verbose("running test for %lu seconds, %u readers, %u writers.\n",
	351	duration, nr_readers, nr_writers);
	352	printf_verbose("Writer delay : %lu loops.\n", wdelay);
	353	printf_verbose("Reader duration : %lu loops.\n", rduration);
	354	printf_verbose("thread %-6s, thread id : %lx, tid %lu\n",
	355	"main", pthread_self(), (unsigned long)gettid());
	356
	357	tid_reader = malloc(sizeof(tid_reader) nr_readers);
	358	tid_writer = malloc(sizeof(tid_writer) nr_writers);
	359	count_reader = malloc(sizeof(count_reader) nr_readers);
	360	count_writer = malloc(sizeof(count_writer) nr_writers);
	361
	362	next_aff = 0;
	363
	364	for (i = 0; i < nr_readers; i++) {
	365	err = pthread_create(&tid_reader[i], NULL, thr_reader,
	366	&count_reader[i]);
	367	if (err != 0)
	368	exit(1);
	369	}
	370	for (i = 0; i < nr_writers; i++) {
	371	err = pthread_create(&tid_writer[i], NULL, thr_writer,
	372	&count_writer[i]);
	373	if (err != 0)
	374	exit(1);
	375	}
	376
	377	cmm_smp_mb();
	378
	379	test_go = 1;
	380
	381	sleep(duration);
	382
	383	test_stop = 1;
	384
	385	for (i = 0; i < nr_readers; i++) {
	386	err = pthread_join(tid_reader[i], &tret);
	387	if (err != 0)
	388	exit(1);
	389	tot_reads += count_reader[i];
	390	}
	391	for (i = 0; i < nr_writers; i++) {
	392	err = pthread_join(tid_writer[i], &tret);
	393	if (err != 0)
	394	exit(1);
	395	tot_writes += count_writer[i];
	396	}
	397
	398	printf_verbose("total number of reads : %llu, writes %llu\n", tot_reads,
	399	tot_writes);
	400	printf("SUMMARY %-25s testdur %4lu nr_readers %3u rdur %6lu wdur %6lu "
	401	"nr_writers %3u "
	402	"wdelay %6lu nr_reads %12llu nr_writes %12llu nr_ops %12llu\n",
	403	argv[0], duration, nr_readers, rduration, wduration,
	404	nr_writers, wdelay, tot_reads, tot_writes,
	405	tot_reads + tot_writes);
	406
	407	free(tid_reader);
	408	free(tid_writer);
	409	free(count_reader);
	410	free(count_writer);
	411	return 0;
	412	}