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