Commit | Line | Data |
---|---|---|
7cdc2bab | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
7cdc2bab | 3 | * |
0235b0db MJ |
4 | * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com> |
5 | * Copyright 2016 Philippe Proulx <pproulx@efficios.com> | |
6 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation | |
7cdc2bab MD |
7 | */ |
8 | ||
2ece7dd0 | 9 | #define BT_COMP_LOG_SELF_COMP self_comp |
c01594de | 10 | #define BT_LOG_OUTPUT_LEVEL log_level |
350ad6c1 | 11 | #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/META" |
d9c39b0a | 12 | #include "logging/comp-logging.h" |
020bc26f | 13 | |
7cdc2bab MD |
14 | #include <stdio.h> |
15 | #include <stdint.h> | |
16 | #include <stdlib.h> | |
17 | #include <stdbool.h> | |
18 | #include <glib.h> | |
578e048b | 19 | #include "compat/memstream.h" |
3fadfbc0 | 20 | #include <babeltrace2/babeltrace.h> |
7cdc2bab | 21 | |
7cdc2bab MD |
22 | #include "metadata.h" |
23 | #include "../common/metadata/decoder.h" | |
335a2da5 | 24 | #include "../common/metadata/ctf-meta-configure-ir-trace.h" |
7cdc2bab MD |
25 | |
26 | #define TSDL_MAGIC 0x75d11d57 | |
27 | ||
28 | struct packet_header { | |
29 | uint32_t magic; | |
30 | uint8_t uuid[16]; | |
31 | uint32_t checksum; | |
32 | uint32_t content_size; | |
33 | uint32_t packet_size; | |
34 | uint8_t compression_scheme; | |
35 | uint8_t encryption_scheme; | |
36 | uint8_t checksum_scheme; | |
37 | uint8_t major; | |
38 | uint8_t minor; | |
39 | } __attribute__((__packed__)); | |
40 | ||
14f28187 | 41 | |
7cdc2bab | 42 | static |
c01594de | 43 | bool stream_classes_all_have_default_clock_class(bt_trace_class *tc, |
2ece7dd0 PP |
44 | bt_logging_level log_level, |
45 | bt_self_component *self_comp) | |
7cdc2bab | 46 | { |
14f28187 FD |
47 | uint64_t i, sc_count; |
48 | const bt_clock_class *cc = NULL; | |
49 | const bt_stream_class *sc; | |
50 | bool ret = true; | |
7cdc2bab | 51 | |
14f28187 FD |
52 | sc_count = bt_trace_class_get_stream_class_count(tc); |
53 | for (i = 0; i < sc_count; i++) { | |
54 | sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i); | |
7cdc2bab | 55 | |
14f28187 | 56 | BT_ASSERT(sc); |
7cdc2bab | 57 | |
14f28187 FD |
58 | cc = bt_stream_class_borrow_default_clock_class_const(sc); |
59 | if (!cc) { | |
60 | ret = false; | |
1419db2b FD |
61 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
62 | "Stream class doesn't have a default clock class: " | |
14f28187 FD |
63 | "sc-id=%" PRIu64 ", sc-name=\"%s\"", |
64 | bt_stream_class_get_id(sc), | |
65 | bt_stream_class_get_name(sc)); | |
66 | goto end; | |
7cdc2bab MD |
67 | } |
68 | } | |
69 | ||
7cdc2bab | 70 | end: |
14f28187 FD |
71 | return ret; |
72 | } | |
73 | /* | |
74 | * Iterate over the stream classes and returns the first clock class | |
75 | * encountered. This is useful to create message iterator inactivity message as | |
76 | * we don't need a particular clock class. | |
77 | */ | |
78 | static | |
79 | const bt_clock_class *borrow_any_clock_class(bt_trace_class *tc) | |
80 | { | |
81 | uint64_t i, sc_count; | |
82 | const bt_clock_class *cc = NULL; | |
83 | const bt_stream_class *sc; | |
84 | ||
85 | sc_count = bt_trace_class_get_stream_class_count(tc); | |
86 | for (i = 0; i < sc_count; i++) { | |
87 | sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i); | |
98b15851 | 88 | BT_ASSERT_DBG(sc); |
14f28187 FD |
89 | |
90 | cc = bt_stream_class_borrow_default_clock_class_const(sc); | |
91 | if (cc) { | |
92 | goto end; | |
93 | } | |
94 | } | |
95 | end: | |
98b15851 | 96 | BT_ASSERT_DBG(cc); |
14f28187 | 97 | return cc; |
7cdc2bab MD |
98 | } |
99 | ||
100 | BT_HIDDEN | |
14f28187 | 101 | enum lttng_live_iterator_status lttng_live_metadata_update( |
7cdc2bab MD |
102 | struct lttng_live_trace *trace) |
103 | { | |
104 | struct lttng_live_session *session = trace->session; | |
7cdc2bab | 105 | struct lttng_live_metadata *metadata = trace->metadata; |
7cdc2bab MD |
106 | size_t size, len_read = 0; |
107 | char *metadata_buf = NULL; | |
c28512ab | 108 | bool keep_receiving; |
7cdc2bab MD |
109 | FILE *fp = NULL; |
110 | enum ctf_metadata_decoder_status decoder_status; | |
14f28187 FD |
111 | enum lttng_live_iterator_status status = |
112 | LTTNG_LIVE_ITERATOR_STATUS_OK; | |
c01594de | 113 | bt_logging_level log_level = trace->log_level; |
2ece7dd0 | 114 | bt_self_component *self_comp = trace->self_comp; |
c28512ab | 115 | enum lttng_live_get_one_metadata_status metadata_status; |
7cdc2bab | 116 | |
ecb4ba8a FD |
117 | BT_COMP_LOGD("Updating metadata for trace: trace-id=%"PRIu64, trace->id); |
118 | ||
7cdc2bab MD |
119 | /* No metadata stream yet. */ |
120 | if (!metadata) { | |
121 | if (session->new_streams_needed) { | |
14f28187 | 122 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
7cdc2bab MD |
123 | } else { |
124 | session->new_streams_needed = true; | |
14f28187 | 125 | status = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
7cdc2bab MD |
126 | } |
127 | goto end; | |
128 | } | |
129 | ||
76bbaebc | 130 | if (trace->metadata_stream_state != LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED) { |
7cdc2bab MD |
131 | goto end; |
132 | } | |
133 | ||
f79c2d7a FD |
134 | /* |
135 | * Open a new write only file handle to populate the `metadata_buf` | |
136 | * memory buffer so we can write in loop in it easily. | |
137 | */ | |
7cdc2bab MD |
138 | fp = bt_open_memstream(&metadata_buf, &size); |
139 | if (!fp) { | |
5b959469 FD |
140 | if (errno == EINTR && |
141 | lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) { | |
f79c2d7a | 142 | session->lttng_live_msg_iter->was_interrupted = true; |
5b959469 FD |
143 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
144 | } else { | |
145 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp, | |
146 | "Metadata open_memstream", "."); | |
147 | status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; | |
148 | } | |
149 | goto end; | |
7cdc2bab MD |
150 | } |
151 | ||
c28512ab | 152 | keep_receiving = true; |
7cdc2bab | 153 | /* Grab all available metadata. */ |
c28512ab FD |
154 | while (keep_receiving) { |
155 | size_t reply_len = 0; | |
7cdc2bab | 156 | /* |
c28512ab FD |
157 | * lttng_live_get_one_metadata_packet() asks the Relay Daemon |
158 | * for new metadata. If new metadata is received, the function | |
159 | * writes it to the provided file handle and updates the | |
160 | * reply_len output parameter. We call this function in loop | |
161 | * until it returns _END meaning that no new metadata is | |
162 | * available. | |
163 | * We may receive a _CLOSED status if the metadata stream we | |
164 | * are requesting is no longer available on the relay. | |
165 | * If we receive an _ERROR status, it means there was a | |
166 | * networking, allocating, or some other unrecoverable error. | |
7cdc2bab | 167 | */ |
c28512ab FD |
168 | metadata_status = lttng_live_get_one_metadata_packet(trace, fp, |
169 | &reply_len); | |
170 | ||
171 | switch (metadata_status) { | |
172 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK: | |
173 | len_read += reply_len; | |
174 | break; | |
175 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_END: | |
176 | keep_receiving = false; | |
177 | break; | |
178 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED: | |
ecb4ba8a FD |
179 | BT_COMP_LOGD("Metadata stream was closed by the Relay, the trace is no longer active: " |
180 | "trace-id=%"PRIu64", metadata-stream-id=%"PRIu64, | |
181 | trace->id, metadata->stream_id); | |
76bbaebc FD |
182 | /* |
183 | * The stream was closed and we received everything | |
184 | * there was to receive for this metadata stream. | |
185 | * We go on with the decoding of what we received. So | |
186 | * that data stream can be decoded. | |
187 | */ | |
c28512ab | 188 | keep_receiving = false; |
76bbaebc | 189 | trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED; |
c28512ab FD |
190 | break; |
191 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR: | |
ecb4ba8a FD |
192 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
193 | "Error getting one trace metadata packet: " | |
194 | "trace-id=%"PRIu64, trace->id); | |
c28512ab FD |
195 | goto error; |
196 | default: | |
498e7994 | 197 | bt_common_abort(); |
7cdc2bab | 198 | } |
c28512ab | 199 | } |
7cdc2bab | 200 | |
f79c2d7a | 201 | /* The memory buffer `metadata_buf` contains all the metadata. */ |
7cdc2bab | 202 | if (bt_close_memstream(&metadata_buf, &size, fp)) { |
ecb4ba8a | 203 | BT_COMP_LOGW_ERRNO("Metadata bt_close_memstream", "."); |
7cdc2bab | 204 | } |
e7c34fd7 | 205 | |
7cdc2bab MD |
206 | fp = NULL; |
207 | ||
208 | if (len_read == 0) { | |
209 | if (!trace->trace) { | |
14f28187 | 210 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
7cdc2bab MD |
211 | goto end; |
212 | } | |
76bbaebc FD |
213 | |
214 | /* The relay sent zero bytes of metdata. */ | |
215 | trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED; | |
7cdc2bab MD |
216 | goto end; |
217 | } | |
218 | ||
f79c2d7a FD |
219 | /* |
220 | * Open a new reading file handle on the `metadata_buf` and pass it to | |
221 | * the metadata decoder. | |
222 | */ | |
7cdc2bab MD |
223 | fp = bt_fmemopen(metadata_buf, len_read, "rb"); |
224 | if (!fp) { | |
5b959469 FD |
225 | if (errno == EINTR && |
226 | lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) { | |
f79c2d7a | 227 | session->lttng_live_msg_iter->was_interrupted = true; |
5b959469 FD |
228 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
229 | } else { | |
230 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp, | |
231 | "Cannot memory-open metadata buffer", "."); | |
232 | status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; | |
233 | } | |
234 | goto end; | |
7cdc2bab MD |
235 | } |
236 | ||
14f28187 | 237 | /* |
06be9946 PP |
238 | * The call to ctf_metadata_decoder_append_content() will append |
239 | * new metadata to our current trace class. | |
14f28187 | 240 | */ |
ecb4ba8a | 241 | BT_COMP_LOGD("Appending new metadata to the ctf_trace class"); |
06be9946 PP |
242 | decoder_status = ctf_metadata_decoder_append_content( |
243 | metadata->decoder, fp); | |
7cdc2bab MD |
244 | switch (decoder_status) { |
245 | case CTF_METADATA_DECODER_STATUS_OK: | |
14f28187 | 246 | if (!trace->trace_class) { |
335a2da5 PP |
247 | struct ctf_trace_class *tc = |
248 | ctf_metadata_decoder_borrow_ctf_trace_class( | |
249 | metadata->decoder); | |
250 | ||
14f28187 FD |
251 | trace->trace_class = |
252 | ctf_metadata_decoder_get_ir_trace_class( | |
253 | metadata->decoder); | |
254 | trace->trace = bt_trace_create(trace->trace_class); | |
335a2da5 | 255 | if (!trace->trace) { |
1419db2b FD |
256 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
257 | "Failed to create bt_trace"); | |
335a2da5 PP |
258 | goto error; |
259 | } | |
260 | if (ctf_trace_class_configure_ir_trace(tc, | |
261 | trace->trace)) { | |
1419db2b FD |
262 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
263 | "Failed to configure ctf trace class"); | |
335a2da5 PP |
264 | goto error; |
265 | } | |
14f28187 | 266 | if (!stream_classes_all_have_default_clock_class( |
2ece7dd0 PP |
267 | trace->trace_class, log_level, |
268 | self_comp)) { | |
14f28187 FD |
269 | /* Error logged in function. */ |
270 | goto error; | |
271 | } | |
272 | trace->clock_class = | |
273 | borrow_any_clock_class(trace->trace_class); | |
7cdc2bab | 274 | } |
76bbaebc FD |
275 | |
276 | /* The metadata was updated succesfully. */ | |
277 | trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED; | |
14f28187 | 278 | |
7cdc2bab | 279 | break; |
1a6da3f9 | 280 | default: |
7cdc2bab MD |
281 | goto error; |
282 | } | |
283 | ||
284 | goto end; | |
c28512ab | 285 | |
7cdc2bab | 286 | error: |
5b959469 | 287 | status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; |
7cdc2bab MD |
288 | end: |
289 | if (fp) { | |
290 | int closeret; | |
291 | ||
292 | closeret = fclose(fp); | |
293 | if (closeret) { | |
ecb4ba8a | 294 | BT_COMP_LOGW_ERRNO("Error on fclose", "."); |
7cdc2bab MD |
295 | } |
296 | } | |
6f79a7cf | 297 | free(metadata_buf); |
7cdc2bab MD |
298 | return status; |
299 | } | |
300 | ||
301 | BT_HIDDEN | |
302 | int lttng_live_metadata_create_stream(struct lttng_live_session *session, | |
2ece7dd0 | 303 | uint64_t ctf_trace_id, uint64_t stream_id, |
06994c71 | 304 | const char *trace_name) |
7cdc2bab | 305 | { |
1419db2b FD |
306 | bt_self_component *self_comp = session->self_comp; |
307 | bt_logging_level log_level = session->log_level; | |
7cdc2bab MD |
308 | struct lttng_live_metadata *metadata = NULL; |
309 | struct lttng_live_trace *trace; | |
0746848c | 310 | struct ctf_metadata_decoder_config cfg = { |
c01594de | 311 | .log_level = session->log_level, |
2ece7dd0 | 312 | .self_comp = session->self_comp, |
0746848c PP |
313 | .clock_class_offset_s = 0, |
314 | .clock_class_offset_ns = 0, | |
06be9946 | 315 | .create_trace_class = true, |
0746848c | 316 | }; |
7cdc2bab MD |
317 | |
318 | metadata = g_new0(struct lttng_live_metadata, 1); | |
319 | if (!metadata) { | |
320 | return -1; | |
321 | } | |
c01594de | 322 | metadata->log_level = session->log_level; |
2ece7dd0 | 323 | metadata->self_comp = session->self_comp; |
7cdc2bab | 324 | metadata->stream_id = stream_id; |
14f28187 | 325 | |
f7b785ac | 326 | metadata->decoder = ctf_metadata_decoder_create(&cfg); |
7cdc2bab | 327 | if (!metadata->decoder) { |
1419db2b FD |
328 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
329 | "Failed to create CTF metadata decoder"); | |
7cdc2bab MD |
330 | goto error; |
331 | } | |
36e94ad6 FD |
332 | trace = lttng_live_session_borrow_or_create_trace_by_id(session, |
333 | ctf_trace_id); | |
7cdc2bab | 334 | if (!trace) { |
1419db2b FD |
335 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
336 | "Failed to borrow trace"); | |
7cdc2bab MD |
337 | goto error; |
338 | } | |
7cdc2bab MD |
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 | } | |
7cdc2bab MD |
356 | ctf_metadata_decoder_destroy(metadata->decoder); |
357 | trace->metadata = NULL; | |
7cdc2bab MD |
358 | g_free(metadata); |
359 | } |