[mirror_ubuntu-artful-kernel.git] / tools / perf / builtin-probe.c

/*
 * builtin-probe.c
 *
 * Builtin probe command: Set up probe events by C expression
 *
 * Written by Masami Hiramatsu <mhiramat@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */
#include <sys/utsname.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <string.h>

#include "perf.h"
#include "builtin.h"
#include "util/util.h"
#include "util/strlist.h"
#include "util/strfilter.h"
#include "util/symbol.h"
#include "util/debug.h"
#include <api/fs/debugfs.h>
#include "util/parse-options.h"
#include "util/probe-finder.h"
#include "util/probe-event.h"

#define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*"
#define DEFAULT_FUNC_FILTER "!_*"

/* Session management structure */
static struct {
	bool list_events;
	bool force_add;
	bool show_lines;
	bool show_vars;
	bool show_ext_vars;
	bool show_funcs;
	bool mod_events;
	bool uprobes;
	int nevents;
	struct perf_probe_event events[MAX_PROBES];
	struct strlist *dellist;
	struct line_range line_range;
	char *target;
	int max_probe_points;
	struct strfilter *filter;
} params;

/* Parse an event definition. Note that any error must die. */
static int parse_probe_event(const char *str)
{
	struct perf_probe_event *pev = &params.events[params.nevents];
	int ret;

	pr_debug("probe-definition(%d): %s\n", params.nevents, str);
	if (++params.nevents == MAX_PROBES) {
		pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
		return -1;
	}

	pev->uprobes = params.uprobes;

	/* Parse a perf-probe command into event */
	ret = parse_perf_probe_command(str, pev);
	pr_debug("%d arguments\n", pev->nargs);

	return ret;
}

static int set_target(const char *ptr)
{
	int found = 0;
	const char *buf;

	/*
	 * The first argument after options can be an absolute path
	 * to an executable / library or kernel module.
	 *
	 * TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
	 * short module name.
	 */
	if (!params.target && ptr && *ptr == '/') {
		params.target = strdup(ptr);
		if (!params.target)
			return -ENOMEM;

		found = 1;
		buf = ptr + (strlen(ptr) - 3);

		if (strcmp(buf, ".ko"))
			params.uprobes = true;

	}

	return found;
}

static int parse_probe_event_argv(int argc, const char **argv)
{
	int i, len, ret, found_target;
	char *buf;

	found_target = set_target(argv[0]);
	if (found_target < 0)
		return found_target;

	if (found_target && argc == 1)
		return 0;

	/* Bind up rest arguments */
	len = 0;
	for (i = 0; i < argc; i++) {
		if (i == 0 && found_target)
			continue;

		len += strlen(argv[i]) + 1;
	}
	buf = zalloc(len + 1);
	if (buf == NULL)
		return -ENOMEM;
	len = 0;
	for (i = 0; i < argc; i++) {
		if (i == 0 && found_target)
			continue;

		len += sprintf(&buf[len], "%s ", argv[i]);
	}
	params.mod_events = true;
	ret = parse_probe_event(buf);
	free(buf);
	return ret;
}

static int opt_add_probe_event(const struct option *opt __maybe_unused,
			      const char *str, int unset __maybe_unused)
{
	if (str) {
		params.mod_events = true;
		return parse_probe_event(str);
	} else
		return 0;
}

static int opt_del_probe_event(const struct option *opt __maybe_unused,
			       const char *str, int unset __maybe_unused)
{
	if (str) {
		params.mod_events = true;
		if (!params.dellist)
			params.dellist = strlist__new(true, NULL);
		strlist__add(params.dellist, str);
	}
	return 0;
}

static int opt_set_target(const struct option *opt, const char *str,
			int unset __maybe_unused)
{
	int ret = -ENOENT;
	char *tmp;

	if  (str && !params.target) {
		if (!strcmp(opt->long_name, "exec"))
			params.uprobes = true;
#ifdef HAVE_DWARF_SUPPORT
		else if (!strcmp(opt->long_name, "module"))
			params.uprobes = false;
#endif
		else
			return ret;

		/* Expand given path to absolute path, except for modulename */
		if (params.uprobes || strchr(str, '/')) {
			tmp = realpath(str, NULL);
			if (!tmp) {
				pr_warning("Failed to get the absolute path of %s: %m\n", str);
				return ret;
			}
		} else {
			tmp = strdup(str);
			if (!tmp)
				return -ENOMEM;
		}
		params.target = tmp;
		ret = 0;
	}

	return ret;
}

#ifdef HAVE_DWARF_SUPPORT
static int opt_show_lines(const struct option *opt __maybe_unused,
			  const char *str, int unset __maybe_unused)
{
	int ret = 0;

	if (!str)
		return 0;

	if (params.show_lines) {
		pr_warning("Warning: more than one --line options are"
			   " detected. Only the first one is valid.\n");
		return 0;
	}

	params.show_lines = true;
	ret = parse_line_range_desc(str, &params.line_range);

	return ret;
}

