Fix: lttng: poptGetArg doesn't provide string ownership
[lttng-tools.git] / src / bin / lttng / commands / destroy.cpp
CommitLineData
f3ed775e 1/*
21cf9b6b 2 * Copyright (C) 2011 EfficiOS Inc.
f3ed775e 3 *
ab5be9fa 4 * SPDX-License-Identifier: GPL-2.0-only
f3ed775e 5 *
f3ed775e
DG
6 */
7
6c1c0768 8#define _LGPL_SOURCE
f3ed775e
DG
9#include <popt.h>
10#include <stdio.h>
11#include <stdlib.h>
12#include <string.h>
13#include <sys/stat.h>
14#include <sys/types.h>
15#include <unistd.h>
20fb9e02 16#include <stdbool.h>
bbbfd849 17#include <lttng/lttng.h>
f3ed775e 18
c9e313bc 19#include "../command.hpp"
f3ed775e 20
c9e313bc
SM
21#include <common/mi-lttng.hpp>
22#include <common/sessiond-comm/sessiond-comm.hpp>
23#include <common/utils.hpp>
42224349 24
b09ee5ba 25static int opt_destroy_all;
e20ee7c2 26static int opt_no_wait;
f3ed775e 27
4fc83d94
PP
28#ifdef LTTNG_EMBED_HELP
29static const char help_msg[] =
30#include <lttng-destroy.1.h>
31;
32#endif
33
65f25c66
JRJ
34/* Mi writer */
35static struct mi_writer *writer;
36
f3ed775e
DG
37enum {
38 OPT_HELP = 1,
679b4943 39 OPT_LIST_OPTIONS,
f3ed775e
DG
40};
41
42static struct poptOption long_options[] = {
43 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
44 {"help", 'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
b09ee5ba 45 {"all", 'a', POPT_ARG_VAL, &opt_destroy_all, 1, 0, 0},
679b4943 46 {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
e20ee7c2 47 {"no-wait", 'n', POPT_ARG_VAL, &opt_no_wait, 1, 0, 0},
f3ed775e
DG
48 {0, 0, 0, 0, 0, 0, 0}
49};
50
f3ed775e 51/*
b09ee5ba
FG
52 * destroy_session
53 *
54 * Unregister the provided session to the session daemon. On success, removes
55 * the default configuration.
f3ed775e 56 */
65f25c66 57static int destroy_session(struct lttng_session *session)
f3ed775e
DG
58{
59 int ret;
1dac0189 60 char *session_name = NULL;
58f237ca 61 bool session_was_already_stopped;
bbbfd849
JG
62 enum lttng_error_code ret_code;
63 struct lttng_destruction_handle *handle = NULL;
58f237ca
JG
64 enum lttng_destruction_handle_status status;
65 bool newline_needed = false, printed_destroy_msg = false;
bbbfd849 66 enum lttng_rotation_state rotation_state;
58f237ca 67 char *stats_str = NULL;
f3ed775e 68
e20ee7c2
JD
69 ret = lttng_stop_tracing_no_wait(session->name);
70 if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
71 ERR("%s", lttng_strerror(ret));
72 }
58f237ca
JG
73
74 session_was_already_stopped = ret == -LTTNG_ERR_TRACE_ALREADY_STOPPED;
e20ee7c2 75 if (!opt_no_wait) {
e20ee7c2
JD
76 do {
77 ret = lttng_data_pending(session->name);
78 if (ret < 0) {
79 /* Return the data available call error. */
80 goto error;
81 }
82
83 /*
58f237ca
JG
84 * Data sleep time before retrying (in usec). Don't
85 * sleep if the call returned value indicates
86 * availability.
e20ee7c2
JD
87 */
88 if (ret) {
dec2c8e1
JG
89 if (!printed_destroy_msg) {
90 _MSG("Destroying session %s",
91 session->name);
92 newline_needed = true;
93 printed_destroy_msg = true;
94 fflush(stdout);
95 }
01f55be4 96
c8f61fd4 97 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US);
e20ee7c2
JD
98 _MSG(".");
99 fflush(stdout);
100 }
101 } while (ret != 0);
e20ee7c2 102 }
58f237ca
JG
103
104 if (!session_was_already_stopped) {
20fb9e02
JD
105 /*
106 * Don't print the event and packet loss warnings since the user
107 * already saw them when stopping the trace.
108 */
58f237ca
JG
109 ret = get_session_stats_str(session->name, &stats_str);
110 if (ret < 0) {
111 goto error;
112 }
20fb9e02 113 }
e20ee7c2 114
bbbfd849
JG
115 ret_code = lttng_destroy_session_ext(session->name, &handle);
116 if (ret_code != LTTNG_OK) {
117 ret = -ret_code;
b09ee5ba 118 goto error;
f3ed775e
DG
119 }
120
bbbfd849
JG
121 if (opt_no_wait) {
122 goto skip_wait_rotation;
123 }
124
125 do {
58f237ca
JG
126 status = lttng_destruction_handle_wait_for_completion(
127 handle, DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US /
128 USEC_PER_MSEC);
bbbfd849
JG
129 switch (status) {
130 case LTTNG_DESTRUCTION_HANDLE_STATUS_TIMEOUT:
58f237ca
JG
131 if (!printed_destroy_msg) {
132 _MSG("Destroying session %s", session->name);
133 newline_needed = true;
134 printed_destroy_msg = true;
bbbfd849
JG
135 }
136 _MSG(".");
137 fflush(stdout);
138 break;
139 case LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED:
140 break;
141 default:
58f237ca
JG
142 ERR("%sFailed to wait for the completion of the destruction of session \"%s\"",
143 newline_needed ? "\n" : "",
bbbfd849 144 session->name);
58f237ca 145 newline_needed = false;
bbbfd849
JG
146 ret = -1;
147 goto error;
148 }
149 } while (status == LTTNG_DESTRUCTION_HANDLE_STATUS_TIMEOUT);
150
151 status = lttng_destruction_handle_get_result(handle, &ret_code);
152 if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
58f237ca
JG
153 ERR("%sFailed to get the result of session destruction",
154 newline_needed ? "\n" : "");
bbbfd849 155 ret = -1;
58f237ca 156 newline_needed = false;
bbbfd849
JG
157 goto error;
158 }
159 if (ret_code != LTTNG_OK) {
3285a971 160 ret = -ret_code;
bbbfd849
JG
161 goto error;
162 }
163
58f237ca
JG
164 status = lttng_destruction_handle_get_rotation_state(
165 handle, &rotation_state);
7d81aa9f 166 if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
58f237ca
JG
167 ERR("%sFailed to get rotation state from destruction handle",
168 newline_needed ? "\n" : "");
169 newline_needed = false;
7d81aa9f
JG
170 goto skip_wait_rotation;
171 }
58f237ca 172
bbbfd849
JG
173 switch (rotation_state) {
174 case LTTNG_ROTATION_STATE_NO_ROTATION:
175 break;
58f237ca 176 case LTTNG_ROTATION_STATE_COMPLETED:
bbbfd849
JG
177 {
178 const struct lttng_trace_archive_location *location;
179
58f237ca
JG
180 status = lttng_destruction_handle_get_archive_location(
181 handle, &location);
bbbfd849 182 if (status == LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
58f237ca
JG
183 ret = print_trace_archive_location(
184 location, session->name);
bbbfd849 185 if (ret) {
58f237ca
JG
186 ERR("%sFailed to print the location of trace archive",
187 newline_needed ? "\n" : "");
188 newline_needed = false;
bbbfd849
JG
189 goto skip_wait_rotation;
190 }
191 break;
192 }
58f237ca 193 }
30eb3927 194 /* fall-through. */
58f237ca
JG
195 default:
196 ERR("%sFailed to get the location of the rotation performed during the session's destruction",
197 newline_needed ? "\n" : "");
198 newline_needed = false;
bbbfd849
JG
199 goto skip_wait_rotation;
200 }
201skip_wait_rotation:
58f237ca 202 MSG("%sSession %s destroyed", newline_needed ? "\n" : "",
bbbfd849 203 session->name);
58f237ca
JG
204 newline_needed = false;
205 if (stats_str) {
206 MSG("%s", stats_str);
207 }
1dac0189
PPM
208
209 session_name = get_session_name_quiet();
210 if (session_name && !strncmp(session->name, session_name, NAME_MAX)) {
211 config_destroy_default();
212 }
65f25c66
JRJ
213
214 if (lttng_opt_mi) {
215 ret = mi_lttng_session(writer, session, 0);
216 if (ret) {
217 ret = CMD_ERROR;
218 goto error;
219 }
220 }
221
f3ed775e 222 ret = CMD_SUCCESS;
b09ee5ba 223error:
58f237ca 224 if (newline_needed) {
f16edb77
JG
225 MSG("");
226 }
bbbfd849 227 lttng_destruction_handle_destroy(handle);
1dac0189 228 free(session_name);
58f237ca 229 free(stats_str);
b09ee5ba
FG
230 return ret;
231}
f3ed775e 232
b09ee5ba
FG
233/*
234 * destroy_all_sessions
235 *
236 * Call destroy_sessions for each registered sessions
237 */
65f25c66 238static int destroy_all_sessions(struct lttng_session *sessions, int count)
b09ee5ba 239{
3285a971
JG
240 int i;
241 bool error_occurred = false;
b09ee5ba 242
a0377dfe 243 LTTNG_ASSERT(count >= 0);
b09ee5ba
FG
244 if (count == 0) {
245 MSG("No session found, nothing to do.");
246 }
60e835ca 247
b09ee5ba 248 for (i = 0; i < count; i++) {
3285a971
JG
249 int ret = destroy_session(&sessions[i]);
250
b09ee5ba 251 if (ret < 0) {
3285a971
JG
252 ERR("%s during the destruction of session \"%s\"",
253 lttng_strerror(ret),
254 sessions[i].name);
255 /* Continue to next session. */
256 error_occurred = true;
b09ee5ba 257 }
b73d0b29 258 }
3285a971
JG
259
260 return error_occurred ? CMD_ERROR : CMD_SUCCESS;
f3ed775e
DG
261}
262
263/*
843f5df9 264 * The 'destroy <options>' first level command
f3ed775e
DG
265 */
266int cmd_destroy(int argc, const char **argv)
267{
b09ee5ba 268 int opt;
65f25c66 269 int ret = CMD_SUCCESS , i, command_ret = CMD_SUCCESS, success = 1;
f3ed775e 270 static poptContext pc;
b09ee5ba 271 char *session_name = NULL;
5b915816 272 const char *arg_session_name = NULL;
68c7f6e5 273 const char *leftover = NULL;
f3ed775e 274
6a8d2abc 275 struct lttng_session *sessions = NULL;
65f25c66
JRJ
276 int count;
277 int found;
278
f3ed775e
DG
279 pc = poptGetContext(NULL, argc, argv, long_options, 0);
280 poptReadDefaultConfig(pc, 0);
281
282 while ((opt = poptGetNextOpt(pc)) != -1) {
283 switch (opt) {
284 case OPT_HELP:
4ba92f18 285 SHOW_HELP();
b09ee5ba 286 break;
679b4943
SM
287 case OPT_LIST_OPTIONS:
288 list_cmd_options(stdout, long_options);
b09ee5ba 289 break;
f3ed775e 290 default:
f3ed775e 291 ret = CMD_UNDEFINED;
b09ee5ba 292 break;
f3ed775e 293 }
b09ee5ba 294 goto end;
f3ed775e
DG
295 }
296
65f25c66 297 /* Mi preparation */
c7e35b03 298 if (lttng_opt_mi) {
65f25c66
JRJ
299 writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
300 if (!writer) {
301 ret = -LTTNG_ERR_NOMEM;
302 goto end;
303 }
304
305 /* Open command element */
306 ret = mi_lttng_writer_command_open(writer,
307 mi_lttng_element_command_destroy);
308 if (ret) {
309 ret = CMD_ERROR;
310 goto end;
311 }
312
313 /* Open output element */
314 ret = mi_lttng_writer_open_element(writer,
315 mi_lttng_element_command_output);
316 if (ret) {
317 ret = CMD_ERROR;
318 goto end;
319 }
320
321 /* For validation and semantic purpose we open a sessions element */
322 ret = mi_lttng_sessions_open(writer);
323 if (ret) {
324 ret = CMD_ERROR;
325 goto end;
326 }
327 }
328
329 /* Recuperate all sessions for further operation */
330 count = lttng_list_sessions(&sessions);
331 if (count < 0) {
56c3ec9e
JR
332 ERR("%s", lttng_strerror(count));
333 command_ret = CMD_ERROR;
65f25c66
JRJ
334 success = 0;
335 goto mi_closing;
c7e35b03
JR
336 }
337
fd076c09 338 /* Ignore session name in case all sessions are to be destroyed */
b09ee5ba 339 if (opt_destroy_all) {
65f25c66
JRJ
340 command_ret = destroy_all_sessions(sessions, count);
341 if (command_ret) {
342 success = 0;
343 }
344 } else {
5b915816 345 arg_session_name = poptGetArg(pc);
65f25c66 346
5b915816 347 if (!arg_session_name) {
65f25c66
JRJ
348 /* No session name specified, lookup default */
349 session_name = get_session_name();
5b915816
MJ
350 } else {
351 session_name = strdup(arg_session_name);
65f25c66 352 if (session_name == NULL) {
5b915816 353 PERROR("Failed to copy session name");
65f25c66 354 }
5b915816
MJ
355 }
356
357 if (session_name == NULL) {
358 command_ret = CMD_ERROR;
359 success = 0;
360 goto mi_closing;
65f25c66 361 }
fd076c09 362
65f25c66
JRJ
363 /* Find the corresponding lttng_session struct */
364 found = 0;
365 for (i = 0; i < count; i++) {
366 if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
367 found = 1;
368 command_ret = destroy_session(&sessions[i]);
369 if (command_ret) {
370 success = 0;
3285a971
JG
371 ERR("%s during the destruction of session \"%s\"",
372 lttng_strerror(command_ret),
373 sessions[i].name);
65f25c66 374 }
65f25c66
JRJ
375 }
376 }
377
378 if (!found) {
379 ERR("Session name %s not found", session_name);
380 command_ret = LTTNG_ERR_SESS_NOT_FOUND;
381 success = 0;
382 goto mi_closing;
383 }
384 }
385
68c7f6e5
JD
386 leftover = poptGetArg(pc);
387 if (leftover) {
388 ERR("Unknown argument: %s", leftover);
389 ret = CMD_ERROR;
390 success = 0;
391 goto mi_closing;
392 }
393
65f25c66
JRJ
394mi_closing:
395 /* Mi closing */
396 if (lttng_opt_mi) {
397 /* Close sessions and output element element */
398 ret = mi_lttng_close_multi_element(writer, 2);
399 if (ret) {
fd076c09 400 ret = CMD_ERROR;
b09ee5ba
FG
401 goto end;
402 }
fd076c09 403
65f25c66
JRJ
404 /* Success ? */
405 ret = mi_lttng_writer_write_element_bool(writer,
406 mi_lttng_element_command_success, success);
407 if (ret) {
408 ret = CMD_ERROR;
409 goto end;
410 }
f3ed775e 411
65f25c66
JRJ
412 /* Command element close */
413 ret = mi_lttng_writer_command_close(writer);
414 if (ret) {
415 ret = CMD_ERROR;
416 goto end;
417 }
418 }
f3ed775e 419end:
65f25c66
JRJ
420 /* Mi clean-up */
421 if (writer && mi_lttng_writer_destroy(writer)) {
422 /* Preserve original error code */
423 ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
424 }
425
5b915816 426 free(session_name);
6a8d2abc
SM
427 free(sessions);
428
65f25c66
JRJ
429 /* Overwrite ret if an error occurred during destroy_session/all */
430 ret = command_ret ? command_ret : ret;
431
fd076c09 432 poptFreeContext(pc);
f3ed775e
DG
433 return ret;
434}
This page took 0.087734 seconds and 4 git commands to generate.