2 * SPDX-License-Identifier: MIT
4 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
15 #include <babeltrace2/babeltrace.h>
17 #define BT_COMP_LOG_SELF_COMP (mdec->config.self_comp)
18 #define BT_COMP_LOG_SELF_COMP_CLASS (mdec->config.self_comp_class)
19 #define BT_LOG_OUTPUT_LEVEL (mdec->config.log_level)
20 #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER"
21 #include "logging.hpp"
22 #include "logging/comp-logging.h"
24 #include "common/assert.h"
25 #include "common/uuid.h"
26 #include "compat/memstream.h"
29 #include "decoder-packetized-file-stream-to-buf.hpp"
30 #include "decoder.hpp"
31 #include "parser-wrap.hpp"
32 #include "scanner.hpp"
34 #define TSDL_MAGIC 0x75d11d57
36 struct ctf_metadata_decoder
38 struct ctf_scanner
*scanner
;
40 struct ctf_visitor_generate_ir
*visitor
;
44 struct ctf_metadata_decoder_config config
;
45 struct meta_log_config log_cfg
;
46 bool has_checked_plaintext_signature
;
54 uint32_t content_size
;
56 uint8_t compression_scheme
;
57 uint8_t encryption_scheme
;
58 uint8_t checksum_scheme
;
61 } __attribute__((__packed__
));
63 int ctf_metadata_decoder_is_packetized(FILE *fp
, bool *is_packetized
, int *byte_order
,
64 bt_logging_level log_level
, bt_self_component
*self_comp
)
70 *is_packetized
= false;
71 len
= fread(&magic
, sizeof(magic
), 1, fp
);
74 BT_LOG_INFO
, log_level
, self_comp
,
75 "Cannot read first metadata packet header: assuming the stream is not packetized.");
81 if (magic
== TSDL_MAGIC
) {
82 *is_packetized
= true;
83 *byte_order
= BYTE_ORDER
;
84 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
85 *is_packetized
= true;
86 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
? LITTLE_ENDIAN
: BIG_ENDIAN
;
96 struct ctf_metadata_decoder
*
97 ctf_metadata_decoder_create(const struct ctf_metadata_decoder_config
*config
)
99 struct ctf_metadata_decoder
*mdec
= g_new0(struct ctf_metadata_decoder
, 1);
102 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, config
->log_level
, config
->self_comp
,
103 "Creating CTF metadata decoder: "
104 "clock-class-offset-s=%" PRId64
", "
105 "clock-class-offset-ns=%" PRId64
,
106 config
->clock_class_offset_s
, config
->clock_class_offset_ns
);
109 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, config
->log_level
, config
->self_comp
,
110 "Failed to allocate one CTF metadata decoder.");
114 mdec
->log_cfg
.log_level
= config
->log_level
;
115 mdec
->log_cfg
.self_comp
= config
->self_comp
;
116 mdec
->log_cfg
.self_comp_class
= config
->self_comp_class
;
117 mdec
->scanner
= ctf_scanner_alloc();
118 if (!mdec
->scanner
) {
119 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot allocate a metadata lexical scanner: "
125 mdec
->text
= g_string_new(NULL
);
127 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to allocate one GString: "
134 mdec
->config
= *config
;
135 mdec
->visitor
= ctf_visitor_generate_ir_create(config
);
136 if (!mdec
->visitor
) {
137 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to create a CTF IR metadata AST visitor: "
143 BT_COMP_LOGD("Creating CTF metadata decoder: "
144 "clock-class-offset-s=%" PRId64
", "
145 "clock-class-offset-ns=%" PRId64
", addr=%p",
146 config
->clock_class_offset_s
, config
->clock_class_offset_ns
, mdec
);
150 ctf_metadata_decoder_destroy(mdec
);
157 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder
*mdec
)
164 ctf_scanner_free(mdec
->scanner
);
168 g_string_free(mdec
->text
, TRUE
);
171 BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec
);
172 ctf_visitor_generate_ir_destroy(mdec
->visitor
);
176 enum ctf_metadata_decoder_status
177 ctf_metadata_decoder_append_content(struct ctf_metadata_decoder
*mdec
, FILE *fp
)
179 enum ctf_metadata_decoder_status status
= CTF_METADATA_DECODER_STATUS_OK
;
182 bool close_fp
= false;
187 ret
= ctf_metadata_decoder_is_packetized(fp
, &is_packetized
, &mdec
->bo
, mdec
->config
.log_level
,
188 mdec
->config
.self_comp
);
190 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
195 BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec
);
196 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(
197 fp
, &buf
, mdec
->bo
, &mdec
->is_uuid_set
, mdec
->uuid
, mdec
->config
.log_level
,
198 mdec
->config
.self_comp
, mdec
->config
.self_comp_class
);
200 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
201 "Cannot decode packetized metadata packets to metadata text: "
202 "mdec-addr=%p, ret=%d",
204 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
208 if (strlen(buf
) == 0) {
209 /* An empty metadata packet is OK. */
213 /* Convert the real file pointer to a memory file pointer */
214 fp
= bt_fmemopen(buf
, strlen(buf
), "rb");
217 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot memory-open metadata buffer: %s: "
219 strerror(errno
), mdec
);
220 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
223 } else if (!mdec
->has_checked_plaintext_signature
) {
224 unsigned int major
, minor
;
226 const long init_pos
= ftell(fp
);
228 BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec
);
231 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP
,
232 "Failed to get current file position", ".");
233 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
237 /* Check text-only metadata header and version */
238 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
241 "Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
246 BT_COMP_LOGI("Found metadata stream version in signature: version=%u.%u", major
, minor
);
248 if (!ctf_metadata_decoder_is_packet_version_valid(major
, minor
)) {
249 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
250 "Invalid metadata version found in plain text signature: "
251 "version=%u.%u, mdec-addr=%p",
253 status
= CTF_METADATA_DECODER_STATUS_INVAL_VERSION
;
257 if (fseek(fp
, init_pos
, SEEK_SET
)) {
258 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
259 "Cannot seek metadata file stream to initial position: %s: "
261 strerror(errno
), mdec
);
262 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
266 mdec
->has_checked_plaintext_signature
= true;
270 if (BT_LOG_ON_TRACE
) {
275 /* Save the file's position: we'll seek back to append the plain text */
278 if (mdec
->config
.keep_plain_text
) {
279 start_pos
= ftell(fp
);
282 /* Append the metadata text content */
283 ret
= ctf_scanner_append_ast(mdec
->scanner
, fp
);
285 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
286 "Cannot create the metadata AST out of the metadata text: "
289 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
293 /* We know it's complete: append plain text */
294 if (mdec
->config
.keep_plain_text
) {
295 BT_ASSERT(start_pos
!= -1);
296 ret
= fseek(fp
, start_pos
, SEEK_SET
);
298 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to seek file: ret=%d, mdec-addr=%p",
300 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
304 ret
= bt_common_append_file_content_to_g_string(mdec
->text
, fp
);
306 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to append to current plain text: "
307 "ret=%d, mdec-addr=%p",
309 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
314 ret
= ctf_visitor_semantic_check(0, &mdec
->scanner
->ast
->root
, &mdec
->log_cfg
);
316 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Validation of the metadata semantics failed: "
319 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
323 if (mdec
->config
.create_trace_class
) {
324 ret
= ctf_visitor_generate_ir_visit_node(mdec
->visitor
, &mdec
->scanner
->ast
->root
);
330 BT_COMP_LOGD("While visiting metadata AST: incomplete data: "
333 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
336 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
337 "Failed to visit AST node to create CTF IR objects: "
338 "mdec-addr=%p, ret=%d",
340 status
= CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
;
350 if (fp
&& close_fp
) {
352 BT_COMP_LOGE("Cannot close metadata file stream: "
363 bt_trace_class
*ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder
*mdec
)
366 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
367 return ctf_visitor_generate_ir_get_ir_trace_class(mdec
->visitor
);
370 struct ctf_trace_class
*
371 ctf_metadata_decoder_borrow_ctf_trace_class(struct ctf_metadata_decoder
*mdec
)
374 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
375 return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec
->visitor
);
378 const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder
*mdec
)
381 BT_ASSERT_DBG(mdec
->config
.keep_plain_text
);
382 return mdec
->text
->str
;
385 int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder
*mdec
)
391 int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder
*mdec
, bt_uuid_t uuid
)
397 if (!mdec
->is_uuid_set
) {
402 bt_uuid_copy(uuid
, mdec
->uuid
);
408 static enum ctf_metadata_decoder_status
find_uuid_in_trace_decl(struct ctf_metadata_decoder
*mdec
,
409 struct ctf_node
*trace_node
,
412 enum ctf_metadata_decoder_status status
= CTF_METADATA_DECODER_STATUS_OK
;
413 struct ctf_node
*entry_node
;
414 struct bt_list_head
*decl_list
= &trace_node
->u
.trace
.declaration_list
;
417 bt_list_for_each_entry (entry_node
, decl_list
, siblings
) {
418 if (entry_node
->type
== NODE_CTF_EXPRESSION
) {
421 left
= ctf_ast_concatenate_unary_strings(&entry_node
->u
.ctf_expression
.left
);
423 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot concatenate unary strings.");
424 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
428 if (strcmp(left
, "uuid") == 0) {
429 ret
= ctf_ast_get_unary_uuid(&entry_node
->u
.ctf_expression
.right
, uuid
,
430 mdec
->config
.log_level
, mdec
->config
.self_comp
);
432 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Invalid trace's `uuid` attribute.");
433 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
445 status
= CTF_METADATA_DECODER_STATUS_NONE
;
452 enum ctf_metadata_decoder_status
453 ctf_metadata_decoder_get_trace_class_uuid(struct ctf_metadata_decoder
*mdec
, bt_uuid_t uuid
)
455 enum ctf_metadata_decoder_status status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
456 struct ctf_node
*root_node
= &mdec
->scanner
->ast
->root
;
457 struct ctf_node
*trace_node
;
460 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
464 trace_node
= bt_list_entry(root_node
->u
.root
.trace
.next
, struct ctf_node
, siblings
);
466 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
470 status
= find_uuid_in_trace_decl(mdec
, trace_node
, uuid
);