| 1 | /* |
| 2 | * Copyright 2019 - Francis Deslauriers <francis.deslauriers@efficios.com> |
| 3 | * Copyright 2016 - Philippe Proulx <pproulx@efficios.com> |
| 4 | * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation |
| 5 | * |
| 6 | * Some functions are based on older functions written by Mathieu Desnoyers. |
| 7 | * |
| 8 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 9 | * of this software and associated documentation files (the "Software"), to deal |
| 10 | * in the Software without restriction, including without limitation the rights |
| 11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 12 | * copies of the Software, and to permit persons to whom the Software is |
| 13 | * furnished to do so, subject to the following conditions: |
| 14 | * |
| 15 | * The above copyright notice and this permission notice shall be included in |
| 16 | * all copies or substantial portions of the Software. |
| 17 | * |
| 18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 24 | * SOFTWARE. |
| 25 | */ |
| 26 | |
| 27 | #define BT_COMP_LOG_SELF_COMP self_comp |
| 28 | #define BT_LOG_OUTPUT_LEVEL log_level |
| 29 | #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/META" |
| 30 | #include "logging/comp-logging.h" |
| 31 | |
| 32 | #include <stdio.h> |
| 33 | #include <stdint.h> |
| 34 | #include <stdlib.h> |
| 35 | #include <stdbool.h> |
| 36 | #include <glib.h> |
| 37 | #include "compat/memstream.h" |
| 38 | #include <babeltrace2/babeltrace.h> |
| 39 | |
| 40 | #include "metadata.h" |
| 41 | #include "../common/metadata/decoder.h" |
| 42 | #include "../common/metadata/ctf-meta-configure-ir-trace.h" |
| 43 | |
| 44 | #define TSDL_MAGIC 0x75d11d57 |
| 45 | |
| 46 | struct packet_header { |
| 47 | uint32_t magic; |
| 48 | uint8_t uuid[16]; |
| 49 | uint32_t checksum; |
| 50 | uint32_t content_size; |
| 51 | uint32_t packet_size; |
| 52 | uint8_t compression_scheme; |
| 53 | uint8_t encryption_scheme; |
| 54 | uint8_t checksum_scheme; |
| 55 | uint8_t major; |
| 56 | uint8_t minor; |
| 57 | } __attribute__((__packed__)); |
| 58 | |
| 59 | |
| 60 | static |
| 61 | bool stream_classes_all_have_default_clock_class(bt_trace_class *tc, |
| 62 | bt_logging_level log_level, |
| 63 | bt_self_component *self_comp) |
| 64 | { |
| 65 | uint64_t i, sc_count; |
| 66 | const bt_clock_class *cc = NULL; |
| 67 | const bt_stream_class *sc; |
| 68 | bool ret = true; |
| 69 | |
| 70 | sc_count = bt_trace_class_get_stream_class_count(tc); |
| 71 | for (i = 0; i < sc_count; i++) { |
| 72 | sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i); |
| 73 | |
| 74 | BT_ASSERT(sc); |
| 75 | |
| 76 | cc = bt_stream_class_borrow_default_clock_class_const(sc); |
| 77 | if (!cc) { |
| 78 | ret = false; |
| 79 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 80 | "Stream class doesn't have a default clock class: " |
| 81 | "sc-id=%" PRIu64 ", sc-name=\"%s\"", |
| 82 | bt_stream_class_get_id(sc), |
| 83 | bt_stream_class_get_name(sc)); |
| 84 | goto end; |
| 85 | } |
| 86 | } |
| 87 | |
| 88 | end: |
| 89 | return ret; |
| 90 | } |
| 91 | /* |
| 92 | * Iterate over the stream classes and returns the first clock class |
| 93 | * encountered. This is useful to create message iterator inactivity message as |
| 94 | * we don't need a particular clock class. |
| 95 | */ |
| 96 | static |
| 97 | const bt_clock_class *borrow_any_clock_class(bt_trace_class *tc) |
| 98 | { |
| 99 | uint64_t i, sc_count; |
| 100 | const bt_clock_class *cc = NULL; |
| 101 | const bt_stream_class *sc; |
| 102 | |
| 103 | sc_count = bt_trace_class_get_stream_class_count(tc); |
| 104 | for (i = 0; i < sc_count; i++) { |
| 105 | sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i); |
| 106 | BT_ASSERT_DBG(sc); |
| 107 | |
| 108 | cc = bt_stream_class_borrow_default_clock_class_const(sc); |
| 109 | if (cc) { |
| 110 | goto end; |
| 111 | } |
| 112 | } |
| 113 | end: |
| 114 | BT_ASSERT_DBG(cc); |
| 115 | return cc; |
| 116 | } |
| 117 | |
| 118 | BT_HIDDEN |
| 119 | enum lttng_live_iterator_status lttng_live_metadata_update( |
| 120 | struct lttng_live_trace *trace) |
| 121 | { |
| 122 | struct lttng_live_session *session = trace->session; |
| 123 | struct lttng_live_metadata *metadata = trace->metadata; |
| 124 | size_t size, len_read = 0; |
| 125 | char *metadata_buf = NULL; |
| 126 | bool keep_receiving; |
| 127 | FILE *fp = NULL; |
| 128 | enum ctf_metadata_decoder_status decoder_status; |
| 129 | enum lttng_live_iterator_status status = |
| 130 | LTTNG_LIVE_ITERATOR_STATUS_OK; |
| 131 | bt_logging_level log_level = trace->log_level; |
| 132 | bt_self_component *self_comp = trace->self_comp; |
| 133 | enum lttng_live_get_one_metadata_status metadata_status; |
| 134 | |
| 135 | /* No metadata stream yet. */ |
| 136 | if (!metadata) { |
| 137 | if (session->new_streams_needed) { |
| 138 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
| 139 | } else { |
| 140 | session->new_streams_needed = true; |
| 141 | status = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
| 142 | } |
| 143 | goto end; |
| 144 | } |
| 145 | |
| 146 | if (!metadata->trace) { |
| 147 | trace->new_metadata_needed = false; |
| 148 | } |
| 149 | |
| 150 | if (!trace->new_metadata_needed) { |
| 151 | goto end; |
| 152 | } |
| 153 | |
| 154 | /* Open for writing */ |
| 155 | fp = bt_open_memstream(&metadata_buf, &size); |
| 156 | if (!fp) { |
| 157 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp, |
| 158 | "Metadata open_memstream", "."); |
| 159 | goto error; |
| 160 | } |
| 161 | |
| 162 | keep_receiving = true; |
| 163 | /* Grab all available metadata. */ |
| 164 | while (keep_receiving) { |
| 165 | size_t reply_len = 0; |
| 166 | /* |
| 167 | * lttng_live_get_one_metadata_packet() asks the Relay Daemon |
| 168 | * for new metadata. If new metadata is received, the function |
| 169 | * writes it to the provided file handle and updates the |
| 170 | * reply_len output parameter. We call this function in loop |
| 171 | * until it returns _END meaning that no new metadata is |
| 172 | * available. |
| 173 | * We may receive a _CLOSED status if the metadata stream we |
| 174 | * are requesting is no longer available on the relay. |
| 175 | * If we receive an _ERROR status, it means there was a |
| 176 | * networking, allocating, or some other unrecoverable error. |
| 177 | */ |
| 178 | metadata_status = lttng_live_get_one_metadata_packet(trace, fp, |
| 179 | &reply_len); |
| 180 | |
| 181 | switch (metadata_status) { |
| 182 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK: |
| 183 | len_read += reply_len; |
| 184 | break; |
| 185 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_END: |
| 186 | keep_receiving = false; |
| 187 | break; |
| 188 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED: |
| 189 | keep_receiving = false; |
| 190 | break; |
| 191 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR: |
| 192 | goto error; |
| 193 | default: |
| 194 | bt_common_abort(); |
| 195 | } |
| 196 | } |
| 197 | |
| 198 | /* |
| 199 | * A closed metadata stream means the trace is no longer active. Return |
| 200 | * _END so that the caller can remove the trace from its list. |
| 201 | */ |
| 202 | if (metadata_status == LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED) { |
| 203 | status = LTTNG_LIVE_ITERATOR_STATUS_END; |
| 204 | goto end; |
| 205 | } |
| 206 | |
| 207 | if (bt_close_memstream(&metadata_buf, &size, fp)) { |
| 208 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp, |
| 209 | "Metadata bt_close_memstream", "."); |
| 210 | } |
| 211 | |
| 212 | fp = NULL; |
| 213 | |
| 214 | if (len_read == 0) { |
| 215 | if (!trace->trace) { |
| 216 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
| 217 | goto end; |
| 218 | } |
| 219 | trace->new_metadata_needed = false; |
| 220 | goto end; |
| 221 | } |
| 222 | |
| 223 | fp = bt_fmemopen(metadata_buf, len_read, "rb"); |
| 224 | if (!fp) { |
| 225 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp, |
| 226 | "Cannot memory-open metadata buffer", "."); |
| 227 | goto error; |
| 228 | } |
| 229 | |
| 230 | /* |
| 231 | * The call to ctf_metadata_decoder_append_content() will append |
| 232 | * new metadata to our current trace class. |
| 233 | */ |
| 234 | decoder_status = ctf_metadata_decoder_append_content( |
| 235 | metadata->decoder, fp); |
| 236 | switch (decoder_status) { |
| 237 | case CTF_METADATA_DECODER_STATUS_OK: |
| 238 | if (!trace->trace_class) { |
| 239 | struct ctf_trace_class *tc = |
| 240 | ctf_metadata_decoder_borrow_ctf_trace_class( |
| 241 | metadata->decoder); |
| 242 | |
| 243 | trace->trace_class = |
| 244 | ctf_metadata_decoder_get_ir_trace_class( |
| 245 | metadata->decoder); |
| 246 | trace->trace = bt_trace_create(trace->trace_class); |
| 247 | if (!trace->trace) { |
| 248 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 249 | "Failed to create bt_trace"); |
| 250 | goto error; |
| 251 | } |
| 252 | if (ctf_trace_class_configure_ir_trace(tc, |
| 253 | trace->trace)) { |
| 254 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 255 | "Failed to configure ctf trace class"); |
| 256 | goto error; |
| 257 | } |
| 258 | if (!stream_classes_all_have_default_clock_class( |
| 259 | trace->trace_class, log_level, |
| 260 | self_comp)) { |
| 261 | /* Error logged in function. */ |
| 262 | goto error; |
| 263 | } |
| 264 | trace->clock_class = |
| 265 | borrow_any_clock_class(trace->trace_class); |
| 266 | } |
| 267 | trace->new_metadata_needed = false; |
| 268 | |
| 269 | break; |
| 270 | case CTF_METADATA_DECODER_STATUS_INCOMPLETE: |
| 271 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
| 272 | break; |
| 273 | default: |
| 274 | goto error; |
| 275 | } |
| 276 | |
| 277 | goto end; |
| 278 | |
| 279 | error: |
| 280 | if (errno == EINTR) { |
| 281 | if (lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) { |
| 282 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
| 283 | } |
| 284 | } else { |
| 285 | status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; |
| 286 | } |
| 287 | end: |
| 288 | if (fp) { |
| 289 | int closeret; |
| 290 | |
| 291 | closeret = fclose(fp); |
| 292 | if (closeret) { |
| 293 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp, |
| 294 | "Error on fclose", "."); |
| 295 | } |
| 296 | } |
| 297 | free(metadata_buf); |
| 298 | return status; |
| 299 | } |
| 300 | |
| 301 | BT_HIDDEN |
| 302 | int lttng_live_metadata_create_stream(struct lttng_live_session *session, |
| 303 | uint64_t ctf_trace_id, uint64_t stream_id, |
| 304 | const char *trace_name) |
| 305 | { |
| 306 | bt_self_component *self_comp = session->self_comp; |
| 307 | bt_logging_level log_level = session->log_level; |
| 308 | struct lttng_live_metadata *metadata = NULL; |
| 309 | struct lttng_live_trace *trace; |
| 310 | struct ctf_metadata_decoder_config cfg = { |
| 311 | .log_level = session->log_level, |
| 312 | .self_comp = session->self_comp, |
| 313 | .clock_class_offset_s = 0, |
| 314 | .clock_class_offset_ns = 0, |
| 315 | .create_trace_class = true, |
| 316 | }; |
| 317 | |
| 318 | metadata = g_new0(struct lttng_live_metadata, 1); |
| 319 | if (!metadata) { |
| 320 | return -1; |
| 321 | } |
| 322 | metadata->log_level = session->log_level; |
| 323 | metadata->self_comp = session->self_comp; |
| 324 | metadata->stream_id = stream_id; |
| 325 | |
| 326 | metadata->decoder = ctf_metadata_decoder_create(&cfg); |
| 327 | if (!metadata->decoder) { |
| 328 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 329 | "Failed to create CTF metadata decoder"); |
| 330 | goto error; |
| 331 | } |
| 332 | trace = lttng_live_borrow_trace(session, ctf_trace_id); |
| 333 | if (!trace) { |
| 334 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
| 335 | "Failed to borrow trace"); |
| 336 | goto error; |
| 337 | } |
| 338 | metadata->trace = trace; |
| 339 | trace->metadata = metadata; |
| 340 | return 0; |
| 341 | |
| 342 | error: |
| 343 | ctf_metadata_decoder_destroy(metadata->decoder); |
| 344 | g_free(metadata); |
| 345 | return -1; |
| 346 | } |
| 347 | |
| 348 | BT_HIDDEN |
| 349 | void lttng_live_metadata_fini(struct lttng_live_trace *trace) |
| 350 | { |
| 351 | struct lttng_live_metadata *metadata = trace->metadata; |
| 352 | |
| 353 | if (!metadata) { |
| 354 | return; |
| 355 | } |
| 356 | ctf_metadata_decoder_destroy(metadata->decoder); |
| 357 | trace->metadata = NULL; |
| 358 | g_free(metadata); |
| 359 | } |