2 * Copyright (C) 2011 EfficiOS Inc.
4 * SPDX-License-Identifier: GPL-2.0-only
9 #include "../command.hpp"
11 #include <common/exception.hpp>
12 #include <common/make-unique-wrapper.hpp>
13 #include <common/mi-lttng.hpp>
14 #include <common/scope-exit.hpp>
15 #include <common/sessiond-comm/sessiond-comm.hpp>
16 #include <common/utils.hpp>
18 #include <lttng/lttng.h>
26 #include <sys/types.h>
37 #ifdef LTTNG_EMBED_HELP
38 const char help_msg
[] =
39 #include <lttng-destroy.1.h>
46 struct mi_writer
*writer
;
48 struct poptOption long_options
[] = {
49 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
50 { "help", 'h', POPT_ARG_NONE
, nullptr, OPT_HELP
, nullptr, nullptr },
51 { "all", 'a', POPT_ARG_NONE
, nullptr, OPT_ALL
, nullptr, nullptr },
52 { "glob", 'g', POPT_ARG_NONE
, nullptr, OPT_ENABLE_GLOB
, nullptr, nullptr },
53 { "list-options", 0, POPT_ARG_NONE
, nullptr, OPT_LIST_OPTIONS
, nullptr, nullptr },
54 { "no-wait", 'n', POPT_ARG_VAL
, &opt_no_wait
, 1, nullptr, nullptr },
55 { nullptr, 0, 0, nullptr, 0, nullptr, nullptr }
61 * Unregister the provided session to the session daemon. On success, removes
62 * the default configuration.
64 cmd_error_code
destroy_session(const lttng_session
& session
)
67 bool newline_needed
= false, printed_destroy_msg
= false;
69 const auto print_trailing_new_line
= lttng::make_scope_exit([&newline_needed
]() noexcept
{
75 ret
= lttng_stop_tracing_no_wait(session
.name
);
76 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
77 LTTNG_THROW_CTL(fmt::format("Failed to stop session `{}`", session
.name
),
78 static_cast<lttng_error_code
>(-ret
));
81 const auto session_was_already_stopped
= ret
== -LTTNG_ERR_TRACE_ALREADY_STOPPED
;
84 ret
= lttng_data_pending(session
.name
);
86 /* Return the data available call error. */
87 ERR_FMT("Failed to check pending data for session `{}` ({})",
94 * Data sleep time before retrying (in usec). Don't
95 * sleep if the call returned value indicates
99 if (!printed_destroy_msg
) {
100 _MSG("Destroying session `%s`", session
.name
);
101 newline_needed
= true;
102 printed_destroy_msg
= true;
106 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US
);
113 std::unique_ptr
<char, lttng::memory::create_deleter_class
<char, lttng::free
>::deleter
>
115 if (!session_was_already_stopped
) {
116 char *raw_stats_str
= nullptr;
119 * Don't print the event and packet loss warnings since the user
120 * already saw them when stopping the trace.
122 ret
= get_session_stats_str(session
.name
, &raw_stats_str
);
127 /* May still be null if there are no stats to print. */
128 stats_str
.reset(raw_stats_str
);
131 const auto destruction_handle
= [&session
]() {
132 struct lttng_destruction_handle
*raw_destruction_handle
= nullptr;
135 lttng_destroy_session_ext(session
.name
, &raw_destruction_handle
);
136 if (ctl_ret_code
!= LTTNG_OK
) {
137 LTTNG_THROW_CTL(fmt::format("Failed to destroy session `{}`", session
.name
),
141 return lttng::make_unique_wrapper
<lttng_destruction_handle
,
142 lttng_destruction_handle_destroy
>(
143 raw_destruction_handle
);
147 enum lttng_destruction_handle_status status
;
150 status
= lttng_destruction_handle_wait_for_completion(
151 destruction_handle
.get(),
152 DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US
/ USEC_PER_MSEC
);
154 case LTTNG_DESTRUCTION_HANDLE_STATUS_TIMEOUT
:
155 if (!printed_destroy_msg
) {
156 _MSG("Destroying session `%s`", session
.name
);
157 newline_needed
= true;
158 printed_destroy_msg
= true;
163 case LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED
:
166 ERR_FMT("{}An error occurred during the destruction of session `{}`",
167 newline_needed
? "\n" : "",
169 newline_needed
= false;
172 } while (status
== LTTNG_DESTRUCTION_HANDLE_STATUS_TIMEOUT
);
174 enum lttng_error_code ctl_ret_code
;
175 status
= lttng_destruction_handle_get_result(destruction_handle
.get(),
177 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_OK
) {
178 ERR_FMT("{}Failed to query the result of the destruction of session `{}`",
179 newline_needed
? "\n" : "",
182 newline_needed
= false;
186 if (ctl_ret_code
!= LTTNG_OK
) {
187 LTTNG_THROW_CTL(fmt::format("Failed to destroy session `{}`", session
.name
),
191 enum lttng_rotation_state rotation_state
;
192 status
= lttng_destruction_handle_get_rotation_state(destruction_handle
.get(),
194 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_OK
) {
195 ERR_FMT("{}Failed to query the rotation state from the destruction handle of session `{}`",
196 newline_needed
? "\n" : "",
198 newline_needed
= false;
200 switch (rotation_state
) {
201 case LTTNG_ROTATION_STATE_NO_ROTATION
:
203 case LTTNG_ROTATION_STATE_COMPLETED
:
205 const struct lttng_trace_archive_location
*location
;
207 status
= lttng_destruction_handle_get_archive_location(
208 destruction_handle
.get(), &location
);
209 if (status
== LTTNG_DESTRUCTION_HANDLE_STATUS_OK
) {
210 ret
= print_trace_archive_location(location
, session
.name
);
212 ERR_FMT("{}Failed to print the location of the latest trace archive of session `{}`",
213 newline_needed
? "\n" : "",
215 newline_needed
= false;
223 ERR_FMT("{}Failed to get the location of the rotation performed during the destruction of `{}`",
224 newline_needed
? "\n" : "",
226 newline_needed
= false;
232 MSG("%sSession `%s` destroyed", newline_needed
? "\n" : "", session
.name
);
233 newline_needed
= false;
235 MSG("%s", stats_str
.get());
239 * If the session being destroy is the "default" session as defined in the .lttngrc file,
242 const auto session_name
=
243 lttng::make_unique_wrapper
<char, lttng::free
>(get_session_name_quiet());
244 if (session_name
&& !strncmp(session
.name
, session_name
.get(), NAME_MAX
)) {
245 config_destroy_default();
249 ret
= mi_lttng_session(writer
, &session
, 0);
258 cmd_error_code
destroy_sessions(const session_spec
& spec
)
260 bool had_warning
= false;
261 bool had_error
= false;
262 bool listing_failed
= false;
264 const auto sessions
= [&listing_failed
, &spec
]() -> session_list
{
266 return list_sessions(spec
);
267 } catch (const lttng::ctl::error
& ctl_exception
) {
268 ERR_FMT("Failed to list sessions ({})",
269 lttng_strerror(-ctl_exception
.code()));
270 listing_failed
= true;
275 if (!listing_failed
&& sessions
.size() == 0 && spec
.type
== session_spec::type::NAME
) {
276 ERR_FMT("Session `{}` not found", spec
.value
);
280 if (listing_failed
) {
284 for (const auto& session
: sessions
) {
285 cmd_error_code sub_ret
;
288 sub_ret
= destroy_session(session
);
289 } catch (const lttng::ctl::error
& ctl_exception
) {
290 switch (ctl_exception
.code()) {
291 case LTTNG_ERR_NO_SESSION
:
292 if (spec
.type
!= session_spec::type::NAME
) {
293 /* Session destroyed during command, ignore and carry-on. */
294 sub_ret
= CMD_SUCCESS
;
300 case LTTNG_ERR_NO_SESSIOND
:
301 /* Don't keep going on a fatal error. */
306 ERR_FMT("Failed to destroy session `{}` ({})",
308 lttng_strerror(-ctl_exception
.code()));
313 /* Keep going, but report the most serious state. */
314 had_warning
|= sub_ret
== CMD_WARNING
;
315 had_error
|= sub_ret
== CMD_ERROR
;
320 } else if (had_warning
) {
329 * The 'destroy <options>' first level command
331 int cmd_destroy(int argc
, const char **argv
)
334 cmd_error_code command_ret
= CMD_SUCCESS
;
336 static poptContext pc
;
337 const char *leftover
= nullptr;
338 struct session_spec spec
= {
339 .type
= session_spec::NAME
,
342 session_list
const sessions
;
344 pc
= poptGetContext(nullptr, argc
, argv
, long_options
, 0);
345 poptReadDefaultConfig(pc
, 0);
347 while ((opt
= poptGetNextOpt(pc
)) != -1) {
354 command_ret
= static_cast<cmd_error_code
>(ret
);
357 case OPT_LIST_OPTIONS
:
358 list_cmd_options(stdout
, long_options
);
361 spec
.type
= session_spec::ALL
;
363 case OPT_ENABLE_GLOB
:
364 spec
.type
= session_spec::GLOB_PATTERN
;
367 command_ret
= CMD_UNDEFINED
;
374 writer
= mi_lttng_writer_create(fileno(stdout
), lttng_opt_mi
);
376 command_ret
= CMD_ERROR
;
380 /* Open command element */
381 if (mi_lttng_writer_command_open(writer
, mi_lttng_element_command_destroy
)) {
382 command_ret
= CMD_ERROR
;
386 /* Open output element */
387 if (mi_lttng_writer_open_element(writer
, mi_lttng_element_command_output
)) {
388 command_ret
= CMD_ERROR
;
392 /* For validation and semantic purpose we open a sessions element */
393 if (mi_lttng_sessions_open(writer
)) {
394 command_ret
= CMD_ERROR
;
399 spec
.value
= poptGetArg(pc
);
401 command_ret
= destroy_sessions(spec
);
403 success
= command_ret
== CMD_SUCCESS
;
405 leftover
= poptGetArg(pc
);
407 ERR("Unknown argument: %s", leftover
);
408 command_ret
= CMD_ERROR
;
414 /* Close sessions and output element element */
415 if (mi_lttng_close_multi_element(writer
, 2)) {
416 command_ret
= CMD_ERROR
;
421 if (mi_lttng_writer_write_element_bool(
422 writer
, mi_lttng_element_command_success
, success
)) {
423 command_ret
= CMD_ERROR
;
427 /* Command element close */
428 if (mi_lttng_writer_command_close(writer
)) {
429 command_ret
= CMD_ERROR
;
435 if (writer
&& mi_lttng_writer_destroy(writer
)) {
436 command_ret
= CMD_ERROR
;