2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include <sys/types.h>
28 #include <common/mi-lttng.h>
30 #include "../command.h"
32 static char *opt_event_list
;
33 static int opt_kernel
;
34 static char *opt_channel_name
;
35 static char *opt_session_name
;
36 static int opt_userspace
;
37 static int opt_disable_all
;
40 static int opt_python
;
41 static int opt_event_type
;
53 static struct lttng_handle
*handle
;
54 static struct mi_writer
*writer
;
56 static struct poptOption long_options
[] = {
57 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
58 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
59 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
60 {"all-events", 'a', POPT_ARG_VAL
, &opt_disable_all
, 1, 0, 0},
61 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
62 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
63 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
64 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
65 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
66 {"userspace", 'u', POPT_ARG_VAL
, &opt_userspace
, 1, 0, 0},
67 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_TYPE_SYSCALL
, 0, 0},
68 {"probe", 0, POPT_ARG_NONE
, 0, OPT_TYPE_PROBE
, 0, 0},
69 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TYPE_TRACEPOINT
, 0, 0},
70 {"function", 0, POPT_ARG_NONE
, 0, OPT_TYPE_FUNCTION
, 0, 0},
71 {"all", 0, POPT_ARG_NONE
, 0, OPT_TYPE_ALL
, 0, 0},
72 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
79 static void usage(FILE *ofp
)
81 fprintf(ofp
, "usage: lttng disable-event NAME[,NAME2,...] (-k | -u | -j | -l | -p) [OPTIONS]\n");
83 fprintf(ofp
, "Options:\n");
84 fprintf(ofp
, " -h, --help Show this help\n");
85 fprintf(ofp
, " --list-options Simple listing of options\n");
86 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
87 fprintf(ofp
, " -c, --channel NAME Apply to this channel\n");
88 fprintf(ofp
, " -a, --all-events Disable all tracepoints\n");
89 fprintf(ofp
, " -k, --kernel Apply to the kernel tracer\n");
90 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
91 fprintf(ofp
, " -j, --jul Apply to Java application using JUL\n");
92 fprintf(ofp
, " -l, --log4j Apply to Java application using LOG4j\n");
93 fprintf(ofp
, " -p, --python Apply to Python application using logging\n");
95 fprintf(ofp
, "Event type options (Only supported with kernel domain):\n");
96 fprintf(ofp
, " --all All event types (default)\n");
97 fprintf(ofp
, " --tracepoint Tracepoint event\n");
98 fprintf(ofp
, " --syscall System call event\n");
99 fprintf(ofp
, " --probe Probe event\n");
100 fprintf(ofp
, " --function Function event\n");
105 const char *print_channel_name(const char *name
)
107 return name
? : DEFAULT_CHANNEL_NAME
;
111 const char *print_raw_channel_name(const char *name
)
113 return name
? : "<default>";
117 const char *print_event_type(const enum lttng_event_type ev_type
)
120 case LTTNG_EVENT_ALL
:
122 case LTTNG_EVENT_TRACEPOINT
:
124 case LTTNG_EVENT_PROBE
:
126 case LTTNG_EVENT_FUNCTION
:
128 case LTTNG_EVENT_FUNCTION_ENTRY
:
129 return "function entry";
130 case LTTNG_EVENT_SYSCALL
:
137 /* Mi print a partial event.
141 static int mi_print_event(char *event_name
, int enabled
, int success
)
148 /* Open event element */
149 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
154 /* Print the name of event */
155 ret
= mi_lttng_writer_write_element_string(writer
,
156 config_element_name
, event_name
);
161 /* Print enabled ? */
162 ret
= mi_lttng_writer_write_element_bool(writer
,
163 config_element_enabled
, enabled
);
169 ret
= mi_lttng_writer_write_element_bool(writer
,
170 mi_lttng_element_command_success
, success
);
175 /* Close event element */
176 ret
= mi_lttng_writer_close_element(writer
);
184 * Disabling event using the lttng API.
186 static int disable_events(char *session_name
)
188 int ret
= CMD_SUCCESS
, warn
= 0, command_ret
= CMD_SUCCESS
;
189 int enabled
= 1, success
= 1;
190 char *event_name
, *channel_name
= NULL
;
191 struct lttng_domain dom
;
192 struct lttng_event event
;
194 memset(&dom
, 0, sizeof(dom
));
196 /* Create lttng domain */
198 dom
.type
= LTTNG_DOMAIN_KERNEL
;
199 } else if (opt_userspace
) {
200 dom
.type
= LTTNG_DOMAIN_UST
;
201 } else if (opt_jul
) {
202 dom
.type
= LTTNG_DOMAIN_JUL
;
203 } else if (opt_log4j
) {
204 dom
.type
= LTTNG_DOMAIN_LOG4J
;
205 } else if (opt_python
) {
206 dom
.type
= LTTNG_DOMAIN_PYTHON
;
208 /* Checked by the caller. */
212 channel_name
= opt_channel_name
;
214 handle
= lttng_create_handle(session_name
, &dom
);
215 if (handle
== NULL
) {
220 /* Mi print the channel and open the events element */
222 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
228 ret
= mi_lttng_writer_write_element_string(writer
,
229 config_element_name
, print_channel_name(channel_name
));
235 /* Open events element */
236 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
243 memset(&event
, 0, sizeof(event
));
244 /* Set default loglevel to any/unknown */
247 /* opt_event_type contain the event type to disable at this point */
248 event
.type
= opt_event_type
;
250 if (opt_disable_all
) {
251 command_ret
= lttng_disable_event_ext(handle
, &event
, channel_name
, NULL
);
252 if (command_ret
< 0) {
253 ERR("%s", lttng_strerror(command_ret
));
260 MSG("All %s events of type %s are disabled in channel %s",
261 get_domain_str(dom
.type
),
262 print_event_type(opt_event_type
),
263 print_channel_name(channel_name
));
267 ret
= mi_print_event("*", enabled
, success
);
274 /* Strip event list */
275 event_name
= strtok(opt_event_list
, ",");
276 while (event_name
!= NULL
) {
277 DBG("Disabling event %s", event_name
);
279 strncpy(event
.name
, event_name
, sizeof(event
.name
));
280 event
.name
[sizeof(event
.name
) - 1] = '\0';
281 command_ret
= lttng_disable_event_ext(handle
, &event
, channel_name
, NULL
);
282 if (command_ret
< 0) {
283 ERR("%s of type %s : %s (channel %s, session %s)",
285 print_event_type(opt_event_type
),
286 lttng_strerror(command_ret
),
287 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
288 ? print_raw_channel_name(channel_name
)
289 : print_channel_name(channel_name
),
294 * If an error occurred we assume that the event is still
299 MSG("%s %s of type %s disabled in channel %s for session %s",
300 get_domain_str(dom
.type
),
302 print_event_type(opt_event_type
),
303 print_channel_name(channel_name
),
310 ret
= mi_print_event(event_name
, enabled
, success
);
318 event_name
= strtok(NULL
, ",");
324 /* Close events element and channel element */
325 ret
= mi_lttng_close_multi_element(writer
, 2);
331 /* if there is already an error preserve it */
336 /* Overwrite ret if an error occurred */
337 ret
= command_ret
? command_ret
: ret
;
339 lttng_destroy_handle(handle
);
346 * Disable event to trace session
348 int cmd_disable_events(int argc
, const char **argv
)
350 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
351 static poptContext pc
;
352 char *session_name
= NULL
;
355 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
356 poptReadDefaultConfig(pc
, 0);
358 /* Default event type */
359 opt_event_type
= LTTNG_EVENT_ALL
;
361 while ((opt
= poptGetNextOpt(pc
)) != -1) {
366 case OPT_TYPE_SYSCALL
:
367 opt_event_type
= LTTNG_EVENT_SYSCALL
;
369 case OPT_TYPE_TRACEPOINT
:
370 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
373 opt_event_type
= LTTNG_EVENT_PROBE
;
375 case OPT_TYPE_FUNCTION
:
376 opt_event_type
= LTTNG_EVENT_FUNCTION
;
379 opt_event_type
= LTTNG_EVENT_ALL
;
381 case OPT_LIST_OPTIONS
:
382 list_cmd_options(stdout
, long_options
);
390 /* Validate event type. Multiple event type are not supported. */
391 if (event_type
== -1) {
392 event_type
= opt_event_type
;
394 if (event_type
!= opt_event_type
) {
395 ERR("Multiple event type not supported.");
402 ret
= print_missing_or_multiple_domains(
403 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+ opt_python
);
409 /* Ust and agent only support ALL event type */
410 if ((opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
)
411 && opt_event_type
!= LTTNG_EVENT_ALL
) {
412 ERR("Disabling userspace and agent (-j | -l | -p) event(s) based on instrumentation type is not supported.\n");
418 opt_event_list
= (char*) poptGetArg(pc
);
419 if (opt_event_list
== NULL
&& opt_disable_all
== 0) {
420 ERR("Missing event name(s).\n");
426 if (!opt_session_name
) {
427 session_name
= get_session_name();
428 if (session_name
== NULL
) {
433 session_name
= opt_session_name
;
438 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
440 ret
= -LTTNG_ERR_NOMEM
;
444 /* Open command element */
445 ret
= mi_lttng_writer_command_open(writer
,
446 mi_lttng_element_command_disable_event
);
452 /* Open output element */
453 ret
= mi_lttng_writer_open_element(writer
,
454 mi_lttng_element_command_output
);
461 command_ret
= disable_events(session_name
);
468 /* Close output element */
469 ret
= mi_lttng_writer_close_element(writer
);
475 ret
= mi_lttng_writer_write_element_bool(writer
,
476 mi_lttng_element_command_success
, success
);
482 /* Command element close */
483 ret
= mi_lttng_writer_command_close(writer
);
491 if (!opt_session_name
&& session_name
) {
496 if (writer
&& mi_lttng_writer_destroy(writer
)) {
497 /* Preserve original error code */
498 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
501 /* Overwrite ret if an error occured in disable_events */
502 ret
= command_ret
? command_ret
: ret
;