2 * Copyright 2016-2017 - Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
15 #define BT_COMP_LOG_SELF_COMP (mdec->config.self_comp)
16 #define BT_LOG_OUTPUT_LEVEL (mdec->config.log_level)
17 #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER"
18 #include "logging/comp-logging.h"
25 #include "common/assert.h"
26 #include "common/uuid.h"
27 #include "compat/memstream.h"
28 #include <babeltrace2/babeltrace.h>
36 #include "parser-wrap.h"
38 #define TSDL_MAGIC 0x75d11d57
40 struct ctf_metadata_decoder
{
41 struct ctf_scanner
*scanner
;
43 struct ctf_visitor_generate_ir
*visitor
;
47 struct ctf_metadata_decoder_config config
;
48 struct meta_log_config log_cfg
;
49 bool has_checked_plaintext_signature
;
52 struct packet_header
{
56 uint32_t content_size
;
58 uint8_t compression_scheme
;
59 uint8_t encryption_scheme
;
60 uint8_t checksum_scheme
;
63 } __attribute__((__packed__
));
66 int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp
,
67 char **buf
, int byte_order
, bool *is_uuid_set
,
68 uint8_t *uuid
, bt_logging_level log_level
,
69 bt_self_component
*self_comp
);
72 int ctf_metadata_decoder_is_packetized(FILE *fp
, bool *is_packetized
,
73 int *byte_order
, bt_logging_level log_level
,
74 bt_self_component
*self_comp
)
80 *is_packetized
= false;
81 len
= fread(&magic
, sizeof(magic
), 1, fp
);
83 BT_COMP_LOG_CUR_LVL(BT_LOG_INFO
, log_level
, self_comp
,
84 "Cannot read first metadata packet header: assuming the stream is not packetized.");
90 if (magic
== TSDL_MAGIC
) {
91 *is_packetized
= true;
92 *byte_order
= BYTE_ORDER
;
93 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
94 *is_packetized
= true;
95 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
96 LITTLE_ENDIAN
: BIG_ENDIAN
;
107 struct ctf_metadata_decoder
*ctf_metadata_decoder_create(
108 const struct ctf_metadata_decoder_config
*config
)
110 struct ctf_metadata_decoder
*mdec
=
111 g_new0(struct ctf_metadata_decoder
, 1);
114 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, config
->log_level
, config
->self_comp
,
115 "Creating CTF metadata decoder: "
116 "clock-class-offset-s=%" PRId64
", "
117 "clock-class-offset-ns=%" PRId64
,
118 config
->clock_class_offset_s
, config
->clock_class_offset_ns
);
121 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, config
->log_level
,
123 "Failed to allocate one CTF metadata decoder.");
127 mdec
->log_cfg
.log_level
= config
->log_level
;
128 mdec
->log_cfg
.self_comp
= config
->self_comp
;
129 mdec
->scanner
= ctf_scanner_alloc();
130 if (!mdec
->scanner
) {
131 BT_COMP_LOGE("Cannot allocate a metadata lexical scanner: "
132 "mdec-addr=%p", mdec
);
136 mdec
->text
= g_string_new(NULL
);
138 BT_COMP_LOGE("Failed to allocate one GString: "
139 "mdec-addr=%p", mdec
);
144 mdec
->config
= *config
;
145 mdec
->visitor
= ctf_visitor_generate_ir_create(config
);
146 if (!mdec
->visitor
) {
147 BT_COMP_LOGE("Failed to create a CTF IR metadata AST visitor: "
148 "mdec-addr=%p", mdec
);
152 BT_COMP_LOGD("Creating CTF metadata decoder: "
153 "clock-class-offset-s=%" PRId64
", "
154 "clock-class-offset-ns=%" PRId64
", addr=%p",
155 config
->clock_class_offset_s
, config
->clock_class_offset_ns
,
160 ctf_metadata_decoder_destroy(mdec
);
168 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder
*mdec
)
175 ctf_scanner_free(mdec
->scanner
);
179 g_string_free(mdec
->text
, TRUE
);
182 BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec
);
183 ctf_visitor_generate_ir_destroy(mdec
->visitor
);
188 enum ctf_metadata_decoder_status
ctf_metadata_decoder_append_content(
189 struct ctf_metadata_decoder
*mdec
, FILE *fp
)
191 enum ctf_metadata_decoder_status status
=
192 CTF_METADATA_DECODER_STATUS_OK
;
195 bool close_fp
= false;
200 ret
= ctf_metadata_decoder_is_packetized(fp
, &is_packetized
, &mdec
->bo
,
201 mdec
->config
.log_level
, mdec
->config
.self_comp
);
203 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
208 BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec
);
209 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(fp
,
210 &buf
, mdec
->bo
, &mdec
->is_uuid_set
,
211 mdec
->uuid
, mdec
->config
.log_level
,
212 mdec
->config
.self_comp
);
214 BT_COMP_LOGE("Cannot decode packetized metadata packets to metadata text: "
215 "mdec-addr=%p, ret=%d", mdec
, ret
);
216 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
220 if (strlen(buf
) == 0) {
221 /* An empty metadata packet is OK. */
225 /* Convert the real file pointer to a memory file pointer */
226 fp
= bt_fmemopen(buf
, strlen(buf
), "rb");
229 BT_COMP_LOGE("Cannot memory-open metadata buffer: %s: "
230 "mdec-addr=%p", strerror(errno
), mdec
);
231 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
234 } else if (!mdec
->has_checked_plaintext_signature
) {
235 unsigned int major
, minor
;
237 const long init_pos
= ftell(fp
);
239 BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec
);
242 BT_COMP_LOGE_ERRNO("Failed to get current file position", ".");
243 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
247 /* Check text-only metadata header and version */
248 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
250 BT_COMP_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
251 "mdec-addr=%p", mdec
);
254 BT_COMP_LOGI("Found metadata stream version in signature: version=%u.%u", major
, minor
);
256 if (!ctf_metadata_decoder_is_packet_version_valid(major
,
258 BT_COMP_LOGE("Invalid metadata version found in plain text signature: "
259 "version=%u.%u, mdec-addr=%p", major
, minor
,
261 status
= CTF_METADATA_DECODER_STATUS_INVAL_VERSION
;
265 if (fseek(fp
, init_pos
, SEEK_SET
)) {
266 BT_COMP_LOGE("Cannot seek metadata file stream to initial position: %s: "
267 "mdec-addr=%p", strerror(errno
), mdec
);
268 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
272 mdec
->has_checked_plaintext_signature
= true;
276 if (BT_LOG_ON_TRACE
) {
281 /* Save the file's position: we'll seek back to append the plain text */
284 if (mdec
->config
.keep_plain_text
) {
285 start_pos
= ftell(fp
);
288 /* Append the metadata text content */
289 ret
= ctf_scanner_append_ast(mdec
->scanner
, fp
);
291 BT_COMP_LOGE("Cannot create the metadata AST out of the metadata text: "
292 "mdec-addr=%p", mdec
);
293 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
297 /* We know it's complete: append plain text */
298 if (mdec
->config
.keep_plain_text
) {
299 BT_ASSERT(start_pos
!= -1);
300 ret
= fseek(fp
, start_pos
, SEEK_SET
);
302 BT_COMP_LOGE("Failed to seek file: ret=%d, mdec-addr=%p",
304 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
308 ret
= bt_common_append_file_content_to_g_string(mdec
->text
, fp
);
310 BT_COMP_LOGE("Failed to append to current plain text: "
311 "ret=%d, mdec-addr=%p", ret
, mdec
);
312 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
317 ret
= ctf_visitor_semantic_check(0, &mdec
->scanner
->ast
->root
,
320 BT_COMP_LOGE("Validation of the metadata semantics failed: "
321 "mdec-addr=%p", mdec
);
322 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
326 if (mdec
->config
.create_trace_class
) {
327 ret
= ctf_visitor_generate_ir_visit_node(mdec
->visitor
,
328 &mdec
->scanner
->ast
->root
);
334 BT_COMP_LOGD("While visiting metadata AST: incomplete data: "
335 "mdec-addr=%p", mdec
);
336 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
339 BT_COMP_LOGE("Failed to visit AST node to create CTF IR objects: "
340 "mdec-addr=%p, ret=%d", mdec
, ret
);
341 status
= CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
;
351 if (fp
&& close_fp
) {
353 BT_COMP_LOGE("Cannot close metadata file stream: "
354 "mdec-addr=%p", mdec
);
364 bt_trace_class
*ctf_metadata_decoder_get_ir_trace_class(
365 struct ctf_metadata_decoder
*mdec
)
368 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
369 return ctf_visitor_generate_ir_get_ir_trace_class(mdec
->visitor
);
373 struct ctf_trace_class
*ctf_metadata_decoder_borrow_ctf_trace_class(
374 struct ctf_metadata_decoder
*mdec
)
377 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
378 return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec
->visitor
);
382 const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder
*mdec
)
385 BT_ASSERT_DBG(mdec
->config
.keep_plain_text
);
386 return mdec
->text
->str
;
390 int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder
*mdec
)
397 int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder
*mdec
,
404 if (!mdec
->is_uuid_set
) {
409 bt_uuid_copy(uuid
, mdec
->uuid
);
416 enum ctf_metadata_decoder_status
find_uuid_in_trace_decl(
417 struct ctf_metadata_decoder
*mdec
, struct ctf_node
*trace_node
,
420 enum ctf_metadata_decoder_status status
=
421 CTF_METADATA_DECODER_STATUS_OK
;
422 struct ctf_node
*entry_node
;
423 struct bt_list_head
*decl_list
= &trace_node
->u
.trace
.declaration_list
;
426 bt_list_for_each_entry(entry_node
, decl_list
, siblings
) {
427 if (entry_node
->type
== NODE_CTF_EXPRESSION
) {
430 left
= ctf_ast_concatenate_unary_strings(
431 &entry_node
->u
.ctf_expression
.left
);
433 BT_COMP_LOGE("Cannot concatenate unary strings.");
434 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
438 if (strcmp(left
, "uuid") == 0) {
439 ret
= ctf_ast_get_unary_uuid(
440 &entry_node
->u
.ctf_expression
.right
,
441 uuid
, mdec
->config
.log_level
,
442 mdec
->config
.self_comp
);
444 BT_COMP_LOGE("Invalid trace's `uuid` attribute.");
445 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
457 status
= CTF_METADATA_DECODER_STATUS_NONE
;
465 enum ctf_metadata_decoder_status
ctf_metadata_decoder_get_trace_class_uuid(
466 struct ctf_metadata_decoder
*mdec
, bt_uuid_t uuid
)
468 enum ctf_metadata_decoder_status status
=
469 CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
470 struct ctf_node
*root_node
= &mdec
->scanner
->ast
->root
;
471 struct ctf_node
*trace_node
;
474 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
479 bt_list_entry(root_node
->u
.root
.trace
.next
,
480 struct ctf_node
, siblings
);
482 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
486 status
= find_uuid_in_trace_decl(mdec
, trace_node
, uuid
);