[mirror_ubuntu-bionic-kernel.git] / tools / perf / builtin-trace.c

#include "builtin.h"

#include "util/util.h"
#include "util/cache.h"
#include "util/symbol.h"
#include "util/thread.h"
#include "util/header.h"
#include "util/exec_cmd.h"
#include "util/trace-event.h"
#include "util/session.h"

static char const		*script_name;
static char const		*generate_script_lang;
static bool			debug_mode;
static u64			last_timestamp;
static u64			nr_unordered;

static int default_start_script(const char *script __unused,
				int argc __unused,
				const char **argv __unused)
{
	return 0;
}

static int default_stop_script(void)
{
	return 0;
}

static int default_generate_script(const char *outfile __unused)
{
	return 0;
}

static struct scripting_ops default_scripting_ops = {
	.start_script		= default_start_script,
	.stop_script		= default_stop_script,
	.process_event		= print_event,
	.generate_script	= default_generate_script,
};

static struct scripting_ops	*scripting_ops;

static void setup_scripting(void)
{
	/* make sure PERF_EXEC_PATH is set for scripts */
	perf_set_argv_exec_path(perf_exec_path());

	setup_perl_scripting();
	setup_python_scripting();

	scripting_ops = &default_scripting_ops;
}

static int cleanup_scripting(void)
{
	pr_debug("\nperf trace script stopped\n");

	return scripting_ops->stop_script();
}

#include "util/parse-options.h"

#include "perf.h"
#include "util/debug.h"

#include "util/trace-event.h"
#include "util/exec_cmd.h"

static char const		*input_name = "perf.data";

static int process_sample_event(event_t *event, struct perf_session *session)
{
	struct sample_data data;
	struct thread *thread;

	memset(&data, 0, sizeof(data));
	data.time = -1;
	data.cpu = -1;
	data.period = 1;

	event__parse_sample(event, session->sample_type, &data);

	dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event->header.misc,
		    data.pid, data.tid, data.ip, data.period);

	thread = perf_session__findnew(session, event->ip.pid);
	if (thread == NULL) {
		pr_debug("problem processing %d event, skipping it.\n",
			 event->header.type);
		return -1;
	}

	if (session->sample_type & PERF_SAMPLE_RAW) {
		if (debug_mode) {
			if (data.time < last_timestamp) {
				pr_err("Samples misordered, previous: %llu "
					"this: %llu\n", last_timestamp,
					data.time);
				nr_unordered++;
			}
			last_timestamp = data.time;
			return 0;
		}
		/*
		 * FIXME: better resolve from pid from the struct trace_entry
		 * field, although it should be the same than this perf
		 * event pid
		 */
		scripting_ops->process_event(data.cpu, data.raw_data,
					     data.raw_size,
					     data.time, thread->comm);
	}

	session->hists.stats.total_period += data.period;
	return 0;
}

static u64 nr_lost;

static int process_lost_event(event_t *event, struct perf_session *session __used)
{
	nr_lost += event->lost.lost;

	return 0;
}

static struct perf_event_ops event_ops = {
	.sample	= process_sample_event,
	.comm	= event__process_comm,
	.attr	= event__process_attr,
	.event_type = event__process_event_type,
	.tracing_data = event__process_tracing_data,
	.build_id = event__process_build_id,
	.lost = process_lost_event,
	.ordered_samples = true,
};

extern volatile int session_done;

static void sig_handler(int sig __unused)
{
	session_done = 1;
}

static int __cmd_trace(struct perf_session *session)
{
	int ret;

	signal(SIGINT, sig_handler);

	ret = perf_session__process_events(session, &event_ops);

	if (debug_mode) {
		pr_err("Misordered timestamps: %llu\n", nr_unordered);
		pr_err("Lost events: %llu\n", nr_lost);
	}

	return ret;
}

struct script_spec {
	struct list_head	node;
	struct scripting_ops	*ops;
	char			spec[0];
};

LIST_HEAD(script_specs);

static struct script_spec *script_spec__new(const char *spec,
					    struct scripting_ops *ops)
{
	struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);

	if (s != NULL) {
		strcpy(s->spec, spec);
		s->ops = ops;
	}

	return s;
}

static void script_spec__delete(struct script_spec *s)
{
	free(s->spec);
	free(s);
}

static void script_spec__add(struct script_spec *s)
{
	list_add_tail(&s->node, &script_specs);
}

static struct script_spec *script_spec__find(const char *spec)
{
	struct script_spec *s;

	list_for_each_entry(s, &script_specs, node)
		if (strcasecmp(s->spec, spec) == 0)
			return s;
	return NULL;
}

static struct script_spec *script_spec__findnew(const char *spec,
						struct scripting_ops *ops)
{
	struct script_spec *s = script_spec__find(spec);

	if (s)
		return s;

	s = script_spec__new(spec, ops);
	if (!s)
		goto out_delete_spec;

	script_spec__add(s);

	return s;

out_delete_spec:
	script_spec__delete(s);

	return NULL;
}

int script_spec_register(const char *spec, struct scripting_ops *ops)
{
	struct script_spec *s;

	s = script_spec__find(spec);
	if (s)
		return -1;

	s = script_spec__findnew(spec, ops);
	if (!s)
		return -1;

	return 0;
}

