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