Update loglevel ABI
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
CommitLineData
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
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>
8f0d098b 28#include <ctype.h>
f3ed775e 29
c399183f 30#include "../command.h"
f3ed775e
DG
31
32static char *opt_event_list;
33static int opt_event_type;
dad47fc4
MD
34static const char *opt_loglevel;
35static int opt_loglevel_type;
6181537c 36static int opt_kernel;
5440dc42 37static char *opt_session_name;
f3ed775e
DG
38static int opt_userspace;
39static int opt_enable_all;
cf0e5467 40static char *opt_probe;
8f0d098b
MD
41static char *opt_function;
42static char *opt_function_entry_symbol;
f3ed775e 43static char *opt_channel_name;
d78d6610
DG
44#if 0
45/* Not implemented yet */
46static char *opt_cmd_name;
47static pid_t opt_pid;
48#endif
f3ed775e
DG
49
50enum {
51 OPT_HELP = 1,
f3ed775e 52 OPT_TRACEPOINT,
cf0e5467 53 OPT_PROBE,
f3ed775e 54 OPT_FUNCTION,
8f0d098b 55 OPT_FUNCTION_ENTRY,
a54bd42d 56 OPT_SYSCALL,
eeac7d46 57 OPT_USERSPACE,
dad47fc4
MD
58 OPT_LOGLEVEL,
59 OPT_LOGLEVEL_ONLY,
679b4943 60 OPT_LIST_OPTIONS,
f3ed775e
DG
61};
62
cd80958d
DG
63static struct lttng_handle *handle;
64
f3ed775e
DG
65static struct poptOption long_options[] = {
66 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
67 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42 68 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
e14f64a8 69 {"all", 'a', POPT_ARG_VAL, &opt_enable_all, 1, 0, 0},
f3ed775e
DG
70 {"channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
71 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610
DG
72#if 0
73 /* Not implemented yet */
40e9d5d3 74 {"userspace", 'u', POPT_ARG_STRING | POPT_ARGFLAG_OPTIONAL, &opt_cmd_name, OPT_USERSPACE, 0, 0},
f3ed775e 75 {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0},
d78d6610
DG
76#else
77 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
78#endif
f3ed775e 79 {"tracepoint", 0, POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
7ebae521 80 {"probe", 0, POPT_ARG_STRING, &opt_probe, OPT_PROBE, 0, 0},
40e9d5d3 81 {"function", 0, POPT_ARG_STRING, &opt_function, OPT_FUNCTION, 0, 0},
b213d387
MD
82#if 0
83 /*
84 * Currently removed from lttng kernel tracer. Removed from
85 * lttng UI to discourage its use.
86 */
40e9d5d3 87 {"function:entry", 0, POPT_ARG_STRING, &opt_function_entry_symbol, OPT_FUNCTION_ENTRY, 0, 0},
b213d387 88#endif
7ebae521 89 {"syscall", 0, POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
dad47fc4
MD
90 {"loglevel", 0, POPT_ARG_STRING, 0, OPT_LOGLEVEL, 0, 0},
91 {"loglevel-only", 0, POPT_ARG_STRING, 0, OPT_LOGLEVEL_ONLY, 0, 0},
679b4943 92 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
f3ed775e
DG
93 {0, 0, 0, 0, 0, 0, 0}
94};
95
96/*
97 * usage
98 */
99static 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");
679b4943 104 fprintf(ofp, " --list-options Simple listing of options\n");
5440dc42 105 fprintf(ofp, " -s, --session Apply on session name\n");
f3ed775e 106 fprintf(ofp, " -c, --channel Apply on this channel\n");
e14f64a8 107 fprintf(ofp, " -a, --all Enable all tracepoints\n");
f3ed775e 108 fprintf(ofp, " -k, --kernel Apply for the kernel tracer\n");
d78d6610 109#if 0
f3ed775e 110 fprintf(ofp, " -u, --userspace [CMD] Apply for the user-space tracer\n");
e14f64a8
DG
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");
d78d6610
DG
114#else
115 fprintf(ofp, " -u, --userspace Apply for the user-space tracer\n");
116#endif
f3ed775e
DG
117 fprintf(ofp, "\n");
118 fprintf(ofp, "Event options:\n");
119 fprintf(ofp, " --tracepoint Tracepoint event (default)\n");
be49af1e
MD
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");
dad47fc4
MD
125 fprintf(ofp, " --loglevel name\n");
126 fprintf(ofp, " Tracepoint loglevel (range: 0 to loglevel)\n");
127 fprintf(ofp, " --loglevel-only name\n");
128 fprintf(ofp, " Tracepoint loglevel (only this loglevel)\n");
8f0d098b 129 fprintf(ofp, " --probe [addr | symbol | symbol+offset]\n");
cf0e5467
MD
130 fprintf(ofp, " Dynamic probe.\n");
131 fprintf(ofp, " Addr and offset can be octal (0NNN...),\n");
132 fprintf(ofp, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
8f0d098b
MD
133 fprintf(ofp, " --function [addr | symbol | symbol+offset]\n");
134 fprintf(ofp, " Dynamic function entry/return probe.\n");
135 fprintf(ofp, " Addr and offset can be octal (0NNN...),\n");
136 fprintf(ofp, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
b213d387 137#if 0
8f0d098b
MD
138 fprintf(ofp, " --function:entry symbol\n");
139 fprintf(ofp, " Function tracer event\n");
b213d387 140#endif
a54bd42d 141 fprintf(ofp, " --syscall System call event\n");
f3ed775e
DG
142 fprintf(ofp, "\n");
143}
144
0d63dd19 145/*
6181537c 146 * Parse probe options.
0d63dd19 147 */
cf0e5467 148static int parse_probe_opts(struct lttng_event *ev, char *opt)
0d63dd19
DG
149{
150 int ret;
8ff0bbd0 151 char s_hex[19];
0d63dd19
DG
152 char name[LTTNG_SYMBOL_NAME_LEN];
153
154 if (opt == NULL) {
155 ret = -1;
8f0d098b 156 goto end;
0d63dd19
DG
157 }
158
159 /* Check for symbol+offset */
8ff0bbd0 160 ret = sscanf(opt, "%[^'+']+%s", name, s_hex);
0d63dd19 161 if (ret == 2) {
7d29a247 162 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
99497cd0 163 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
cf0e5467 164 DBG("probe symbol %s", ev->attr.probe.symbol_name);
8ff0bbd0
DG
165 if (strlen(s_hex) == 0) {
166 ERR("Invalid probe offset %s", s_hex);
0d63dd19 167 ret = -1;
8f0d098b 168 goto end;
0d63dd19 169 }
8ff0bbd0 170 ev->attr.probe.offset = strtoul(s_hex, NULL, 0);
cf0e5467 171 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
3000dc78 172 ev->attr.probe.addr = 0;
8f0d098b
MD
173 goto end;
174 }
175
176 /* Check for symbol */
177 if (isalpha(name[0])) {
178 ret = sscanf(opt, "%s", name);
179 if (ret == 1) {
180 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
99497cd0 181 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
8f0d098b
MD
182 DBG("probe symbol %s", ev->attr.probe.symbol_name);
183 ev->attr.probe.offset = 0;
184 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
185 ev->attr.probe.addr = 0;
186 goto end;
187 }
0d63dd19
DG
188 }
189
190 /* Check for address */
8ff0bbd0 191 ret = sscanf(opt, "%s", s_hex);
0d63dd19 192 if (ret > 0) {
8ff0bbd0
DG
193 if (strlen(s_hex) == 0) {
194 ERR("Invalid probe address %s", s_hex);
0d63dd19 195 ret = -1;
8f0d098b 196 goto end;
0d63dd19 197 }
8ff0bbd0 198 ev->attr.probe.addr = strtoul(s_hex, NULL, 0);
cf0e5467 199 DBG("probe addr %" PRIu64, ev->attr.probe.addr);
3000dc78
DG
200 ev->attr.probe.offset = 0;
201 memset(ev->attr.probe.symbol_name, 0, LTTNG_SYMBOL_NAME_LEN);
8f0d098b 202 goto end;
0d63dd19
DG
203 }
204
205 /* No match */
206 ret = -1;
207
8f0d098b 208end:
0d63dd19
DG
209 return ret;
210}
211
f3ed775e 212/*
6181537c 213 * Enabling event using the lttng API.
f3ed775e 214 */
cd80958d 215static int enable_events(char *session_name)
f3ed775e
DG
216{
217 int err, ret = CMD_SUCCESS;
b73d0b29 218 char *event_name, *channel_name = NULL;
f3ed775e 219 struct lttng_event ev;
7d29a247 220 struct lttng_domain dom;
f3ed775e 221
f3ed775e
DG
222 if (opt_channel_name == NULL) {
223 err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME);
224 if (err < 0) {
225 ret = CMD_FATAL;
226 goto error;
227 }
228 } else {
229 channel_name = opt_channel_name;
230 }
231
2bdd86d4 232 if (opt_kernel && opt_userspace) {
e14f64a8 233 ERR("Can't use -k/--kernel and -u/--userspace together");
2bdd86d4
MD
234 ret = CMD_FATAL;
235 goto error;
236 }
6181537c 237
7d29a247
DG
238 /* Create lttng domain */
239 if (opt_kernel) {
240 dom.type = LTTNG_DOMAIN_KERNEL;
d78d6610 241 } else if (opt_userspace) {
2bdd86d4 242 dom.type = LTTNG_DOMAIN_UST;
6181537c 243 } else {
e14f64a8 244 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
d16c1a4c 245 ret = CMD_ERROR;
6181537c 246 goto error;
2bdd86d4 247 }
7d29a247 248
cd80958d
DG
249 handle = lttng_create_handle(session_name, &dom);
250 if (handle == NULL) {
251 ret = -1;
252 goto error;
253 }
1aef21b6 254
cd80958d 255 if (opt_enable_all) {
8c9ae521 256 /* Default setup for enable all */
75e8c5ab
MD
257
258 if (opt_kernel) {
259 ev.type = opt_event_type;
260 ev.name[0] = '\0';
261 } else {
262 ev.type = LTTNG_EVENT_TRACEPOINT;
263 strcpy(ev.name, "*");
264 }
8c9ae521
DG
265
266 ret = lttng_enable_event(handle, &ev, channel_name);
267 if (ret < 0) {
268 goto error;
269 }
270
0133c199
MD
271 switch (opt_event_type) {
272 case LTTNG_EVENT_TRACEPOINT:
2bdd86d4
MD
273 MSG("All %s tracepoints are enabled in channel %s",
274 opt_kernel ? "kernel" : "UST", channel_name);
0133c199 275 break;
a54bd42d 276 case LTTNG_EVENT_SYSCALL:
0133c199 277 if (opt_kernel) {
8c9ae521
DG
278 MSG("All kernel system calls are enabled in channel %s",
279 channel_name);
c93d9daf 280 }
0133c199 281 break;
7a3d1328 282 case LTTNG_EVENT_ALL:
2bdd86d4
MD
283 MSG("All %s events are enabled in channel %s",
284 opt_kernel ? "kernel" : "UST", channel_name);
7a3d1328 285 break;
0133c199 286 default:
8c9ae521 287 /*
6181537c
DG
288 * We should not be here since lttng_enable_event should have
289 * failed on the event type.
8c9ae521 290 */
f3ed775e
DG
291 goto error;
292 }
8c9ae521 293 goto end;
f3ed775e
DG
294 }
295
296 /* Strip event list */
297 event_name = strtok(opt_event_list, ",");
298 while (event_name != NULL) {
6181537c
DG
299 /* Copy name and type of the event */
300 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
301 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
302 ev.type = opt_event_type;
303
f3ed775e
DG
304 /* Kernel tracer action */
305 if (opt_kernel) {
306 DBG("Enabling kernel event %s for channel %s",
307 event_name, channel_name);
f3ed775e
DG
308
309 switch (opt_event_type) {
7a3d1328
MD
310 case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
311 ev.type = LTTNG_EVENT_TRACEPOINT;
312 /* Fall-through */
e6ddca71 313 case LTTNG_EVENT_TRACEPOINT:
f3ed775e 314 break;
7d29a247 315 case LTTNG_EVENT_PROBE:
cf0e5467 316 ret = parse_probe_opts(&ev, opt_probe);
0d63dd19 317 if (ret < 0) {
cf0e5467 318 ERR("Unable to parse probe options");
0d63dd19
DG
319 ret = 0;
320 goto error;
321 }
f3ed775e
DG
322 break;
323 case LTTNG_EVENT_FUNCTION:
8f0d098b
MD
324 ret = parse_probe_opts(&ev, opt_function);
325 if (ret < 0) {
326 ERR("Unable to parse function probe options");
327 ret = 0;
328 goto error;
329 }
330 break;
331 case LTTNG_EVENT_FUNCTION_ENTRY:
6181537c
DG
332 strncpy(ev.attr.ftrace.symbol_name, opt_function_entry_symbol,
333 LTTNG_SYMBOL_NAME_LEN);
99497cd0 334 ev.attr.ftrace.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
f3ed775e 335 break;
a54bd42d 336 case LTTNG_EVENT_SYSCALL:
6181537c
DG
337 MSG("per-syscall selection not supported yet. Use \"-a\" "
338 "for all syscalls.");
f3ed775e 339 default:
1ab1ea0b 340 ret = CMD_UNDEFINED;
f3ed775e
DG
341 goto error;
342 }
dad47fc4
MD
343
344 if (opt_loglevel[0] != '\0') {
345 MSG("Kernel loglevels are not supported.");
346 ret = CMD_UNDEFINED;
347 goto error;
348 }
349
350 /* kernel loglevels not implemented */
351 ev.loglevel_type = opt_loglevel_type;
352 ev.loglevel[0] = '\0';
f3ed775e 353 } else if (opt_userspace) { /* User-space tracer action */
d78d6610 354#if 0
e14f64a8
DG
355 if (opt_cmd_name != NULL || opt_pid) {
356 MSG("Only supporting tracing all UST processes (-u) for now.");
1ab1ea0b 357 ret = CMD_UNDEFINED;
2bdd86d4
MD
358 goto error;
359 }
d78d6610 360#endif
6181537c
DG
361
362 DBG("Enabling UST event %s for channel %s", event_name,
363 channel_name);
2bdd86d4
MD
364
365 switch (opt_event_type) {
366 case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
2bdd86d4
MD
367 /* Fall-through */
368 case LTTNG_EVENT_TRACEPOINT:
e4baff1e
MD
369 /* Copy name and type of the event */
370 ev.type = LTTNG_EVENT_TRACEPOINT;
371 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
372 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
2bdd86d4
MD
373 break;
374 case LTTNG_EVENT_PROBE:
375 case LTTNG_EVENT_FUNCTION:
376 case LTTNG_EVENT_FUNCTION_ENTRY:
377 case LTTNG_EVENT_SYSCALL:
378 default:
1ab1ea0b 379 ret = CMD_UNDEFINED;
2bdd86d4
MD
380 goto error;
381 }
dad47fc4
MD
382
383 ev.loglevel_type = opt_loglevel_type;
384 strncpy(ev.loglevel, opt_loglevel, LTTNG_SYMBOL_NAME_LEN);
385 ev.loglevel[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
f3ed775e 386 } else {
e14f64a8 387 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
f3ed775e
DG
388 goto error;
389 }
390
6181537c
DG
391 ret = lttng_enable_event(handle, &ev, channel_name);
392 if (ret == 0) {
393 MSG("%s event %s created in channel %s",
394 opt_kernel ? "kernel": "UST", event_name, channel_name);
395 }
396
f3ed775e
DG
397 /* Next event */
398 event_name = strtok(NULL, ",");
399 }
400
8c9ae521 401end:
f3ed775e 402error:
b73d0b29
MD
403 if (opt_channel_name == NULL) {
404 free(channel_name);
405 }
cd80958d
DG
406 lttng_destroy_handle(handle);
407
f3ed775e
DG
408 return ret;
409}
410
411/*
6181537c 412 * Add event to trace session
f3ed775e
DG
413 */
414int cmd_enable_events(int argc, const char **argv)
415{
416 int opt, ret;
417 static poptContext pc;
cd80958d 418 char *session_name = NULL;
f3ed775e
DG
419
420 pc = poptGetContext(NULL, argc, argv, long_options, 0);
421 poptReadDefaultConfig(pc, 0);
422
423 /* Default event type */
7a3d1328 424 opt_event_type = LTTNG_EVENT_ALL;
f3ed775e
DG
425
426 while ((opt = poptGetNextOpt(pc)) != -1) {
427 switch (opt) {
428 case OPT_HELP:
429 usage(stderr);
430 ret = CMD_SUCCESS;
431 goto end;
f3ed775e 432 case OPT_TRACEPOINT:
e6ddca71 433 opt_event_type = LTTNG_EVENT_TRACEPOINT;
f3ed775e 434 break;
cf0e5467 435 case OPT_PROBE:
7d29a247 436 opt_event_type = LTTNG_EVENT_PROBE;
f3ed775e
DG
437 break;
438 case OPT_FUNCTION:
439 opt_event_type = LTTNG_EVENT_FUNCTION;
8f0d098b
MD
440 break;
441 case OPT_FUNCTION_ENTRY:
442 opt_event_type = LTTNG_EVENT_FUNCTION_ENTRY;
f3ed775e 443 break;
a54bd42d
MD
444 case OPT_SYSCALL:
445 opt_event_type = LTTNG_EVENT_SYSCALL;
0133c199 446 break;
eeac7d46
MD
447 case OPT_USERSPACE:
448 opt_userspace = 1;
eeac7d46 449 break;
dad47fc4
MD
450 case OPT_LOGLEVEL:
451 opt_loglevel_type = LTTNG_EVENT_LOGLEVEL;
452 opt_loglevel = poptGetOptArg(pc);
453 break;
454 case OPT_LOGLEVEL_ONLY:
455 opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_ONLY;
456 opt_loglevel = poptGetOptArg(pc);
13dce3b7 457 break;
679b4943
SM
458 case OPT_LIST_OPTIONS:
459 list_cmd_options(stdout, long_options);
460 ret = CMD_SUCCESS;
461 goto end;
f3ed775e
DG
462 default:
463 usage(stderr);
464 ret = CMD_UNDEFINED;
465 goto end;
466 }
467 }
468
469 opt_event_list = (char*) poptGetArg(pc);
470 if (opt_event_list == NULL && opt_enable_all == 0) {
471 ERR("Missing event name(s).\n");
472 usage(stderr);
473 ret = CMD_SUCCESS;
474 goto end;
475 }
476
cd80958d
DG
477 if (!opt_session_name) {
478 session_name = get_session_name();
479 if (session_name == NULL) {
480 ret = -1;
481 goto end;
482 }
483 } else {
484 session_name = opt_session_name;
485 }
486
487 ret = enable_events(session_name);
f3ed775e
DG
488
489end:
cd80958d
DG
490 if (opt_session_name == NULL) {
491 free(session_name);
492 }
493
f3ed775e
DG
494 return ret;
495}
This page took 0.050578 seconds and 4 git commands to generate.