static struct scripting_ops *script_spec__lookup(const char *spec)
{
	struct script_spec *s = script_spec__find(spec);
	if (!s)
		return NULL;

	return s->ops;
}

static void list_available_languages(void)
{
	struct script_spec *s;

	fprintf(stderr, "\n");
	fprintf(stderr, "Scripting language extensions (used in "
		"perf trace -s [spec:]script.[spec]):\n\n");

	list_for_each_entry(s, &script_specs, node)
		fprintf(stderr, "  %-42s [%s]\n", s->spec, s->ops->name);

	fprintf(stderr, "\n");
}

static int parse_scriptname(const struct option *opt __used,
			    const char *str, int unset __used)
{
	char spec[PATH_MAX];
	const char *script, *ext;
	int len;

	if (strcmp(str, "lang") == 0) {
		list_available_languages();
		exit(0);
	}

	script = strchr(str, ':');
	if (script) {
		len = script - str;
		if (len >= PATH_MAX) {
			fprintf(stderr, "invalid language specifier");
			return -1;
		}
		strncpy(spec, str, len);
		spec[len] = '\0';
		scripting_ops = script_spec__lookup(spec);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
			return -1;
		}
		script++;
	} else {
		script = str;
		ext = strchr(script, '.');
		if (!ext) {
			fprintf(stderr, "invalid script extension");
			return -1;
		}
		scripting_ops = script_spec__lookup(++ext);
		if (!scripting_ops) {
			fprintf(stderr, "invalid script extension");
			return -1;
		}
	}

	script_name = strdup(script);

	return 0;
}

#define for_each_lang(scripts_dir, lang_dirent, lang_next)		\
	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
	       lang_next)						\
		if (lang_dirent.d_type == DT_DIR &&			\
		    (strcmp(lang_dirent.d_name, ".")) &&		\
		    (strcmp(lang_dirent.d_name, "..")))

#define for_each_script(lang_dir, script_dirent, script_next)		\
	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
	       script_next)						\
		if (script_dirent.d_type != DT_DIR)


#define RECORD_SUFFIX			"-record"
#define REPORT_SUFFIX			"-report"

struct script_desc {
	struct list_head	node;
	char			*name;
	char			*half_liner;
	char			*args;
};

LIST_HEAD(script_descs);

static struct script_desc *script_desc__new(const char *name)
{
	struct script_desc *s = zalloc(sizeof(*s));

	if (s != NULL)
		s->name = strdup(name);

	return s;
}

static void script_desc__delete(struct script_desc *s)
{
	free(s->name);
	free(s);
}

static void script_desc__add(struct script_desc *s)
{
	list_add_tail(&s->node, &script_descs);
}

static struct script_desc *script_desc__find(const char *name)
{
	struct script_desc *s;

	list_for_each_entry(s, &script_descs, node)
		if (strcasecmp(s->name, name) == 0)
			return s;
	return NULL;
}

static struct script_desc *script_desc__findnew(const char *name)
{
	struct script_desc *s = script_desc__find(name);

	if (s)
		return s;

	s = script_desc__new(name);
	if (!s)
		goto out_delete_desc;

	script_desc__add(s);

	return s;

out_delete_desc:
	script_desc__delete(s);

	return NULL;
}

static char *ends_with(char *str, const char *suffix)
{
	size_t suffix_len = strlen(suffix);
	char *p = str;

	if (strlen(str) > suffix_len) {
		p = str + strlen(str) - suffix_len;
		if (!strncmp(p, suffix, suffix_len))
			return p;
	}

	return NULL;
}

static char *ltrim(char *str)
{
	int len = strlen(str);

	while (len && isspace(*str)) {
		len--;
		str++;
	}

	return str;
}

static int read_script_info(struct script_desc *desc, const char *filename)
{
	char line[BUFSIZ], *p;
	FILE *fp;

	fp = fopen(filename, "r");
	if (!fp)
		return -1;

	while (fgets(line, sizeof(line), fp)) {
		p = ltrim(line);
		if (strlen(p) == 0)
			continue;
		if (*p != '#')
			continue;
		p++;
		if (strlen(p) && *p == '!')
			continue;

		p = ltrim(p);
		if (strlen(p) && p[strlen(p) - 1] == '\n')
			p[strlen(p) - 1] = '\0';

		if (!strncmp(p, "description:", strlen("description:"))) {
			p += strlen("description:");
			desc->half_liner = strdup(ltrim(p));
			continue;
		}

		if (!strncmp(p, "args:", strlen("args:"))) {
			p += strlen("args:");
			desc->args = strdup(ltrim(p));
			continue;
		}
	}

	fclose(fp);

	return 0;
}

