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 PRINT_ERR_STREAM lttng_live->error_fp
35 #define PRINT_PREFIX "lttng-live-metadata"
36 #define PRINT_DBG_CHECK lttng_live_debug
40 #include "../common/metadata/decoder.h"
42 #define TSDL_MAGIC 0x75d11d57
44 struct packet_header
{
48 uint32_t content_size
;
50 uint8_t compression_scheme
;
51 uint8_t encryption_scheme
;
52 uint8_t checksum_scheme
;
55 } __attribute__((__packed__
));
58 enum bt_ctf_lttng_live_iterator_status
lttng_live_update_clock_map(
59 struct lttng_live_trace
*trace
)
61 enum bt_ctf_lttng_live_iterator_status status
=
62 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK
;
66 BT_PUT(trace
->cc_prio_map
);
67 trace
->cc_prio_map
= bt_clock_class_priority_map_create();
68 if (!trace
->cc_prio_map
) {
72 count
= bt_ctf_trace_get_clock_class_count(trace
->trace
);
75 for (i
= 0; i
< count
; i
++) {
76 struct bt_ctf_clock_class
*clock_class
=
77 bt_ctf_trace_get_clock_class_by_index(trace
->trace
, i
);
80 ret
= bt_clock_class_priority_map_add_clock_class(
81 trace
->cc_prio_map
, clock_class
, 0);
91 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
97 enum bt_ctf_lttng_live_iterator_status
lttng_live_metadata_update(
98 struct lttng_live_trace
*trace
)
100 struct lttng_live_session
*session
= trace
->session
;
101 struct lttng_live_component
*lttng_live
= session
->lttng_live
;
102 struct lttng_live_metadata
*metadata
= trace
->metadata
;
104 size_t size
, len_read
= 0;
105 char *metadata_buf
= NULL
;
107 enum ctf_metadata_decoder_status decoder_status
;
108 enum bt_ctf_lttng_live_iterator_status status
=
109 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK
;
111 /* No metadata stream yet. */
113 if (session
->new_streams_needed
) {
114 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
116 session
->new_streams_needed
= true;
117 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
122 if (!trace
->new_metadata_needed
) {
126 /* Open for writing */
127 fp
= bt_open_memstream(&metadata_buf
, &size
);
129 PERR("Metadata open_memstream: %s\n", strerror(errno
));
133 /* Grab all available metadata. */
136 * get_one_metadata_packet returns the number of bytes
137 * received, 0 when we have received everything, a
138 * negative value on error.
140 ret
= lttng_live_get_one_metadata_packet(trace
, fp
);
147 * Consider metadata closed as soon as we get an error reading
148 * it (e.g. cannot be found).
151 if (!metadata
->closed
) {
152 metadata
->closed
= true;
154 * Release our reference on the trace as soon as
155 * we know the metadata stream is not available
156 * anymore. This won't necessarily teardown the
157 * metadata objects immediately, but only when
158 * the data streams are done.
160 lttng_live_unref_trace(metadata
->trace
);
164 if (bt_close_memstream(&metadata_buf
, &size
, fp
)) {
165 BT_LOGE("bt_close_memstream: %s", strerror(errno
));
172 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
175 trace
->new_metadata_needed
= false;
179 if (babeltrace_debug
) {
183 fp
= bt_fmemopen(metadata_buf
, len_read
, "rb");
185 PERR("Cannot memory-open metadata buffer: %s\n",
190 decoder_status
= ctf_metadata_decoder_decode(metadata
->decoder
, fp
);
191 switch (decoder_status
) {
192 case CTF_METADATA_DECODER_STATUS_OK
:
193 BT_PUT(trace
->trace
);
194 trace
->trace
= ctf_metadata_decoder_get_trace(metadata
->decoder
);
195 trace
->new_metadata_needed
= false;
196 status
= lttng_live_update_clock_map(trace
);
197 if (status
!= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK
) {
201 case CTF_METADATA_DECODER_STATUS_INCOMPLETE
:
202 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
204 case CTF_METADATA_DECODER_STATUS_ERROR
:
205 case CTF_METADATA_DECODER_STATUS_INVAL_VERSION
:
206 case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
:
212 status
= BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
217 closeret
= fclose(fp
);
219 PERR("Error on fclose");
226 int lttng_live_metadata_create_stream(struct lttng_live_session
*session
,
227 uint64_t ctf_trace_id
,
230 struct lttng_live_metadata
*metadata
= NULL
;
231 struct lttng_live_trace
*trace
;
233 metadata
= g_new0(struct lttng_live_metadata
, 1);
237 metadata
->stream_id
= stream_id
;
238 //TODO: add clock offset option
239 metadata
->decoder
= ctf_metadata_decoder_create(
240 session
->lttng_live
->error_fp
, 0);
241 if (!metadata
->decoder
) {
244 trace
= lttng_live_ref_trace(session
, ctf_trace_id
);
248 metadata
->trace
= trace
;
249 trace
->metadata
= metadata
;
253 ctf_metadata_decoder_destroy(metadata
->decoder
);
259 void lttng_live_metadata_fini(struct lttng_live_trace
*trace
)
261 struct lttng_live_metadata
*metadata
= trace
->metadata
;
266 if (metadata
->text
) {
267 free(metadata
->text
);
269 ctf_metadata_decoder_destroy(metadata
->decoder
);
270 trace
->metadata
= NULL
;
271 lttng_live_unref_trace(trace
);
272 if (!metadata
->closed
) {
273 lttng_live_unref_trace(metadata
->trace
);