[deliverable/linux.git] / tools / perf / bench / mem-memcpy.c

/*
 * mem-memcpy.c
 *
 * memcpy: Simple memory copy in various ways
 *
 * Written by Hitoshi Mitake <mitake@dcl.info.waseda.ac.jp>
 */

#include "../perf.h"
#include "../util/util.h"
#include "../util/parse-options.h"
#include "../util/header.h"
#include "../util/cloexec.h"
#include "bench.h"
#include "mem-memcpy-arch.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/time.h>
#include <errno.h>

#define K 1024

static const char	*length_str	= "1MB";
static const char	*routine	= "default";
static int		iterations	= 1;
static bool		use_cycle;
static int		cycle_fd;
static bool		only_prefault;
static bool		no_prefault;

static const struct option options[] = {
	OPT_STRING('l', "length", &length_str, "1MB",
		    "Specify length of memory to copy. "
		    "Available units: B, KB, MB, GB and TB (upper and lower)"),
	OPT_STRING('r', "routine", &routine, "default",
		    "Specify routine to copy"),
	OPT_INTEGER('i', "iterations", &iterations,
		    "repeat memcpy() invocation this number of times"),
	OPT_BOOLEAN('c', "cycle", &use_cycle,
		    "Use cycles event instead of gettimeofday() for measuring"),
	OPT_BOOLEAN('o', "only-prefault", &only_prefault,
		    "Show only the result with page faults before memcpy()"),
	OPT_BOOLEAN('n', "no-prefault", &no_prefault,
		    "Show only the result without page faults before memcpy()"),
	OPT_END()
};

typedef void *(*memcpy_t)(void *, const void *, size_t);

struct routine {
	const char *name;
	const char *desc;
	memcpy_t fn;
};

struct routine routines[] = {
	{ "default",
	  "Default memcpy() provided by glibc",
	  memcpy },
#ifdef HAVE_ARCH_X86_64_SUPPORT

#define MEMCPY_FN(fn, name, desc) { name, desc, fn },
#include "mem-memcpy-x86-64-asm-def.h"
#undef MEMCPY_FN

#endif

	{ NULL,
	  NULL,
	  NULL   }
};

static const char * const bench_mem_memcpy_usage[] = {
	"perf bench mem memcpy <options>",
	NULL
};

static struct perf_event_attr cycle_attr = {
	.type		= PERF_TYPE_HARDWARE,
	.config		= PERF_COUNT_HW_CPU_CYCLES
};

static void init_cycle(void)
{
	cycle_fd = sys_perf_event_open(&cycle_attr, getpid(), -1, -1,
				       perf_event_open_cloexec_flag());

	if (cycle_fd < 0 && errno == ENOSYS)
		die("No CONFIG_PERF_EVENTS=y kernel support configured?\n");
	else
		BUG_ON(cycle_fd < 0);
}

static u64 get_cycle(void)
{
	int ret;
	u64 clk;

	ret = read(cycle_fd, &clk, sizeof(u64));
	BUG_ON(ret != sizeof(u64));

	return clk;
}

static double timeval2double(struct timeval *ts)
{
	return (double)ts->tv_sec +
		(double)ts->tv_usec / (double)1000000;
}

static void alloc_mem(void **dst, void **src, size_t length)
{
	*dst = zalloc(length);
	if (!*dst)
		die("memory allocation failed - maybe length is too large?\n");

	*src = zalloc(length);
	if (!*src)
		die("memory allocation failed - maybe length is too large?\n");
	/* Make sure to always replace the zero pages even if MMAP_THRESH is crossed */
	memset(*src, 0, length);
}

static u64 do_memcpy_cycle(memcpy_t fn, size_t len, bool prefault)
{
	u64 cycle_start = 0ULL, cycle_end = 0ULL;
	void *src = NULL, *dst = NULL;
	int i;

	alloc_mem(&src, &dst, len);

	if (prefault)
		fn(dst, src, len);

	cycle_start = get_cycle();
	for (i = 0; i < iterations; ++i)
		fn(dst, src, len);
	cycle_end = get_cycle();

	free(src);
	free(dst);
	return cycle_end - cycle_start;
}

static double do_memcpy_gettimeofday(memcpy_t fn, size_t len, bool prefault)
{
	struct timeval tv_start, tv_end, tv_diff;
	void *src = NULL, *dst = NULL;
	int i;

	alloc_mem(&src, &dst, len);

	if (prefault)
		fn(dst, src, len);

	BUG_ON(gettimeofday(&tv_start, NULL));
	for (i = 0; i < iterations; ++i)
		fn(dst, src, len);
	BUG_ON(gettimeofday(&tv_end, NULL));

	timersub(&tv_end, &tv_start, &tv_diff);

	free(src);
	free(dst);
	return (double)((double)len / timeval2double(&tv_diff));
}

