Update consumerd search paths comment
[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");
be49af1e
MD
103 fprintf(ofp, " - userspace tracer supports wildcards at end of string.\n");
104 fprintf(ofp, " Don't forget to quote to deal with bash expansion.\n");
105 fprintf(ofp, " e.g.:\n");
106 fprintf(ofp, " \"*\"\n");
107 fprintf(ofp, " \"app_component:na*\"\n");
13dce3b7 108 fprintf(ofp, " --loglevel Tracepoint loglevel\n");
8f0d098b 109 fprintf(ofp, " --probe [addr | symbol | symbol+offset]\n");
cf0e5467
MD
110 fprintf(ofp, " Dynamic probe.\n");
111 fprintf(ofp, " Addr and offset can be octal (0NNN...),\n");
112 fprintf(ofp, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
8f0d098b
MD
113 fprintf(ofp, " --function [addr | symbol | symbol+offset]\n");
114 fprintf(ofp, " Dynamic function entry/return probe.\n");
115 fprintf(ofp, " Addr and offset can be octal (0NNN...),\n");
116 fprintf(ofp, " decimal (NNN...) or hexadecimal (0xNNN...)\n");
b213d387 117#if 0
8f0d098b
MD
118 fprintf(ofp, " --function:entry symbol\n");
119 fprintf(ofp, " Function tracer event\n");
b213d387 120#endif
a54bd42d 121 fprintf(ofp, " --syscall System call event\n");
f3ed775e
DG
122 fprintf(ofp, "\n");
123}
124
0d63dd19 125/*
6181537c 126 * Parse probe options.
0d63dd19 127 */
cf0e5467 128static int parse_probe_opts(struct lttng_event *ev, char *opt)
0d63dd19
DG
129{
130 int ret;
8ff0bbd0 131 char s_hex[19];
0d63dd19
DG
132 char name[LTTNG_SYMBOL_NAME_LEN];
133
134 if (opt == NULL) {
135 ret = -1;
8f0d098b 136 goto end;
0d63dd19
DG
137 }
138
139 /* Check for symbol+offset */
8ff0bbd0 140 ret = sscanf(opt, "%[^'+']+%s", name, s_hex);
0d63dd19 141 if (ret == 2) {
7d29a247 142 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
99497cd0 143 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
cf0e5467 144 DBG("probe symbol %s", ev->attr.probe.symbol_name);
8ff0bbd0
DG
145 if (strlen(s_hex) == 0) {
146 ERR("Invalid probe offset %s", s_hex);
0d63dd19 147 ret = -1;
8f0d098b 148 goto end;
0d63dd19 149 }
8ff0bbd0 150 ev->attr.probe.offset = strtoul(s_hex, NULL, 0);
cf0e5467 151 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
3000dc78 152 ev->attr.probe.addr = 0;
8f0d098b
MD
153 goto end;
154 }
155
156 /* Check for symbol */
157 if (isalpha(name[0])) {
158 ret = sscanf(opt, "%s", name);
159 if (ret == 1) {
160 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
99497cd0 161 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
8f0d098b
MD
162 DBG("probe symbol %s", ev->attr.probe.symbol_name);
163 ev->attr.probe.offset = 0;
164 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
165 ev->attr.probe.addr = 0;
166 goto end;
167 }
0d63dd19
DG
168 }
169
170 /* Check for address */
8ff0bbd0 171 ret = sscanf(opt, "%s", s_hex);
0d63dd19 172 if (ret > 0) {
8ff0bbd0
DG
173 if (strlen(s_hex) == 0) {
174 ERR("Invalid probe address %s", s_hex);
0d63dd19 175 ret = -1;
8f0d098b 176 goto end;
0d63dd19 177 }
8ff0bbd0 178 ev->attr.probe.addr = strtoul(s_hex, NULL, 0);
cf0e5467 179 DBG("probe addr %" PRIu64, ev->attr.probe.addr);
3000dc78
DG
180 ev->attr.probe.offset = 0;
181 memset(ev->attr.probe.symbol_name, 0, LTTNG_SYMBOL_NAME_LEN);
8f0d098b 182 goto end;
0d63dd19
DG
183 }
184
185 /* No match */
186 ret = -1;
187
8f0d098b 188end:
0d63dd19
DG
189 return ret;
190}
191
f3ed775e 192/*
6181537c 193 * Enabling event using the lttng API.
f3ed775e 194 */
cd80958d 195static int enable_events(char *session_name)
f3ed775e
DG
196{
197 int err, ret = CMD_SUCCESS;
b73d0b29 198 char *event_name, *channel_name = NULL;
f3ed775e 199 struct lttng_event ev;
7d29a247 200 struct lttng_domain dom;
f3ed775e 201
f3ed775e
DG
202 if (opt_channel_name == NULL) {
203 err = asprintf(&channel_name, DEFAULT_CHANNEL_NAME);
204 if (err < 0) {
205 ret = CMD_FATAL;
206 goto error;
207 }
208 } else {
209 channel_name = opt_channel_name;
210 }
211
2bdd86d4 212 if (opt_kernel && opt_userspace) {
e14f64a8 213 ERR("Can't use -k/--kernel and -u/--userspace together");
2bdd86d4
MD
214 ret = CMD_FATAL;
215 goto error;
216 }
6181537c 217
7d29a247
DG
218 /* Create lttng domain */
219 if (opt_kernel) {
220 dom.type = LTTNG_DOMAIN_KERNEL;
6181537c
DG
221 } else if (opt_pid != 0) {
222 dom.type = LTTNG_DOMAIN_UST_PID;
223 dom.attr.pid = opt_pid;
224 DBG("PID %d set to lttng handle", opt_pid);
225 } else if (opt_userspace && opt_cmd_name == NULL) {
2bdd86d4 226 dom.type = LTTNG_DOMAIN_UST;
6181537c
DG
227 } else if (opt_userspace && opt_cmd_name != NULL) {
228 dom.type = LTTNG_DOMAIN_UST_EXEC_NAME;
229 strncpy(dom.attr.exec_name, opt_cmd_name, NAME_MAX);
230 } else {
e14f64a8 231 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
6181537c
DG
232 ret = CMD_NOT_IMPLEMENTED;
233 goto error;
2bdd86d4 234 }
7d29a247 235
cd80958d
DG
236 handle = lttng_create_handle(session_name, &dom);
237 if (handle == NULL) {
238 ret = -1;
239 goto error;
240 }
1aef21b6 241
cd80958d 242 if (opt_enable_all) {
8c9ae521
DG
243 /* Default setup for enable all */
244 ev.name[0] = '\0';
245 ev.type = opt_event_type;
246
247 ret = lttng_enable_event(handle, &ev, channel_name);
248 if (ret < 0) {
249 goto error;
250 }
251
0133c199
MD
252 switch (opt_event_type) {
253 case LTTNG_EVENT_TRACEPOINT:
2bdd86d4
MD
254 MSG("All %s tracepoints are enabled in channel %s",
255 opt_kernel ? "kernel" : "UST", channel_name);
0133c199 256 break;
a54bd42d 257 case LTTNG_EVENT_SYSCALL:
0133c199 258 if (opt_kernel) {
8c9ae521
DG
259 MSG("All kernel system calls are enabled in channel %s",
260 channel_name);
c93d9daf 261 }
0133c199 262 break;
7a3d1328 263 case LTTNG_EVENT_ALL:
2bdd86d4
MD
264 MSG("All %s events are enabled in channel %s",
265 opt_kernel ? "kernel" : "UST", channel_name);
7a3d1328 266 break;
0133c199 267 default:
8c9ae521 268 /*
6181537c
DG
269 * We should not be here since lttng_enable_event should have
270 * failed on the event type.
8c9ae521 271 */
f3ed775e
DG
272 goto error;
273 }
8c9ae521 274 goto end;
f3ed775e
DG
275 }
276
277 /* Strip event list */
278 event_name = strtok(opt_event_list, ",");
279 while (event_name != NULL) {
6181537c
DG
280 /* Copy name and type of the event */
281 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
282 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
283 ev.type = opt_event_type;
284
f3ed775e
DG
285 /* Kernel tracer action */
286 if (opt_kernel) {
287 DBG("Enabling kernel event %s for channel %s",
288 event_name, channel_name);
f3ed775e
DG
289
290 switch (opt_event_type) {
7a3d1328
MD
291 case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
292 ev.type = LTTNG_EVENT_TRACEPOINT;
293 /* Fall-through */
e6ddca71 294 case LTTNG_EVENT_TRACEPOINT:
f3ed775e 295 break;
7d29a247 296 case LTTNG_EVENT_PROBE:
cf0e5467 297 ret = parse_probe_opts(&ev, opt_probe);
0d63dd19 298 if (ret < 0) {
cf0e5467 299 ERR("Unable to parse probe options");
0d63dd19
DG
300 ret = 0;
301 goto error;
302 }
f3ed775e
DG
303 break;
304 case LTTNG_EVENT_FUNCTION:
8f0d098b
MD
305 ret = parse_probe_opts(&ev, opt_function);
306 if (ret < 0) {
307 ERR("Unable to parse function probe options");
308 ret = 0;
309 goto error;
310 }
311 break;
312 case LTTNG_EVENT_FUNCTION_ENTRY:
6181537c
DG
313 strncpy(ev.attr.ftrace.symbol_name, opt_function_entry_symbol,
314 LTTNG_SYMBOL_NAME_LEN);
99497cd0 315 ev.attr.ftrace.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
f3ed775e 316 break;
a54bd42d 317 case LTTNG_EVENT_SYSCALL:
6181537c
DG
318 MSG("per-syscall selection not supported yet. Use \"-a\" "
319 "for all syscalls.");
f3ed775e
DG
320 default:
321 ret = CMD_NOT_IMPLEMENTED;
322 goto error;
323 }
f3ed775e 324 } else if (opt_userspace) { /* User-space tracer action */
e14f64a8
DG
325 if (opt_cmd_name != NULL || opt_pid) {
326 MSG("Only supporting tracing all UST processes (-u) for now.");
2bdd86d4
MD
327 ret = CMD_NOT_IMPLEMENTED;
328 goto error;
329 }
6181537c
DG
330
331 DBG("Enabling UST event %s for channel %s", event_name,
332 channel_name);
2bdd86d4
MD
333
334 switch (opt_event_type) {
335 case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
2bdd86d4
MD
336 /* Fall-through */
337 case LTTNG_EVENT_TRACEPOINT:
e4baff1e
MD
338 /* Copy name and type of the event */
339 ev.type = LTTNG_EVENT_TRACEPOINT;
340 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
341 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
2bdd86d4 342 break;
13dce3b7 343 case LTTNG_EVENT_TRACEPOINT_LOGLEVEL:
e4baff1e 344 /* Copy name and type of the event */
13dce3b7 345 ev.type = LTTNG_EVENT_TRACEPOINT_LOGLEVEL;
e4baff1e
MD
346 strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
347 ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
13dce3b7 348 break;
2bdd86d4
MD
349 case LTTNG_EVENT_PROBE:
350 case LTTNG_EVENT_FUNCTION:
351 case LTTNG_EVENT_FUNCTION_ENTRY:
352 case LTTNG_EVENT_SYSCALL:
353 default:
354 ret = CMD_NOT_IMPLEMENTED;
355 goto error;
356 }
f3ed775e 357 } else {
e14f64a8 358 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
f3ed775e
DG
359 goto error;
360 }
361
6181537c
DG
362 ret = lttng_enable_event(handle, &ev, channel_name);
363 if (ret == 0) {
364 MSG("%s event %s created in channel %s",
365 opt_kernel ? "kernel": "UST", event_name, channel_name);
366 }
367
f3ed775e
DG
368 /* Next event */
369 event_name = strtok(NULL, ",");
370 }
371
8c9ae521 372end:
f3ed775e 373error:
b73d0b29
MD
374 if (opt_channel_name == NULL) {
375 free(channel_name);
376 }
cd80958d
DG
377 lttng_destroy_handle(handle);
378
f3ed775e
DG
379 return ret;
380}
381
382/*
6181537c 383 * Add event to trace session
f3ed775e
DG
384 */
385int cmd_enable_events(int argc, const char **argv)
386{
387 int opt, ret;
388 static poptContext pc;
cd80958d 389 char *session_name = NULL;
f3ed775e
DG
390
391 pc = poptGetContext(NULL, argc, argv, long_options, 0);
392 poptReadDefaultConfig(pc, 0);
393
394 /* Default event type */
7a3d1328 395 opt_event_type = LTTNG_EVENT_ALL;
f3ed775e
DG
396
397 while ((opt = poptGetNextOpt(pc)) != -1) {
398 switch (opt) {
399 case OPT_HELP:
400 usage(stderr);
401 ret = CMD_SUCCESS;
402 goto end;
f3ed775e 403 case OPT_TRACEPOINT:
e6ddca71 404 opt_event_type = LTTNG_EVENT_TRACEPOINT;
f3ed775e 405 break;
cf0e5467 406 case OPT_PROBE:
7d29a247 407 opt_event_type = LTTNG_EVENT_PROBE;
f3ed775e
DG
408 break;
409 case OPT_FUNCTION:
410 opt_event_type = LTTNG_EVENT_FUNCTION;
8f0d098b
MD
411 break;
412 case OPT_FUNCTION_ENTRY:
413 opt_event_type = LTTNG_EVENT_FUNCTION_ENTRY;
f3ed775e 414 break;
a54bd42d
MD
415 case OPT_SYSCALL:
416 opt_event_type = LTTNG_EVENT_SYSCALL;
0133c199 417 break;
eeac7d46
MD
418 case OPT_USERSPACE:
419 opt_userspace = 1;
eeac7d46 420 break;
13dce3b7
MD
421 case OPT_TRACEPOINT_LOGLEVEL:
422 opt_event_type = LTTNG_EVENT_TRACEPOINT_LOGLEVEL;
423 break;
f3ed775e
DG
424 default:
425 usage(stderr);
426 ret = CMD_UNDEFINED;
427 goto end;
428 }
429 }
430
431 opt_event_list = (char*) poptGetArg(pc);
432 if (opt_event_list == NULL && opt_enable_all == 0) {
433 ERR("Missing event name(s).\n");
434 usage(stderr);
435 ret = CMD_SUCCESS;
436 goto end;
437 }
438
cd80958d
DG
439 if (!opt_session_name) {
440 session_name = get_session_name();
441 if (session_name == NULL) {
442 ret = -1;
443 goto end;
444 }
445 } else {
446 session_name = opt_session_name;
447 }
448
449 ret = enable_events(session_name);
f3ed775e
DG
450
451end:
cd80958d
DG
452 if (opt_session_name == NULL) {
453 free(session_name);
454 }
455
f3ed775e
DG
456 return ret;
457}
This page took 0.048315 seconds and 4 git commands to generate.