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