2 * SPDX-License-Identifier: MIT
4 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
14 #include <babeltrace2/babeltrace.h>
16 #define BT_COMP_LOG_SELF_COMP (mdec->config.self_comp)
17 #define BT_COMP_LOG_SELF_COMP_CLASS (mdec->config.self_comp_class)
18 #define BT_LOG_OUTPUT_LEVEL ((enum bt_log_level) mdec->config.log_level)
19 #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER"
20 #include "logging.hpp"
21 #include "logging/comp-logging.h"
23 #include "common/assert.h"
24 #include "common/uuid.h"
25 #include "compat/memstream.h"
28 #include "decoder-packetized-file-stream-to-buf.hpp"
29 #include "decoder.hpp"
30 #include "parser-wrap.hpp"
31 #include "scanner.hpp"
33 #define TSDL_MAGIC 0x75d11d57
35 struct ctf_metadata_decoder
37 struct ctf_scanner
*scanner
= nullptr;
38 GString
*text
= nullptr;
39 struct ctf_visitor_generate_ir
*visitor
= nullptr;
41 bool is_uuid_set
= false;
43 struct ctf_metadata_decoder_config config
;
44 struct meta_log_config log_cfg
;
45 bool has_checked_plaintext_signature
= false;
53 uint32_t content_size
;
55 uint8_t compression_scheme
;
56 uint8_t encryption_scheme
;
57 uint8_t checksum_scheme
;
60 } __attribute__((__packed__
));
62 int ctf_metadata_decoder_is_packetized(FILE *fp
, bool *is_packetized
, int *byte_order
,
63 bt_logging_level log_level
, bt_self_component
*self_comp
)
69 *is_packetized
= false;
70 len
= fread(&magic
, sizeof(magic
), 1, fp
);
73 BT_LOG_INFO
, log_level
, self_comp
,
74 "Cannot read first metadata packet header: assuming the stream is not packetized.");
80 if (magic
== TSDL_MAGIC
) {
81 *is_packetized
= true;
82 *byte_order
= BYTE_ORDER
;
83 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
84 *is_packetized
= true;
85 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
? LITTLE_ENDIAN
: BIG_ENDIAN
;
95 struct ctf_metadata_decoder
*
96 ctf_metadata_decoder_create(const struct ctf_metadata_decoder_config
*config
)
99 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, config
->log_level
, config
->self_comp
,
100 "Creating CTF metadata decoder: "
101 "clock-class-offset-s=%" PRId64
", "
102 "clock-class-offset-ns=%" PRId64
,
103 config
->clock_class_offset_s
, config
->clock_class_offset_ns
);
105 ctf_metadata_decoder
*mdec
= new ctf_metadata_decoder
;
106 mdec
->log_cfg
.log_level
= config
->log_level
;
107 mdec
->log_cfg
.self_comp
= config
->self_comp
;
108 mdec
->log_cfg
.self_comp_class
= config
->self_comp_class
;
109 mdec
->scanner
= ctf_scanner_alloc();
110 if (!mdec
->scanner
) {
111 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot allocate a metadata lexical scanner: "
117 mdec
->text
= g_string_new(NULL
);
119 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to allocate one GString: "
126 mdec
->config
= *config
;
127 mdec
->visitor
= ctf_visitor_generate_ir_create(config
);
128 if (!mdec
->visitor
) {
129 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to create a CTF IR metadata AST visitor: "
135 BT_COMP_LOGD("Creating CTF metadata decoder: "
136 "clock-class-offset-s=%" PRId64
", "
137 "clock-class-offset-ns=%" PRId64
", addr=%p",
138 config
->clock_class_offset_s
, config
->clock_class_offset_ns
, mdec
);
142 ctf_metadata_decoder_destroy(mdec
);
149 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder
*mdec
)
156 ctf_scanner_free(mdec
->scanner
);
160 g_string_free(mdec
->text
, TRUE
);
163 BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec
);
164 ctf_visitor_generate_ir_destroy(mdec
->visitor
);
168 enum ctf_metadata_decoder_status
169 ctf_metadata_decoder_append_content(struct ctf_metadata_decoder
*mdec
, FILE *fp
)
171 enum ctf_metadata_decoder_status status
= CTF_METADATA_DECODER_STATUS_OK
;
174 bool close_fp
= false;
179 ret
= ctf_metadata_decoder_is_packetized(fp
, &is_packetized
, &mdec
->bo
, mdec
->config
.log_level
,
180 mdec
->config
.self_comp
);
182 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
187 BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec
);
188 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(
189 fp
, &buf
, mdec
->bo
, &mdec
->is_uuid_set
, mdec
->uuid
, mdec
->config
.log_level
,
190 mdec
->config
.self_comp
, mdec
->config
.self_comp_class
);
192 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
193 "Cannot decode packetized metadata packets to metadata text: "
194 "mdec-addr=%p, ret=%d",
196 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
200 if (strlen(buf
) == 0) {
201 /* An empty metadata packet is OK. */
205 /* Convert the real file pointer to a memory file pointer */
206 fp
= bt_fmemopen(buf
, strlen(buf
), "rb");
209 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot memory-open metadata buffer: %s: "
211 strerror(errno
), mdec
);
212 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
215 } else if (!mdec
->has_checked_plaintext_signature
) {
216 unsigned int major
, minor
;
218 const long init_pos
= ftell(fp
);
220 BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec
);
223 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP
,
224 "Failed to get current file position", ".");
225 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
229 /* Check text-only metadata header and version */
230 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
233 "Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
238 BT_COMP_LOGI("Found metadata stream version in signature: version=%u.%u", major
, minor
);
240 if (!ctf_metadata_decoder_is_packet_version_valid(major
, minor
)) {
241 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
242 "Invalid metadata version found in plain text signature: "
243 "version=%u.%u, mdec-addr=%p",
245 status
= CTF_METADATA_DECODER_STATUS_INVAL_VERSION
;
249 if (fseek(fp
, init_pos
, SEEK_SET
)) {
250 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
251 "Cannot seek metadata file stream to initial position: %s: "
253 strerror(errno
), mdec
);
254 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
258 mdec
->has_checked_plaintext_signature
= true;
262 if (BT_LOG_ON_TRACE
) {
267 /* Save the file's position: we'll seek back to append the plain text */
270 if (mdec
->config
.keep_plain_text
) {
271 start_pos
= ftell(fp
);
274 /* Append the metadata text content */
275 ret
= ctf_scanner_append_ast(mdec
->scanner
, fp
);
277 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
278 "Cannot create the metadata AST out of the metadata text: "
281 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
285 /* We know it's complete: append plain text */
286 if (mdec
->config
.keep_plain_text
) {
287 BT_ASSERT(start_pos
!= -1);
288 ret
= fseek(fp
, start_pos
, SEEK_SET
);
290 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to seek file: ret=%d, mdec-addr=%p",
292 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
296 ret
= bt_common_append_file_content_to_g_string(mdec
->text
, fp
);
298 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to append to current plain text: "
299 "ret=%d, mdec-addr=%p",
301 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
306 ret
= ctf_visitor_semantic_check(0, &mdec
->scanner
->ast
->root
, &mdec
->log_cfg
);
308 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Validation of the metadata semantics failed: "
311 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
315 if (mdec
->config
.create_trace_class
) {
316 ret
= ctf_visitor_generate_ir_visit_node(mdec
->visitor
, &mdec
->scanner
->ast
->root
);
322 BT_COMP_LOGD("While visiting metadata AST: incomplete data: "
325 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
328 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
329 "Failed to visit AST node to create CTF IR objects: "
330 "mdec-addr=%p, ret=%d",
332 status
= CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
;
342 if (fp
&& close_fp
) {
344 BT_COMP_LOGE("Cannot close metadata file stream: "
355 bt_trace_class
*ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder
*mdec
)
358 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
359 return ctf_visitor_generate_ir_get_ir_trace_class(mdec
->visitor
);
362 struct ctf_trace_class
*
363 ctf_metadata_decoder_borrow_ctf_trace_class(struct ctf_metadata_decoder
*mdec
)
366 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
367 return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec
->visitor
);
370 const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder
*mdec
)
373 BT_ASSERT_DBG(mdec
->config
.keep_plain_text
);
374 return mdec
->text
->str
;
377 int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder
*mdec
)
383 int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder
*mdec
, bt_uuid_t uuid
)
389 if (!mdec
->is_uuid_set
) {
394 bt_uuid_copy(uuid
, mdec
->uuid
);
400 static enum ctf_metadata_decoder_status
find_uuid_in_trace_decl(struct ctf_metadata_decoder
*mdec
,
401 struct ctf_node
*trace_node
,
404 enum ctf_metadata_decoder_status status
= CTF_METADATA_DECODER_STATUS_OK
;
405 struct ctf_node
*entry_node
;
406 struct bt_list_head
*decl_list
= &trace_node
->u
.trace
.declaration_list
;
409 bt_list_for_each_entry (entry_node
, decl_list
, siblings
) {
410 if (entry_node
->type
== NODE_CTF_EXPRESSION
) {
413 left
= ctf_ast_concatenate_unary_strings(&entry_node
->u
.ctf_expression
.left
);
415 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot concatenate unary strings.");
416 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
420 if (strcmp(left
, "uuid") == 0) {
421 ret
= ctf_ast_get_unary_uuid(&entry_node
->u
.ctf_expression
.right
, uuid
,
422 mdec
->config
.log_level
, mdec
->config
.self_comp
);
424 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Invalid trace's `uuid` attribute.");
425 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
437 status
= CTF_METADATA_DECODER_STATUS_NONE
;
444 enum ctf_metadata_decoder_status
445 ctf_metadata_decoder_get_trace_class_uuid(struct ctf_metadata_decoder
*mdec
, bt_uuid_t uuid
)
447 enum ctf_metadata_decoder_status status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
448 struct ctf_node
*root_node
= &mdec
->scanner
->ast
->root
;
449 struct ctf_node
*trace_node
;
452 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
456 trace_node
= bt_list_entry(root_node
->u
.root
.trace
.next
, struct ctf_node
, siblings
);
458 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
462 status
= find_uuid_in_trace_decl(mdec
, trace_node
, uuid
);