[linux-2.6-block.git] / tools / perf / util / probe-file.c

/*
 * probe-file.c : operate ftrace k/uprobe events files
 *
 * Written by Masami Hiramatsu <masami.hiramatsu.pt@hitachi.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.
 *
 */
#include "util.h"
#include "event.h"
#include "strlist.h"
#include "debug.h"
#include "cache.h"
#include "color.h"
#include "symbol.h"
#include "thread.h"
#include <api/fs/tracing_path.h>
#include "probe-event.h"
#include "probe-file.h"
#include "session.h"

#define MAX_CMDLEN 256

static void print_open_warning(int err, bool uprobe)
{
	char sbuf[STRERR_BUFSIZE];

	if (err == -ENOENT) {
		const char *config;

		if (uprobe)
			config = "CONFIG_UPROBE_EVENTS";
		else
			config = "CONFIG_KPROBE_EVENTS";

		pr_warning("%cprobe_events file does not exist"
			   " - please rebuild kernel with %s.\n",
			   uprobe ? 'u' : 'k', config);
	} else if (err == -ENOTSUP)
		pr_warning("Tracefs or debugfs is not mounted.\n");
	else
		pr_warning("Failed to open %cprobe_events: %s\n",
			   uprobe ? 'u' : 'k',
			   strerror_r(-err, sbuf, sizeof(sbuf)));
}

static void print_both_open_warning(int kerr, int uerr)
{
	/* Both kprobes and uprobes are disabled, warn it. */
	if (kerr == -ENOTSUP && uerr == -ENOTSUP)
		pr_warning("Tracefs or debugfs is not mounted.\n");
	else if (kerr == -ENOENT && uerr == -ENOENT)
		pr_warning("Please rebuild kernel with CONFIG_KPROBE_EVENTS "
			   "or/and CONFIG_UPROBE_EVENTS.\n");
	else {
		char sbuf[STRERR_BUFSIZE];
		pr_warning("Failed to open kprobe events: %s.\n",
			   strerror_r(-kerr, sbuf, sizeof(sbuf)));
		pr_warning("Failed to open uprobe events: %s.\n",
			   strerror_r(-uerr, sbuf, sizeof(sbuf)));
	}
}

static int open_probe_events(const char *trace_file, bool readwrite)
{
	char buf[PATH_MAX];
	const char *tracing_dir = "";
	int ret;

	ret = e_snprintf(buf, PATH_MAX, "%s/%s%s",
			 tracing_path, tracing_dir, trace_file);
	if (ret >= 0) {
		pr_debug("Opening %s write=%d\n", buf, readwrite);
		if (readwrite && !probe_event_dry_run)
			ret = open(buf, O_RDWR | O_APPEND, 0);
		else
			ret = open(buf, O_RDONLY, 0);

		if (ret < 0)
			ret = -errno;
	}
	return ret;
}

static int open_kprobe_events(bool readwrite)
{
	return open_probe_events("kprobe_events", readwrite);
}

static int open_uprobe_events(bool readwrite)
{
	return open_probe_events("uprobe_events", readwrite);
}

int probe_file__open(int flag)
{
	int fd;

	if (flag & PF_FL_UPROBE)
		fd = open_uprobe_events(flag & PF_FL_RW);
	else
		fd = open_kprobe_events(flag & PF_FL_RW);
	if (fd < 0)
		print_open_warning(fd, flag & PF_FL_UPROBE);

	return fd;
}

int probe_file__open_both(int *kfd, int *ufd, int flag)
{
	if (!kfd || !ufd)
		return -EINVAL;

	*kfd = open_kprobe_events(flag & PF_FL_RW);
	*ufd = open_uprobe_events(flag & PF_FL_RW);
	if (*kfd < 0 && *ufd < 0) {
		print_both_open_warning(*kfd, *ufd);
		return *kfd;
	}

	return 0;
}