#define pf (no_prefault ? 0 : 1)

#define print_bps(x) do {					\
		if (x < K)					\
			printf(" %14lf B/Sec", x);		\
		else if (x < K * K)				\
			printf(" %14lfd KB/Sec", x / K);	\
		else if (x < K * K * K)				\
			printf(" %14lf MB/Sec", x / K / K);	\
		else						\
			printf(" %14lf GB/Sec", x / K / K / K); \
	} while (0)

int bench_mem_memcpy(int argc, const char **argv,
		     const char *prefix __maybe_unused)
{
	int i;
	size_t len;
	double result_bps[2];
	u64 result_cycle[2];

	argc = parse_options(argc, argv, options,
			     bench_mem_memcpy_usage, 0);

	if (no_prefault && only_prefault) {
		fprintf(stderr, "Invalid options: -o and -n are mutually exclusive\n");
		return 1;
	}

	if (use_cycle)
		init_cycle();

	len = (size_t)perf_atoll((char *)length_str);

	result_cycle[0] = result_cycle[1] = 0ULL;
	result_bps[0] = result_bps[1] = 0.0;

	if ((s64)len <= 0) {
		fprintf(stderr, "Invalid length:%s\n", length_str);
		return 1;
	}

	/* same to without specifying either of prefault and no-prefault */
	if (only_prefault && no_prefault)
		only_prefault = no_prefault = false;

	for (i = 0; routines[i].name; i++) {
		if (!strcmp(routines[i].name, routine))
			break;
	}
	if (!routines[i].name) {
		printf("Unknown routine:%s\n", routine);
		printf("Available routines...\n");
		for (i = 0; routines[i].name; i++) {
			printf("\t%s ... %s\n",
			       routines[i].name, routines[i].desc);
		}
		return 1;
	}

	if (bench_format == BENCH_FORMAT_DEFAULT)
		printf("# Copying %s Bytes ...\n\n", length_str);

	if (!only_prefault && !no_prefault) {
		/* show both of results */
		if (use_cycle) {
			result_cycle[0] =
				do_memcpy_cycle(routines[i].fn, len, false);
			result_cycle[1] =
				do_memcpy_cycle(routines[i].fn, len, true);
		} else {
			result_bps[0] =
				do_memcpy_gettimeofday(routines[i].fn,
						len, false);
			result_bps[1] =
				do_memcpy_gettimeofday(routines[i].fn,
						len, true);
		}
	} else {
		if (use_cycle) {
			result_cycle[pf] =
				do_memcpy_cycle(routines[i].fn,
						len, only_prefault);
		} else {
			result_bps[pf] =
				do_memcpy_gettimeofday(routines[i].fn,
						len, only_prefault);
		}
	}

	switch (bench_format) {
	case BENCH_FORMAT_DEFAULT:
		if (!only_prefault && !no_prefault) {
			if (use_cycle) {
				printf(" %14lf Cycle/Byte\n",
					(double)result_cycle[0]
					/ (double)len);
				printf(" %14lf Cycle/Byte (with prefault)\n",
					(double)result_cycle[1]
					/ (double)len);
			} else {
				print_bps(result_bps[0]);
				printf("\n");
				print_bps(result_bps[1]);
				printf(" (with prefault)\n");
			}
		} else {
			if (use_cycle) {
				printf(" %14lf Cycle/Byte",
					(double)result_cycle[pf]
					/ (double)len);
			} else
				print_bps(result_bps[pf]);

			printf("%s\n", only_prefault ? " (with prefault)" : "");
		}
		break;
	case BENCH_FORMAT_SIMPLE:
		if (!only_prefault && !no_prefault) {
			if (use_cycle) {
				printf("%lf %lf\n",
					(double)result_cycle[0] / (double)len,
					(double)result_cycle[1] / (double)len);
			} else {
				printf("%lf %lf\n",
					result_bps[0], result_bps[1]);
			}
		} else {
			if (use_cycle) {
				printf("%lf\n", (double)result_cycle[pf]
					/ (double)len);
			} else
				printf("%lf\n", result_bps[pf]);
		}
		break;
	default:
		/* reaching this means there's some disaster: */
		die("unknown format: %d\n", bench_format);
		break;
	}

	return 0;
}
Commit	Line	Data
827f3b49 HM	1	/*
	2	* mem-memcpy.c
	3	*
	4	* memcpy: Simple memory copy in various ways
	5	*
	6	* Written by Hitoshi Mitake <mitake@dcl.info.waseda.ac.jp>
	7	*/
