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

#include "builtin.h"
#include "perf.h"

#include "util/parse-options.h"
#include "util/trace-event.h"
#include "util/tool.h"
#include "util/session.h"
#include "util/data.h"

#define MEM_OPERATION_LOAD	0x1
#define MEM_OPERATION_STORE	0x2

/*
 * default to both load an store sampling
 */
static int mem_operation = MEM_OPERATION_LOAD | MEM_OPERATION_STORE;

struct perf_mem {
	struct perf_tool	tool;
	char const		*input_name;
	bool			hide_unresolved;
	bool			dump_raw;
	const char		*cpu_list;
	DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
};

static int __cmd_record(int argc, const char **argv)
{
	int rec_argc, i = 0, j;
	const char **rec_argv;
	int ret;

	rec_argc = argc + 7; /* max number of arguments */
	rec_argv = calloc(rec_argc + 1, sizeof(char *));
	if (!rec_argv)
		return -1;

	rec_argv[i++] = "record";

	if (mem_operation & MEM_OPERATION_LOAD)
		rec_argv[i++] = "-W";

	rec_argv[i++] = "-d";

	if (mem_operation & MEM_OPERATION_LOAD) {
		rec_argv[i++] = "-e";
		rec_argv[i++] = "cpu/mem-loads/pp";
	}

	if (mem_operation & MEM_OPERATION_STORE) {
		rec_argv[i++] = "-e";
		rec_argv[i++] = "cpu/mem-stores/pp";
	}

	for (j = 1; j < argc; j++, i++)
		rec_argv[i] = argv[j];

	ret = cmd_record(i, rec_argv, NULL);
	free(rec_argv);
	return ret;
}

static int
dump_raw_samples(struct perf_tool *tool,
		 union perf_event *event,
		 struct perf_sample *sample,
		 struct machine *machine)
{
	struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
	struct addr_location al;
	const char *fmt;

	if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
		fprintf(stderr, "problem processing %d event, skipping it.\n",
				event->header.type);
		return -1;
	}

	if (al.filtered || (mem->hide_unresolved && al.sym == NULL))
		return 0;

	if (al.map != NULL)
		al.map->dso->hit = 1;

	if (symbol_conf.field_sep) {
		fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s%"PRIu64
		      "%s0x%"PRIx64"%s%s:%s\n";
	} else {
		fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
		      "%s%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
		symbol_conf.field_sep = " ";
	}

	printf(fmt,
		sample->pid,
		symbol_conf.field_sep,
		sample->tid,
		symbol_conf.field_sep,
		sample->ip,
		symbol_conf.field_sep,
		sample->addr,
		symbol_conf.field_sep,
		sample->weight,
		symbol_conf.field_sep,
		sample->data_src,
		symbol_conf.field_sep,
		al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
		al.sym ? al.sym->name : "???");

	return 0;
}

static int process_sample_event(struct perf_tool *tool,
				union perf_event *event,
				struct perf_sample *sample,
				struct perf_evsel *evsel __maybe_unused,
				struct machine *machine)
{
	return dump_raw_samples(tool, event, sample, machine);
}

static int report_raw_events(struct perf_mem *mem)
{
	struct perf_data_file file = {
		.path = input_name,
		.mode = PERF_DATA_MODE_READ,
	};
	int err = -EINVAL;
	int ret;
	struct perf_session *session = perf_session__new(&file, false,
							 &mem->tool);

	if (session == NULL)
		return -1;

	if (mem->cpu_list) {
		ret = perf_session__cpu_bitmap(session, mem->cpu_list,
					       mem->cpu_bitmap);
		if (ret)
			goto out_delete;
	}

	if (symbol__init(&session->header.env) < 0)
		return -1;

	printf("# PID, TID, IP, ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");

	err = perf_session__process_events(session, &mem->tool);
	if (err)
		return err;

	return 0;

out_delete:
	perf_session__delete(session);
	return err;
}

