2 * Copyright (C) 2011 EfficiOS Inc.
4 * SPDX-License-Identifier: GPL-2.0-only
14 #include <sys/types.h>
17 #include <common/mi-lttng.hpp>
18 #include <lttng/domain-internal.hpp>
20 #include "../command.hpp"
22 static int opt_kernel
;
23 static char *opt_channel_name
;
24 static char *opt_session_name
;
25 static int opt_userspace
;
26 static int opt_disable_all
;
29 static int opt_python
;
30 static int opt_event_type
;
32 #ifdef LTTNG_EMBED_HELP
33 static const char help_msg
[] =
34 #include <lttng-disable-event.1.h>
48 static struct lttng_handle
*handle
;
49 static struct mi_writer
*writer
;
51 static struct poptOption long_options
[] = {
52 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
53 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
54 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
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},
57 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
58 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
59 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
60 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
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},
67 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
72 const char *print_channel_name(const char *name
)
74 return name
? : DEFAULT_CHANNEL_NAME
;
78 const char *print_raw_channel_name(const char *name
)
80 return name
? : "<default>";
84 const char *print_event_type(const enum lttng_event_type ev_type
)
89 case LTTNG_EVENT_TRACEPOINT
:
91 case LTTNG_EVENT_PROBE
:
93 case LTTNG_EVENT_FUNCTION
:
95 case LTTNG_EVENT_FUNCTION_ENTRY
:
96 return "function entry";
97 case LTTNG_EVENT_SYSCALL
:
104 /* Mi print a partial event.
108 static int mi_print_event(const char *event_name
, int enabled
, int success
)
112 LTTNG_ASSERT(writer
);
113 LTTNG_ASSERT(event_name
);
115 /* Open event element */
116 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
121 /* Print the name of event */
122 ret
= mi_lttng_writer_write_element_string(writer
,
123 config_element_name
, event_name
);
128 /* Print enabled ? */
129 ret
= mi_lttng_writer_write_element_bool(writer
,
130 config_element_enabled
, enabled
);
136 ret
= mi_lttng_writer_write_element_bool(writer
,
137 mi_lttng_element_command_success
, success
);
142 /* Close event element */
143 ret
= mi_lttng_writer_close_element(writer
);
151 * Disabling event using the lttng API.
153 static int disable_events(char *session_name
, char *event_list
)
155 int ret
= CMD_SUCCESS
, warn
= 0, command_ret
= CMD_SUCCESS
;
156 int enabled
= 1, success
= 1;
157 char *event_name
, *channel_name
= NULL
;
158 struct lttng_domain dom
;
159 struct lttng_event event
;
161 memset(&dom
, 0, sizeof(dom
));
163 /* Create lttng domain */
165 dom
.type
= LTTNG_DOMAIN_KERNEL
;
166 } else if (opt_userspace
) {
167 dom
.type
= LTTNG_DOMAIN_UST
;
168 } else if (opt_jul
) {
169 dom
.type
= LTTNG_DOMAIN_JUL
;
170 } else if (opt_log4j
) {
171 dom
.type
= LTTNG_DOMAIN_LOG4J
;
172 } else if (opt_python
) {
173 dom
.type
= LTTNG_DOMAIN_PYTHON
;
175 /* Checked by the caller. */
179 channel_name
= opt_channel_name
;
181 handle
= lttng_create_handle(session_name
, &dom
);
182 if (handle
== NULL
) {
187 /* Mi print the channel and open the events element */
189 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
195 ret
= mi_lttng_writer_write_element_string(writer
,
196 config_element_name
, print_channel_name(channel_name
));
202 /* Open events element */
203 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
210 memset(&event
, 0, sizeof(event
));
211 /* Set default loglevel to any/unknown */
214 /* opt_event_type contain the event type to disable at this point */
215 event
.type
= (lttng_event_type
) opt_event_type
;
217 if (opt_disable_all
) {
218 command_ret
= lttng_disable_event_ext(handle
, &event
, channel_name
, NULL
);
219 if (command_ret
< 0) {
220 ERR("%s", lttng_strerror(command_ret
));
227 MSG("All %s events of type %s are disabled in channel %s",
228 lttng_domain_type_str(dom
.type
),
229 print_event_type((lttng_event_type
) opt_event_type
),
230 print_channel_name(channel_name
));
234 ret
= mi_print_event("*", enabled
, success
);
241 /* Strip event list */
242 event_name
= strtok(event_list
, ",");
243 while (event_name
!= NULL
) {
244 DBG("Disabling event %s", event_name
);
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
);
249 if (command_ret
< 0) {
250 ERR("%s of type %s : %s (channel %s, session %s)",
252 print_event_type((lttng_event_type
) opt_event_type
),
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
),
261 * If an error occurred we assume that the event is still
266 MSG("%s %s of type %s disabled in channel %s for session %s",
267 lttng_domain_type_str(dom
.type
),
269 print_event_type((lttng_event_type
) opt_event_type
),
270 print_channel_name(channel_name
),
277 ret
= mi_print_event(event_name
, enabled
, success
);
285 event_name
= strtok(NULL
, ",");
291 /* Close events element and channel element */
292 ret
= mi_lttng_close_multi_element(writer
, 2);
298 /* if there is already an error preserve it */
303 /* Overwrite ret if an error occurred */
304 ret
= command_ret
? command_ret
: ret
;
306 lttng_destroy_handle(handle
);
313 * Disable event to trace session
315 int cmd_disable_events(int argc
, const char **argv
)
317 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
318 static poptContext pc
;
319 char *session_name
= NULL
;
320 char *event_list
= NULL
;
321 const char *arg_event_list
= NULL
;
322 const char *leftover
= NULL
;
325 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
326 poptReadDefaultConfig(pc
, 0);
328 /* Default event type */
329 opt_event_type
= LTTNG_EVENT_ALL
;
331 while ((opt
= poptGetNextOpt(pc
)) != -1) {
336 case OPT_TYPE_SYSCALL
:
337 opt_event_type
= LTTNG_EVENT_SYSCALL
;
339 case OPT_TYPE_TRACEPOINT
:
340 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
343 opt_event_type
= LTTNG_EVENT_PROBE
;
345 case OPT_TYPE_FUNCTION
:
346 opt_event_type
= LTTNG_EVENT_FUNCTION
;
349 opt_event_type
= LTTNG_EVENT_ALL
;
351 case OPT_LIST_OPTIONS
:
352 list_cmd_options(stdout
, long_options
);
359 /* Validate event type. Multiple event type are not supported. */
360 if (event_type
== -1) {
361 event_type
= opt_event_type
;
363 if (event_type
!= opt_event_type
) {
364 ERR("Multiple event type not supported.");
371 ret
= print_missing_or_multiple_domains(
372 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+
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
) {
383 ERR("Disabling userspace and agent (-j | -l | -p) event(s) based on instrumentation type is not supported.\n");
388 arg_event_list
= poptGetArg(pc
);
389 if (arg_event_list
== NULL
&& opt_disable_all
== 0) {
390 ERR("Missing event name(s).\n");
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)");
404 leftover
= poptGetArg(pc
);
406 ERR("Unknown argument: %s", leftover
);
411 if (!opt_session_name
) {
412 session_name
= get_session_name();
413 if (session_name
== NULL
) {
418 session_name
= opt_session_name
;
423 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
425 ret
= -LTTNG_ERR_NOMEM
;
429 /* Open command element */
430 ret
= mi_lttng_writer_command_open(writer
,
431 mi_lttng_element_command_disable_event
);
437 /* Open output element */
438 ret
= mi_lttng_writer_open_element(writer
,
439 mi_lttng_element_command_output
);
446 command_ret
= disable_events(session_name
, event_list
);
453 /* Close output element */
454 ret
= mi_lttng_writer_close_element(writer
);
460 ret
= mi_lttng_writer_write_element_bool(writer
,
461 mi_lttng_element_command_success
, success
);
467 /* Command element close */
468 ret
= mi_lttng_writer_command_close(writer
);
476 if (!opt_session_name
&& session_name
) {
483 if (writer
&& mi_lttng_writer_destroy(writer
)) {
484 /* Preserve original error code */
485 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
488 /* Overwrite ret if an error occurred in disable_events */
489 ret
= command_ret
? command_ret
: ret
;