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
;
51 static struct lttng_handle
*handle
;
52 static struct mi_writer
*writer
;
54 static struct poptOption long_options
[] = {
55 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
56 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
57 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
58 {"all-events", 'a', POPT_ARG_VAL
, &opt_disable_all
, 1, 0, 0},
59 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
60 {"jul", 'j', POPT_ARG_VAL
, &opt_jul
, 1, 0, 0},
61 {"log4j", 'l', POPT_ARG_VAL
, &opt_log4j
, 1, 0, 0},
62 {"python", 'p', POPT_ARG_VAL
, &opt_python
, 1, 0, 0},
63 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
64 {"syscall", 0, POPT_ARG_NONE
, 0, OPT_SYSCALL
, 0, 0},
65 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
66 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
73 static void usage(FILE *ofp
)
75 fprintf(ofp
, "usage: lttng disable-event NAME[,NAME2,...] (-k | -u) [OPTIONS]\n");
77 fprintf(ofp
, "Options:\n");
78 fprintf(ofp
, " -h, --help Show this help\n");
79 fprintf(ofp
, " --list-options Simple listing of options\n");
80 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
81 fprintf(ofp
, " -c, --channel NAME Apply to this channel\n");
82 fprintf(ofp
, " -a, --all-events Disable all tracepoints\n");
83 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
84 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
85 fprintf(ofp
, " -j, --jul Apply for Java application using JUL\n");
86 fprintf(ofp
, " -l, --log4j Apply to Java application using LOG4j\n");
87 fprintf(ofp
, " -p, --python Apply to Python application using logging\n");
89 fprintf(ofp
, "Event options:\n");
90 fprintf(ofp
, " --syscall System call event\n");
95 const char *print_channel_name(const char *name
)
97 return name
? : DEFAULT_CHANNEL_NAME
;
101 const char *print_raw_channel_name(const char *name
)
103 return name
? : "<default>";
106 /* Mi print a partial event.
110 static int mi_print_event(char *event_name
, int enabled
, int success
)
117 /* Open event element */
118 ret
= mi_lttng_writer_open_element(writer
, config_element_event
);
123 /* Print the name of event */
124 ret
= mi_lttng_writer_write_element_string(writer
,
125 config_element_name
, event_name
);
130 /* Print enabled ? */
131 ret
= mi_lttng_writer_write_element_bool(writer
,
132 config_element_enabled
, enabled
);
138 ret
= mi_lttng_writer_write_element_bool(writer
,
139 mi_lttng_element_command_success
, success
);
144 /* Close event element */
145 ret
= mi_lttng_writer_close_element(writer
);
153 * Disabling event using the lttng API.
155 static int disable_events(char *session_name
)
157 int ret
= CMD_SUCCESS
, warn
= 0, command_ret
= CMD_SUCCESS
;
158 int enabled
= 1, success
= 1;
159 char *event_name
, *channel_name
= NULL
;
160 struct lttng_domain dom
;
161 struct lttng_event event
;
163 memset(&dom
, 0, sizeof(dom
));
165 /* Create lttng domain */
167 dom
.type
= LTTNG_DOMAIN_KERNEL
;
168 } else if (opt_userspace
) {
169 dom
.type
= LTTNG_DOMAIN_UST
;
170 } else if (opt_jul
) {
171 dom
.type
= LTTNG_DOMAIN_JUL
;
172 } else if (opt_log4j
) {
173 dom
.type
= LTTNG_DOMAIN_LOG4J
;
174 } else if (opt_python
) {
175 dom
.type
= LTTNG_DOMAIN_PYTHON
;
177 /* Checked by the caller. */
181 channel_name
= opt_channel_name
;
183 handle
= lttng_create_handle(session_name
, &dom
);
184 if (handle
== NULL
) {
189 /* Mi print the channel and open the events element */
191 ret
= mi_lttng_writer_open_element(writer
, config_element_channel
);
197 ret
= mi_lttng_writer_write_element_string(writer
,
198 config_element_name
, print_channel_name(channel_name
));
204 /* Open events element */
205 ret
= mi_lttng_writer_open_element(writer
, config_element_events
);
212 memset(&event
, 0, sizeof(event
));
213 /* Set default loglevel to any/unknown */
216 switch (opt_event_type
) {
217 case LTTNG_EVENT_SYSCALL
:
218 event
.type
= LTTNG_EVENT_SYSCALL
;
221 event
.type
= LTTNG_EVENT_ALL
;
225 if (opt_disable_all
) {
226 command_ret
= lttng_disable_event_ext(handle
, &event
, channel_name
, NULL
);
227 if (command_ret
< 0) {
228 ERR("%s", lttng_strerror(command_ret
));
235 MSG("All %s %s are disabled in channel %s",
236 get_domain_str(dom
.type
),
237 opt_event_type
== LTTNG_EVENT_SYSCALL
? "system calls" : "events",
238 print_channel_name(channel_name
));
242 ret
= mi_print_event("*", enabled
, success
);
249 /* Strip event list */
250 event_name
= strtok(opt_event_list
, ",");
251 while (event_name
!= NULL
) {
252 DBG("Disabling event %s", event_name
);
254 strncpy(event
.name
, event_name
, sizeof(event
.name
));
255 event
.name
[sizeof(event
.name
) - 1] = '\0';
256 command_ret
= lttng_disable_event_ext(handle
, &event
, channel_name
, NULL
);
257 if (command_ret
< 0) {
258 ERR("%s %s: %s (channel %s, session %s)",
259 opt_event_type
== LTTNG_EVENT_SYSCALL
? "System call" : "Event",
261 lttng_strerror(command_ret
),
262 command_ret
== -LTTNG_ERR_NEED_CHANNEL_NAME
263 ? print_raw_channel_name(channel_name
)
264 : print_channel_name(channel_name
),
269 * If an error occurred we assume that the event is still
274 MSG("%s %s %s disabled in channel %s for session %s",
275 get_domain_str(dom
.type
),
276 opt_event_type
== LTTNG_EVENT_SYSCALL
? "system call" : "event",
278 print_channel_name(channel_name
),
285 ret
= mi_print_event(event_name
, enabled
, success
);
293 event_name
= strtok(NULL
, ",");
299 /* Close events element and channel element */
300 ret
= mi_lttng_close_multi_element(writer
, 2);
306 /* if there is already an error preserve it */
311 /* Overwrite ret if an error occurred */
312 ret
= command_ret
? command_ret
: ret
;
314 lttng_destroy_handle(handle
);
321 * Disable event to trace session
323 int cmd_disable_events(int argc
, const char **argv
)
325 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
326 static poptContext pc
;
327 char *session_name
= NULL
;
330 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
331 poptReadDefaultConfig(pc
, 0);
333 /* Default event type */
334 opt_event_type
= LTTNG_EVENT_ALL
;
336 while ((opt
= poptGetNextOpt(pc
)) != -1) {
345 opt_event_type
= LTTNG_EVENT_SYSCALL
;
347 case OPT_LIST_OPTIONS
:
348 list_cmd_options(stdout
, long_options
);
356 /* Validate event type. Multiple event type are not supported. */
357 if (event_type
== -1) {
358 event_type
= opt_event_type
;
360 if (event_type
!= opt_event_type
) {
361 ERR("Multiple event type not supported.");
368 ret
= print_missing_or_multiple_domains(
369 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
+ opt_python
);
375 opt_event_list
= (char*) poptGetArg(pc
);
376 if (opt_event_list
== NULL
&& opt_disable_all
== 0) {
377 ERR("Missing event name(s).\n");
383 if (!opt_session_name
) {
384 session_name
= get_session_name();
385 if (session_name
== NULL
) {
390 session_name
= opt_session_name
;
395 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
397 ret
= -LTTNG_ERR_NOMEM
;
401 /* Open command element */
402 ret
= mi_lttng_writer_command_open(writer
,
403 mi_lttng_element_command_disable_event
);
409 /* Open output element */
410 ret
= mi_lttng_writer_open_element(writer
,
411 mi_lttng_element_command_output
);
418 command_ret
= disable_events(session_name
);
425 /* Close output element */
426 ret
= mi_lttng_writer_close_element(writer
);
432 ret
= mi_lttng_writer_write_element_bool(writer
,
433 mi_lttng_element_command_success
, success
);
439 /* Command element close */
440 ret
= mi_lttng_writer_command_close(writer
);
448 if (!opt_session_name
&& session_name
) {
453 if (writer
&& mi_lttng_writer_destroy(writer
)) {
454 /* Preserve original error code */
455 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
458 /* Overwrite ret if an error occured in disable_events */
459 ret
= command_ret
? command_ret
: ret
;