/*
* 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 free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 2 only,
+ * as published by the Free Software Foundation.
*
* 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.
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#define _GNU_SOURCE
#include <ctype.h>
#include "../command.h"
+#include <src/common/sessiond-comm/sessiond-comm.h>
static char *opt_event_list;
static int opt_event_type;
static char *opt_function;
static char *opt_function_entry_symbol;
static char *opt_channel_name;
+static char *opt_filter;
#if 0
/* Not implemented yet */
static char *opt_cmd_name;
OPT_LOGLEVEL,
OPT_LOGLEVEL_ONLY,
OPT_LIST_OPTIONS,
+ OPT_FILTER,
};
static struct lttng_handle *handle;
{"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},
{"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},
+ {"filter", 'f', POPT_ARG_STRING, &opt_filter, OPT_FILTER, 0, 0},
{0, 0, 0, 0, 0, 0, 0}
};
*/
static void usage(FILE *ofp)
{
- fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\n");
+ fprintf(ofp, "usage: lttng enable-event NAME[,NAME2,...] [-k|-u] [OPTIONS] \n");
fprintf(ofp, "\n");
+ fprintf(ofp, "Options:\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, " -s, --session NAME Apply to session name\n");
+ fprintf(ofp, " -c, --channel NAME Apply to this channel\n");
+ fprintf(ofp, " -a, --all Enable all tracepoints and syscalls\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, " e.g.:\n");
fprintf(ofp, " \"*\"\n");
fprintf(ofp, " \"app_component:na*\"\n");
- fprintf(ofp, " --loglevel name\n");
- fprintf(ofp, " Tracepoint loglevel (range: 0 to loglevel)\n");
- fprintf(ofp, " --loglevel-only name\n");
- fprintf(ofp, " Tracepoint loglevel (only this loglevel)\n");
fprintf(ofp, " --probe [addr | symbol | symbol+offset]\n");
fprintf(ofp, " Dynamic probe.\n");
fprintf(ofp, " Addr and offset can be octal (0NNN...),\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_DEBUG_SYSTEM = 7\n");
+ fprintf(ofp, " TRACE_DEBUG_PROGRAM = 8\n");
+ fprintf(ofp, " TRACE_DEBUG_PROCESS = 9\n");
+ fprintf(ofp, " TRACE_DEBUG_MODULE = 10\n");
+ fprintf(ofp, " TRACE_DEBUG_UNIT = 11\n");
+ fprintf(ofp, " TRACE_DEBUG_FUNCTION = 12\n");
+ fprintf(ofp, " TRACE_DEBUG_LINE = 13\n");
+ fprintf(ofp, " TRACE_DEBUG = 14\n");
+ fprintf(ofp, " (shortcuts such as \"system\" are allowed)\n");
+ fprintf(ofp, " --filter \'expression\'\n");
+ fprintf(ofp, " Filter expression on event fields and context.\n");
+ fprintf(ofp, " Event recording depends on evaluation.\n");
+ fprintf(ofp, " Only specify on first activation of\n");
+ fprintf(ofp, " a given event within a session.\n");
+ fprintf(ofp, " Filter only allowed when enabling\n");
+ fprintf(ofp, " events within a session before tracing\n");
+ fprintf(ofp, " is started. If the filter fails to link\n");
+ fprintf(ofp, " with the event within the traced domain,\n");
+ fprintf(ofp, " the event will be discarded. Currently,\n");
+ fprintf(ofp, " filter is only implemented for the user-space\n");
+ fprintf(ofp, " tracer.\n");
+ fprintf(ofp, " Expression examples:.\n");
+ fprintf(ofp, " \n");
+ fprintf(ofp, " 'intfield > 500 && intfield < 503'\n");
+ fprintf(ofp, " '(stringfield == \"test\" || intfield != 10) && intfield > 33'\n");
+ fprintf(ofp, " 'doublefield > 1.1 && intfield < 5.3'\n");
+ fprintf(ofp, " \n");
+ fprintf(ofp, " Wildcards are allowed at the end of strings:\n");
+ fprintf(ofp, " 'seqfield1 == \"te*\"'\n");
+ fprintf(ofp, " In string literals, the escape character is '\\'.\n");
+ fprintf(ofp, " Use '\\*' for the '*' character, and '\\\\' for\n");
+ fprintf(ofp, " the '\\' character. Wildcard match any sequence of,\n");
+ fprintf(ofp, " characters including an empty sub-string (match 0 or\n");
+ fprintf(ofp, " more characters).\n");
+ fprintf(ofp, "\n");
+ fprintf(ofp, " Context information can be used for filtering. The\n");
+ fprintf(ofp, " examples below show usage of context filtering on\n");
+ fprintf(ofp, " process name (with a wildcard), process ID range, and\n");
+ fprintf(ofp, " unique thread ID for filtering. The process and\n");
+ fprintf(ofp, " thread ID of running applications can be found under\n");
+ fprintf(ofp, " columns \"PID\" and \"LWP\" of the \"ps -eLf\" command.\n");
+ fprintf(ofp, "\n");
+ fprintf(ofp, " '$ctx.procname == \"demo*\"'\n");
+ fprintf(ofp, " '$ctx.vpid >= 4433 && $ctx.vpid < 4455'\n");
+ fprintf(ofp, " '$ctx.vtid == 1234'\n");
+ fprintf(ofp, "\n");
}
/*
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) {
+ if (*s_hex == '\0') {
ERR("Invalid probe offset %s", s_hex);
ret = -1;
goto end;
/* Check for address */
ret = sscanf(opt, "%s", s_hex);
if (ret > 0) {
- if (strlen(s_hex) == 0) {
+ if (*s_hex == '\0') {
ERR("Invalid probe address %s", s_hex);
ret = -1;
goto end;
}
/*
- * Maps this from string to value
- *
- * TRACE_EMERG = 0,
- * TRACE_ALERT = 1,
- * TRACE_CRIT = 2,
- * TRACE_ERR = 3,
- * TRACE_WARNING = 4,
- * TRACE_NOTICE = 5,
- * TRACE_INFO = 6,
- * TRACE_SYSTEM = 7,
- * TRACE_PROCESS = 8,
- * TRACE_MODULE = 9,
- * TRACE_UNIT = 10,
- * TRACE_CLASS = 11,
- * TRACE_OBJECT = 12,
- * TRACE_FUNCTION = 13,
- * TRACE_PRINTF = 14,
- * TRACE_DEBUG = 15,
+ * Maps loglevel from string to value
*/
static
-int loglevel_str_to_value(const char *str)
+int loglevel_str_to_value(const char *inputstr)
{
- 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_PROCESS")) {
- return 8;
- } else if (!strcmp(str, "TRACE_MODULE")) {
- return 9;
- } else if (!strcmp(str, "TRACE_UNIT")) {
- return 10;
- } else if (!strcmp(str, "TRACE_CLASS")) {
- return 11;
- } else if (!strcmp(str, "TRACE_OBJECT")) {
- return 12;
- } else if (!strcmp(str, "TRACE_FUNCTION")) {
- return 13;
- } else if (!strcmp(str, "TRACE_PRINTF")) {
- return 14;
- } else if (!strcmp(str, "TRACE_DEBUG")) {
- return 15;
+ int i = 0;
+ char str[LTTNG_SYMBOL_NAME_LEN];
+
+ while (i < LTTNG_SYMBOL_NAME_LEN && inputstr[i] != '\0') {
+ str[i] = toupper(inputstr[i]);
+ i++;
+ }
+ str[i] = '\0';
+ if (!strcmp(str, "TRACE_EMERG") || !strcmp(str, "EMERG")) {
+ return LTTNG_LOGLEVEL_EMERG;
+ } else if (!strcmp(str, "TRACE_ALERT") || !strcmp(str, "ALERT")) {
+ return LTTNG_LOGLEVEL_ALERT;
+ } else if (!strcmp(str, "TRACE_CRIT") || !strcmp(str, "CRIT")) {
+ return LTTNG_LOGLEVEL_CRIT;
+ } else if (!strcmp(str, "TRACE_ERR") || !strcmp(str, "ERR")) {
+ return LTTNG_LOGLEVEL_ERR;
+ } else if (!strcmp(str, "TRACE_WARNING") || !strcmp(str, "WARNING")) {
+ return LTTNG_LOGLEVEL_WARNING;
+ } else if (!strcmp(str, "TRACE_NOTICE") || !strcmp(str, "NOTICE")) {
+ return LTTNG_LOGLEVEL_NOTICE;
+ } else if (!strcmp(str, "TRACE_INFO") || !strcmp(str, "INFO")) {
+ return LTTNG_LOGLEVEL_INFO;
+ } else if (!strcmp(str, "TRACE_DEBUG_SYSTEM") || !strcmp(str, "DEBUG_SYSTEM") || !strcmp(str, "SYSTEM")) {
+ return LTTNG_LOGLEVEL_DEBUG_SYSTEM;
+ } else if (!strcmp(str, "TRACE_DEBUG_PROGRAM") || !strcmp(str, "DEBUG_PROGRAM") || !strcmp(str, "PROGRAM")) {
+ return LTTNG_LOGLEVEL_DEBUG_PROGRAM;
+ } else if (!strcmp(str, "TRACE_DEBUG_PROCESS") || !strcmp(str, "DEBUG_PROCESS") || !strcmp(str, "PROCESS")) {
+ return LTTNG_LOGLEVEL_DEBUG_PROCESS;
+ } else if (!strcmp(str, "TRACE_DEBUG_MODULE") || !strcmp(str, "DEBUG_MODULE") || !strcmp(str, "MODULE")) {
+ return LTTNG_LOGLEVEL_DEBUG_MODULE;
+ } else if (!strcmp(str, "TRACE_DEBUG_UNIT") || !strcmp(str, "DEBUG_UNIT") || !strcmp(str, "UNIT")) {
+ return LTTNG_LOGLEVEL_DEBUG_UNIT;
+ } else if (!strcmp(str, "TRACE_DEBUG_FUNCTION") || !strcmp(str, "DEBUG_FUNCTION") || !strcmp(str, "FUNCTION")) {
+ return LTTNG_LOGLEVEL_DEBUG_FUNCTION;
+ } else if (!strcmp(str, "TRACE_DEBUG_LINE") || !strcmp(str, "DEBUG_LINE") || !strcmp(str, "LINE")) {
+ return LTTNG_LOGLEVEL_DEBUG_LINE;
+ } else if (!strcmp(str, "TRACE_DEBUG") || !strcmp(str, "DEBUG")) {
+ return LTTNG_LOGLEVEL_DEBUG;
} else {
return -1;
}
struct lttng_event ev;
struct lttng_domain dom;
+ memset(&ev, 0, sizeof(ev));
+ memset(&dom, 0, sizeof(dom));
+
+ if (opt_kernel) {
+ if (opt_filter) {
+ ERR("Filter not implement for kernel tracing yet");
+ ret = CMD_ERROR;
+ goto error;
+ }
+ }
+
/* Create lttng domain */
if (opt_kernel) {
dom.type = LTTNG_DOMAIN_KERNEL;
+ dom.buf_type = LTTNG_BUFFER_GLOBAL;
} else if (opt_userspace) {
dom.type = LTTNG_DOMAIN_UST;
+ /* Default. */
+ dom.buf_type = LTTNG_BUFFER_PER_PID;
} else {
ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
ret = CMD_ERROR;
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 = -LTTNG_ERR_INVALID;
+ goto error;
+ }
+ } else {
+ ev.loglevel = -1;
+ }
}
- ret = lttng_enable_event(handle, &ev, channel_name);
- if (ret < 0) {
- goto error;
- }
+ if (!opt_filter) {
+ ret = lttng_enable_event(handle, &ev, channel_name);
+ if (ret < 0) {
+ switch (-ret) {
+ case LTTNG_ERR_KERN_EVENT_EXIST:
+ WARN("Kernel events already enabled (channel %s, session %s)",
+ channel_name, session_name);
+ break;
+ default:
+ ERR("Events: %s (channel %s, session %s)",
+ lttng_strerror(ret), channel_name, session_name);
+ break;
+ }
+ goto end;
+ }
- switch (opt_event_type) {
- case LTTNG_EVENT_TRACEPOINT:
- MSG("All %s tracepoints are enabled in channel %s",
- opt_kernel ? "kernel" : "UST", channel_name);
- break;
- case LTTNG_EVENT_SYSCALL:
- if (opt_kernel) {
- MSG("All kernel system calls are enabled in channel %s",
- channel_name);
+ switch (opt_event_type) {
+ case LTTNG_EVENT_TRACEPOINT:
+ if (opt_loglevel) {
+ MSG("All %s tracepoints are enabled in channel %s for loglevel %s",
+ opt_kernel ? "kernel" : "UST", channel_name,
+ opt_loglevel);
+ } else {
+ MSG("All %s tracepoints are enabled in channel %s",
+ opt_kernel ? "kernel" : "UST", channel_name);
+
+ }
+ 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:
+ if (opt_loglevel) {
+ MSG("All %s events are enabled in channel %s for loglevel %s",
+ opt_kernel ? "kernel" : "UST", channel_name,
+ opt_loglevel);
+ } else {
+ MSG("All %s events are enabled in channel %s",
+ opt_kernel ? "kernel" : "UST", channel_name);
+ }
+ break;
+ default:
+ /*
+ * We should not be here since lttng_enable_event should have
+ * failed on the event type.
+ */
+ goto error;
+ }
+ }
+ if (opt_filter) {
+ ret = lttng_enable_event_with_filter(handle, &ev, channel_name,
+ opt_filter);
+ if (ret < 0) {
+ fprintf(stderr, "Ret filter: %d\n", ret);
+ switch (-ret) {
+ case LTTNG_ERR_FILTER_EXIST:
+ WARN("Filter on events is already enabled"
+ " (channel %s, session %s)",
+ channel_name, session_name);
+ break;
+ case LTTNG_ERR_FILTER_INVAL:
+ case LTTNG_ERR_FILTER_NOMEM:
+ ERR("%s", lttng_strerror(ret));
+ default:
+ ERR("Setting filter: '%s'", opt_filter);
+ break;
+ }
+ goto error;
+ } else {
+ MSG("Filter '%s' successfully set", opt_filter);
}
- break;
- case LTTNG_EVENT_ALL:
- MSG("All %s events are enabled in channel %s",
- opt_kernel ? "kernel" : "UST", channel_name);
- break;
- default:
- /*
- * We should not be here since lttng_enable_event should have
- * failed on the event type.
- */
- goto error;
}
goto end;
}
if (opt_loglevel) {
MSG("Kernel loglevels are not supported.");
- ret = CMD_UNDEFINED;
+ ret = CMD_UNSUPPORTED;
goto error;
}
}
#endif
- DBG("Enabling UST event %s for channel %s", event_name,
- channel_name);
+ 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 */
case LTTNG_EVENT_SYSCALL:
default:
ERR("Event type not available for user-space tracing");
- ret = CMD_UNDEFINED;
+ ret = CMD_UNSUPPORTED;
goto error;
}
ev.loglevel = loglevel_str_to_value(opt_loglevel);
if (ev.loglevel == -1) {
ERR("Unknown loglevel %s", opt_loglevel);
+ ret = -LTTNG_ERR_INVALID;
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);
+ if (!opt_filter) {
+ ret = lttng_enable_event(handle, &ev, channel_name);
+ if (ret < 0) {
+ /* Turn ret to positive value to handle the positive error code */
+ switch (-ret) {
+ case LTTNG_ERR_KERN_EVENT_EXIST:
+ WARN("Kernel event %s already enabled (channel %s, session %s)",
+ event_name, channel_name, session_name);
+ break;
+ default:
+ ERR("Event %s: %s (channel %s, session %s)", event_name,
+ lttng_strerror(ret), channel_name, session_name);
+ break;
+ }
+ warn = 1;
+ } else {
+ MSG("%s event %s created in channel %s",
+ opt_kernel ? "kernel": "UST", event_name, channel_name);
+ }
+ }
+
+ if (opt_filter) {
+ ret = lttng_enable_event_with_filter(handle, &ev, channel_name,
+ opt_filter);
+ if (ret < 0) {
+ switch (-ret) {
+ case LTTNG_ERR_FILTER_EXIST:
+ WARN("Filter on event %s is already enabled"
+ " (channel %s, session %s)",
+ event_name, channel_name, session_name);
+ break;
+ case LTTNG_ERR_FILTER_INVAL:
+ case LTTNG_ERR_FILTER_NOMEM:
+ ERR("%s", lttng_strerror(ret));
+ default:
+ ERR("Setting filter for event %s: '%s'", ev.name,
+ opt_filter);
+ break;
+ }
+ goto error;
+ } else {
+ MSG("Filter '%s' successfully set", opt_filter);
+ }
}
/* Next event */
int opt, ret = CMD_SUCCESS;
static poptContext pc;
char *session_name = NULL;
+ int event_type = -1;
pc = poptGetContext(NULL, argc, argv, long_options, 0);
poptReadDefaultConfig(pc, 0);
case OPT_LIST_OPTIONS:
list_cmd_options(stdout, long_options);
goto end;
+ case OPT_FILTER:
+ break;
default:
usage(stderr);
ret = CMD_UNDEFINED;
goto end;
}
+
+ /* Validate event type. Multiple event type are not supported. */
+ if (event_type == -1) {
+ event_type = opt_event_type;
+ } else {
+ if (event_type != opt_event_type) {
+ ERR("Multiple event type not supported.");
+ ret = CMD_ERROR;
+ goto end;
+ }
+ }
}
opt_event_list = (char*) poptGetArg(pc);