/* Get raw string list of current kprobe_events  or uprobe_events */
struct strlist *probe_file__get_rawlist(int fd)
{
	int ret, idx;
	FILE *fp;
	char buf[MAX_CMDLEN];
	char *p;
	struct strlist *sl;

	if (fd < 0)
		return NULL;

	sl = strlist__new(NULL, NULL);

	fp = fdopen(dup(fd), "r");
	while (!feof(fp)) {
		p = fgets(buf, MAX_CMDLEN, fp);
		if (!p)
			break;

		idx = strlen(p) - 1;
		if (p[idx] == '\n')
			p[idx] = '\0';
		ret = strlist__add(sl, buf);
		if (ret < 0) {
			pr_debug("strlist__add failed (%d)\n", ret);
			strlist__delete(sl);
			return NULL;
		}
	}
	fclose(fp);

	return sl;
}

static struct strlist *__probe_file__get_namelist(int fd, bool include_group)
{
	char buf[128];
	struct strlist *sl, *rawlist;
	struct str_node *ent;
	struct probe_trace_event tev;
	int ret = 0;

	memset(&tev, 0, sizeof(tev));
	rawlist = probe_file__get_rawlist(fd);
	if (!rawlist)
		return NULL;
	sl = strlist__new(NULL, NULL);
	strlist__for_each(ent, rawlist) {
		ret = parse_probe_trace_command(ent->s, &tev);
		if (ret < 0)
			break;
		if (include_group) {
			ret = e_snprintf(buf, 128, "%s:%s", tev.group,
					tev.event);
			if (ret >= 0)
				ret = strlist__add(sl, buf);
		} else
			ret = strlist__add(sl, tev.event);
		clear_probe_trace_event(&tev);
		if (ret < 0)
			break;
	}
	strlist__delete(rawlist);

	if (ret < 0) {
		strlist__delete(sl);
		return NULL;
	}
	return sl;
}

/* Get current perf-probe event names */
struct strlist *probe_file__get_namelist(int fd)
{
	return __probe_file__get_namelist(fd, false);
}

int probe_file__add_event(int fd, struct probe_trace_event *tev)
{
	int ret = 0;
	char *buf = synthesize_probe_trace_command(tev);
	char sbuf[STRERR_BUFSIZE];

	if (!buf) {
		pr_debug("Failed to synthesize probe trace event.\n");
		return -EINVAL;
	}

	pr_debug("Writing event: %s\n", buf);
	if (!probe_event_dry_run) {
		if (write(fd, buf, strlen(buf)) < (int)strlen(buf)) {
			ret = -errno;
			pr_warning("Failed to write event: %s\n",
				   strerror_r(errno, sbuf, sizeof(sbuf)));
		}
	}
	free(buf);

	return ret;
}

static int __del_trace_probe_event(int fd, struct str_node *ent)
{
	char *p;
	char buf[128];
	int ret;

	/* Convert from perf-probe event to trace-probe event */
	ret = e_snprintf(buf, 128, "-:%s", ent->s);
	if (ret < 0)
		goto error;

	p = strchr(buf + 2, ':');
	if (!p) {
		pr_debug("Internal error: %s should have ':' but not.\n",
			 ent->s);
		ret = -ENOTSUP;
		goto error;
	}
	*p = '/';

	pr_debug("Writing event: %s\n", buf);
	ret = write(fd, buf, strlen(buf));
	if (ret < 0) {
		ret = -errno;
		goto error;
	}

	return 0;
error:
	pr_warning("Failed to delete event: %s\n",
		   strerror_r(-ret, buf, sizeof(buf)));
	return ret;
}

int probe_file__get_events(int fd, struct strfilter *filter,
			   struct strlist *plist)
{
	struct strlist *namelist;
	struct str_node *ent;
	const char *p;
	int ret = -ENOENT;

	if (!plist)
		return -EINVAL;

	namelist = __probe_file__get_namelist(fd, true);
	if (!namelist)
		return -ENOENT;

