Commit | Line | Data |
---|---|---|
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 |
28ab034a | 9 | #include "../command.hpp" |
2a8d72ed | 10 | #include "../utils.hpp" |
28ab034a | 11 | |
2a8d72ed | 12 | #include <common/exception.hpp> |
28ab034a JG |
13 | #include <common/mi-lttng.hpp> |
14 | #include <common/sessiond-comm/sessiond-comm.hpp> | |
15 | ||
f3ed775e DG |
16 | #include <popt.h> |
17 | #include <stdio.h> | |
18 | #include <stdlib.h> | |
19 | #include <string.h> | |
20 | #include <sys/stat.h> | |
21 | #include <sys/types.h> | |
22 | #include <unistd.h> | |
f3ed775e | 23 | |
5330763e JG |
24 | enum { |
25 | OPT_HELP = 1, | |
26 | OPT_LIST_OPTIONS, | |
27 | OPT_ENABLE_GLOB, | |
28 | OPT_ALL, | |
29 | }; | |
f3ed775e | 30 | |
5330763e | 31 | namespace { |
75723cd7 JG |
32 | int opt_no_wait; |
33 | struct mi_writer *writer; | |
34 | ||
4fc83d94 | 35 | #ifdef LTTNG_EMBED_HELP |
75723cd7 | 36 | const char help_msg[] = |
4fc83d94 | 37 | #include <lttng-stop.1.h> |
28ab034a | 38 | ; |
4fc83d94 PP |
39 | #endif |
40 | ||
5330763e | 41 | struct poptOption long_options[] = { |
f3ed775e | 42 | /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */ |
cd9adb8b JG |
43 | { "help", 'h', POPT_ARG_NONE, nullptr, OPT_HELP, nullptr, nullptr }, |
44 | { "list-options", 0, POPT_ARG_NONE, nullptr, OPT_LIST_OPTIONS, nullptr, nullptr }, | |
45 | { "no-wait", 'n', POPT_ARG_VAL, &opt_no_wait, 1, nullptr, nullptr }, | |
2a8d72ed OD |
46 | { "glob", 'g', POPT_ARG_NONE, nullptr, OPT_ENABLE_GLOB, nullptr, nullptr }, |
47 | { "all", 'a', POPT_ARG_NONE, nullptr, OPT_ALL, nullptr, nullptr }, | |
cd9adb8b | 48 | { nullptr, 0, 0, nullptr, 0, nullptr, nullptr } |
f3ed775e DG |
49 | }; |
50 | ||
e5b83100 JRJ |
51 | /* |
52 | * Mi print of partial session | |
53 | */ | |
5330763e | 54 | int mi_print_session(const char *session_name, int enabled) |
e5b83100 JRJ |
55 | { |
56 | int ret; | |
a0377dfe FD |
57 | LTTNG_ASSERT(writer); |
58 | LTTNG_ASSERT(session_name); | |
e5b83100 JRJ |
59 | |
60 | /* Open session element */ | |
61 | ret = mi_lttng_writer_open_element(writer, config_element_session); | |
62 | if (ret) { | |
63 | goto end; | |
64 | } | |
65 | ||
66 | /* Print session name element */ | |
28ab034a | 67 | ret = mi_lttng_writer_write_element_string(writer, config_element_name, session_name); |
e5b83100 JRJ |
68 | if (ret) { |
69 | goto end; | |
70 | } | |
71 | ||
72 | /* Is enabled ? */ | |
28ab034a | 73 | ret = mi_lttng_writer_write_element_bool(writer, config_element_enabled, enabled); |
e5b83100 JRJ |
74 | if (ret) { |
75 | goto end; | |
76 | } | |
77 | ||
78 | /* Close session element */ | |
79 | ret = mi_lttng_writer_close_element(writer); | |
80 | ||
81 | end: | |
82 | return ret; | |
83 | } | |
f3ed775e DG |
84 | |
85 | /* | |
cd80958d | 86 | * Start tracing for all trace of the session. |
f3ed775e | 87 | */ |
75723cd7 | 88 | cmd_error_code stop_tracing(const char *session_name) |
f3ed775e | 89 | { |
ae856491 | 90 | int ret; |
f3ed775e | 91 | |
8eb7a5e2 | 92 | ret = lttng_stop_tracing_no_wait(session_name); |
f3ed775e | 93 | if (ret < 0) { |
75723cd7 JG |
94 | LTTNG_THROW_CTL(fmt::format("Failed to start session `{}`", session_name), |
95 | static_cast<lttng_error_code>(-ret)); | |
f3ed775e DG |
96 | } |
97 | ||
8eb7a5e2 JG |
98 | if (!opt_no_wait) { |
99 | _MSG("Waiting for data availability"); | |
100 | fflush(stdout); | |
101 | do { | |
102 | ret = lttng_data_pending(session_name); | |
103 | if (ret < 0) { | |
104 | /* Return the data available call error. */ | |
75723cd7 JG |
105 | ERR_FMT("Failed to check pending data for session `{}` ({})", |
106 | session_name, | |
107 | lttng_strerror(ret)); | |
108 | return CMD_ERROR; | |
8eb7a5e2 JG |
109 | } |
110 | ||
111 | /* | |
112 | * Data sleep time before retrying (in usec). Don't sleep if the call | |
113 | * returned value indicates availability. | |
114 | */ | |
115 | if (ret) { | |
c8f61fd4 | 116 | usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US); |
8eb7a5e2 JG |
117 | _MSG("."); |
118 | fflush(stdout); | |
119 | } | |
120 | } while (ret != 0); | |
121 | MSG(""); | |
122 | } | |
123 | ||
20fb9e02 | 124 | print_session_stats(session_name); |
75723cd7 | 125 | MSG("Tracing stopped for session `%s`", session_name); |
e5b83100 | 126 | if (lttng_opt_mi) { |
75723cd7 JG |
127 | if (mi_print_session(session_name, 0)) { |
128 | return CMD_ERROR; | |
129 | } | |
e5b83100 | 130 | } |
75723cd7 JG |
131 | |
132 | return CMD_SUCCESS; | |
2a8d72ed | 133 | } |
f3ed775e | 134 | |
75723cd7 | 135 | cmd_error_code stop_tracing(const session_spec& spec) noexcept |
2a8d72ed | 136 | { |
75723cd7 JG |
137 | bool had_warning = false; |
138 | bool had_error = false; | |
139 | bool listing_failed = false; | |
140 | ||
141 | const auto sessions = [&listing_failed, &spec]() -> session_list { | |
142 | try { | |
143 | return list_sessions(spec); | |
144 | } catch (const lttng::ctl::error& ctl_exception) { | |
145 | ERR_FMT("Failed to list sessions ({})", | |
146 | lttng_strerror(-ctl_exception.code())); | |
147 | listing_failed = true; | |
148 | return {}; | |
149 | } | |
150 | }(); | |
151 | ||
42a11b8f | 152 | if (!listing_failed && sessions.size() == 0 && spec.type_ == session_spec::type::NAME) { |
75723cd7 JG |
153 | ERR_FMT("Session `{}` not found", spec.value); |
154 | return CMD_ERROR; | |
155 | } | |
2a8d72ed | 156 | |
75723cd7 JG |
157 | if (listing_failed) { |
158 | return CMD_FATAL; | |
159 | } | |
2a8d72ed | 160 | |
75723cd7 JG |
161 | for (const auto& session : sessions) { |
162 | cmd_error_code sub_ret; | |
163 | ||
164 | try { | |
165 | sub_ret = stop_tracing(session.name); | |
166 | } catch (const lttng::ctl::error& ctl_exception) { | |
167 | switch (ctl_exception.code()) { | |
168 | case LTTNG_ERR_TRACE_ALREADY_STOPPED: | |
169 | WARN_FMT("Tracing already stopped for session `{}`", session.name); | |
170 | sub_ret = CMD_SUCCESS; | |
171 | break; | |
172 | case LTTNG_ERR_NO_SESSION: | |
42a11b8f | 173 | if (spec.type_ != session_spec::type::NAME) { |
75723cd7 JG |
174 | /* Session destroyed during command, ignore and carry-on. */ |
175 | sub_ret = CMD_SUCCESS; | |
176 | break; | |
177 | } else { | |
178 | sub_ret = CMD_ERROR; | |
179 | break; | |
180 | } | |
181 | case LTTNG_ERR_NO_SESSIOND: | |
182 | /* Don't keep going on a fatal error. */ | |
183 | return CMD_FATAL; | |
184 | default: | |
185 | /* Generic error. */ | |
186 | sub_ret = CMD_ERROR; | |
187 | ERR_FMT("Failed to stop session `{}` ({})", | |
188 | session.name, | |
189 | lttng_strerror(-ctl_exception.code())); | |
190 | break; | |
2a8d72ed OD |
191 | } |
192 | } | |
75723cd7 JG |
193 | |
194 | /* Keep going, but report the most serious state. */ | |
195 | had_warning |= sub_ret == CMD_WARNING; | |
196 | had_error |= sub_ret == CMD_ERROR; | |
2a8d72ed | 197 | } |
cd80958d | 198 | |
75723cd7 JG |
199 | if (had_error) { |
200 | return CMD_ERROR; | |
201 | } else if (had_warning) { | |
202 | return CMD_WARNING; | |
203 | } else { | |
204 | return CMD_SUCCESS; | |
205 | } | |
f3ed775e | 206 | } |
5330763e | 207 | } /* namespace */ |
f3ed775e DG |
208 | |
209 | /* | |
210 | * cmd_stop | |
211 | * | |
212 | * The 'stop <options>' first level command | |
213 | */ | |
214 | int cmd_stop(int argc, const char **argv) | |
215 | { | |
75723cd7 JG |
216 | int opt; |
217 | cmd_error_code command_ret = CMD_SUCCESS; | |
218 | bool success = true; | |
f3ed775e | 219 | static poptContext pc; |
cd9adb8b | 220 | const char *leftover = nullptr; |
42a11b8f | 221 | struct session_spec session_spec(session_spec::type::NAME); |
f3ed775e | 222 | |
cd9adb8b | 223 | pc = poptGetContext(nullptr, argc, argv, long_options, 0); |
f3ed775e DG |
224 | poptReadDefaultConfig(pc, 0); |
225 | ||
226 | while ((opt = poptGetNextOpt(pc)) != -1) { | |
227 | switch (opt) { | |
228 | case OPT_HELP: | |
75723cd7 JG |
229 | { |
230 | int ret; | |
231 | ||
4ba92f18 | 232 | SHOW_HELP(); |
75723cd7 | 233 | command_ret = static_cast<cmd_error_code>(ret); |
f3ed775e | 234 | goto end; |
75723cd7 | 235 | } |
679b4943 SM |
236 | case OPT_LIST_OPTIONS: |
237 | list_cmd_options(stdout, long_options); | |
679b4943 | 238 | goto end; |
2a8d72ed | 239 | case OPT_ENABLE_GLOB: |
42a11b8f | 240 | session_spec.type_ = session_spec::type::GLOB_PATTERN; |
2a8d72ed OD |
241 | break; |
242 | case OPT_ALL: | |
42a11b8f | 243 | session_spec.type_ = session_spec::type::ALL; |
2a8d72ed | 244 | break; |
f3ed775e | 245 | default: |
75723cd7 | 246 | command_ret = CMD_UNDEFINED; |
f3ed775e DG |
247 | goto end; |
248 | } | |
249 | } | |
250 | ||
e5b83100 JRJ |
251 | /* Mi check */ |
252 | if (lttng_opt_mi) { | |
253 | writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi); | |
254 | if (!writer) { | |
75723cd7 | 255 | command_ret = CMD_ERROR; |
e5b83100 JRJ |
256 | goto end; |
257 | } | |
258 | ||
259 | /* Open command element */ | |
75723cd7 JG |
260 | if (mi_lttng_writer_command_open(writer, mi_lttng_element_command_stop)) { |
261 | command_ret = CMD_ERROR; | |
e5b83100 JRJ |
262 | goto end; |
263 | } | |
264 | ||
265 | /* Open output element */ | |
75723cd7 JG |
266 | if (mi_lttng_writer_open_element(writer, mi_lttng_element_command_output)) { |
267 | command_ret = CMD_ERROR; | |
e5b83100 JRJ |
268 | goto end; |
269 | } | |
270 | ||
271 | /* | |
272 | * Open sessions element | |
273 | * For validation | |
274 | */ | |
75723cd7 JG |
275 | if (mi_lttng_writer_open_element(writer, config_element_sessions)) { |
276 | command_ret = CMD_ERROR; | |
e5b83100 JRJ |
277 | goto end; |
278 | } | |
279 | } | |
280 | ||
2a8d72ed | 281 | session_spec.value = poptGetArg(pc); |
f3ed775e | 282 | |
68c7f6e5 JD |
283 | leftover = poptGetArg(pc); |
284 | if (leftover) { | |
285 | ERR("Unknown argument: %s", leftover); | |
75723cd7 | 286 | command_ret = CMD_ERROR; |
68c7f6e5 JD |
287 | goto end; |
288 | } | |
289 | ||
2a8d72ed | 290 | command_ret = stop_tracing(session_spec); |
e5b83100 | 291 | if (command_ret) { |
75723cd7 | 292 | success = false; |
e5b83100 JRJ |
293 | } |
294 | ||
295 | /* Mi closing */ | |
296 | if (lttng_opt_mi) { | |
297 | /* Close sessions and output element */ | |
75723cd7 JG |
298 | if (mi_lttng_close_multi_element(writer, 2)) { |
299 | command_ret = CMD_ERROR; | |
e5b83100 JRJ |
300 | goto end; |
301 | } | |
302 | ||
303 | /* Success ? */ | |
75723cd7 JG |
304 | if (mi_lttng_writer_write_element_bool( |
305 | writer, mi_lttng_element_command_success, success)) { | |
306 | command_ret = CMD_ERROR; | |
e5b83100 JRJ |
307 | goto end; |
308 | } | |
309 | ||
310 | /* Command element close */ | |
75723cd7 JG |
311 | if (mi_lttng_writer_command_close(writer)) { |
312 | command_ret = CMD_ERROR; | |
e5b83100 JRJ |
313 | goto end; |
314 | } | |
315 | } | |
f3ed775e DG |
316 | |
317 | end: | |
e5b83100 JRJ |
318 | /* Mi clean-up */ |
319 | if (writer && mi_lttng_writer_destroy(writer)) { | |
75723cd7 | 320 | command_ret = CMD_ERROR; |
e5b83100 JRJ |
321 | } |
322 | ||
ca1c3607 | 323 | poptFreeContext(pc); |
75723cd7 | 324 | return command_ret; |
f3ed775e | 325 | } |