static int opt_show_vars(const struct option *opt __maybe_unused,
			 const char *str, int unset __maybe_unused)
{
	struct perf_probe_event *pev = &params.events[params.nevents];
	int ret;

	if (!str)
		return 0;

	ret = parse_probe_event(str);
	if (!ret && pev->nargs != 0) {
		pr_err("  Error: '--vars' doesn't accept arguments.\n");
		return -EINVAL;
	}
	params.show_vars = true;

	return ret;
}
#endif

static int opt_set_filter(const struct option *opt __maybe_unused,
			  const char *str, int unset __maybe_unused)
{
	const char *err;

	if (str) {
		pr_debug2("Set filter: %s\n", str);
		if (params.filter)
			strfilter__delete(params.filter);
		params.filter = strfilter__new(str, &err);
		if (!params.filter) {
			pr_err("Filter parse error at %td.\n", err - str + 1);
			pr_err("Source: \"%s\"\n", str);
			pr_err("         %*c\n", (int)(err - str + 1), '^');
			return -EINVAL;
		}
	}

	return 0;
}

static int init_params(void)
{
	return line_range__init(&params.line_range);
}

static void cleanup_params(void)
{
	int i;

	for (i = 0; i < params.nevents; i++)
		clear_perf_probe_event(params.events + i);
	if (params.dellist)
		strlist__delete(params.dellist);
	line_range__clear(&params.line_range);
	free(params.target);
	if (params.filter)
		strfilter__delete(params.filter);
	memset(&params, 0, sizeof(params));
}

static void pr_err_with_code(const char *msg, int err)
{
	pr_err("%s", msg);
	pr_debug(" Reason: %s (Code: %d)", strerror(-err), err);
	pr_err("\n");
}