	strlist__for_each(ent, namelist) {
		p = strchr(ent->s, ':');
		if ((p && strfilter__compare(filter, p + 1)) ||
		    strfilter__compare(filter, ent->s)) {
			strlist__add(plist, ent->s);
			ret = 0;
		}
	}
	strlist__delete(namelist);

	return ret;
}

int probe_file__del_strlist(int fd, struct strlist *namelist)
{
	int ret = 0;
	struct str_node *ent;

	strlist__for_each(ent, namelist) {
		ret = __del_trace_probe_event(fd, ent);
		if (ret < 0)
			break;
	}
	return ret;
}

int probe_file__del_events(int fd, struct strfilter *filter)
{
	struct strlist *namelist;
	int ret;

	namelist = strlist__new(NULL, NULL);
	if (!namelist)
		return -ENOMEM;

	ret = probe_file__get_events(fd, filter, namelist);
	if (ret < 0)
		return ret;

	ret = probe_file__del_strlist(fd, namelist);
	strlist__delete(namelist);

	return ret;
}
Commit	Line	Data
92f6c72e MH	1	/*
	2	* probe-file.c : operate ftrace k/uprobe events files
	3	*
	4	* Written by Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	*/
	17	#include "util.h"
	18	#include "event.h"
	19	#include "strlist.h"
	20	#include "debug.h"
	21	#include "cache.h"
	22	#include "color.h"
	23	#include "symbol.h"
	24	#include "thread.h"
