src/bin/lttng/commands/destroy.cpp

   1 /*
   2  * Copyright (C) 2011 EfficiOS Inc.
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #define _LGPL_SOURCE
   9 #include "../command.hpp"
  10
  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>
  17
  18 #include <lttng/lttng.h>
  19
  20 #include <popt.h>
  21 #include <stdbool.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <sys/stat.h>
  26 #include <sys/types.h>
  27 #include <unistd.h>
  28
  29 enum {
  30         OPT_HELP = 1,
  31         OPT_LIST_OPTIONS,
  32         OPT_ALL,
  33         OPT_ENABLE_GLOB,
  34 };
  35
  36 namespace {
  37 #ifdef LTTNG_EMBED_HELP
  38 const char help_msg[] =
  39 #include <lttng-destroy.1.h>
  40         ;
  41 #endif
  42
  43 int opt_no_wait;
  44
  45 /* Mi writer */
  46 struct mi_writer *writer;
  47
  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 }
  56 };
  57
  58 /*
  59  * destroy_session
  60  *
  61  * Unregister the provided session to the session daemon. On success, removes
  62  * the default configuration.
  63  */
  64 cmd_error_code destroy_session(const lttng_session& session)
  65 {
  66         int ret;
  67         bool newline_needed = false, printed_destroy_msg = false;
  68
  69         const auto print_trailing_new_line = lttng::make_scope_exit([&newline_needed]() noexcept {
  70                 if (newline_needed) {
  71                         MSG("");
  72                 }
  73         });
  74
  75         ret = lttng_stop_tracing_no_wait(session.name);
  76         if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
  77                 LTTNG_THROW_CTL(lttng::format("Failed to stop session `{}`", session.name),
  78                                 static_cast<lttng_error_code>(-ret));
  79         }
  80
  81         const auto session_was_already_stopped = ret == -LTTNG_ERR_TRACE_ALREADY_STOPPED;
  82         if (!opt_no_wait) {
  83                 do {
  84                         ret = lttng_data_pending(session.name);
  85                         if (ret < 0) {
  86                                 /* Return the data available call error. */
  87                                 ERR_FMT("Failed to check pending data for session `{}` ({})",
  88                                         session.name,
  89                                         lttng_strerror(ret));
  90                                 return CMD_ERROR;
  91                         }
  92
  93                         /*
  94                          * Data sleep time before retrying (in usec). Don't
  95                          * sleep if the call returned value indicates
  96                          * availability.
  97                          */
  98                         if (ret) {
  99                                 if (!printed_destroy_msg) {
 100                                         _MSG("Destroying session `%s`", session.name);
 101                                         newline_needed = true;
 102                                         printed_destroy_msg = true;
 103                                         fflush(stdout);
 104                                 }
 105
 106                                 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US);
 107                                 _MSG(".");
 108                                 fflush(stdout);
 109                         }
 110                 } while (ret != 0);
 111         }
 112
 113         std::unique_ptr<char, lttng::memory::create_deleter_class<char, lttng::free>::deleter>
 114                 stats_str;
 115         if (!session_was_already_stopped) {
 116                 char *raw_stats_str = nullptr;
 117
 118                 /*
 119                  * Don't print the event and packet loss warnings since the user
 120                  * already saw them when stopping the trace.
 121                  */
 122                 ret = get_session_stats_str(session.name, &raw_stats_str);
 123                 if (ret < 0) {
 124                         return CMD_ERROR;
 125                 }
 126
 127                 /* May still be null if there are no stats to print. */
 128                 stats_str.reset(raw_stats_str);
 129         }
 130
 131         const auto destruction_handle = [&session]() {
 132                 struct lttng_destruction_handle *raw_destruction_handle = nullptr;
 133
 134                 auto ctl_ret_code =
 135                         lttng_destroy_session_ext(session.name, &raw_destruction_handle);
 136                 if (ctl_ret_code != LTTNG_OK) {
 137                         LTTNG_THROW_CTL(lttng::format("Failed to destroy session `{}`",
 138                                                       session.name),
 139                                         ctl_ret_code);
 140                 }
 141
 142                 return lttng::make_unique_wrapper<lttng_destruction_handle,
 143                                                   lttng_destruction_handle_destroy>(
 144                         raw_destruction_handle);
 145         }();
 146
 147         if (!opt_no_wait) {
 148                 enum lttng_destruction_handle_status status;
 149
 150                 do {
 151                         status = lttng_destruction_handle_wait_for_completion(
 152                                 destruction_handle.get(),
 153                                 DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US / USEC_PER_MSEC);
 154                         switch (status) {
 155                         case LTTNG_DESTRUCTION_HANDLE_STATUS_TIMEOUT:
 156                                 if (!printed_destroy_msg) {
 157                                         _MSG("Destroying session `%s`", session.name);
 158                                         newline_needed = true;
 159                                         printed_destroy_msg = true;
 160                                 }
 161                                 _MSG(".");
 162                                 fflush(stdout);
 163                                 break;
 164                         case LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED:
 165                                 break;
 166                         default:
 167                                 ERR_FMT("{}An error occurred during the destruction of session `{}`",
 168                                         newline_needed ? "\n" : "",
 169                                         session.name);
 170                                 newline_needed = false;
 171                                 return CMD_ERROR;
 172                         }
 173                 } while (status == LTTNG_DESTRUCTION_HANDLE_STATUS_TIMEOUT);
 174
 175                 enum lttng_error_code ctl_ret_code;
 176                 status = lttng_destruction_handle_get_result(destruction_handle.get(),
 177                                                              &ctl_ret_code);
 178                 if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
 179                         ERR_FMT("{}Failed to query the result of the destruction of session `{}`",
 180                                 newline_needed ? "\n" : "",
 181                                 session.name);
 182
 183                         newline_needed = false;
 184                         return CMD_ERROR;
 185                 }
 186
 187                 if (ctl_ret_code != LTTNG_OK) {
 188                         LTTNG_THROW_CTL(lttng::format("Failed to destroy session `{}`",
 189                                                       session.name),
 190                                         ctl_ret_code);
 191                 }
 192
 193                 enum lttng_rotation_state rotation_state;
 194                 status = lttng_destruction_handle_get_rotation_state(destruction_handle.get(),
 195                                                                      &rotation_state);
 196                 if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
 197                         ERR_FMT("{}Failed to query the rotation state from the destruction handle of session `{}`",
 198                                 newline_needed ? "\n" : "",
 199                                 session.name);
 200                         newline_needed = false;
 201                 } else {
 202                         switch (rotation_state) {
 203                         case LTTNG_ROTATION_STATE_NO_ROTATION:
 204                                 break;
 205                         case LTTNG_ROTATION_STATE_COMPLETED:
 206                         {
 207                                 const struct lttng_trace_archive_location *location;
 208
 209                                 status = lttng_destruction_handle_get_archive_location(
 210                                         destruction_handle.get(), &location);
 211                                 if (status == LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
 212                                         ret = print_trace_archive_location(location, session.name);
 213                                         if (ret) {
 214                                                 ERR_FMT("{}Failed to print the location of the latest trace archive of session `{}`",
 215                                                         newline_needed ? "\n" : "",
 216                                                         session.name);
 217                                                 newline_needed = false;
 218                                         }
 219
 220                                         break;
 221                                 }
 222                         }
 223                         /* fall-through. */
 224                         default:
 225                                 ERR_FMT("{}Failed to get the location of the rotation performed during the destruction of `{}`",
 226                                         newline_needed ? "\n" : "",
 227                                         session.name);
 228                                 newline_needed = false;
 229                                 break;
 230                         }
 231                 }
 232         }
 233
 234         MSG("%sSession `%s` destroyed", newline_needed ? "\n" : "", session.name);
 235         newline_needed = false;
 236         if (stats_str) {
 237                 MSG("%s", stats_str.get());
 238         }
 239
 240         /*
 241          * If the session being destroy is the "default" session as defined in the .lttngrc file,
 242          * destroy the file.
 243          */
 244         const auto session_name =
 245                 lttng::make_unique_wrapper<char, lttng::free>(get_session_name_quiet());
 246         if (session_name && !strncmp(session.name, session_name.get(), NAME_MAX)) {
 247                 config_destroy_default();
 248         }
 249
 250         if (lttng_opt_mi) {
 251                 ret = mi_lttng_session(writer, &session, 0);
 252                 if (ret) {
 253                         return CMD_ERROR;
 254                 }
 255         }
 256
 257         return CMD_SUCCESS;
 258 }
 259
 260 cmd_error_code destroy_sessions(const lttng::cli::session_spec& spec)
 261 {
 262         bool had_warning = false;
 263         bool had_error = false;
 264         bool listing_failed = false;
 265
 266         const auto sessions = [&listing_failed, &spec]() -> lttng::cli::session_list {
 267                 try {
 268                         return list_sessions(spec);
 269                 } catch (const lttng::ctl::error& ctl_exception) {
 270                         ERR_FMT("Failed to list sessions ({})",
 271                                 lttng_strerror(-ctl_exception.code()));
 272                         listing_failed = true;
 273                         return {};
 274                 }
 275         }();
 276
 277         if (!listing_failed && sessions.size() == 0 &&
 278             spec.type_ == lttng::cli::session_spec::type::NAME) {
 279                 ERR_FMT("Session `{}` not found", spec.value);
 280                 return CMD_ERROR;
 281         }
 282
 283         if (listing_failed) {
 284                 return CMD_FATAL;
 285         }
 286
 287         for (const auto& session : sessions) {
 288                 cmd_error_code sub_ret;
 289
 290                 try {
 291                         sub_ret = destroy_session(session);
 292                 } catch (const lttng::ctl::error& ctl_exception) {
 293                         switch (ctl_exception.code()) {
 294                         case LTTNG_ERR_NO_SESSION:
 295                                 if (spec.type_ != lttng::cli::session_spec::type::NAME) {
 296                                         /* Session destroyed during command, ignore and carry-on. */
 297                                         sub_ret = CMD_SUCCESS;
 298                                         break;
 299                                 } else {
 300                                         sub_ret = CMD_ERROR;
 301                                         break;
 302                                 }
 303                         case LTTNG_ERR_NO_SESSIOND:
 304                                 /* Don't keep going on a fatal error. */
 305                                 return CMD_FATAL;
 306                         default:
 307                                 /* Generic error. */
 308                                 sub_ret = CMD_ERROR;
 309                                 ERR_FMT("Failed to destroy session `{}` ({})",
 310                                         session.name,
 311                                         lttng_strerror(-ctl_exception.code()));
 312                                 break;
 313                         }
 314                 }
 315
 316                 /* Keep going, but report the most serious state. */
 317                 had_warning |= sub_ret == CMD_WARNING;
 318                 had_error |= sub_ret == CMD_ERROR;
 319         }
 320
 321         if (had_error) {
 322                 return CMD_ERROR;
 323         } else if (had_warning) {
 324                 return CMD_WARNING;
 325         } else {
 326                 return CMD_SUCCESS;
 327         }
 328 }
 329 } /* namespace */
 330
 331 /*
 332  * The 'destroy <options>' first level command
 333  */
 334 int cmd_destroy(int argc, const char **argv)
 335 {
 336         int opt;
 337         cmd_error_code command_ret = CMD_SUCCESS;
 338         bool success;
 339         static poptContext pc;
 340         const char *leftover = nullptr;
 341         lttng::cli::session_spec spec(lttng::cli::session_spec::type::NAME);
 342         lttng::cli::session_list const sessions;
 343
 344         pc = poptGetContext(nullptr, argc, argv, long_options, 0);
 345         poptReadDefaultConfig(pc, 0);
 346
 347         while ((opt = poptGetNextOpt(pc)) != -1) {
 348                 switch (opt) {
 349                 case OPT_HELP:
 350                 {
 351                         int ret;
 352
 353                         SHOW_HELP();
 354                         command_ret = static_cast<cmd_error_code>(ret);
 355                         goto end;
 356                 }
 357                 case OPT_LIST_OPTIONS:
 358                         list_cmd_options(stdout, long_options);
 359                         goto end;
 360                 case OPT_ALL:
 361                         spec.type_ = lttng::cli::session_spec::type::ALL;
 362                         break;
 363                 case OPT_ENABLE_GLOB:
 364                         spec.type_ = lttng::cli::session_spec::type::GLOB_PATTERN;
 365                         break;
 366                 default:
 367                         command_ret = CMD_UNDEFINED;
 368                         goto end;
 369                 }
 370         }
 371
 372         /* Mi preparation */
 373         if (lttng_opt_mi) {
 374                 writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
 375                 if (!writer) {
 376                         command_ret = CMD_ERROR;
 377                         goto end;
 378                 }
 379
 380                 /* Open command element */
 381                 if (mi_lttng_writer_command_open(writer, mi_lttng_element_command_destroy)) {
 382                         command_ret = CMD_ERROR;
 383                         goto end;
 384                 }
 385
 386                 /* Open output element */
 387                 if (mi_lttng_writer_open_element(writer, mi_lttng_element_command_output)) {
 388                         command_ret = CMD_ERROR;
 389                         goto end;
 390                 }
 391
 392                 /* For validation and semantic purpose we open a sessions element */
 393                 if (mi_lttng_sessions_open(writer)) {
 394                         command_ret = CMD_ERROR;
 395                         goto end;
 396                 }
 397         }
 398
 399         spec.value = poptGetArg(pc);
 400
 401         command_ret = destroy_sessions(spec);
 402
 403         success = command_ret == CMD_SUCCESS;
 404
 405         leftover = poptGetArg(pc);
 406         if (leftover) {
 407                 ERR("Unknown argument: %s", leftover);
 408                 command_ret = CMD_ERROR;
 409                 success = false;
 410         }
 411
 412         /* Mi closing */
 413         if (lttng_opt_mi) {
 414                 /* Close sessions and output element element */
 415                 if (mi_lttng_close_multi_element(writer, 2)) {
 416                         command_ret = CMD_ERROR;
 417                         goto end;
 418                 }
 419
 420                 /* Success ? */
 421                 if (mi_lttng_writer_write_element_bool(
 422                             writer, mi_lttng_element_command_success, success)) {
 423                         command_ret = CMD_ERROR;
 424                         goto end;
 425                 }
 426
 427                 /* Command element close */
 428                 if (mi_lttng_writer_command_close(writer)) {
 429                         command_ret = CMD_ERROR;
 430                         goto end;
 431                 }
 432         }
 433 end:
 434         /* Mi clean-up */
 435         if (writer && mi_lttng_writer_destroy(writer)) {
 436                 command_ret = CMD_ERROR;
 437         }
 438
 439         poptFreeContext(pc);
 440         return command_ret;
 441 }