static int list_available_scripts(const struct option *opt __used,
				  const char *s __used, int unset __used)
{
	struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
	char scripts_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char script_path[MAXPATHLEN];
	char lang_path[MAXPATHLEN];
	struct script_desc *desc;
	char first_half[BUFSIZ];
	char *script_root;
	char *str;

	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());

	scripts_dir = opendir(scripts_path);
	if (!scripts_dir)
		return -1;

	for_each_lang(scripts_dir, lang_dirent, lang_next) {
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

		for_each_script(lang_dir, script_dirent, script_next) {
			script_root = strdup(script_dirent.d_name);
			str = ends_with(script_root, REPORT_SUFFIX);
			if (str) {
				*str = '\0';
				desc = script_desc__findnew(script_root);
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				read_script_info(desc, script_path);
			}
			free(script_root);
		}
	}

	fprintf(stdout, "List of available trace scripts:\n");
	list_for_each_entry(desc, &script_descs, node) {
		sprintf(first_half, "%s %s", desc->name,
			desc->args ? desc->args : "");
		fprintf(stdout, "  %-36s %s\n", first_half,
			desc->half_liner ? desc->half_liner : "");
	}

	exit(0);
}

static char *get_script_path(const char *script_root, const char *suffix)
{
	struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
	char scripts_path[MAXPATHLEN];
	char script_path[MAXPATHLEN];
	DIR *scripts_dir, *lang_dir;
	char lang_path[MAXPATHLEN];
	char *str, *__script_root;
	char *path = NULL;

	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());

	scripts_dir = opendir(scripts_path);
	if (!scripts_dir)
		return NULL;

	for_each_lang(scripts_dir, lang_dirent, lang_next) {
		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
			 lang_dirent.d_name);
		lang_dir = opendir(lang_path);
		if (!lang_dir)
			continue;

		for_each_script(lang_dir, script_dirent, script_next) {
			__script_root = strdup(script_dirent.d_name);
			str = ends_with(__script_root, suffix);
			if (str) {
				*str = '\0';
				if (strcmp(__script_root, script_root))
					continue;
				snprintf(script_path, MAXPATHLEN, "%s/%s",
					 lang_path, script_dirent.d_name);
				path = strdup(script_path);
				free(__script_root);
				break;
			}
			free(__script_root);
		}
	}

	return path;
}

static const char * const trace_usage[] = {
	"perf trace [<options>] <command>",
	NULL
};

static const struct option options[] = {
	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
		    "dump raw trace in ASCII"),
	OPT_INCR('v', "verbose", &verbose,
		    "be more verbose (show symbol address, etc)"),
	OPT_BOOLEAN('L', "Latency", &latency_format,
		    "show latency attributes (irqs/preemption disabled, etc)"),
	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
			   list_available_scripts),
	OPT_CALLBACK('s', "script", NULL, "name",
		     "script file name (lang:script name, script name, or *)",
		     parse_scriptname),
	OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
		   "generate perf-trace.xx script in specified language"),
	OPT_STRING('i', "input", &input_name, "file",
		    "input file name"),
	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
		   "do various checks like samples ordering and lost events"),

	OPT_END()
};

int cmd_trace(int argc, const char **argv, const char *prefix __used)
{
	struct perf_session *session;
	const char *suffix = NULL;
	const char **__argv;
	char *script_path;
	int i, err;

	if (argc >= 2 && strncmp(argv[1], "rec", strlen("rec")) == 0) {
		if (argc < 3) {
			fprintf(stderr,
				"Please specify a record script\n");
			return -1;
		}
		suffix = RECORD_SUFFIX;
	}

	if (argc >= 2 && strncmp(argv[1], "rep", strlen("rep")) == 0) {
		if (argc < 3) {
			fprintf(stderr,
				"Please specify a report script\n");
			return -1;
		}
		suffix = REPORT_SUFFIX;
	}

	if (!suffix && argc >= 2 && strncmp(argv[1], "-", strlen("-")) != 0) {
		char *record_script_path, *report_script_path;
		int live_pipe[2];
		pid_t pid;

		record_script_path = get_script_path(argv[1], RECORD_SUFFIX);
		if (!record_script_path) {
			fprintf(stderr, "record script not found\n");
			return -1;
		}

		report_script_path = get_script_path(argv[1], REPORT_SUFFIX);
		if (!report_script_path) {
			fprintf(stderr, "report script not found\n");
			return -1;
		}

		if (pipe(live_pipe) < 0) {
			perror("failed to create pipe");
			exit(-1);
		}

		pid = fork();
		if (pid < 0) {
			perror("failed to fork");
			exit(-1);
		}

		if (!pid) {
			dup2(live_pipe[1], 1);
			close(live_pipe[0]);

			__argv = malloc(5 * sizeof(const char *));
			__argv[0] = "/bin/sh";
			__argv[1] = record_script_path;
			__argv[2] = "-o";
			__argv[3] = "-";
			__argv[4] = NULL;

			execvp("/bin/sh", (char **)__argv);
			exit(-1);
		}

		dup2(live_pipe[0], 0);
		close(live_pipe[1]);

		__argv = malloc((argc + 3) * sizeof(const char *));
		__argv[0] = "/bin/sh";
		__argv[1] = report_script_path;
		for (i = 2; i < argc; i++)
			__argv[i] = argv[i];
		__argv[i++] = "-i";
		__argv[i++] = "-";
		__argv[i++] = NULL;

		execvp("/bin/sh", (char **)__argv);
		exit(-1);
	}

	if (suffix) {
		script_path = get_script_path(argv[2], suffix);
		if (!script_path) {
			fprintf(stderr, "script not found\n");
			return -1;
		}

		__argv = malloc((argc + 1) * sizeof(const char *));
		__argv[0] = "/bin/sh";
		__argv[1] = script_path;
		for (i = 3; i < argc; i++)
			__argv[i - 1] = argv[i];
		__argv[argc - 1] = NULL;

		execvp("/bin/sh", (char **)__argv);
		exit(-1);
	}

	setup_scripting();

	argc = parse_options(argc, argv, options, trace_usage,
			     PARSE_OPT_STOP_AT_NON_OPTION);

	if (symbol__init() < 0)
		return -1;
	if (!script_name)
		setup_pager();

	session = perf_session__new(input_name, O_RDONLY, 0, false);
	if (session == NULL)
		return -ENOMEM;

	if (strcmp(input_name, "-") &&
	    !perf_session__has_traces(session, "record -R"))
		return -EINVAL;

	if (generate_script_lang) {
		struct stat perf_stat;

		int input = open(input_name, O_RDONLY);
		if (input < 0) {
			perror("failed to open file");
			exit(-1);
		}

		err = fstat(input, &perf_stat);
		if (err < 0) {
			perror("failed to stat file");
			exit(-1);
		}

		if (!perf_stat.st_size) {
			fprintf(stderr, "zero-sized file, nothing to do!\n");
			exit(0);
		}

		scripting_ops = script_spec__lookup(generate_script_lang);
		if (!scripting_ops) {
			fprintf(stderr, "invalid language specifier");
			return -1;
		}

		err = scripting_ops->generate_script("perf-trace");
		goto out;
	}

	if (script_name) {
		err = scripting_ops->start_script(script_name, argc, argv);
		if (err)
			goto out;
		pr_debug("perf trace started with script %s\n\n", script_name);
	}

	err = __cmd_trace(session);

	perf_session__delete(session);
	cleanup_scripting();
out:
	return err;
}
Commit	Line	Data
5f9c39dc FW	1	#include "builtin.h"
	2
	3	#include "util/util.h"
	4	#include "util/cache.h"
	5	#include "util/symbol.h"
	6	#include "util/thread.h"
	7	#include "util/header.h"