fbf99625	25	#include <api/fs/tracing_path.h>
92f6c72e MH	26	#include "probe-event.h"
	27	#include "probe-file.h"
	28	#include "session.h"
	29
	30	#define MAX_CMDLEN 256
	31
	32	static void print_open_warning(int err, bool uprobe)
	33	{
	34	char sbuf[STRERR_BUFSIZE];
	35
	36	if (err == -ENOENT) {
	37	const char *config;
	38
	39	if (uprobe)
	40	config = "CONFIG_UPROBE_EVENTS";
	41	else
	42	config = "CONFIG_KPROBE_EVENTS";
	43
	44	pr_warning("%cprobe_events file does not exist"
	45	" - please rebuild kernel with %s.\n",
	46	uprobe ? 'u' : 'k', config);
	47	} else if (err == -ENOTSUP)
	48	pr_warning("Tracefs or debugfs is not mounted.\n");
	49	else
	50	pr_warning("Failed to open %cprobe_events: %s\n",
	51	uprobe ? 'u' : 'k',
	52	strerror_r(-err, sbuf, sizeof(sbuf)));
	53	}
	54
	55	static void print_both_open_warning(int kerr, int uerr)
	56	{
	57	/* Both kprobes and uprobes are disabled, warn it. */
	58	if (kerr == -ENOTSUP && uerr == -ENOTSUP)
	59	pr_warning("Tracefs or debugfs is not mounted.\n");
	60	else if (kerr == -ENOENT && uerr == -ENOENT)
	61	pr_warning("Please rebuild kernel with CONFIG_KPROBE_EVENTS "
	62	"or/and CONFIG_UPROBE_EVENTS.\n");
	63	else {
	64	char sbuf[STRERR_BUFSIZE];
	65	pr_warning("Failed to open kprobe events: %s.\n",
	66	strerror_r(-kerr, sbuf, sizeof(sbuf)));
	67	pr_warning("Failed to open uprobe events: %s.\n",
	68	strerror_r(-uerr, sbuf, sizeof(sbuf)));
	69	}
	70	}
	71
	72	static int open_probe_events(const char *trace_file, bool readwrite)
	73	{
	74	char buf[PATH_MAX];
92f6c72e MH	75	const char *tracing_dir = "";
	76	int ret;
	77
92f6c72e	78	ret = e_snprintf(buf, PATH_MAX, "%s/%s%s",
fbf99625	79	tracing_path, tracing_dir, trace_file);
92f6c72e MH	80	if (ret >= 0) {
	81	pr_debug("Opening %s write=%d\n", buf, readwrite);
	82	if (readwrite && !probe_event_dry_run)
	83	ret = open(buf, O_RDWR \| O_APPEND, 0);
	84	else
	85	ret = open(buf, O_RDONLY, 0);
	86
	87	if (ret < 0)
	88	ret = -errno;
	89	}
	90	return ret;
	91	}
	92
	93	static int open_kprobe_events(bool readwrite)
	94	{
	95	return open_probe_events("kprobe_events", readwrite);
	96	}
	97
	98	static int open_uprobe_events(bool readwrite)
	99	{
	100	return open_probe_events("uprobe_events", readwrite);
	101	}
	102
	103	int probe_file__open(int flag)
	104	{
	105	int fd;
	106
	107	if (flag & PF_FL_UPROBE)
	108	fd = open_uprobe_events(flag & PF_FL_RW);
	109	else
	110	fd = open_kprobe_events(flag & PF_FL_RW);
	111	if (fd < 0)
	112	print_open_warning(fd, flag & PF_FL_UPROBE);
	113
	114	return fd;
	115	}
	116
	117	int probe_file__open_both(int kfd, int ufd, int flag)
	118	{
	119	if (!kfd \|\| !ufd)
	120	return -EINVAL;
	121
	122	*kfd = open_kprobe_events(flag & PF_FL_RW);
	123	*ufd = open_uprobe_events(flag & PF_FL_RW);
	124	if (kfd < 0 && ufd < 0) {
	125	print_both_open_warning(kfd, ufd);
	126	return *kfd;
	127	}
	128
	129	return 0;
	130	}
	131
	132	/* Get raw string list of current kprobe_events or uprobe_events */
	133	struct strlist *probe_file__get_rawlist(int fd)
	134	{
	135	int ret, idx;
	136	FILE *fp;
	137	char buf[MAX_CMDLEN];
	138	char *p;
	139	struct strlist *sl;
	140
421fd084 WN	141	if (fd < 0)
	142	return NULL;
	143
92f6c72e MH	144	sl = strlist__new(NULL, NULL);
	145
	146	fp = fdopen(dup(fd), "r");
	147	while (!feof(fp)) {
	148	p = fgets(buf, MAX_CMDLEN, fp);
	149	if (!p)
	150	break;
	151
	152	idx = strlen(p) - 1;
	153	if (p[idx] == '\n')
	154	p[idx] = '\0';
	155	ret = strlist__add(sl, buf);
	156	if (ret < 0) {
	157	pr_debug("strlist__add failed (%d)\n", ret);
	158	strlist__delete(sl);
	159	return NULL;
	160	}
	161	}
	162	fclose(fp);
	163
	164	return sl;
	165	}
	166
	167	static struct strlist *__probe_file__get_namelist(int fd, bool include_group)
	168	{
	169	char buf[128];
	170	struct strlist sl, rawlist;
	171	struct str_node *ent;
	172	struct probe_trace_event tev;
	173	int ret = 0;
	174
	175	memset(&tev, 0, sizeof(tev));
	176	rawlist = probe_file__get_rawlist(fd);
	177	if (!rawlist)
	178	return NULL;
	179	sl = strlist__new(NULL, NULL);
	180	strlist__for_each(ent, rawlist) {
	181	ret = parse_probe_trace_command(ent->s, &tev);
	182	if (ret < 0)
	183	break;
	184	if (include_group) {
	185	ret = e_snprintf(buf, 128, "%s:%s", tev.group,
	186	tev.event);
	187	if (ret >= 0)
	188	ret = strlist__add(sl, buf);
	189	} else
	190	ret = strlist__add(sl, tev.event);
	191	clear_probe_trace_event(&tev);
	192	if (ret < 0)
	193	break;
	194	}
	195	strlist__delete(rawlist);
	196
	197	if (ret < 0) {
	198	strlist__delete(sl);
	199	return NULL;
	200	}
	201	return sl;
	202	}
	203
	204	/* Get current perf-probe event names */
	205	struct strlist *probe_file__get_namelist(int fd)
	206	{
	207	return __probe_file__get_namelist(fd, false);
208	}
209
210	int probe_file__add_event(int fd, struct probe_trace_event *tev)
211	{
212	int ret = 0;
213	char *buf = synthesize_probe_trace_command(tev);
214	char sbuf[STRERR_BUFSIZE];
215
216	if (!buf) {
217	pr_debug("Failed to synthesize probe trace event.\n");
218	return -EINVAL;
219	}
220
221	pr_debug("Writing event: %s\n", buf);
222	if (!probe_event_dry_run) {
6ed0720a	223	if (write(fd, buf, strlen(buf)) < (int)strlen(buf)) {
92f6c72e MH	224	ret = -errno;
	225	pr_warning("Failed to write event: %s\n",
	226	strerror_r(errno, sbuf, sizeof(sbuf)));
	227	}
	228	}
	229	free(buf);
	230
	231	return ret;
	232	}
	233
	234	static int __del_trace_probe_event(int fd, struct str_node *ent)
	235	{
	236	char *p;
	237	char buf[128];
	238	int ret;
	239
	240	/* Convert from perf-probe event to trace-probe event */
	241	ret = e_snprintf(buf, 128, "-:%s", ent->s);
	242	if (ret < 0)
	243	goto error;
	244
	245	p = strchr(buf + 2, ':');
	246	if (!p) {
	247	pr_debug("Internal error: %s should have ':' but not.\n",
	248	ent->s);
	249	ret = -ENOTSUP;
	250	goto error;
	251	}
	252	*p = '/';
	253
	254	pr_debug("Writing event: %s\n", buf);
	255	ret = write(fd, buf, strlen(buf));
	256	if (ret < 0) {
	257	ret = -errno;
	258	goto error;
	259	}
	260
92f6c72e MH	261	return 0;
	262	error:
	263	pr_warning("Failed to delete event: %s\n",
	264	strerror_r(-ret, buf, sizeof(buf)));
	265	return ret;
	266	}
	267
