Clean-up: lttng: silence bogus warning
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
CommitLineData
f3ed775e 1/*
ab5be9fa 2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
f3ed775e 3 *
ab5be9fa 4 * SPDX-License-Identifier: GPL-2.0-only
f3ed775e 5 *
f3ed775e
DG
6 */
7
6c1c0768 8#define _LGPL_SOURCE
b2064f54 9#include <assert.h>
f3ed775e
DG
10#include <popt.h>
11#include <stdio.h>
12#include <stdlib.h>
f3ed775e
DG
13#include <sys/stat.h>
14#include <sys/types.h>
15#include <unistd.h>
5a0de755 16#include <inttypes.h>
8f0d098b 17#include <ctype.h>
f3ed775e 18
343af227 19#include <common/sessiond-comm/sessiond-comm.h>
f5436bfc 20#include <common/compat/string.h>
dbc478f3 21#include <common/compat/getenv.h>
9f449915 22#include <common/string-utils/string-utils.h>
dbc478f3 23#include <common/utils.h>
f3ed775e 24
dbc478f3 25#include <lttng/constant.h>
89476427
JRJ
26/* Mi dependancy */
27#include <common/mi-lttng.h>
28
7e8f2e9c
JG
29#include <lttng/event-internal.h>
30
89476427 31#include "../command.h"
7e8f2e9c 32#include "../loglevel.h"
89476427 33
8ab7c0d9
MD
34#if (LTTNG_SYMBOL_NAME_LEN == 256)
35#define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
36#endif
37
f3ed775e
DG
38static char *opt_event_list;
39static int opt_event_type;
0cda4f28
MD
40static const char *opt_loglevel;
41static int opt_loglevel_type;
6181537c 42static int opt_kernel;
5440dc42 43static char *opt_session_name;
f3ed775e 44static int opt_userspace;
b9dfb167 45static int opt_jul;
5cdb6027 46static int opt_log4j;
0e115563 47static int opt_python;
f3ed775e 48static int opt_enable_all;
cf0e5467 49static char *opt_probe;
dcabc190 50static char *opt_userspace_probe;
8f0d098b 51static char *opt_function;
f3ed775e 52static char *opt_channel_name;
53a80697 53static char *opt_filter;
fac3366c 54static char *opt_exclude;
f3ed775e 55
4fc83d94
PP
56#ifdef LTTNG_EMBED_HELP
57static const char help_msg[] =
58#include <lttng-enable-event.1.h>
59;
60#endif
61
f3ed775e
DG
62enum {
63 OPT_HELP = 1,
f3ed775e 64 OPT_TRACEPOINT,
cf0e5467 65 OPT_PROBE,
dcabc190 66 OPT_USERSPACE_PROBE,
f3ed775e 67 OPT_FUNCTION,
a54bd42d 68 OPT_SYSCALL,
eeac7d46 69 OPT_USERSPACE,
0cda4f28
MD
70 OPT_LOGLEVEL,
71 OPT_LOGLEVEL_ONLY,
679b4943 72 OPT_LIST_OPTIONS,
53a80697 73 OPT_FILTER,
fac3366c 74 OPT_EXCLUDE,
f3ed775e
DG
75};
76
cd80958d 77static struct lttng_handle *handle;
89476427 78static struct mi_writer *writer;
cd80958d 79
f3ed775e
DG
80static struct poptOption long_options[] = {
81 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
82 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
5440dc42 83 {"session", 's', POPT_ARG_STRING, &opt_session_name, 0, 0, 0},
e14f64a8 84 {"all", 'a', POPT_ARG_VAL, &opt_enable_all, 1, 0, 0},
f3ed775e
DG
85 {"channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, 0, 0},
86 {"kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, 0, 0},
d78d6610 87 {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0},
b9dfb167 88 {"jul", 'j', POPT_ARG_VAL, &opt_jul, 1, 0, 0},
5cdb6027 89 {"log4j", 'l', POPT_ARG_VAL, &opt_log4j, 1, 0, 0},
0e115563 90 {"python", 'p', POPT_ARG_VAL, &opt_python, 1, 0, 0},
f3ed775e 91 {"tracepoint", 0, POPT_ARG_NONE, 0, OPT_TRACEPOINT, 0, 0},
7ebae521 92 {"probe", 0, POPT_ARG_STRING, &opt_probe, OPT_PROBE, 0, 0},
dcabc190 93 {"userspace-probe",0, POPT_ARG_STRING, &opt_userspace_probe, OPT_USERSPACE_PROBE, 0, 0},
40e9d5d3 94 {"function", 0, POPT_ARG_STRING, &opt_function, OPT_FUNCTION, 0, 0},
7ebae521 95 {"syscall", 0, POPT_ARG_NONE, 0, OPT_SYSCALL, 0, 0},
0cda4f28
MD
96 {"loglevel", 0, POPT_ARG_STRING, 0, OPT_LOGLEVEL, 0, 0},
97 {"loglevel-only", 0, POPT_ARG_STRING, 0, OPT_LOGLEVEL_ONLY, 0, 0},
679b4943 98 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
53a80697 99 {"filter", 'f', POPT_ARG_STRING, &opt_filter, OPT_FILTER, 0, 0},
fac3366c 100 {"exclude", 'x', POPT_ARG_STRING, &opt_exclude, OPT_EXCLUDE, 0, 0},
f3ed775e
DG
101 {0, 0, 0, 0, 0, 0, 0}
102};
103
0d63dd19 104/*
6181537c 105 * Parse probe options.
0d63dd19 106 */
cf0e5467 107static int parse_probe_opts(struct lttng_event *ev, char *opt)
0d63dd19 108{
49d4e302
JRJ
109 int ret = CMD_SUCCESS;
110 int match;
8ff0bbd0 111 char s_hex[19];
8ab7c0d9 112#define S_HEX_LEN_SCANF_IS_A_BROKEN_API "18" /* 18 is (19 - 1) (\0 is extra) */
0d63dd19
DG
113 char name[LTTNG_SYMBOL_NAME_LEN];
114
115 if (opt == NULL) {
49d4e302 116 ret = CMD_ERROR;
8f0d098b 117 goto end;
0d63dd19
DG
118 }
119
120 /* Check for symbol+offset */
49d4e302 121 match = sscanf(opt, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
8ab7c0d9 122 "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API "s", name, s_hex);
49d4e302 123 if (match == 2) {
7d29a247 124 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
99497cd0 125 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
cf0e5467 126 DBG("probe symbol %s", ev->attr.probe.symbol_name);
9d035200 127 if (*s_hex == '\0') {
8ff0bbd0 128 ERR("Invalid probe offset %s", s_hex);
49d4e302 129 ret = CMD_ERROR;
8f0d098b 130 goto end;
0d63dd19 131 }
8ff0bbd0 132 ev->attr.probe.offset = strtoul(s_hex, NULL, 0);
cf0e5467 133 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
3000dc78 134 ev->attr.probe.addr = 0;
8f0d098b
MD
135 goto end;
136 }
137
138 /* Check for symbol */
88c91427 139 if (isalpha(name[0]) || name[0] == '_') {
49d4e302 140 match = sscanf(opt, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "s",
8ab7c0d9 141 name);
49d4e302 142 if (match == 1) {
8f0d098b 143 strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
99497cd0 144 ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
8f0d098b
MD
145 DBG("probe symbol %s", ev->attr.probe.symbol_name);
146 ev->attr.probe.offset = 0;
147 DBG("probe offset %" PRIu64, ev->attr.probe.offset);
148 ev->attr.probe.addr = 0;
149 goto end;
150 }
0d63dd19
DG
151 }
152
153 /* Check for address */
49d4e302
JRJ
154 match = sscanf(opt, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API "s", s_hex);
155 if (match > 0) {
531be721
FD
156 /*
157 * Return an error if the first character of the tentative
158 * address is NULL or not a digit. It can be "0" if the address
159 * is in hexadecimal and can be 1 to 9 if it's in decimal.
160 */
161 if (*s_hex == '\0' || !isdigit(*s_hex)) {
162 ERR("Invalid probe description %s", s_hex);
49d4e302 163 ret = CMD_ERROR;
8f0d098b 164 goto end;
0d63dd19 165 }
8ff0bbd0 166 ev->attr.probe.addr = strtoul(s_hex, NULL, 0);
cf0e5467 167 DBG("probe addr %" PRIu64, ev->attr.probe.addr);
3000dc78
DG
168 ev->attr.probe.offset = 0;
169 memset(ev->attr.probe.symbol_name, 0, LTTNG_SYMBOL_NAME_LEN);
8f0d098b 170 goto end;
0d63dd19
DG
171 }
172
173 /* No match */
49d4e302 174 ret = CMD_ERROR;
0d63dd19 175
8f0d098b 176end:
0d63dd19
DG
177 return ret;
178}
179
dbc478f3
FD
180/*
181 * Walk the directories in the PATH environment variable to find the target
182 * binary passed as parameter.
183 *
184 * On success, the full path of the binary is copied in binary_full_path out
185 * parameter. This buffer is allocated by the caller and must be at least
186 * LTTNG_PATH_MAX bytes long.
187 * On failure, returns -1;
188 */
189static int walk_command_search_path(const char *binary, char *binary_full_path)
190{
191 char *tentative_binary_path = NULL;
192 char *command_search_path = NULL;
193 char *curr_search_dir_end = NULL;
194 char *curr_search_dir = NULL;
195 struct stat stat_output;
196 int ret = 0;
197
198 command_search_path = lttng_secure_getenv("PATH");
199 if (!command_search_path) {
200 ret = -1;
201 goto end;
202 }
203
204 /*
205 * Duplicate the $PATH string as the char pointer returned by getenv() should
206 * not be modified.
207 */
208 command_search_path = strdup(command_search_path);
209 if (!command_search_path) {
210 ret = -1;
211 goto end;
212 }
213
214 /*
215 * This char array is used to concatenate path to binary to look for
216 * the binary.
217 */
218 tentative_binary_path = zmalloc(LTTNG_PATH_MAX * sizeof(char));
219 if (!tentative_binary_path) {
220 ret = -1;
221 goto alloc_error;
222 }
223
224 curr_search_dir = command_search_path;
225 do {
226 /*
227 * Split on ':'. The return value of this call points to the
228 * matching character.
229 */
230 curr_search_dir_end = strchr(curr_search_dir, ':');
231 if (curr_search_dir_end != NULL) {
232 /*
233 * Add a NULL byte to the end of the first token so it
234 * can be used as a string.
235 */
236 curr_search_dir_end[0] = '\0';
237 }
238
239 /* Empty the tentative path */
240 memset(tentative_binary_path, 0, LTTNG_PATH_MAX * sizeof(char));
241
242 /*
243 * Build the tentative path to the binary using the current
244 * search directory and the name of the binary.
245 */
246 ret = snprintf(tentative_binary_path, LTTNG_PATH_MAX, "%s/%s",
247 curr_search_dir, binary);
248 if (ret < 0) {
249 goto free_binary_path;
250 }
251 if (ret < LTTNG_PATH_MAX) {
252 /*
253 * Use STAT(2) to see if the file exists.
254 */
255 ret = stat(tentative_binary_path, &stat_output);
256 if (ret == 0) {
257 /*
258 * Verify that it is a regular file or a
259 * symlink and not a special file (e.g.
260 * device).
261 */
262 if (S_ISREG(stat_output.st_mode)
263 || S_ISLNK(stat_output.st_mode)) {
264 /*
265 * Found a match, set the out parameter
266 * and return success.
267 */
268 ret = lttng_strncpy(binary_full_path,
269 tentative_binary_path,
270 LTTNG_PATH_MAX);
271 if (ret == -1) {
272 ERR("Source path does not fit "
273 "in destination buffer.");
274 }
275 goto free_binary_path;
276 }
277 }
278 }
279 /* Go to the next entry in the $PATH variable. */
280 curr_search_dir = curr_search_dir_end + 1;
281 } while (curr_search_dir_end != NULL);
282
283free_binary_path:
284 free(tentative_binary_path);
285alloc_error:
286 free(command_search_path);
287end:
288 return ret;
289}
290
36aa2f64
FD
291/*
292 * Check if the symbol field passed by the user is in fact an address or an
293 * offset from a symbol. Those two instrumentation types are not supported yet.
294 * It's expected to be a common mistake because of the existing --probe option
295 * that does support these formats.
296 *
297 * Here are examples of these unsupported formats for the --userspace-probe
298 * option:
299 * elf:/path/to/binary:0x400430
300 * elf:/path/to/binary:4194364
301 * elf:/path/to/binary:my_symbol+0x323
302 * elf:/path/to/binary:my_symbol+43
303 */
304static int warn_userspace_probe_syntax(const char *symbol)
305{
36aa2f64
FD
306 int ret;
307
308 /* Check if the symbol field is an hex address. */
639d2823 309 ret = sscanf(symbol, "0x%*x");
36aa2f64
FD
310 if (ret > 0) {
311 /* If there is a match, print a warning and return an error. */
312 ERR("Userspace probe on address not supported yet.");
313 ret = CMD_UNSUPPORTED;
314 goto error;
315 }
316
317 /* Check if the symbol field is an decimal address. */
639d2823 318 ret = sscanf(symbol, "%*u");
36aa2f64
FD
319 if (ret > 0) {
320 /* If there is a match, print a warning and return an error. */
321 ERR("Userspace probe on address not supported yet.");
322 ret = CMD_UNSUPPORTED;
323 goto error;
324 }
325
326 /* Check if the symbol field is symbol+hex_offset. */
639d2823 327 ret = sscanf(symbol, "%*[^+]+0x%*x");
36aa2f64
FD
328 if (ret > 0) {
329 /* If there is a match, print a warning and return an error. */
330 ERR("Userspace probe on symbol+offset not supported yet.");
331 ret = CMD_UNSUPPORTED;
332 goto error;
333 }
334
335 /* Check if the symbol field is symbol+decimal_offset. */
639d2823 336 ret = sscanf(symbol, "%*[^+]+%*u");
36aa2f64
FD
337 if (ret > 0) {
338 /* If there is a match, print a warning and return an error. */
339 ERR("Userspace probe on symbol+offset not supported yet.");
340 ret = CMD_UNSUPPORTED;
341 goto error;
342 }
343
344 ret = 0;
345
346error:
347 return ret;
348}
349
dcabc190
FD
350/*
351 * Parse userspace probe options
352 * Set the userspace probe fields in the lttng_event struct and set the
353 * target_path to the path to the binary.
354 */
355static int parse_userspace_probe_opts(struct lttng_event *ev, char *opt)
356{
357 int ret = CMD_SUCCESS;
358 int num_token;
359 char **tokens;
360 char *target_path = NULL;
361 char *unescaped_target_path = NULL;
362 char *real_target_path = NULL;
363 char *symbol_name = NULL, *probe_name = NULL, *provider_name = NULL;
364 struct lttng_userspace_probe_location *probe_location = NULL;
365 struct lttng_userspace_probe_location_lookup_method *lookup_method =
366 NULL;
367
368 if (opt == NULL) {
369 ret = CMD_ERROR;
370 goto end;
371 }
372
ebbcac93
FD
373 switch (ev->type) {
374 case LTTNG_EVENT_USERSPACE_PROBE:
375 break;
376 default:
377 assert(0);
378 }
379
dcabc190
FD
380 /*
381 * userspace probe fields are separated by ':'.
382 */
383 tokens = strutils_split(opt, ':', 1);
384 num_token = strutils_array_of_strings_len(tokens);
385
386 /*
387 * Early sanity check that the number of parameter is between 2 and 4
388 * inclusively.
389 * elf:PATH:SYMBOL
390 * std:PATH:PROVIDER_NAME:PROBE_NAME
391 * PATH:SYMBOL (same behavior as ELF)
392 */
393 if (num_token < 2 || num_token > 4) {
394 ret = CMD_ERROR;
395 goto end_string;
396 }
397
398 /*
399 * Looking up the first parameter will tell the technique to use to
400 * interpret the userspace probe/function description.
401 */
402 switch (num_token) {
403 case 2:
404 /* When the probe type is omitted we assume ELF for now. */
405 case 3:
406 if (num_token == 3 && strcmp(tokens[0], "elf") == 0) {
407 target_path = tokens[1];
408 symbol_name = tokens[2];
409 } else if (num_token == 2) {
410 target_path = tokens[0];
411 symbol_name = tokens[1];
412 } else {
413 ret = CMD_ERROR;
414 goto end_string;
415 }
416 lookup_method =
417 lttng_userspace_probe_location_lookup_method_function_elf_create();
418 if (!lookup_method) {
419 WARN("Failed to create ELF lookup method");
420 ret = CMD_ERROR;
421 goto end_string;
422 }
423 break;
424 case 4:
425 if (strcmp(tokens[0], "sdt") == 0) {
426 target_path = tokens[1];
427 provider_name = tokens[2];
428 probe_name = tokens[3];
429 } else {
430 ret = CMD_ERROR;
431 goto end_string;
432 }
433 lookup_method =
434 lttng_userspace_probe_location_lookup_method_tracepoint_sdt_create();
435 if (!lookup_method) {
b9e1aca7 436 WARN("Failed to create SDT lookup method");
dcabc190
FD
437 ret = CMD_ERROR;
438 goto end_string;
439 }
440 break;
441 default:
442 ret = CMD_ERROR;
443 goto end_string;
444 }
445
446 /* strutils_unescape_string allocates a new char *. */
447 unescaped_target_path = strutils_unescape_string(target_path, 0);
448 if (!unescaped_target_path) {
36aa2f64 449 ret = CMD_ERROR;
ebbcac93 450 goto end_destroy_lookup_method;
dcabc190
FD
451 }
452
453 /*
454 * If there is not forward slash in the path. Walk the $PATH else
455 * expand.
456 */
ebbcac93 457 if (strchr(unescaped_target_path, '/') == NULL) {
dcabc190
FD
458 /* Walk the $PATH variable to find the targeted binary. */
459 real_target_path = zmalloc(LTTNG_PATH_MAX * sizeof(char));
460 if (!real_target_path) {
461 PERROR("Error allocating path buffer");
462 ret = CMD_ERROR;
ebbcac93 463 goto end_destroy_lookup_method;
dcabc190 464 }
ebbcac93 465 ret = walk_command_search_path(unescaped_target_path, real_target_path);
dcabc190
FD
466 if (ret) {
467 ERR("Binary not found.");
468 ret = CMD_ERROR;
ebbcac93 469 goto end_destroy_lookup_method;
dcabc190
FD
470 }
471 } else {
472 /*
473 * Expand references to `/./` and `/../`. This function does not check
ebbcac93
FD
474 * if the file exists. This call returns an allocated buffer on
475 * success.
dcabc190 476 */
ebbcac93 477 real_target_path = utils_expand_path_keep_symlink(unescaped_target_path);
dcabc190
FD
478 if (!real_target_path) {
479 ERR("Error expanding the path to binary.");
480 ret = CMD_ERROR;
ebbcac93 481 goto end_destroy_lookup_method;
dcabc190
FD
482 }
483
484 /*
54185c70
FD
485 * Check if the file exists using access(2), If it does not,
486 * return an error.
dcabc190
FD
487 */
488 ret = access(real_target_path, F_OK);
489 if (ret) {
bb77204a 490 ERR("Cannot find binary at path: %s.", real_target_path);
dcabc190 491 ret = CMD_ERROR;
ebbcac93 492 goto end_destroy_lookup_method;
dcabc190
FD
493 }
494 }
495
496 switch (lttng_userspace_probe_location_lookup_method_get_type(lookup_method)) {
497 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_FUNCTION_ELF:
36aa2f64
FD
498 /*
499 * Check for common mistakes in userspace probe description syntax.
500 */
501 ret = warn_userspace_probe_syntax(symbol_name);
502 if (ret) {
503 goto end_destroy_lookup_method;
504 }
505
dcabc190
FD
506 probe_location = lttng_userspace_probe_location_function_create(
507 real_target_path, symbol_name, lookup_method);
508 if (!probe_location) {
509 WARN("Failed to create function probe location");
510 ret = CMD_ERROR;
511 goto end_destroy_lookup_method;
512 }
513
514 /* Ownership transferred to probe_location. */
515 lookup_method = NULL;
516
517 ret = lttng_event_set_userspace_probe_location(ev, probe_location);
518 if (ret) {
519 WARN("Failed to set probe location on event");
520 ret = CMD_ERROR;
521 goto end_destroy_location;
522 }
523 break;
524 case LTTNG_USERSPACE_PROBE_LOCATION_LOOKUP_METHOD_TYPE_TRACEPOINT_SDT:
525 probe_location = lttng_userspace_probe_location_tracepoint_create(
526 real_target_path, provider_name, probe_name, lookup_method);
527 if (!probe_location) {
528 WARN("Failed to create function probe location");
529 ret = CMD_ERROR;
530 goto end_destroy_lookup_method;
531 }
532
533 /* Ownership transferred to probe_location. */
534 lookup_method = NULL;
535
536 ret = lttng_event_set_userspace_probe_location(ev, probe_location);
537 if (ret) {
538 WARN("Failed to set probe location on event");
539 ret = CMD_ERROR;
540 goto end_destroy_location;
541 }
542 break;
543 default:
544 ret = CMD_ERROR;
ebbcac93 545 goto end_destroy_lookup_method;
dcabc190
FD
546 }
547
ebbcac93
FD
548 /* Successful parsing, now clean up everything and return. */
549 goto end_string;
dcabc190
FD
550
551end_destroy_location:
552 lttng_userspace_probe_location_destroy(probe_location);
553end_destroy_lookup_method:
554 lttng_userspace_probe_location_lookup_method_destroy(lookup_method);
ebbcac93
FD
555end_string:
556 strutils_free_null_terminated_array_of_strings(tokens);
dcabc190 557 /*
ebbcac93
FD
558 * Freeing both char * here makes the error handling simplier. free()
559 * performs not action if the pointer is NULL.
dcabc190
FD
560 */
561 free(real_target_path);
dcabc190 562 free(unescaped_target_path);
dcabc190
FD
563end:
564 return ret;
565}
566
85076754
MD
567static
568const char *print_channel_name(const char *name)
569{
570 return name ? : DEFAULT_CHANNEL_NAME;
571}
572
573static
574const char *print_raw_channel_name(const char *name)
575{
576 return name ? : "<default>";
577}
578
89476427
JRJ
579/*
580 * Mi print exlcusion list
581 */
582static
9f449915 583int mi_print_exclusion(char **names)
89476427
JRJ
584{
585 int i, ret;
9f449915 586 int count = names ? strutils_array_of_strings_len(names) : 0;
89476427
JRJ
587
588 assert(writer);
589
590 if (count == 0) {
591 ret = 0;
592 goto end;
593 }
594 ret = mi_lttng_writer_open_element(writer, config_element_exclusions);
595 if (ret) {
596 goto end;
597 }
598
599 for (i = 0; i < count; i++) {
600 ret = mi_lttng_writer_write_element_string(writer,
601 config_element_exclusion, names[i]);
602 if (ret) {
603 goto end;
604 }
605 }
606
607 /* Close exclusions element */
608 ret = mi_lttng_writer_close_element(writer);
609
610end:
611 return ret;
612}
613
9c48cab3
JI
614/*
615 * Return allocated string for pretty-printing exclusion names.
616 */
617static
9f449915 618char *print_exclusions(char **names)
9c48cab3
JI
619{
620 int length = 0;
621 int i;
bfe36393 622 const char preamble[] = " excluding ";
9c48cab3 623 char *ret;
9f449915 624 int count = names ? strutils_array_of_strings_len(names) : 0;
9c48cab3
JI
625
626 if (count == 0) {
627 return strdup("");
628 }
629
630 /* calculate total required length */
631 for (i = 0; i < count; i++) {
9f449915 632 length += strlen(names[i]) + 4;
9c48cab3
JI
633 }
634
bfe36393
JG
635 length += sizeof(preamble);
636 ret = zmalloc(length);
fd591b18
MD
637 if (!ret) {
638 return NULL;
639 }
9c48cab3
JI
640 strncpy(ret, preamble, length);
641 for (i = 0; i < count; i++) {
9f449915 642 strcat(ret, "\"");
9c48cab3 643 strcat(ret, names[i]);
9f449915 644 strcat(ret, "\"");
9c48cab3 645 if (i != count - 1) {
9f449915 646 strcat(ret, ", ");
9c48cab3
JI
647 }
648 }
89476427 649
9c48cab3
JI
650 return ret;
651}
652
748bde76 653static
9f449915 654int check_exclusion_subsets(const char *event_name, const char *exclusion)
748bde76 655{
9f449915
PP
656 bool warn = false;
657 int ret = 0;
658 const char *e = event_name;
659 const char *x = exclusion;
660
661 /* Scan both the excluder and the event letter by letter */
662 while (true) {
663 if (*e == '\\') {
664 if (*x != *e) {
665 warn = true;
666 goto end;
667 }
748bde76 668
9f449915
PP
669 e++;
670 x++;
671 goto cmp_chars;
672 }
673
674 if (*x == '*') {
675 /* Event is a subset of the excluder */
676 ERR("Event %s: %s excludes all events from %s",
677 event_name, exclusion, event_name);
678 goto error;
679 }
680
681 if (*e == '*') {
682 /*
683 * Reached the end of the event name before the
684 * end of the exclusion: this is valid.
685 */
686 goto end;
687 }
688
689cmp_chars:
690 if (*x != *e) {
691 warn = true;
692 break;
693 }
694
695 x++;
696 e++;
748bde76
JI
697 }
698
9f449915 699 goto end;
748bde76 700
9f449915
PP
701error:
702 ret = -1;
748bde76 703
9f449915
PP
704end:
705 if (warn) {
706 WARN("Event %s: %s does not exclude any events from %s",
707 event_name, exclusion, event_name);
708 }
748bde76 709
9f449915
PP
710 return ret;
711}
712
9f449915
PP
713static
714int create_exclusion_list_and_validate(const char *event_name,
715 const char *exclusions_arg,
716 char ***exclusion_list)
717{
718 int ret = 0;
719 char **exclusions = NULL;
720
721 /* Event name must be a valid globbing pattern to allow exclusions. */
722 if (!strutils_is_star_glob_pattern(event_name)) {
723 ERR("Event %s: Exclusions can only be used with a globbing pattern",
724 event_name);
725 goto error;
726 }
727
728 /* Split exclusions. */
729 exclusions = strutils_split(exclusions_arg, ',', true);
730 if (!exclusions) {
731 goto error;
732 }
733
734 /*
735 * If the event name is a star-at-end only globbing pattern,
736 * then we can validate the individual exclusions. Otherwise
737 * all exclusions are passed to the session daemon.
738 */
739 if (strutils_is_star_at_the_end_only_glob_pattern(event_name)) {
740 char * const *exclusion;
741
742 for (exclusion = exclusions; *exclusion; exclusion++) {
743 if (!strutils_is_star_glob_pattern(*exclusion) ||
744 strutils_is_star_at_the_end_only_glob_pattern(*exclusion)) {
8aa579d4 745 ret = check_exclusion_subsets(event_name, *exclusion);
9f449915 746 if (ret) {
5ef79758
MD
747 goto error;
748 }
748bde76 749 }
748bde76
JI
750 }
751 }
9f449915
PP
752
753 *exclusion_list = exclusions;
754
748bde76 755 goto end;
9f449915 756
748bde76 757error:
9f449915
PP
758 ret = -1;
759 strutils_free_null_terminated_array_of_strings(exclusions);
760
748bde76 761end:
748bde76
JI
762 return ret;
763}
502bbe89 764
9f449915
PP
765static void warn_on_truncated_exclusion_names(char * const *exclusion_list,
766 int *warn)
502bbe89 767{
9f449915 768 char * const *exclusion;
502bbe89 769
9f449915
PP
770 for (exclusion = exclusion_list; *exclusion; exclusion++) {
771 if (strlen(*exclusion) >= LTTNG_SYMBOL_NAME_LEN) {
502bbe89 772 WARN("Event exclusion \"%s\" will be truncated",
9f449915 773 *exclusion);
502bbe89
PP
774 *warn = 1;
775 }
776 }
777}
778
f3ed775e 779/*
6181537c 780 * Enabling event using the lttng API.
89476427 781 * Note: in case of error only the last error code will be return.
f3ed775e 782 */
cd80958d 783static int enable_events(char *session_name)
f3ed775e 784{
89476427
JRJ
785 int ret = CMD_SUCCESS, command_ret = CMD_SUCCESS;
786 int error_holder = CMD_SUCCESS, warn = 0, error = 0, success = 1;
b73d0b29 787 char *event_name, *channel_name = NULL;
91744e14 788 struct lttng_event *ev;
7d29a247 789 struct lttng_domain dom;
7ed70bc9 790 char **exclusion_list = NULL;
f3ed775e 791
441c16a7
MD
792 memset(&dom, 0, sizeof(dom));
793
91744e14
FD
794 ev = lttng_event_create();
795 if (!ev) {
796 ret = CMD_ERROR;
797 goto error;
798 }
799
53a80697 800 if (opt_kernel) {
67b58630
JG
801 if (opt_loglevel) {
802 WARN("Kernel loglevels are not supported.");
803 }
53a80697
MD
804 }
805
7d29a247
DG
806 /* Create lttng domain */
807 if (opt_kernel) {
808 dom.type = LTTNG_DOMAIN_KERNEL;
7972aab2 809 dom.buf_type = LTTNG_BUFFER_GLOBAL;
d78d6610 810 } else if (opt_userspace) {
2bdd86d4 811 dom.type = LTTNG_DOMAIN_UST;
7972aab2 812 /* Default. */
8692d4e5 813 dom.buf_type = LTTNG_BUFFER_PER_UID;
b9dfb167
DG
814 } else if (opt_jul) {
815 dom.type = LTTNG_DOMAIN_JUL;
816 /* Default. */
817 dom.buf_type = LTTNG_BUFFER_PER_UID;
5cdb6027
DG
818 } else if (opt_log4j) {
819 dom.type = LTTNG_DOMAIN_LOG4J;
820 /* Default. */
821 dom.buf_type = LTTNG_BUFFER_PER_UID;
0e115563
DG
822 } else if (opt_python) {
823 dom.type = LTTNG_DOMAIN_PYTHON;
824 /* Default. */
825 dom.buf_type = LTTNG_BUFFER_PER_UID;
6181537c 826 } else {
3ecec76a
PP
827 /* Checked by the caller. */
828 assert(0);
2bdd86d4 829 }
7d29a247 830
8b08c525
AB
831 if (opt_exclude) {
832 switch (dom.type) {
833 case LTTNG_DOMAIN_KERNEL:
834 case LTTNG_DOMAIN_JUL:
835 case LTTNG_DOMAIN_LOG4J:
836 case LTTNG_DOMAIN_PYTHON:
837 ERR("Event name exclusions are not yet implemented for %s events",
838 get_domain_str(dom.type));
839 ret = CMD_ERROR;
840 goto error;
841 case LTTNG_DOMAIN_UST:
842 /* Exclusions supported */
843 break;
844 default:
845 assert(0);
846 }
d5dd17fd
JI
847 }
848
4fd2697f
FD
849 /*
850 * Adding a filter to a probe, function or userspace-probe would be
851 * denied by the kernel tracer as it's not supported at the moment. We
852 * do an early check here to warn the user.
853 */
854 if (opt_filter && opt_kernel) {
855 switch (opt_event_type) {
856 case LTTNG_EVENT_ALL:
857 case LTTNG_EVENT_TRACEPOINT:
858 case LTTNG_EVENT_SYSCALL:
859 break;
860 case LTTNG_EVENT_PROBE:
861 case LTTNG_EVENT_USERSPACE_PROBE:
862 case LTTNG_EVENT_FUNCTION:
863 ERR("Filter expressions are not supported for %s events",
864 get_event_type_str(opt_event_type));
865 ret = CMD_ERROR;
866 goto error;
867 default:
868 ret = CMD_UNDEFINED;
869 goto error;
870 }
871 }
872
85076754 873 channel_name = opt_channel_name;
ae856491 874
cd80958d
DG
875 handle = lttng_create_handle(session_name, &dom);
876 if (handle == NULL) {
877 ret = -1;
878 goto error;
879 }
1aef21b6 880
89476427
JRJ
881 /* Prepare Mi */
882 if (lttng_opt_mi) {
883 /* Open a events element */
884 ret = mi_lttng_writer_open_element(writer, config_element_events);
885 if (ret) {
886 ret = CMD_ERROR;
887 goto error;
888 }
889 }
890
cd80958d 891 if (opt_enable_all) {
8c9ae521 892 /* Default setup for enable all */
75e8c5ab 893 if (opt_kernel) {
91744e14
FD
894 ev->type = opt_event_type;
895 strcpy(ev->name, "*");
300b8fd5 896 /* kernel loglevels not implemented */
91744e14 897 ev->loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
75e8c5ab 898 } else {
91744e14
FD
899 ev->type = LTTNG_EVENT_TRACEPOINT;
900 strcpy(ev->name, "*");
901 ev->loglevel_type = opt_loglevel_type;
300b8fd5 902 if (opt_loglevel) {
7e8f2e9c
JG
903 int name_search_ret;
904
0e115563 905 assert(opt_userspace || opt_jul || opt_log4j || opt_python);
7e8f2e9c 906
b2064f54 907 if (opt_userspace) {
7e8f2e9c
JG
908 enum lttng_loglevel loglevel;
909
910 name_search_ret = loglevel_name_to_value(opt_loglevel, &loglevel);
911 ev->loglevel = (int) loglevel;
b2064f54 912 } else if (opt_jul) {
7e8f2e9c
JG
913 enum lttng_loglevel_jul loglevel;
914
915 name_search_ret = loglevel_jul_name_to_value(opt_loglevel, &loglevel);
916 ev->loglevel = (int) loglevel;
5cdb6027 917 } else if (opt_log4j) {
7e8f2e9c
JG
918 enum lttng_loglevel_log4j loglevel;
919
920 name_search_ret = loglevel_log4j_name_to_value(opt_loglevel, &loglevel);
921 ev->loglevel = (int) loglevel;
7fefa907
JG
922 } else {
923 /* python domain. */
7e8f2e9c
JG
924 enum lttng_loglevel_python loglevel;
925
926 name_search_ret = loglevel_python_name_to_value(opt_loglevel, &loglevel);
927 ev->loglevel = (int) loglevel;
b2064f54 928 }
7e8f2e9c
JG
929
930 if (name_search_ret == -1) {
300b8fd5 931 ERR("Unknown loglevel %s", opt_loglevel);
2f70b271 932 ret = -LTTNG_ERR_INVALID;
300b8fd5
MD
933 goto error;
934 }
22e25b71 935 } else {
0e115563 936 assert(opt_userspace || opt_jul || opt_log4j || opt_python);
b2064f54 937 if (opt_userspace) {
91744e14 938 ev->loglevel = -1;
34aa3685 939 } else if (opt_jul) {
91744e14 940 ev->loglevel = LTTNG_LOGLEVEL_JUL_ALL;
34aa3685 941 } else if (opt_log4j) {
91744e14 942 ev->loglevel = LTTNG_LOGLEVEL_LOG4J_ALL;
0e115563 943 } else if (opt_python) {
91744e14 944 ev->loglevel = LTTNG_LOGLEVEL_PYTHON_DEBUG;
b2064f54 945 }
300b8fd5 946 }
75e8c5ab 947 }
8c9ae521 948
7ed70bc9 949 if (opt_exclude) {
9f449915
PP
950 ret = create_exclusion_list_and_validate("*",
951 opt_exclude, &exclusion_list);
952 if (ret) {
953 ret = CMD_ERROR;
7ed70bc9
JI
954 goto error;
955 }
502bbe89 956
91744e14 957 ev->exclusion = 1;
502bbe89 958 warn_on_truncated_exclusion_names(exclusion_list,
9f449915 959 &warn);
7ed70bc9 960 }
025faf73 961 if (!opt_filter) {
7ed70bc9 962 ret = lttng_enable_event_with_exclusions(handle,
91744e14 963 ev, channel_name,
7ed70bc9 964 NULL,
9f449915
PP
965 exclusion_list ? strutils_array_of_strings_len(exclusion_list) : 0,
966 exclusion_list);
025faf73
DG
967 if (ret < 0) {
968 switch (-ret) {
969 case LTTNG_ERR_KERN_EVENT_EXIST:
970 WARN("Kernel events already enabled (channel %s, session %s)",
85076754 971 print_channel_name(channel_name), session_name);
89476427 972 warn = 1;
025faf73 973 break;
45d5d421
CB
974 case LTTNG_ERR_TRACE_ALREADY_STARTED:
975 {
976 const char *msg = "The command tried to enable an event in a new domain for a session that has already been started once.";
977 ERR("Events: %s (channel %s, session %s)",
978 msg,
979 print_channel_name(channel_name),
980 session_name);
981 error = 1;
982 break;
983 }
025faf73
DG
984 default:
985 ERR("Events: %s (channel %s, session %s)",
85076754
MD
986 lttng_strerror(ret),
987 ret == -LTTNG_ERR_NEED_CHANNEL_NAME
988 ? print_raw_channel_name(channel_name)
989 : print_channel_name(channel_name),
990 session_name);
89476427 991 error = 1;
025faf73
DG
992 break;
993 }
994 goto end;
42224349 995 }
8c9ae521 996
025faf73
DG
997 switch (opt_event_type) {
998 case LTTNG_EVENT_TRACEPOINT:
67b58630 999 if (opt_loglevel && dom.type != LTTNG_DOMAIN_KERNEL) {
9f449915 1000 char *exclusion_string = print_exclusions(exclusion_list);
5ef79758
MD
1001
1002 if (!exclusion_string) {
1003 PERROR("Cannot allocate exclusion_string");
1004 error = 1;
1005 goto end;
1006 }
9c48cab3 1007 MSG("All %s tracepoints%s are enabled in channel %s for loglevel %s",
b9dfb167 1008 get_domain_str(dom.type),
9c48cab3 1009 exclusion_string,
85076754 1010 print_channel_name(channel_name),
025faf73 1011 opt_loglevel);
9c48cab3 1012 free(exclusion_string);
025faf73 1013 } else {
9f449915 1014 char *exclusion_string = print_exclusions(exclusion_list);
5ef79758
MD
1015
1016 if (!exclusion_string) {
1017 PERROR("Cannot allocate exclusion_string");
1018 error = 1;
1019 goto end;
1020 }
9c48cab3 1021 MSG("All %s tracepoints%s are enabled in channel %s",
b9dfb167 1022 get_domain_str(dom.type),
9c48cab3 1023 exclusion_string,
85076754 1024 print_channel_name(channel_name));
9c48cab3 1025 free(exclusion_string);
025faf73
DG
1026 }
1027 break;
1028 case LTTNG_EVENT_SYSCALL:
1029 if (opt_kernel) {
6e911cad
MD
1030 MSG("All %s system calls are enabled in channel %s",
1031 get_domain_str(dom.type),
85076754 1032 print_channel_name(channel_name));
025faf73
DG
1033 }
1034 break;
1035 case LTTNG_EVENT_ALL:
67b58630 1036 if (opt_loglevel && dom.type != LTTNG_DOMAIN_KERNEL) {
9f449915 1037 char *exclusion_string = print_exclusions(exclusion_list);
5ef79758
MD
1038
1039 if (!exclusion_string) {
1040 PERROR("Cannot allocate exclusion_string");
1041 error = 1;
1042 goto end;
1043 }
9c48cab3 1044 MSG("All %s events%s are enabled in channel %s for loglevel %s",
b9dfb167 1045 get_domain_str(dom.type),
9c48cab3 1046 exclusion_string,
85076754 1047 print_channel_name(channel_name),
025faf73 1048 opt_loglevel);
9c48cab3 1049 free(exclusion_string);
025faf73 1050 } else {
9f449915 1051 char *exclusion_string = print_exclusions(exclusion_list);
5ef79758
MD
1052
1053 if (!exclusion_string) {
1054 PERROR("Cannot allocate exclusion_string");
1055 error = 1;
1056 goto end;
1057 }
9c48cab3 1058 MSG("All %s events%s are enabled in channel %s",
b9dfb167 1059 get_domain_str(dom.type),
9c48cab3 1060 exclusion_string,
85076754 1061 print_channel_name(channel_name));
9c48cab3 1062 free(exclusion_string);
025faf73
DG
1063 }
1064 break;
1065 default:
1066 /*
1067 * We should not be here since lttng_enable_event should have
1068 * failed on the event type.
1069 */
1070 goto error;
57064ada 1071 }
f3ed775e 1072 }
89476427 1073
025faf73 1074 if (opt_filter) {
91744e14 1075 command_ret = lttng_enable_event_with_exclusions(handle, ev, channel_name,
9f449915
PP
1076 opt_filter,
1077 exclusion_list ? strutils_array_of_strings_len(exclusion_list) : 0,
1078 exclusion_list);
89476427
JRJ
1079 if (command_ret < 0) {
1080 switch (-command_ret) {
16363652 1081 case LTTNG_ERR_FILTER_EXIST:
85076754 1082 WARN("Filter on all events is already enabled"
16363652 1083 " (channel %s, session %s)",
85076754 1084 print_channel_name(channel_name), session_name);
89476427 1085 warn = 1;
16363652 1086 break;
45d5d421
CB
1087 case LTTNG_ERR_TRACE_ALREADY_STARTED:
1088 {
1089 const char *msg = "The command tried to enable an event in a new domain for a session that has already been started once.";
1090 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
1091 msg,
1092 print_channel_name(channel_name),
1093 session_name, opt_filter);
1094 error = 1;
1095 break;
1096 }
16363652 1097 default:
85076754 1098 ERR("All events: %s (channel %s, session %s, filter \'%s\')",
da3d7d0e
JRJ
1099 lttng_strerror(command_ret),
1100 command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME
85076754
MD
1101 ? print_raw_channel_name(channel_name)
1102 : print_channel_name(channel_name),
1103 session_name, opt_filter);
89476427 1104 error = 1;
16363652
DG
1105 break;
1106 }
89476427 1107 error_holder = command_ret;
16363652 1108 } else {
91744e14 1109 ev->filter = 1;
16363652
DG
1110 MSG("Filter '%s' successfully set", opt_filter);
1111 }
1112 }
89476427
JRJ
1113
1114 if (lttng_opt_mi) {
1115 /* The wildcard * is used for kernel and ust domain to
1116 * represent ALL. We copy * in event name to force the wildcard use
1117 * for kernel domain
1118 *
1119 * Note: this is strictly for semantic and printing while in
1120 * machine interface mode.
1121 */
91744e14 1122 strcpy(ev->name, "*");
89476427
JRJ
1123
1124 /* If we reach here the events are enabled */
1125 if (!error && !warn) {
91744e14 1126 ev->enabled = 1;
89476427 1127 } else {
91744e14 1128 ev->enabled = 0;
89476427
JRJ
1129 success = 0;
1130 }
91744e14 1131 ret = mi_lttng_event(writer, ev, 1, handle->domain.type);
89476427
JRJ
1132 if (ret) {
1133 ret = CMD_ERROR;
1134 goto error;
1135 }
1136
1137 /* print exclusion */
9f449915 1138 ret = mi_print_exclusion(exclusion_list);
89476427
JRJ
1139 if (ret) {
1140 ret = CMD_ERROR;
1141 goto error;
1142 }
1143
1144 /* Success ? */
1145 ret = mi_lttng_writer_write_element_bool(writer,
1146 mi_lttng_element_command_success, success);
1147 if (ret) {
1148 ret = CMD_ERROR;
1149 goto error;
1150 }
1151
1152 /* Close event element */
1153 ret = mi_lttng_writer_close_element(writer);
1154 if (ret) {
1155 ret = CMD_ERROR;
1156 goto error;
1157 }
1158 }
1159
8c9ae521 1160 goto end;
f3ed775e
DG
1161 }
1162
1163 /* Strip event list */
1164 event_name = strtok(opt_event_list, ",");
1165 while (event_name != NULL) {
6181537c 1166 /* Copy name and type of the event */
91744e14
FD
1167 strncpy(ev->name, event_name, LTTNG_SYMBOL_NAME_LEN);
1168 ev->name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
1169 ev->type = opt_event_type;
6181537c 1170
f3ed775e
DG
1171 /* Kernel tracer action */
1172 if (opt_kernel) {
1173 DBG("Enabling kernel event %s for channel %s",
85076754
MD
1174 event_name,
1175 print_channel_name(channel_name));
f3ed775e
DG
1176
1177 switch (opt_event_type) {
29c62722
MD
1178 case LTTNG_EVENT_ALL: /* Enable tracepoints and syscalls */
1179 /* If event name differs from *, select tracepoint. */
91744e14
FD
1180 if (strcmp(ev->name, "*")) {
1181 ev->type = LTTNG_EVENT_TRACEPOINT;
29c62722
MD
1182 }
1183 break;
e6ddca71 1184 case LTTNG_EVENT_TRACEPOINT:
f3ed775e 1185 break;
7d29a247 1186 case LTTNG_EVENT_PROBE:
91744e14 1187 ret = parse_probe_opts(ev, opt_probe);
49d4e302 1188 if (ret) {
cf0e5467 1189 ERR("Unable to parse probe options");
91744e14 1190 ret = CMD_ERROR;
0d63dd19
DG
1191 goto error;
1192 }
f3ed775e 1193 break;
dcabc190
FD
1194 case LTTNG_EVENT_USERSPACE_PROBE:
1195 ret = parse_userspace_probe_opts(ev, opt_userspace_probe);
1196 if (ret) {
36aa2f64
FD
1197 switch (ret) {
1198 case CMD_UNSUPPORTED:
1199 /*
1200 * Error message describing
1201 * what is not supported was
1202 * printed in the function.
1203 */
1204 break;
1205 case CMD_ERROR:
1206 default:
1207 ERR("Unable to parse userspace probe options");
1208 break;
1209 }
dcabc190
FD
1210 goto error;
1211 }
1212 break;
f3ed775e 1213 case LTTNG_EVENT_FUNCTION:
91744e14 1214 ret = parse_probe_opts(ev, opt_function);
49d4e302 1215 if (ret) {
8f0d098b 1216 ERR("Unable to parse function probe options");
91744e14 1217 ret = CMD_ERROR;
8f0d098b
MD
1218 goto error;
1219 }
1220 break;
a54bd42d 1221 case LTTNG_EVENT_SYSCALL:
91744e14 1222 ev->type = LTTNG_EVENT_SYSCALL;
c6aa2d41 1223 break;
f3ed775e 1224 default:
1ab1ea0b 1225 ret = CMD_UNDEFINED;
f3ed775e
DG
1226 goto error;
1227 }
0cda4f28 1228
0cda4f28 1229 /* kernel loglevels not implemented */
91744e14 1230 ev->loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
f3ed775e 1231 } else if (opt_userspace) { /* User-space tracer action */
300b8fd5 1232 DBG("Enabling UST event %s for channel %s, loglevel %s", event_name,
85076754 1233 print_channel_name(channel_name), opt_loglevel ? : "<all>");
2bdd86d4
MD
1234
1235 switch (opt_event_type) {
1236 case LTTNG_EVENT_ALL: /* Default behavior is tracepoint */
2bdd86d4
MD
1237 /* Fall-through */
1238 case LTTNG_EVENT_TRACEPOINT:
e4baff1e 1239 /* Copy name and type of the event */
91744e14
FD
1240 ev->type = LTTNG_EVENT_TRACEPOINT;
1241 strncpy(ev->name, event_name, LTTNG_SYMBOL_NAME_LEN);
1242 ev->name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
2bdd86d4
MD
1243 break;
1244 case LTTNG_EVENT_PROBE:
1245 case LTTNG_EVENT_FUNCTION:
2bdd86d4 1246 case LTTNG_EVENT_SYSCALL:
dcabc190 1247 case LTTNG_EVENT_USERSPACE_PROBE:
2bdd86d4 1248 default:
cc62c0c0 1249 ERR("Event type not available for user-space tracing");
4ce78777 1250 ret = CMD_UNSUPPORTED;
2bdd86d4
MD
1251 goto error;
1252 }
0cda4f28 1253
7ed70bc9 1254 if (opt_exclude) {
91744e14 1255 ev->exclusion = 1;
d5dd17fd
JI
1256 if (opt_event_type != LTTNG_EVENT_ALL && opt_event_type != LTTNG_EVENT_TRACEPOINT) {
1257 ERR("Exclusion option can only be used with tracepoint events");
1258 ret = CMD_ERROR;
1259 goto error;
1260 }
7ed70bc9 1261 /* Free previously allocated items */
9f449915
PP
1262 strutils_free_null_terminated_array_of_strings(
1263 exclusion_list);
1264 exclusion_list = NULL;
1265 ret = create_exclusion_list_and_validate(
1266 event_name, opt_exclude,
1267 &exclusion_list);
1268 if (ret) {
1269 ret = CMD_ERROR;
7ed70bc9
JI
1270 goto error;
1271 }
502bbe89
PP
1272
1273 warn_on_truncated_exclusion_names(
9f449915 1274 exclusion_list, &warn);
7ed70bc9
JI
1275 }
1276
91744e14 1277 ev->loglevel_type = opt_loglevel_type;
ed7f4083 1278 if (opt_loglevel) {
7e8f2e9c
JG
1279 enum lttng_loglevel loglevel;
1280 const int name_search_ret = loglevel_name_to_value(opt_loglevel, &loglevel);
1281
1282 if (name_search_ret == -1) {
8005f29a 1283 ERR("Unknown loglevel %s", opt_loglevel);
2f70b271 1284 ret = -LTTNG_ERR_INVALID;
8005f29a
MD
1285 goto error;
1286 }
7e8f2e9c
JG
1287
1288 ev->loglevel = (int) loglevel;
22e25b71 1289 } else {
91744e14 1290 ev->loglevel = -1;
ed7f4083 1291 }
0e115563 1292 } else if (opt_jul || opt_log4j || opt_python) {
b9dfb167
DG
1293 if (opt_event_type != LTTNG_EVENT_ALL &&
1294 opt_event_type != LTTNG_EVENT_TRACEPOINT) {
5cdb6027 1295 ERR("Event type not supported for domain.");
b9dfb167
DG
1296 ret = CMD_UNSUPPORTED;
1297 goto error;
1298 }
b2064f54 1299
91744e14 1300 ev->loglevel_type = opt_loglevel_type;
b2064f54 1301 if (opt_loglevel) {
7e8f2e9c
JG
1302 int name_search_ret;
1303
5cdb6027 1304 if (opt_jul) {
7e8f2e9c
JG
1305 enum lttng_loglevel_jul loglevel;
1306
1307 name_search_ret = loglevel_jul_name_to_value(opt_loglevel, &loglevel);
1308 ev->loglevel = (int) loglevel;
5cdb6027 1309 } else if (opt_log4j) {
7e8f2e9c
JG
1310 enum lttng_loglevel_log4j loglevel;
1311
1312 name_search_ret = loglevel_log4j_name_to_value(opt_loglevel, &loglevel);
1313 ev->loglevel = (int) loglevel;
7fefa907
JG
1314 } else {
1315 /* python domain. */
7e8f2e9c
JG
1316 enum lttng_loglevel_python loglevel;
1317
1318 name_search_ret = loglevel_python_name_to_value(opt_loglevel, &loglevel);
1319 ev->loglevel = (int) loglevel;
5cdb6027 1320 }
7e8f2e9c
JG
1321
1322 if (name_search_ret) {
b2064f54
DG
1323 ERR("Unknown loglevel %s", opt_loglevel);
1324 ret = -LTTNG_ERR_INVALID;
1325 goto error;
1326 }
1327 } else {
5cdb6027 1328 if (opt_jul) {
91744e14 1329 ev->loglevel = LTTNG_LOGLEVEL_JUL_ALL;
5cdb6027 1330 } else if (opt_log4j) {
91744e14 1331 ev->loglevel = LTTNG_LOGLEVEL_LOG4J_ALL;
0e115563 1332 } else if (opt_python) {
91744e14 1333 ev->loglevel = LTTNG_LOGLEVEL_PYTHON_DEBUG;
5cdb6027 1334 }
b2064f54 1335 }
91744e14
FD
1336 ev->type = LTTNG_EVENT_TRACEPOINT;
1337 strncpy(ev->name, event_name, LTTNG_SYMBOL_NAME_LEN);
1338 ev->name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
f3ed775e 1339 } else {
3ecec76a 1340 assert(0);
f3ed775e
DG
1341 }
1342
025faf73 1343 if (!opt_filter) {
9c48cab3
JI
1344 char *exclusion_string;
1345
89476427 1346 command_ret = lttng_enable_event_with_exclusions(handle,
91744e14 1347 ev, channel_name,
9f449915
PP
1348 NULL,
1349 exclusion_list ? strutils_array_of_strings_len(exclusion_list) : 0,
1350 exclusion_list);
1351 exclusion_string = print_exclusions(exclusion_list);
5ef79758
MD
1352 if (!exclusion_string) {
1353 PERROR("Cannot allocate exclusion_string");
1354 error = 1;
1355 goto end;
1356 }
89476427 1357 if (command_ret < 0) {
025faf73 1358 /* Turn ret to positive value to handle the positive error code */
89476427 1359 switch (-command_ret) {
025faf73 1360 case LTTNG_ERR_KERN_EVENT_EXIST:
9c48cab3 1361 WARN("Kernel event %s%s already enabled (channel %s, session %s)",
85076754 1362 event_name,
9c48cab3 1363 exclusion_string,
85076754 1364 print_channel_name(channel_name), session_name);
89476427 1365 warn = 1;
025faf73 1366 break;
45d5d421
CB
1367 case LTTNG_ERR_TRACE_ALREADY_STARTED:
1368 {
1369 const char *msg = "The command tried to enable an event in a new domain for a session that has already been started once.";
1370 ERR("Event %s%s: %s (channel %s, session %s)", event_name,
1371 exclusion_string,
1372 msg,
1373 print_channel_name(channel_name),
1374 session_name);
1375 error = 1;
1376 break;
1377 }
dcabc190
FD
1378 case LTTNG_ERR_SDT_PROBE_SEMAPHORE:
1379 ERR("SDT probes %s guarded by semaphores are not supported (channel %s, session %s)",
1380 event_name, print_channel_name(channel_name),
1381 session_name);
1382 error = 1;
1383 break;
025faf73 1384 default:
9c48cab3
JI
1385 ERR("Event %s%s: %s (channel %s, session %s)", event_name,
1386 exclusion_string,
da3d7d0e
JRJ
1387 lttng_strerror(command_ret),
1388 command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME
85076754
MD
1389 ? print_raw_channel_name(channel_name)
1390 : print_channel_name(channel_name),
1391 session_name);
89476427 1392 error = 1;
025faf73
DG
1393 break;
1394 }
89476427 1395 error_holder = command_ret;
025faf73 1396 } else {
8274eeba
AB
1397 switch (dom.type) {
1398 case LTTNG_DOMAIN_KERNEL:
1399 case LTTNG_DOMAIN_UST:
49ceaa70 1400 MSG("%s event %s%s created in channel %s",
8274eeba
AB
1401 get_domain_str(dom.type),
1402 event_name,
1403 exclusion_string,
1404 print_channel_name(channel_name));
1405 break;
1406 case LTTNG_DOMAIN_JUL:
1407 case LTTNG_DOMAIN_LOG4J:
1408 case LTTNG_DOMAIN_PYTHON:
1409 /*
1410 * Don't print the default channel
1411 * name for agent domains.
1412 */
895707da 1413 MSG("%s event %s%s enabled",
8274eeba
AB
1414 get_domain_str(dom.type),
1415 event_name,
1416 exclusion_string);
1417 break;
1418 default:
1419 assert(0);
49ceaa70 1420 }
42224349 1421 }
9c48cab3 1422 free(exclusion_string);
6181537c 1423 }
025faf73
DG
1424
1425 if (opt_filter) {
9c48cab3
JI
1426 char *exclusion_string;
1427
89476427 1428 /* Filter present */
91744e14 1429 ev->filter = 1;
89476427 1430
91744e14 1431 command_ret = lttng_enable_event_with_exclusions(handle, ev, channel_name,
9f449915
PP
1432 opt_filter,
1433 exclusion_list ? strutils_array_of_strings_len(exclusion_list) : 0,
1434 exclusion_list);
1435 exclusion_string = print_exclusions(exclusion_list);
5ef79758
MD
1436 if (!exclusion_string) {
1437 PERROR("Cannot allocate exclusion_string");
1438 error = 1;
1439 goto end;
1440 }
89476427
JRJ
1441 if (command_ret < 0) {
1442 switch (-command_ret) {
7671f53c 1443 case LTTNG_ERR_FILTER_EXIST:
9c48cab3 1444 WARN("Filter on event %s%s is already enabled"
7671f53c 1445 " (channel %s, session %s)",
85076754 1446 event_name,
9c48cab3 1447 exclusion_string,
85076754 1448 print_channel_name(channel_name), session_name);
89476427 1449 warn = 1;
7671f53c 1450 break;
45d5d421
CB
1451 case LTTNG_ERR_TRACE_ALREADY_STARTED:
1452 {
1453 const char *msg = "The command tried to enable an event in a new domain for a session that has already been started once.";
91744e14 1454 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev->name,
45d5d421
CB
1455 exclusion_string,
1456 msg,
1457 print_channel_name(channel_name),
1458 session_name, opt_filter);
1459 error = 1;
1460 break;
1461 }
7671f53c 1462 default:
91744e14 1463 ERR("Event %s%s: %s (channel %s, session %s, filter \'%s\')", ev->name,
9c48cab3 1464 exclusion_string,
da3d7d0e
JRJ
1465 lttng_strerror(command_ret),
1466 command_ret == -LTTNG_ERR_NEED_CHANNEL_NAME
85076754
MD
1467 ? print_raw_channel_name(channel_name)
1468 : print_channel_name(channel_name),
1469 session_name, opt_filter);
89476427 1470 error = 1;
7671f53c
CB
1471 break;
1472 }
89476427
JRJ
1473 error_holder = command_ret;
1474
16363652 1475 } else {
9c48cab3
JI
1476 MSG("Event %s%s: Filter '%s' successfully set",
1477 event_name, exclusion_string,
1478 opt_filter);
53a80697 1479 }
9c48cab3 1480 free(exclusion_string);
53a80697 1481 }
6181537c 1482
89476427
JRJ
1483 if (lttng_opt_mi) {
1484 if (command_ret) {
1485 success = 0;
91744e14 1486 ev->enabled = 0;
89476427 1487 } else {
91744e14 1488 ev->enabled = 1;
89476427
JRJ
1489 }
1490
91744e14 1491 ret = mi_lttng_event(writer, ev, 1, handle->domain.type);
89476427
JRJ
1492 if (ret) {
1493 ret = CMD_ERROR;
1494 goto error;
1495 }
1496
1497 /* print exclusion */
9f449915 1498 ret = mi_print_exclusion(exclusion_list);
89476427
JRJ
1499 if (ret) {
1500 ret = CMD_ERROR;
1501 goto error;
1502 }
1503
1504 /* Success ? */
1505 ret = mi_lttng_writer_write_element_bool(writer,
1506 mi_lttng_element_command_success, success);
1507 if (ret) {
1508 ret = CMD_ERROR;
1509 goto end;
1510 }
1511
1512 /* Close event element */
1513 ret = mi_lttng_writer_close_element(writer);
1514 if (ret) {
1515 ret = CMD_ERROR;
1516 goto end;
1517 }
1518 }
1519
f3ed775e
DG
1520 /* Next event */
1521 event_name = strtok(NULL, ",");
89476427
JRJ
1522 /* Reset warn, error and success */
1523 success = 1;
f3ed775e
DG
1524 }
1525
8c9ae521 1526end:
89476427
JRJ
1527 /* Close Mi */
1528 if (lttng_opt_mi) {
1529 /* Close events element */
1530 ret = mi_lttng_writer_close_element(writer);
1531 if (ret) {
1532 ret = CMD_ERROR;
1533 goto error;
1534 }
1535 }
f3ed775e 1536error:
ae856491
DG
1537 if (warn) {
1538 ret = CMD_WARNING;
1539 }
89476427
JRJ
1540 if (error) {
1541 ret = CMD_ERROR;
1542 }
cd80958d 1543 lttng_destroy_handle(handle);
9f449915 1544 strutils_free_null_terminated_array_of_strings(exclusion_list);
7ed70bc9 1545
89476427
JRJ
1546 /* Overwrite ret with error_holder if there was an actual error with
1547 * enabling an event.
1548 */
1549 ret = error_holder ? error_holder : ret;
1550
91744e14 1551 lttng_event_destroy(ev);
f3ed775e
DG
1552 return ret;
1553}
1554
1555/*
6181537c 1556 * Add event to trace session
f3ed775e
DG
1557 */
1558int cmd_enable_events(int argc, const char **argv)
1559{
89476427 1560 int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1;
f3ed775e 1561 static poptContext pc;
cd80958d 1562 char *session_name = NULL;
68c7f6e5 1563 const char *leftover = NULL;
de044b7a 1564 int event_type = -1;
f3ed775e
DG
1565
1566 pc = poptGetContext(NULL, argc, argv, long_options, 0);
1567 poptReadDefaultConfig(pc, 0);
1568
1569 /* Default event type */
7a3d1328 1570 opt_event_type = LTTNG_EVENT_ALL;
f3ed775e
DG
1571
1572 while ((opt = poptGetNextOpt(pc)) != -1) {
1573 switch (opt) {
1574 case OPT_HELP:
4ba92f18 1575 SHOW_HELP();
f3ed775e 1576 goto end;
f3ed775e 1577 case OPT_TRACEPOINT:
e6ddca71 1578 opt_event_type = LTTNG_EVENT_TRACEPOINT;
f3ed775e 1579 break;
cf0e5467 1580 case OPT_PROBE:
7d29a247 1581 opt_event_type = LTTNG_EVENT_PROBE;
f3ed775e 1582 break;
dcabc190
FD
1583 case OPT_USERSPACE_PROBE:
1584 opt_event_type = LTTNG_EVENT_USERSPACE_PROBE;
1585 break;
f3ed775e
DG
1586 case OPT_FUNCTION:
1587 opt_event_type = LTTNG_EVENT_FUNCTION;
8f0d098b 1588 break;
a54bd42d
MD
1589 case OPT_SYSCALL:
1590 opt_event_type = LTTNG_EVENT_SYSCALL;
0133c199 1591 break;
eeac7d46
MD
1592 case OPT_USERSPACE:
1593 opt_userspace = 1;
eeac7d46 1594 break;
0cda4f28 1595 case OPT_LOGLEVEL:
8005f29a 1596 opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_RANGE;
0cda4f28
MD
1597 opt_loglevel = poptGetOptArg(pc);
1598 break;
1599 case OPT_LOGLEVEL_ONLY:
8005f29a 1600 opt_loglevel_type = LTTNG_EVENT_LOGLEVEL_SINGLE;
0cda4f28 1601 opt_loglevel = poptGetOptArg(pc);
13dce3b7 1602 break;
679b4943
SM
1603 case OPT_LIST_OPTIONS:
1604 list_cmd_options(stdout, long_options);
679b4943 1605 goto end;
53a80697
MD
1606 case OPT_FILTER:
1607 break;
fac3366c
JI
1608 case OPT_EXCLUDE:
1609 break;
f3ed775e 1610 default:
f3ed775e
DG
1611 ret = CMD_UNDEFINED;
1612 goto end;
1613 }
de044b7a
DG
1614
1615 /* Validate event type. Multiple event type are not supported. */
1616 if (event_type == -1) {
1617 event_type = opt_event_type;
1618 } else {
1619 if (event_type != opt_event_type) {
1620 ERR("Multiple event type not supported.");
1621 ret = CMD_ERROR;
1622 goto end;
1623 }
1624 }
f3ed775e
DG
1625 }
1626
3ecec76a 1627 ret = print_missing_or_multiple_domains(
3533d06b
JG
1628 opt_kernel + opt_userspace + opt_jul + opt_log4j +
1629 opt_python,
1630 true);
3ecec76a
PP
1631 if (ret) {
1632 ret = CMD_ERROR;
1633 goto end;
1634 }
1635
89476427
JRJ
1636 /* Mi check */
1637 if (lttng_opt_mi) {
1638 writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
1639 if (!writer) {
1640 ret = -LTTNG_ERR_NOMEM;
1641 goto end;
1642 }
1643
1644 /* Open command element */
1645 ret = mi_lttng_writer_command_open(writer,
1646 mi_lttng_element_command_enable_event);
1647 if (ret) {
1648 ret = CMD_ERROR;
1649 goto end;
1650 }
1651
1652 /* Open output element */
1653 ret = mi_lttng_writer_open_element(writer,
1654 mi_lttng_element_command_output);
1655 if (ret) {
1656 ret = CMD_ERROR;
1657 goto end;
1658 }
1659 }
1660
f3ed775e
DG
1661 opt_event_list = (char*) poptGetArg(pc);
1662 if (opt_event_list == NULL && opt_enable_all == 0) {
1663 ERR("Missing event name(s).\n");
ca1c3607 1664 ret = CMD_ERROR;
f3ed775e
DG
1665 goto end;
1666 }
1667
68c7f6e5
JD
1668 leftover = poptGetArg(pc);
1669 if (leftover) {
1670 ERR("Unknown argument: %s", leftover);
1671 ret = CMD_ERROR;
1672 goto end;
1673 }
1674
cd80958d
DG
1675 if (!opt_session_name) {
1676 session_name = get_session_name();
1677 if (session_name == NULL) {
89476427
JRJ
1678 command_ret = CMD_ERROR;
1679 success = 0;
1680 goto mi_closing;
cd80958d
DG
1681 }
1682 } else {
1683 session_name = opt_session_name;
1684 }
1685
89476427
JRJ
1686 command_ret = enable_events(session_name);
1687 if (command_ret) {
1688 success = 0;
1689 goto mi_closing;
1690 }
1691
1692mi_closing:
1693 /* Mi closing */
1694 if (lttng_opt_mi) {
1695 /* Close output element */
1696 ret = mi_lttng_writer_close_element(writer);
1697 if (ret) {
1698 ret = CMD_ERROR;
1699 goto end;
1700 }
1701
1702 ret = mi_lttng_writer_write_element_bool(writer,
1703 mi_lttng_element_command_success, success);
1704 if (ret) {
1705 ret = CMD_ERROR;
1706 goto end;
1707 }
1708
1709 /* Command element close */
1710 ret = mi_lttng_writer_command_close(writer);
1711 if (ret) {
1712 ret = CMD_ERROR;
1713 goto end;
1714 }
1715 }
f3ed775e
DG
1716
1717end:
89476427
JRJ
1718 /* Mi clean-up */
1719 if (writer && mi_lttng_writer_destroy(writer)) {
1720 /* Preserve original error code */
1721 ret = ret ? ret : LTTNG_ERR_MI_IO_FAIL;
1722 }
1723
cd80958d
DG
1724 if (opt_session_name == NULL) {
1725 free(session_name);
1726 }
1727
89476427
JRJ
1728 /* Overwrite ret if an error occurred in enable_events */
1729 ret = command_ret ? command_ret : ret;
1730
ca1c3607 1731 poptFreeContext(pc);
f3ed775e
DG
1732 return ret;
1733}
9f449915 1734
This page took 0.148959 seconds and 4 git commands to generate.