static int report_events(int argc, const char **argv, struct perf_mem *mem)
{
	const char **rep_argv;
	int ret, i = 0, j, rep_argc;

	if (mem->dump_raw)
		return report_raw_events(mem);

	rep_argc = argc + 3;
	rep_argv = calloc(rep_argc + 1, sizeof(char *));
	if (!rep_argv)
		return -1;

	rep_argv[i++] = "report";
	rep_argv[i++] = "--mem-mode";
	rep_argv[i++] = "-n"; /* display number of samples */

	/*
	 * there is no weight (cost) associated with stores, so don't print
	 * the column
	 */
	if (!(mem_operation & MEM_OPERATION_LOAD))
		rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
				"dso_daddr,tlb,locked";

	for (j = 1; j < argc; j++, i++)
		rep_argv[i] = argv[j];

	ret = cmd_report(i, rep_argv, NULL);
	free(rep_argv);
	return ret;
}

struct mem_mode {
	const char *name;
	int mode;
};

#define MEM_OPT(n, m) \
	{ .name = n, .mode = (m) }

#define MEM_END { .name = NULL }

static const struct mem_mode mem_modes[]={
	MEM_OPT("load", MEM_OPERATION_LOAD),
	MEM_OPT("store", MEM_OPERATION_STORE),
	MEM_END
};

static int
parse_mem_ops(const struct option *opt, const char *str, int unset)
{
	int *mode = (int *)opt->value;
	const struct mem_mode *m;
	char *s, *os = NULL, *p;
	int ret = -1;

	if (unset)
		return 0;

	/* str may be NULL in case no arg is passed to -t */
	if (str) {
		/* because str is read-only */
		s = os = strdup(str);
		if (!s)
			return -1;

		/* reset mode */
		*mode = 0;

		for (;;) {
			p = strchr(s, ',');
			if (p)
				*p = '\0';

			for (m = mem_modes; m->name; m++) {
				if (!strcasecmp(s, m->name))
					break;
			}
			if (!m->name) {
				fprintf(stderr, "unknown sampling op %s,"
					    " check man page\n", s);
				goto error;
			}

			*mode |= m->mode;

			if (!p)
				break;

			s = p + 1;
		}
	}
	ret = 0;

	if (*mode == 0)
		*mode = MEM_OPERATION_LOAD;
error:
	free(os);
	return ret;
}

int cmd_mem(int argc, const char **argv, const char *prefix __maybe_unused)
{
	struct stat st;
	struct perf_mem mem = {
		.tool = {
			.sample		= process_sample_event,
			.mmap		= perf_event__process_mmap,
			.mmap2		= perf_event__process_mmap2,
			.comm		= perf_event__process_comm,
			.lost		= perf_event__process_lost,
			.fork		= perf_event__process_fork,
			.build_id	= perf_event__process_build_id,
			.ordered_events	= true,
		},
		.input_name		 = "perf.data",
	};
	const struct option mem_options[] = {
	OPT_CALLBACK('t', "type", &mem_operation,
		   "type", "memory operations(load,store) Default load,store",
		    parse_mem_ops),
	OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
		    "dump raw samples in ASCII"),
	OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
		    "Only display entries resolved to a symbol"),
	OPT_STRING('i', "input", &input_name, "file",
		   "input file name"),
	OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
		   "list of cpus to profile"),
	OPT_STRING('x', "field-separator", &symbol_conf.field_sep,
		   "separator",
		   "separator for columns, no spaces will be added"
		   " between columns '.' is reserved."),
	OPT_END()
	};
	const char *const mem_subcommands[] = { "record", "report", NULL };
	const char *mem_usage[] = {
		NULL,
		NULL
	};


	argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
					mem_usage, PARSE_OPT_STOP_AT_NON_OPTION);

	if (!argc || !(strncmp(argv[0], "rec", 3) || mem_operation))
		usage_with_options(mem_usage, mem_options);

	if (!mem.input_name || !strlen(mem.input_name)) {
		if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
			mem.input_name = "-";
		else
			mem.input_name = "perf.data";
	}

	if (!strncmp(argv[0], "rec", 3))
		return __cmd_record(argc, argv);
	else if (!strncmp(argv[0], "rep", 3))
		return report_events(argc, argv, &mem);
	else
		usage_with_options(mem_usage, mem_options);

	return 0;
}
Commit	Line	Data
028f12ee SE	1	#include "builtin.h"
	2	#include "perf.h"
	3
	4	#include "util/parse-options.h"
	5	#include "util/trace-event.h"
	6	#include "util/tool.h"
	7	#include "util/session.h"