cf72344d IM	8	#include "util/exec_cmd.h"
cf72344d IM	9	#include "util/trace-event.h"
94c744b6	10	#include "util/session.h"
5f9c39dc	11
956ffd02 TZ	12	static char const *script_name;
956ffd02 TZ	13	static char const *generate_script_lang;
ffabd99e	14	static bool debug_mode;
e1889d75	15	static u64 last_timestamp;
6fcf7ddb	16	static u64 nr_unordered;
956ffd02	17
586bc5cc TZ	18	static int default_start_script(const char *script __unused,
	19	int argc __unused,
	20	const char **argv __unused)
956ffd02 TZ	21	{
	22	return 0;
	23	}
	24
	25	static int default_stop_script(void)
	26	{
	27	return 0;
	28	}
	29
586bc5cc	30	static int default_generate_script(const char *outfile __unused)
956ffd02 TZ	31	{
	32	return 0;
	33	}
	34
	35	static struct scripting_ops default_scripting_ops = {
	36	.start_script = default_start_script,
	37	.stop_script = default_stop_script,
	38	.process_event = print_event,
	39	.generate_script = default_generate_script,
	40	};
	41
	42	static struct scripting_ops *scripting_ops;
	43
	44	static void setup_scripting(void)
	45	{
	46	/* make sure PERF_EXEC_PATH is set for scripts */
	47	perf_set_argv_exec_path(perf_exec_path());
	48
16c632de	49	setup_perl_scripting();
7e4b21b8	50	setup_python_scripting();
16c632de	51
956ffd02 TZ	52	scripting_ops = &default_scripting_ops;
	53	}
	54
	55	static int cleanup_scripting(void)
	56	{
3824a4e8 TZ	57	pr_debug("\nperf trace script stopped\n");
3824a4e8 TZ	58
956ffd02 TZ	59	return scripting_ops->stop_script();
	60	}
	61
5f9c39dc FW	62	#include "util/parse-options.h"
	63
	64	#include "perf.h"
	65	#include "util/debug.h"
	66
	67	#include "util/trace-event.h"
956ffd02	68	#include "util/exec_cmd.h"
5f9c39dc	69
956ffd02	70	static char const *input_name = "perf.data";
5f9c39dc	71
b3165f41	72	static int process_sample_event(event_t event, struct perf_session session)
5f9c39dc	73	{
180f95e2 OH	74	struct sample_data data;
180f95e2 OH	75	struct thread *thread;
6ddf259d	76
180f95e2 OH	77	memset(&data, 0, sizeof(data));
	78	data.time = -1;
	79	data.cpu = -1;
	80	data.period = 1;
cd6feeea	81
c019879b	82	event__parse_sample(event, session->sample_type, &data);
5f9c39dc	83
0d755034 ACM	84	dump_printf("(IP, %d): %d/%d: %#Lx period: %Ld\n", event->header.misc,
0d755034 ACM	85	data.pid, data.tid, data.ip, data.period);
5f9c39dc	86
b3165f41	87	thread = perf_session__findnew(session, event->ip.pid);
5f9c39dc	88	if (thread == NULL) {
6beba7ad ACM	89	pr_debug("problem processing %d event, skipping it.\n",
6beba7ad ACM	90	event->header.type);
5f9c39dc FW	91	return -1;
	92	}
	93
c019879b	94	if (session->sample_type & PERF_SAMPLE_RAW) {
ffabd99e	95	if (debug_mode) {
e1889d75 FW	96	if (data.time < last_timestamp) {
	97	pr_err("Samples misordered, previous: %llu "
	98	"this: %llu\n", last_timestamp,
	99	data.time);
6fcf7ddb	100	nr_unordered++;
e1889d75 FW	101	}
e1889d75 FW	102	last_timestamp = data.time;
6fcf7ddb	103	return 0;
e1889d75	104	}
5f9c39dc FW	105	/*
	106	* FIXME: better resolve from pid from the struct trace_entry
	107	* field, although it should be the same than this perf
	108	* event pid
	109	*/
180f95e2 OH	110	scripting_ops->process_event(data.cpu, data.raw_data,
	111	data.raw_size,
	112	data.time, thread->comm);
5f9c39dc	113	}
5f9c39dc	114
cee75ac7	115	session->hists.stats.total_period += data.period;
5f9c39dc FW	116	return 0;
	117	}
	118
