Commit | Line | Data |
---|---|---|
e953ef25 | 1 | /* |
21cf9b6b | 2 | * Copyright (C) 2011 EfficiOS Inc. |
e953ef25 | 3 | * |
ab5be9fa | 4 | * SPDX-License-Identifier: GPL-2.0-only |
e953ef25 | 5 | * |
e953ef25 DG |
6 | */ |
7 | ||
6c1c0768 | 8 | #define _LGPL_SOURCE |
28ab034a JG |
9 | #include "../command.hpp" |
10 | ||
11 | #include <common/mi-lttng.hpp> | |
12 | ||
13 | #include <lttng/domain-internal.hpp> | |
14 | ||
e953ef25 DG |
15 | #include <popt.h> |
16 | #include <stdio.h> | |
17 | #include <stdlib.h> | |
18 | #include <string.h> | |
19 | #include <sys/stat.h> | |
20 | #include <sys/types.h> | |
21 | #include <unistd.h> | |
e4d484a5 | 22 | |
9730260e | 23 | static int opt_kernel; |
e953ef25 | 24 | static char *opt_channel_name; |
5440dc42 | 25 | static char *opt_session_name; |
e953ef25 DG |
26 | static int opt_userspace; |
27 | static int opt_disable_all; | |
b9dfb167 | 28 | static int opt_jul; |
5cdb6027 | 29 | static int opt_log4j; |
0e115563 | 30 | static int opt_python; |
6e911cad | 31 | static int opt_event_type; |
e953ef25 | 32 | |
4fc83d94 PP |
33 | #ifdef LTTNG_EMBED_HELP |
34 | static const char help_msg[] = | |
35 | #include <lttng-disable-event.1.h> | |
28ab034a | 36 | ; |
4fc83d94 PP |
37 | #endif |
38 | ||
e953ef25 DG |
39 | enum { |
40 | OPT_HELP = 1, | |
9550ee81 JR |
41 | OPT_TYPE_SYSCALL, |
42 | OPT_TYPE_TRACEPOINT, | |
43 | OPT_TYPE_PROBE, | |
44 | OPT_TYPE_FUNCTION, | |
45 | OPT_TYPE_ALL, | |
679b4943 | 46 | OPT_LIST_OPTIONS, |
e953ef25 DG |
47 | }; |
48 | ||
cd80958d | 49 | static struct lttng_handle *handle; |
e4d484a5 | 50 | static struct mi_writer *writer; |
cd80958d | 51 | |
e953ef25 DG |
52 | static struct poptOption long_options[] = { |
53 | /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ | |
cd9adb8b JG |
54 | { "help", 'h', POPT_ARG_NONE, nullptr, OPT_HELP, nullptr, nullptr }, |
55 | { "session", 's', POPT_ARG_STRING, &opt_session_name, 0, nullptr, nullptr }, | |
56 | { "all-events", 'a', POPT_ARG_VAL, &opt_disable_all, 1, nullptr, nullptr }, | |
57 | { "channel", 'c', POPT_ARG_STRING, &opt_channel_name, 0, nullptr, nullptr }, | |
58 | { "jul", 'j', POPT_ARG_VAL, &opt_jul, 1, nullptr, nullptr }, | |
59 | { "log4j", 'l', POPT_ARG_VAL, &opt_log4j, 1, nullptr, nullptr }, | |
60 | { "python", 'p', POPT_ARG_VAL, &opt_python, 1, nullptr, nullptr }, | |
61 | { "kernel", 'k', POPT_ARG_VAL, &opt_kernel, 1, nullptr, nullptr }, | |
62 | { "userspace", 'u', POPT_ARG_VAL, &opt_userspace, 1, nullptr, nullptr }, | |
63 | { "syscall", 0, POPT_ARG_NONE, nullptr, OPT_TYPE_SYSCALL, nullptr, nullptr }, | |
64 | { "probe", 0, POPT_ARG_NONE, nullptr, OPT_TYPE_PROBE, nullptr, nullptr }, | |
65 | { "tracepoint", 0, POPT_ARG_NONE, nullptr, OPT_TYPE_TRACEPOINT, nullptr, nullptr }, | |
66 | { "function", 0, POPT_ARG_NONE, nullptr, OPT_TYPE_FUNCTION, nullptr, nullptr }, | |
67 | { "all", 0, POPT_ARG_NONE, nullptr, OPT_TYPE_ALL, nullptr, nullptr }, | |
68 | { "list-options", 0, POPT_ARG_NONE, nullptr, OPT_LIST_OPTIONS, nullptr, nullptr }, | |
69 | { nullptr, 0, 0, nullptr, 0, nullptr, nullptr } | |
e953ef25 DG |
70 | }; |
71 | ||
28ab034a | 72 | static const char *print_channel_name(const char *name) |
85076754 | 73 | { |
28ab034a | 74 | return name ?: DEFAULT_CHANNEL_NAME; |
85076754 MD |
75 | } |
76 | ||
28ab034a | 77 | static const char *print_raw_channel_name(const char *name) |
85076754 | 78 | { |
28ab034a | 79 | return name ?: "<default>"; |
85076754 MD |
80 | } |
81 | ||
28ab034a | 82 | static const char *print_event_type(const enum lttng_event_type ev_type) |
9550ee81 JR |
83 | { |
84 | switch (ev_type) { | |
85 | case LTTNG_EVENT_ALL: | |
86 | return "any"; | |
87 | case LTTNG_EVENT_TRACEPOINT: | |
88 | return "tracepoint"; | |
89 | case LTTNG_EVENT_PROBE: | |
90 | return "probe"; | |
91 | case LTTNG_EVENT_FUNCTION: | |
92 | return "function"; | |
93 | case LTTNG_EVENT_FUNCTION_ENTRY: | |
94 | return "function entry"; | |
95 | case LTTNG_EVENT_SYSCALL: | |
96 | return "syscall"; | |
97 | default: | |
98 | return ""; | |
99 | } | |
100 | } | |
101 | ||
e4d484a5 JRJ |
102 | /* Mi print a partial event. |
103 | * enabled is 0 or 1 | |
104 | * success is 0 or 1 | |
105 | */ | |
b53d4e59 | 106 | static int mi_print_event(const char *event_name, int enabled, int success) |
e4d484a5 JRJ |
107 | { |
108 | int ret; | |
109 | ||
a0377dfe FD |
110 | LTTNG_ASSERT(writer); |
111 | LTTNG_ASSERT(event_name); | |
e4d484a5 JRJ |
112 | |
113 | /* Open event element */ | |
114 | ret = mi_lttng_writer_open_element(writer, config_element_event); | |
115 | if (ret) { | |
116 | goto end; | |
117 | } | |
118 | ||
119 | /* Print the name of event */ | |
28ab034a | 120 | ret = mi_lttng_writer_write_element_string(writer, config_element_name, event_name); |
e4d484a5 JRJ |
121 | if (ret) { |
122 | goto end; | |
123 | } | |
124 | ||
125 | /* Print enabled ? */ | |
28ab034a | 126 | ret = mi_lttng_writer_write_element_bool(writer, config_element_enabled, enabled); |
e4d484a5 JRJ |
127 | if (ret) { |
128 | goto end; | |
129 | } | |
130 | ||
131 | /* Success ? */ | |
28ab034a | 132 | ret = mi_lttng_writer_write_element_bool(writer, mi_lttng_element_command_success, success); |
e4d484a5 JRJ |
133 | if (ret) { |
134 | goto end; | |
135 | } | |
136 | ||
137 | /* Close event element */ | |
138 | ret = mi_lttng_writer_close_element(writer); | |
139 | end: | |
140 | return ret; | |
141 | } | |
142 | ||
e953ef25 DG |
143 | /* |
144 | * disable_events | |
145 | * | |
146 | * Disabling event using the lttng API. | |
147 | */ | |
5b915816 | 148 | static int disable_events(char *session_name, char *event_list) |
e953ef25 | 149 | { |
66cefebd JG |
150 | enum cmd_error_code ret = CMD_SUCCESS, command_ret = CMD_SUCCESS; |
151 | bool enabled = true, success = true, warn = false; | |
cd9adb8b | 152 | char *event_name, *channel_name = nullptr; |
7d29a247 | 153 | struct lttng_domain dom; |
6e911cad | 154 | struct lttng_event event; |
e953ef25 | 155 | |
441c16a7 MD |
156 | memset(&dom, 0, sizeof(dom)); |
157 | ||
d78d6610 | 158 | /* Create lttng domain */ |
7d29a247 DG |
159 | if (opt_kernel) { |
160 | dom.type = LTTNG_DOMAIN_KERNEL; | |
d78d6610 | 161 | } else if (opt_userspace) { |
9730260e | 162 | dom.type = LTTNG_DOMAIN_UST; |
b9dfb167 DG |
163 | } else if (opt_jul) { |
164 | dom.type = LTTNG_DOMAIN_JUL; | |
5cdb6027 DG |
165 | } else if (opt_log4j) { |
166 | dom.type = LTTNG_DOMAIN_LOG4J; | |
0e115563 DG |
167 | } else if (opt_python) { |
168 | dom.type = LTTNG_DOMAIN_PYTHON; | |
9730260e | 169 | } else { |
3ecec76a | 170 | /* Checked by the caller. */ |
a0377dfe | 171 | abort(); |
7d29a247 DG |
172 | } |
173 | ||
85076754 | 174 | channel_name = opt_channel_name; |
ae856491 | 175 | |
cd80958d | 176 | handle = lttng_create_handle(session_name, &dom); |
cd9adb8b | 177 | if (handle == nullptr) { |
66cefebd | 178 | ret = CMD_ERROR; |
cd80958d DG |
179 | goto error; |
180 | } | |
181 | ||
e4d484a5 JRJ |
182 | /* Mi print the channel and open the events element */ |
183 | if (lttng_opt_mi) { | |
66cefebd JG |
184 | int mi_ret = mi_lttng_writer_open_element(writer, config_element_channel); |
185 | if (mi_ret) { | |
e4d484a5 JRJ |
186 | ret = CMD_ERROR; |
187 | goto end; | |
e953ef25 DG |
188 | } |
189 | ||
66cefebd | 190 | mi_ret = mi_lttng_writer_write_element_string( |
28ab034a | 191 | writer, config_element_name, print_channel_name(channel_name)); |
66cefebd | 192 | if (mi_ret) { |
e4d484a5 JRJ |
193 | ret = CMD_ERROR; |
194 | goto end; | |
195 | } | |
196 | ||
197 | /* Open events element */ | |
66cefebd JG |
198 | mi_ret = mi_lttng_writer_open_element(writer, config_element_events); |
199 | if (mi_ret) { | |
e4d484a5 JRJ |
200 | ret = CMD_ERROR; |
201 | goto end; | |
202 | } | |
e953ef25 DG |
203 | } |
204 | ||
6e911cad | 205 | memset(&event, 0, sizeof(event)); |
9b7431cf JG |
206 | /* Set default loglevel to any/unknown */ |
207 | event.loglevel = -1; | |
208 | ||
9550ee81 | 209 | /* opt_event_type contain the event type to disable at this point */ |
48a40005 | 210 | event.type = (lttng_event_type) opt_event_type; |
6e911cad | 211 | |
e4d484a5 | 212 | if (opt_disable_all) { |
66cefebd | 213 | const int disable_ret = lttng_disable_event_ext(handle, &event, channel_name, nullptr); |
e4d484a5 | 214 | |
66cefebd JG |
215 | if (disable_ret < 0) { |
216 | ERR("%s", lttng_strerror(command_ret)); | |
217 | command_ret = CMD_ERROR; | |
218 | enabled = true; | |
219 | success = false; | |
9730260e | 220 | } else { |
66cefebd JG |
221 | enabled = false; |
222 | success = true; | |
9550ee81 | 223 | MSG("All %s events of type %s are disabled in channel %s", |
28ab034a JG |
224 | lttng_domain_type_str(dom.type), |
225 | print_event_type((lttng_event_type) opt_event_type), | |
226 | print_channel_name(channel_name)); | |
9730260e DG |
227 | } |
228 | ||
e4d484a5 | 229 | if (lttng_opt_mi) { |
66cefebd JG |
230 | const int mi_ret = mi_print_event("*", enabled, success); |
231 | ||
232 | if (mi_ret) { | |
e4d484a5 JRJ |
233 | ret = CMD_ERROR; |
234 | goto error; | |
235 | } | |
236 | } | |
237 | } else { | |
238 | /* Strip event list */ | |
5b915816 | 239 | event_name = strtok(event_list, ","); |
cd9adb8b | 240 | while (event_name != nullptr) { |
e4d484a5 | 241 | DBG("Disabling event %s", event_name); |
e953ef25 | 242 | |
6e911cad MD |
243 | strncpy(event.name, event_name, sizeof(event.name)); |
244 | event.name[sizeof(event.name) - 1] = '\0'; | |
66cefebd | 245 | const int disable_ret = |
cd9adb8b | 246 | lttng_disable_event_ext(handle, &event, channel_name, nullptr); |
66cefebd | 247 | if (disable_ret < 0) { |
9550ee81 | 248 | ERR("%s of type %s : %s (channel %s, session %s)", |
28ab034a JG |
249 | event_name, |
250 | print_event_type((lttng_event_type) opt_event_type), | |
ed0c6be4 JG |
251 | lttng_strerror(disable_ret), |
252 | disable_ret == -LTTNG_ERR_NEED_CHANNEL_NAME ? | |
28ab034a JG |
253 | print_raw_channel_name(channel_name) : |
254 | print_channel_name(channel_name), | |
255 | session_name); | |
66cefebd JG |
256 | warn = true; |
257 | success = false; | |
e4d484a5 | 258 | /* |
6e911cad MD |
259 | * If an error occurred we assume that the event is still |
260 | * enabled. | |
e4d484a5 | 261 | */ |
66cefebd JG |
262 | enabled = true; |
263 | command_ret = CMD_ERROR; | |
e4d484a5 | 264 | } else { |
9550ee81 | 265 | MSG("%s %s of type %s disabled in channel %s for session %s", |
28ab034a JG |
266 | lttng_domain_type_str(dom.type), |
267 | event_name, | |
268 | print_event_type((lttng_event_type) opt_event_type), | |
269 | print_channel_name(channel_name), | |
270 | session_name); | |
66cefebd JG |
271 | success = true; |
272 | enabled = false; | |
e4d484a5 JRJ |
273 | } |
274 | ||
275 | if (lttng_opt_mi) { | |
66cefebd JG |
276 | const int mi_ret = mi_print_event(event_name, enabled, success); |
277 | ||
278 | if (mi_ret) { | |
e4d484a5 JRJ |
279 | ret = CMD_ERROR; |
280 | goto error; | |
281 | } | |
282 | } | |
283 | ||
284 | /* Next event */ | |
cd9adb8b | 285 | event_name = strtok(nullptr, ","); |
e4d484a5 JRJ |
286 | } |
287 | } | |
ae856491 | 288 | |
9730260e | 289 | end: |
e4d484a5 JRJ |
290 | if (lttng_opt_mi) { |
291 | /* Close events element and channel element */ | |
66cefebd JG |
292 | const int mi_ret = mi_lttng_close_multi_element(writer, 2); |
293 | ||
294 | if (mi_ret) { | |
e4d484a5 JRJ |
295 | ret = CMD_ERROR; |
296 | } | |
297 | } | |
e953ef25 | 298 | error: |
e4d484a5 JRJ |
299 | /* if there is already an error preserve it */ |
300 | if (warn && !ret) { | |
ae856491 DG |
301 | ret = CMD_WARNING; |
302 | } | |
cd80958d | 303 | |
e4d484a5 JRJ |
304 | /* Overwrite ret if an error occurred */ |
305 | ret = command_ret ? command_ret : ret; | |
306 | ||
307 | lttng_destroy_handle(handle); | |
e953ef25 DG |
308 | return ret; |
309 | } | |
310 | ||
311 | /* | |
312 | * cmd_disable_events | |
313 | * | |
314 | * Disable event to trace session | |
315 | */ | |
316 | int cmd_disable_events(int argc, const char **argv) | |
317 | { | |
e4d484a5 | 318 | int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1; |
e953ef25 | 319 | static poptContext pc; |
cd9adb8b JG |
320 | char *session_name = nullptr; |
321 | char *event_list = nullptr; | |
322 | const char *arg_event_list = nullptr; | |
323 | const char *leftover = nullptr; | |
6e911cad | 324 | int event_type = -1; |
e953ef25 | 325 | |
cd9adb8b | 326 | pc = poptGetContext(nullptr, argc, argv, long_options, 0); |
e953ef25 DG |
327 | poptReadDefaultConfig(pc, 0); |
328 | ||
6e911cad MD |
329 | /* Default event type */ |
330 | opt_event_type = LTTNG_EVENT_ALL; | |
331 | ||
e953ef25 DG |
332 | while ((opt = poptGetNextOpt(pc)) != -1) { |
333 | switch (opt) { | |
334 | case OPT_HELP: | |
4ba92f18 | 335 | SHOW_HELP(); |
e953ef25 | 336 | goto end; |
9550ee81 | 337 | case OPT_TYPE_SYSCALL: |
6e911cad MD |
338 | opt_event_type = LTTNG_EVENT_SYSCALL; |
339 | break; | |
9550ee81 JR |
340 | case OPT_TYPE_TRACEPOINT: |
341 | opt_event_type = LTTNG_EVENT_TRACEPOINT; | |
342 | break; | |
343 | case OPT_TYPE_PROBE: | |
344 | opt_event_type = LTTNG_EVENT_PROBE; | |
345 | break; | |
346 | case OPT_TYPE_FUNCTION: | |
347 | opt_event_type = LTTNG_EVENT_FUNCTION; | |
348 | break; | |
349 | case OPT_TYPE_ALL: | |
350 | opt_event_type = LTTNG_EVENT_ALL; | |
351 | break; | |
679b4943 SM |
352 | case OPT_LIST_OPTIONS: |
353 | list_cmd_options(stdout, long_options); | |
679b4943 | 354 | goto end; |
e953ef25 | 355 | default: |
e953ef25 DG |
356 | ret = CMD_UNDEFINED; |
357 | goto end; | |
358 | } | |
6e911cad MD |
359 | |
360 | /* Validate event type. Multiple event type are not supported. */ | |
361 | if (event_type == -1) { | |
362 | event_type = opt_event_type; | |
363 | } else { | |
364 | if (event_type != opt_event_type) { | |
365 | ERR("Multiple event type not supported."); | |
366 | ret = CMD_ERROR; | |
367 | goto end; | |
368 | } | |
369 | } | |
e953ef25 DG |
370 | } |
371 | ||
3ecec76a | 372 | ret = print_missing_or_multiple_domains( |
28ab034a | 373 | opt_kernel + opt_userspace + opt_jul + opt_log4j + opt_python, true); |
3ecec76a PP |
374 | if (ret) { |
375 | ret = CMD_ERROR; | |
376 | goto end; | |
377 | } | |
378 | ||
9550ee81 | 379 | /* Ust and agent only support ALL event type */ |
28ab034a JG |
380 | if ((opt_userspace || opt_jul || opt_log4j || opt_python) && |
381 | opt_event_type != LTTNG_EVENT_ALL) { | |
7767963f | 382 | ERR("Disabling userspace and agent (-j | -l | -p) event(s) based on instrumentation type is not supported.\n"); |
9550ee81 JR |
383 | ret = CMD_ERROR; |
384 | goto end; | |
385 | } | |
386 | ||
5b915816 | 387 | arg_event_list = poptGetArg(pc); |
cd9adb8b | 388 | if (arg_event_list == nullptr && opt_disable_all == 0) { |
e953ef25 | 389 | ERR("Missing event name(s).\n"); |
ca1c3607 | 390 | ret = CMD_ERROR; |
e953ef25 DG |
391 | goto end; |
392 | } | |
393 | ||
5b915816 MJ |
394 | if (opt_disable_all == 0) { |
395 | event_list = strdup(arg_event_list); | |
cd9adb8b | 396 | if (event_list == nullptr) { |
5b915816 MJ |
397 | PERROR("Failed to copy event name(s)"); |
398 | ret = CMD_ERROR; | |
399 | goto end; | |
400 | } | |
401 | } | |
402 | ||
68c7f6e5 JD |
403 | leftover = poptGetArg(pc); |
404 | if (leftover) { | |
405 | ERR("Unknown argument: %s", leftover); | |
406 | ret = CMD_ERROR; | |
407 | goto end; | |
408 | } | |
409 | ||
cd80958d DG |
410 | if (!opt_session_name) { |
411 | session_name = get_session_name(); | |
cd9adb8b | 412 | if (session_name == nullptr) { |
ca1c3607 | 413 | ret = CMD_ERROR; |
cd80958d DG |
414 | goto end; |
415 | } | |
416 | } else { | |
417 | session_name = opt_session_name; | |
418 | } | |
419 | ||
e4d484a5 JRJ |
420 | /* Mi check */ |
421 | if (lttng_opt_mi) { | |
422 | writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi); | |
423 | if (!writer) { | |
424 | ret = -LTTNG_ERR_NOMEM; | |
425 | goto end; | |
426 | } | |
427 | ||
428 | /* Open command element */ | |
28ab034a | 429 | ret = mi_lttng_writer_command_open(writer, mi_lttng_element_command_disable_event); |
e4d484a5 JRJ |
430 | if (ret) { |
431 | ret = CMD_ERROR; | |
432 | goto end; | |
433 | } | |
434 | ||
435 | /* Open output element */ | |
28ab034a | 436 | ret = mi_lttng_writer_open_element(writer, mi_lttng_element_command_output); |
e4d484a5 JRJ |
437 | if (ret) { |
438 | ret = CMD_ERROR; | |
439 | goto end; | |
440 | } | |
441 | } | |
442 | ||
5b915816 | 443 | command_ret = disable_events(session_name, event_list); |
e4d484a5 JRJ |
444 | if (command_ret) { |
445 | success = 0; | |
446 | } | |
447 | ||
448 | /* Mi closing */ | |
449 | if (lttng_opt_mi) { | |
450 | /* Close output element */ | |
451 | ret = mi_lttng_writer_close_element(writer); | |
452 | if (ret) { | |
453 | ret = CMD_ERROR; | |
454 | goto end; | |
455 | } | |
456 | ||
28ab034a JG |
457 | ret = mi_lttng_writer_write_element_bool( |
458 | writer, mi_lttng_element_command_success, success); | |
e4d484a5 JRJ |
459 | if (ret) { |
460 | ret = CMD_ERROR; | |
461 | goto end; | |
462 | } | |
463 | ||
464 | /* Command element close */ | |
465 | ret = mi_lttng_writer_command_close(writer); | |
466 | if (ret) { | |
467 | ret = CMD_ERROR; | |
468 | goto end; | |
469 | } | |
470 | } | |
e953ef25 DG |
471 | |
472 | end: | |
5853fd43 DG |
473 | if (!opt_session_name && session_name) { |
474 | free(session_name); | |
475 | } | |
e4d484a5 | 476 | |
5b915816 MJ |
477 | free(event_list); |
478 | ||
e4d484a5 JRJ |
479 | /* Mi clean-up */ |
480 | if (writer && mi_lttng_writer_destroy(writer)) { | |
481 | /* Preserve original error code */ | |
482 | ret = ret ? ret : LTTNG_ERR_MI_IO_FAIL; | |
483 | } | |
484 | ||
83f4233d | 485 | /* Overwrite ret if an error occurred in disable_events */ |
e4d484a5 JRJ |
486 | ret = command_ret ? command_ret : ret; |
487 | ||
ca1c3607 | 488 | poptFreeContext(pc); |
e953ef25 DG |
489 | return ret; |
490 | } |