2 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
16 #include <sys/types.h>
20 #include <common/utils.h>
21 #include <common/mi-lttng.h>
22 #include <lttng/lttng.h>
24 #include "../command.h"
26 static const char *opt_session_name
;
27 static const char *opt_output_name
;
28 static const char *opt_data_url
;
29 static const char *opt_ctrl_url
;
30 static const char *current_session_name
;
31 static uint64_t opt_max_size
;
33 /* Stub for the cmd struct actions. */
34 static int cmd_add_output(int argc
, const char **argv
);
35 static int cmd_del_output(int argc
, const char **argv
);
36 static int cmd_list_output(int argc
, const char **argv
);
37 static int cmd_record(int argc
, const char **argv
);
39 static const char *indent4
= " ";
41 #ifdef LTTNG_EMBED_HELP
42 static const char help_msg
[] =
43 #include <lttng-snapshot.1.h>
54 static struct mi_writer
*writer
;
56 static struct poptOption snapshot_opts
[] = {
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 {"ctrl-url", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
61 {"data-url", 'D', POPT_ARG_STRING
, &opt_data_url
, 0, 0, 0},
62 {"name", 'n', POPT_ARG_STRING
, &opt_output_name
, 0, 0, 0},
63 {"max-size", 'm', POPT_ARG_STRING
, 0, OPT_MAX_SIZE
, 0, 0},
64 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
65 {"list-commands", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_COMMANDS
},
69 static struct cmd_struct actions
[] = {
70 { "add-output", cmd_add_output
},
71 { "del-output", cmd_del_output
},
72 { "list-output", cmd_list_output
},
73 { "record", cmd_record
},
74 { NULL
, NULL
} /* Array closure */
78 * Count and return the number of arguments in argv.
80 static int count_arguments(const char **argv
)
86 while (argv
[i
] != NULL
) {
94 * Create a snapshot output object from arguments using the given URL.
96 * Return a newly allocated object or NULL on error.
98 static struct lttng_snapshot_output
*create_output_from_args(const char *url
)
101 struct lttng_snapshot_output
*output
= NULL
;
103 output
= lttng_snapshot_output_create();
109 ret
= lttng_snapshot_output_set_ctrl_url(url
, output
);
113 } else if (opt_ctrl_url
) {
114 ret
= lttng_snapshot_output_set_ctrl_url(opt_ctrl_url
, output
);
121 ret
= lttng_snapshot_output_set_data_url(opt_data_url
, output
);
128 ret
= lttng_snapshot_output_set_size(opt_max_size
, output
);
134 if (opt_output_name
) {
135 ret
= lttng_snapshot_output_set_name(opt_output_name
, output
);
144 lttng_snapshot_output_destroy(output
);
149 static int list_output(void)
151 int ret
, output_seen
= 0;
152 struct lttng_snapshot_output
*s_iter
;
153 struct lttng_snapshot_output_list
*list
;
155 ret
= lttng_snapshot_list_output(current_session_name
, &list
);
160 MSG("Snapshot output list for session %s", current_session_name
);
163 ret
= mi_lttng_snapshot_output_session_name(writer
,
164 current_session_name
);
171 while ((s_iter
= lttng_snapshot_output_list_get_next(list
)) != NULL
) {
172 if (lttng_snapshot_output_get_maxsize(s_iter
)) {
173 MSG("%s[%" PRIu32
"] %s: %s (max size: %" PRIu64
" bytes)", indent4
,
174 lttng_snapshot_output_get_id(s_iter
),
175 lttng_snapshot_output_get_name(s_iter
),
176 lttng_snapshot_output_get_ctrl_url(s_iter
),
177 lttng_snapshot_output_get_maxsize(s_iter
));
179 MSG("%s[%" PRIu32
"] %s: %s", indent4
,
180 lttng_snapshot_output_get_id(s_iter
),
181 lttng_snapshot_output_get_name(s_iter
),
182 lttng_snapshot_output_get_ctrl_url(s_iter
));
186 ret
= mi_lttng_snapshot_list_output(writer
, s_iter
);
195 /* Close snapshot snapshots element */
196 ret
= mi_lttng_writer_close_element(writer
);
202 /* Close snapshot session element */
203 ret
= mi_lttng_writer_close_element(writer
);
209 lttng_snapshot_output_list_destroy(list
);
212 MSG("%sNone", indent4
);
220 * Delete output by ID.
222 static int del_output(uint32_t id
, const char *name
)
225 struct lttng_snapshot_output
*output
= NULL
;
227 output
= lttng_snapshot_output_create();
234 ret
= lttng_snapshot_output_set_name(name
, output
);
235 } else if (id
!= UINT32_MAX
) {
236 ret
= lttng_snapshot_output_set_id(id
, output
);
246 ret
= lttng_snapshot_del_output(current_session_name
, output
);
251 if (id
!= UINT32_MAX
) {
252 MSG("Snapshot output id %" PRIu32
" successfully deleted for session %s",
253 id
, current_session_name
);
255 MSG("Snapshot output %s successfully deleted for session %s",
256 name
, current_session_name
);
260 ret
= mi_lttng_snapshot_del_output(writer
, id
, name
,
261 current_session_name
);
268 lttng_snapshot_output_destroy(output
);
273 * Add output from the user URL.
275 static int add_output(const char *url
)
278 struct lttng_snapshot_output
*output
= NULL
;
282 if (!url
&& (!opt_data_url
|| !opt_ctrl_url
)) {
287 output
= create_output_from_args(url
);
293 /* This call, if successful, populates the id of the output object. */
294 ret
= lttng_snapshot_add_output(current_session_name
, output
);
299 n_ptr
= lttng_snapshot_output_get_name(output
);
300 if (*n_ptr
== '\0') {
302 pret
= snprintf(name
, sizeof(name
), DEFAULT_SNAPSHOT_NAME
"-%" PRIu32
,
303 lttng_snapshot_output_get_id(output
));
305 PERROR("snprintf add output name");
310 MSG("Snapshot output successfully added for session %s",
311 current_session_name
);
313 MSG(" [%" PRIu32
"] %s: %s (max size: %" PRIu64
" bytes)",
314 lttng_snapshot_output_get_id(output
), n_ptr
,
315 lttng_snapshot_output_get_ctrl_url(output
),
316 lttng_snapshot_output_get_maxsize(output
));
318 MSG(" [%" PRIu32
"] %s: %s",
319 lttng_snapshot_output_get_id(output
), n_ptr
,
320 lttng_snapshot_output_get_ctrl_url(output
));
323 ret
= mi_lttng_snapshot_add_output(writer
, current_session_name
,
330 lttng_snapshot_output_destroy(output
);
334 static int cmd_add_output(int argc
, const char **argv
)
338 if (argc
< 2 && (!opt_data_url
|| !opt_ctrl_url
)) {
339 ERR("An output destination must be specified to add a snapshot output.");
344 ret
= add_output(argv
[1]);
347 case LTTNG_ERR_SNAPSHOT_UNSUPPORTED
:
348 ERR("Session \"%s\" contains a channel that is incompatible with the snapshot functionality.\nMake sure all channels are configured in 'mmap' output mode.",
349 current_session_name
);
361 static int cmd_del_output(int argc
, const char **argv
)
368 ERR("A snapshot output name or id must be provided to delete a snapshot output.");
374 id
= strtol(argv
[1], &name
, 10);
375 if (id
== 0 && (errno
== 0 || errno
== EINVAL
)) {
376 ret
= del_output(UINT32_MAX
, name
);
377 } else if (errno
== 0 && *name
== '\0') {
378 ret
= del_output(id
, NULL
);
380 ERR("Argument %s not recognized", argv
[1]);
389 static int cmd_list_output(int argc
, const char **argv
)
399 * Do a snapshot record with the URL if one is given.
401 static int record(const char *url
)
404 struct lttng_snapshot_output
*output
= NULL
;
406 output
= create_output_from_args(url
);
412 ret
= lttng_snapshot_record(current_session_name
, output
, 0);
414 if (ret
== -LTTNG_ERR_MAX_SIZE_INVALID
) {
415 ERR("Invalid snapshot size. Cannot fit at least one packet per stream.");
420 MSG("Snapshot recorded successfully for session %s", current_session_name
);
423 MSG("Snapshot written at: %s", url
);
424 } else if (opt_ctrl_url
) {
425 MSG("Snapshot written to ctrl: %s, data: %s", opt_ctrl_url
,
430 ret
= mi_lttng_snapshot_record(writer
, current_session_name
, url
,
431 opt_ctrl_url
, opt_data_url
);
438 lttng_snapshot_output_destroy(output
);
442 static int cmd_record(int argc
, const char **argv
)
447 ret
= record(argv
[1]);
455 static enum cmd_error_code
handle_command(const char **argv
)
457 int mi_ret
, i
= 0, argc
;
458 enum cmd_error_code cmd_ret
;
459 struct cmd_struct
*cmd
;
462 ERR("No action specified for snapshot command.");
467 if ((!opt_ctrl_url
&& opt_data_url
) ||
468 (opt_ctrl_url
&& !opt_data_url
)) {
469 ERR("URLs must be specified for both data and control");
474 argc
= count_arguments(argv
);
475 /* popt should have passed NULL if no arguments are present. */
479 while (cmd
->func
!= NULL
) {
481 if (strcmp(argv
[0], cmd
->name
) == 0) {
486 mi_ret
= mi_lttng_writer_open_element(writer
,
487 mi_lttng_element_command_action
);
493 /* Name of the action */
494 mi_ret
= mi_lttng_writer_write_element_string(writer
,
495 config_element_name
, argv
[0]);
501 /* Open output element */
502 mi_ret
= mi_lttng_writer_open_element(writer
,
503 mi_lttng_element_command_output
);
510 result
= cmd
->func(argc
, argv
);
517 case CMD_UNSUPPORTED
:
519 * Sub-commands mix lttng_error_codes
520 * and cmd_error_codes. This should be
521 * cleaned-up, but in the meantime this
522 * hack works since the values of the
523 * two enums do not intersect.
527 case -LTTNG_ERR_SNAPSHOT_NODATA
:
528 WARN("%s", lttng_strerror(result
));
530 /* A warning is fine since the user has no control on
531 * whether or not applications (or the kernel) have
532 * produced any event between the start of the tracing
533 * session and the recording of the snapshot. MI wise
534 * the command is not a success since nothing was
537 cmd_ret
= CMD_SUCCESS
;
540 ERR("%s", lttng_strerror(result
));
545 cmd_ret
= CMD_SUCCESS
;
550 /* Close output and action element */
551 mi_ret
= mi_lttng_close_multi_element(writer
, 2);
563 cmd_ret
= CMD_UNDEFINED
;
569 * The 'snapshot <cmd> <options>' first level command
571 int cmd_snapshot(int argc
, const char **argv
)
575 enum cmd_error_code cmd_ret
= CMD_SUCCESS
;
576 char *session_name
= NULL
;
577 static poptContext pc
;
579 pc
= poptGetContext(NULL
, argc
, argv
, snapshot_opts
, 0);
580 poptReadDefaultConfig(pc
, 0);
584 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
590 /* Open command element */
591 mi_ret
= mi_lttng_writer_command_open(writer
,
592 mi_lttng_element_command_snapshot
);
598 /* Open output element */
599 mi_ret
= mi_lttng_writer_open_element(writer
,
600 mi_lttng_element_command_output
);
607 while ((opt
= poptGetNextOpt(pc
)) != -1) {
613 /* SHOW_HELP assigns to ret. */
618 case OPT_LIST_OPTIONS
:
619 list_cmd_options(stdout
, snapshot_opts
);
621 case OPT_LIST_COMMANDS
:
622 list_commands(actions
, stdout
);
627 const char *opt
= poptGetOptArg(pc
);
629 if (utils_parse_size_suffix((char *) opt
, &val
) < 0) {
630 ERR("Unable to handle max-size value %s", opt
);
640 cmd_ret
= CMD_UNDEFINED
;
645 if (!opt_session_name
) {
646 session_name
= get_session_name();
647 if (session_name
== NULL
) {
651 current_session_name
= session_name
;
653 current_session_name
= opt_session_name
;
656 cmd_ret
= handle_command(poptGetArgs(pc
));
659 /* Close output element */
660 mi_ret
= mi_lttng_writer_close_element(writer
);
667 mi_ret
= mi_lttng_writer_write_element_bool(writer
,
668 mi_lttng_element_command_success
,
669 cmd_ret
== CMD_SUCCESS
);
675 /* Command element close */
676 mi_ret
= mi_lttng_writer_command_close(writer
);
685 if (writer
&& mi_lttng_writer_destroy(writer
)) {
689 if (!opt_session_name
) {