bt2: add interrupter support
[babeltrace.git] / src / plugins / ctf / lttng-live / metadata.c
CommitLineData
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"
2ece7dd0 30#include "plugins/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
46struct 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 60static
c01594de 61bool 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;
2ece7dd0 79 BT_COMP_LOGE("Stream class doesn't have a default clock class: "
14f28187
FD
80 "sc-id=%" PRIu64 ", sc-name=\"%s\"",
81 bt_stream_class_get_id(sc),
82 bt_stream_class_get_name(sc));
83 goto end;
7cdc2bab
MD
84 }
85 }
86
7cdc2bab 87end:
14f28187
FD
88 return ret;
89}
90/*
91 * Iterate over the stream classes and returns the first clock class
92 * encountered. This is useful to create message iterator inactivity message as
93 * we don't need a particular clock class.
94 */
95static
96const bt_clock_class *borrow_any_clock_class(bt_trace_class *tc)
97{
98 uint64_t i, sc_count;
99 const bt_clock_class *cc = NULL;
100 const bt_stream_class *sc;
101
102 sc_count = bt_trace_class_get_stream_class_count(tc);
103 for (i = 0; i < sc_count; i++) {
104 sc = bt_trace_class_borrow_stream_class_by_index_const(tc, i);
105 BT_ASSERT(sc);
106
107 cc = bt_stream_class_borrow_default_clock_class_const(sc);
108 if (cc) {
109 goto end;
110 }
111 }
112end:
113 BT_ASSERT(cc);
114 return cc;
7cdc2bab
MD
115}
116
117BT_HIDDEN
14f28187 118enum lttng_live_iterator_status lttng_live_metadata_update(
7cdc2bab
MD
119 struct lttng_live_trace *trace)
120{
121 struct lttng_live_session *session = trace->session;
7cdc2bab 122 struct lttng_live_metadata *metadata = trace->metadata;
14f28187
FD
123 struct lttng_live_component *lttng_live =
124 session->lttng_live_msg_iter->lttng_live_comp;
7cdc2bab
MD
125 ssize_t ret = 0;
126 size_t size, len_read = 0;
127 char *metadata_buf = NULL;
128 FILE *fp = NULL;
129 enum ctf_metadata_decoder_status decoder_status;
14f28187
FD
130 enum lttng_live_iterator_status status =
131 LTTNG_LIVE_ITERATOR_STATUS_OK;
c01594de 132 bt_logging_level log_level = trace->log_level;
2ece7dd0 133 bt_self_component *self_comp = trace->self_comp;
7cdc2bab
MD
134
135 /* No metadata stream yet. */
136 if (!metadata) {
137 if (session->new_streams_needed) {
14f28187 138 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
7cdc2bab
MD
139 } else {
140 session->new_streams_needed = true;
14f28187 141 status = LTTNG_LIVE_ITERATOR_STATUS_CONTINUE;
7cdc2bab
MD
142 }
143 goto end;
144 }
145
6f79a7cf
MD
146 if (!metadata->trace) {
147 trace->new_metadata_needed = false;
148 }
149
7cdc2bab
MD
150 if (!trace->new_metadata_needed) {
151 goto end;
152 }
153
154 /* Open for writing */
155 fp = bt_open_memstream(&metadata_buf, &size);
156 if (!fp) {
2ece7dd0 157 BT_COMP_LOGE("Metadata open_memstream: %s", strerror(errno));
7cdc2bab
MD
158 goto error;
159 }
160
161 /* Grab all available metadata. */
162 do {
163 /*
164 * get_one_metadata_packet returns the number of bytes
165 * received, 0 when we have received everything, a
166 * negative value on error.
167 */
168 ret = lttng_live_get_one_metadata_packet(trace, fp);
169 if (ret > 0) {
170 len_read += ret;
171 }
172 } while (ret > 0);
173
174 /*
175 * Consider metadata closed as soon as we get an error reading
176 * it (e.g. cannot be found).
177 */
178 if (ret < 0) {
179 if (!metadata->closed) {
180 metadata->closed = true;
181 /*
182 * Release our reference on the trace as soon as
183 * we know the metadata stream is not available
184 * anymore. This won't necessarily teardown the
185 * metadata objects immediately, but only when
186 * the data streams are done.
187 */
6f79a7cf 188 metadata->trace = NULL;
7cdc2bab 189 }
4c66436f 190 if (errno == EINTR) {
42521b69 191 if (lttng_live_graph_is_canceled(lttng_live)) {
14f28187 192 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
4c66436f
MD
193 goto end;
194 }
195 }
7cdc2bab
MD
196 }
197
198 if (bt_close_memstream(&metadata_buf, &size, fp)) {
2ece7dd0 199 BT_COMP_LOGE("bt_close_memstream: %s", strerror(errno));
7cdc2bab
MD
200 }
201 ret = 0;
202 fp = NULL;
203
204 if (len_read == 0) {
205 if (!trace->trace) {
14f28187 206 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
7cdc2bab
MD
207 goto end;
208 }
209 trace->new_metadata_needed = false;
210 goto end;
211 }
212
7cdc2bab
MD
213 fp = bt_fmemopen(metadata_buf, len_read, "rb");
214 if (!fp) {
2ece7dd0 215 BT_COMP_LOGE("Cannot memory-open metadata buffer: %s",
7cdc2bab
MD
216 strerror(errno));
217 goto error;
218 }
219
14f28187
FD
220 /*
221 * The call to ctf_metadata_decoder_decode will append new metadata to
222 * our current trace class.
223 */
7cdc2bab
MD
224 decoder_status = ctf_metadata_decoder_decode(metadata->decoder, fp);
225 switch (decoder_status) {
226 case CTF_METADATA_DECODER_STATUS_OK:
14f28187 227 if (!trace->trace_class) {
335a2da5
PP
228 struct ctf_trace_class *tc =
229 ctf_metadata_decoder_borrow_ctf_trace_class(
230 metadata->decoder);
231
14f28187
FD
232 trace->trace_class =
233 ctf_metadata_decoder_get_ir_trace_class(
234 metadata->decoder);
235 trace->trace = bt_trace_create(trace->trace_class);
335a2da5
PP
236 if (!trace->trace) {
237 goto error;
238 }
239 if (ctf_trace_class_configure_ir_trace(tc,
240 trace->trace)) {
241 goto error;
242 }
14f28187 243 if (!stream_classes_all_have_default_clock_class(
2ece7dd0
PP
244 trace->trace_class, log_level,
245 self_comp)) {
14f28187
FD
246 /* Error logged in function. */
247 goto error;
248 }
249 trace->clock_class =
250 borrow_any_clock_class(trace->trace_class);
7cdc2bab 251 }
14f28187
FD
252 trace->new_metadata_needed = false;
253
7cdc2bab
MD
254 break;
255 case CTF_METADATA_DECODER_STATUS_INCOMPLETE:
14f28187 256 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
7cdc2bab
MD
257 break;
258 case CTF_METADATA_DECODER_STATUS_ERROR:
259 case CTF_METADATA_DECODER_STATUS_INVAL_VERSION:
260 case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR:
261 goto error;
262 }
263
264 goto end;
265error:
14f28187 266 status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
7cdc2bab
MD
267end:
268 if (fp) {
269 int closeret;
270
271 closeret = fclose(fp);
272 if (closeret) {
2ece7dd0 273 BT_COMP_LOGE("Error on fclose");
7cdc2bab
MD
274 }
275 }
6f79a7cf 276 free(metadata_buf);
7cdc2bab
MD
277 return status;
278}
279
280BT_HIDDEN
281int lttng_live_metadata_create_stream(struct lttng_live_session *session,
2ece7dd0 282 uint64_t ctf_trace_id, uint64_t stream_id,
06994c71 283 const char *trace_name)
7cdc2bab
MD
284{
285 struct lttng_live_metadata *metadata = NULL;
286 struct lttng_live_trace *trace;
06994c71 287 const char *match;
0746848c 288 struct ctf_metadata_decoder_config cfg = {
c01594de 289 .log_level = session->log_level,
2ece7dd0 290 .self_comp = session->self_comp,
0746848c
PP
291 .clock_class_offset_s = 0,
292 .clock_class_offset_ns = 0,
293 };
7cdc2bab
MD
294
295 metadata = g_new0(struct lttng_live_metadata, 1);
296 if (!metadata) {
297 return -1;
298 }
c01594de 299 metadata->log_level = session->log_level;
2ece7dd0 300 metadata->self_comp = session->self_comp;
7cdc2bab 301 metadata->stream_id = stream_id;
14f28187 302
06994c71
MD
303 match = strstr(trace_name, session->session_name->str);
304 if (!match) {
305 goto error;
306 }
14f28187 307
f7b785ac 308 metadata->decoder = ctf_metadata_decoder_create(&cfg);
7cdc2bab
MD
309 if (!metadata->decoder) {
310 goto error;
311 }
14f28187 312 trace = lttng_live_borrow_trace(session, ctf_trace_id);
7cdc2bab
MD
313 if (!trace) {
314 goto error;
315 }
316 metadata->trace = trace;
317 trace->metadata = metadata;
318 return 0;
319
320error:
321 ctf_metadata_decoder_destroy(metadata->decoder);
322 g_free(metadata);
323 return -1;
324}
325
326BT_HIDDEN
327void lttng_live_metadata_fini(struct lttng_live_trace *trace)
328{
329 struct lttng_live_metadata *metadata = trace->metadata;
330
331 if (!metadata) {
332 return;
333 }
7cdc2bab
MD
334 ctf_metadata_decoder_destroy(metadata->decoder);
335 trace->metadata = NULL;
7cdc2bab
MD
336 g_free(metadata);
337}
This page took 0.066325 seconds and 4 git commands to generate.