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