827f3b49 HM	8
	9	#include "../perf.h"
	10	#include "../util/util.h"
	11	#include "../util/parse-options.h"
827f3b49	12	#include "../util/header.h"
57480d2c	13	#include "../util/cloexec.h"
827f3b49	14	#include "bench.h"
49ce8fc6	15	#include "mem-memcpy-arch.h"
827f3b49 HM	16
	17	#include <stdio.h>
	18	#include <stdlib.h>
	19	#include <string.h>
	20	#include <sys/time.h>
	21	#include <errno.h>
	22
	23	#define K 1024
	24
12eac0bf HM	25	static const char *length_str = "1MB";
12eac0bf HM	26	static const char *routine = "default";
e3e877e7	27	static int iterations = 1;
17d7a112 HM	28	static bool use_cycle;
17d7a112 HM	29	static int cycle_fd;
49ce8fc6 HM	30	static bool only_prefault;
49ce8fc6 HM	31	static bool no_prefault;
827f3b49 HM	32
	33	static const struct option options[] = {
	34	OPT_STRING('l', "length", &length_str, "1MB",
	35	"Specify length of memory to copy. "
08942f6d	36	"Available units: B, KB, MB, GB and TB (upper and lower)"),
827f3b49 HM	37	OPT_STRING('r', "routine", &routine, "default",
827f3b49 HM	38	"Specify routine to copy"),
e3e877e7 JB	39	OPT_INTEGER('i', "iterations", &iterations,
e3e877e7 JB	40	"repeat memcpy() invocation this number of times"),
17d7a112	41	OPT_BOOLEAN('c', "cycle", &use_cycle,
08942f6d	42	"Use cycles event instead of gettimeofday() for measuring"),
49ce8fc6 HM	43	OPT_BOOLEAN('o', "only-prefault", &only_prefault,
	44	"Show only the result with page faults before memcpy()"),
	45	OPT_BOOLEAN('n', "no-prefault", &no_prefault,
	46	"Show only the result without page faults before memcpy()"),
827f3b49 HM	47	OPT_END()
	48	};
	49
49ce8fc6 HM	50	typedef void (memcpy_t)(void , const void , size_t);
49ce8fc6 HM	51
827f3b49 HM	52	struct routine {
	53	const char *name;
	54	const char *desc;
49ce8fc6	55	memcpy_t fn;
827f3b49 HM	56	};
	57
	58	struct routine routines[] = {
	59	{ "default",
	60	"Default memcpy() provided by glibc",
	61	memcpy },
89fe808a	62	#ifdef HAVE_ARCH_X86_64_SUPPORT
49ce8fc6 HM	63
	64	#define MEMCPY_FN(fn, name, desc) { name, desc, fn },
	65	#include "mem-memcpy-x86-64-asm-def.h"
	66	#undef MEMCPY_FN
	67
	68	#endif
	69
827f3b49 HM	70	{ NULL,
	71	NULL,
	72	NULL }
	73	};
	74
	75	static const char * const bench_mem_memcpy_usage[] = {
	76	"perf bench mem memcpy <options>",
	77	NULL
	78	};
	79
17d7a112	80	static struct perf_event_attr cycle_attr = {
12eac0bf HM	81	.type = PERF_TYPE_HARDWARE,
12eac0bf HM	82	.config = PERF_COUNT_HW_CPU_CYCLES
827f3b49 HM	83	};
827f3b49 HM	84
17d7a112	85	static void init_cycle(void)
827f3b49	86	{
57480d2c YD	87	cycle_fd = sys_perf_event_open(&cycle_attr, getpid(), -1, -1,
57480d2c YD	88	perf_event_open_cloexec_flag());
12eac0bf	89
17d7a112	90	if (cycle_fd < 0 && errno == ENOSYS)
12eac0bf HM	91	die("No CONFIG_PERF_EVENTS=y kernel support configured?\n");
12eac0bf HM	92	else
17d7a112	93	BUG_ON(cycle_fd < 0);
827f3b49 HM	94	}
827f3b49 HM	95
17d7a112	96	static u64 get_cycle(void)
827f3b49 HM	97	{
	98	int ret;
	99	u64 clk;
	100
17d7a112	101	ret = read(cycle_fd, &clk, sizeof(u64));
827f3b49 HM	102	BUG_ON(ret != sizeof(u64));
	103
	104	return clk;
	105	}
	106
	107	static double timeval2double(struct timeval *ts)
	108	{
	109	return (double)ts->tv_sec +
	110	(double)ts->tv_usec / (double)1000000;
	111	}
	112
