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