[net-next-2.6.git] / tools / perf / builtin-trace.c

#include "builtin.h"

#include "perf.h"
#include "util/cache.h"
#include "util/debug.h"
#include "util/exec_cmd.h"
#include "util/header.h"
#include "util/parse-options.h"
#include "util/session.h"
#include "util/symbol.h"
#include "util/thread.h"
#include "util/trace-event.h"
#include "util/util.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();
}

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