49ce8fc6 HM	113	static void alloc_mem(void dst, void src, size_t length)
	114	{
	115	*dst = zalloc(length);
13966721	116	if (!*dst)
49ce8fc6 HM	117	die("memory allocation failed - maybe length is too large?\n");
	118
	119	*src = zalloc(length);
13966721	120	if (!*src)
49ce8fc6	121	die("memory allocation failed - maybe length is too large?\n");
a198996c AK	122	/* Make sure to always replace the zero pages even if MMAP_THRESH is crossed */
a198996c AK	123	memset(*src, 0, length);
49ce8fc6 HM	124	}
49ce8fc6 HM	125
17d7a112	126	static u64 do_memcpy_cycle(memcpy_t fn, size_t len, bool prefault)
49ce8fc6	127	{
17d7a112	128	u64 cycle_start = 0ULL, cycle_end = 0ULL;
49ce8fc6	129	void src = NULL, dst = NULL;
e3e877e7	130	int i;
49ce8fc6 HM	131
	132	alloc_mem(&src, &dst, len);
	133
	134	if (prefault)
	135	fn(dst, src, len);
	136
17d7a112	137	cycle_start = get_cycle();
e3e877e7 JB	138	for (i = 0; i < iterations; ++i)
e3e877e7 JB	139	fn(dst, src, len);
17d7a112	140	cycle_end = get_cycle();
49ce8fc6 HM	141
	142	free(src);
	143	free(dst);
17d7a112	144	return cycle_end - cycle_start;
49ce8fc6 HM	145	}
	146
	147	static double do_memcpy_gettimeofday(memcpy_t fn, size_t len, bool prefault)
	148	{
	149	struct timeval tv_start, tv_end, tv_diff;
	150	void src = NULL, dst = NULL;
e3e877e7	151	int i;
49ce8fc6 HM	152
	153	alloc_mem(&src, &dst, len);
	154
	155	if (prefault)
	156	fn(dst, src, len);
	157
	158	BUG_ON(gettimeofday(&tv_start, NULL));
e3e877e7 JB	159	for (i = 0; i < iterations; ++i)
e3e877e7 JB	160	fn(dst, src, len);
49ce8fc6 HM	161	BUG_ON(gettimeofday(&tv_end, NULL));
	162
	163	timersub(&tv_end, &tv_start, &tv_diff);
	164
	165	free(src);
	166	free(dst);
	167	return (double)((double)len / timeval2double(&tv_diff));
	168	}
	169
	170	#define pf (no_prefault ? 0 : 1)
	171
	172	#define print_bps(x) do { \
	173	if (x < K) \
	174	printf(" %14lf B/Sec", x); \
	175	else if (x < K * K) \
	176	printf(" %14lfd KB/Sec", x / K); \
	177	else if (x < K * K * K) \
	178	printf(" %14lf MB/Sec", x / K / K); \
	179	else \
	180	printf(" %14lf GB/Sec", x / K / K / K); \
	181	} while (0)
	182
