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