static int
__cmd_probe(int argc, const char **argv, const char *prefix __maybe_unused)
{
	const char * const probe_usage[] = {
		"perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
		"perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
		"perf probe [<options>] --del '[GROUP:]EVENT' ...",
		"perf probe --list",
#ifdef HAVE_DWARF_SUPPORT
		"perf probe [<options>] --line 'LINEDESC'",
		"perf probe [<options>] --vars 'PROBEPOINT'",
#endif
		NULL
};
	const struct option options[] = {
	OPT_INCR('v', "verbose", &verbose,
		    "be more verbose (show parsed arguments, etc)"),
	OPT_BOOLEAN('l', "list", &params.list_events,
		    "list up current probe events"),
	OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
		opt_del_probe_event),
	OPT_CALLBACK('a', "add", NULL,
#ifdef HAVE_DWARF_SUPPORT
		"[EVENT=]FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT"
		" [[NAME=]ARG ...]",
#else
		"[EVENT=]FUNC[+OFF|%return] [[NAME=]ARG ...]",
#endif
		"probe point definition, where\n"
		"\t\tGROUP:\tGroup name (optional)\n"
		"\t\tEVENT:\tEvent name\n"
		"\t\tFUNC:\tFunction name\n"
		"\t\tOFF:\tOffset from function entry (in byte)\n"
		"\t\t%return:\tPut the probe at function return\n"
#ifdef HAVE_DWARF_SUPPORT
		"\t\tSRC:\tSource code path\n"
		"\t\tRL:\tRelative line number from function entry.\n"
		"\t\tAL:\tAbsolute line number in file.\n"
		"\t\tPT:\tLazy expression of line code.\n"
		"\t\tARG:\tProbe argument (local variable name or\n"
		"\t\t\tkprobe-tracer argument format.)\n",
#else
		"\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
#endif
		opt_add_probe_event),
	OPT_BOOLEAN('f', "force", &params.force_add, "forcibly add events"
		    " with existing name"),
#ifdef HAVE_DWARF_SUPPORT
	OPT_CALLBACK('L', "line", NULL,
		     "FUNC[:RLN[+NUM|-RLN2]]|SRC:ALN[+NUM|-ALN2]",
		     "Show source code lines.", opt_show_lines),
	OPT_CALLBACK('V', "vars", NULL,
		     "FUNC[@SRC][+OFF|%return|:RL|;PT]|SRC:AL|SRC;PT",
		     "Show accessible variables on PROBEDEF", opt_show_vars),
	OPT_BOOLEAN('\0', "externs", &params.show_ext_vars,
		    "Show external variables too (with --vars only)"),
	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
	OPT_STRING('s', "source", &symbol_conf.source_prefix,
		   "directory", "path to kernel source"),
	OPT_CALLBACK('m', "module", NULL, "modname|path",
		"target module name (for online) or path (for offline)",
		opt_set_target),
#endif
	OPT__DRY_RUN(&probe_event_dry_run),
	OPT_INTEGER('\0', "max-probes", &params.max_probe_points,
		 "Set how many probe points can be found for a probe."),
	OPT_BOOLEAN('F', "funcs", &params.show_funcs,
		    "Show potential probe-able functions."),
	OPT_CALLBACK('\0', "filter", NULL,
		     "[!]FILTER", "Set a filter (with --vars/funcs only)\n"
		     "\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
		     "\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
		     opt_set_filter),
	OPT_CALLBACK('x', "exec", NULL, "executable|path",
			"target executable name or path", opt_set_target),
	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
		    "Disable symbol demangling"),
	OPT_END()
	};
	int ret;

	argc = parse_options(argc, argv, options, probe_usage,
			     PARSE_OPT_STOP_AT_NON_OPTION);
	if (argc > 0) {
		if (strcmp(argv[0], "-") == 0) {
			pr_warning("  Error: '-' is not supported.\n");
			usage_with_options(probe_usage, options);
		}
		ret = parse_probe_event_argv(argc, argv);
		if (ret < 0) {
			pr_err_with_code("  Error: Command Parse Error.", ret);
			return ret;
		}
	}

	if (params.max_probe_points == 0)
		params.max_probe_points = MAX_PROBES;

	if ((!params.nevents && !params.dellist && !params.list_events &&
	     !params.show_lines && !params.show_funcs))
		usage_with_options(probe_usage, options);

	/*
	 * Only consider the user's kernel image path if given.
	 */
	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);

	if (params.list_events) {
		if (params.mod_events) {
			pr_err("  Error: Don't use --list with --add/--del.\n");
			usage_with_options(probe_usage, options);
		}
		if (params.show_lines) {
			pr_err("  Error: Don't use --list with --line.\n");
			usage_with_options(probe_usage, options);
		}
		if (params.show_vars) {
			pr_err(" Error: Don't use --list with --vars.\n");
			usage_with_options(probe_usage, options);
		}
		if (params.show_funcs) {
			pr_err("  Error: Don't use --list with --funcs.\n");
			usage_with_options(probe_usage, options);
		}
		if (params.uprobes) {
			pr_warning("  Error: Don't use --list with --exec.\n");
			usage_with_options(probe_usage, options);
		}
		ret = show_perf_probe_events();
		if (ret < 0)
			pr_err_with_code("  Error: Failed to show event list.", ret);
		return ret;
	}
	if (params.show_funcs) {
		if (params.nevents != 0 || params.dellist) {
			pr_err("  Error: Don't use --funcs with"
			       " --add/--del.\n");
			usage_with_options(probe_usage, options);
		}
		if (params.show_lines) {
			pr_err("  Error: Don't use --funcs with --line.\n");
			usage_with_options(probe_usage, options);
		}
		if (params.show_vars) {
			pr_err("  Error: Don't use --funcs with --vars.\n");
			usage_with_options(probe_usage, options);
		}
		if (!params.filter)
			params.filter = strfilter__new(DEFAULT_FUNC_FILTER,
						       NULL);
		ret = show_available_funcs(params.target, params.filter,
					params.uprobes);
		strfilter__delete(params.filter);
		params.filter = NULL;
		if (ret < 0)
			pr_err_with_code("  Error: Failed to show functions.", ret);
		return ret;
	}

#ifdef HAVE_DWARF_SUPPORT
	if (params.show_lines) {
		if (params.mod_events) {
			pr_err("  Error: Don't use --line with"
			       " --add/--del.\n");
			usage_with_options(probe_usage, options);
		}
		if (params.show_vars) {
			pr_err(" Error: Don't use --line with --vars.\n");
			usage_with_options(probe_usage, options);
		}

		ret = show_line_range(&params.line_range, params.target);
		if (ret < 0)
			pr_err_with_code("  Error: Failed to show lines.", ret);
		return ret;
	}
	if (params.show_vars) {
		if (params.mod_events) {
			pr_err("  Error: Don't use --vars with"
			       " --add/--del.\n");
			usage_with_options(probe_usage, options);
		}
		if (!params.filter)
			params.filter = strfilter__new(DEFAULT_VAR_FILTER,
						       NULL);

		ret = show_available_vars(params.events, params.nevents,
					  params.max_probe_points,
					  params.target,
					  params.filter,
					  params.show_ext_vars);
		strfilter__delete(params.filter);
		params.filter = NULL;
		if (ret < 0)
			pr_err_with_code("  Error: Failed to show vars.", ret);
		return ret;
	}
#endif

	if (params.dellist) {
		ret = del_perf_probe_events(params.dellist);
		if (ret < 0) {
			pr_err_with_code("  Error: Failed to delete events.", ret);
			return ret;
		}
	}

	if (params.nevents) {
		ret = add_perf_probe_events(params.events, params.nevents,
					    params.max_probe_points,
					    params.target,
					    params.force_add);
		if (ret < 0) {
			pr_err_with_code("  Error: Failed to add events.", ret);
			return ret;
		}
	}
	return 0;
}

