2 * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
5 * Some functions are based on older functions written by Mathieu Desnoyers.
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 #include <babeltrace/compat/uuid-internal.h>
32 #include <babeltrace/compat/memstream-internal.h>
34 #define BT_LOG_TAG "PLUGIN-CTF-LTTNG-LIVE-METADATA"
37 #include "../common/metadata/decoder.h"
39 #define TSDL_MAGIC 0x75d11d57
41 struct packet_header
{
45 uint32_t content_size
;
47 uint8_t compression_scheme
;
48 uint8_t encryption_scheme
;
49 uint8_t checksum_scheme
;
52 } __attribute__((__packed__
));
55 enum bt_ctf_lttng_live_iterator_status
lttng_live_update_clock_map(
56 struct lttng_live_trace
*trace
)
58 enum bt_ctf_lttng_live_iterator_status status
=
59 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK
;
63 BT_PUT(trace
->cc_prio_map
);
64 trace
->cc_prio_map
= bt_clock_class_priority_map_create();
65 if (!trace
->cc_prio_map
) {
69 count
= bt_ctf_trace_get_clock_class_count(trace
->trace
);
72 for (i
= 0; i
< count
; i
++) {
73 struct bt_ctf_clock_class
*clock_class
=
74 bt_ctf_trace_get_clock_class_by_index(trace
->trace
, i
);
77 ret
= bt_clock_class_priority_map_add_clock_class(
78 trace
->cc_prio_map
, clock_class
, 0);
88 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
94 enum bt_ctf_lttng_live_iterator_status
lttng_live_metadata_update(
95 struct lttng_live_trace
*trace
)
97 struct lttng_live_session
*session
= trace
->session
;
98 struct lttng_live_metadata
*metadata
= trace
->metadata
;
100 size_t size
, len_read
= 0;
101 char *metadata_buf
= NULL
;
103 enum ctf_metadata_decoder_status decoder_status
;
104 enum bt_ctf_lttng_live_iterator_status status
=
105 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK
;
107 /* No metadata stream yet. */
109 if (session
->new_streams_needed
) {
110 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
112 session
->new_streams_needed
= true;
113 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
118 if (!trace
->new_metadata_needed
) {
122 /* Open for writing */
123 fp
= bt_open_memstream(&metadata_buf
, &size
);
125 BT_LOGE("Metadata open_memstream: %s", strerror(errno
));
129 /* Grab all available metadata. */
132 * get_one_metadata_packet returns the number of bytes
133 * received, 0 when we have received everything, a
134 * negative value on error.
136 ret
= lttng_live_get_one_metadata_packet(trace
, fp
);
143 * Consider metadata closed as soon as we get an error reading
144 * it (e.g. cannot be found).
147 if (!metadata
->closed
) {
148 metadata
->closed
= true;
150 * Release our reference on the trace as soon as
151 * we know the metadata stream is not available
152 * anymore. This won't necessarily teardown the
153 * metadata objects immediately, but only when
154 * the data streams are done.
156 lttng_live_unref_trace(metadata
->trace
);
160 if (bt_close_memstream(&metadata_buf
, &size
, fp
)) {
161 BT_LOGE("bt_close_memstream: %s", strerror(errno
));
168 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
171 trace
->new_metadata_needed
= false;
175 if (babeltrace_debug
) {
179 fp
= bt_fmemopen(metadata_buf
, len_read
, "rb");
181 BT_LOGE("Cannot memory-open metadata buffer: %s",
186 decoder_status
= ctf_metadata_decoder_decode(metadata
->decoder
, fp
);
187 switch (decoder_status
) {
188 case CTF_METADATA_DECODER_STATUS_OK
:
189 BT_PUT(trace
->trace
);
190 trace
->trace
= ctf_metadata_decoder_get_trace(metadata
->decoder
);
191 trace
->new_metadata_needed
= false;
192 status
= lttng_live_update_clock_map(trace
);
193 if (status
!= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK
) {
197 case CTF_METADATA_DECODER_STATUS_INCOMPLETE
:
198 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
200 case CTF_METADATA_DECODER_STATUS_ERROR
:
201 case CTF_METADATA_DECODER_STATUS_INVAL_VERSION
:
202 case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
:
208 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
213 closeret
= fclose(fp
);
215 BT_LOGE("Error on fclose");
222 int lttng_live_metadata_create_stream(struct lttng_live_session
*session
,
223 uint64_t ctf_trace_id
,
226 struct lttng_live_metadata
*metadata
= NULL
;
227 struct lttng_live_trace
*trace
;
229 metadata
= g_new0(struct lttng_live_metadata
, 1);
233 metadata
->stream_id
= stream_id
;
234 //TODO: add clock offset option
235 metadata
->decoder
= ctf_metadata_decoder_create(stderr
, 0);
236 if (!metadata
->decoder
) {
239 trace
= lttng_live_ref_trace(session
, ctf_trace_id
);
243 metadata
->trace
= trace
;
244 trace
->metadata
= metadata
;
248 ctf_metadata_decoder_destroy(metadata
->decoder
);
254 void lttng_live_metadata_fini(struct lttng_live_trace
*trace
)
256 struct lttng_live_metadata
*metadata
= trace
->metadata
;
261 if (metadata
->text
) {
262 free(metadata
->text
);
264 ctf_metadata_decoder_destroy(metadata
->decoder
);
265 trace
->metadata
= NULL
;
266 lttng_live_unref_trace(trace
);
267 if (!metadata
->closed
) {
268 lttng_live_unref_trace(metadata
->trace
);