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