int cmd_probe(int argc, const char **argv, const char *prefix)
{
	int ret;

	ret = init_params();
	if (!ret) {
		ret = __cmd_probe(argc, argv, prefix);
		cleanup_params();
	}

	return ret;
}
Commit	Line	Data
4ea42b18 MH	1	/*
	2	* builtin-probe.c
	3	*
	4	* Builtin probe command: Set up probe events by C expression
	5	*
	6	* Written by Masami Hiramatsu <mhiramat@redhat.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	21	*
	22	*/
4ea42b18 MH	23	#include <sys/utsname.h>
	24	#include <sys/types.h>
	25	#include <sys/stat.h>
	26	#include <fcntl.h>
	27	#include <errno.h>
	28	#include <stdio.h>
	29	#include <unistd.h>
	30	#include <stdlib.h>
	31	#include <string.h>
	32
4ea42b18 MH	33	#include "perf.h"
	34	#include "builtin.h"
	35	#include "util/util.h"
fa28244d	36	#include "util/strlist.h"
bd09d7b5	37	#include "util/strfilter.h"
e0faa8d3	38	#include "util/symbol.h"
89c69c0e	39	#include "util/debug.h"
553873e1	40	#include <api/fs/debugfs.h>
4ea42b18	41	#include "util/parse-options.h"
4ea42b18	42	#include "util/probe-finder.h"
50656eec	43	#include "util/probe-event.h"
4ea42b18	44
bd09d7b5	45	#define DEFAULT_VAR_FILTER "!__k???tab_* & !__crc_*"
3c42258c	46	#define DEFAULT_FUNC_FILTER "!_*"
4ea42b18 MH	47
	48	/* Session management structure */
	49	static struct {
fac13fd5	50	bool list_events;
d761b08b	51	bool force_add;
631c9def	52	bool show_lines;
cf6eb489	53	bool show_vars;
fb8c5a56	54	bool show_ext_vars;
e80711ca	55	bool show_funcs;
cf6eb489	56	bool mod_events;
225466f1	57	bool uprobes;
4235b045 MH	58	int nevents;
4235b045 MH	59	struct perf_probe_event events[MAX_PROBES];
fa28244d	60	struct strlist *dellist;
631c9def	61	struct line_range line_range;
e53b00d3	62	char *target;
ef4a3565	63	int max_probe_points;
bd09d7b5	64	struct strfilter *filter;
12a1fadb	65	} params;
4ea42b18	66
253977b0	67	/* Parse an event definition. Note that any error must die. */
146a1439	68	static int parse_probe_event(const char *str)
4ea42b18	69	{
4235b045	70	struct perf_probe_event *pev = &params.events[params.nevents];
146a1439	71	int ret;
4ea42b18	72
4235b045	73	pr_debug("probe-definition(%d): %s\n", params.nevents, str);
8a7ddad8 ACM	74	if (++params.nevents == MAX_PROBES) {
	75	pr_err("Too many probes (> %d) were specified.", MAX_PROBES);
	76	return -1;
	77	}
4ea42b18	78
225466f1 SD	79	pev->uprobes = params.uprobes;
225466f1 SD	80
4235b045	81	/* Parse a perf-probe command into event */
146a1439	82	ret = parse_perf_probe_command(str, pev);
4235b045	83	pr_debug("%d arguments\n", pev->nargs);
146a1439 MH	84
146a1439 MH	85	return ret;
46ab4926 MH	86	}
46ab4926 MH	87
73eff9f5 SD	88	static int set_target(const char *ptr)
	89	{
	90	int found = 0;
	91	const char *buf;
	92
	93	/*
	94	* The first argument after options can be an absolute path
	95	* to an executable / library or kernel module.
	96	*
	97	* TODO: Support relative path, and $PATH, $LD_LIBRARY_PATH,
	98	* short module name.
	99	*/
	100	if (!params.target && ptr && *ptr == '/') {
e53b00d3 MH	101	params.target = strdup(ptr);
	102	if (!params.target)
	103	return -ENOMEM;
	104
73eff9f5 SD	105	found = 1;
	106	buf = ptr + (strlen(ptr) - 3);
	107
	108	if (strcmp(buf, ".ko"))
	109	params.uprobes = true;
	110
	111	}
	112
	113	return found;
	114	}
	115
