2 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
30 #include <common/utils.h>
31 #include <common/mi-lttng.h>
32 #include <lttng/snapshot.h>
34 #include "../command.h"
36 static const char *opt_session_name
;
37 static const char *opt_output_name
;
38 static const char *opt_data_url
;
39 static const char *opt_ctrl_url
;
40 static const char *current_session_name
;
41 static uint64_t opt_max_size
;
43 /* Stub for the cmd struct actions. */
44 static int cmd_add_output(int argc
, const char **argv
);
45 static int cmd_del_output(int argc
, const char **argv
);
46 static int cmd_list_output(int argc
, const char **argv
);
47 static int cmd_record(int argc
, const char **argv
);
49 static const char *indent4
= " ";
51 #ifdef LTTNG_EMBED_HELP
52 static const char help_msg
[] =
53 #include <lttng-snapshot.1.h>
64 static struct mi_writer
*writer
;
66 static struct poptOption snapshot_opts
[] = {
67 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
68 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
69 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
70 {"ctrl-url", 'C', POPT_ARG_STRING
, &opt_ctrl_url
, 0, 0, 0},
71 {"data-url", 'D', POPT_ARG_STRING
, &opt_data_url
, 0, 0, 0},
72 {"name", 'n', POPT_ARG_STRING
, &opt_output_name
, 0, 0, 0},
73 {"max-size", 'm', POPT_ARG_STRING
, 0, OPT_MAX_SIZE
, 0, 0},
74 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
75 {"list-commands", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_COMMANDS
},
79 static struct cmd_struct actions
[] = {
80 { "add-output", cmd_add_output
},
81 { "del-output", cmd_del_output
},
82 { "list-output", cmd_list_output
},
83 { "record", cmd_record
},
84 { NULL
, NULL
} /* Array closure */
88 * Count and return the number of arguments in argv.
90 static int count_arguments(const char **argv
)
96 while (argv
[i
] != NULL
) {
104 * Create a snapshot output object from arguments using the given URL.
106 * Return a newly allocated object or NULL on error.
108 static struct lttng_snapshot_output
*create_output_from_args(const char *url
)
111 struct lttng_snapshot_output
*output
= NULL
;
113 output
= lttng_snapshot_output_create();
119 ret
= lttng_snapshot_output_set_ctrl_url(url
, output
);
123 } else if (opt_ctrl_url
) {
124 ret
= lttng_snapshot_output_set_ctrl_url(opt_ctrl_url
, output
);
131 ret
= lttng_snapshot_output_set_data_url(opt_data_url
, output
);
138 ret
= lttng_snapshot_output_set_size(opt_max_size
, output
);
144 if (opt_output_name
) {
145 ret
= lttng_snapshot_output_set_name(opt_output_name
, output
);
154 lttng_snapshot_output_destroy(output
);
159 static int list_output(void)
161 int ret
, output_seen
= 0;
162 struct lttng_snapshot_output
*s_iter
;
163 struct lttng_snapshot_output_list
*list
;
165 ret
= lttng_snapshot_list_output(current_session_name
, &list
);
170 MSG("Snapshot output list for session %s", current_session_name
);
173 ret
= mi_lttng_snapshot_output_session_name(writer
,
174 current_session_name
);
181 while ((s_iter
= lttng_snapshot_output_list_get_next(list
)) != NULL
) {
182 MSG("%s[%" PRIu32
"] %s: %s (max-size: %" PRId64
")", indent4
,
183 lttng_snapshot_output_get_id(s_iter
),
184 lttng_snapshot_output_get_name(s_iter
),
185 lttng_snapshot_output_get_ctrl_url(s_iter
),
186 lttng_snapshot_output_get_maxsize(s_iter
));
189 ret
= mi_lttng_snapshot_list_output(writer
, s_iter
);
198 /* Close snapshot snapshots element */
199 ret
= mi_lttng_writer_close_element(writer
);
205 /* Close snapshot session element */
206 ret
= mi_lttng_writer_close_element(writer
);
212 lttng_snapshot_output_list_destroy(list
);
215 MSG("%sNone", indent4
);
223 * Delete output by ID.
225 static int del_output(uint32_t id
, const char *name
)
228 struct lttng_snapshot_output
*output
= NULL
;
230 output
= lttng_snapshot_output_create();
237 ret
= lttng_snapshot_output_set_name(name
, output
);
238 } else if (id
!= UINT32_MAX
) {
239 ret
= lttng_snapshot_output_set_id(id
, output
);
249 ret
= lttng_snapshot_del_output(current_session_name
, output
);
254 if (id
!= UINT32_MAX
) {
255 MSG("Snapshot output id %" PRIu32
" successfully deleted for session %s",
256 id
, current_session_name
);
258 MSG("Snapshot output %s successfully deleted for session %s",
259 name
, current_session_name
);
263 ret
= mi_lttng_snapshot_del_output(writer
, id
, name
,
264 current_session_name
);
271 lttng_snapshot_output_destroy(output
);
276 * Add output from the user URL.
278 static int add_output(const char *url
)
281 struct lttng_snapshot_output
*output
= NULL
;
285 if (!url
&& (!opt_data_url
|| !opt_ctrl_url
)) {
290 output
= create_output_from_args(url
);
296 /* This call, if successful, populates the id of the output object. */
297 ret
= lttng_snapshot_add_output(current_session_name
, output
);
302 n_ptr
= lttng_snapshot_output_get_name(output
);
303 if (*n_ptr
== '\0') {
305 pret
= snprintf(name
, sizeof(name
), DEFAULT_SNAPSHOT_NAME
"-%" PRIu32
,
306 lttng_snapshot_output_get_id(output
));
308 PERROR("snprintf add output name");
313 MSG("Snapshot output successfully added for session %s",
314 current_session_name
);
315 MSG(" [%" PRIu32
"] %s: %s (max-size: %" PRId64
")",
316 lttng_snapshot_output_get_id(output
), n_ptr
,
317 lttng_snapshot_output_get_ctrl_url(output
),
318 lttng_snapshot_output_get_maxsize(output
));
320 ret
= mi_lttng_snapshot_add_output(writer
, current_session_name
,
327 lttng_snapshot_output_destroy(output
);
331 static int cmd_add_output(int argc
, const char **argv
)
335 if (argc
< 2 && (!opt_data_url
|| !opt_ctrl_url
)) {
340 ret
= add_output(argv
[1]);
346 static int cmd_del_output(int argc
, const char **argv
)
358 id
= strtol(argv
[1], &name
, 10);
359 if (id
== 0 && (errno
== 0 || errno
== EINVAL
)) {
360 ret
= del_output(UINT32_MAX
, name
);
361 } else if (errno
== 0 && *name
== '\0') {
362 ret
= del_output(id
, NULL
);
364 ERR("Argument %s not recognized", argv
[1]);
373 static int cmd_list_output(int argc
, const char **argv
)
383 * Do a snapshot record with the URL if one is given.
385 static int record(const char *url
)
388 struct lttng_snapshot_output
*output
= NULL
;
390 output
= create_output_from_args(url
);
396 ret
= lttng_snapshot_record(current_session_name
, output
, 0);
398 if (ret
== -LTTNG_ERR_MAX_SIZE_INVALID
) {
399 ERR("Invalid snapshot size. Cannot fit at least one packet per stream.");
404 MSG("Snapshot recorded successfully for session %s", current_session_name
);
407 MSG("Snapshot written at: %s", url
);
408 } else if (opt_ctrl_url
) {
409 MSG("Snapshot written to ctrl: %s, data: %s", opt_ctrl_url
,
414 ret
= mi_lttng_snapshot_record(writer
, current_session_name
, url
,
415 opt_ctrl_url
, opt_data_url
);
422 lttng_snapshot_output_destroy(output
);
426 static int cmd_record(int argc
, const char **argv
)
431 ret
= record(argv
[1]);
439 static int handle_command(const char **argv
)
441 int ret
= CMD_SUCCESS
, i
= 0, argc
, command_ret
= CMD_SUCCESS
;
442 struct cmd_struct
*cmd
;
444 if (argv
== NULL
|| (!opt_ctrl_url
&& opt_data_url
) ||
445 (opt_ctrl_url
&& !opt_data_url
)) {
446 command_ret
= CMD_ERROR
;
450 argc
= count_arguments(argv
);
453 while (cmd
->func
!= NULL
) {
455 if (strcmp(argv
[0], cmd
->name
) == 0) {
458 ret
= mi_lttng_writer_open_element(writer
,
459 mi_lttng_element_command_action
);
465 /* Name of the action */
466 ret
= mi_lttng_writer_write_element_string(writer
,
467 config_element_name
, argv
[0]);
473 /* Open output element */
474 ret
= mi_lttng_writer_open_element(writer
,
475 mi_lttng_element_command_output
);
482 command_ret
= cmd
->func(argc
, argv
);
485 /* Close output and action element */
486 ret
= mi_lttng_close_multi_element(writer
, 2);
501 /* Overwrite ret if an error occurred in cmd->func() */
502 ret
= command_ret
? command_ret
: ret
;
506 * The 'snapshot <cmd> <options>' first level command
508 int cmd_snapshot(int argc
, const char **argv
)
510 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
, success
= 1;
511 char *session_name
= NULL
;
512 static poptContext pc
;
514 pc
= poptGetContext(NULL
, argc
, argv
, snapshot_opts
, 0);
515 poptReadDefaultConfig(pc
, 0);
519 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
521 ret
= -LTTNG_ERR_NOMEM
;
525 /* Open command element */
526 ret
= mi_lttng_writer_command_open(writer
,
527 mi_lttng_element_command_snapshot
);
533 /* Open output element */
534 ret
= mi_lttng_writer_open_element(writer
,
535 mi_lttng_element_command_output
);
542 while ((opt
= poptGetNextOpt(pc
)) != -1) {
547 case OPT_LIST_OPTIONS
:
548 list_cmd_options(stdout
, snapshot_opts
);
550 case OPT_LIST_COMMANDS
:
551 list_commands(actions
, stdout
);
556 const char *opt
= poptGetOptArg(pc
);
558 if (utils_parse_size_suffix((char *) opt
, &val
) < 0) {
559 ERR("Unable to handle max-size value %s", opt
);
574 if (!opt_session_name
) {
575 session_name
= get_session_name();
576 if (session_name
== NULL
) {
580 current_session_name
= session_name
;
582 current_session_name
= opt_session_name
;
585 command_ret
= handle_command(poptGetArgs(pc
));
587 switch (-command_ret
) {
588 case LTTNG_ERR_SNAPSHOT_NODATA
:
589 WARN("%s", lttng_strerror(command_ret
));
591 /* A warning is fine since the user has no control on
592 * whether or not applications (or the kernel) have
593 * produced any event between the start of the tracing
594 * session and the recording of the snapshot. MI wise
595 * the command is not a success since nothing was
601 ERR("%s", lttng_strerror(command_ret
));
608 /* Close output element */
609 ret
= mi_lttng_writer_close_element(writer
);
616 ret
= mi_lttng_writer_write_element_bool(writer
,
617 mi_lttng_element_command_success
, success
);
623 /* Command element close */
624 ret
= mi_lttng_writer_command_close(writer
);
633 if (writer
&& mi_lttng_writer_destroy(writer
)) {
634 /* Preserve original error code */
635 ret
= ret
? ret
: -LTTNG_ERR_MI_IO_FAIL
;
638 if (!opt_session_name
) {
642 /* Overwrite ret if an error occurred during handle_command */
643 ret
= command_ret
? command_ret
: ret
;