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