146a1439	116	static int parse_probe_event_argv(int argc, const char **argv)
d1bde3f7	117	{
73eff9f5	118	int i, len, ret, found_target;
d1bde3f7 MH	119	char *buf;
d1bde3f7 MH	120
73eff9f5	121	found_target = set_target(argv[0]);
e53b00d3 MH	122	if (found_target < 0)
	123	return found_target;
	124
73eff9f5 SD	125	if (found_target && argc == 1)
	126	return 0;
	127
d1bde3f7 MH	128	/* Bind up rest arguments */
d1bde3f7 MH	129	len = 0;
73eff9f5 SD	130	for (i = 0; i < argc; i++) {
	131	if (i == 0 && found_target)
	132	continue;
	133
d1bde3f7	134	len += strlen(argv[i]) + 1;
73eff9f5	135	}
8a7ddad8 ACM	136	buf = zalloc(len + 1);
	137	if (buf == NULL)
	138	return -ENOMEM;
d1bde3f7	139	len = 0;
73eff9f5 SD	140	for (i = 0; i < argc; i++) {
	141	if (i == 0 && found_target)
	142	continue;
	143
d1bde3f7	144	len += sprintf(&buf[len], "%s ", argv[i]);
73eff9f5	145	}
cf6eb489	146	params.mod_events = true;
146a1439	147	ret = parse_probe_event(buf);
d1bde3f7	148	free(buf);
146a1439	149	return ret;
d1bde3f7 MH	150	}
d1bde3f7 MH	151
1d037ca1 IT	152	static int opt_add_probe_event(const struct option *opt __maybe_unused,
1d037ca1 IT	153	const char *str, int unset __maybe_unused)
46ab4926	154	{
cf6eb489 MH	155	if (str) {
cf6eb489 MH	156	params.mod_events = true;
146a1439	157	return parse_probe_event(str);
cf6eb489	158	} else
146a1439	159	return 0;
4ea42b18 MH	160	}
4ea42b18 MH	161
1d037ca1 IT	162	static int opt_del_probe_event(const struct option *opt __maybe_unused,
1d037ca1 IT	163	const char *str, int unset __maybe_unused)
fa28244d MH	164	{
fa28244d MH	165	if (str) {
cf6eb489	166	params.mod_events = true;
12a1fadb MH	167	if (!params.dellist)
	168	params.dellist = strlist__new(true, NULL);
	169	strlist__add(params.dellist, str);
fa28244d MH	170	}
	171	return 0;
	172	}
	173
225466f1	174	static int opt_set_target(const struct option opt, const char str,
1d037ca1	175	int unset __maybe_unused)
225466f1 SD	176	{
225466f1 SD	177	int ret = -ENOENT;
8a613d40	178	char *tmp;
225466f1 SD	179
	180	if (str && !params.target) {
	181	if (!strcmp(opt->long_name, "exec"))
	182	params.uprobes = true;
89fe808a	183	#ifdef HAVE_DWARF_SUPPORT
225466f1 SD	184	else if (!strcmp(opt->long_name, "module"))
	185	params.uprobes = false;
	186	#endif
	187	else
	188	return ret;
	189
8a613d40 MH	190	/* Expand given path to absolute path, except for modulename */
	191	if (params.uprobes \|\| strchr(str, '/')) {
	192	tmp = realpath(str, NULL);
	193	if (!tmp) {
	194	pr_warning("Failed to get the absolute path of %s: %m\n", str);
	195	return ret;
	196	}
	197	} else {
	198	tmp = strdup(str);
	199	if (!tmp)
	200	return -ENOMEM;
	201	}
	202	params.target = tmp;
225466f1 SD	203	ret = 0;
	204	}
	205
	206	return ret;
	207	}
	208
89fe808a	209	#ifdef HAVE_DWARF_SUPPORT
1d037ca1 IT	210	static int opt_show_lines(const struct option *opt __maybe_unused,
1d037ca1 IT	211	const char *str, int unset __maybe_unused)
0eda7385	212	{
146a1439 MH	213	int ret = 0;
146a1439 MH	214
13e27d76 MH	215	if (!str)
	216	return 0;
	217
	218	if (params.show_lines) {
	219	pr_warning("Warning: more than one --line options are"
	220	" detected. Only the first one is valid.\n");
	221	return 0;
	222	}
	223
12a1fadb	224	params.show_lines = true;
13e27d76	225	ret = parse_line_range_desc(str, &params.line_range);
146a1439 MH	226
146a1439 MH	227	return ret;
0eda7385	228	}
cf6eb489	229
1d037ca1 IT	230	static int opt_show_vars(const struct option *opt __maybe_unused,
1d037ca1 IT	231	const char *str, int unset __maybe_unused)
cf6eb489 MH	232	{
	233	struct perf_probe_event *pev = &params.events[params.nevents];
	234	int ret;
	235
	236	if (!str)
	237	return 0;
	238
	239	ret = parse_probe_event(str);
	240	if (!ret && pev->nargs != 0) {
	241	pr_err(" Error: '--vars' doesn't accept arguments.\n");
	242	return -EINVAL;
	243	}
	244	params.show_vars = true;
	245
	246	return ret;
	247	}