827f3b49	183	int bench_mem_memcpy(int argc, const char **argv,
1d037ca1	184	const char *prefix __maybe_unused)
827f3b49 HM	185	{
827f3b49 HM	186	int i;
49ce8fc6 HM	187	size_t len;
49ce8fc6 HM	188	double result_bps[2];
17d7a112	189	u64 result_cycle[2];
827f3b49	190
827f3b49 HM	191	argc = parse_options(argc, argv, options,
	192	bench_mem_memcpy_usage, 0);
	193
424e9634 DB	194	if (no_prefault && only_prefault) {
	195	fprintf(stderr, "Invalid options: -o and -n are mutually exclusive\n");
	196	return 1;
	197	}
	198
17d7a112 HM	199	if (use_cycle)
17d7a112 HM	200	init_cycle();
49ce8fc6 HM	201
49ce8fc6 HM	202	len = (size_t)perf_atoll((char *)length_str);
12eac0bf	203
17d7a112	204	result_cycle[0] = result_cycle[1] = 0ULL;
49ce8fc6 HM	205	result_bps[0] = result_bps[1] = 0.0;
	206
	207	if ((s64)len <= 0) {
827f3b49 HM	208	fprintf(stderr, "Invalid length:%s\n", length_str);
	209	return 1;
	210	}
	211
49ce8fc6 HM	212	/* same to without specifying either of prefault and no-prefault */
	213	if (only_prefault && no_prefault)
	214	only_prefault = no_prefault = false;
	215
827f3b49 HM	216	for (i = 0; routines[i].name; i++) {
	217	if (!strcmp(routines[i].name, routine))
	218	break;
	219	}
	220	if (!routines[i].name) {
	221	printf("Unknown routine:%s\n", routine);
	222	printf("Available routines...\n");
	223	for (i = 0; routines[i].name; i++) {
	224	printf("\t%s ... %s\n",
	225	routines[i].name, routines[i].desc);
	226	}
	227	return 1;
	228	}
	229
49ce8fc6 HM	230	if (bench_format == BENCH_FORMAT_DEFAULT)
49ce8fc6 HM	231	printf("# Copying %s Bytes ...\n\n", length_str);
827f3b49	232
49ce8fc6 HM	233	if (!only_prefault && !no_prefault) {
49ce8fc6 HM	234	/* show both of results */
17d7a112 HM	235	if (use_cycle) {
	236	result_cycle[0] =
	237	do_memcpy_cycle(routines[i].fn, len, false);
	238	result_cycle[1] =
	239	do_memcpy_cycle(routines[i].fn, len, true);
49ce8fc6 HM	240	} else {
	241	result_bps[0] =
	242	do_memcpy_gettimeofday(routines[i].fn,
	243	len, false);
	244	result_bps[1] =
	245	do_memcpy_gettimeofday(routines[i].fn,
	246	len, true);
	247	}
827f3b49	248	} else {
17d7a112 HM	249	if (use_cycle) {
	250	result_cycle[pf] =
	251	do_memcpy_cycle(routines[i].fn,
49ce8fc6 HM	252	len, only_prefault);
	253	} else {
	254	result_bps[pf] =
	255	do_memcpy_gettimeofday(routines[i].fn,
	256	len, only_prefault);
	257	}
827f3b49 HM	258	}
	259
	260	switch (bench_format) {
	261	case BENCH_FORMAT_DEFAULT:
49ce8fc6	262	if (!only_prefault && !no_prefault) {
17d7a112 HM	263	if (use_cycle) {
	264	printf(" %14lf Cycle/Byte\n",
	265	(double)result_cycle[0]
49ce8fc6	266	/ (double)len);
17d7a112 HM	267	printf(" %14lf Cycle/Byte (with prefault)\n",
17d7a112 HM	268	(double)result_cycle[1]
49ce8fc6 HM	269	/ (double)len);
	270	} else {
	271	print_bps(result_bps[0]);
	272	printf("\n");
	273	print_bps(result_bps[1]);
	274	printf(" (with prefault)\n");
827f3b49	275	}
49ce8fc6	276	} else {
17d7a112 HM	277	if (use_cycle) {
	278	printf(" %14lf Cycle/Byte",
	279	(double)result_cycle[pf]
49ce8fc6 HM	280	/ (double)len);
	281	} else
	282	print_bps(result_bps[pf]);
	283
	284	printf("%s\n", only_prefault ? " (with prefault)" : "");
827f3b49 HM	285	}
	286	break;
	287	case BENCH_FORMAT_SIMPLE:
49ce8fc6	288	if (!only_prefault && !no_prefault) {
17d7a112	289	if (use_cycle) {
49ce8fc6	290	printf("%lf %lf\n",
17d7a112 HM	291	(double)result_cycle[0] / (double)len,
17d7a112 HM	292	(double)result_cycle[1] / (double)len);
49ce8fc6 HM	293	} else {
	294	printf("%lf %lf\n",
	295	result_bps[0], result_bps[1]);
	296	}
	297	} else {
17d7a112 HM	298	if (use_cycle) {
17d7a112 HM	299	printf("%lf\n", (double)result_cycle[pf]
49ce8fc6 HM	300	/ (double)len);
	301	} else
	302	printf("%lf\n", result_bps[pf]);
	303	}
827f3b49 HM	304	break;
827f3b49 HM	305	default:
12eac0bf HM	306	/* reaching this means there's some disaster: */
12eac0bf HM	307	die("unknown format: %d\n", bench_format);
827f3b49 HM	308	break;
	309	}
	310
	311	return 0;
	312	}