f5fc1412	8	#include "util/data.h"
028f12ee	9
67121f85 SE	10	#define MEM_OPERATION_LOAD 0x1
67121f85 SE	11	#define MEM_OPERATION_STORE 0x2
028f12ee	12
67121f85 SE	13	/*
	14	* default to both load an store sampling
	15	*/
	16	static int mem_operation = MEM_OPERATION_LOAD \| MEM_OPERATION_STORE;
028f12ee SE	17
	18	struct perf_mem {
	19	struct perf_tool tool;
	20	char const *input_name;
028f12ee SE	21	bool hide_unresolved;
	22	bool dump_raw;
	23	const char *cpu_list;
	24	DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
	25	};
	26
028f12ee SE	27	static int __cmd_record(int argc, const char **argv)
	28	{
	29	int rec_argc, i = 0, j;
	30	const char **rec_argv;
028f12ee SE	31	int ret;
028f12ee SE	32
67121f85	33	rec_argc = argc + 7; /* max number of arguments */
028f12ee SE	34	rec_argv = calloc(rec_argc + 1, sizeof(char *));
	35	if (!rec_argv)
	36	return -1;
	37
67121f85	38	rec_argv[i++] = "record";
028f12ee	39
67121f85 SE	40	if (mem_operation & MEM_OPERATION_LOAD)
	41	rec_argv[i++] = "-W";
	42
	43	rec_argv[i++] = "-d";
	44
	45	if (mem_operation & MEM_OPERATION_LOAD) {
	46	rec_argv[i++] = "-e";
	47	rec_argv[i++] = "cpu/mem-loads/pp";
	48	}
	49
	50	if (mem_operation & MEM_OPERATION_STORE) {
	51	rec_argv[i++] = "-e";
	52	rec_argv[i++] = "cpu/mem-stores/pp";
	53	}
028f12ee	54
028f12ee SE	55	for (j = 1; j < argc; j++, i++)
	56	rec_argv[i] = argv[j];
	57
	58	ret = cmd_record(i, rec_argv, NULL);
	59	free(rec_argv);
	60	return ret;
	61	}
	62
	63	static int
	64	dump_raw_samples(struct perf_tool *tool,
	65	union perf_event *event,
	66	struct perf_sample *sample,
028f12ee SE	67	struct machine *machine)
	68	{
	69	struct perf_mem *mem = container_of(tool, struct perf_mem, tool);
	70	struct addr_location al;
	71	const char *fmt;
	72
e44baa3e	73	if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
028f12ee SE	74	fprintf(stderr, "problem processing %d event, skipping it.\n",
	75	event->header.type);
	76	return -1;
	77	}
	78
	79	if (al.filtered \|\| (mem->hide_unresolved && al.sym == NULL))
	80	return 0;
	81
	82	if (al.map != NULL)
	83	al.map->dso->hit = 1;
	84
	85	if (symbol_conf.field_sep) {
	86	fmt = "%d%s%d%s0x%"PRIx64"%s0x%"PRIx64"%s%"PRIu64
	87	"%s0x%"PRIx64"%s%s:%s\n";
	88	} else {
	89	fmt = "%5d%s%5d%s0x%016"PRIx64"%s0x016%"PRIx64
	90	"%s%5"PRIu64"%s0x%06"PRIx64"%s%s:%s\n";
	91	symbol_conf.field_sep = " ";
	92	}
	93
	94	printf(fmt,
	95	sample->pid,
	96	symbol_conf.field_sep,
	97	sample->tid,
	98	symbol_conf.field_sep,
ef89325f	99	sample->ip,
028f12ee SE	100	symbol_conf.field_sep,
	101	sample->addr,
	102	symbol_conf.field_sep,
	103	sample->weight,
	104	symbol_conf.field_sep,
	105	sample->data_src,
	106	symbol_conf.field_sep,
	107	al.map ? (al.map->dso ? al.map->dso->long_name : "???") : "???",
	108	al.sym ? al.sym->name : "???");
	109
	110	return 0;
	111	}
	112
	113	static int process_sample_event(struct perf_tool *tool,
	114	union perf_event *event,
	115	struct perf_sample *sample,
8b640cc4	116	struct perf_evsel *evsel __maybe_unused,
028f12ee SE	117	struct machine *machine)
028f12ee SE	118	{
8b640cc4	119	return dump_raw_samples(tool, event, sample, machine);
028f12ee SE	120	}
	121
	122	static int report_raw_events(struct perf_mem *mem)
	123	{
f5fc1412 JO	124	struct perf_data_file file = {
	125	.path = input_name,
	126	.mode = PERF_DATA_MODE_READ,
	127	};
028f12ee SE	128	int err = -EINVAL;
028f12ee SE	129	int ret;
f5fc1412 JO	130	struct perf_session *session = perf_session__new(&file, false,
f5fc1412 JO	131	&mem->tool);
028f12ee SE	132
028f12ee SE	133	if (session == NULL)
52e02834	134	return -1;
028f12ee SE	135
	136	if (mem->cpu_list) {
	137	ret = perf_session__cpu_bitmap(session, mem->cpu_list,
	138	mem->cpu_bitmap);
	139	if (ret)
	140	goto out_delete;
	141	}
	142
0a7e6d1b	143	if (symbol__init(&session->header.env) < 0)
028f12ee SE	144	return -1;
	145
	146	printf("# PID, TID, IP, ADDR, LOCAL WEIGHT, DSRC, SYMBOL\n");
	147
	148	err = perf_session__process_events(session, &mem->tool);
	149	if (err)
	150	return err;
	151
	152	return 0;
	153
	154	out_delete:
	155	perf_session__delete(session);
	156	return err;
	157	}
	158
	159	static int report_events(int argc, const char *argv, struct perf_mem mem)
	160	{
	161	const char **rep_argv;
	162	int ret, i = 0, j, rep_argc;
	163
	164	if (mem->dump_raw)
	165	return report_raw_events(mem);
	166
	167	rep_argc = argc + 3;
	168	rep_argv = calloc(rep_argc + 1, sizeof(char *));
	169	if (!rep_argv)
	170	return -1;
	171
67121f85 SE	172	rep_argv[i++] = "report";
	173	rep_argv[i++] = "--mem-mode";
	174	rep_argv[i++] = "-n"; /* display number of samples */
028f12ee SE	175
	176	/*
	177	* there is no weight (cost) associated with stores, so don't print
	178	* the column
	179	*/
67121f85 SE	180	if (!(mem_operation & MEM_OPERATION_LOAD))
	181	rep_argv[i++] = "--sort=mem,sym,dso,symbol_daddr,"
	182	"dso_daddr,tlb,locked";
028f12ee SE	183
	184	for (j = 1; j < argc; j++, i++)
	185	rep_argv[i] = argv[j];
	186
	187	ret = cmd_report(i, rep_argv, NULL);
	188	free(rep_argv);
	189	return ret;
	190	}
	191
