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