Commit | Line | Data |
---|---|---|
7cdc2bab | 1 | /* |
14f28187 | 2 | * Copyright 2019 - Francis Deslauriers <francis.deslauriers@efficios.com> |
7cdc2bab MD |
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 | ||
2ece7dd0 | 27 | #define BT_COMP_LOG_SELF_COMP self_comp |
c01594de | 28 | #define BT_LOG_OUTPUT_LEVEL log_level |
350ad6c1 | 29 | #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/META" |
d9c39b0a | 30 | #include "logging/comp-logging.h" |
020bc26f | 31 | |
7cdc2bab MD |
32 | #include <stdio.h> |
33 | #include <stdint.h> | |
34 | #include <stdlib.h> | |
35 | #include <stdbool.h> | |
36 | #include <glib.h> | |
578e048b | 37 | #include "compat/memstream.h" |
3fadfbc0 | 38 | #include <babeltrace2/babeltrace.h> |
7cdc2bab | 39 | |
7cdc2bab MD |
40 | #include "metadata.h" |
41 | #include "../common/metadata/decoder.h" | |
335a2da5 | 42 | #include "../common/metadata/ctf-meta-configure-ir-trace.h" |
7cdc2bab MD |
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 | ||
14f28187 | 59 | |
7cdc2bab | 60 | static |
c01594de | 61 | bool stream_classes_all_have_default_clock_class(bt_trace_class *tc, |
2ece7dd0 PP |
62 | bt_logging_level log_level, |
63 | bt_self_component *self_comp) | |
7cdc2bab | 64 | { |
14f28187 FD |
65 | uint64_t i, sc_count; |
66 | const bt_clock_class *cc = NULL; | |
67 | const bt_stream_class *sc; | |
68 | bool ret = true; | |
7cdc2bab | 69 | |
14f28187 FD |
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); | |
7cdc2bab | 73 | |
14f28187 | 74 | BT_ASSERT(sc); |
7cdc2bab | 75 | |
14f28187 FD |
76 | cc = bt_stream_class_borrow_default_clock_class_const(sc); |
77 | if (!cc) { | |
78 | ret = false; | |
1419db2b FD |
79 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
80 | "Stream class doesn't have a default clock class: " | |
14f28187 FD |
81 | "sc-id=%" PRIu64 ", sc-name=\"%s\"", |
82 | bt_stream_class_get_id(sc), | |
83 | bt_stream_class_get_name(sc)); | |
84 | goto end; | |
7cdc2bab MD |
85 | } |
86 | } | |
87 | ||
7cdc2bab | 88 | end: |
14f28187 FD |
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); | |
98b15851 | 106 | BT_ASSERT_DBG(sc); |
14f28187 FD |
107 | |
108 | cc = bt_stream_class_borrow_default_clock_class_const(sc); | |
109 | if (cc) { | |
110 | goto end; | |
111 | } | |
112 | } | |
113 | end: | |
98b15851 | 114 | BT_ASSERT_DBG(cc); |
14f28187 | 115 | return cc; |
7cdc2bab MD |
116 | } |
117 | ||
118 | BT_HIDDEN | |
14f28187 | 119 | enum lttng_live_iterator_status lttng_live_metadata_update( |
7cdc2bab MD |
120 | struct lttng_live_trace *trace) |
121 | { | |
122 | struct lttng_live_session *session = trace->session; | |
7cdc2bab | 123 | struct lttng_live_metadata *metadata = trace->metadata; |
7cdc2bab MD |
124 | size_t size, len_read = 0; |
125 | char *metadata_buf = NULL; | |
c28512ab | 126 | bool keep_receiving; |
7cdc2bab MD |
127 | FILE *fp = NULL; |
128 | enum ctf_metadata_decoder_status decoder_status; | |
14f28187 FD |
129 | enum lttng_live_iterator_status status = |
130 | LTTNG_LIVE_ITERATOR_STATUS_OK; | |
c01594de | 131 | bt_logging_level log_level = trace->log_level; |
2ece7dd0 | 132 | bt_self_component *self_comp = trace->self_comp; |
c28512ab | 133 | enum lttng_live_get_one_metadata_status metadata_status; |
7cdc2bab | 134 | |
ecb4ba8a FD |
135 | BT_COMP_LOGD("Updating metadata for trace: trace-id=%"PRIu64, trace->id); |
136 | ||
7cdc2bab MD |
137 | /* No metadata stream yet. */ |
138 | if (!metadata) { | |
139 | if (session->new_streams_needed) { | |
14f28187 | 140 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
7cdc2bab MD |
141 | } else { |
142 | session->new_streams_needed = true; | |
14f28187 | 143 | status = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE; |
7cdc2bab MD |
144 | } |
145 | goto end; | |
146 | } | |
147 | ||
6f79a7cf MD |
148 | if (!metadata->trace) { |
149 | trace->new_metadata_needed = false; | |
150 | } | |
151 | ||
7cdc2bab MD |
152 | if (!trace->new_metadata_needed) { |
153 | goto end; | |
154 | } | |
155 | ||
f79c2d7a FD |
156 | /* |
157 | * Open a new write only file handle to populate the `metadata_buf` | |
158 | * memory buffer so we can write in loop in it easily. | |
159 | */ | |
7cdc2bab MD |
160 | fp = bt_open_memstream(&metadata_buf, &size); |
161 | if (!fp) { | |
5b959469 FD |
162 | if (errno == EINTR && |
163 | lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) { | |
f79c2d7a | 164 | session->lttng_live_msg_iter->was_interrupted = true; |
5b959469 FD |
165 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
166 | } else { | |
167 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp, | |
168 | "Metadata open_memstream", "."); | |
169 | status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; | |
170 | } | |
171 | goto end; | |
7cdc2bab MD |
172 | } |
173 | ||
c28512ab | 174 | keep_receiving = true; |
7cdc2bab | 175 | /* Grab all available metadata. */ |
c28512ab FD |
176 | while (keep_receiving) { |
177 | size_t reply_len = 0; | |
7cdc2bab | 178 | /* |
c28512ab FD |
179 | * lttng_live_get_one_metadata_packet() asks the Relay Daemon |
180 | * for new metadata. If new metadata is received, the function | |
181 | * writes it to the provided file handle and updates the | |
182 | * reply_len output parameter. We call this function in loop | |
183 | * until it returns _END meaning that no new metadata is | |
184 | * available. | |
185 | * We may receive a _CLOSED status if the metadata stream we | |
186 | * are requesting is no longer available on the relay. | |
187 | * If we receive an _ERROR status, it means there was a | |
188 | * networking, allocating, or some other unrecoverable error. | |
7cdc2bab | 189 | */ |
c28512ab FD |
190 | metadata_status = lttng_live_get_one_metadata_packet(trace, fp, |
191 | &reply_len); | |
192 | ||
193 | switch (metadata_status) { | |
194 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK: | |
195 | len_read += reply_len; | |
196 | break; | |
197 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_END: | |
198 | keep_receiving = false; | |
199 | break; | |
200 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED: | |
ecb4ba8a FD |
201 | BT_COMP_LOGD("Metadata stream was closed by the Relay, the trace is no longer active: " |
202 | "trace-id=%"PRIu64", metadata-stream-id=%"PRIu64, | |
203 | trace->id, metadata->stream_id); | |
c28512ab FD |
204 | keep_receiving = false; |
205 | break; | |
206 | case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR: | |
ecb4ba8a FD |
207 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
208 | "Error getting one trace metadata packet: " | |
209 | "trace-id=%"PRIu64, trace->id); | |
c28512ab FD |
210 | goto error; |
211 | default: | |
498e7994 | 212 | bt_common_abort(); |
7cdc2bab | 213 | } |
c28512ab | 214 | } |
7cdc2bab MD |
215 | |
216 | /* | |
c28512ab FD |
217 | * A closed metadata stream means the trace is no longer active. Return |
218 | * _END so that the caller can remove the trace from its list. | |
7cdc2bab | 219 | */ |
c28512ab FD |
220 | if (metadata_status == LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED) { |
221 | status = LTTNG_LIVE_ITERATOR_STATUS_END; | |
222 | goto end; | |
7cdc2bab MD |
223 | } |
224 | ||
f79c2d7a | 225 | /* The memory buffer `metadata_buf` contains all the metadata. */ |
7cdc2bab | 226 | if (bt_close_memstream(&metadata_buf, &size, fp)) { |
ecb4ba8a | 227 | BT_COMP_LOGW_ERRNO("Metadata bt_close_memstream", "."); |
7cdc2bab | 228 | } |
e7c34fd7 | 229 | |
7cdc2bab MD |
230 | fp = NULL; |
231 | ||
232 | if (len_read == 0) { | |
233 | if (!trace->trace) { | |
14f28187 | 234 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
7cdc2bab MD |
235 | goto end; |
236 | } | |
237 | trace->new_metadata_needed = false; | |
238 | goto end; | |
239 | } | |
240 | ||
f79c2d7a FD |
241 | /* |
242 | * Open a new reading file handle on the `metadata_buf` and pass it to | |
243 | * the metadata decoder. | |
244 | */ | |
7cdc2bab MD |
245 | fp = bt_fmemopen(metadata_buf, len_read, "rb"); |
246 | if (!fp) { | |
5b959469 FD |
247 | if (errno == EINTR && |
248 | lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) { | |
f79c2d7a | 249 | session->lttng_live_msg_iter->was_interrupted = true; |
5b959469 FD |
250 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
251 | } else { | |
252 | BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp, | |
253 | "Cannot memory-open metadata buffer", "."); | |
254 | status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; | |
255 | } | |
256 | goto end; | |
7cdc2bab MD |
257 | } |
258 | ||
14f28187 | 259 | /* |
06be9946 PP |
260 | * The call to ctf_metadata_decoder_append_content() will append |
261 | * new metadata to our current trace class. | |
14f28187 | 262 | */ |
ecb4ba8a | 263 | BT_COMP_LOGD("Appending new metadata to the ctf_trace class"); |
06be9946 PP |
264 | decoder_status = ctf_metadata_decoder_append_content( |
265 | metadata->decoder, fp); | |
7cdc2bab MD |
266 | switch (decoder_status) { |
267 | case CTF_METADATA_DECODER_STATUS_OK: | |
14f28187 | 268 | if (!trace->trace_class) { |
335a2da5 PP |
269 | struct ctf_trace_class *tc = |
270 | ctf_metadata_decoder_borrow_ctf_trace_class( | |
271 | metadata->decoder); | |
272 | ||
14f28187 FD |
273 | trace->trace_class = |
274 | ctf_metadata_decoder_get_ir_trace_class( | |
275 | metadata->decoder); | |
276 | trace->trace = bt_trace_create(trace->trace_class); | |
335a2da5 | 277 | if (!trace->trace) { |
1419db2b FD |
278 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
279 | "Failed to create bt_trace"); | |
335a2da5 PP |
280 | goto error; |
281 | } | |
282 | if (ctf_trace_class_configure_ir_trace(tc, | |
283 | trace->trace)) { | |
1419db2b FD |
284 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
285 | "Failed to configure ctf trace class"); | |
335a2da5 PP |
286 | goto error; |
287 | } | |
14f28187 | 288 | if (!stream_classes_all_have_default_clock_class( |
2ece7dd0 PP |
289 | trace->trace_class, log_level, |
290 | self_comp)) { | |
14f28187 FD |
291 | /* Error logged in function. */ |
292 | goto error; | |
293 | } | |
294 | trace->clock_class = | |
295 | borrow_any_clock_class(trace->trace_class); | |
7cdc2bab | 296 | } |
14f28187 FD |
297 | trace->new_metadata_needed = false; |
298 | ||
7cdc2bab MD |
299 | break; |
300 | case CTF_METADATA_DECODER_STATUS_INCOMPLETE: | |
14f28187 | 301 | status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN; |
7cdc2bab | 302 | break; |
1a6da3f9 | 303 | default: |
7cdc2bab MD |
304 | goto error; |
305 | } | |
306 | ||
307 | goto end; | |
c28512ab | 308 | |
7cdc2bab | 309 | error: |
5b959469 | 310 | status = LTTNG_LIVE_ITERATOR_STATUS_ERROR; |
7cdc2bab MD |
311 | end: |
312 | if (fp) { | |
313 | int closeret; | |
314 | ||
315 | closeret = fclose(fp); | |
316 | if (closeret) { | |
ecb4ba8a | 317 | BT_COMP_LOGW_ERRNO("Error on fclose", "."); |
7cdc2bab MD |
318 | } |
319 | } | |
6f79a7cf | 320 | free(metadata_buf); |
7cdc2bab MD |
321 | return status; |
322 | } | |
323 | ||
324 | BT_HIDDEN | |
325 | int lttng_live_metadata_create_stream(struct lttng_live_session *session, | |
2ece7dd0 | 326 | uint64_t ctf_trace_id, uint64_t stream_id, |
06994c71 | 327 | const char *trace_name) |
7cdc2bab | 328 | { |
1419db2b FD |
329 | bt_self_component *self_comp = session->self_comp; |
330 | bt_logging_level log_level = session->log_level; | |
7cdc2bab MD |
331 | struct lttng_live_metadata *metadata = NULL; |
332 | struct lttng_live_trace *trace; | |
0746848c | 333 | struct ctf_metadata_decoder_config cfg = { |
c01594de | 334 | .log_level = session->log_level, |
2ece7dd0 | 335 | .self_comp = session->self_comp, |
0746848c PP |
336 | .clock_class_offset_s = 0, |
337 | .clock_class_offset_ns = 0, | |
06be9946 | 338 | .create_trace_class = true, |
0746848c | 339 | }; |
7cdc2bab MD |
340 | |
341 | metadata = g_new0(struct lttng_live_metadata, 1); | |
342 | if (!metadata) { | |
343 | return -1; | |
344 | } | |
c01594de | 345 | metadata->log_level = session->log_level; |
2ece7dd0 | 346 | metadata->self_comp = session->self_comp; |
7cdc2bab | 347 | metadata->stream_id = stream_id; |
14f28187 | 348 | |
f7b785ac | 349 | metadata->decoder = ctf_metadata_decoder_create(&cfg); |
7cdc2bab | 350 | if (!metadata->decoder) { |
1419db2b FD |
351 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
352 | "Failed to create CTF metadata decoder"); | |
7cdc2bab MD |
353 | goto error; |
354 | } | |
14f28187 | 355 | trace = lttng_live_borrow_trace(session, ctf_trace_id); |
7cdc2bab | 356 | if (!trace) { |
1419db2b FD |
357 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
358 | "Failed to borrow trace"); | |
7cdc2bab MD |
359 | goto error; |
360 | } | |
361 | metadata->trace = trace; | |
362 | trace->metadata = metadata; | |
363 | return 0; | |
364 | ||
365 | error: | |
366 | ctf_metadata_decoder_destroy(metadata->decoder); | |
367 | g_free(metadata); | |
368 | return -1; | |
369 | } | |
370 | ||
371 | BT_HIDDEN | |
372 | void lttng_live_metadata_fini(struct lttng_live_trace *trace) | |
373 | { | |
374 | struct lttng_live_metadata *metadata = trace->metadata; | |
375 | ||
376 | if (!metadata) { | |
377 | return; | |
378 | } | |
7cdc2bab MD |
379 | ctf_metadata_decoder_destroy(metadata->decoder); |
380 | trace->metadata = NULL; | |
7cdc2bab MD |
381 | g_free(metadata); |
382 | } |