67121f85 SE	192	struct mem_mode {
	193	const char *name;
	194	int mode;
	195	};
	196
	197	#define MEM_OPT(n, m) \
	198	{ .name = n, .mode = (m) }
	199
	200	#define MEM_END { .name = NULL }
	201
	202	static const struct mem_mode mem_modes[]={
	203	MEM_OPT("load", MEM_OPERATION_LOAD),
	204	MEM_OPT("store", MEM_OPERATION_STORE),
	205	MEM_END
	206	};
	207
	208	static int
	209	parse_mem_ops(const struct option opt, const char str, int unset)
	210	{
	211	int mode = (int )opt->value;
	212	const struct mem_mode *m;
	213	char s, os = NULL, *p;
	214	int ret = -1;
	215
	216	if (unset)
	217	return 0;
	218
	219	/* str may be NULL in case no arg is passed to -t */
	220	if (str) {
	221	/* because str is read-only */
	222	s = os = strdup(str);
	223	if (!s)
	224	return -1;
	225
	226	/* reset mode */
	227	*mode = 0;
	228
	229	for (;;) {
	230	p = strchr(s, ',');
	231	if (p)
	232	*p = '\0';
	233
	234	for (m = mem_modes; m->name; m++) {
	235	if (!strcasecmp(s, m->name))
	236	break;
	237	}
	238	if (!m->name) {
	239	fprintf(stderr, "unknown sampling op %s,"
	240	" check man page\n", s);
	241	goto error;
	242	}
	243
	244	*mode \|= m->mode;
	245
	246	if (!p)
	247	break;
	248
	249	s = p + 1;
	250	}
	251	}
	252	ret = 0;
	253
	254	if (*mode == 0)
	255	*mode = MEM_OPERATION_LOAD;
256	error:
257	free(os);
258	return ret;
259	}
260
028f12ee SE	261	int cmd_mem(int argc, const char *argv, const char prefix __maybe_unused)
	262	{
	263	struct stat st;
	264	struct perf_mem mem = {
	265	.tool = {
	266	.sample = process_sample_event,
	267	.mmap = perf_event__process_mmap,
5c5e854b	268	.mmap2 = perf_event__process_mmap2,
028f12ee SE	269	.comm = perf_event__process_comm,
	270	.lost = perf_event__process_lost,
	271	.fork = perf_event__process_fork,
	272	.build_id = perf_event__process_build_id,
0a8cb85c	273	.ordered_events = true,
028f12ee SE	274	},
	275	.input_name = "perf.data",
	276	};
	277	const struct option mem_options[] = {
67121f85 SE	278	OPT_CALLBACK('t', "type", &mem_operation,
	279	"type", "memory operations(load,store) Default load,store",
	280	parse_mem_ops),
028f12ee SE	281	OPT_BOOLEAN('D', "dump-raw-samples", &mem.dump_raw,
	282	"dump raw samples in ASCII"),
	283	OPT_BOOLEAN('U', "hide-unresolved", &mem.hide_unresolved,
	284	"Only display entries resolved to a symbol"),
	285	OPT_STRING('i', "input", &input_name, "file",
	286	"input file name"),
	287	OPT_STRING('C', "cpu", &mem.cpu_list, "cpu",
	288	"list of cpus to profile"),
	289	OPT_STRING('x', "field-separator", &symbol_conf.field_sep,
	290	"separator",
	291	"separator for columns, no spaces will be added"
	292	" between columns '.' is reserved."),
	293	OPT_END()
	294	};
8d2a2a1d RR	295	const char *const mem_subcommands[] = { "record", "report", NULL };
	296	const char *mem_usage[] = {
	297	NULL,
	298	NULL
	299	};
	300
028f12ee	301
8d2a2a1d RR	302	argc = parse_options_subcommand(argc, argv, mem_options, mem_subcommands,
8d2a2a1d RR	303	mem_usage, PARSE_OPT_STOP_AT_NON_OPTION);
028f12ee SE	304
	305	if (!argc \|\| !(strncmp(argv[0], "rec", 3) \|\| mem_operation))
	306	usage_with_options(mem_usage, mem_options);
	307
	308	if (!mem.input_name \|\| !strlen(mem.input_name)) {
	309	if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
	310	mem.input_name = "-";
	311	else
	312	mem.input_name = "perf.data";
	313	}
	314
	315	if (!strncmp(argv[0], "rec", 3))
	316	return __cmd_record(argc, argv);
	317	else if (!strncmp(argv[0], "rep", 3))
	318	return report_events(argc, argv, &mem);
	319	else
	320	usage_with_options(mem_usage, mem_options);
	321
	322	return 0;
	323	}