2 * Copyright (C) 2011 EfficiOS Inc.
4 * SPDX-License-Identifier: GPL-2.0-only
9 #include "../command.hpp"
10 #include "../exception.hpp"
11 #include "../utils.hpp"
13 #include <common/exception.hpp>
14 #include <common/mi-lttng.hpp>
15 #include <common/sessiond-comm/sessiond-comm.hpp>
22 #include <sys/types.h>
34 struct mi_writer
*writer
;
36 #ifdef LTTNG_EMBED_HELP
37 const char help_msg
[] =
38 #include <lttng-stop.1.h>
42 struct poptOption long_options
[] = {
43 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
44 { "help", 'h', POPT_ARG_NONE
, nullptr, OPT_HELP
, nullptr, nullptr },
45 { "list-options", 0, POPT_ARG_NONE
, nullptr, OPT_LIST_OPTIONS
, nullptr, nullptr },
46 { "no-wait", 'n', POPT_ARG_VAL
, &opt_no_wait
, 1, nullptr, nullptr },
47 { "glob", 'g', POPT_ARG_NONE
, nullptr, OPT_ENABLE_GLOB
, nullptr, nullptr },
48 { "all", 'a', POPT_ARG_NONE
, nullptr, OPT_ALL
, nullptr, nullptr },
49 { nullptr, 0, 0, nullptr, 0, nullptr, nullptr }
53 * Mi print of partial session
55 int mi_print_session(const char *session_name
, int enabled
)
59 LTTNG_ASSERT(session_name
);
61 /* Open session element */
62 ret
= mi_lttng_writer_open_element(writer
, config_element_session
);
67 /* Print session name element */
68 ret
= mi_lttng_writer_write_element_string(writer
, config_element_name
, session_name
);
74 ret
= mi_lttng_writer_write_element_bool(writer
, config_element_enabled
, enabled
);
79 /* Close session element */
80 ret
= mi_lttng_writer_close_element(writer
);
87 * Start tracing for all trace of the session.
89 cmd_error_code
stop_tracing(const char *session_name
)
93 ret
= lttng_stop_tracing_no_wait(session_name
);
95 LTTNG_THROW_CTL(lttng::format("Failed to start session `{}`", session_name
),
96 static_cast<lttng_error_code
>(-ret
));
100 _MSG("Waiting for data availability");
103 ret
= lttng_data_pending(session_name
);
105 /* Return the data available call error. */
106 ERR_FMT("Failed to check pending data for session `{}` ({})",
108 lttng_strerror(ret
));
113 * Data sleep time before retrying (in usec). Don't sleep if the call
114 * returned value indicates availability.
117 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US
);
125 print_session_stats(session_name
);
126 MSG("Tracing stopped for session `%s`", session_name
);
128 if (mi_print_session(session_name
, 0)) {
136 cmd_error_code
stop_tracing(const lttng::cli::session_spec
& spec
)
138 bool had_warning
= false;
139 bool had_error
= false;
140 bool listing_failed
= false;
142 const auto sessions
= [&listing_failed
, &spec
]() -> lttng::cli::session_list
{
144 return list_sessions(spec
);
145 } catch (const lttng::ctl::error
& ctl_exception
) {
146 ERR_FMT("Failed to list sessions ({})",
147 lttng_strerror(-ctl_exception
.code()));
148 listing_failed
= true;
150 } catch (const lttng::cli::no_default_session_error
& cli_exception
) {
152 * The retrieval of the default session name already logs
153 * an error when it fails. There is no value in printing
154 * anything about this exception.
156 listing_failed
= true;
161 if (!listing_failed
&& sessions
.size() == 0 &&
162 spec
.type_
== lttng::cli::session_spec::type::NAME
) {
163 ERR_FMT("Session `{}` not found", spec
.value
);
167 if (listing_failed
) {
171 for (const auto& session
: sessions
) {
172 cmd_error_code sub_ret
;
175 sub_ret
= stop_tracing(session
.name
);
176 } catch (const lttng::ctl::error
& ctl_exception
) {
177 switch (ctl_exception
.code()) {
178 case LTTNG_ERR_TRACE_ALREADY_STOPPED
:
179 WARN_FMT("Tracing already stopped for session `{}`", session
.name
);
180 sub_ret
= CMD_SUCCESS
;
182 case LTTNG_ERR_NO_SESSION
:
183 if (spec
.type_
!= lttng::cli::session_spec::type::NAME
) {
184 /* Session destroyed during command, ignore and carry-on. */
185 sub_ret
= CMD_SUCCESS
;
191 case LTTNG_ERR_NO_SESSIOND
:
192 /* Don't keep going on a fatal error. */
197 ERR_FMT("Failed to stop session `{}` ({})",
199 lttng_strerror(-ctl_exception
.code()));
204 /* Keep going, but report the most serious state. */
205 had_warning
|= sub_ret
== CMD_WARNING
;
206 had_error
|= sub_ret
== CMD_ERROR
;
211 } else if (had_warning
) {
222 * The 'stop <options>' first level command
224 int cmd_stop(int argc
, const char **argv
)
227 cmd_error_code command_ret
= CMD_SUCCESS
;
229 static poptContext pc
;
230 const char *leftover
= nullptr;
231 lttng::cli::session_spec
session_spec(lttng::cli::session_spec::type::NAME
);
233 pc
= poptGetContext(nullptr, argc
, argv
, long_options
, 0);
234 poptReadDefaultConfig(pc
, 0);
236 while ((opt
= poptGetNextOpt(pc
)) != -1) {
243 command_ret
= static_cast<cmd_error_code
>(ret
);
246 case OPT_LIST_OPTIONS
:
247 list_cmd_options(stdout
, long_options
);
249 case OPT_ENABLE_GLOB
:
250 session_spec
.type_
= lttng::cli::session_spec::type::GLOB_PATTERN
;
253 session_spec
.type_
= lttng::cli::session_spec::type::ALL
;
256 command_ret
= CMD_UNDEFINED
;
263 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
265 command_ret
= CMD_ERROR
;
269 /* Open command element */
270 if (mi_lttng_writer_command_open(writer
, mi_lttng_element_command_stop
)) {
271 command_ret
= CMD_ERROR
;
275 /* Open output element */
276 if (mi_lttng_writer_open_element(writer
, mi_lttng_element_command_output
)) {
277 command_ret
= CMD_ERROR
;
282 * Open sessions element
285 if (mi_lttng_writer_open_element(writer
, config_element_sessions
)) {
286 command_ret
= CMD_ERROR
;
291 session_spec
.value
= poptGetArg(pc
);
293 leftover
= poptGetArg(pc
);
295 ERR("Unknown argument: %s", leftover
);
296 command_ret
= CMD_ERROR
;
300 command_ret
= stop_tracing(session_spec
);
307 /* Close sessions and output element */
308 if (mi_lttng_close_multi_element(writer
, 2)) {
309 command_ret
= CMD_ERROR
;
314 if (mi_lttng_writer_write_element_bool(
315 writer
, mi_lttng_element_command_success
, success
)) {
316 command_ret
= CMD_ERROR
;
320 /* Command element close */
321 if (mi_lttng_writer_command_close(writer
)) {
322 command_ret
= CMD_ERROR
;
329 if (writer
&& mi_lttng_writer_destroy(writer
)) {
330 command_ret
= CMD_ERROR
;