[lttng-tools.git] / lttng / commands / enable_events.c

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *
 * 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; only version 2
 * of the License.
 *
 * 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.
 */

#define _GNU_SOURCE
#include <popt.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <inttypes.h>

#include "../cmd.h"
#include "../conf.h"
#include "../utils.h"

static char *opt_event_list;
static int opt_event_type;
static char *opt_kernel;
static char *opt_cmd_name;
static char *opt_session_name;
static int opt_pid_all;
static int opt_userspace;
static int opt_enable_all;
static pid_t opt_pid;
static char *opt_probe;
static char *opt_function_symbol;
static char *opt_channel_name;

enum {
	OPT_HELP = 1,
	OPT_USERSPACE,
	OPT_TRACEPOINT,
	OPT_MARKER,
	OPT_PROBE,
	OPT_FUNCTION,
};

static struct poptOption long_options[] = {
	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	{"help",           'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	{"session",        's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
	{"all-events",     'a', POPT_ARG_VAL, &opt_enable_all, 1, 0, 0},
	{"channel",        'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
	{"kernel",         'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
	{"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, 0, OPT_USERSPACE, 0, 0},
	{"all",            0,   POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
	{"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	{"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
	{"marker",         0,   POPT_ARG_NONE, 0, OPT_MARKER, 0, 0},
	{"probe",         0,   POPT_ARG_STRING, 0, OPT_PROBE, 0, 0},
	{"function",       0,   POPT_ARG_STRING, 0, OPT_FUNCTION, 0, 0},
	{0, 0, 0, 0, 0, 0, 0}
};

/*
 * usage
 */
static void usage(FILE *ofp)
{
	fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "  -h, --help               Show this help\n");
	fprintf(ofp, "  -s, --session            Apply on session name\n");
	fprintf(ofp, "  -c, --channel            Apply on this channel\n");
	fprintf(ofp, "  -a, --all-events         Enable all tracepoints\n");
	fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
	fprintf(ofp, "  -u, --userspace [CMD]    Apply for the user-space tracer\n");
	fprintf(ofp, "      --all                If -u, apply on all traceable apps\n");
	fprintf(ofp, "  -p, --pid PID            If -u, apply on a specific PID\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "Event options:\n");
	fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
	fprintf(ofp, "    --probe [addr | symbol+offset]\n");
	fprintf(ofp, "                           Dynamic probe.\n");
	fprintf(ofp, "                           Addr and offset can be octal (0NNN...),\n");
	fprintf(ofp, "                           decimal (NNN...) or hexadecimal (0xNNN...)\n");
	fprintf(ofp, "    --function SYMBOL      Function tracer event\n");
	fprintf(ofp, "    --marker               User-space marker (deprecated)\n");
	fprintf(ofp, "\n");
}

/*
 *  parse_probe_addr
 *
 *  Parse probe options.
 */
static int parse_probe_opts(struct lttng_event *ev, char *opt)
{
	int ret;
	uint64_t hex;
	char name[LTTNG_SYMBOL_NAME_LEN];

	if (opt == NULL) {
		ret = -1;
		goto error;
	}

	/* Check for symbol+offset */
	ret = sscanf(opt, "%[^'+']+%" SCNu64, name, &hex);
	if (ret == 2) {
		strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
		DBG("probe symbol %s", ev->attr.probe.symbol_name);
		if (hex == 0) {
			ERR("Invalid probe offset %" PRIu64, hex);
			ret = -1;
			goto error;
		}
		ev->attr.probe.offset = hex;
		DBG("probe offset %" PRIu64, ev->attr.probe.offset);
		goto error;
	}

	/* Check for address */
	ret = sscanf(opt, "%" SCNu64, &hex);
	if (ret > 0) {
		if (hex == 0) {
			ERR("Invalid probe address %" PRIu64, hex);
			ret = -1;
			goto error;
		}
		ev->attr.probe.addr = hex;
		DBG("probe addr %" PRIu64, ev->attr.probe.addr);
		goto error;
	}

	/* No match */
	ret = -1;

error:
	return ret;
}

/*
 *  enable_events
 *
 *  Enabling event using the lttng API.
 */
static int enable_events(void)
{
	int err, ret = CMD_SUCCESS;
	char *event_name, *channel_name = NULL;
	struct lttng_event ev;
	struct lttng_domain dom;

	if (set_session_name(opt_session_name) < 0) {
		ret = CMD_ERROR;
		goto error;
	}

	if (opt_channel_name == NULL) {
		err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME);
		if (err < 0) {
			ret = CMD_FATAL;
			goto error;
		}
	} else {
		channel_name = opt_channel_name;
	}

	/* Create lttng domain */
	if (opt_kernel) {
		dom.type = LTTNG_DOMAIN_KERNEL;
	}

	if (opt_enable_all) {
		if (opt_kernel) {
			ret = lttng_enable_event(&dom, NULL, channel_name);
			if (ret == 0) {
				MSG("All kernel events are enabled in channel %s", channel_name);
			}
			goto error;
		}

		/* TODO: User-space tracer */
	}

	/* Strip event list */
	event_name = strtok(opt_event_list, ",");
	while (event_name != NULL) {
		/* Kernel tracer action */
		if (opt_kernel) {
			DBG("Enabling kernel event %s for channel %s",
					event_name, channel_name);
			/* Copy name and type of the event */
			strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
			ev.type = opt_event_type;

			switch (opt_event_type) {
			case LTTNG_EVENT_TRACEPOINT:
				break;
			case LTTNG_EVENT_PROBE:
				ret = parse_probe_opts(&ev, opt_probe);
				if (ret < 0) {
					ERR("Unable to parse probe options");
					ret = 0;
					goto error;
				}
				break;
			case LTTNG_EVENT_FUNCTION:
				strncpy(ev.attr.ftrace.symbol_name, opt_function_symbol, LTTNG_SYMBOL_NAME_LEN);
				break;
			default:
				ret = CMD_NOT_IMPLEMENTED;
				goto error;
			}

			ret = lttng_enable_event(&dom, &ev, channel_name);
			if (ret == 0) {
				MSG("Kernel event %s created in channel %s", event_name, channel_name);
			} else if (ret < 0) {
				ERR("Unable to find event %s", ev.name);
			}
		} else if (opt_userspace) {		/* User-space tracer action */
			/*
			 * TODO: Waiting on lttng UST 2.0
			 */
			if (opt_pid_all) {
			} else if (opt_pid != 0) {
			}
			ret = CMD_NOT_IMPLEMENTED;
			goto error;
		} else {
			ERR("Please specify a tracer (kernel or user-space)");
			goto error;
		}

		/* Next event */
		event_name = strtok(NULL, ",");
	}

error:
	if (opt_channel_name == NULL) {
		free(channel_name);
	}
	return ret;
}

/*
 *  cmd_enable_events
 *
 *  Add event to trace session
 */
int cmd_enable_events(int argc, const char **argv)
{
	int opt, ret;
	static poptContext pc;

	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	poptReadDefaultConfig(pc, 0);

	/* Default event type */
	opt_event_type = LTTNG_EVENT_TRACEPOINT;

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
		case OPT_HELP:
			usage(stderr);
			ret = CMD_SUCCESS;
			goto end;
		case OPT_USERSPACE:
			opt_userspace = 1;
			opt_cmd_name = poptGetOptArg(pc);
			break;
		case OPT_TRACEPOINT:
			opt_event_type = LTTNG_EVENT_TRACEPOINT;
			break;
		case OPT_MARKER:
			ret = CMD_NOT_IMPLEMENTED;
			goto end;
		case OPT_PROBE:
			opt_event_type = LTTNG_EVENT_PROBE;
			opt_probe = poptGetOptArg(pc);
			break;
		case OPT_FUNCTION:
			opt_event_type = LTTNG_EVENT_FUNCTION;
			opt_function_symbol = poptGetOptArg(pc);
			break;
		default:
			usage(stderr);
			ret = CMD_UNDEFINED;
			goto end;
		}
	}

	opt_event_list = (char*) poptGetArg(pc);
	if (opt_event_list == NULL && opt_enable_all == 0) {
		ERR("Missing event name(s).\n");
		usage(stderr);
		ret = CMD_SUCCESS;
		goto end;
	}

	ret = enable_events();

end:
	return ret;
}
Commit	Line	Data
f3ed775e DG	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License
82a3637f DG	6	* as published by the Free Software Foundation; only version 2
82a3637f DG	7	* of the License.
f3ed775e DG	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	17	*/
	18
	19	#define _GNU_SOURCE
	20	#include <popt.h>
	21	#include <stdio.h>
	22	#include <stdlib.h>
	23	#include <string.h>
	24	#include <sys/stat.h>
	25	#include <sys/types.h>
	26	#include <unistd.h>
5a0de755	27	#include <inttypes.h>
f3ed775e	28
6e2d116c DG	29	#include "../cmd.h"
	30	#include "../conf.h"
	31	#include "../utils.h"
f3ed775e DG	32
	33	static char *opt_event_list;
	34	static int opt_event_type;
	35	static char *opt_kernel;
	36	static char *opt_cmd_name;
5440dc42	37	static char *opt_session_name;
f3ed775e DG	38	static int opt_pid_all;
	39	static int opt_userspace;
	40	static int opt_enable_all;
	41	static pid_t opt_pid;
cf0e5467	42	static char *opt_probe;
f3ed775e DG	43	static char *opt_function_symbol;
	44	static char *opt_channel_name;
	45
	46	enum {
	47	OPT_HELP = 1,
	48	OPT_USERSPACE,
	49	OPT_TRACEPOINT,
	50	OPT_MARKER,
cf0e5467	51	OPT_PROBE,
f3ed775e DG	52	OPT_FUNCTION,
	53	};
	54
	55	static struct poptOption long_options[] = {
	56	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	57	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42	58	{"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
f3ed775e DG	59	{"all-events", 'a', POPT_ARG_VAL, &opt_enable_all, 1, 0, 0},
	60	{"channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
	61	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
	62	{"userspace", 'u', POPT_ARG_STRING \| POPT_ARGFLAG_OPTIONAL, 0, OPT_USERSPACE, 0, 0},
	63	{"all", 0, POPT_ARG_VAL, &opt_pid_all, 1, 0, 0},
	64	{"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	65	{"tracepoint", 0, POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
	66	{"marker", 0, POPT_ARG_NONE, 0, OPT_MARKER, 0, 0},
cf0e5467	67	{"probe", 0, POPT_ARG_STRING, 0, OPT_PROBE, 0, 0},
f3ed775e DG	68	{"function", 0, POPT_ARG_STRING, 0, OPT_FUNCTION, 0, 0},
	69	{0, 0, 0, 0, 0, 0, 0}
	70	};
	71
	72	/*
	73	* usage
	74	*/
	75	static void usage(FILE *ofp)
	76	{
	77	fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
	78	fprintf(ofp, "\n");
	79	fprintf(ofp, " -h, --help Show this help\n");
5440dc42	80	fprintf(ofp, " -s, --session Apply on session name\n");
f3ed775e DG	81	fprintf(ofp, " -c, --channel Apply on this channel\n");
	82	fprintf(ofp, " -a, --all-events Enable all tracepoints\n");
	83	fprintf(ofp, " -k, --kernel Apply for the kernel tracer\n");
	84	fprintf(ofp, " -u, --userspace [CMD] Apply for the user-space tracer\n");
	85	fprintf(ofp, " --all If -u, apply on all traceable apps\n");
	86	fprintf(ofp, " -p, --pid PID If -u, apply on a specific PID\n");
	87	fprintf(ofp, "\n");
	88	fprintf(ofp, "Event options:\n");
	89	fprintf(ofp, " --tracepoint Tracepoint event (default)\n");
cf0e5467 MD	90	fprintf(ofp, " --probe [addr \| symbol+offset]\n");
	91	fprintf(ofp, " Dynamic probe.\n");
	92	fprintf(ofp, " Addr and offset can be octal (0NNN...),\n");
	93	fprintf(ofp, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
f3ed775e DG	94	fprintf(ofp, " --function SYMBOL Function tracer event\n");
	95	fprintf(ofp, " --marker User-space marker (deprecated)\n");
	96	fprintf(ofp, "\n");
	97	}
	98
0d63dd19	99	/*
cf0e5467	100	* parse_probe_addr
0d63dd19	101	*
cf0e5467	102	* Parse probe options.
0d63dd19	103	*/
cf0e5467	104	static int parse_probe_opts(struct lttng_event ev, char opt)
0d63dd19 DG	105	{
	106	int ret;
	107	uint64_t hex;
	108	char name[LTTNG_SYMBOL_NAME_LEN];
	109
	110	if (opt == NULL) {
	111	ret = -1;
	112	goto error;
	113	}
	114
	115	/* Check for symbol+offset */
5a0de755	116	ret = sscanf(opt, "%[^'+']+%" SCNu64, name, &hex);
0d63dd19	117	if (ret == 2) {
7d29a247	118	strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
cf0e5467	119	DBG("probe symbol %s", ev->attr.probe.symbol_name);
0d63dd19	120	if (hex == 0) {
cf0e5467	121	ERR("Invalid probe offset %" PRIu64, hex);
0d63dd19 DG	122	ret = -1;
	123	goto error;
	124	}
7d29a247	125	ev->attr.probe.offset = hex;
cf0e5467	126	DBG("probe offset %" PRIu64, ev->attr.probe.offset);
0d63dd19 DG	127	goto error;
	128	}
	129
	130	/* Check for address */
5a0de755	131	ret = sscanf(opt, "%" SCNu64, &hex);
0d63dd19 DG	132	if (ret > 0) {
0d63dd19 DG	133	if (hex == 0) {
cf0e5467	134	ERR("Invalid probe address %" PRIu64, hex);
0d63dd19 DG	135	ret = -1;
	136	goto error;
	137	}
7d29a247	138	ev->attr.probe.addr = hex;
cf0e5467	139	DBG("probe addr %" PRIu64, ev->attr.probe.addr);
0d63dd19 DG	140	goto error;
	141	}
	142
	143	/* No match */
	144	ret = -1;
	145
	146	error:
	147	return ret;
	148	}
	149
f3ed775e DG	150	/*
	151	* enable_events
	152	*
	153	* Enabling event using the lttng API.
	154	*/
	155	static int enable_events(void)
	156	{
	157	int err, ret = CMD_SUCCESS;
b73d0b29	158	char event_name, channel_name = NULL;
f3ed775e	159	struct lttng_event ev;
7d29a247	160	struct lttng_domain dom;
f3ed775e	161
5440dc42	162	if (set_session_name(opt_session_name) < 0) {
f3ed775e DG	163	ret = CMD_ERROR;
	164	goto error;
	165	}
	166
	167	if (opt_channel_name == NULL) {
	168	err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME);
	169	if (err < 0) {
	170	ret = CMD_FATAL;
	171	goto error;
	172	}
	173	} else {
	174	channel_name = opt_channel_name;
	175	}
	176
7d29a247 DG	177	/* Create lttng domain */
	178	if (opt_kernel) {
	179	dom.type = LTTNG_DOMAIN_KERNEL;
	180	}
	181
f3ed775e DG	182	if (opt_enable_all) {
f3ed775e DG	183	if (opt_kernel) {
7d29a247	184	ret = lttng_enable_event(&dom, NULL, channel_name);
c93d9daf DG	185	if (ret == 0) {
	186	MSG("All kernel events are enabled in channel %s", channel_name);
	187	}
f3ed775e DG	188	goto error;
	189	}
	190
	191	/* TODO: User-space tracer */
	192	}
	193
	194	/* Strip event list */
	195	event_name = strtok(opt_event_list, ",");
	196	while (event_name != NULL) {
	197	/* Kernel tracer action */
	198	if (opt_kernel) {
	199	DBG("Enabling kernel event %s for channel %s",
	200	event_name, channel_name);
	201	/* Copy name and type of the event */
	202	strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
	203	ev.type = opt_event_type;
	204
	205	switch (opt_event_type) {
e6ddca71	206	case LTTNG_EVENT_TRACEPOINT:
f3ed775e	207	break;
7d29a247	208	case LTTNG_EVENT_PROBE:
cf0e5467	209	ret = parse_probe_opts(&ev, opt_probe);
0d63dd19	210	if (ret < 0) {
cf0e5467	211	ERR("Unable to parse probe options");
0d63dd19 DG	212	ret = 0;
	213	goto error;
	214	}
f3ed775e DG	215	break;
	216	case LTTNG_EVENT_FUNCTION:
	217	strncpy(ev.attr.ftrace.symbol_name, opt_function_symbol, LTTNG_SYMBOL_NAME_LEN);
f3ed775e DG	218	break;
	219	default:
	220	ret = CMD_NOT_IMPLEMENTED;
	221	goto error;
	222	}
	223
7d29a247 DG	224	ret = lttng_enable_event(&dom, &ev, channel_name);
7d29a247 DG	225	if (ret == 0) {
f3ed775e	226	MSG("Kernel event %s created in channel %s", event_name, channel_name);
7d29a247 DG	227	} else if (ret < 0) {
7d29a247 DG	228	ERR("Unable to find event %s", ev.name);
f3ed775e DG	229	}
	230	} else if (opt_userspace) { /* User-space tracer action */
	231	/*
	232	* TODO: Waiting on lttng UST 2.0
	233	*/
	234	if (opt_pid_all) {
	235	} else if (opt_pid != 0) {
	236	}
	237	ret = CMD_NOT_IMPLEMENTED;
	238	goto error;
	239	} else {
	240	ERR("Please specify a tracer (kernel or user-space)");
	241	goto error;
	242	}
	243
	244	/* Next event */
	245	event_name = strtok(NULL, ",");
	246	}
	247
	248	error:
b73d0b29 MD	249	if (opt_channel_name == NULL) {
	250	free(channel_name);
	251	}
f3ed775e DG	252	return ret;
	253	}
	254
	255	/*
	256	* cmd_enable_events
	257	*
	258	* Add event to trace session
	259	*/
	260	int cmd_enable_events(int argc, const char **argv)
	261	{
	262	int opt, ret;
	263	static poptContext pc;
	264
	265	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	266	poptReadDefaultConfig(pc, 0);
	267
	268	/* Default event type */
e6ddca71	269	opt_event_type = LTTNG_EVENT_TRACEPOINT;
f3ed775e DG	270
	271	while ((opt = poptGetNextOpt(pc)) != -1) {
	272	switch (opt) {
	273	case OPT_HELP:
	274	usage(stderr);
	275	ret = CMD_SUCCESS;
	276	goto end;
	277	case OPT_USERSPACE:
	278	opt_userspace = 1;
	279	opt_cmd_name = poptGetOptArg(pc);
	280	break;
	281	case OPT_TRACEPOINT:
e6ddca71	282	opt_event_type = LTTNG_EVENT_TRACEPOINT;
f3ed775e DG	283	break;
	284	case OPT_MARKER:
	285	ret = CMD_NOT_IMPLEMENTED;
	286	goto end;
cf0e5467	287	case OPT_PROBE:
7d29a247	288	opt_event_type = LTTNG_EVENT_PROBE;
cf0e5467	289	opt_probe = poptGetOptArg(pc);
f3ed775e DG	290	break;
	291	case OPT_FUNCTION:
	292	opt_event_type = LTTNG_EVENT_FUNCTION;
	293	opt_function_symbol = poptGetOptArg(pc);
	294	break;
	295	default:
	296	usage(stderr);
	297	ret = CMD_UNDEFINED;
	298	goto end;
	299	}
	300	}
	301
	302	opt_event_list = (char*) poptGetArg(pc);
	303	if (opt_event_list == NULL && opt_enable_all == 0) {
	304	ERR("Missing event name(s).\n");
	305	usage(stderr);
	306	ret = CMD_SUCCESS;
	307	goto end;
	308	}
	309
	310	ret = enable_events();
	311
	312	end:
	313	return ret;
	314	}