ffabd99e FW	119	static u64 nr_lost;
	120
	121	static int process_lost_event(event_t event, struct perf_session session __used)
	122	{
	123	nr_lost += event->lost.lost;
	124
	125	return 0;
	126	}
	127
301a0b02	128	static struct perf_event_ops event_ops = {
55aa640f ACM	129	.sample = process_sample_event,
55aa640f ACM	130	.comm = event__process_comm,
2c46dbb5	131	.attr = event__process_attr,
cd19a035	132	.event_type = event__process_event_type,
9215545e	133	.tracing_data = event__process_tracing_data,
c7929e47	134	.build_id = event__process_build_id,
ffabd99e	135	.lost = process_lost_event,
e0a808c6	136	.ordered_samples = true,
016e92fb FW	137	};
016e92fb FW	138
c239da3b TZ	139	extern volatile int session_done;
	140
	141	static void sig_handler(int sig __unused)
	142	{
	143	session_done = 1;
	144	}
	145
d8f66248	146	static int __cmd_trace(struct perf_session *session)
5f9c39dc	147	{
6fcf7ddb FW	148	int ret;
6fcf7ddb FW	149
c239da3b TZ	150	signal(SIGINT, sig_handler);
c239da3b TZ	151
6fcf7ddb FW	152	ret = perf_session__process_events(session, &event_ops);
6fcf7ddb FW	153
ffabd99e	154	if (debug_mode) {
6fcf7ddb	155	pr_err("Misordered timestamps: %llu\n", nr_unordered);
ffabd99e FW	156	pr_err("Lost events: %llu\n", nr_lost);
ffabd99e FW	157	}
6fcf7ddb FW	158
6fcf7ddb FW	159	return ret;
5f9c39dc FW	160	}
5f9c39dc FW	161
956ffd02 TZ	162	struct script_spec {
	163	struct list_head node;
	164	struct scripting_ops *ops;
	165	char spec[0];
	166	};
	167
	168	LIST_HEAD(script_specs);
	169
	170	static struct script_spec script_spec__new(const char spec,
	171	struct scripting_ops *ops)
	172	{
	173	struct script_spec s = malloc(sizeof(s) + strlen(spec) + 1);
	174
	175	if (s != NULL) {
	176	strcpy(s->spec, spec);
	177	s->ops = ops;
	178	}
	179
	180	return s;
	181	}
	182
	183	static void script_spec__delete(struct script_spec *s)
	184	{
	185	free(s->spec);
	186	free(s);
	187	}
	188
	189	static void script_spec__add(struct script_spec *s)
	190	{
	191	list_add_tail(&s->node, &script_specs);
	192	}
	193
	194	static struct script_spec script_spec__find(const char spec)
	195	{
	196	struct script_spec *s;
	197
	198	list_for_each_entry(s, &script_specs, node)
	199	if (strcasecmp(s->spec, spec) == 0)
	200	return s;
	201	return NULL;
	202	}
	203
	204	static struct script_spec script_spec__findnew(const char spec,
	205	struct scripting_ops *ops)
	206	{
	207	struct script_spec *s = script_spec__find(spec);
	208
	209	if (s)
	210	return s;
	211
	212	s = script_spec__new(spec, ops);
	213	if (!s)
	214	goto out_delete_spec;
	215
	216	script_spec__add(s);
	217
	218	return s;
	219
	220	out_delete_spec:
	221	script_spec__delete(s);
	222
	223	return NULL;
	224	}
	225
