2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
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
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.
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.
25 #include <sys/types.h>
30 #include "../command.h"
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
;
45 /* Not implemented yet */
46 static char *opt_cmd_name
;
63 static struct lttng_handle
*handle
;
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},
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},
77 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
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},
84 * Currently removed from lttng kernel tracer. Removed from
85 * lttng UI to discourage its use.
87 {"function:entry", 0, POPT_ARG_STRING
, &opt_function_entry_symbol
, OPT_FUNCTION_ENTRY
, 0, 0},
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
},
99 static void usage(FILE *ofp
)
101 fprintf(ofp
, "usage: lttng enable-event NAME[,NAME2,...] [options] [event_options]\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");
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");
115 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\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");
134 fprintf(ofp
, " --function:entry symbol\n");
135 fprintf(ofp
, " Function tracer event\n");
137 fprintf(ofp
, " --syscall System call event\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");
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");
169 * Parse probe options.
171 static int parse_probe_opts(struct lttng_event
*ev
, char *opt
)
175 char name
[LTTNG_SYMBOL_NAME_LEN
];
182 /* Check for symbol+offset */
183 ret
= sscanf(opt
, "%[^'+']+%s", name
, s_hex
);
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
);
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;
199 /* Check for symbol */
200 if (isalpha(name
[0])) {
201 ret
= sscanf(opt
, "%s", name
);
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;
213 /* Check for address */
214 ret
= sscanf(opt
, "%s", s_hex
);
216 if (strlen(s_hex
) == 0) {
217 ERR("Invalid probe address %s", s_hex
);
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
);
236 * Maps loglevel from string to value
239 int loglevel_str_to_value(const char *str
)
241 if (!strcmp(str
, "TRACE_EMERG")) {
243 } else if (!strcmp(str
, "TRACE_ALERT")) {
245 } else if (!strcmp(str
, "TRACE_CRIT")) {
247 } else if (!strcmp(str
, "TRACE_ERR")) {
249 } else if (!strcmp(str
, "TRACE_WARNING")) {
251 } else if (!strcmp(str
, "TRACE_NOTICE")) {
253 } else if (!strcmp(str
, "TRACE_INFO")) {
255 } else if (!strcmp(str
, "TRACE_SYSTEM")) {
257 } else if (!strcmp(str
, "TRACE_PROGRAM")) {
259 } else if (!strcmp(str
, "TRACE_PROCESS")) {
261 } else if (!strcmp(str
, "TRACE_MODULE")) {
263 } else if (!strcmp(str
, "TRACE_UNIT")) {
265 } else if (!strcmp(str
, "TRACE_FUNCTION")) {
267 } else if (!strcmp(str
, "TRACE_DEFAULT")) {
269 } else if (!strcmp(str
, "TRACE_VERBOSE")) {
271 } else if (!strcmp(str
, "TRACE_DEBUG")) {
279 * Enabling event using the lttng API.
281 static int enable_events(char *session_name
)
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
;
288 memset(&ev
, 0, sizeof(ev
));
289 memset(&dom
, 0, sizeof(dom
));
291 /* Create lttng domain */
293 dom
.type
= LTTNG_DOMAIN_KERNEL
;
294 } else if (opt_userspace
) {
295 dom
.type
= LTTNG_DOMAIN_UST
;
297 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
302 if (opt_channel_name
== NULL
) {
303 err
= asprintf(&channel_name
, DEFAULT_CHANNEL_NAME
);
309 channel_name
= opt_channel_name
;
312 handle
= lttng_create_handle(session_name
, &dom
);
313 if (handle
== NULL
) {
318 if (opt_enable_all
) {
319 /* Default setup for enable all */
321 ev
.type
= opt_event_type
;
323 /* kernel loglevels not implemented */
324 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
326 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
327 strcpy(ev
.name
, "*");
328 ev
.loglevel_type
= opt_loglevel_type
;
330 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
331 if (ev
.loglevel
== -1) {
332 ERR("Unknown loglevel %s", opt_loglevel
);
341 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
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>");
352 case LTTNG_EVENT_SYSCALL
:
354 MSG("All kernel system calls are enabled in channel %s",
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>");
365 * We should not be here since lttng_enable_event should have
366 * failed on the event type.
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
;
381 /* Kernel tracer action */
383 DBG("Enabling kernel event %s for channel %s",
384 event_name
, channel_name
);
386 switch (opt_event_type
) {
387 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
388 ev
.type
= LTTNG_EVENT_TRACEPOINT
;
390 case LTTNG_EVENT_TRACEPOINT
:
392 case LTTNG_EVENT_PROBE
:
393 ret
= parse_probe_opts(&ev
, opt_probe
);
395 ERR("Unable to parse probe options");
400 case LTTNG_EVENT_FUNCTION
:
401 ret
= parse_probe_opts(&ev
, opt_function
);
403 ERR("Unable to parse function probe options");
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';
413 case LTTNG_EVENT_SYSCALL
:
414 MSG("per-syscall selection not supported yet. Use \"-a\" "
415 "for all syscalls.");
422 MSG("Kernel loglevels are not supported.");
427 /* kernel loglevels not implemented */
428 ev
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
429 } else if (opt_userspace
) { /* User-space tracer action */
431 if (opt_cmd_name
!= NULL
|| opt_pid
) {
432 MSG("Only supporting tracing all UST processes (-u) for now.");
438 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name
,
439 channel_name
, opt_loglevel
? : "<all>");
441 switch (opt_event_type
) {
442 case LTTNG_EVENT_ALL
: /* Default behavior is tracepoint */
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';
450 case LTTNG_EVENT_PROBE
:
451 case LTTNG_EVENT_FUNCTION
:
452 case LTTNG_EVENT_FUNCTION_ENTRY
:
453 case LTTNG_EVENT_SYSCALL
:
455 ERR("Event type not available for user-space tracing");
460 ev
.loglevel_type
= opt_loglevel_type
;
462 ev
.loglevel
= loglevel_str_to_value(opt_loglevel
);
463 if (ev
.loglevel
== -1) {
464 ERR("Unknown loglevel %s", opt_loglevel
);
472 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
477 ret
= lttng_enable_event(handle
, &ev
, channel_name
);
479 ERR("Event %s: %s (channel %s, session %s)", event_name
,
480 lttng_strerror(ret
), channel_name
, session_name
);
483 MSG("%s event %s created in channel %s",
484 opt_kernel
? "kernel": "UST", event_name
, channel_name
);
488 event_name
= strtok(NULL
, ",");
496 if (opt_channel_name
== NULL
) {
499 lttng_destroy_handle(handle
);
505 * Add event to trace session
507 int cmd_enable_events(int argc
, const char **argv
)
509 int opt
, ret
= CMD_SUCCESS
;
510 static poptContext pc
;
511 char *session_name
= NULL
;
513 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
514 poptReadDefaultConfig(pc
, 0);
516 /* Default event type */
517 opt_event_type
= LTTNG_EVENT_ALL
;
519 while ((opt
= poptGetNextOpt(pc
)) != -1) {
525 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
528 opt_event_type
= LTTNG_EVENT_PROBE
;
531 opt_event_type
= LTTNG_EVENT_FUNCTION
;
533 case OPT_FUNCTION_ENTRY
:
534 opt_event_type
= LTTNG_EVENT_FUNCTION_ENTRY
;
537 opt_event_type
= LTTNG_EVENT_SYSCALL
;
543 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
544 opt_loglevel
= poptGetOptArg(pc
);
546 case OPT_LOGLEVEL_ONLY
:
547 opt_loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
548 opt_loglevel
= poptGetOptArg(pc
);
550 case OPT_LIST_OPTIONS
:
551 list_cmd_options(stdout
, long_options
);
560 opt_event_list
= (char*) poptGetArg(pc
);
561 if (opt_event_list
== NULL
&& opt_enable_all
== 0) {
562 ERR("Missing event name(s).\n");
568 if (!opt_session_name
) {
569 session_name
= get_session_name();
570 if (session_name
== NULL
) {
575 session_name
= opt_session_name
;
578 ret
= enable_events(session_name
);
581 if (opt_session_name
== NULL
) {