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