3c42258c	248	#endif
bd09d7b5	249
1d037ca1 IT	250	static int opt_set_filter(const struct option *opt __maybe_unused,
1d037ca1 IT	251	const char *str, int unset __maybe_unused)
bd09d7b5 MH	252	{
	253	const char *err;
	254
	255	if (str) {
	256	pr_debug2("Set filter: %s\n", str);
	257	if (params.filter)
	258	strfilter__delete(params.filter);
	259	params.filter = strfilter__new(str, &err);
	260	if (!params.filter) {
823c7164	261	pr_err("Filter parse error at %td.\n", err - str + 1);
bd09d7b5 MH	262	pr_err("Source: \"%s\"\n", str);
	263	pr_err(" %*c\n", (int)(err - str + 1), '^');
	264	return -EINVAL;
	265	}
	266	}
	267
	268	return 0;
	269	}
4ea42b18	270
5a62257a	271	static int init_params(void)
e53b00d3	272	{
5a62257a	273	return line_range__init(&params.line_range);
e53b00d3 MH	274	}
	275
	276	static void cleanup_params(void)
	277	{
	278	int i;
	279
	280	for (i = 0; i < params.nevents; i++)
	281	clear_perf_probe_event(params.events + i);
	282	if (params.dellist)
	283	strlist__delete(params.dellist);
	284	line_range__clear(&params.line_range);
	285	free(params.target);
	286	if (params.filter)
	287	strfilter__delete(params.filter);
	288	memset(&params, 0, sizeof(params));
	289	}
	290
b4bf1130 MH	291	static void pr_err_with_code(const char *msg, int err)
	292	{
	293	pr_err("%s", msg);
	294	pr_debug(" Reason: %s (Code: %d)", strerror(-err), err);
	295	pr_err("\n");
	296	}
	297
