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.
25 #include <sys/types.h>
29 #include <common/mi-lttng.h>
31 #include "../command.h"
33 static char *opt_event_list
;
34 static int opt_kernel
;
35 static char *opt_channel_name
;
36 static char *opt_session_name
;
37 static int opt_userspace
;
38 static int opt_disable_all
;
41 static int opt_python
;
42 static int opt_event_type
;
44 /* Not implemented yet */
45 static char *opt_cmd_name
;
59 static struct lttng_handle
*handle
;
60 static struct mi_writer
*writer
;
62 static struct poptOption long_options
[] = {
63 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
64 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
65 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
66 {"all-events", 'a', POPT_ARG_VAL
, &opt_disable_all
, 1, 0, 0},
67 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
68 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
69 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
70 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
71 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
72 {"userspace", 'u', POPT_ARG_VAL
, &opt_userspace
, 1, 0, 0},
73 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_TYPE_SYSCALL
, 0, 0},
74 {"probe", 0, POPT_ARG_NONE
, 0, OPT_TYPE_PROBE
, 0, 0},
75 {"tracepoint", 0, POPT_ARG_NONE
, 0, OPT_TYPE_TRACEPOINT
, 0, 0},
76 {"function", 0, POPT_ARG_NONE
, 0, OPT_TYPE_FUNCTION
, 0, 0},
77 {"all", 0, POPT_ARG_NONE
, 0, OPT_TYPE_ALL
, 0, 0},
78 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
85 static void usage(FILE *ofp
)
87 fprintf(ofp
, "usage: lttng disable-event NAME[,NAME2,...] (-k | -u) [OPTIONS]\n");
89 fprintf(ofp
, "Options:\n");
90 fprintf(ofp
, " -h, --help Show this help\n");
91 fprintf(ofp
, " --list-options Simple listing of options\n");
92 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
93 fprintf(ofp
, " -c, --channel NAME Apply to this channel\n");
94 fprintf(ofp
, " -a, --all-events Disable all tracepoints\n");
95 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
96 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
97 fprintf(ofp
, " -j, --jul Apply for Java application using JUL\n");
98 fprintf(ofp
, " -l, --log4j Apply to Java application using LOG4j\n");
99 fprintf(ofp
, " -p, --python Apply to Python application using logging\n");
101 fprintf(ofp
, "Event type options (Only supported with kernel domain):\n");
102 fprintf(ofp
, " --all All event types (default)\n");
103 fprintf(ofp
, " --tracepoint Tracepoint event\n");
104 fprintf(ofp
, " --syscall System call event\n");
105 fprintf(ofp
, " --probe Probe event\n");
106 fprintf(ofp
, " --function Function event\n");
111 const char *print_channel_name(const char *name
)
113 return name
? : DEFAULT_CHANNEL_NAME
;
117 const char *print_raw_channel_name(const char *name
)
119 return name
? : "<default>";
123 const char *print_event_type(const enum lttng_event_type ev_type
)
126 case LTTNG_EVENT_ALL
:
128 case LTTNG_EVENT_TRACEPOINT
:
130 case LTTNG_EVENT_PROBE
:
132 case LTTNG_EVENT_FUNCTION
:
134 case LTTNG_EVENT_FUNCTION_ENTRY
:
135 return "function entry";
136 case LTTNG_EVENT_SYSCALL
:
143 /* Mi print a partial event.
147 static int mi_print_event(char *event_name
, int enabled
, int success
)
154 /* Open event element */
155 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
160 /* Print the name of event */
161 ret
= mi_lttng_writer_write_element_string(writer
,
162 config_element_name
, event_name
);
167 /* Print enabled ? */
168 ret
= mi_lttng_writer_write_element_bool(writer
,
169 config_element_enabled
, enabled
);
175 ret
= mi_lttng_writer_write_element_bool(writer
,
176 mi_lttng_element_command_success
, success
);
181 /* Close event element */
182 ret
= mi_lttng_writer_close_element(writer
);
190 * Disabling event using the lttng API.
192 static int disable_events(char *session_name
)
194 int ret
= CMD_SUCCESS
, warn
= 0, command_ret
= CMD_SUCCESS
;
195 int enabled
= 1, success
= 1;
196 char *event_name
, *channel_name
= NULL
;
197 struct lttng_domain dom
;
198 struct lttng_event event
;
200 memset(&dom
, 0, sizeof(dom
));
202 /* Create lttng domain */
204 dom
.type
= LTTNG_DOMAIN_KERNEL
;
205 } else if (opt_userspace
) {
206 dom
.type
= LTTNG_DOMAIN_UST
;
207 } else if (opt_jul
) {
208 dom
.type
= LTTNG_DOMAIN_JUL
;
209 } else if (opt_log4j
) {
210 dom
.type
= LTTNG_DOMAIN_LOG4J
;
211 } else if (opt_python
) {
212 dom
.type
= LTTNG_DOMAIN_PYTHON
;
214 /* Checked by the caller. */
218 channel_name
= opt_channel_name
;
220 handle
= lttng_create_handle(session_name
, &dom
);
221 if (handle
== NULL
) {
226 /* Mi print the channel and open the events element */
228 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
234 ret
= mi_lttng_writer_write_element_string(writer
,
235 config_element_name
, print_channel_name(channel_name
));
241 /* Open events element */
242 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
249 memset(&event
, 0, sizeof(event
));
250 /* Set default loglevel to any/unknown */
253 /* opt_event_type contain the event type to disable at this point */
254 event
.type
= opt_event_type
;
256 if (opt_disable_all
) {
257 command_ret
= lttng_disable_event_ext(handle
, &event
, channel_name
, NULL
);
258 if (command_ret
< 0) {
259 ERR("%s", lttng_strerror(command_ret
));
266 MSG("All %s events of type %s are disabled in channel %s",
267 get_domain_str(dom
.type
),
268 print_event_type(opt_event_type
),
269 print_channel_name(channel_name
));
273 ret
= mi_print_event("*", enabled
, success
);
280 /* Strip event list */
281 event_name
= strtok(opt_event_list
, ",");
282 while (event_name
!= NULL
) {
283 DBG("Disabling event %s", event_name
);
285 strncpy(event
.name
, event_name
, sizeof(event
.name
));
286 event
.name
[sizeof(event
.name
) - 1] = '\0';
287 command_ret
= lttng_disable_event_ext(handle
, &event
, channel_name
, NULL
);
288 if (command_ret
< 0) {
289 ERR("%s of type %s : %s (channel %s, session %s)",
291 print_event_type(opt_event_type
),
292 lttng_strerror(command_ret
),
293 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
294 ? print_raw_channel_name(channel_name
)
295 : print_channel_name(channel_name
),
300 * If an error occurred we assume that the event is still
305 MSG("%s %s of type %s disabled in channel %s for session %s",
306 get_domain_str(dom
.type
),
308 print_event_type(opt_event_type
),
309 print_channel_name(channel_name
),
316 ret
= mi_print_event(event_name
, enabled
, success
);
324 event_name
= strtok(NULL
, ",");
330 /* Close events element and channel element */
331 ret
= mi_lttng_close_multi_element(writer
, 2);
337 /* if there is already an error preserve it */
342 /* Overwrite ret if an error occurred */
343 ret
= command_ret
? command_ret
: ret
;
345 lttng_destroy_handle(handle
);
352 * Disable event to trace session
354 int cmd_disable_events(int argc
, const char **argv
)
356 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
357 static poptContext pc
;
358 char *session_name
= NULL
;
361 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
362 poptReadDefaultConfig(pc
, 0);
364 /* Default event type */
365 opt_event_type
= LTTNG_EVENT_ALL
;
367 while ((opt
= poptGetNextOpt(pc
)) != -1) {
372 case OPT_TYPE_SYSCALL
:
373 opt_event_type
= LTTNG_EVENT_SYSCALL
;
375 case OPT_TYPE_TRACEPOINT
:
376 opt_event_type
= LTTNG_EVENT_TRACEPOINT
;
379 opt_event_type
= LTTNG_EVENT_PROBE
;
381 case OPT_TYPE_FUNCTION
:
382 opt_event_type
= LTTNG_EVENT_FUNCTION
;
385 opt_event_type
= LTTNG_EVENT_ALL
;
387 case OPT_LIST_OPTIONS
:
388 list_cmd_options(stdout
, long_options
);
396 /* Validate event type. Multiple event type are not supported. */
397 if (event_type
== -1) {
398 event_type
= opt_event_type
;
400 if (event_type
!= opt_event_type
) {
401 ERR("Multiple event type not supported.");
408 ret
= print_missing_or_multiple_domains(
409 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+ opt_python
);
415 /* Ust and agent only support ALL event type */
416 if ((opt_userspace
|| opt_jul
|| opt_log4j
|| opt_python
)
417 && opt_event_type
!= LTTNG_EVENT_ALL
) {
418 ERR("UST and agent (-j | -l | -p) event(s) disabling based on event type is not supported.\n");
424 opt_event_list
= (char*) poptGetArg(pc
);
425 if (opt_event_list
== NULL
&& opt_disable_all
== 0) {
426 ERR("Missing event name(s).\n");
432 if (!opt_session_name
) {
433 session_name
= get_session_name();
434 if (session_name
== NULL
) {
439 session_name
= opt_session_name
;
444 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
446 ret
= -LTTNG_ERR_NOMEM
;
450 /* Open command element */
451 ret
= mi_lttng_writer_command_open(writer
,
452 mi_lttng_element_command_disable_event
);
458 /* Open output element */
459 ret
= mi_lttng_writer_open_element(writer
,
460 mi_lttng_element_command_output
);
467 command_ret
= disable_events(session_name
);
474 /* Close output element */
475 ret
= mi_lttng_writer_close_element(writer
);
481 ret
= mi_lttng_writer_write_element_bool(writer
,
482 mi_lttng_element_command_success
, success
);
488 /* Command element close */
489 ret
= mi_lttng_writer_command_close(writer
);
497 if (!opt_session_name
&& session_name
) {
502 if (writer
&& mi_lttng_writer_destroy(writer
)) {
503 /* Preserve original error code */
504 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
507 /* Overwrite ret if an error occured in disable_events */
508 ret
= command_ret
? command_ret
: ret
;