226	int script_spec_register(const char spec, struct scripting_ops ops)
227	{
228	struct script_spec *s;
229
230	s = script_spec__find(spec);
231	if (s)
232	return -1;
233
234	s = script_spec__findnew(spec, ops);
235	if (!s)
236	return -1;
237
238	return 0;
239	}
240
241	static struct scripting_ops script_spec__lookup(const char spec)
242	{
243	struct script_spec *s = script_spec__find(spec);
244	if (!s)
245	return NULL;
246
247	return s->ops;
248	}
249
250	static void list_available_languages(void)
251	{
252	struct script_spec *s;
253
254	fprintf(stderr, "\n");
255	fprintf(stderr, "Scripting language extensions (used in "
256	"perf trace -s [spec:]script.[spec]):\n\n");
257
258	list_for_each_entry(s, &script_specs, node)
259	fprintf(stderr, " %-42s [%s]\n", s->spec, s->ops->name);
260
261	fprintf(stderr, "\n");
262	}
263
264	static int parse_scriptname(const struct option *opt __used,
265	const char *str, int unset __used)
266	{
267	char spec[PATH_MAX];
268	const char script, ext;
269	int len;
270
f526d68b	271	if (strcmp(str, "lang") == 0) {
956ffd02	272	list_available_languages();
f526d68b	273	exit(0);
956ffd02 TZ	274	}
	275
	276	script = strchr(str, ':');
	277	if (script) {
	278	len = script - str;
	279	if (len >= PATH_MAX) {
	280	fprintf(stderr, "invalid language specifier");
	281	return -1;
	282	}
	283	strncpy(spec, str, len);
	284	spec[len] = '\0';
	285	scripting_ops = script_spec__lookup(spec);
	286	if (!scripting_ops) {
	287	fprintf(stderr, "invalid language specifier");
	288	return -1;
	289	}
	290	script++;
	291	} else {
	292	script = str;
	293	ext = strchr(script, '.');
	294	if (!ext) {
	295	fprintf(stderr, "invalid script extension");
	296	return -1;
	297	}
	298	scripting_ops = script_spec__lookup(++ext);
	299	if (!scripting_ops) {
	300	fprintf(stderr, "invalid script extension");
	301	return -1;
	302	}
	303	}
	304
	305	script_name = strdup(script);
	306
	307	return 0;
	308	}
	309
4b9c0c59 TZ	310	#define for_each_lang(scripts_dir, lang_dirent, lang_next) \
	311	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) && \
	312	lang_next) \
	313	if (lang_dirent.d_type == DT_DIR && \
	314	(strcmp(lang_dirent.d_name, ".")) && \
	315	(strcmp(lang_dirent.d_name, "..")))
	316
	317	#define for_each_script(lang_dir, script_dirent, script_next) \
	318	while (!readdir_r(lang_dir, &script_dirent, &script_next) && \
	319	script_next) \
	320	if (script_dirent.d_type != DT_DIR)
	321
	322
	323	#define RECORD_SUFFIX "-record"
	324	#define REPORT_SUFFIX "-report"
	325
	326	struct script_desc {
	327	struct list_head node;
	328	char *name;
	329	char *half_liner;
	330	char *args;
	331	};
	332
	333	LIST_HEAD(script_descs);
	334
	335	static struct script_desc script_desc__new(const char name)
	336	{
	337	struct script_desc s = zalloc(sizeof(s));
	338
	339	if (s != NULL)
	340	s->name = strdup(name);
	341
	342	return s;
	343	}
	344
	345	static void script_desc__delete(struct script_desc *s)
	346	{
	347	free(s->name);
	348	free(s);
	349	}
	350
	351	static void script_desc__add(struct script_desc *s)
	352	{
	353	list_add_tail(&s->node, &script_descs);
	354	}
	355
	356	static struct script_desc script_desc__find(const char name)
	357	{
	358	struct script_desc *s;
	359
	360	list_for_each_entry(s, &script_descs, node)
	361	if (strcasecmp(s->name, name) == 0)
	362	return s;
	363	return NULL;
	364	}
	365
	366	static struct script_desc script_desc__findnew(const char name)
	367	{
	368	struct script_desc *s = script_desc__find(name);
	369
	370	if (s)
	371	return s;
	372
	373	s = script_desc__new(name);
374	if (!s)
375	goto out_delete_desc;
376
377	script_desc__add(s);
378
379	return s;
380
381	out_delete_desc:
382	script_desc__delete(s);
383
384	return NULL;
385	}
386
387	static char ends_with(char str, const char *suffix)
388	{
389	size_t suffix_len = strlen(suffix);
390	char *p = str;
391
392	if (strlen(str) > suffix_len) {
393	p = str + strlen(str) - suffix_len;
394	if (!strncmp(p, suffix, suffix_len))
395	return p;
396	}
397
398	return NULL;
399	}
400
401	static char ltrim(char str)
402	{
403	int len = strlen(str);
404
405	while (len && isspace(*str)) {
406	len--;
407	str++;
408	}
409
410	return str;
411	}
412
413	static int read_script_info(struct script_desc desc, const char filename)
414	{
415	char line[BUFSIZ], *p;
416	FILE *fp;
417
418	fp = fopen(filename, "r");
419	if (!fp)
420	return -1;
421
422	while (fgets(line, sizeof(line), fp)) {
423	p = ltrim(line);
424	if (strlen(p) == 0)
425	continue;
426	if (*p != '#')
427	continue;
428	p++;
429	if (strlen(p) && *p == '!')
430	continue;
431
432	p = ltrim(p);
433	if (strlen(p) && p[strlen(p) - 1] == '\n')
434	p[strlen(p) - 1] = '\0';
435
436	if (!strncmp(p, "description:", strlen("description:"))) {
437	p += strlen("description:");
438	desc->half_liner = strdup(ltrim(p));
439	continue;
440	}
441
442	if (!strncmp(p, "args:", strlen("args:"))) {
443	p += strlen("args:");
444	desc->args = strdup(ltrim(p));
445	continue;
446	}
447	}
448
449	fclose(fp);
450
451	return 0;
452	}
453
454	static int list_available_scripts(const struct option *opt __used,
455	const char *s __used, int unset __used)
456	{
457	struct dirent script_next, lang_next, script_dirent, lang_dirent;
458	char scripts_path[MAXPATHLEN];
459	DIR scripts_dir, lang_dir;
460	char script_path[MAXPATHLEN];
461	char lang_path[MAXPATHLEN];
462	struct script_desc *desc;
463	char first_half[BUFSIZ];
464	char *script_root;
465	char *str;
466
467	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
468
469	scripts_dir = opendir(scripts_path);
470	if (!scripts_dir)
471	return -1;
472
473	for_each_lang(scripts_dir, lang_dirent, lang_next) {
474	snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
475	lang_dirent.d_name);
476	lang_dir = opendir(lang_path);
477	if (!lang_dir)
478	continue;
479
480	for_each_script(lang_dir, script_dirent, script_next) {
481	script_root = strdup(script_dirent.d_name);
482	str = ends_with(script_root, REPORT_SUFFIX);
483	if (str) {
484	*str = '\0';
485	desc = script_desc__findnew(script_root);
486	snprintf(script_path, MAXPATHLEN, "%s/%s",
487	lang_path, script_dirent.d_name);
488	read_script_info(desc, script_path);
489	}
490	free(script_root);
491	}
492	}
493
494	fprintf(stdout, "List of available trace scripts:\n");
495	list_for_each_entry(desc, &script_descs, node) {
496	sprintf(first_half, "%s %s", desc->name,
497	desc->args ? desc->args : "");
498	fprintf(stdout, " %-36s %s\n", first_half,
499	desc->half_liner ? desc->half_liner : "");
500	}
501
502	exit(0);
503	}
504
3875294f TZ	505	static char get_script_path(const char script_root, const char *suffix)
	506	{
	507	struct dirent script_next, lang_next, script_dirent, lang_dirent;
	508	char scripts_path[MAXPATHLEN];
	509	char script_path[MAXPATHLEN];
	510	DIR scripts_dir, lang_dir;
	511	char lang_path[MAXPATHLEN];
	512	char str, __script_root;
	513	char *path = NULL;
	514
	515	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
	516
	517	scripts_dir = opendir(scripts_path);
	518	if (!scripts_dir)
	519	return NULL;
	520
	521	for_each_lang(scripts_dir, lang_dirent, lang_next) {
	522	snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
	523	lang_dirent.d_name);
	524	lang_dir = opendir(lang_path);
	525	if (!lang_dir)
	526	continue;
	527
	528	for_each_script(lang_dir, script_dirent, script_next) {
	529	__script_root = strdup(script_dirent.d_name);
	530	str = ends_with(__script_root, suffix);
	531	if (str) {
	532	*str = '\0';
	533	if (strcmp(__script_root, script_root))
	534	continue;
	535	snprintf(script_path, MAXPATHLEN, "%s/%s",
	536	lang_path, script_dirent.d_name);
	537	path = strdup(script_path);
	538	free(__script_root);
	539	break;
	540	}
	541	free(__script_root);
	542	}
	543	}
	544
	545	return path;
	546	}
	547
