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,
 114                         lttng::memory::create_deleter_class<char, lttng::memory::free>::deleter>
 115                 stats_str;
 116         if (!session_was_already_stopped) {
 117                 char *raw_stats_str = nullptr;
 118
 119                 /*
 120                  * Don't print the event and packet loss warnings since the user
 121                  * already saw them when stopping the trace.
 122                  */
 123                 ret = get_session_stats_str(session.name, &raw_stats_str);
 124                 if (ret < 0) {
 125                         return CMD_ERROR;
 126                 }
 127
 128                 /* May still be null if there are no stats to print. */
 129                 stats_str.reset(raw_stats_str);
 130         }
 131
 132         const auto destruction_handle = [&session]() {
 133                 struct lttng_destruction_handle *raw_destruction_handle = nullptr;
 134
 135                 auto ctl_ret_code =
 136                         lttng_destroy_session_ext(session.name, &raw_destruction_handle);
 137                 if (ctl_ret_code != LTTNG_OK) {
 138                         LTTNG_THROW_CTL(lttng::format("Failed to destroy session `{}`",
 139                                                       session.name),
 140                                         ctl_ret_code);
 141                 }
 142
 143                 return lttng::make_unique_wrapper<lttng_destruction_handle,
 144                                                   lttng_destruction_handle_destroy>(
 145                         raw_destruction_handle);
 146         }();
 147
 148         if (!opt_no_wait) {
 149                 enum lttng_destruction_handle_status status;
 150
 151                 do {
 152                         status = lttng_destruction_handle_wait_for_completion(
 153                                 destruction_handle.get(),
 154                                 DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US / USEC_PER_MSEC);
 155                         switch (status) {
 156                         case LTTNG_DESTRUCTION_HANDLE_STATUS_TIMEOUT:
 157                                 if (!printed_destroy_msg) {
 158                                         _MSG("Destroying session `%s`", session.name);
 159                                         newline_needed = true;
 160                                         printed_destroy_msg = true;
 161                                 }
 162                                 _MSG(".");
 163                                 fflush(stdout);
 164                                 break;
 165                         case LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED:
 166                                 break;
 167                         default:
 168                                 ERR_FMT("{}An error occurred during the destruction of session `{}`",
 169                                         newline_needed ? "\n" : "",
 170                                         session.name);
 171                                 newline_needed = false;
 172                                 return CMD_ERROR;
 173                         }
 174                 } while (status == LTTNG_DESTRUCTION_HANDLE_STATUS_TIMEOUT);
 175
 176                 enum lttng_error_code ctl_ret_code;
 177                 status = lttng_destruction_handle_get_result(destruction_handle.get(),
 178                                                              &ctl_ret_code);
 179                 if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
 180                         ERR_FMT("{}Failed to query the result of the destruction of session `{}`",
 181                                 newline_needed ? "\n" : "",
 182                                 session.name);
 183
 184                         newline_needed = false;
 185                         return CMD_ERROR;
 186                 }
 187
 188                 if (ctl_ret_code != LTTNG_OK) {
 189                         LTTNG_THROW_CTL(lttng::format("Failed to destroy session `{}`",
 190                                                       session.name),
 191                                         ctl_ret_code);
 192                 }
 193
 194                 enum lttng_rotation_state rotation_state;
 195                 status = lttng_destruction_handle_get_rotation_state(destruction_handle.get(),
 196                                                                      &rotation_state);
 197                 if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
 198                         ERR_FMT("{}Failed to query the rotation state from the destruction handle of session `{}`",
 199                                 newline_needed ? "\n" : "",
 200                                 session.name);
 201                         newline_needed = false;
 202                 } else {
 203                         switch (rotation_state) {
 204                         case LTTNG_ROTATION_STATE_NO_ROTATION:
 205                                 break;
 206                         case LTTNG_ROTATION_STATE_COMPLETED:
 207                         {
 208                                 const struct lttng_trace_archive_location *location;
 209
 210                                 status = lttng_destruction_handle_get_archive_location(
 211                                         destruction_handle.get(), &location);
 212                                 if (status == LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
 213                                         ret = print_trace_archive_location(location, session.name);
 214                                         if (ret) {
 215                                                 ERR_FMT("{}Failed to print the location of the latest trace archive of session `{}`",
 216                                                         newline_needed ? "\n" : "",
 217                                                         session.name);
 218                                                 newline_needed = false;
 219                                         }
 220
 221                                         break;
 222                                 }
 223                         }
 224                         /* fall-through. */
 225                         default:
 226                                 ERR_FMT("{}Failed to get the location of the rotation performed during the destruction of `{}`",
 227                                         newline_needed ? "\n" : "",
 228                                         session.name);
 229                                 newline_needed = false;
 230                                 break;
 231                         }
 232                 }
 233         }
 234
 235         MSG("%sSession `%s` destroyed", newline_needed ? "\n" : "", session.name);
 236         newline_needed = false;
 237         if (stats_str) {
 238                 MSG("%s", stats_str.get());
 239         }
 240
 241         /*
 242          * If the session being destroy is the "default" session as defined in the .lttngrc file,
 243          * destroy the file.
 244          */
 245         const auto session_name =
 246                 lttng::make_unique_wrapper<char, lttng::memory::free>(get_session_name_quiet());
 247         if (session_name && !strncmp(session.name, session_name.get(), NAME_MAX)) {
 248                 config_destroy_default();
 249         }
 250
 251         if (lttng_opt_mi) {
 252                 ret = mi_lttng_session(writer, &session, 0);
 253                 if (ret) {
 254                         return CMD_ERROR;
 255                 }
 256         }
 257
 258         return CMD_SUCCESS;
 259 }
 260
 261 cmd_error_code destroy_sessions(const lttng::cli::session_spec& spec)
 262 {
 263         bool had_warning = false;
 264         bool had_error = false;
 265         bool listing_failed = false;
 266
 267         const auto sessions = [&listing_failed, &spec]() -> lttng::cli::session_list {
 268                 try {
 269                         return list_sessions(spec);
 270                 } catch (const lttng::ctl::error& ctl_exception) {
 271                         ERR_FMT("Failed to list sessions ({})",
 272                                 lttng_strerror(-ctl_exception.code()));
 273                         listing_failed = true;
 274                         return {};
 275                 }
 276         }();
 277
 278         if (!listing_failed && sessions.size() == 0 &&
 279             spec.type_ == lttng::cli::session_spec::type::NAME) {
 280                 ERR_FMT("Session `{}` not found", spec.value);
 281                 return CMD_ERROR;
 282         }
 283
 284         if (listing_failed) {
 285                 return CMD_FATAL;
 286         }
 287
 288         for (const auto& session : sessions) {
 289                 cmd_error_code sub_ret;
 290
 291                 try {
 292                         sub_ret = destroy_session(session);
 293                 } catch (const lttng::ctl::error& ctl_exception) {
 294                         switch (ctl_exception.code()) {
 295                         case LTTNG_ERR_NO_SESSION:
 296                                 if (spec.type_ != lttng::cli::session_spec::type::NAME) {
 297                                         /* Session destroyed during command, ignore and carry-on. */
 298                                         sub_ret = CMD_SUCCESS;
 299                                         break;
 300                                 } else {
 301                                         sub_ret = CMD_ERROR;
 302                                         break;
 303                                 }
 304                         case LTTNG_ERR_NO_SESSIOND:
 305                                 /* Don't keep going on a fatal error. */
 306                                 return CMD_FATAL;
 307                         default:
 308                                 /* Generic error. */
 309                                 sub_ret = CMD_ERROR;
 310                                 ERR_FMT("Failed to destroy session `{}` ({})",
 311                                         session.name,
 312                                         lttng_strerror(-ctl_exception.code()));
 313                                 break;
 314                         }
 315                 }
 316
 317                 /* Keep going, but report the most serious state. */
 318                 had_warning |= sub_ret == CMD_WARNING;
 319                 had_error |= sub_ret == CMD_ERROR;
 320         }
 321
 322         if (had_error) {
 323                 return CMD_ERROR;
 324         } else if (had_warning) {
 325                 return CMD_WARNING;
 326         } else {
 327                 return CMD_SUCCESS;
 328         }
 329 }
 330 } /* namespace */
 331
 332 /*
 333  * The 'destroy <options>' first level command
 334  */
 335 int cmd_destroy(int argc, const char **argv)
 336 {
 337         int opt;
 338         cmd_error_code command_ret = CMD_SUCCESS;
 339         bool success;
 340         static poptContext pc;
 341         const char *leftover = nullptr;
 342         lttng::cli::session_spec spec(lttng::cli::session_spec::type::NAME);
 343         lttng::cli::session_list const sessions;
 344
 345         pc = poptGetContext(nullptr, argc, argv, long_options, 0);
 346         poptReadDefaultConfig(pc, 0);
 347
 348         while ((opt = poptGetNextOpt(pc)) != -1) {
 349                 switch (opt) {
 350                 case OPT_HELP:
 351                 {
 352                         int ret;
 353
 354                         SHOW_HELP();
 355                         command_ret = static_cast<cmd_error_code>(ret);
 356                         goto end;
 357                 }
 358                 case OPT_LIST_OPTIONS:
 359                         list_cmd_options(stdout, long_options);
 360                         goto end;
 361                 case OPT_ALL:
 362                         spec.type_ = lttng::cli::session_spec::type::ALL;
 363                         break;
 364                 case OPT_ENABLE_GLOB:
 365                         spec.type_ = lttng::cli::session_spec::type::GLOB_PATTERN;
 366                         break;
 367                 default:
 368                         command_ret = CMD_UNDEFINED;
 369                         goto end;
 370                 }
 371         }
 372
 373         /* Mi preparation */
 374         if (lttng_opt_mi) {
 375                 writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
 376                 if (!writer) {
 377                         command_ret = CMD_ERROR;
 378                         goto end;
 379                 }
 380
 381                 /* Open command element */
 382                 if (mi_lttng_writer_command_open(writer, mi_lttng_element_command_destroy)) {
 383                         command_ret = CMD_ERROR;
 384                         goto end;
 385                 }
 386
 387                 /* Open output element */
 388                 if (mi_lttng_writer_open_element(writer, mi_lttng_element_command_output)) {
 389                         command_ret = CMD_ERROR;
 390                         goto end;
 391                 }
 392
 393                 /* For validation and semantic purpose we open a sessions element */
 394                 if (mi_lttng_sessions_open(writer)) {
 395                         command_ret = CMD_ERROR;
 396                         goto end;
 397                 }
 398         }
 399
 400         spec.value = poptGetArg(pc);
 401
 402         command_ret = destroy_sessions(spec);
 403
 404         success = command_ret == CMD_SUCCESS;
 405
 406         leftover = poptGetArg(pc);
 407         if (leftover) {
 408                 ERR("Unknown argument: %s", leftover);
 409                 command_ret = CMD_ERROR;
 410                 success = false;
 411         }
 412
 413         /* Mi closing */
 414         if (lttng_opt_mi) {
 415                 /* Close sessions and output element element */
 416                 if (mi_lttng_close_multi_element(writer, 2)) {
 417                         command_ret = CMD_ERROR;
 418                         goto end;
 419                 }
 420
 421                 /* Success ? */
 422                 if (mi_lttng_writer_write_element_bool(
 423                             writer, mi_lttng_element_command_success, success)) {
 424                         command_ret = CMD_ERROR;
 425                         goto end;
 426                 }
 427
 428                 /* Command element close */
 429                 if (mi_lttng_writer_command_close(writer)) {
 430                         command_ret = CMD_ERROR;
 431                         goto end;
 432                 }
 433         }
 434 end:
 435         /* Mi clean-up */
 436         if (writer && mi_lttng_writer_destroy(writer)) {
 437                 command_ret = CMD_ERROR;
 438         }
 439
 440         poptFreeContext(pc);
 441         return command_ret;
 442 }