e53b00d3 MH	298	static int
e53b00d3 MH	299	__cmd_probe(int argc, const char *argv, const char prefix __maybe_unused)
11c4e4a3 ACM	300	{
	301	const char * const probe_usage[] = {
	302	"perf probe [<options>] 'PROBEDEF' ['PROBEDEF' ...]",
	303	"perf probe [<options>] --add 'PROBEDEF' [--add 'PROBEDEF' ...]",
	304	"perf probe [<options>] --del '[GROUP:]EVENT' ...",
	305	"perf probe --list",
89fe808a	306	#ifdef HAVE_DWARF_SUPPORT
11c4e4a3 ACM	307	"perf probe [<options>] --line 'LINEDESC'",
11c4e4a3 ACM	308	"perf probe [<options>] --vars 'PROBEPOINT'",
f3ab481c	309	#endif
11c4e4a3	310	NULL
4ea42b18	311	};
11c4e4a3	312	const struct option options[] = {
c0555642	313	OPT_INCR('v', "verbose", &verbose,
89c69c0e	314	"be more verbose (show parsed arguments, etc)"),
12a1fadb	315	OPT_BOOLEAN('l', "list", &params.list_events,
fac13fd5	316	"list up current probe events"),
fa28244d MH	317	OPT_CALLBACK('d', "del", NULL, "[GROUP:]EVENT", "delete a probe event.",
fa28244d MH	318	opt_del_probe_event),
46ab4926	319	OPT_CALLBACK('a', "add", NULL,
89fe808a	320	#ifdef HAVE_DWARF_SUPPORT
32cb0dd5	321	"[EVENT=]FUNC[@SRC][+OFF\|%return\|:RL\|;PT]\|SRC:AL\|SRC;PT"
48481938	322	" [[NAME=]ARG ...]",
4b4da7f7	323	#else
48481938	324	"[EVENT=]FUNC[+OFF\|%return] [[NAME=]ARG ...]",
23e8ec0d	325	#endif
4ea42b18	326	"probe point definition, where\n"
af663d75 MH	327	"\t\tGROUP:\tGroup name (optional)\n"
af663d75 MH	328	"\t\tEVENT:\tEvent name\n"
4ea42b18	329	"\t\tFUNC:\tFunction name\n"
2a9c8c36	330	"\t\tOFF:\tOffset from function entry (in byte)\n"
253977b0	331	"\t\t%return:\tPut the probe at function return\n"
89fe808a	332	#ifdef HAVE_DWARF_SUPPORT
4ea42b18	333	"\t\tSRC:\tSource code path\n"
2a9c8c36 MH	334	"\t\tRL:\tRelative line number from function entry.\n"
	335	"\t\tAL:\tAbsolute line number in file.\n"
	336	"\t\tPT:\tLazy expression of line code.\n"
4ea42b18	337	"\t\tARG:\tProbe argument (local variable name or\n"
50656eec	338	"\t\t\tkprobe-tracer argument format.)\n",
4b4da7f7 MH	339	#else
	340	"\t\tARG:\tProbe argument (kprobe-tracer argument format.)\n",
	341	#endif
253977b0	342	opt_add_probe_event),
12a1fadb	343	OPT_BOOLEAN('f', "force", &params.force_add, "forcibly add events"
d761b08b	344	" with existing name"),
89fe808a	345	#ifdef HAVE_DWARF_SUPPORT
631c9def	346	OPT_CALLBACK('L', "line", NULL,
085ea739	347	"FUNC[:RLN[+NUM\|-RLN2]]\|SRC:ALN[+NUM\|-ALN2]",
631c9def	348	"Show source code lines.", opt_show_lines),
cf6eb489 MH	349	OPT_CALLBACK('V', "vars", NULL,
	350	"FUNC[@SRC][+OFF\|%return\|:RL\|;PT]\|SRC:AL\|SRC;PT",
	351	"Show accessible variables on PROBEDEF", opt_show_vars),
fb8c5a56 MH	352	OPT_BOOLEAN('\0', "externs", &params.show_ext_vars,
fb8c5a56 MH	353	"Show external variables too (with --vars only)"),
4b4da7f7 MH	354	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
4b4da7f7 MH	355	"file", "vmlinux pathname"),
9ed7e1b8 CD	356	OPT_STRING('s', "source", &symbol_conf.source_prefix,
9ed7e1b8 CD	357	"directory", "path to kernel source"),
225466f1 SD	358	OPT_CALLBACK('m', "module", NULL, "modname\|path",
	359	"target module name (for online) or path (for offline)",
	360	opt_set_target),
631c9def	361	#endif
f4d7da49	362	OPT__DRY_RUN(&probe_event_dry_run),
ef4a3565 MH	363	OPT_INTEGER('\0', "max-probes", &params.max_probe_points,
ef4a3565 MH	364	"Set how many probe points can be found for a probe."),
e80711ca MH	365	OPT_BOOLEAN('F', "funcs", &params.show_funcs,
e80711ca MH	366	"Show potential probe-able functions."),
3c42258c MH	367	OPT_CALLBACK('\0', "filter", NULL,
	368	"[!]FILTER", "Set a filter (with --vars/funcs only)\n"
	369	"\t\t\t(default: \"" DEFAULT_VAR_FILTER "\" for --vars,\n"
	370	"\t\t\t \"" DEFAULT_FUNC_FILTER "\" for --funcs)",
	371	opt_set_filter),
225466f1 SD	372	OPT_CALLBACK('x', "exec", NULL, "executable\|path",
225466f1 SD	373	"target executable name or path", opt_set_target),
35e17b24 AK	374	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
35e17b24 AK	375	"Disable symbol demangling"),
4ea42b18	376	OPT_END()
11c4e4a3	377	};
146a1439 MH	378	int ret;
146a1439 MH	379
4ea42b18	380	argc = parse_options(argc, argv, options, probe_usage,
46ab4926	381	PARSE_OPT_STOP_AT_NON_OPTION);
ce11a603 MH	382	if (argc > 0) {
	383	if (strcmp(argv[0], "-") == 0) {
	384	pr_warning(" Error: '-' is not supported.\n");
	385	usage_with_options(probe_usage, options);
	386	}
146a1439 MH	387	ret = parse_probe_event_argv(argc, argv);
146a1439 MH	388	if (ret < 0) {
b4bf1130	389	pr_err_with_code(" Error: Command Parse Error.", ret);
146a1439 MH	390	return ret;
146a1439 MH	391	}
ce11a603	392	}
46ab4926	393
ef4a3565 MH	394	if (params.max_probe_points == 0)
	395	params.max_probe_points = MAX_PROBES;
	396
4235b045	397	if ((!params.nevents && !params.dellist && !params.list_events &&
e80711ca	398	!params.show_lines && !params.show_funcs))
4ea42b18 MH	399	usage_with_options(probe_usage, options);
4ea42b18 MH	400
fd930ff9 FBH	401	/*
	402	* Only consider the user's kernel image path if given.
	403	*/
	404	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
	405
