src.ctf.lttng-live: use `_APPEND_CAUSE` variants of logging macros
[babeltrace.git] / src / plugins / ctf / lttng-live / metadata.c
CommitLineData
7cdc2bab 1/*
bb18709b 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
5278d5ba 27#define BT_COMP_LOG_SELF_COMP self_comp
1c0ceb65 28#define BT_LOG_OUTPUT_LEVEL log_level
b03487ab 29#define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/META"
3fa1b6a3 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>
57952005 37#include "compat/memstream.h"
71c5da58 38#include <babeltrace2/babeltrace.h>
7cdc2bab 39
7cdc2bab
MD
40#include "metadata.h"
41#include "../common/metadata/decoder.h"
cd03c43c 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
bb18709b 59
7cdc2bab 60static
1c0ceb65 61bool stream_classes_all_have_default_clock_class(bt_trace_class *tc,
5278d5ba
PP
62 bt_logging_level log_level,
63 bt_self_component *self_comp)
7cdc2bab 64{
bb18709b
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
bb18709b
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
bb18709b 74 BT_ASSERT(sc);
7cdc2bab 75
bb18709b
FD
76 cc = bt_stream_class_borrow_default_clock_class_const(sc);
77 if (!cc) {
78 ret = false;
f6e2a9d2
FD
79 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
80 "Stream class doesn't have a default clock class: "
bb18709b
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 88end:
bb18709b
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 */
96static
97const 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);
ec4a3354 106 BT_ASSERT_DBG(sc);
bb18709b
FD
107
108 cc = bt_stream_class_borrow_default_clock_class_const(sc);
109 if (cc) {
110 goto end;
111 }
112 }
113end:
ec4a3354 114 BT_ASSERT_DBG(cc);
bb18709b 115 return cc;
7cdc2bab
MD
116}
117
118BT_HIDDEN
bb18709b 119enum 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;
f797424a 126 bool keep_receiving;
7cdc2bab
MD
127 FILE *fp = NULL;
128 enum ctf_metadata_decoder_status decoder_status;
bb18709b
FD
129 enum lttng_live_iterator_status status =
130 LTTNG_LIVE_ITERATOR_STATUS_OK;
1c0ceb65 131 bt_logging_level log_level = trace->log_level;
5278d5ba 132 bt_self_component *self_comp = trace->self_comp;
f797424a 133 enum lttng_live_get_one_metadata_status metadata_status;
7cdc2bab
MD
134
135 /* No metadata stream yet. */
136 if (!metadata) {
137 if (session->new_streams_needed) {
bb18709b 138 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
7cdc2bab
MD
139 } else {
140 session->new_streams_needed = true;
bb18709b 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) {
f6e2a9d2
FD
157 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
158 "Metadata open_memstream", ".");
7cdc2bab
MD
159 goto error;
160 }
161
f797424a 162 keep_receiving = true;
7cdc2bab 163 /* Grab all available metadata. */
f797424a
FD
164 while (keep_receiving) {
165 size_t reply_len = 0;
7cdc2bab 166 /*
f797424a
FD
167 * lttng_live_get_one_metadata_packet() asks the Relay Daemon
168 * for new metadata. If new metadata is received, the function
169 * writes it to the provided file handle and updates the
170 * reply_len output parameter. We call this function in loop
171 * until it returns _END meaning that no new metadata is
172 * available.
173 * We may receive a _CLOSED status if the metadata stream we
174 * are requesting is no longer available on the relay.
175 * If we receive an _ERROR status, it means there was a
176 * networking, allocating, or some other unrecoverable error.
7cdc2bab 177 */
f797424a
FD
178 metadata_status = lttng_live_get_one_metadata_packet(trace, fp,
179 &reply_len);
180
181 switch (metadata_status) {
182 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK:
183 len_read += reply_len;
184 break;
185 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_END:
186 keep_receiving = false;
187 break;
188 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED:
189 keep_receiving = false;
190 break;
191 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR:
192 goto error;
193 default:
194 abort();
7cdc2bab 195 }
f797424a 196 }
7cdc2bab
MD
197
198 /*
f797424a
FD
199 * A closed metadata stream means the trace is no longer active. Return
200 * _END so that the caller can remove the trace from its list.
7cdc2bab 201 */
f797424a
FD
202 if (metadata_status == LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED) {
203 status = LTTNG_LIVE_ITERATOR_STATUS_END;
204 goto end;
7cdc2bab
MD
205 }
206
207 if (bt_close_memstream(&metadata_buf, &size, fp)) {
f6e2a9d2
FD
208 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
209 "Metadata bt_close_memstream", ".");
7cdc2bab 210 }
67875d75 211
7cdc2bab
MD
212 fp = NULL;
213
214 if (len_read == 0) {
215 if (!trace->trace) {
bb18709b 216 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
7cdc2bab
MD
217 goto end;
218 }
219 trace->new_metadata_needed = false;
220 goto end;
221 }
222
7cdc2bab
MD
223 fp = bt_fmemopen(metadata_buf, len_read, "rb");
224 if (!fp) {
f6e2a9d2
FD
225 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
226 "Cannot memory-open metadata buffer", ".");
7cdc2bab
MD
227 goto error;
228 }
229
bb18709b 230 /*
526c3a49
PP
231 * The call to ctf_metadata_decoder_append_content() will append
232 * new metadata to our current trace class.
bb18709b 233 */
526c3a49
PP
234 decoder_status = ctf_metadata_decoder_append_content(
235 metadata->decoder, fp);
7cdc2bab
MD
236 switch (decoder_status) {
237 case CTF_METADATA_DECODER_STATUS_OK:
bb18709b 238 if (!trace->trace_class) {
cd03c43c
PP
239 struct ctf_trace_class *tc =
240 ctf_metadata_decoder_borrow_ctf_trace_class(
241 metadata->decoder);
242
bb18709b
FD
243 trace->trace_class =
244 ctf_metadata_decoder_get_ir_trace_class(
245 metadata->decoder);
246 trace->trace = bt_trace_create(trace->trace_class);
cd03c43c 247 if (!trace->trace) {
f6e2a9d2
FD
248 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
249 "Failed to create bt_trace");
cd03c43c
PP
250 goto error;
251 }
252 if (ctf_trace_class_configure_ir_trace(tc,
253 trace->trace)) {
f6e2a9d2
FD
254 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
255 "Failed to configure ctf trace class");
cd03c43c
PP
256 goto error;
257 }
bb18709b 258 if (!stream_classes_all_have_default_clock_class(
5278d5ba
PP
259 trace->trace_class, log_level,
260 self_comp)) {
bb18709b
FD
261 /* Error logged in function. */
262 goto error;
263 }
264 trace->clock_class =
265 borrow_any_clock_class(trace->trace_class);
7cdc2bab 266 }
bb18709b
FD
267 trace->new_metadata_needed = false;
268
7cdc2bab
MD
269 break;
270 case CTF_METADATA_DECODER_STATUS_INCOMPLETE:
bb18709b 271 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
7cdc2bab 272 break;
26aa224b 273 default:
7cdc2bab
MD
274 goto error;
275 }
276
277 goto end;
f797424a 278
7cdc2bab 279error:
f797424a
FD
280 if (errno == EINTR) {
281 if (lttng_live_graph_is_canceled(session->lttng_live_msg_iter)) {
282 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
283 }
284 } else {
285 status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
286 }
7cdc2bab
MD
287end:
288 if (fp) {
289 int closeret;
290
291 closeret = fclose(fp);
292 if (closeret) {
f6e2a9d2
FD
293 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp,
294 "Error on fclose", ".");
7cdc2bab
MD
295 }
296 }
6f79a7cf 297 free(metadata_buf);
7cdc2bab
MD
298 return status;
299}
300
301BT_HIDDEN
302int lttng_live_metadata_create_stream(struct lttng_live_session *session,
5278d5ba 303 uint64_t ctf_trace_id, uint64_t stream_id,
06994c71 304 const char *trace_name)
7cdc2bab 305{
f6e2a9d2
FD
306 bt_self_component *self_comp = session->self_comp;
307 bt_logging_level log_level = session->log_level;
7cdc2bab
MD
308 struct lttng_live_metadata *metadata = NULL;
309 struct lttng_live_trace *trace;
1f1f2720 310 struct ctf_metadata_decoder_config cfg = {
1c0ceb65 311 .log_level = session->log_level,
5278d5ba 312 .self_comp = session->self_comp,
1f1f2720
PP
313 .clock_class_offset_s = 0,
314 .clock_class_offset_ns = 0,
526c3a49 315 .create_trace_class = true,
1f1f2720 316 };
7cdc2bab
MD
317
318 metadata = g_new0(struct lttng_live_metadata, 1);
319 if (!metadata) {
320 return -1;
321 }
1c0ceb65 322 metadata->log_level = session->log_level;
5278d5ba 323 metadata->self_comp = session->self_comp;
7cdc2bab 324 metadata->stream_id = stream_id;
bb18709b 325
16699f85 326 metadata->decoder = ctf_metadata_decoder_create(&cfg);
7cdc2bab 327 if (!metadata->decoder) {
f6e2a9d2
FD
328 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
329 "Failed to create CTF metadata decoder");
7cdc2bab
MD
330 goto error;
331 }
bb18709b 332 trace = lttng_live_borrow_trace(session, ctf_trace_id);
7cdc2bab 333 if (!trace) {
f6e2a9d2
FD
334 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
335 "Failed to borrow trace");
7cdc2bab
MD
336 goto error;
337 }
338 metadata->trace = trace;
339 trace->metadata = metadata;
340 return 0;
341
342error:
343 ctf_metadata_decoder_destroy(metadata->decoder);
344 g_free(metadata);
345 return -1;
346}
347
348BT_HIDDEN
349void lttng_live_metadata_fini(struct lttng_live_trace *trace)
350{
351 struct lttng_live_metadata *metadata = trace->metadata;
352
353 if (!metadata) {
354 return;
355 }
7cdc2bab
MD
356 ctf_metadata_decoder_destroy(metadata->decoder);
357 trace->metadata = NULL;
7cdc2bab
MD
358 g_free(metadata);
359}
This page took 0.078731 seconds and 4 git commands to generate.