0422a4fc	548	static const char * const trace_usage[] = {
5f9c39dc FW	549	"perf trace [<options>] <command>",
	550	NULL
	551	};
	552
	553	static const struct option options[] = {
	554	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
	555	"dump raw trace in ASCII"),
c0555642	556	OPT_INCR('v', "verbose", &verbose,
5f9c39dc	557	"be more verbose (show symbol address, etc)"),
4b9c0c59	558	OPT_BOOLEAN('L', "Latency", &latency_format,
cda48461	559	"show latency attributes (irqs/preemption disabled, etc)"),
4b9c0c59 TZ	560	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
4b9c0c59 TZ	561	list_available_scripts),
956ffd02 TZ	562	OPT_CALLBACK('s', "script", NULL, "name",
	563	"script file name (lang:script name, script name, or *)",
	564	parse_scriptname),
	565	OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
	566	"generate perf-trace.xx script in specified language"),
408f0d18 HM	567	OPT_STRING('i', "input", &input_name, "file",
408f0d18 HM	568	"input file name"),
ffabd99e FW	569	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
ffabd99e FW	570	"do various checks like samples ordering and lost events"),
956ffd02	571
1909629f	572	OPT_END()
5f9c39dc FW	573	};
	574
	575	int cmd_trace(int argc, const char *argv, const char prefix __used)
	576	{
d8f66248	577	struct perf_session *session;
3875294f TZ	578	const char *suffix = NULL;
	579	const char **__argv;
	580	char *script_path;
	581	int i, err;
	582
	583	if (argc >= 2 && strncmp(argv[1], "rec", strlen("rec")) == 0) {
	584	if (argc < 3) {
	585	fprintf(stderr,
	586	"Please specify a record script\n");
	587	return -1;
	588	}
	589	suffix = RECORD_SUFFIX;
	590	}
	591
	592	if (argc >= 2 && strncmp(argv[1], "rep", strlen("rep")) == 0) {
	593	if (argc < 3) {
	594	fprintf(stderr,
	595	"Please specify a report script\n");
	596	return -1;
	597	}
	598	suffix = REPORT_SUFFIX;
	599	}
	600
a0cccc2e TZ	601	if (!suffix && argc >= 2 && strncmp(argv[1], "-", strlen("-")) != 0) {
	602	char record_script_path, report_script_path;
	603	int live_pipe[2];
	604	pid_t pid;
	605
	606	record_script_path = get_script_path(argv[1], RECORD_SUFFIX);
	607	if (!record_script_path) {
	608	fprintf(stderr, "record script not found\n");
	609	return -1;
	610	}
	611
	612	report_script_path = get_script_path(argv[1], REPORT_SUFFIX);
	613	if (!report_script_path) {
	614	fprintf(stderr, "report script not found\n");
	615	return -1;
	616	}
	617
	618	if (pipe(live_pipe) < 0) {
	619	perror("failed to create pipe");
	620	exit(-1);
	621	}
	622
	623	pid = fork();
	624	if (pid < 0) {
	625	perror("failed to fork");
	626	exit(-1);
	627	}
	628
	629	if (!pid) {
	630	dup2(live_pipe[1], 1);
	631	close(live_pipe[0]);
	632
	633	__argv = malloc(5 * sizeof(const char *));
	634	__argv[0] = "/bin/sh";
	635	__argv[1] = record_script_path;
	636	__argv[2] = "-o";
	637	__argv[3] = "-";
	638	__argv[4] = NULL;
	639
	640	execvp("/bin/sh", (char **)__argv);
	641	exit(-1);
	642	}
	643
	644	dup2(live_pipe[0], 0);
	645	close(live_pipe[1]);
	646
	647	__argv = malloc((argc + 3) * sizeof(const char *));
	648	__argv[0] = "/bin/sh";
	649	__argv[1] = report_script_path;
	650	for (i = 2; i < argc; i++)
	651	__argv[i] = argv[i];
	652	__argv[i++] = "-i";
	653	__argv[i++] = "-";
	654	__argv[i++] = NULL;
	655
	656	execvp("/bin/sh", (char **)__argv);
	657	exit(-1);
	658	}
	659
3875294f TZ	660	if (suffix) {
	661	script_path = get_script_path(argv[2], suffix);
	662	if (!script_path) {
	663	fprintf(stderr, "script not found\n");
	664	return -1;
	665	}
	666
	667	__argv = malloc((argc + 1) * sizeof(const char *));
	668	__argv[0] = "/bin/sh";
	669	__argv[1] = script_path;
	670	for (i = 3; i < argc; i++)
	671	__argv[i - 1] = argv[i];
	672	__argv[argc - 1] = NULL;
	673
	674	execvp("/bin/sh", (char **)__argv);
	675	exit(-1);
	676	}
956ffd02	677
956ffd02 TZ	678	setup_scripting();
956ffd02 TZ	679
0422a4fc	680	argc = parse_options(argc, argv, options, trace_usage,
586bc5cc	681	PARSE_OPT_STOP_AT_NON_OPTION);
5f9c39dc	682
655000e7 ACM	683	if (symbol__init() < 0)
655000e7 ACM	684	return -1;
cf4fee50 TZ	685	if (!script_name)
cf4fee50 TZ	686	setup_pager();
5f9c39dc	687
454c407e	688	session = perf_session__new(input_name, O_RDONLY, 0, false);
d8f66248 ACM	689	if (session == NULL)
	690	return -ENOMEM;
	691
c239da3b TZ	692	if (strcmp(input_name, "-") &&
c239da3b TZ	693	!perf_session__has_traces(session, "record -R"))
d549c769 ACM	694	return -EINVAL;
d549c769 ACM	695
956ffd02 TZ	696	if (generate_script_lang) {
	697	struct stat perf_stat;
	698
	699	int input = open(input_name, O_RDONLY);
	700	if (input < 0) {
	701	perror("failed to open file");
	702	exit(-1);
	703	}
	704
	705	err = fstat(input, &perf_stat);
	706	if (err < 0) {
	707	perror("failed to stat file");
	708	exit(-1);
	709	}
	710
	711	if (!perf_stat.st_size) {
	712	fprintf(stderr, "zero-sized file, nothing to do!\n");
	713	exit(0);
	714	}
	715
	716	scripting_ops = script_spec__lookup(generate_script_lang);
	717	if (!scripting_ops) {
	718	fprintf(stderr, "invalid language specifier");
	719	return -1;
	720	}
	721
956ffd02 TZ	722	err = scripting_ops->generate_script("perf-trace");
	723	goto out;
	724	}
	725
	726	if (script_name) {
586bc5cc	727	err = scripting_ops->start_script(script_name, argc, argv);
956ffd02 TZ	728	if (err)
956ffd02 TZ	729	goto out;
3824a4e8	730	pr_debug("perf trace started with script %s\n\n", script_name);
956ffd02 TZ	731	}
956ffd02 TZ	732
d8f66248	733	err = __cmd_trace(session);
956ffd02	734
d8f66248	735	perf_session__delete(session);
956ffd02 TZ	736	cleanup_scripting();
	737	out:
	738	return err;
5f9c39dc	739	}