[urcu.git] / tests / benchmark / test_perthreadlock.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
#endif
#include <urcu.h>

struct test_array {
	int a;
};

struct per_thread_lock {
	pthread_mutex_t lock;
} __attribute__((aligned(CAA_CACHE_LINE_SIZE)));	/* cache-line aligned */

static struct per_thread_lock *per_thread_lock;

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 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) {
		errno = ret;
		perror("Error in pthread mutex lock");
		abort();
	}
	cpu = cpu_affinities[next_aff++];
	ret = pthread_mutex_unlock(&affinity_mutex);
	if (ret) {
		errno = ret;
		perror("Error in pthread mutex unlock");
		abort();
	}
	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 long long __attribute__((aligned(CAA_CACHE_LINE_SIZE))) *tot_nr_writes;
static
unsigned long long __attribute__((aligned(CAA_CACHE_LINE_SIZE))) *tot_nr_reads;

static unsigned int nr_readers;
static unsigned int nr_writers;

static void urcu_mutex_lock(pthread_mutex_t *lock)
{
	int ret;

	ret = pthread_mutex_lock(lock);
	if (ret) {
		errno = ret;
		perror("Error in pthread mutex lock");
		abort();
	}
}

static void urcu_mutex_unlock(pthread_mutex_t *lock)
{
	int ret;

	ret = pthread_mutex_unlock(lock);
	if (ret) {
		errno = ret;
		perror("Error in pthread mutex unlock");
		abort();
	}
}

void *thr_reader(void *data)
{
	unsigned long tidx = (unsigned long)data;

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

	set_affinity();

	while (!test_go)
	{
	}

	for (;;) {
		int v;

		urcu_mutex_lock(&per_thread_lock[tidx].lock);
		v = test_array.a;
		assert(v == 8);
		if (caa_unlikely(rduration))
			loop_sleep(rduration);
		urcu_mutex_unlock(&per_thread_lock[tidx].lock);
		URCU_TLS(nr_reads)++;
		if (caa_unlikely(!test_duration_read()))
			break;
	}

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

}

void *thr_writer(void *data)
{
	unsigned long wtidx = (unsigned long)data;
	long tidx;

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

	set_affinity();

	while (!test_go)
	{
	}
	cmm_smp_mb();

	for (;;) {
		for (tidx = 0; tidx < nr_readers; tidx++) {
			urcu_mutex_lock(&per_thread_lock[tidx].lock);
		}
		test_array.a = 0;
		test_array.a = 8;
		if (caa_unlikely(wduration))
			loop_sleep(wduration);
		for (tidx = (long)nr_readers - 1; tidx >= 0; tidx--) {
			urcu_mutex_unlock(&per_thread_lock[tidx].lock);
		}
		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());
	tot_nr_writes[wtidx] = 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");
	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 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]) {
		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));
	tot_nr_reads = calloc(nr_readers, sizeof(*tot_nr_reads));
	tot_nr_writes = calloc(nr_writers, sizeof(*tot_nr_writes));
	per_thread_lock = calloc(nr_readers, sizeof(*per_thread_lock));
	for (i = 0; i < nr_readers; i++) {
		pthread_mutex_init(&per_thread_lock[i].lock, NULL);
	}

	next_aff = 0;

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