e607f142 NK	268	int probe_file__get_events(int fd, struct strfilter *filter,
e607f142 NK	269	struct strlist *plist)
92f6c72e MH	270	{
	271	struct strlist *namelist;
	272	struct str_node *ent;
	273	const char *p;
	274	int ret = -ENOENT;
	275
421fd084 WN	276	if (!plist)
	277	return -EINVAL;
	278
92f6c72e MH	279	namelist = __probe_file__get_namelist(fd, true);
	280	if (!namelist)
	281	return -ENOENT;
	282
	283	strlist__for_each(ent, namelist) {
	284	p = strchr(ent->s, ':');
	285	if ((p && strfilter__compare(filter, p + 1)) \|\|
	286	strfilter__compare(filter, ent->s)) {
e7895e42 NK	287	strlist__add(plist, ent->s);
e7895e42 NK	288	ret = 0;
92f6c72e MH	289	}
	290	}
	291	strlist__delete(namelist);
	292
	293	return ret;
	294	}
e7895e42	295
e607f142	296	int probe_file__del_strlist(int fd, struct strlist *namelist)
e7895e42 NK	297	{
	298	int ret = 0;
	299	struct str_node *ent;
	300
	301	strlist__for_each(ent, namelist) {
	302	ret = __del_trace_probe_event(fd, ent);
	303	if (ret < 0)
	304	break;
	305	}
	306	return ret;
	307	}
	308
	309	int probe_file__del_events(int fd, struct strfilter *filter)
	310	{
	311	struct strlist *namelist;
	312	int ret;
	313
	314	namelist = strlist__new(NULL, NULL);
	315	if (!namelist)
	316	return -ENOMEM;
	317
	318	ret = probe_file__get_events(fd, filter, namelist);
	319	if (ret < 0)
	320	return ret;
	321
	322	ret = probe_file__del_strlist(fd, namelist);
	323	strlist__delete(namelist);
	324
	325	return ret;
	326	}