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>
33 #include <babeltrace/graph/graph.h>
35 #define BT_LOG_TAG "PLUGIN-CTF-LTTNG-LIVE-METADATA"
38 #include "../common/metadata/decoder.h"
40 #define TSDL_MAGIC 0x75d11d57
42 struct packet_header
{
46 uint32_t content_size
;
48 uint8_t compression_scheme
;
49 uint8_t encryption_scheme
;
50 uint8_t checksum_scheme
;
53 } __attribute__((__packed__
));
56 enum bt_ctf_lttng_live_iterator_status
lttng_live_update_clock_map(
57 struct lttng_live_trace
*trace
)
59 enum bt_ctf_lttng_live_iterator_status status
=
60 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK
;
64 BT_PUT(trace
->cc_prio_map
);
65 trace
->cc_prio_map
= bt_clock_class_priority_map_create();
66 if (!trace
->cc_prio_map
) {
70 count
= bt_ctf_trace_get_clock_class_count(trace
->trace
);
73 for (i
= 0; i
< count
; i
++) {
74 struct bt_ctf_clock_class
*clock_class
=
75 bt_ctf_trace_get_clock_class_by_index(trace
->trace
, i
);
78 ret
= bt_clock_class_priority_map_add_clock_class(
79 trace
->cc_prio_map
, clock_class
, 0);
89 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
95 enum bt_ctf_lttng_live_iterator_status
lttng_live_metadata_update(
96 struct lttng_live_trace
*trace
)
98 struct lttng_live_session
*session
= trace
->session
;
99 struct lttng_live_metadata
*metadata
= trace
->metadata
;
101 size_t size
, len_read
= 0;
102 char *metadata_buf
= NULL
;
104 enum ctf_metadata_decoder_status decoder_status
;
105 enum bt_ctf_lttng_live_iterator_status status
=
106 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK
;
108 /* No metadata stream yet. */
110 if (session
->new_streams_needed
) {
111 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
113 session
->new_streams_needed
= true;
114 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
119 if (!trace
->new_metadata_needed
) {
123 /* Open for writing */
124 fp
= bt_open_memstream(&metadata_buf
, &size
);
126 BT_LOGE("Metadata open_memstream: %s", strerror(errno
));
130 /* Grab all available metadata. */
133 * get_one_metadata_packet returns the number of bytes
134 * received, 0 when we have received everything, a
135 * negative value on error.
137 ret
= lttng_live_get_one_metadata_packet(trace
, fp
);
144 * Consider metadata closed as soon as we get an error reading
145 * it (e.g. cannot be found).
148 if (!metadata
->closed
) {
149 metadata
->closed
= true;
151 * Release our reference on the trace as soon as
152 * we know the metadata stream is not available
153 * anymore. This won't necessarily teardown the
154 * metadata objects immediately, but only when
155 * the data streams are done.
157 lttng_live_unref_trace(metadata
->trace
);
159 if (errno
== EINTR
) {
160 if (bt_graph_is_canceled(session
->lttng_live
->graph
)) {
161 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
167 if (bt_close_memstream(&metadata_buf
, &size
, fp
)) {
168 BT_LOGE("bt_close_memstream: %s", strerror(errno
));
175 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
178 trace
->new_metadata_needed
= false;
182 if (babeltrace_debug
) {
186 fp
= bt_fmemopen(metadata_buf
, len_read
, "rb");
188 BT_LOGE("Cannot memory-open metadata buffer: %s",
193 decoder_status
= ctf_metadata_decoder_decode(metadata
->decoder
, fp
);
194 switch (decoder_status
) {
195 case CTF_METADATA_DECODER_STATUS_OK
:
196 BT_PUT(trace
->trace
);
197 trace
->trace
= ctf_metadata_decoder_get_trace(metadata
->decoder
);
198 trace
->new_metadata_needed
= false;
199 status
= lttng_live_update_clock_map(trace
);
200 if (status
!= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK
) {
204 case CTF_METADATA_DECODER_STATUS_INCOMPLETE
:
205 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
207 case CTF_METADATA_DECODER_STATUS_ERROR
:
208 case CTF_METADATA_DECODER_STATUS_INVAL_VERSION
:
209 case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
:
215 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
220 closeret
= fclose(fp
);
222 BT_LOGE("Error on fclose");
229 int lttng_live_metadata_create_stream(struct lttng_live_session
*session
,
230 uint64_t ctf_trace_id
,
233 struct lttng_live_metadata
*metadata
= NULL
;
234 struct lttng_live_trace
*trace
;
236 metadata
= g_new0(struct lttng_live_metadata
, 1);
240 metadata
->stream_id
= stream_id
;
241 //TODO: add clock offset option
242 //TODO: add (preferably unique) trace's name
243 metadata
->decoder
= ctf_metadata_decoder_create(stderr
, 0,
245 if (!metadata
->decoder
) {
248 trace
= lttng_live_ref_trace(session
, ctf_trace_id
);
252 metadata
->trace
= trace
;
253 trace
->metadata
= metadata
;
257 ctf_metadata_decoder_destroy(metadata
->decoder
);
263 void lttng_live_metadata_fini(struct lttng_live_trace
*trace
)
265 struct lttng_live_metadata
*metadata
= trace
->metadata
;
270 if (metadata
->text
) {
271 free(metadata
->text
);
273 ctf_metadata_decoder_destroy(metadata
->decoder
);
274 trace
->metadata
= NULL
;
275 lttng_live_unref_trace(trace
);
276 if (!metadata
->closed
) {
277 lttng_live_unref_trace(metadata
->trace
);