[lttng-tools.git] / src / bin / 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 <ctype.h>

#include "../command.h"

static char *opt_event_list;
static int opt_event_type;
static const char *opt_loglevel;
static int opt_loglevel_type;
static int opt_kernel;
static char *opt_session_name;
static int opt_userspace;
static int opt_enable_all;
static char *opt_probe;
static char *opt_function;
static char *opt_function_entry_symbol;
static char *opt_channel_name;
#if 0
/* Not implemented yet */
static char *opt_cmd_name;
static pid_t opt_pid;
#endif

enum {
	OPT_HELP = 1,
	OPT_TRACEPOINT,
	OPT_PROBE,
	OPT_FUNCTION,
	OPT_FUNCTION_ENTRY,
	OPT_SYSCALL,
	OPT_USERSPACE,
	OPT_LOGLEVEL,
	OPT_LOGLEVEL_ONLY,
	OPT_LIST_OPTIONS,
};

static struct lttng_handle *handle;

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",            '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},
#if 0
	/* Not implemented yet */
	{"userspace",      'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
	{"pid",            'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
#else
	{"userspace",      'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
#endif
	{"tracepoint",     0,   POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
	{"probe",          0,   POPT_ARG_STRING, &opt_probe, OPT_PROBE, 0, 0},
	{"function",       0,   POPT_ARG_STRING, &opt_function, OPT_FUNCTION, 0, 0},
#if 0
	/*
	 * Currently removed from lttng kernel tracer. Removed from
	 * lttng UI to discourage its use.
	 */
	{"function:entry", 0,   POPT_ARG_STRING, &opt_function_entry_symbol, OPT_FUNCTION_ENTRY, 0, 0},
#endif
	{"syscall",        0,   POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
	{"loglevel",       0,     POPT_ARG_STRING, 0, OPT_LOGLEVEL, 0, 0},
	{"loglevel-only",  0,     POPT_ARG_STRING, 0, OPT_LOGLEVEL_ONLY, 0, 0},
	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
	{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, "      --list-options       Simple listing of options\n");
	fprintf(ofp, "  -s, --session            Apply to session name\n");
	fprintf(ofp, "  -c, --channel            Apply to this channel\n");
	fprintf(ofp, "  -a, --all                Enable all tracepoints\n");
	fprintf(ofp, "  -k, --kernel             Apply for the kernel tracer\n");
#if 0
	fprintf(ofp, "  -u, --userspace [CMD]    Apply to the user-space tracer\n");
	fprintf(ofp, "                           If no CMD, the domain used is UST global\n");
	fprintf(ofp, "                           or else the domain is UST EXEC_NAME\n");
	fprintf(ofp, "  -p, --pid PID            If -u, apply to specific PID (domain: UST PID)\n");
#else
	fprintf(ofp, "  -u, --userspace          Apply to the user-space tracer\n");
#endif
	fprintf(ofp, "\n");
	fprintf(ofp, "Event options:\n");
	fprintf(ofp, "    --tracepoint           Tracepoint event (default)\n");
	fprintf(ofp, "                           - userspace tracer supports wildcards at end of string.\n");
	fprintf(ofp, "                             Don't forget to quote to deal with bash expansion.\n");
	fprintf(ofp, "                             e.g.:\n");
	fprintf(ofp, "                               \"*\"\n");
	fprintf(ofp, "                               \"app_component:na*\"\n");
	fprintf(ofp, "    --probe [addr | symbol | 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 [addr | symbol | symbol+offset]\n");
	fprintf(ofp, "                           Dynamic function entry/return probe.\n");
	fprintf(ofp, "                           Addr and offset can be octal (0NNN...),\n");
	fprintf(ofp, "                           decimal (NNN...) or hexadecimal (0xNNN...)\n");
#if 0
	fprintf(ofp, "    --function:entry symbol\n");
	fprintf(ofp, "                           Function tracer event\n");
#endif
	fprintf(ofp, "    --syscall              System call event\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "    --loglevel name\n");
	fprintf(ofp, "                           Tracepoint loglevel range from 0 to loglevel\n");
	fprintf(ofp, "    --loglevel-only name\n");
	fprintf(ofp, "                           Tracepoint loglevel (only this loglevel)\n");
	fprintf(ofp, "\n");
	fprintf(ofp, "                           The loglevel or loglevel-only options should be\n");
	fprintf(ofp, "                           combined with a tracepoint name or tracepoint\n");
	fprintf(ofp, "                           wildcard.\n");
	fprintf(ofp, "                           Available loglevels:\n");
	fprintf(ofp, "                                              (higher value is more verbose)\n");
	fprintf(ofp, "                               TRACE_EMERG    = 0\n");
	fprintf(ofp, "                               TRACE_ALERT    = 1\n");
	fprintf(ofp, "                               TRACE_CRIT     = 2\n");
	fprintf(ofp, "                               TRACE_ERR      = 3\n");
	fprintf(ofp, "                               TRACE_WARNING  = 4\n");
	fprintf(ofp, "                               TRACE_NOTICE   = 5\n");
	fprintf(ofp, "                               TRACE_INFO     = 6\n");
	fprintf(ofp, "                               TRACE_SYSTEM   = 7\n");
	fprintf(ofp, "                               TRACE_PROGRAM  = 8\n");
	fprintf(ofp, "                               TRACE_PROCESS  = 9\n");
	fprintf(ofp, "                               TRACE_MODULE   = 10\n");
	fprintf(ofp, "                               TRACE_UNIT     = 11\n");
	fprintf(ofp, "                               TRACE_FUNCTION = 12\n");
	fprintf(ofp, "                               TRACE_DEFAULT  = 13\n");
	fprintf(ofp, "                               TRACE_VERBOSE  = 14\n");
	fprintf(ofp, "                               TRACE_DEBUG    = 15\n");
	fprintf(ofp, "\n");
}

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

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

	/* Check for symbol+offset */
	ret = sscanf(opt, "%[^'+']+%s", name, s_hex);
	if (ret == 2) {
		strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
		ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
		DBG("probe symbol %s", ev->attr.probe.symbol_name);
		if (strlen(s_hex) == 0) {
			ERR("Invalid probe offset %s", s_hex);
			ret = -1;
			goto end;
		}
		ev->attr.probe.offset = strtoul(s_hex, NULL, 0);
		DBG("probe offset %" PRIu64, ev->attr.probe.offset);
		ev->attr.probe.addr = 0;
		goto end;
	}

	/* Check for symbol */
	if (isalpha(name[0])) {
		ret = sscanf(opt, "%s", name);
		if (ret == 1) {
			strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
			ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
			DBG("probe symbol %s", ev->attr.probe.symbol_name);
			ev->attr.probe.offset = 0;
			DBG("probe offset %" PRIu64, ev->attr.probe.offset);
			ev->attr.probe.addr = 0;
			goto end;
		}
	}

	/* Check for address */
	ret = sscanf(opt, "%s", s_hex);
	if (ret > 0) {
		if (strlen(s_hex) == 0) {
			ERR("Invalid probe address %s", s_hex);
			ret = -1;
			goto end;
		}
		ev->attr.probe.addr = strtoul(s_hex, NULL, 0);
		DBG("probe addr %" PRIu64, ev->attr.probe.addr);
		ev->attr.probe.offset = 0;
		memset(ev->attr.probe.symbol_name, 0, LTTNG_SYMBOL_NAME_LEN);
		goto end;
	}

	/* No match */
	ret = -1;

end:
	return ret;
}

/*
 * Maps loglevel from string to value
 */
static
int loglevel_str_to_value(const char *str)
{
	if (!strcmp(str, "TRACE_EMERG")) {
		return 0;
	} else if (!strcmp(str, "TRACE_ALERT")) {
		return 1;
	} else if (!strcmp(str, "TRACE_CRIT")) {
		return 2;
	} else if (!strcmp(str, "TRACE_ERR")) {
		return 3;
	} else if (!strcmp(str, "TRACE_WARNING")) {
		return 4;
	} else if (!strcmp(str, "TRACE_NOTICE")) {
		return 5;
	} else if (!strcmp(str, "TRACE_INFO")) {
		return 6;
	} else if (!strcmp(str, "TRACE_SYSTEM")) {
		return 7;
	} else if (!strcmp(str, "TRACE_PROGRAM")) {
		return 8;
	} else if (!strcmp(str, "TRACE_PROCESS")) {
		return 9;
	} else if (!strcmp(str, "TRACE_MODULE")) {
		return 10;
	} else if (!strcmp(str, "TRACE_UNIT")) {
		return 11;
	} else if (!strcmp(str, "TRACE_FUNCTION")) {
		return 12;
	} else if (!strcmp(str, "TRACE_DEFAULT")) {
		return 13;
	} else if (!strcmp(str, "TRACE_VERBOSE")) {
		return 14;
	} else if (!strcmp(str, "TRACE_DEBUG")) {
		return 15;
	} else {
		return -1;
	}
}

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

	memset(&ev, 0, sizeof(ev));
	memset(&dom, 0, sizeof(dom));

	/* Create lttng domain */
	if (opt_kernel) {
		dom.type = LTTNG_DOMAIN_KERNEL;
	} else if (opt_userspace) {
		dom.type = LTTNG_DOMAIN_UST;
	} else {
		ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
		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;
	}

	handle = lttng_create_handle(session_name, &dom);
	if (handle == NULL) {
		ret = -1;
		goto error;
	}

	if (opt_enable_all) {
		/* Default setup for enable all */
		if (opt_kernel) {
			ev.type = opt_event_type;
			ev.name[0] = '\0';
			/* kernel loglevels not implemented */
			ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
		} else {
			ev.type = LTTNG_EVENT_TRACEPOINT;
			strcpy(ev.name, "*");
			ev.loglevel_type = opt_loglevel_type;
			if (opt_loglevel) {
				ev.loglevel = loglevel_str_to_value(opt_loglevel);
				if (ev.loglevel == -1) {
					ERR("Unknown loglevel %s", opt_loglevel);
					ret = -1;
					goto error;
				}
			} else {
				ev.loglevel = -1;
			}
		}

		ret = lttng_enable_event(handle, &ev, channel_name);
		if (ret < 0) {
			goto error;
		}

		switch (opt_event_type) {
		case LTTNG_EVENT_TRACEPOINT:
			MSG("All %s tracepoints are enabled in channel %s for loglevel %s",
				opt_kernel ? "kernel" : "UST", channel_name,
				opt_loglevel ? : "<all>");
			break;
		case LTTNG_EVENT_SYSCALL:
			if (opt_kernel) {
				MSG("All kernel system calls are enabled in channel %s",
						channel_name);
			}
			break;
		case LTTNG_EVENT_ALL:
			MSG("All %s events are enabled in channel %s for loglevel %s",
				opt_kernel ? "kernel" : "UST", channel_name,
				opt_loglevel ? : "<all>");
			break;
		default:
			/*
			 * We should not be here since lttng_enable_event should have
			 * failed on the event type.
			 */
			goto error;
		}
		goto end;
	}

	/* Strip event list */
	event_name = strtok(opt_event_list, ",");
	while (event_name != NULL) {
		/* Copy name and type of the event */
		strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
		ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
		ev.type = opt_event_type;

		/* Kernel tracer action */
		if (opt_kernel) {
			DBG("Enabling kernel event %s for channel %s",
					event_name, channel_name);

			switch (opt_event_type) {
			case LTTNG_EVENT_ALL:	/* Default behavior is tracepoint */
				ev.type = LTTNG_EVENT_TRACEPOINT;
				/* Fall-through */
			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:
				ret = parse_probe_opts(&ev, opt_function);
				if (ret < 0) {
					ERR("Unable to parse function probe options");
					ret = 0;
					goto error;
				}
				break;
			case LTTNG_EVENT_FUNCTION_ENTRY:
				strncpy(ev.attr.ftrace.symbol_name, opt_function_entry_symbol,
						LTTNG_SYMBOL_NAME_LEN);
				ev.attr.ftrace.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
				break;
			case LTTNG_EVENT_SYSCALL:
				MSG("per-syscall selection not supported yet. Use \"-a\" "
						"for all syscalls.");
			default:
				ret = CMD_UNDEFINED;
				goto error;
			}

			if (opt_loglevel) {
				MSG("Kernel loglevels are not supported.");
				ret = CMD_UNDEFINED;
				goto error;
			}

			/* kernel loglevels not implemented */
			ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
		} else if (opt_userspace) {		/* User-space tracer action */
#if 0
			if (opt_cmd_name != NULL || opt_pid) {
				MSG("Only supporting tracing all UST processes (-u) for now.");
				ret = CMD_UNDEFINED;
				goto error;
			}
#endif

			DBG("Enabling UST event %s for channel %s, loglevel %s", event_name,
					channel_name, opt_loglevel ? : "<all>");

			switch (opt_event_type) {
			case LTTNG_EVENT_ALL:	/* Default behavior is tracepoint */
				/* Fall-through */
			case LTTNG_EVENT_TRACEPOINT:
				/* Copy name and type of the event */
				ev.type = LTTNG_EVENT_TRACEPOINT;
				strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
				ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
				break;
			case LTTNG_EVENT_PROBE:
			case LTTNG_EVENT_FUNCTION:
			case LTTNG_EVENT_FUNCTION_ENTRY:
			case LTTNG_EVENT_SYSCALL:
			default:
				ERR("Event type not available for user-space tracing");
				ret = CMD_UNDEFINED;
				goto error;
			}

			ev.loglevel_type = opt_loglevel_type;
			if (opt_loglevel) {
				ev.loglevel = loglevel_str_to_value(opt_loglevel);
				if (ev.loglevel == -1) {
					ERR("Unknown loglevel %s", opt_loglevel);
					ret = -1;
					goto error;
				}
			} else {
				ev.loglevel = -1;
			}
		} else {
			ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
			ret = CMD_ERROR;
			goto error;
		}

		ret = lttng_enable_event(handle, &ev, channel_name);
		if (ret < 0) {
			ERR("Event %s: %s (channel %s, session %s)", event_name,
					lttng_strerror(ret), channel_name, session_name);
			warn = 1;
		} else {
			MSG("%s event %s created in channel %s",
					opt_kernel ? "kernel": "UST", event_name, channel_name);
		}

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

end:
error:
	if (warn) {
		ret = CMD_WARNING;
	}
	if (opt_channel_name == NULL) {
		free(channel_name);
	}
	lttng_destroy_handle(handle);

	return ret;
}

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

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

	/* Default event type */
	opt_event_type = LTTNG_EVENT_ALL;

	while ((opt = poptGetNextOpt(pc)) != -1) {
		switch (opt) {
		case OPT_HELP:
			usage(stdout);
			goto end;
		case OPT_TRACEPOINT:
			opt_event_type = LTTNG_EVENT_TRACEPOINT;
			break;
		case OPT_PROBE:
			opt_event_type = LTTNG_EVENT_PROBE;
			break;
		case OPT_FUNCTION:
			opt_event_type = LTTNG_EVENT_FUNCTION;
			break;
		case OPT_FUNCTION_ENTRY:
			opt_event_type = LTTNG_EVENT_FUNCTION_ENTRY;
			break;
		case OPT_SYSCALL:
			opt_event_type = LTTNG_EVENT_SYSCALL;
			break;
		case OPT_USERSPACE:
			opt_userspace = 1;
			break;
		case OPT_LOGLEVEL:
			opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_RANGE;
			opt_loglevel = poptGetOptArg(pc);
			break;
		case OPT_LOGLEVEL_ONLY:
			opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_SINGLE;
			opt_loglevel = poptGetOptArg(pc);
			break;
		case OPT_LIST_OPTIONS:
			list_cmd_options(stdout, long_options);
			goto end;
		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_ERROR;
		goto end;
	}

	if (!opt_session_name) {
		session_name = get_session_name();
		if (session_name == NULL) {
			ret = CMD_ERROR;
			goto end;
		}
	} else {
		session_name = opt_session_name;
	}

	ret = enable_events(session_name);

end:
	if (opt_session_name == NULL) {
		free(session_name);
	}

	poptFreeContext(pc);
	return ret;
}
Commit	Line	Data
	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
	6	* as published by the Free Software Foundation; only version 2
	7	* of the License.
	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>
	27	#include <inttypes.h>
	28	#include <ctype.h>
	29
	30	#include "../command.h"
	31
	32	static char *opt_event_list;
	33	static int opt_event_type;
	34	static const char *opt_loglevel;
	35	static int opt_loglevel_type;
	36	static int opt_kernel;
	37	static char *opt_session_name;
	38	static int opt_userspace;
	39	static int opt_enable_all;
	40	static char *opt_probe;
	41	static char *opt_function;
	42	static char *opt_function_entry_symbol;
	43	static char *opt_channel_name;
	44	#if 0
	45	/* Not implemented yet */
	46	static char *opt_cmd_name;
	47	static pid_t opt_pid;
	48	#endif
	49
	50	enum {
	51	OPT_HELP = 1,
	52	OPT_TRACEPOINT,
	53	OPT_PROBE,
	54	OPT_FUNCTION,
	55	OPT_FUNCTION_ENTRY,
	56	OPT_SYSCALL,
	57	OPT_USERSPACE,
	58	OPT_LOGLEVEL,
	59	OPT_LOGLEVEL_ONLY,
	60	OPT_LIST_OPTIONS,
	61	};
	62
	63	static struct lttng_handle *handle;
	64
	65	static struct poptOption long_options[] = {
	66	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
	67	{"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
	68	{"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
	69	{"all", 'a', POPT_ARG_VAL, &opt_enable_all, 1, 0, 0},
	70	{"channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
	71	{"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
	72	#if 0
	73	/* Not implemented yet */
	74	{"userspace", 'u', POPT_ARG_STRING \| POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
	75	{"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
	76	#else
	77	{"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
	78	#endif
	79	{"tracepoint", 0, POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
	80	{"probe", 0, POPT_ARG_STRING, &opt_probe, OPT_PROBE, 0, 0},
	81	{"function", 0, POPT_ARG_STRING, &opt_function, OPT_FUNCTION, 0, 0},
	82	#if 0
	83	/*
	84	* Currently removed from lttng kernel tracer. Removed from
	85	* lttng UI to discourage its use.
	86	*/
	87	{"function:entry", 0, POPT_ARG_STRING, &opt_function_entry_symbol, OPT_FUNCTION_ENTRY, 0, 0},
	88	#endif
	89	{"syscall", 0, POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
	90	{"loglevel", 0, POPT_ARG_STRING, 0, OPT_LOGLEVEL, 0, 0},
	91	{"loglevel-only", 0, POPT_ARG_STRING, 0, OPT_LOGLEVEL_ONLY, 0, 0},
	92	{"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
	93	{0, 0, 0, 0, 0, 0, 0}
	94	};
	95
	96	/*
	97	* usage
	98	*/
	99	static void usage(FILE *ofp)
	100	{
	101	fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
	102	fprintf(ofp, "\n");
	103	fprintf(ofp, " -h, --help Show this help\n");
	104	fprintf(ofp, " --list-options Simple listing of options\n");
	105	fprintf(ofp, " -s, --session Apply to session name\n");
	106	fprintf(ofp, " -c, --channel Apply to this channel\n");
	107	fprintf(ofp, " -a, --all Enable all tracepoints\n");
	108	fprintf(ofp, " -k, --kernel Apply for the kernel tracer\n");
	109	#if 0
	110	fprintf(ofp, " -u, --userspace [CMD] Apply to the user-space tracer\n");
	111	fprintf(ofp, " If no CMD, the domain used is UST global\n");
	112	fprintf(ofp, " or else the domain is UST EXEC_NAME\n");
	113	fprintf(ofp, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n");
	114	#else
	115	fprintf(ofp, " -u, --userspace Apply to the user-space tracer\n");
	116	#endif
	117	fprintf(ofp, "\n");
	118	fprintf(ofp, "Event options:\n");
	119	fprintf(ofp, " --tracepoint Tracepoint event (default)\n");
	120	fprintf(ofp, " - userspace tracer supports wildcards at end of string.\n");
	121	fprintf(ofp, " Don't forget to quote to deal with bash expansion.\n");
	122	fprintf(ofp, " e.g.:\n");
	123	fprintf(ofp, " \"*\"\n");
	124	fprintf(ofp, " \"app_component:na*\"\n");
	125	fprintf(ofp, " --probe [addr \| symbol \| symbol+offset]\n");
	126	fprintf(ofp, " Dynamic probe.\n");
	127	fprintf(ofp, " Addr and offset can be octal (0NNN...),\n");
	128	fprintf(ofp, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
	129	fprintf(ofp, " --function [addr \| symbol \| symbol+offset]\n");
	130	fprintf(ofp, " Dynamic function entry/return probe.\n");
	131	fprintf(ofp, " Addr and offset can be octal (0NNN...),\n");
	132	fprintf(ofp, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
	133	#if 0
	134	fprintf(ofp, " --function:entry symbol\n");
	135	fprintf(ofp, " Function tracer event\n");
	136	#endif
	137	fprintf(ofp, " --syscall System call event\n");
	138	fprintf(ofp, "\n");
	139	fprintf(ofp, " --loglevel name\n");
	140	fprintf(ofp, " Tracepoint loglevel range from 0 to loglevel\n");
	141	fprintf(ofp, " --loglevel-only name\n");
	142	fprintf(ofp, " Tracepoint loglevel (only this loglevel)\n");
	143	fprintf(ofp, "\n");
	144	fprintf(ofp, " The loglevel or loglevel-only options should be\n");
	145	fprintf(ofp, " combined with a tracepoint name or tracepoint\n");
	146	fprintf(ofp, " wildcard.\n");
	147	fprintf(ofp, " Available loglevels:\n");
	148	fprintf(ofp, " (higher value is more verbose)\n");
	149	fprintf(ofp, " TRACE_EMERG = 0\n");
	150	fprintf(ofp, " TRACE_ALERT = 1\n");
	151	fprintf(ofp, " TRACE_CRIT = 2\n");
	152	fprintf(ofp, " TRACE_ERR = 3\n");
	153	fprintf(ofp, " TRACE_WARNING = 4\n");
	154	fprintf(ofp, " TRACE_NOTICE = 5\n");
	155	fprintf(ofp, " TRACE_INFO = 6\n");
	156	fprintf(ofp, " TRACE_SYSTEM = 7\n");
	157	fprintf(ofp, " TRACE_PROGRAM = 8\n");
	158	fprintf(ofp, " TRACE_PROCESS = 9\n");
	159	fprintf(ofp, " TRACE_MODULE = 10\n");
	160	fprintf(ofp, " TRACE_UNIT = 11\n");
	161	fprintf(ofp, " TRACE_FUNCTION = 12\n");
	162	fprintf(ofp, " TRACE_DEFAULT = 13\n");
	163	fprintf(ofp, " TRACE_VERBOSE = 14\n");
	164	fprintf(ofp, " TRACE_DEBUG = 15\n");
	165	fprintf(ofp, "\n");
	166	}
	167
	168	/*
	169	* Parse probe options.
	170	*/
	171	static int parse_probe_opts(struct lttng_event ev, char opt)
	172	{
	173	int ret;
	174	char s_hex[19];
	175	char name[LTTNG_SYMBOL_NAME_LEN];
	176
	177	if (opt == NULL) {
	178	ret = -1;
	179	goto end;
	180	}
	181
	182	/* Check for symbol+offset */
	183	ret = sscanf(opt, "%[^'+']+%s", name, s_hex);
	184	if (ret == 2) {
	185	strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
	186	ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
	187	DBG("probe symbol %s", ev->attr.probe.symbol_name);
	188	if (strlen(s_hex) == 0) {
	189	ERR("Invalid probe offset %s", s_hex);
	190	ret = -1;
	191	goto end;
	192	}
	193	ev->attr.probe.offset = strtoul(s_hex, NULL, 0);
	194	DBG("probe offset %" PRIu64, ev->attr.probe.offset);
	195	ev->attr.probe.addr = 0;
	196	goto end;
	197	}
	198
	199	/* Check for symbol */
	200	if (isalpha(name[0])) {
	201	ret = sscanf(opt, "%s", name);
	202	if (ret == 1) {
	203	strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
	204	ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
	205	DBG("probe symbol %s", ev->attr.probe.symbol_name);
	206	ev->attr.probe.offset = 0;
	207	DBG("probe offset %" PRIu64, ev->attr.probe.offset);
	208	ev->attr.probe.addr = 0;
	209	goto end;
	210	}
	211	}
	212
	213	/* Check for address */
	214	ret = sscanf(opt, "%s", s_hex);
	215	if (ret > 0) {
	216	if (strlen(s_hex) == 0) {
	217	ERR("Invalid probe address %s", s_hex);
	218	ret = -1;
	219	goto end;
	220	}
	221	ev->attr.probe.addr = strtoul(s_hex, NULL, 0);
	222	DBG("probe addr %" PRIu64, ev->attr.probe.addr);
	223	ev->attr.probe.offset = 0;
	224	memset(ev->attr.probe.symbol_name, 0, LTTNG_SYMBOL_NAME_LEN);
	225	goto end;
	226	}
	227
	228	/* No match */
	229	ret = -1;
	230
	231	end:
	232	return ret;
	233	}
	234
	235	/*
	236	* Maps loglevel from string to value
	237	*/
	238	static
	239	int loglevel_str_to_value(const char *str)
	240	{
	241	if (!strcmp(str, "TRACE_EMERG")) {
	242	return 0;
	243	} else if (!strcmp(str, "TRACE_ALERT")) {
	244	return 1;
	245	} else if (!strcmp(str, "TRACE_CRIT")) {
	246	return 2;
	247	} else if (!strcmp(str, "TRACE_ERR")) {
	248	return 3;
	249	} else if (!strcmp(str, "TRACE_WARNING")) {
	250	return 4;
	251	} else if (!strcmp(str, "TRACE_NOTICE")) {
	252	return 5;
	253	} else if (!strcmp(str, "TRACE_INFO")) {
	254	return 6;
	255	} else if (!strcmp(str, "TRACE_SYSTEM")) {
	256	return 7;
	257	} else if (!strcmp(str, "TRACE_PROGRAM")) {
	258	return 8;
	259	} else if (!strcmp(str, "TRACE_PROCESS")) {
	260	return 9;
	261	} else if (!strcmp(str, "TRACE_MODULE")) {
	262	return 10;
	263	} else if (!strcmp(str, "TRACE_UNIT")) {
	264	return 11;
	265	} else if (!strcmp(str, "TRACE_FUNCTION")) {
	266	return 12;
	267	} else if (!strcmp(str, "TRACE_DEFAULT")) {
	268	return 13;
	269	} else if (!strcmp(str, "TRACE_VERBOSE")) {
	270	return 14;
	271	} else if (!strcmp(str, "TRACE_DEBUG")) {
	272	return 15;
	273	} else {
	274	return -1;
	275	}
	276	}
	277
	278	/*
	279	* Enabling event using the lttng API.
	280	*/
	281	static int enable_events(char *session_name)
	282	{
	283	int err, ret = CMD_SUCCESS, warn = 0;
	284	char event_name, channel_name = NULL;
	285	struct lttng_event ev;
	286	struct lttng_domain dom;
	287
	288	memset(&ev, 0, sizeof(ev));
	289	memset(&dom, 0, sizeof(dom));
	290
	291	/* Create lttng domain */
	292	if (opt_kernel) {
	293	dom.type = LTTNG_DOMAIN_KERNEL;
	294	} else if (opt_userspace) {
	295	dom.type = LTTNG_DOMAIN_UST;
	296	} else {
	297	ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
	298	ret = CMD_ERROR;
	299	goto error;
	300	}
	301
	302	if (opt_channel_name == NULL) {
	303	err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME);
	304	if (err < 0) {
	305	ret = CMD_FATAL;
	306	goto error;
	307	}
	308	} else {
	309	channel_name = opt_channel_name;
	310	}
	311
	312	handle = lttng_create_handle(session_name, &dom);
	313	if (handle == NULL) {
	314	ret = -1;
	315	goto error;
	316	}
	317
	318	if (opt_enable_all) {
	319	/* Default setup for enable all */
	320	if (opt_kernel) {
	321	ev.type = opt_event_type;
	322	ev.name[0] = '\0';
	323	/* kernel loglevels not implemented */
	324	ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
	325	} else {
	326	ev.type = LTTNG_EVENT_TRACEPOINT;
	327	strcpy(ev.name, "*");
	328	ev.loglevel_type = opt_loglevel_type;
	329	if (opt_loglevel) {
	330	ev.loglevel = loglevel_str_to_value(opt_loglevel);
	331	if (ev.loglevel == -1) {
	332	ERR("Unknown loglevel %s", opt_loglevel);
	333	ret = -1;
	334	goto error;
	335	}
	336	} else {
	337	ev.loglevel = -1;
	338	}
	339	}
	340
	341	ret = lttng_enable_event(handle, &ev, channel_name);
	342	if (ret < 0) {
	343	goto error;
	344	}
	345
	346	switch (opt_event_type) {
	347	case LTTNG_EVENT_TRACEPOINT:
	348	MSG("All %s tracepoints are enabled in channel %s for loglevel %s",
	349	opt_kernel ? "kernel" : "UST", channel_name,
	350	opt_loglevel ? : "<all>");
	351	break;
	352	case LTTNG_EVENT_SYSCALL:
	353	if (opt_kernel) {
	354	MSG("All kernel system calls are enabled in channel %s",
	355	channel_name);
	356	}
	357	break;
	358	case LTTNG_EVENT_ALL:
	359	MSG("All %s events are enabled in channel %s for loglevel %s",
	360	opt_kernel ? "kernel" : "UST", channel_name,
	361	opt_loglevel ? : "<all>");
	362	break;
	363	default:
	364	/*
	365	* We should not be here since lttng_enable_event should have
	366	* failed on the event type.
	367	*/
	368	goto error;
	369	}
	370	goto end;
	371	}
	372
	373	/* Strip event list */
	374	event_name = strtok(opt_event_list, ",");
	375	while (event_name != NULL) {
	376	/* Copy name and type of the event */
	377	strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
	378	ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
	379	ev.type = opt_event_type;
	380
	381	/* Kernel tracer action */
	382	if (opt_kernel) {
	383	DBG("Enabling kernel event %s for channel %s",
	384	event_name, channel_name);
	385
	386	switch (opt_event_type) {
	387	case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
	388	ev.type = LTTNG_EVENT_TRACEPOINT;
	389	/* Fall-through */
	390	case LTTNG_EVENT_TRACEPOINT:
	391	break;
	392	case LTTNG_EVENT_PROBE:
	393	ret = parse_probe_opts(&ev, opt_probe);
	394	if (ret < 0) {
	395	ERR("Unable to parse probe options");
	396	ret = 0;
	397	goto error;
	398	}
	399	break;
	400	case LTTNG_EVENT_FUNCTION:
	401	ret = parse_probe_opts(&ev, opt_function);
	402	if (ret < 0) {
	403	ERR("Unable to parse function probe options");
	404	ret = 0;
	405	goto error;
	406	}
	407	break;
	408	case LTTNG_EVENT_FUNCTION_ENTRY:
	409	strncpy(ev.attr.ftrace.symbol_name, opt_function_entry_symbol,
	410	LTTNG_SYMBOL_NAME_LEN);
	411	ev.attr.ftrace.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
	412	break;
	413	case LTTNG_EVENT_SYSCALL:
	414	MSG("per-syscall selection not supported yet. Use \"-a\" "
	415	"for all syscalls.");
	416	default:
	417	ret = CMD_UNDEFINED;
	418	goto error;
	419	}
	420
	421	if (opt_loglevel) {
	422	MSG("Kernel loglevels are not supported.");
	423	ret = CMD_UNDEFINED;
	424	goto error;
	425	}
	426
	427	/* kernel loglevels not implemented */
	428	ev.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
	429	} else if (opt_userspace) { /* User-space tracer action */
	430	#if 0
	431	if (opt_cmd_name != NULL \|\| opt_pid) {
	432	MSG("Only supporting tracing all UST processes (-u) for now.");
	433	ret = CMD_UNDEFINED;
	434	goto error;
	435	}
	436	#endif
	437
	438	DBG("Enabling UST event %s for channel %s, loglevel %s", event_name,
	439	channel_name, opt_loglevel ? : "<all>");
	440
	441	switch (opt_event_type) {
	442	case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
	443	/* Fall-through */
	444	case LTTNG_EVENT_TRACEPOINT:
	445	/* Copy name and type of the event */
	446	ev.type = LTTNG_EVENT_TRACEPOINT;
	447	strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
	448	ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
	449	break;
	450	case LTTNG_EVENT_PROBE:
	451	case LTTNG_EVENT_FUNCTION:
	452	case LTTNG_EVENT_FUNCTION_ENTRY:
	453	case LTTNG_EVENT_SYSCALL:
	454	default:
	455	ERR("Event type not available for user-space tracing");
	456	ret = CMD_UNDEFINED;
	457	goto error;
	458	}
	459
	460	ev.loglevel_type = opt_loglevel_type;
	461	if (opt_loglevel) {
	462	ev.loglevel = loglevel_str_to_value(opt_loglevel);
	463	if (ev.loglevel == -1) {
	464	ERR("Unknown loglevel %s", opt_loglevel);
	465	ret = -1;
	466	goto error;
	467	}
	468	} else {
	469	ev.loglevel = -1;
	470	}
	471	} else {
	472	ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
	473	ret = CMD_ERROR;
	474	goto error;
	475	}
	476
	477	ret = lttng_enable_event(handle, &ev, channel_name);
	478	if (ret < 0) {
	479	ERR("Event %s: %s (channel %s, session %s)", event_name,
	480	lttng_strerror(ret), channel_name, session_name);
	481	warn = 1;
	482	} else {
	483	MSG("%s event %s created in channel %s",
	484	opt_kernel ? "kernel": "UST", event_name, channel_name);
	485	}
	486
	487	/* Next event */
	488	event_name = strtok(NULL, ",");
	489	}
	490
	491	end:
	492	error:
	493	if (warn) {
	494	ret = CMD_WARNING;
	495	}
	496	if (opt_channel_name == NULL) {
	497	free(channel_name);
	498	}
	499	lttng_destroy_handle(handle);
	500
	501	return ret;
	502	}
	503
	504	/*
	505	* Add event to trace session
	506	*/
	507	int cmd_enable_events(int argc, const char **argv)
	508	{
	509	int opt, ret = CMD_SUCCESS;
	510	static poptContext pc;
	511	char *session_name = NULL;
	512
	513	pc = poptGetContext(NULL, argc, argv, long_options, 0);
	514	poptReadDefaultConfig(pc, 0);
	515
	516	/* Default event type */
	517	opt_event_type = LTTNG_EVENT_ALL;
	518
	519	while ((opt = poptGetNextOpt(pc)) != -1) {
	520	switch (opt) {
	521	case OPT_HELP:
	522	usage(stdout);
	523	goto end;
	524	case OPT_TRACEPOINT:
	525	opt_event_type = LTTNG_EVENT_TRACEPOINT;
	526	break;
	527	case OPT_PROBE:
	528	opt_event_type = LTTNG_EVENT_PROBE;
	529	break;
	530	case OPT_FUNCTION:
	531	opt_event_type = LTTNG_EVENT_FUNCTION;
	532	break;
	533	case OPT_FUNCTION_ENTRY:
	534	opt_event_type = LTTNG_EVENT_FUNCTION_ENTRY;
	535	break;
	536	case OPT_SYSCALL:
	537	opt_event_type = LTTNG_EVENT_SYSCALL;
	538	break;
	539	case OPT_USERSPACE:
	540	opt_userspace = 1;
	541	break;
	542	case OPT_LOGLEVEL:
	543	opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_RANGE;
	544	opt_loglevel = poptGetOptArg(pc);
	545	break;
	546	case OPT_LOGLEVEL_ONLY:
	547	opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_SINGLE;
	548	opt_loglevel = poptGetOptArg(pc);
	549	break;
	550	case OPT_LIST_OPTIONS:
	551	list_cmd_options(stdout, long_options);
	552	goto end;
	553	default:
	554	usage(stderr);
	555	ret = CMD_UNDEFINED;
	556	goto end;
	557	}
	558	}
	559
	560	opt_event_list = (char*) poptGetArg(pc);
	561	if (opt_event_list == NULL && opt_enable_all == 0) {
	562	ERR("Missing event name(s).\n");
	563	usage(stderr);
	564	ret = CMD_ERROR;
	565	goto end;
	566	}
	567
	568	if (!opt_session_name) {
	569	session_name = get_session_name();
	570	if (session_name == NULL) {
	571	ret = CMD_ERROR;
	572	goto end;
	573	}
	574	} else {
	575	session_name = opt_session_name;
	576	}
	577
	578	ret = enable_events(session_name);
	579
	580	end:
	581	if (opt_session_name == NULL) {
	582	free(session_name);
	583	}
	584
	585	poptFreeContext(pc);
	586	return ret;
	587	}