12a1fadb	406	if (params.list_events) {
cf6eb489	407	if (params.mod_events) {
146a1439	408	pr_err(" Error: Don't use --list with --add/--del.\n");
fa28244d MH	409	usage_with_options(probe_usage, options);
fa28244d MH	410	}
12a1fadb	411	if (params.show_lines) {
146a1439	412	pr_err(" Error: Don't use --list with --line.\n");
631c9def MH	413	usage_with_options(probe_usage, options);
631c9def MH	414	}
cf6eb489 MH	415	if (params.show_vars) {
	416	pr_err(" Error: Don't use --list with --vars.\n");
	417	usage_with_options(probe_usage, options);
	418	}
e80711ca MH	419	if (params.show_funcs) {
	420	pr_err(" Error: Don't use --list with --funcs.\n");
	421	usage_with_options(probe_usage, options);
	422	}
225466f1 SD	423	if (params.uprobes) {
	424	pr_warning(" Error: Don't use --list with --exec.\n");
	425	usage_with_options(probe_usage, options);
	426	}
146a1439 MH	427	ret = show_perf_probe_events();
146a1439 MH	428	if (ret < 0)
b4bf1130	429	pr_err_with_code(" Error: Failed to show event list.", ret);
146a1439	430	return ret;
4de189fe	431	}
e80711ca MH	432	if (params.show_funcs) {
	433	if (params.nevents != 0 \|\| params.dellist) {
	434	pr_err(" Error: Don't use --funcs with"
	435	" --add/--del.\n");
	436	usage_with_options(probe_usage, options);
	437	}
	438	if (params.show_lines) {
	439	pr_err(" Error: Don't use --funcs with --line.\n");
	440	usage_with_options(probe_usage, options);
	441	}
	442	if (params.show_vars) {
	443	pr_err(" Error: Don't use --funcs with --vars.\n");
	444	usage_with_options(probe_usage, options);
	445	}
3c42258c MH	446	if (!params.filter)
	447	params.filter = strfilter__new(DEFAULT_FUNC_FILTER,
	448	NULL);
225466f1 SD	449	ret = show_available_funcs(params.target, params.filter,
225466f1 SD	450	params.uprobes);
3c42258c	451	strfilter__delete(params.filter);
e53b00d3	452	params.filter = NULL;
e80711ca	453	if (ret < 0)
b4bf1130	454	pr_err_with_code(" Error: Failed to show functions.", ret);
e80711ca MH	455	return ret;
e80711ca MH	456	}
4de189fe	457
89fe808a	458	#ifdef HAVE_DWARF_SUPPORT
fb7345bb	459	if (params.show_lines) {
cf6eb489 MH	460	if (params.mod_events) {
	461	pr_err(" Error: Don't use --line with"
	462	" --add/--del.\n");
	463	usage_with_options(probe_usage, options);
	464	}
	465	if (params.show_vars) {
	466	pr_err(" Error: Don't use --line with --vars.\n");
631c9def MH	467	usage_with_options(probe_usage, options);
631c9def MH	468	}
e0faa8d3	469
4eced234	470	ret = show_line_range(&params.line_range, params.target);
146a1439	471	if (ret < 0)
b4bf1130	472	pr_err_with_code(" Error: Failed to show lines.", ret);
146a1439	473	return ret;
631c9def	474	}
cf6eb489 MH	475	if (params.show_vars) {
	476	if (params.mod_events) {
	477	pr_err(" Error: Don't use --vars with"
	478	" --add/--del.\n");
	479	usage_with_options(probe_usage, options);
	480	}
bd09d7b5 MH	481	if (!params.filter)
	482	params.filter = strfilter__new(DEFAULT_VAR_FILTER,
	483	NULL);
	484
cf6eb489	485	ret = show_available_vars(params.events, params.nevents,
fb8c5a56	486	params.max_probe_points,
4eced234	487	params.target,
bd09d7b5	488	params.filter,
fb8c5a56	489	params.show_ext_vars);
bd09d7b5	490	strfilter__delete(params.filter);
e53b00d3	491	params.filter = NULL;
cf6eb489	492	if (ret < 0)
b4bf1130	493	pr_err_with_code(" Error: Failed to show vars.", ret);
cf6eb489 MH	494	return ret;
cf6eb489 MH	495	}
631c9def MH	496	#endif
631c9def MH	497
12a1fadb	498	if (params.dellist) {
146a1439	499	ret = del_perf_probe_events(params.dellist);
146a1439	500	if (ret < 0) {
b4bf1130	501	pr_err_with_code(" Error: Failed to delete events.", ret);
146a1439 MH	502	return ret;
146a1439 MH	503	}
fa28244d MH	504	}
fa28244d MH	505
146a1439 MH	506	if (params.nevents) {
146a1439 MH	507	ret = add_perf_probe_events(params.events, params.nevents,
c82ec0a2	508	params.max_probe_points,
4eced234	509	params.target,
c82ec0a2	510	params.force_add);
146a1439	511	if (ret < 0) {
b4bf1130	512	pr_err_with_code(" Error: Failed to add events.", ret);
146a1439 MH	513	return ret;
	514	}
	515	}
4ea42b18 MH	516	return 0;
4ea42b18 MH	517	}
e53b00d3 MH	518
	519	int cmd_probe(int argc, const char *argv, const char prefix)
	520	{
	521	int ret;
	522
5a62257a MH	523	ret = init_params();
	524	if (!ret) {
	525	ret = __cmd_probe(argc, argv, prefix);
	526	cleanup_params();
	527	}
e53b00d3 MH	528
	529	return ret;
	530	}