Commit | Line | Data |
---|---|---|
f3bc2010 JG |
1 | /* |
2 | * lttng-live.c | |
3 | * | |
4 | * Babeltrace CTF LTTng-live Client Component | |
5 | * | |
14f28187 | 6 | * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com> |
f3bc2010 | 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7cdc2bab | 8 | * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
f3bc2010 JG |
9 | * |
10 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
11 | * | |
12 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
13 | * of this software and associated documentation files (the "Software"), to deal | |
14 | * in the Software without restriction, including without limitation the rights | |
15 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
16 | * copies of the Software, and to permit persons to whom the Software is | |
17 | * furnished to do so, subject to the following conditions: | |
18 | * | |
19 | * The above copyright notice and this permission notice shall be included in | |
20 | * all copies or substantial portions of the Software. | |
21 | * | |
22 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
23 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
24 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
25 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
26 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
27 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
28 | * SOFTWARE. | |
29 | */ | |
30 | ||
2ece7dd0 | 31 | #define BT_COMP_LOG_SELF_COMP self_comp |
c01594de | 32 | #define BT_LOG_OUTPUT_LEVEL log_level |
350ad6c1 | 33 | #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE" |
d9c39b0a | 34 | #include "logging/comp-logging.h" |
020bc26f | 35 | |
14f28187 | 36 | #include <inttypes.h> |
c4f23e30 | 37 | #include <stdbool.h> |
14f28187 FD |
38 | #include <unistd.h> |
39 | ||
3c22a242 FD |
40 | #include <glib.h> |
41 | ||
578e048b | 42 | #include "common/assert.h" |
3fadfbc0 | 43 | #include <babeltrace2/babeltrace.h> |
578e048b | 44 | #include "compat/compiler.h" |
3fadfbc0 | 45 | #include <babeltrace2/types.h> |
f3bc2010 | 46 | |
376fc2bd | 47 | #include "plugins/common/muxing/muxing.h" |
80aff5ef | 48 | #include "plugins/common/param-validation/param-validation.h" |
376fc2bd | 49 | |
7cdc2bab MD |
50 | #include "data-stream.h" |
51 | #include "metadata.h" | |
14f28187 | 52 | #include "lttng-live.h" |
7cdc2bab | 53 | |
14f28187 FD |
54 | #define MAX_QUERY_SIZE (256*1024) |
55 | #define URL_PARAM "url" | |
312df793 | 56 | #define INPUTS_PARAM "inputs" |
14f28187 FD |
57 | #define SESS_NOT_FOUND_ACTION_PARAM "session-not-found-action" |
58 | #define SESS_NOT_FOUND_ACTION_CONTINUE_STR "continue" | |
59 | #define SESS_NOT_FOUND_ACTION_FAIL_STR "fail" | |
60 | #define SESS_NOT_FOUND_ACTION_END_STR "end" | |
7cdc2bab | 61 | |
2ece7dd0 | 62 | #define print_dbg(fmt, ...) BT_COMP_LOGD(fmt, ## __VA_ARGS__) |
7cdc2bab | 63 | |
14f28187 | 64 | static |
b607a4f7 FD |
65 | const char *lttng_live_iterator_status_string( |
66 | enum lttng_live_iterator_status status) | |
14f28187 FD |
67 | { |
68 | switch (status) { | |
69 | case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE: | |
70 | return "LTTNG_LIVE_ITERATOR_STATUS_CONTINUE"; | |
71 | case LTTNG_LIVE_ITERATOR_STATUS_AGAIN: | |
72 | return "LTTNG_LIVE_ITERATOR_STATUS_AGAIN"; | |
73 | case LTTNG_LIVE_ITERATOR_STATUS_END: | |
74 | return "LTTNG_LIVE_ITERATOR_STATUS_END"; | |
75 | case LTTNG_LIVE_ITERATOR_STATUS_OK: | |
76 | return "LTTNG_LIVE_ITERATOR_STATUS_OK"; | |
77 | case LTTNG_LIVE_ITERATOR_STATUS_INVAL: | |
78 | return "LTTNG_LIVE_ITERATOR_STATUS_INVAL"; | |
79 | case LTTNG_LIVE_ITERATOR_STATUS_ERROR: | |
80 | return "LTTNG_LIVE_ITERATOR_STATUS_ERROR"; | |
81 | case LTTNG_LIVE_ITERATOR_STATUS_NOMEM: | |
82 | return "LTTNG_LIVE_ITERATOR_STATUS_NOMEM"; | |
83 | case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED: | |
84 | return "LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED"; | |
85 | default: | |
498e7994 | 86 | bt_common_abort(); |
14f28187 FD |
87 | } |
88 | } | |
89 | ||
90 | static | |
ecb4ba8a | 91 | const char *lttng_live_stream_state_string(enum lttng_live_stream_state state) |
7cdc2bab | 92 | { |
ecb4ba8a | 93 | switch (state) { |
7cdc2bab MD |
94 | case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA: |
95 | return "ACTIVE_NO_DATA"; | |
96 | case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA: | |
97 | return "QUIESCENT_NO_DATA"; | |
98 | case LTTNG_LIVE_STREAM_QUIESCENT: | |
99 | return "QUIESCENT"; | |
100 | case LTTNG_LIVE_STREAM_ACTIVE_DATA: | |
101 | return "ACTIVE_DATA"; | |
102 | case LTTNG_LIVE_STREAM_EOF: | |
103 | return "EOF"; | |
104 | default: | |
105 | return "ERROR"; | |
106 | } | |
107 | } | |
7cdc2bab | 108 | |
ecb4ba8a | 109 | #define LTTNG_LIVE_LOGD_STREAM_ITER(live_stream_iter) \ |
14f28187 | 110 | do { \ |
ecb4ba8a FD |
111 | BT_COMP_LOGD("Live stream iterator state=%s, last-inact-ts=%" PRId64 \ |
112 | ", curr-inact-ts %" PRId64, \ | |
113 | lttng_live_stream_state_string(live_stream_iter->state), \ | |
14f28187 FD |
114 | live_stream_iter->last_inactivity_ts, \ |
115 | live_stream_iter->current_inactivity_ts); \ | |
116 | } while (0); | |
6f79a7cf MD |
117 | |
118 | BT_HIDDEN | |
9b4f9b42 | 119 | bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter) |
6f79a7cf | 120 | { |
14f28187 | 121 | bool ret; |
6f79a7cf | 122 | |
9b4f9b42 | 123 | if (!msg_iter) { |
14f28187 FD |
124 | ret = false; |
125 | goto end; | |
7cdc2bab | 126 | } |
7cdc2bab | 127 | |
9b4f9b42 PP |
128 | ret = bt_self_message_iterator_is_interrupted( |
129 | msg_iter->self_msg_iter); | |
4bf0e537 | 130 | |
14f28187 FD |
131 | end: |
132 | return ret; | |
7cdc2bab MD |
133 | } |
134 | ||
135 | static | |
36e94ad6 | 136 | struct lttng_live_trace *lttng_live_session_borrow_trace_by_id(struct lttng_live_session *session, |
7cdc2bab | 137 | uint64_t trace_id) |
d3e4dcd8 | 138 | { |
14f28187 FD |
139 | uint64_t trace_idx; |
140 | struct lttng_live_trace *ret_trace = NULL; | |
7cdc2bab | 141 | |
14f28187 FD |
142 | for (trace_idx = 0; trace_idx < session->traces->len; trace_idx++) { |
143 | struct lttng_live_trace *trace = | |
144 | g_ptr_array_index(session->traces, trace_idx); | |
7cdc2bab | 145 | if (trace->id == trace_id) { |
14f28187 FD |
146 | ret_trace = trace; |
147 | goto end; | |
7cdc2bab MD |
148 | } |
149 | } | |
14f28187 FD |
150 | |
151 | end: | |
152 | return ret_trace; | |
d3eb6e8f PP |
153 | } |
154 | ||
7cdc2bab | 155 | static |
14f28187 | 156 | void lttng_live_destroy_trace(struct lttng_live_trace *trace) |
7cdc2bab | 157 | { |
c01594de | 158 | bt_logging_level log_level = trace->log_level; |
2ece7dd0 | 159 | bt_self_component *self_comp = trace->self_comp; |
c01594de | 160 | |
ecb4ba8a | 161 | BT_COMP_LOGD("Destroying live trace: trace-id=%"PRIu64, trace->id); |
7cdc2bab | 162 | |
14f28187 FD |
163 | BT_ASSERT(trace->stream_iterators); |
164 | g_ptr_array_free(trace->stream_iterators, TRUE); | |
5bd230f4 | 165 | |
14f28187 FD |
166 | BT_TRACE_PUT_REF_AND_RESET(trace->trace); |
167 | BT_TRACE_CLASS_PUT_REF_AND_RESET(trace->trace_class); | |
5bd230f4 | 168 | |
7cdc2bab | 169 | lttng_live_metadata_fini(trace); |
7cdc2bab MD |
170 | g_free(trace); |
171 | } | |
172 | ||
173 | static | |
174 | struct lttng_live_trace *lttng_live_create_trace(struct lttng_live_session *session, | |
175 | uint64_t trace_id) | |
176 | { | |
177 | struct lttng_live_trace *trace = NULL; | |
c01594de | 178 | bt_logging_level log_level = session->log_level; |
2ece7dd0 | 179 | bt_self_component *self_comp = session->self_comp; |
7cdc2bab | 180 | |
ecb4ba8a FD |
181 | BT_COMP_LOGD("Creating live trace: " |
182 | "session-id=%"PRIu64", trace-id=%"PRIu64, | |
183 | session->id, trace_id); | |
7cdc2bab MD |
184 | trace = g_new0(struct lttng_live_trace, 1); |
185 | if (!trace) { | |
1419db2b FD |
186 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
187 | "Failed to allocate live trace"); | |
7cdc2bab MD |
188 | goto error; |
189 | } | |
c01594de | 190 | trace->log_level = session->log_level; |
2ece7dd0 | 191 | trace->self_comp = session->self_comp; |
7cdc2bab MD |
192 | trace->session = session; |
193 | trace->id = trace_id; | |
14f28187 FD |
194 | trace->trace_class = NULL; |
195 | trace->trace = NULL; | |
196 | trace->stream_iterators = g_ptr_array_new_with_free_func( | |
0f1979c3 | 197 | (GDestroyNotify) lttng_live_stream_iterator_destroy); |
14f28187 | 198 | BT_ASSERT(trace->stream_iterators); |
76bbaebc | 199 | trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED; |
14f28187 FD |
200 | g_ptr_array_add(session->traces, trace); |
201 | ||
7cdc2bab MD |
202 | goto end; |
203 | error: | |
204 | g_free(trace); | |
205 | trace = NULL; | |
206 | end: | |
207 | return trace; | |
208 | } | |
209 | ||
210 | BT_HIDDEN | |
36e94ad6 | 211 | struct lttng_live_trace *lttng_live_session_borrow_or_create_trace_by_id( |
14f28187 | 212 | struct lttng_live_session *session, uint64_t trace_id) |
7cdc2bab MD |
213 | { |
214 | struct lttng_live_trace *trace; | |
215 | ||
36e94ad6 | 216 | trace = lttng_live_session_borrow_trace_by_id(session, trace_id); |
7cdc2bab | 217 | if (trace) { |
14f28187 | 218 | goto end; |
7cdc2bab | 219 | } |
7cdc2bab | 220 | |
14f28187 FD |
221 | /* The session is the owner of the newly created trace. */ |
222 | trace = lttng_live_create_trace(session, trace_id); | |
7cdc2bab | 223 | |
14f28187 FD |
224 | end: |
225 | return trace; | |
7cdc2bab MD |
226 | } |
227 | ||
228 | BT_HIDDEN | |
14f28187 | 229 | int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, |
06994c71 MD |
230 | uint64_t session_id, const char *hostname, |
231 | const char *session_name) | |
7cdc2bab MD |
232 | { |
233 | int ret = 0; | |
14f28187 | 234 | struct lttng_live_session *session; |
c01594de | 235 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
2ece7dd0 | 236 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; |
7cdc2bab | 237 | |
ecb4ba8a FD |
238 | BT_COMP_LOGD("Adding live session: " |
239 | "session-id=%" PRIu64 ", hostname=\"%s\" session-name=\"%s\"", | |
240 | session_id, hostname, session_name); | |
241 | ||
14f28187 FD |
242 | session = g_new0(struct lttng_live_session, 1); |
243 | if (!session) { | |
1419db2b FD |
244 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
245 | "Failed to allocate live session"); | |
7cdc2bab MD |
246 | goto error; |
247 | } | |
248 | ||
c01594de | 249 | session->log_level = lttng_live_msg_iter->log_level; |
2ece7dd0 | 250 | session->self_comp = lttng_live_msg_iter->self_comp; |
14f28187 FD |
251 | session->id = session_id; |
252 | session->traces = g_ptr_array_new_with_free_func( | |
0f1979c3 | 253 | (GDestroyNotify) lttng_live_destroy_trace); |
14f28187 FD |
254 | BT_ASSERT(session->traces); |
255 | session->lttng_live_msg_iter = lttng_live_msg_iter; | |
256 | session->new_streams_needed = true; | |
257 | session->hostname = g_string_new(hostname); | |
258 | BT_ASSERT(session->hostname); | |
259 | ||
260 | session->session_name = g_string_new(session_name); | |
261 | BT_ASSERT(session->session_name); | |
7cdc2bab | 262 | |
14f28187 | 263 | g_ptr_array_add(lttng_live_msg_iter->sessions, session); |
7cdc2bab MD |
264 | goto end; |
265 | error: | |
14f28187 | 266 | g_free(session); |
7cdc2bab MD |
267 | ret = -1; |
268 | end: | |
269 | return ret; | |
270 | } | |
271 | ||
272 | static | |
273 | void lttng_live_destroy_session(struct lttng_live_session *session) | |
274 | { | |
c01594de | 275 | bt_logging_level log_level; |
2ece7dd0 | 276 | bt_self_component *self_comp; |
14f28187 FD |
277 | |
278 | if (!session) { | |
279 | goto end; | |
280 | } | |
7cdc2bab | 281 | |
c01594de | 282 | log_level = session->log_level; |
2ece7dd0 | 283 | self_comp = session->self_comp; |
ecb4ba8a FD |
284 | BT_COMP_LOGD("Destroying live session: " |
285 | "session-id=%"PRIu64", session-name=\"%s\"", | |
286 | session->id, session->session_name->str); | |
7cdc2bab | 287 | if (session->id != -1ULL) { |
36e94ad6 | 288 | if (lttng_live_session_detach(session)) { |
0757916e FD |
289 | if (!lttng_live_graph_is_canceled( |
290 | session->lttng_live_msg_iter)) { | |
4c66436f | 291 | /* Old relayd cannot detach sessions. */ |
2ece7dd0 | 292 | BT_COMP_LOGD("Unable to detach lttng live session %" PRIu64, |
4c66436f MD |
293 | session->id); |
294 | } | |
7cdc2bab MD |
295 | } |
296 | session->id = -1ULL; | |
297 | } | |
14f28187 FD |
298 | |
299 | if (session->traces) { | |
300 | g_ptr_array_free(session->traces, TRUE); | |
7cdc2bab | 301 | } |
14f28187 | 302 | |
06994c71 MD |
303 | if (session->hostname) { |
304 | g_string_free(session->hostname, TRUE); | |
305 | } | |
306 | if (session->session_name) { | |
307 | g_string_free(session->session_name, TRUE); | |
308 | } | |
7cdc2bab | 309 | g_free(session); |
14f28187 FD |
310 | |
311 | end: | |
312 | return; | |
7cdc2bab MD |
313 | } |
314 | ||
14f28187 FD |
315 | static |
316 | void lttng_live_msg_iter_destroy(struct lttng_live_msg_iter *lttng_live_msg_iter) | |
7cdc2bab | 317 | { |
14f28187 FD |
318 | if (!lttng_live_msg_iter) { |
319 | goto end; | |
7cdc2bab | 320 | } |
7cdc2bab | 321 | |
14f28187 FD |
322 | if (lttng_live_msg_iter->sessions) { |
323 | g_ptr_array_free(lttng_live_msg_iter->sessions, TRUE); | |
7cdc2bab | 324 | } |
14f28187 | 325 | |
b9e6ec43 FD |
326 | if (lttng_live_msg_iter->viewer_connection) { |
327 | live_viewer_connection_destroy(lttng_live_msg_iter->viewer_connection); | |
328 | } | |
14f28187 FD |
329 | BT_ASSERT(lttng_live_msg_iter->lttng_live_comp); |
330 | BT_ASSERT(lttng_live_msg_iter->lttng_live_comp->has_msg_iter); | |
331 | ||
332 | /* All stream iterators must be destroyed at this point. */ | |
333 | BT_ASSERT(lttng_live_msg_iter->active_stream_iter == 0); | |
334 | lttng_live_msg_iter->lttng_live_comp->has_msg_iter = false; | |
335 | ||
336 | g_free(lttng_live_msg_iter); | |
337 | ||
338 | end: | |
339 | return; | |
340 | } | |
341 | ||
342 | BT_HIDDEN | |
343 | void lttng_live_msg_iter_finalize(bt_self_message_iterator *self_msg_iter) | |
344 | { | |
345 | struct lttng_live_msg_iter *lttng_live_msg_iter; | |
346 | ||
347 | BT_ASSERT(self_msg_iter); | |
348 | ||
349 | lttng_live_msg_iter = bt_self_message_iterator_get_data(self_msg_iter); | |
350 | BT_ASSERT(lttng_live_msg_iter); | |
351 | lttng_live_msg_iter_destroy(lttng_live_msg_iter); | |
7cdc2bab MD |
352 | } |
353 | ||
354 | static | |
14f28187 | 355 | enum lttng_live_iterator_status lttng_live_iterator_next_check_stream_state( |
7cdc2bab MD |
356 | struct lttng_live_stream_iterator *lttng_live_stream) |
357 | { | |
c01594de | 358 | bt_logging_level log_level = lttng_live_stream->log_level; |
2ece7dd0 | 359 | bt_self_component *self_comp = lttng_live_stream->self_comp; |
c01594de | 360 | |
7cdc2bab MD |
361 | switch (lttng_live_stream->state) { |
362 | case LTTNG_LIVE_STREAM_QUIESCENT: | |
363 | case LTTNG_LIVE_STREAM_ACTIVE_DATA: | |
364 | break; | |
365 | case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA: | |
366 | /* Invalid state. */ | |
2ece7dd0 | 367 | BT_COMP_LOGF("Unexpected stream state \"ACTIVE_NO_DATA\""); |
498e7994 | 368 | bt_common_abort(); |
7cdc2bab MD |
369 | case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA: |
370 | /* Invalid state. */ | |
2ece7dd0 | 371 | BT_COMP_LOGF("Unexpected stream state \"QUIESCENT_NO_DATA\""); |
498e7994 | 372 | bt_common_abort(); |
7cdc2bab MD |
373 | case LTTNG_LIVE_STREAM_EOF: |
374 | break; | |
375 | } | |
14f28187 | 376 | return LTTNG_LIVE_ITERATOR_STATUS_OK; |
7cdc2bab MD |
377 | } |
378 | ||
379 | /* | |
380 | * For active no data stream, fetch next data. It can be either: | |
381 | * - quiescent: need to put it in the prio heap at quiescent end | |
382 | * timestamp, | |
383 | * - have data: need to wire up first event into the prio heap, | |
384 | * - have no data on this stream at this point: need to retry (AGAIN) or | |
385 | * return EOF. | |
386 | */ | |
387 | static | |
14f28187 FD |
388 | enum lttng_live_iterator_status lttng_live_iterator_next_handle_one_no_data_stream( |
389 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
7cdc2bab MD |
390 | struct lttng_live_stream_iterator *lttng_live_stream) |
391 | { | |
c01594de | 392 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
2ece7dd0 | 393 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; |
0f1979c3 | 394 | enum lttng_live_iterator_status ret = LTTNG_LIVE_ITERATOR_STATUS_OK; |
7cdc2bab | 395 | enum lttng_live_stream_state orig_state = lttng_live_stream->state; |
0f1979c3 | 396 | struct packet_index index; |
7cdc2bab | 397 | |
76bbaebc FD |
398 | if (lttng_live_stream->trace->metadata_stream_state == |
399 | LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED) { | |
14f28187 | 400 | ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
7cdc2bab MD |
401 | goto end; |
402 | } | |
403 | if (lttng_live_stream->trace->session->new_streams_needed) { | |
14f28187 | 404 | ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
7cdc2bab MD |
405 | goto end; |
406 | } | |
14f28187 FD |
407 | if (lttng_live_stream->state != LTTNG_LIVE_STREAM_ACTIVE_NO_DATA && |
408 | lttng_live_stream->state != LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA) { | |
7cdc2bab MD |
409 | goto end; |
410 | } | |
14f28187 FD |
411 | ret = lttng_live_get_next_index(lttng_live_msg_iter, lttng_live_stream, |
412 | &index); | |
413 | if (ret != LTTNG_LIVE_ITERATOR_STATUS_OK) { | |
7cdc2bab MD |
414 | goto end; |
415 | } | |
98b15851 | 416 | BT_ASSERT_DBG(lttng_live_stream->state != LTTNG_LIVE_STREAM_EOF); |
7cdc2bab | 417 | if (lttng_live_stream->state == LTTNG_LIVE_STREAM_QUIESCENT) { |
14f28187 FD |
418 | uint64_t last_inact_ts = lttng_live_stream->last_inactivity_ts, |
419 | curr_inact_ts = lttng_live_stream->current_inactivity_ts; | |
420 | ||
421 | if (orig_state == LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA && | |
422 | last_inact_ts == curr_inact_ts) { | |
423 | ret = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; | |
ecb4ba8a | 424 | LTTNG_LIVE_LOGD_STREAM_ITER(lttng_live_stream); |
7cdc2bab | 425 | } else { |
14f28187 | 426 | ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
7cdc2bab MD |
427 | } |
428 | goto end; | |
429 | } | |
430 | lttng_live_stream->base_offset = index.offset; | |
431 | lttng_live_stream->offset = index.offset; | |
432 | lttng_live_stream->len = index.packet_size / CHAR_BIT; | |
433 | end: | |
14f28187 FD |
434 | if (ret == LTTNG_LIVE_ITERATOR_STATUS_OK) { |
435 | ret = lttng_live_iterator_next_check_stream_state(lttng_live_stream); | |
7cdc2bab MD |
436 | } |
437 | return ret; | |
438 | } | |
439 | ||
440 | /* | |
14f28187 FD |
441 | * Creation of the message requires the ctf trace class to be created |
442 | * beforehand, but the live protocol gives us all streams (including metadata) | |
443 | * at once. So we split it in three steps: getting streams, getting metadata | |
444 | * (which creates the ctf trace class), and then creating the per-stream | |
445 | * messages. | |
7cdc2bab MD |
446 | */ |
447 | static | |
14f28187 FD |
448 | enum lttng_live_iterator_status lttng_live_get_session( |
449 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
7cdc2bab MD |
450 | struct lttng_live_session *session) |
451 | { | |
1419db2b FD |
452 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
453 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; | |
14f28187 FD |
454 | enum lttng_live_iterator_status status; |
455 | uint64_t trace_idx; | |
7cdc2bab | 456 | |
ecb4ba8a FD |
457 | BT_COMP_LOGD("Updating all streams for session: " |
458 | "session-id=%"PRIu64", session-name=\"%s\"", | |
459 | session->id, session->session_name->str); | |
460 | ||
14f28187 | 461 | if (!session->attached) { |
f79c2d7a | 462 | enum lttng_live_viewer_status attach_status = |
36e94ad6 | 463 | lttng_live_session_attach(session, |
851de941 | 464 | lttng_live_msg_iter->self_msg_iter); |
f79c2d7a | 465 | if (attach_status != LTTNG_LIVE_VIEWER_STATUS_OK) { |
0757916e | 466 | if (lttng_live_graph_is_canceled(lttng_live_msg_iter)) { |
1419db2b FD |
467 | /* |
468 | * Clear any causes appended in | |
469 | * `lttng_live_attach_session()` as we want to | |
470 | * return gracefully since the graph was | |
471 | * cancelled. | |
472 | */ | |
473 | bt_current_thread_clear_error(); | |
14f28187 FD |
474 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
475 | } else { | |
476 | status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; | |
1419db2b FD |
477 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
478 | "Error attaching to LTTng live session"); | |
14f28187 FD |
479 | } |
480 | goto end; | |
4c66436f | 481 | } |
7cdc2bab | 482 | } |
14f28187 | 483 | |
36e94ad6 | 484 | status = lttng_live_session_get_new_streams(session, |
851de941 | 485 | lttng_live_msg_iter->self_msg_iter); |
14f28187 FD |
486 | if (status != LTTNG_LIVE_ITERATOR_STATUS_OK && |
487 | status != LTTNG_LIVE_ITERATOR_STATUS_END) { | |
488 | goto end; | |
7cdc2bab | 489 | } |
c28512ab FD |
490 | trace_idx = 0; |
491 | while (trace_idx < session->traces->len) { | |
14f28187 FD |
492 | struct lttng_live_trace *trace = |
493 | g_ptr_array_index(session->traces, trace_idx); | |
494 | ||
7cdc2bab | 495 | status = lttng_live_metadata_update(trace); |
c28512ab | 496 | switch (status) { |
0ca5c4f9 | 497 | case LTTNG_LIVE_ITERATOR_STATUS_END: |
c28512ab FD |
498 | case LTTNG_LIVE_ITERATOR_STATUS_OK: |
499 | trace_idx++; | |
500 | break; | |
0ca5c4f9 FD |
501 | case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE: |
502 | case LTTNG_LIVE_ITERATOR_STATUS_AGAIN: | |
503 | goto end; | |
c28512ab | 504 | default: |
ecb4ba8a FD |
505 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
506 | "Error updating trace metadata: " | |
507 | "stream-iter-status=%s, trace-id=%"PRIu64, | |
508 | lttng_live_iterator_status_string(status), | |
509 | trace->id); | |
14f28187 | 510 | goto end; |
7cdc2bab MD |
511 | } |
512 | } | |
851de941 SM |
513 | status = lttng_live_lazy_msg_init(session, |
514 | lttng_live_msg_iter->self_msg_iter); | |
14f28187 FD |
515 | |
516 | end: | |
517 | return status; | |
7cdc2bab MD |
518 | } |
519 | ||
7cdc2bab | 520 | static |
14f28187 | 521 | void lttng_live_force_new_streams_and_metadata(struct lttng_live_msg_iter *lttng_live_msg_iter) |
7cdc2bab | 522 | { |
14f28187 | 523 | uint64_t session_idx, trace_idx; |
7cdc2bab | 524 | |
14f28187 FD |
525 | for (session_idx = 0; session_idx < lttng_live_msg_iter->sessions->len; |
526 | session_idx++) { | |
527 | struct lttng_live_session *session = | |
528 | g_ptr_array_index(lttng_live_msg_iter->sessions, session_idx); | |
7cdc2bab | 529 | session->new_streams_needed = true; |
14f28187 FD |
530 | for (trace_idx = 0; trace_idx < session->traces->len; |
531 | trace_idx++) { | |
532 | struct lttng_live_trace *trace = | |
533 | g_ptr_array_index(session->traces, trace_idx); | |
76bbaebc FD |
534 | |
535 | BT_ASSERT(trace->metadata_stream_state != | |
536 | LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED); | |
537 | ||
538 | trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED; | |
7cdc2bab MD |
539 | } |
540 | } | |
541 | } | |
542 | ||
543 | static | |
14f28187 FD |
544 | enum lttng_live_iterator_status |
545 | lttng_live_iterator_handle_new_streams_and_metadata( | |
546 | struct lttng_live_msg_iter *lttng_live_msg_iter) | |
7cdc2bab | 547 | { |
f79c2d7a FD |
548 | enum lttng_live_iterator_status status; |
549 | enum lttng_live_viewer_status viewer_status; | |
1419db2b FD |
550 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
551 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; | |
14f28187 FD |
552 | uint64_t session_idx = 0, nr_sessions_opened = 0; |
553 | struct lttng_live_session *session; | |
554 | enum session_not_found_action sess_not_found_act = | |
555 | lttng_live_msg_iter->lttng_live_comp->params.sess_not_found_act; | |
556 | ||
ecb4ba8a FD |
557 | BT_COMP_LOGD("Update data and metadata of all sessions" |
558 | "live-msg-iter-addr=%p", lttng_live_msg_iter); | |
7cdc2bab | 559 | /* |
14f28187 | 560 | * In a remotely distant future, we could add a "new |
7cdc2bab MD |
561 | * session" flag to the protocol, which would tell us that we |
562 | * need to query for new sessions even though we have sessions | |
563 | * currently ongoing. | |
564 | */ | |
14f28187 FD |
565 | if (lttng_live_msg_iter->sessions->len == 0) { |
566 | if (sess_not_found_act != SESSION_NOT_FOUND_ACTION_CONTINUE) { | |
ecb4ba8a | 567 | BT_COMP_LOGD("No session found. Exiting in accordance with the `session-not-found-action` parameter"); |
f79c2d7a | 568 | status = LTTNG_LIVE_ITERATOR_STATUS_END; |
14f28187 FD |
569 | goto end; |
570 | } else { | |
ecb4ba8a | 571 | BT_COMP_LOGD("No session found. Try creating a new one in accordance with the `session-not-found-action` parameter"); |
14f28187 FD |
572 | /* |
573 | * Retry to create a viewer session for the requested | |
574 | * session name. | |
575 | */ | |
f79c2d7a FD |
576 | viewer_status = lttng_live_create_viewer_session(lttng_live_msg_iter); |
577 | if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) { | |
578 | if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) { | |
579 | status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; | |
580 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, | |
581 | "Error creating LTTng live viewer session"); | |
582 | } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) { | |
583 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; | |
584 | } else { | |
585 | bt_common_abort(); | |
586 | } | |
14f28187 FD |
587 | goto end; |
588 | } | |
589 | } | |
7cdc2bab | 590 | } |
14f28187 FD |
591 | |
592 | for (session_idx = 0; session_idx < lttng_live_msg_iter->sessions->len; | |
593 | session_idx++) { | |
594 | session = g_ptr_array_index(lttng_live_msg_iter->sessions, | |
595 | session_idx); | |
f79c2d7a FD |
596 | status = lttng_live_get_session(lttng_live_msg_iter, session); |
597 | switch (status) { | |
14f28187 | 598 | case LTTNG_LIVE_ITERATOR_STATUS_OK: |
7cdc2bab | 599 | break; |
14f28187 | 600 | case LTTNG_LIVE_ITERATOR_STATUS_END: |
f79c2d7a | 601 | status = LTTNG_LIVE_ITERATOR_STATUS_OK; |
7cdc2bab MD |
602 | break; |
603 | default: | |
604 | goto end; | |
605 | } | |
606 | if (!session->closed) { | |
607 | nr_sessions_opened++; | |
608 | } | |
609 | } | |
f79c2d7a FD |
610 | |
611 | if (sess_not_found_act != SESSION_NOT_FOUND_ACTION_CONTINUE && | |
14f28187 | 612 | nr_sessions_opened == 0) { |
f79c2d7a FD |
613 | status = LTTNG_LIVE_ITERATOR_STATUS_END; |
614 | } else { | |
615 | status = LTTNG_LIVE_ITERATOR_STATUS_OK; | |
7cdc2bab | 616 | } |
f79c2d7a FD |
617 | |
618 | end: | |
619 | return status; | |
7cdc2bab MD |
620 | } |
621 | ||
622 | static | |
14f28187 FD |
623 | enum lttng_live_iterator_status emit_inactivity_message( |
624 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
625 | struct lttng_live_stream_iterator *stream_iter, | |
cad707e2 | 626 | const bt_message **message, uint64_t timestamp) |
7cdc2bab | 627 | { |
0f1979c3 | 628 | enum lttng_live_iterator_status ret = LTTNG_LIVE_ITERATOR_STATUS_OK; |
1419db2b FD |
629 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
630 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; | |
14f28187 | 631 | bt_message *msg = NULL; |
7cdc2bab | 632 | |
14f28187 FD |
633 | BT_ASSERT(stream_iter->trace->clock_class); |
634 | ||
635 | msg = bt_message_message_iterator_inactivity_create( | |
0f1979c3 FD |
636 | lttng_live_msg_iter->self_msg_iter, |
637 | stream_iter->trace->clock_class, timestamp); | |
d6e69534 | 638 | if (!msg) { |
1419db2b FD |
639 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
640 | "Error emitting message iterator inactivity message"); | |
7cdc2bab MD |
641 | goto error; |
642 | } | |
14f28187 | 643 | |
d6e69534 | 644 | *message = msg; |
7cdc2bab | 645 | end: |
7cdc2bab MD |
646 | return ret; |
647 | ||
648 | error: | |
14f28187 | 649 | ret = LTTNG_LIVE_ITERATOR_STATUS_ERROR; |
d6e69534 | 650 | bt_message_put_ref(msg); |
7cdc2bab MD |
651 | goto end; |
652 | } | |
653 | ||
654 | static | |
14f28187 FD |
655 | enum lttng_live_iterator_status lttng_live_iterator_next_handle_one_quiescent_stream( |
656 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
7cdc2bab | 657 | struct lttng_live_stream_iterator *lttng_live_stream, |
cad707e2 | 658 | const bt_message **message) |
7cdc2bab | 659 | { |
0f1979c3 | 660 | enum lttng_live_iterator_status ret = LTTNG_LIVE_ITERATOR_STATUS_OK; |
7cdc2bab MD |
661 | |
662 | if (lttng_live_stream->state != LTTNG_LIVE_STREAM_QUIESCENT) { | |
14f28187 | 663 | return LTTNG_LIVE_ITERATOR_STATUS_OK; |
7cdc2bab MD |
664 | } |
665 | ||
14f28187 FD |
666 | if (lttng_live_stream->current_inactivity_ts == |
667 | lttng_live_stream->last_inactivity_ts) { | |
7cdc2bab | 668 | lttng_live_stream->state = LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA; |
14f28187 FD |
669 | ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
670 | goto end; | |
671 | } | |
672 | ||
673 | ret = emit_inactivity_message(lttng_live_msg_iter, lttng_live_stream, | |
0f1979c3 | 674 | message, lttng_live_stream->current_inactivity_ts); |
14f28187 FD |
675 | |
676 | lttng_live_stream->last_inactivity_ts = | |
0f1979c3 | 677 | lttng_live_stream->current_inactivity_ts; |
14f28187 FD |
678 | end: |
679 | return ret; | |
680 | } | |
681 | ||
682 | static | |
683 | int live_get_msg_ts_ns(struct lttng_live_stream_iterator *stream_iter, | |
684 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
685 | const bt_message *msg, int64_t last_msg_ts_ns, | |
686 | int64_t *ts_ns) | |
687 | { | |
688 | const bt_clock_class *clock_class = NULL; | |
689 | const bt_clock_snapshot *clock_snapshot = NULL; | |
690 | int ret = 0; | |
c01594de | 691 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
2ece7dd0 | 692 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; |
14f28187 | 693 | |
98b15851 PP |
694 | BT_ASSERT_DBG(msg); |
695 | BT_ASSERT_DBG(ts_ns); | |
14f28187 | 696 | |
2ece7dd0 | 697 | BT_COMP_LOGD("Getting message's timestamp: iter-data-addr=%p, msg-addr=%p, " |
14f28187 FD |
698 | "last-msg-ts=%" PRId64, lttng_live_msg_iter, msg, |
699 | last_msg_ts_ns); | |
700 | ||
701 | switch (bt_message_get_type(msg)) { | |
702 | case BT_MESSAGE_TYPE_EVENT: | |
0f1979c3 | 703 | clock_class = bt_message_event_borrow_stream_class_default_clock_class_const( |
14f28187 | 704 | msg); |
98b15851 | 705 | BT_ASSERT_DBG(clock_class); |
14f28187 | 706 | |
0cbc2c33 PP |
707 | clock_snapshot = bt_message_event_borrow_default_clock_snapshot_const( |
708 | msg); | |
14f28187 FD |
709 | break; |
710 | case BT_MESSAGE_TYPE_PACKET_BEGINNING: | |
0f1979c3 | 711 | clock_class = bt_message_packet_beginning_borrow_stream_class_default_clock_class_const( |
14f28187 FD |
712 | msg); |
713 | BT_ASSERT(clock_class); | |
714 | ||
0cbc2c33 PP |
715 | clock_snapshot = bt_message_packet_beginning_borrow_default_clock_snapshot_const( |
716 | msg); | |
14f28187 FD |
717 | break; |
718 | case BT_MESSAGE_TYPE_PACKET_END: | |
0f1979c3 | 719 | clock_class = bt_message_packet_end_borrow_stream_class_default_clock_class_const( |
14f28187 FD |
720 | msg); |
721 | BT_ASSERT(clock_class); | |
722 | ||
0cbc2c33 PP |
723 | clock_snapshot = bt_message_packet_end_borrow_default_clock_snapshot_const( |
724 | msg); | |
14f28187 FD |
725 | break; |
726 | case BT_MESSAGE_TYPE_DISCARDED_EVENTS: | |
0f1979c3 | 727 | clock_class = bt_message_discarded_events_borrow_stream_class_default_clock_class_const( |
14f28187 FD |
728 | msg); |
729 | BT_ASSERT(clock_class); | |
730 | ||
9b24b6aa | 731 | clock_snapshot = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const( |
0cbc2c33 | 732 | msg); |
14f28187 FD |
733 | break; |
734 | case BT_MESSAGE_TYPE_DISCARDED_PACKETS: | |
0f1979c3 | 735 | clock_class = bt_message_discarded_packets_borrow_stream_class_default_clock_class_const( |
14f28187 FD |
736 | msg); |
737 | BT_ASSERT(clock_class); | |
738 | ||
9b24b6aa | 739 | clock_snapshot = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const( |
0cbc2c33 | 740 | msg); |
14f28187 | 741 | break; |
14f28187 | 742 | case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: |
60d02328 | 743 | clock_snapshot = bt_message_message_iterator_inactivity_borrow_clock_snapshot_const( |
0f1979c3 | 744 | msg); |
14f28187 FD |
745 | break; |
746 | default: | |
747 | /* All the other messages have a higher priority */ | |
2ece7dd0 | 748 | BT_COMP_LOGD_STR("Message has no timestamp: using the last message timestamp."); |
14f28187 | 749 | *ts_ns = last_msg_ts_ns; |
7cdc2bab MD |
750 | goto end; |
751 | } | |
752 | ||
14f28187 | 753 | clock_class = bt_clock_snapshot_borrow_clock_class_const(clock_snapshot); |
98b15851 | 754 | BT_ASSERT_DBG(clock_class); |
14f28187 FD |
755 | |
756 | ret = bt_clock_snapshot_get_ns_from_origin(clock_snapshot, ts_ns); | |
757 | if (ret) { | |
1419db2b FD |
758 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
759 | "Cannot get nanoseconds from Epoch of clock snapshot: " | |
14f28187 FD |
760 | "clock-snapshot-addr=%p", clock_snapshot); |
761 | goto error; | |
762 | } | |
763 | ||
764 | goto end; | |
765 | ||
14f28187 FD |
766 | error: |
767 | ret = -1; | |
7cdc2bab | 768 | |
7cdc2bab | 769 | end: |
14f28187 | 770 | if (ret == 0) { |
2ece7dd0 | 771 | BT_COMP_LOGD("Found message's timestamp: " |
14f28187 FD |
772 | "iter-data-addr=%p, msg-addr=%p, " |
773 | "last-msg-ts=%" PRId64 ", ts=%" PRId64, | |
774 | lttng_live_msg_iter, msg, last_msg_ts_ns, *ts_ns); | |
775 | } | |
776 | ||
7cdc2bab MD |
777 | return ret; |
778 | } | |
779 | ||
780 | static | |
14f28187 FD |
781 | enum lttng_live_iterator_status lttng_live_iterator_next_handle_one_active_data_stream( |
782 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
7cdc2bab | 783 | struct lttng_live_stream_iterator *lttng_live_stream, |
cad707e2 | 784 | const bt_message **message) |
7cdc2bab | 785 | { |
14f28187 | 786 | enum lttng_live_iterator_status ret = LTTNG_LIVE_ITERATOR_STATUS_OK; |
c01594de | 787 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
2ece7dd0 | 788 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; |
18a1979b | 789 | enum ctf_msg_iter_status status; |
0f1979c3 | 790 | uint64_t session_idx, trace_idx; |
7cdc2bab | 791 | |
14f28187 FD |
792 | for (session_idx = 0; session_idx < lttng_live_msg_iter->sessions->len; |
793 | session_idx++) { | |
794 | struct lttng_live_session *session = | |
795 | g_ptr_array_index(lttng_live_msg_iter->sessions, session_idx); | |
7cdc2bab MD |
796 | |
797 | if (session->new_streams_needed) { | |
14f28187 FD |
798 | ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
799 | goto end; | |
7cdc2bab | 800 | } |
14f28187 FD |
801 | for (trace_idx = 0; trace_idx < session->traces->len; |
802 | trace_idx++) { | |
803 | struct lttng_live_trace *trace = | |
804 | g_ptr_array_index(session->traces, trace_idx); | |
76bbaebc | 805 | if (trace->metadata_stream_state == LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED) { |
14f28187 FD |
806 | ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
807 | goto end; | |
7cdc2bab MD |
808 | } |
809 | } | |
810 | } | |
811 | ||
812 | if (lttng_live_stream->state != LTTNG_LIVE_STREAM_ACTIVE_DATA) { | |
14f28187 | 813 | ret = LTTNG_LIVE_ITERATOR_STATUS_ERROR; |
ecb4ba8a FD |
814 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
815 | "Invalid state of live stream iterator" | |
816 | "stream-iter-status=%s", | |
817 | lttng_live_stream_state_string(lttng_live_stream->state)); | |
14f28187 | 818 | goto end; |
7cdc2bab | 819 | } |
14f28187 | 820 | |
851de941 SM |
821 | status = ctf_msg_iter_get_next_message( |
822 | lttng_live_stream->msg_iter, message); | |
7cdc2bab | 823 | switch (status) { |
18a1979b | 824 | case CTF_MSG_ITER_STATUS_EOF: |
14f28187 | 825 | ret = LTTNG_LIVE_ITERATOR_STATUS_END; |
7cdc2bab | 826 | break; |
18a1979b | 827 | case CTF_MSG_ITER_STATUS_OK: |
14f28187 | 828 | ret = LTTNG_LIVE_ITERATOR_STATUS_OK; |
7cdc2bab | 829 | break; |
18a1979b | 830 | case CTF_MSG_ITER_STATUS_AGAIN: |
7cdc2bab MD |
831 | /* |
832 | * Continue immediately (end of packet). The next | |
833 | * get_index may return AGAIN to delay the following | |
834 | * attempt. | |
835 | */ | |
14f28187 | 836 | ret = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
7cdc2bab | 837 | break; |
18a1979b | 838 | case CTF_MSG_ITER_STATUS_ERROR: |
7cdc2bab | 839 | default: |
14f28187 | 840 | ret = LTTNG_LIVE_ITERATOR_STATUS_ERROR; |
1419db2b | 841 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
ecb4ba8a FD |
842 | "CTF message iterator failed to get next message: " |
843 | "msg-iter=%p, msg-iter-status=%s", | |
844 | lttng_live_stream->msg_iter, | |
845 | ctf_msg_iter_status_string(status)); | |
7cdc2bab MD |
846 | break; |
847 | } | |
14f28187 FD |
848 | |
849 | end: | |
7cdc2bab MD |
850 | return ret; |
851 | } | |
852 | ||
4a39caef FD |
853 | static |
854 | enum lttng_live_iterator_status lttng_live_iterator_close_stream( | |
855 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
856 | struct lttng_live_stream_iterator *stream_iter, | |
cad707e2 | 857 | const bt_message **curr_msg) |
4a39caef FD |
858 | { |
859 | enum lttng_live_iterator_status live_status = | |
860 | LTTNG_LIVE_ITERATOR_STATUS_OK; | |
1419db2b FD |
861 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
862 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; | |
4a39caef FD |
863 | /* |
864 | * The viewer has hung up on us so we are closing the stream. The | |
18a1979b | 865 | * `ctf_msg_iter` should simply realize that it needs to close the |
4a39caef FD |
866 | * stream properly by emitting the necessary stream end message. |
867 | */ | |
18a1979b | 868 | enum ctf_msg_iter_status status = ctf_msg_iter_get_next_message( |
851de941 | 869 | stream_iter->msg_iter, curr_msg); |
4a39caef | 870 | |
18a1979b | 871 | if (status == CTF_MSG_ITER_STATUS_ERROR) { |
1419db2b FD |
872 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
873 | "Error getting the next message from CTF message iterator"); | |
4a39caef FD |
874 | live_status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; |
875 | goto end; | |
1cda4ff4 FD |
876 | } else if (status == CTF_MSG_ITER_STATUS_EOF) { |
877 | BT_COMP_LOGI("Reached the end of the live stream iterator."); | |
878 | live_status = LTTNG_LIVE_ITERATOR_STATUS_END; | |
879 | goto end; | |
4a39caef FD |
880 | } |
881 | ||
18a1979b | 882 | BT_ASSERT(status == CTF_MSG_ITER_STATUS_OK); |
4a39caef FD |
883 | |
884 | end: | |
885 | return live_status; | |
886 | } | |
887 | ||
7cdc2bab MD |
888 | /* |
889 | * helper function: | |
890 | * handle_no_data_streams() | |
891 | * retry: | |
892 | * - for each ACTIVE_NO_DATA stream: | |
893 | * - query relayd for stream data, or quiescence info. | |
894 | * - if need metadata, get metadata, goto retry. | |
895 | * - if new stream, get new stream as ACTIVE_NO_DATA, goto retry | |
896 | * - if quiescent, move to QUIESCENT streams | |
897 | * - if fetched data, move to ACTIVE_DATA streams | |
898 | * (at this point each stream either has data, or is quiescent) | |
899 | * | |
900 | * | |
901 | * iterator_next: | |
902 | * handle_new_streams_and_metadata() | |
903 | * - query relayd for known streams, add them as ACTIVE_NO_DATA | |
904 | * - query relayd for metadata | |
905 | * | |
906 | * call handle_active_no_data_streams() | |
907 | * | |
908 | * handle_quiescent_streams() | |
909 | * - if at least one stream is ACTIVE_DATA: | |
910 | * - peek stream event with lowest timestamp -> next_ts | |
911 | * - for each quiescent stream | |
912 | * - if next_ts >= quiescent end | |
913 | * - set state to ACTIVE_NO_DATA | |
914 | * - else | |
915 | * - for each quiescent stream | |
916 | * - set state to ACTIVE_NO_DATA | |
917 | * | |
918 | * call handle_active_no_data_streams() | |
919 | * | |
920 | * handle_active_data_streams() | |
921 | * - if at least one stream is ACTIVE_DATA: | |
922 | * - get stream event with lowest timestamp from heap | |
d6e69534 | 923 | * - make that stream event the current message. |
7cdc2bab MD |
924 | * - move this stream heap position to its next event |
925 | * - if we need to fetch data from relayd, move | |
926 | * stream to ACTIVE_NO_DATA. | |
927 | * - return OK | |
928 | * - return AGAIN | |
929 | * | |
930 | * end criterion: ctrl-c on client. If relayd exits or the session | |
931 | * closes on the relay daemon side, we keep on waiting for streams. | |
932 | * Eventually handle --end timestamp (also an end criterion). | |
933 | * | |
934 | * When disconnected from relayd: try to re-connect endlessly. | |
935 | */ | |
936 | static | |
a31f4d8b | 937 | enum lttng_live_iterator_status lttng_live_iterator_next_msg_on_stream( |
14f28187 FD |
938 | struct lttng_live_msg_iter *lttng_live_msg_iter, |
939 | struct lttng_live_stream_iterator *stream_iter, | |
cad707e2 | 940 | const bt_message **curr_msg) |
7cdc2bab | 941 | { |
c01594de | 942 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
2ece7dd0 | 943 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; |
14f28187 | 944 | enum lttng_live_iterator_status live_status; |
7cdc2bab | 945 | |
ecb4ba8a FD |
946 | BT_COMP_LOGD("Finding the next message for stream iterator: " |
947 | "stream-name=\"%s\"", stream_iter->name->str); | |
948 | ||
4a39caef FD |
949 | if (stream_iter->has_stream_hung_up) { |
950 | /* | |
951 | * The stream has hung up and the stream was properly closed | |
952 | * during the last call to the current function. Return _END | |
953 | * status now so that this stream iterator is removed for the | |
954 | * stream iterator list. | |
955 | */ | |
956 | live_status = LTTNG_LIVE_ITERATOR_STATUS_END; | |
957 | goto end; | |
958 | } | |
959 | ||
7cdc2bab | 960 | retry: |
ecb4ba8a | 961 | LTTNG_LIVE_LOGD_STREAM_ITER(stream_iter); |
14f28187 | 962 | live_status = lttng_live_iterator_handle_new_streams_and_metadata( |
0f1979c3 | 963 | lttng_live_msg_iter); |
14f28187 | 964 | if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) { |
7cdc2bab MD |
965 | goto end; |
966 | } | |
14f28187 | 967 | live_status = lttng_live_iterator_next_handle_one_no_data_stream( |
0f1979c3 | 968 | lttng_live_msg_iter, stream_iter); |
4a39caef | 969 | |
14f28187 | 970 | if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) { |
4a39caef FD |
971 | if (live_status == LTTNG_LIVE_ITERATOR_STATUS_END) { |
972 | /* | |
973 | * We overwrite `live_status` since `curr_msg` is | |
974 | * likely set to a valid message in this function. | |
975 | */ | |
976 | live_status = lttng_live_iterator_close_stream( | |
977 | lttng_live_msg_iter, stream_iter, curr_msg); | |
978 | } | |
7cdc2bab MD |
979 | goto end; |
980 | } | |
14f28187 | 981 | live_status = lttng_live_iterator_next_handle_one_quiescent_stream( |
0f1979c3 | 982 | lttng_live_msg_iter, stream_iter, curr_msg); |
14f28187 | 983 | if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) { |
5084732e | 984 | BT_ASSERT(!*curr_msg); |
7cdc2bab MD |
985 | goto end; |
986 | } | |
14f28187 | 987 | if (*curr_msg) { |
7cdc2bab MD |
988 | goto end; |
989 | } | |
14f28187 | 990 | live_status = lttng_live_iterator_next_handle_one_active_data_stream( |
0f1979c3 | 991 | lttng_live_msg_iter, stream_iter, curr_msg); |
14f28187 | 992 | if (live_status != LTTNG_LIVE_ITERATOR_STATUS_OK) { |
5084732e | 993 | BT_ASSERT(!*curr_msg); |
7cdc2bab MD |
994 | } |
995 | ||
996 | end: | |
14f28187 | 997 | if (live_status == LTTNG_LIVE_ITERATOR_STATUS_CONTINUE) { |
7cdc2bab | 998 | goto retry; |
7cdc2bab | 999 | } |
14f28187 FD |
1000 | |
1001 | return live_status; | |
7cdc2bab MD |
1002 | } |
1003 | ||
1004 | static | |
14f28187 FD |
1005 | enum lttng_live_iterator_status next_stream_iterator_for_trace( |
1006 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
1007 | struct lttng_live_trace *live_trace, | |
a31f4d8b | 1008 | struct lttng_live_stream_iterator **youngest_trace_stream_iter) |
7cdc2bab | 1009 | { |
a31f4d8b | 1010 | struct lttng_live_stream_iterator *youngest_candidate_stream_iter = NULL; |
0f1979c3 FD |
1011 | bt_logging_level log_level = lttng_live_msg_iter->log_level; |
1012 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; | |
14f28187 | 1013 | enum lttng_live_iterator_status stream_iter_status;; |
a31f4d8b | 1014 | int64_t youngest_candidate_msg_ts = INT64_MAX; |
14f28187 | 1015 | uint64_t stream_iter_idx; |
7cdc2bab | 1016 | |
98b15851 PP |
1017 | BT_ASSERT_DBG(live_trace); |
1018 | BT_ASSERT_DBG(live_trace->stream_iterators); | |
ecb4ba8a FD |
1019 | |
1020 | BT_COMP_LOGD("Finding the next stream iterator for trace: " | |
1021 | "trace-id=%"PRIu64, live_trace->id); | |
14f28187 FD |
1022 | /* |
1023 | * Update the current message of every stream iterators of this trace. | |
1024 | * The current msg of every stream must have a timestamp equal or | |
1025 | * larger than the last message returned by this iterator. We must | |
1026 | * ensure monotonicity. | |
1027 | */ | |
1028 | stream_iter_idx = 0; | |
1029 | while (stream_iter_idx < live_trace->stream_iterators->len) { | |
1030 | bool stream_iter_is_ended = false; | |
1031 | struct lttng_live_stream_iterator *stream_iter = | |
1032 | g_ptr_array_index(live_trace->stream_iterators, | |
0f1979c3 | 1033 | stream_iter_idx); |
14f28187 FD |
1034 | |
1035 | /* | |
1036 | * Find if there is are now current message for this stream | |
1037 | * iterator get it. | |
1038 | */ | |
1039 | while (!stream_iter->current_msg) { | |
cad707e2 | 1040 | const bt_message *msg = NULL; |
14f28187 | 1041 | int64_t curr_msg_ts_ns = INT64_MAX; |
a31f4d8b | 1042 | stream_iter_status = lttng_live_iterator_next_msg_on_stream( |
0f1979c3 | 1043 | lttng_live_msg_iter, stream_iter, &msg); |
14f28187 | 1044 | |
2ece7dd0 | 1045 | BT_COMP_LOGD("live stream iterator returned status :%s", |
b607a4f7 | 1046 | lttng_live_iterator_status_string(stream_iter_status)); |
14f28187 FD |
1047 | if (stream_iter_status == LTTNG_LIVE_ITERATOR_STATUS_END) { |
1048 | stream_iter_is_ended = true; | |
1049 | break; | |
1050 | } | |
1051 | ||
1052 | if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK) { | |
1053 | goto end; | |
1054 | } | |
1055 | ||
98b15851 | 1056 | BT_ASSERT_DBG(msg); |
14f28187 FD |
1057 | |
1058 | /* | |
1059 | * Get the timestamp in nanoseconds from origin of this | |
1060 | * messsage. | |
1061 | */ | |
1062 | live_get_msg_ts_ns(stream_iter, lttng_live_msg_iter, | |
1063 | msg, lttng_live_msg_iter->last_msg_ts_ns, | |
1064 | &curr_msg_ts_ns); | |
1065 | ||
1066 | /* | |
1067 | * Check if the message of the current live stream | |
118ae153 | 1068 | * iterator occurred at the exact same time or after the |
14f28187 FD |
1069 | * last message returned by this component's message |
1070 | * iterator. If not, we return an error. | |
1071 | */ | |
1072 | if (curr_msg_ts_ns >= lttng_live_msg_iter->last_msg_ts_ns) { | |
1073 | stream_iter->current_msg = msg; | |
1074 | stream_iter->current_msg_ts_ns = curr_msg_ts_ns; | |
1075 | } else { | |
1076 | /* | |
1077 | * We received a message in the past. To ensure | |
1078 | * monotonicity, we can't send it forward. | |
1079 | */ | |
1419db2b FD |
1080 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1081 | "Message's timestamp is less than " | |
14f28187 FD |
1082 | "lttng-live's message iterator's last " |
1083 | "returned timestamp: " | |
1084 | "lttng-live-msg-iter-addr=%p, ts=%" PRId64 ", " | |
1085 | "last-msg-ts=%" PRId64, | |
1086 | lttng_live_msg_iter, curr_msg_ts_ns, | |
1087 | lttng_live_msg_iter->last_msg_ts_ns); | |
1088 | stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; | |
1089 | goto end; | |
1090 | } | |
1091 | } | |
1092 | ||
98b15851 | 1093 | BT_ASSERT_DBG(stream_iter != youngest_candidate_stream_iter); |
07afb6bc FD |
1094 | |
1095 | if (!stream_iter_is_ended) { | |
a31f4d8b FD |
1096 | if (G_UNLIKELY(youngest_candidate_stream_iter == NULL) || |
1097 | stream_iter->current_msg_ts_ns < youngest_candidate_msg_ts) { | |
07afb6bc FD |
1098 | /* |
1099 | * Update the current best candidate message | |
1100 | * for the stream iterator of this live trace | |
1101 | * to be forwarded downstream. | |
1102 | */ | |
a31f4d8b FD |
1103 | youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns; |
1104 | youngest_candidate_stream_iter = stream_iter; | |
1105 | } else if (stream_iter->current_msg_ts_ns == youngest_candidate_msg_ts) { | |
07afb6bc FD |
1106 | /* |
1107 | * Order the messages in an arbitrary but | |
1108 | * deterministic way. | |
1109 | */ | |
98b15851 | 1110 | BT_ASSERT_DBG(stream_iter != youngest_candidate_stream_iter); |
07afb6bc FD |
1111 | int ret = common_muxing_compare_messages( |
1112 | stream_iter->current_msg, | |
a31f4d8b | 1113 | youngest_candidate_stream_iter->current_msg); |
07afb6bc FD |
1114 | if (ret < 0) { |
1115 | /* | |
a31f4d8b | 1116 | * The `youngest_candidate_stream_iter->current_msg` |
07afb6bc FD |
1117 | * should go first. Update the next |
1118 | * iterator and the current timestamp. | |
1119 | */ | |
a31f4d8b FD |
1120 | youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns; |
1121 | youngest_candidate_stream_iter = stream_iter; | |
07afb6bc FD |
1122 | } else if (ret == 0) { |
1123 | /* | |
1124 | * Unable to pick which one should go | |
1125 | * first. | |
1126 | */ | |
1127 | BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: " | |
1128 | "stream-iter-addr=%p" | |
1129 | "stream-iter-addr=%p", | |
1130 | stream_iter, | |
a31f4d8b | 1131 | youngest_candidate_stream_iter); |
07afb6bc FD |
1132 | } |
1133 | } | |
14f28187 | 1134 | |
07afb6bc FD |
1135 | stream_iter_idx++; |
1136 | } else { | |
14f28187 | 1137 | /* |
fba9b58e JG |
1138 | * The live stream iterator has ended. That |
1139 | * iterator is removed from the array, but | |
1140 | * there is no need to increment | |
1141 | * stream_iter_idx as | |
1142 | * g_ptr_array_remove_index_fast replaces the | |
1143 | * removed element with the array's last | |
1144 | * element. | |
14f28187 | 1145 | */ |
fba9b58e JG |
1146 | g_ptr_array_remove_index_fast( |
1147 | live_trace->stream_iterators, | |
14f28187 | 1148 | stream_iter_idx); |
14f28187 FD |
1149 | } |
1150 | } | |
1151 | ||
a31f4d8b FD |
1152 | if (youngest_candidate_stream_iter) { |
1153 | *youngest_trace_stream_iter = youngest_candidate_stream_iter; | |
14f28187 FD |
1154 | stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_OK; |
1155 | } else { | |
1156 | /* | |
1157 | * The only case where we don't have a candidate for this trace | |
1158 | * is if we reached the end of all the iterators. | |
1159 | */ | |
1160 | BT_ASSERT(live_trace->stream_iterators->len == 0); | |
1161 | stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_END; | |
1162 | } | |
1163 | ||
1164 | end: | |
1165 | return stream_iter_status; | |
1166 | } | |
1167 | ||
1168 | static | |
1169 | enum lttng_live_iterator_status next_stream_iterator_for_session( | |
1170 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
1171 | struct lttng_live_session *session, | |
a31f4d8b | 1172 | struct lttng_live_stream_iterator **youngest_session_stream_iter) |
14f28187 | 1173 | { |
07afb6bc FD |
1174 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; |
1175 | bt_logging_level log_level = lttng_live_msg_iter->log_level; | |
14f28187 FD |
1176 | enum lttng_live_iterator_status stream_iter_status; |
1177 | uint64_t trace_idx = 0; | |
a31f4d8b FD |
1178 | int64_t youngest_candidate_msg_ts = INT64_MAX; |
1179 | struct lttng_live_stream_iterator *youngest_candidate_stream_iter = NULL; | |
14f28187 | 1180 | |
ecb4ba8a FD |
1181 | BT_COMP_LOGD("Finding the next stream iterator for session: " |
1182 | "session-id=%"PRIu64, session->id); | |
14f28187 FD |
1183 | /* |
1184 | * Make sure we are attached to the session and look for new streams | |
1185 | * and metadata. | |
1186 | */ | |
1187 | stream_iter_status = lttng_live_get_session(lttng_live_msg_iter, session); | |
1188 | if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK && | |
1189 | stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_CONTINUE && | |
1190 | stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_END) { | |
7cdc2bab MD |
1191 | goto end; |
1192 | } | |
14f28187 | 1193 | |
98b15851 | 1194 | BT_ASSERT_DBG(session->traces); |
14f28187 | 1195 | |
14f28187 FD |
1196 | while (trace_idx < session->traces->len) { |
1197 | bool trace_is_ended = false; | |
1198 | struct lttng_live_stream_iterator *stream_iter; | |
1199 | struct lttng_live_trace *trace = | |
1200 | g_ptr_array_index(session->traces, trace_idx); | |
1201 | ||
1202 | stream_iter_status = next_stream_iterator_for_trace( | |
1203 | lttng_live_msg_iter, trace, &stream_iter); | |
1204 | if (stream_iter_status == LTTNG_LIVE_ITERATOR_STATUS_END) { | |
1205 | /* | |
1206 | * All the live stream iterators for this trace are | |
1207 | * ENDed. Remove the trace from this session. | |
1208 | */ | |
1209 | trace_is_ended = true; | |
1210 | } else if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK) { | |
1211 | goto end; | |
1212 | } | |
1213 | ||
1214 | if (!trace_is_ended) { | |
98b15851 | 1215 | BT_ASSERT_DBG(stream_iter); |
14f28187 | 1216 | |
a31f4d8b FD |
1217 | if (G_UNLIKELY(youngest_candidate_stream_iter == NULL) || |
1218 | stream_iter->current_msg_ts_ns < youngest_candidate_msg_ts) { | |
1219 | youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns; | |
1220 | youngest_candidate_stream_iter = stream_iter; | |
1221 | } else if (stream_iter->current_msg_ts_ns == youngest_candidate_msg_ts) { | |
07afb6bc FD |
1222 | /* |
1223 | * Order the messages in an arbitrary but | |
1224 | * deterministic way. | |
1225 | */ | |
1226 | int ret = common_muxing_compare_messages( | |
1227 | stream_iter->current_msg, | |
a31f4d8b | 1228 | youngest_candidate_stream_iter->current_msg); |
07afb6bc FD |
1229 | if (ret < 0) { |
1230 | /* | |
a31f4d8b | 1231 | * The `youngest_candidate_stream_iter->current_msg` |
07afb6bc FD |
1232 | * should go first. Update the next iterator |
1233 | * and the current timestamp. | |
1234 | */ | |
a31f4d8b FD |
1235 | youngest_candidate_msg_ts = stream_iter->current_msg_ts_ns; |
1236 | youngest_candidate_stream_iter = stream_iter; | |
07afb6bc FD |
1237 | } else if (ret == 0) { |
1238 | /* Unable to pick which one should go first. */ | |
1239 | BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: " | |
1240 | "stream-iter-addr=%p" "stream-iter-addr=%p", | |
a31f4d8b | 1241 | stream_iter, youngest_candidate_stream_iter); |
07afb6bc | 1242 | } |
14f28187 FD |
1243 | } |
1244 | trace_idx++; | |
1245 | } else { | |
ba90bce7 JG |
1246 | /* |
1247 | * trace_idx is not incremented since | |
1248 | * g_ptr_array_remove_index_fast replaces the | |
1249 | * element at trace_idx with the array's last element. | |
1250 | */ | |
1251 | g_ptr_array_remove_index_fast(session->traces, | |
1252 | trace_idx); | |
14f28187 FD |
1253 | } |
1254 | } | |
a31f4d8b FD |
1255 | if (youngest_candidate_stream_iter) { |
1256 | *youngest_session_stream_iter = youngest_candidate_stream_iter; | |
14f28187 | 1257 | stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_OK; |
7cdc2bab | 1258 | } else { |
14f28187 FD |
1259 | /* |
1260 | * The only cases where we don't have a candidate for this | |
1261 | * trace is: | |
1262 | * 1. if we reached the end of all the iterators of all the | |
1263 | * traces of this session, | |
1264 | * 2. if we never had live stream iterator in the first place. | |
1265 | * | |
1266 | * In either cases, we return END. | |
1267 | */ | |
1268 | BT_ASSERT(session->traces->len == 0); | |
1269 | stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_END; | |
7cdc2bab MD |
1270 | } |
1271 | end: | |
14f28187 FD |
1272 | return stream_iter_status; |
1273 | } | |
1274 | ||
1275 | static inline | |
1276 | void put_messages(bt_message_array_const msgs, uint64_t count) | |
1277 | { | |
1278 | uint64_t i; | |
1279 | ||
1280 | for (i = 0; i < count; i++) { | |
1281 | BT_MESSAGE_PUT_REF_AND_RESET(msgs[i]); | |
7cdc2bab | 1282 | } |
7cdc2bab MD |
1283 | } |
1284 | ||
d3eb6e8f | 1285 | BT_HIDDEN |
a3f0c7db | 1286 | bt_message_iterator_class_next_method_status lttng_live_msg_iter_next( |
14f28187 FD |
1287 | bt_self_message_iterator *self_msg_it, |
1288 | bt_message_array_const msgs, uint64_t capacity, | |
1289 | uint64_t *count) | |
d3eb6e8f | 1290 | { |
a3f0c7db | 1291 | bt_message_iterator_class_next_method_status status; |
f79c2d7a | 1292 | enum lttng_live_viewer_status viewer_status; |
14f28187 FD |
1293 | struct lttng_live_msg_iter *lttng_live_msg_iter = |
1294 | bt_self_message_iterator_get_data(self_msg_it); | |
1295 | struct lttng_live_component *lttng_live = | |
1296 | lttng_live_msg_iter->lttng_live_comp; | |
376fc2bd FD |
1297 | bt_self_component *self_comp = lttng_live_msg_iter->self_comp; |
1298 | bt_logging_level log_level = lttng_live_msg_iter->log_level; | |
14f28187 FD |
1299 | enum lttng_live_iterator_status stream_iter_status; |
1300 | uint64_t session_idx; | |
1301 | ||
1302 | *count = 0; | |
1303 | ||
98b15851 | 1304 | BT_ASSERT_DBG(lttng_live_msg_iter); |
14f28187 | 1305 | |
f79c2d7a FD |
1306 | if (G_UNLIKELY(lttng_live_msg_iter->was_interrupted)) { |
1307 | /* | |
1308 | * The iterator was interrupted in a previous call to the | |
1309 | * `_next()` method. We currently do not support generating | |
1310 | * messages after such event. The babeltrace2 CLI should never | |
1311 | * be running the graph after being interrupted. So this check | |
1312 | * is to prevent other graph users from using this live | |
1313 | * iterator in an messed up internal state. | |
1314 | */ | |
a3f0c7db | 1315 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR; |
f79c2d7a FD |
1316 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1317 | "Message iterator was interrupted during a previous call to the `next()` and currently does not support continuing after such event."); | |
1318 | goto end; | |
1319 | } | |
1320 | ||
14f28187 FD |
1321 | /* |
1322 | * Clear all the invalid message reference that might be left over in | |
1323 | * the output array. | |
1324 | */ | |
1325 | memset(msgs, 0, capacity * sizeof(*msgs)); | |
1326 | ||
1327 | /* | |
1328 | * If no session are exposed on the relay found at the url provided by | |
1329 | * the user, session count will be 0. In this case, we return status | |
1330 | * end to return gracefully. | |
1331 | */ | |
1332 | if (lttng_live_msg_iter->sessions->len == 0) { | |
1333 | if (lttng_live->params.sess_not_found_act != | |
1334 | SESSION_NOT_FOUND_ACTION_CONTINUE) { | |
a3f0c7db | 1335 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END; |
f79c2d7a | 1336 | goto end; |
14f28187 FD |
1337 | } else { |
1338 | /* | |
1339 | * The are no more active session for this session | |
1340 | * name. Retry to create a viewer session for the | |
1341 | * requested session name. | |
1342 | */ | |
f79c2d7a FD |
1343 | viewer_status = lttng_live_create_viewer_session(lttng_live_msg_iter); |
1344 | if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) { | |
1345 | if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) { | |
a3f0c7db | 1346 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR; |
f79c2d7a FD |
1347 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1348 | "Error creating LTTng live viewer session"); | |
1349 | } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) { | |
a3f0c7db | 1350 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN; |
f79c2d7a FD |
1351 | } else { |
1352 | bt_common_abort(); | |
1353 | } | |
1354 | goto end; | |
14f28187 FD |
1355 | } |
1356 | } | |
1357 | } | |
1358 | ||
1359 | if (lttng_live_msg_iter->active_stream_iter == 0) { | |
1360 | lttng_live_force_new_streams_and_metadata(lttng_live_msg_iter); | |
1361 | } | |
1362 | ||
1363 | /* | |
1364 | * Here the muxing of message is done. | |
1365 | * | |
1366 | * We need to iterate over all the streams of all the traces of all the | |
1367 | * viewer sessions in order to get the message with the smallest | |
1368 | * timestamp. In this case, a session is a viewer session and there is | |
1369 | * one viewer session per consumer daemon. (UST 32bit, UST 64bit and/or | |
1370 | * kernel). Each viewer session can have multiple traces, for example, | |
1371 | * 64bit UST viewer sessions could have multiple per-pid traces. | |
1372 | * | |
1373 | * We iterate over the streams of each traces to update and see what is | |
1374 | * their next message's timestamp. From those timestamps, we select the | |
1375 | * message with the smallest timestamp as the best candidate message | |
1376 | * for that trace and do the same thing across all the sessions. | |
1377 | * | |
1378 | * We then compare the timestamp of best candidate message of all the | |
1379 | * sessions to pick the message with the smallest timestamp and we | |
1380 | * return it. | |
1381 | */ | |
1382 | while (*count < capacity) { | |
a31f4d8b FD |
1383 | struct lttng_live_stream_iterator *youngest_stream_iter = NULL, |
1384 | *candidate_stream_iter = NULL; | |
1385 | int64_t youngest_msg_ts_ns = INT64_MAX; | |
14f28187 | 1386 | |
98b15851 | 1387 | BT_ASSERT_DBG(lttng_live_msg_iter->sessions); |
14f28187 | 1388 | session_idx = 0; |
14f28187 FD |
1389 | while (session_idx < lttng_live_msg_iter->sessions->len) { |
1390 | struct lttng_live_session *session = | |
1391 | g_ptr_array_index(lttng_live_msg_iter->sessions, | |
1392 | session_idx); | |
1393 | ||
1394 | /* Find the best candidate message to send downstream. */ | |
1395 | stream_iter_status = next_stream_iterator_for_session( | |
1396 | lttng_live_msg_iter, session, | |
1397 | &candidate_stream_iter); | |
1398 | ||
1399 | /* If we receive an END status, it means that either: | |
1400 | * - Those traces never had active streams (UST with no | |
1401 | * data produced yet), | |
1402 | * - All live stream iterators have ENDed.*/ | |
1403 | if (stream_iter_status == LTTNG_LIVE_ITERATOR_STATUS_END) { | |
1404 | if (session->closed && session->traces->len == 0) { | |
1405 | /* | |
7d632b96 JG |
1406 | * Remove the session from the list. |
1407 | * session_idx is not modified since | |
1408 | * g_ptr_array_remove_index_fast | |
1409 | * replaces the the removed element with | |
1410 | * the array's last element. | |
14f28187 FD |
1411 | */ |
1412 | g_ptr_array_remove_index_fast( | |
1413 | lttng_live_msg_iter->sessions, | |
1414 | session_idx); | |
14f28187 FD |
1415 | } else { |
1416 | session_idx++; | |
1417 | } | |
1418 | continue; | |
1419 | } | |
1420 | ||
1421 | if (stream_iter_status != LTTNG_LIVE_ITERATOR_STATUS_OK) { | |
f79c2d7a | 1422 | goto return_status; |
14f28187 FD |
1423 | } |
1424 | ||
a31f4d8b | 1425 | if (G_UNLIKELY(youngest_stream_iter == NULL) || |
1d314141 | 1426 | candidate_stream_iter->current_msg_ts_ns < youngest_msg_ts_ns) { |
a31f4d8b FD |
1427 | youngest_msg_ts_ns = candidate_stream_iter->current_msg_ts_ns; |
1428 | youngest_stream_iter = candidate_stream_iter; | |
1429 | } else if (candidate_stream_iter->current_msg_ts_ns == youngest_msg_ts_ns) { | |
376fc2bd FD |
1430 | /* |
1431 | * The currently selected message to be sent | |
1432 | * downstream next has the exact same timestamp | |
1433 | * that of the current candidate message. We | |
1434 | * must break the tie in a predictable manner. | |
1435 | */ | |
1436 | BT_COMP_LOGD_STR("Two of the next message candidates have the same timestamps, pick one deterministically."); | |
1437 | /* | |
1438 | * Order the messages in an arbitrary but | |
07afb6bc | 1439 | * deterministic way. |
376fc2bd | 1440 | */ |
07afb6bc FD |
1441 | int ret = common_muxing_compare_messages( |
1442 | candidate_stream_iter->current_msg, | |
a31f4d8b | 1443 | youngest_stream_iter->current_msg); |
376fc2bd FD |
1444 | if (ret < 0) { |
1445 | /* | |
1446 | * The `candidate_stream_iter->current_msg` | |
1447 | * should go first. Update the next | |
1448 | * iterator and the current timestamp. | |
1449 | */ | |
a31f4d8b FD |
1450 | youngest_msg_ts_ns = candidate_stream_iter->current_msg_ts_ns; |
1451 | youngest_stream_iter = candidate_stream_iter; | |
376fc2bd FD |
1452 | } else if (ret == 0) { |
1453 | /* Unable to pick which one should go first. */ | |
1454 | BT_COMP_LOGW("Cannot deterministically pick next live stream message iterator because they have identical next messages: " | |
1455 | "next-stream-iter-addr=%p" "candidate-stream-iter-addr=%p", | |
a31f4d8b | 1456 | youngest_stream_iter, candidate_stream_iter); |
376fc2bd | 1457 | } |
14f28187 FD |
1458 | } |
1459 | ||
1460 | session_idx++; | |
1461 | } | |
1462 | ||
a31f4d8b | 1463 | if (!youngest_stream_iter) { |
14f28187 | 1464 | stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
f79c2d7a | 1465 | goto return_status; |
14f28187 FD |
1466 | } |
1467 | ||
98b15851 | 1468 | BT_ASSERT_DBG(youngest_stream_iter->current_msg); |
14f28187 | 1469 | /* Ensure monotonicity. */ |
98b15851 | 1470 | BT_ASSERT_DBG(lttng_live_msg_iter->last_msg_ts_ns <= |
a31f4d8b | 1471 | youngest_stream_iter->current_msg_ts_ns); |
14f28187 FD |
1472 | |
1473 | /* | |
1474 | * Insert the next message to the message batch. This will set | |
1475 | * stream iterator current messsage to NULL so that next time | |
1476 | * we fetch the next message of that stream iterator | |
1477 | */ | |
a31f4d8b | 1478 | BT_MESSAGE_MOVE_REF(msgs[*count], youngest_stream_iter->current_msg); |
14f28187 FD |
1479 | (*count)++; |
1480 | ||
1481 | /* Update the last timestamp in nanoseconds sent downstream. */ | |
a31f4d8b FD |
1482 | lttng_live_msg_iter->last_msg_ts_ns = youngest_msg_ts_ns; |
1483 | youngest_stream_iter->current_msg_ts_ns = INT64_MAX; | |
14f28187 FD |
1484 | |
1485 | stream_iter_status = LTTNG_LIVE_ITERATOR_STATUS_OK; | |
1486 | } | |
f79c2d7a FD |
1487 | |
1488 | return_status: | |
14f28187 FD |
1489 | switch (stream_iter_status) { |
1490 | case LTTNG_LIVE_ITERATOR_STATUS_OK: | |
1491 | case LTTNG_LIVE_ITERATOR_STATUS_AGAIN: | |
f79c2d7a FD |
1492 | /* |
1493 | * If we gathered messages, return _OK even if the graph was | |
1494 | * interrupted. This allows for the components downstream to at | |
1495 | * least get the thoses messages. If the graph was indeed | |
1496 | * interrupted there should not be another _next() call as the | |
1497 | * application will tear down the graph. This component class | |
1498 | * doesn't support restarting after an interruption. | |
1499 | */ | |
14f28187 | 1500 | if (*count > 0) { |
a3f0c7db | 1501 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK; |
14f28187 | 1502 | } else { |
a3f0c7db | 1503 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_AGAIN; |
14f28187 | 1504 | } |
7cdc2bab | 1505 | break; |
14f28187 | 1506 | case LTTNG_LIVE_ITERATOR_STATUS_END: |
a3f0c7db | 1507 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END; |
7cdc2bab | 1508 | break; |
14f28187 | 1509 | case LTTNG_LIVE_ITERATOR_STATUS_NOMEM: |
b607a4f7 FD |
1510 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1511 | "Memory error preparing the next batch of messages: " | |
1512 | "live-iter-status=%s", | |
1513 | lttng_live_iterator_status_string(stream_iter_status)); | |
a3f0c7db | 1514 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR; |
14f28187 FD |
1515 | break; |
1516 | case LTTNG_LIVE_ITERATOR_STATUS_ERROR: | |
1517 | case LTTNG_LIVE_ITERATOR_STATUS_INVAL: | |
1518 | case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED: | |
b607a4f7 FD |
1519 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1520 | "Error preparing the next batch of messages: " | |
1521 | "live-iter-status=%s", | |
1522 | lttng_live_iterator_status_string(stream_iter_status)); | |
1523 | ||
a3f0c7db | 1524 | status = BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR; |
14f28187 FD |
1525 | /* Put all existing messages on error. */ |
1526 | put_messages(msgs, *count); | |
7cdc2bab | 1527 | break; |
14f28187 | 1528 | default: |
498e7994 | 1529 | bt_common_abort(); |
7cdc2bab | 1530 | } |
14f28187 | 1531 | |
f79c2d7a | 1532 | end: |
14f28187 | 1533 | return status; |
7cdc2bab | 1534 | } |
41a2b7ae | 1535 | |
4f74db52 FD |
1536 | static |
1537 | struct lttng_live_msg_iter *lttng_live_msg_iter_create( | |
1538 | struct lttng_live_component *lttng_live_comp, | |
1539 | bt_self_message_iterator *self_msg_it) | |
1540 | { | |
1541 | bt_self_component *self_comp = lttng_live_comp->self_comp; | |
1542 | bt_logging_level log_level = lttng_live_comp->log_level; | |
1543 | ||
1544 | struct lttng_live_msg_iter *lttng_live_msg_iter = | |
1545 | g_new0(struct lttng_live_msg_iter, 1); | |
1546 | if (!lttng_live_msg_iter) { | |
1547 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, | |
1548 | "Failed to allocate lttng_live_msg_iter"); | |
1549 | goto end; | |
1550 | } | |
1551 | ||
1552 | lttng_live_msg_iter->log_level = lttng_live_comp->log_level; | |
1553 | lttng_live_msg_iter->self_comp = lttng_live_comp->self_comp; | |
1554 | lttng_live_msg_iter->lttng_live_comp = lttng_live_comp; | |
1555 | lttng_live_msg_iter->self_msg_iter = self_msg_it; | |
1556 | ||
1557 | lttng_live_msg_iter->active_stream_iter = 0; | |
1558 | lttng_live_msg_iter->last_msg_ts_ns = INT64_MIN; | |
1559 | lttng_live_msg_iter->was_interrupted = false; | |
1560 | ||
1561 | lttng_live_msg_iter->sessions = g_ptr_array_new_with_free_func( | |
1562 | (GDestroyNotify) lttng_live_destroy_session); | |
1563 | BT_ASSERT(lttng_live_msg_iter->sessions); | |
1564 | ||
1565 | end: | |
1566 | return lttng_live_msg_iter; | |
1567 | ||
1568 | } | |
1569 | ||
7cdc2bab | 1570 | BT_HIDDEN |
a3f0c7db | 1571 | bt_message_iterator_class_initialize_method_status lttng_live_msg_iter_init( |
14f28187 | 1572 | bt_self_message_iterator *self_msg_it, |
8d8b141d | 1573 | bt_self_message_iterator_configuration *config, |
14f28187 | 1574 | bt_self_component_port_output *self_port) |
7cdc2bab | 1575 | { |
a3f0c7db | 1576 | bt_message_iterator_class_initialize_method_status status; |
14f28187 FD |
1577 | struct lttng_live_component *lttng_live; |
1578 | struct lttng_live_msg_iter *lttng_live_msg_iter; | |
f79c2d7a | 1579 | enum lttng_live_viewer_status viewer_status; |
c01594de | 1580 | bt_logging_level log_level; |
f615b250 PP |
1581 | bt_self_component *self_comp = |
1582 | bt_self_message_iterator_borrow_component(self_msg_it); | |
14f28187 FD |
1583 | |
1584 | lttng_live = bt_self_component_get_data(self_comp); | |
c01594de | 1585 | log_level = lttng_live->log_level; |
2ece7dd0 | 1586 | self_comp = lttng_live->self_comp; |
14f28187 | 1587 | |
4f74db52 | 1588 | |
14f28187 FD |
1589 | /* There can be only one downstream iterator at the same time. */ |
1590 | BT_ASSERT(!lttng_live->has_msg_iter); | |
1591 | lttng_live->has_msg_iter = true; | |
1592 | ||
4f74db52 FD |
1593 | lttng_live_msg_iter = lttng_live_msg_iter_create(lttng_live, |
1594 | self_msg_it); | |
14f28187 | 1595 | if (!lttng_live_msg_iter) { |
a3f0c7db | 1596 | status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
f79c2d7a | 1597 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
4f74db52 FD |
1598 | "Failed to create lttng_live_msg_iter"); |
1599 | goto error; | |
7cdc2bab | 1600 | } |
14f28187 | 1601 | |
f79c2d7a FD |
1602 | viewer_status = live_viewer_connection_create(self_comp, NULL, |
1603 | log_level, lttng_live->params.url->str, false, | |
1604 | lttng_live_msg_iter, <tng_live_msg_iter->viewer_connection); | |
1605 | if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) { | |
1606 | if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) { | |
1607 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, | |
1608 | "Failed to create viewer connection"); | |
1609 | } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) { | |
1610 | /* | |
1611 | * Interruption in the _iter_init() method is not | |
1612 | * supported. Return an error. | |
1613 | */ | |
1614 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, | |
1615 | "Interrupted while creating viewer connection"); | |
1616 | } | |
14f28187 FD |
1617 | goto error; |
1618 | } | |
1619 | ||
f79c2d7a FD |
1620 | viewer_status = lttng_live_create_viewer_session(lttng_live_msg_iter); |
1621 | if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) { | |
1622 | if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) { | |
1623 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, | |
1624 | "Failed to create viewer session"); | |
1625 | } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) { | |
1626 | /* | |
1627 | * Interruption in the _iter_init() method is not | |
1628 | * supported. Return an error. | |
1629 | */ | |
1630 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, | |
1631 | "Interrupted when creating viewer session"); | |
1632 | } | |
14f28187 FD |
1633 | goto error; |
1634 | } | |
f79c2d7a | 1635 | |
14f28187 FD |
1636 | if (lttng_live_msg_iter->sessions->len == 0) { |
1637 | switch (lttng_live->params.sess_not_found_act) { | |
1638 | case SESSION_NOT_FOUND_ACTION_CONTINUE: | |
f79c2d7a | 1639 | BT_COMP_LOGI("Unable to connect to the requested live viewer session. Keep trying to connect because of " |
14f28187 FD |
1640 | "%s=\"%s\" component parameter: url=\"%s\"", |
1641 | SESS_NOT_FOUND_ACTION_PARAM, | |
1642 | SESS_NOT_FOUND_ACTION_CONTINUE_STR, | |
1643 | lttng_live->params.url->str); | |
1644 | break; | |
1645 | case SESSION_NOT_FOUND_ACTION_FAIL: | |
f79c2d7a FD |
1646 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1647 | "Unable to connect to the requested live viewer session. Fail the message iterator initialization because of %s=\"%s\" " | |
14f28187 FD |
1648 | "component parameter: url =\"%s\"", |
1649 | SESS_NOT_FOUND_ACTION_PARAM, | |
1650 | SESS_NOT_FOUND_ACTION_FAIL_STR, | |
1651 | lttng_live->params.url->str); | |
7cdc2bab | 1652 | goto error; |
14f28187 | 1653 | case SESSION_NOT_FOUND_ACTION_END: |
f79c2d7a | 1654 | BT_COMP_LOGI("Unable to connect to the requested live viewer session. End gracefully at the first _next() " |
14f28187 FD |
1655 | "call because of %s=\"%s\" component parameter: " |
1656 | "url=\"%s\"", SESS_NOT_FOUND_ACTION_PARAM, | |
1657 | SESS_NOT_FOUND_ACTION_END_STR, | |
1658 | lttng_live->params.url->str); | |
1659 | break; | |
bce81ff2 | 1660 | default: |
498e7994 | 1661 | bt_common_abort(); |
7cdc2bab | 1662 | } |
7cdc2bab MD |
1663 | } |
1664 | ||
14f28187 | 1665 | bt_self_message_iterator_set_data(self_msg_it, lttng_live_msg_iter); |
a3f0c7db | 1666 | status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK; |
14f28187 | 1667 | goto end; |
f79c2d7a | 1668 | |
14f28187 | 1669 | error: |
a3f0c7db | 1670 | status = BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR; |
14f28187 | 1671 | lttng_live_msg_iter_destroy(lttng_live_msg_iter); |
7cdc2bab | 1672 | end: |
f79c2d7a | 1673 | return status; |
7cdc2bab MD |
1674 | } |
1675 | ||
80aff5ef SM |
1676 | static struct bt_param_validation_map_value_entry_descr list_sessions_params[] = { |
1677 | { URL_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, { .type = BT_VALUE_TYPE_STRING } }, | |
1678 | BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END | |
1679 | }; | |
1680 | ||
7cdc2bab | 1681 | static |
d24d5663 PP |
1682 | bt_component_class_query_method_status lttng_live_query_list_sessions( |
1683 | const bt_value *params, const bt_value **result, | |
80aff5ef | 1684 | bt_self_component_class *self_comp_class, |
d24d5663 | 1685 | bt_logging_level log_level) |
7cdc2bab | 1686 | { |
80aff5ef | 1687 | bt_component_class_query_method_status status; |
14f28187 | 1688 | const bt_value *url_value = NULL; |
7cdc2bab | 1689 | const char *url; |
14f28187 | 1690 | struct live_viewer_connection *viewer_connection = NULL; |
f79c2d7a | 1691 | enum lttng_live_viewer_status viewer_status; |
80aff5ef SM |
1692 | enum bt_param_validation_status validation_status; |
1693 | gchar *validate_error = NULL; | |
7cdc2bab | 1694 | |
80aff5ef SM |
1695 | validation_status = bt_param_validation_validate(params, |
1696 | list_sessions_params, &validate_error); | |
1697 | if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) { | |
1698 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR; | |
7cdc2bab | 1699 | goto error; |
80aff5ef | 1700 | } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) { |
a635e507 | 1701 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; |
1419db2b FD |
1702 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "%s", |
1703 | validate_error); | |
7cdc2bab MD |
1704 | goto error; |
1705 | } | |
1706 | ||
80aff5ef | 1707 | url_value = bt_value_map_borrow_entry_value_const(params, URL_PARAM); |
14f28187 FD |
1708 | url = bt_value_string_get(url_value); |
1709 | ||
f79c2d7a FD |
1710 | viewer_status = live_viewer_connection_create(NULL, self_comp_class, |
1711 | log_level, url, true, NULL, &viewer_connection); | |
1712 | if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) { | |
1713 | if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) { | |
1714 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, | |
1715 | "Failed to create viewer connection"); | |
1716 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
1717 | } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) { | |
1718 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN; | |
1719 | } else { | |
1720 | bt_common_abort(); | |
1721 | } | |
7cdc2bab MD |
1722 | goto error; |
1723 | } | |
1724 | ||
14f28187 | 1725 | status = live_viewer_connection_list_sessions(viewer_connection, |
80aff5ef | 1726 | result); |
d24d5663 | 1727 | if (status != BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK) { |
1419db2b FD |
1728 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, |
1729 | "Failed to list viewer sessions"); | |
c7eee084 PP |
1730 | goto error; |
1731 | } | |
1732 | ||
7cdc2bab | 1733 | goto end; |
c7eee084 | 1734 | |
7cdc2bab | 1735 | error: |
14f28187 | 1736 | BT_VALUE_PUT_REF_AND_RESET(*result); |
c7eee084 | 1737 | |
14f28187 | 1738 | if (status >= 0) { |
d24d5663 | 1739 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; |
c7eee084 PP |
1740 | } |
1741 | ||
7cdc2bab MD |
1742 | end: |
1743 | if (viewer_connection) { | |
14f28187 | 1744 | live_viewer_connection_destroy(viewer_connection); |
7cdc2bab | 1745 | } |
80aff5ef SM |
1746 | |
1747 | g_free(validate_error); | |
1748 | ||
14f28187 | 1749 | return status; |
7cdc2bab MD |
1750 | } |
1751 | ||
312df793 PP |
1752 | static |
1753 | bt_component_class_query_method_status lttng_live_query_support_info( | |
1754 | const bt_value *params, const bt_value **result, | |
1419db2b | 1755 | bt_self_component_class *self_comp_class, |
312df793 PP |
1756 | bt_logging_level log_level) |
1757 | { | |
1758 | bt_component_class_query_method_status status = | |
1759 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; | |
1760 | const bt_value *input_type_value; | |
1761 | const bt_value *input_value; | |
1762 | double weight = 0; | |
1763 | struct bt_common_lttng_live_url_parts parts = { 0 }; | |
1764 | ||
1765 | /* Used by the logging macros */ | |
1766 | __attribute__((unused)) bt_self_component *self_comp = NULL; | |
1767 | ||
1768 | *result = NULL; | |
1769 | input_type_value = bt_value_map_borrow_entry_value_const(params, | |
1770 | "type"); | |
1771 | if (!input_type_value) { | |
1419db2b FD |
1772 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, |
1773 | "Missing expected `type` parameter."); | |
312df793 PP |
1774 | goto error; |
1775 | } | |
1776 | ||
1777 | if (!bt_value_is_string(input_type_value)) { | |
1419db2b FD |
1778 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, |
1779 | "`type` parameter is not a string value."); | |
312df793 PP |
1780 | goto error; |
1781 | } | |
1782 | ||
1783 | if (strcmp(bt_value_string_get(input_type_value), "string") != 0) { | |
1784 | /* We don't handle file system paths */ | |
1785 | goto create_result; | |
1786 | } | |
1787 | ||
1788 | input_value = bt_value_map_borrow_entry_value_const(params, "input"); | |
1789 | if (!input_value) { | |
1419db2b FD |
1790 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, |
1791 | "Missing expected `input` parameter."); | |
312df793 PP |
1792 | goto error; |
1793 | } | |
1794 | ||
1795 | if (!bt_value_is_string(input_value)) { | |
1419db2b FD |
1796 | BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, |
1797 | "`input` parameter is not a string value."); | |
312df793 PP |
1798 | goto error; |
1799 | } | |
1800 | ||
1801 | parts = bt_common_parse_lttng_live_url(bt_value_string_get(input_value), | |
1802 | NULL, 0); | |
1803 | if (parts.session_name) { | |
1804 | /* | |
1805 | * Looks pretty much like an LTTng live URL: we got the | |
1806 | * session name part, which forms a complete URL. | |
1807 | */ | |
1808 | weight = .75; | |
1809 | } | |
1810 | ||
1811 | create_result: | |
1812 | *result = bt_value_real_create_init(weight); | |
1813 | if (!*result) { | |
1814 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR; | |
1815 | goto error; | |
1816 | } | |
1817 | ||
1818 | goto end; | |
1819 | ||
1820 | error: | |
1821 | if (status >= 0) { | |
1822 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR; | |
1823 | } | |
1824 | ||
1825 | BT_ASSERT(!*result); | |
1826 | ||
1827 | end: | |
1828 | bt_common_destroy_lttng_live_url_parts(&parts); | |
1829 | return status; | |
1830 | } | |
1831 | ||
7cdc2bab | 1832 | BT_HIDDEN |
d24d5663 PP |
1833 | bt_component_class_query_method_status lttng_live_query( |
1834 | bt_self_component_class_source *comp_class, | |
3c729b9a | 1835 | bt_private_query_executor *priv_query_exec, |
14f28187 | 1836 | const char *object, const bt_value *params, |
7c14d641 | 1837 | __attribute__((unused)) void *method_data, |
3c729b9a | 1838 | const bt_value **result) |
7cdc2bab | 1839 | { |
d24d5663 PP |
1840 | bt_component_class_query_method_status status = |
1841 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; | |
2ece7dd0 | 1842 | bt_self_component *self_comp = NULL; |
80aff5ef SM |
1843 | bt_self_component_class *self_comp_class = |
1844 | bt_self_component_class_source_as_self_component_class(comp_class); | |
3c729b9a PP |
1845 | bt_logging_level log_level = bt_query_executor_get_logging_level( |
1846 | bt_private_query_executor_as_query_executor_const( | |
1847 | priv_query_exec)); | |
c7eee084 | 1848 | |
7cdc2bab | 1849 | if (strcmp(object, "sessions") == 0) { |
c01594de | 1850 | status = lttng_live_query_list_sessions(params, result, |
80aff5ef | 1851 | self_comp_class, log_level); |
312df793 PP |
1852 | } else if (strcmp(object, "babeltrace.support-info") == 0) { |
1853 | status = lttng_live_query_support_info(params, result, | |
1419db2b | 1854 | self_comp_class, log_level); |
14f28187 | 1855 | } else { |
32a09ecd | 1856 | BT_COMP_LOGI("Unknown query object `%s`", object); |
76b6c2f7 | 1857 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT; |
14f28187 | 1858 | goto end; |
7cdc2bab | 1859 | } |
14f28187 FD |
1860 | |
1861 | end: | |
1862 | return status; | |
7cdc2bab MD |
1863 | } |
1864 | ||
1865 | static | |
1866 | void lttng_live_component_destroy_data(struct lttng_live_component *lttng_live) | |
1867 | { | |
19bdff20 FD |
1868 | if (!lttng_live) { |
1869 | return; | |
1870 | } | |
14f28187 FD |
1871 | if (lttng_live->params.url) { |
1872 | g_string_free(lttng_live->params.url, TRUE); | |
7cdc2bab MD |
1873 | } |
1874 | g_free(lttng_live); | |
1875 | } | |
1876 | ||
1877 | BT_HIDDEN | |
14f28187 | 1878 | void lttng_live_component_finalize(bt_self_component_source *component) |
7cdc2bab | 1879 | { |
14f28187 | 1880 | void *data = bt_self_component_get_data( |
0f1979c3 | 1881 | bt_self_component_source_as_self_component(component)); |
7cdc2bab MD |
1882 | |
1883 | if (!data) { | |
1884 | return; | |
1885 | } | |
1886 | lttng_live_component_destroy_data(data); | |
1887 | } | |
1888 | ||
1889 | static | |
14f28187 FD |
1890 | enum session_not_found_action parse_session_not_found_action_param( |
1891 | const bt_value *no_session_param) | |
1892 | { | |
1893 | enum session_not_found_action action; | |
80aff5ef SM |
1894 | const char *no_session_act_str = bt_value_string_get(no_session_param); |
1895 | ||
14f28187 FD |
1896 | if (strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_CONTINUE_STR) == 0) { |
1897 | action = SESSION_NOT_FOUND_ACTION_CONTINUE; | |
1898 | } else if (strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_FAIL_STR) == 0) { | |
1899 | action = SESSION_NOT_FOUND_ACTION_FAIL; | |
14f28187 | 1900 | } else { |
80aff5ef SM |
1901 | BT_ASSERT(strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_END_STR) == 0); |
1902 | action = SESSION_NOT_FOUND_ACTION_END; | |
14f28187 FD |
1903 | } |
1904 | ||
1905 | return action; | |
1906 | } | |
1907 | ||
80aff5ef SM |
1908 | static struct bt_param_validation_value_descr inputs_elem_descr = { |
1909 | .type = BT_VALUE_TYPE_STRING, | |
1910 | }; | |
1911 | ||
1912 | static const char *sess_not_found_action_choices[] = { | |
1913 | SESS_NOT_FOUND_ACTION_CONTINUE_STR, | |
1914 | SESS_NOT_FOUND_ACTION_FAIL_STR, | |
1915 | SESS_NOT_FOUND_ACTION_END_STR, | |
1916 | }; | |
1917 | ||
1918 | static struct bt_param_validation_map_value_entry_descr params_descr[] = { | |
1919 | { INPUTS_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, { BT_VALUE_TYPE_ARRAY, .array = { | |
1920 | .min_length = 1, | |
1921 | .max_length = 1, | |
1922 | .element_type = &inputs_elem_descr, | |
1923 | } } }, | |
1924 | { SESS_NOT_FOUND_ACTION_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { BT_VALUE_TYPE_STRING, .string = { | |
1925 | .choices = sess_not_found_action_choices, | |
1926 | } } }, | |
1927 | BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END | |
1928 | }; | |
1929 | ||
70384700 | 1930 | static |
80aff5ef SM |
1931 | bt_component_class_initialize_method_status lttng_live_component_create( |
1932 | const bt_value *params, | |
1933 | bt_logging_level log_level, | |
1934 | bt_self_component *self_comp, | |
1935 | struct lttng_live_component **component) | |
7cdc2bab | 1936 | { |
80aff5ef | 1937 | struct lttng_live_component *lttng_live = NULL; |
312df793 PP |
1938 | const bt_value *inputs_value; |
1939 | const bt_value *url_value; | |
1940 | const bt_value *value; | |
7cdc2bab | 1941 | const char *url; |
80aff5ef SM |
1942 | enum bt_param_validation_status validation_status; |
1943 | gchar *validation_error = NULL; | |
1944 | bt_component_class_initialize_method_status status; | |
1945 | ||
1946 | validation_status = bt_param_validation_validate(params, params_descr, | |
1947 | &validation_error); | |
1948 | if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) { | |
1949 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; | |
1950 | goto error; | |
1951 | } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) { | |
1952 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "%s", validation_error); | |
1953 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
1954 | goto error; | |
1955 | } | |
7cdc2bab MD |
1956 | |
1957 | lttng_live = g_new0(struct lttng_live_component, 1); | |
1958 | if (!lttng_live) { | |
80aff5ef | 1959 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
7cdc2bab MD |
1960 | goto end; |
1961 | } | |
c01594de | 1962 | lttng_live->log_level = log_level; |
2ece7dd0 | 1963 | lttng_live->self_comp = self_comp; |
7cdc2bab | 1964 | lttng_live->max_query_size = MAX_QUERY_SIZE; |
14f28187 FD |
1965 | lttng_live->has_msg_iter = false; |
1966 | ||
80aff5ef SM |
1967 | inputs_value = |
1968 | bt_value_map_borrow_entry_value_const(params, INPUTS_PARAM); | |
1969 | url_value = | |
1970 | bt_value_array_borrow_element_by_index_const(inputs_value, 0); | |
312df793 | 1971 | url = bt_value_string_get(url_value); |
80aff5ef | 1972 | |
14f28187 FD |
1973 | lttng_live->params.url = g_string_new(url); |
1974 | if (!lttng_live->params.url) { | |
80aff5ef | 1975 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
7cdc2bab MD |
1976 | goto error; |
1977 | } | |
14f28187 FD |
1978 | |
1979 | value = bt_value_map_borrow_entry_value_const(params, | |
1980 | SESS_NOT_FOUND_ACTION_PARAM); | |
312df793 | 1981 | if (value) { |
14f28187 FD |
1982 | lttng_live->params.sess_not_found_act = |
1983 | parse_session_not_found_action_param(value); | |
14f28187 | 1984 | } else { |
312df793 PP |
1985 | BT_COMP_LOGI("Optional `%s` parameter is missing: " |
1986 | "defaulting to `%s`.", | |
14f28187 FD |
1987 | SESS_NOT_FOUND_ACTION_PARAM, |
1988 | SESS_NOT_FOUND_ACTION_CONTINUE_STR); | |
1989 | lttng_live->params.sess_not_found_act = | |
1990 | SESSION_NOT_FOUND_ACTION_CONTINUE; | |
7cdc2bab | 1991 | } |
4c66436f | 1992 | |
80aff5ef | 1993 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; |
7cdc2bab MD |
1994 | goto end; |
1995 | ||
1996 | error: | |
1997 | lttng_live_component_destroy_data(lttng_live); | |
1998 | lttng_live = NULL; | |
1999 | end: | |
80aff5ef SM |
2000 | g_free(validation_error); |
2001 | ||
2002 | *component = lttng_live; | |
2003 | return status; | |
d3e4dcd8 PP |
2004 | } |
2005 | ||
f3bc2010 | 2006 | BT_HIDDEN |
21a9f056 | 2007 | bt_component_class_initialize_method_status lttng_live_component_init( |
c01594de | 2008 | bt_self_component_source *self_comp_src, |
59225a3e SM |
2009 | bt_self_component_source_configuration *config, |
2010 | const bt_value *params, | |
2011 | __attribute__((unused)) void *init_method_data) | |
f3bc2010 | 2012 | { |
7cdc2bab | 2013 | struct lttng_live_component *lttng_live; |
80aff5ef | 2014 | bt_component_class_initialize_method_status ret; |
c01594de PP |
2015 | bt_self_component *self_comp = |
2016 | bt_self_component_source_as_self_component(self_comp_src); | |
2017 | bt_logging_level log_level = bt_component_get_logging_level( | |
2018 | bt_self_component_as_component(self_comp)); | |
d24d5663 | 2019 | bt_self_component_add_port_status add_port_status; |
7cdc2bab | 2020 | |
80aff5ef SM |
2021 | ret = lttng_live_component_create(params, log_level, self_comp, <tng_live); |
2022 | if (ret != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) { | |
19bdff20 | 2023 | goto error; |
7cdc2bab MD |
2024 | } |
2025 | ||
d24d5663 PP |
2026 | add_port_status = bt_self_component_source_add_output_port( |
2027 | self_comp_src, "out", NULL, NULL); | |
80aff5ef SM |
2028 | if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) { |
2029 | ret = (int) add_port_status; | |
2030 | goto end; | |
147337a3 | 2031 | } |
7cdc2bab | 2032 | |
c01594de | 2033 | bt_self_component_set_data(self_comp, lttng_live); |
19bdff20 | 2034 | goto end; |
7cdc2bab | 2035 | |
19bdff20 FD |
2036 | error: |
2037 | lttng_live_component_destroy_data(lttng_live); | |
2038 | lttng_live = NULL; | |
7cdc2bab MD |
2039 | end: |
2040 | return ret; | |
d85ef162 | 2041 | } |