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.
20 #include <babeltrace/compat/uuid-internal.h>
21 #include <babeltrace/compat/memstream-internal.h>
22 #include <babeltrace/ctf-ir/trace.h>
30 #define PRINT_ERR_STREAM (mdec ? mdec->err_stream : stderr)
31 #define PRINT_PREFIX "metadata-decoder"
34 #define TSDL_MAGIC 0x75d11d57
36 struct ctf_metadata_decoder
{
37 struct ctf_visitor_generate_ir
*visitor
;
44 struct packet_header
{
48 uint32_t content_size
;
50 uint8_t compression_scheme
;
51 uint8_t encryption_scheme
;
52 uint8_t checksum_scheme
;
55 } __attribute__((__packed__
));
58 bool ctf_metadata_decoder_is_packetized(FILE *fp
, int *byte_order
)
64 len
= fread(&magic
, sizeof(magic
), 1, fp
);
70 if (magic
== TSDL_MAGIC
) {
72 *byte_order
= BYTE_ORDER
;
73 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
75 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
76 LITTLE_ENDIAN
: BIG_ENDIAN
;
87 bool is_version_valid(unsigned int major
, unsigned int minor
)
89 return major
== 1 && minor
== 8;
93 int decode_packet(struct ctf_metadata_decoder
*mdec
, FILE *in_fp
, FILE *out_fp
,
96 struct packet_header header
;
97 size_t readlen
, writelen
, toread
;
98 uint8_t buf
[512 + 1]; /* + 1 for debug-mode \0 */
101 readlen
= fread(&header
, sizeof(header
), 1, in_fp
);
102 if (feof(in_fp
) != 0) {
109 if (byte_order
!= BYTE_ORDER
) {
110 header
.magic
= GUINT32_SWAP_LE_BE(header
.magic
);
111 header
.checksum
= GUINT32_SWAP_LE_BE(header
.checksum
);
112 header
.content_size
= GUINT32_SWAP_LE_BE(header
.content_size
);
113 header
.packet_size
= GUINT32_SWAP_LE_BE(header
.packet_size
);
116 if (header
.compression_scheme
) {
117 PERR("Metadata packet compression not supported yet\n");
121 if (header
.encryption_scheme
) {
122 PERR("Metadata packet encryption not supported yet\n");
126 if (header
.checksum
|| header
.checksum_scheme
) {
127 PERR("Metadata packet checksum verification not supported yet\n");
131 if (!is_version_valid(header
.major
, header
.minor
)) {
132 PERR("Invalid metadata version: %u.%u\n", header
.major
,
137 /* Set expected trace UUID if not set; otherwise validate it */
139 if (!mdec
->is_uuid_set
) {
140 memcpy(mdec
->uuid
, header
.uuid
, sizeof(header
.uuid
));
141 mdec
->is_uuid_set
= true;
142 } else if (bt_uuid_compare(header
.uuid
, mdec
->uuid
)) {
143 PERR("Metadata UUID mismatch between packets of the same stream\n");
148 if ((header
.content_size
/ CHAR_BIT
) < sizeof(header
)) {
149 PERR("Bad metadata packet content size: %u\n",
150 header
.content_size
);
154 toread
= header
.content_size
/ CHAR_BIT
- sizeof(header
);
157 readlen
= fread(buf
, sizeof(uint8_t),
158 MIN(sizeof(buf
) - 1, toread
), in_fp
);
160 PERR("Cannot read metadata packet buffer (at position %ld)\n",
165 writelen
= fwrite(buf
, sizeof(uint8_t), readlen
, out_fp
);
166 if (writelen
< readlen
|| ferror(out_fp
)) {
167 PERR("Cannot write decoded metadata text to buffer\n");
175 /* Read leftover padding */
176 toread
= (header
.packet_size
- header
.content_size
) /
178 fseek_ret
= fseek(in_fp
, toread
, SEEK_CUR
);
180 PWARN("Missing padding at the end of the metadata file\n");
197 int ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
198 struct ctf_metadata_decoder
*mdec
, FILE *fp
,
199 char **buf
, int byte_order
)
205 size_t packet_index
= 0;
207 out_fp
= bt_open_memstream(buf
, &size
);
208 if (out_fp
== NULL
) {
209 PERR("Cannot open memory stream: %s\n", strerror(errno
));
218 tret
= decode_packet(mdec
, fp
, out_fp
, byte_order
);
220 PERR("Cannot decode packet #%zu\n", packet_index
);
227 /* Make sure the whole string ends with a null character */
228 tret
= fputc('\0', out_fp
);
230 PERR("Cannot append '\\0' to the decoded metadata buffer\n");
234 /* Close stream, which also flushes the buffer */
235 ret
= bt_close_memstream(buf
, &size
, out_fp
);
237 PERR("Cannot close memory stream: %s\n", strerror(errno
));
247 bt_close_memstream(buf
, &size
, out_fp
);
260 int ctf_metadata_decoder_packetized_file_stream_to_buf(
261 FILE *fp
, char **buf
, int byte_order
)
263 return ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
264 NULL
, fp
, buf
, byte_order
);
268 struct ctf_metadata_decoder
*ctf_metadata_decoder_create(FILE *err
,
269 uint64_t clock_class_offset_ns
, const char *name
)
271 struct ctf_metadata_decoder
*mdec
=
272 g_new0(struct ctf_metadata_decoder
, 1);
278 mdec
->err_stream
= err
;
279 mdec
->visitor
= ctf_visitor_generate_ir_create(err
,
280 clock_class_offset_ns
, name
);
281 if (!mdec
->visitor
) {
282 ctf_metadata_decoder_destroy(mdec
);
292 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder
*mdec
)
298 ctf_visitor_generate_ir_destroy(mdec
->visitor
);
303 enum ctf_metadata_decoder_status
ctf_metadata_decoder_decode(
304 struct ctf_metadata_decoder
*mdec
, FILE *fp
)
306 enum ctf_metadata_decoder_status status
=
307 CTF_METADATA_DECODER_STATUS_OK
;
309 struct ctf_scanner
*scanner
= NULL
;
311 bool close_fp
= false;
315 if (ctf_metadata_decoder_is_packetized(fp
, &mdec
->bo
)) {
316 PDBG("Metadata stream is packetized\n");
317 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf_with_mdec(
318 mdec
, fp
, &buf
, mdec
->bo
);
321 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
325 if (strlen(buf
) == 0) {
326 /* An empty metadata packet is OK. */
330 /* Convert the real file pointer to a memory file pointer */
331 fp
= bt_fmemopen(buf
, strlen(buf
), "rb");
334 PERR("Cannot memory-open metadata buffer: %s\n",
336 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
340 unsigned int major
, minor
;
342 const long init_pos
= ftell(fp
);
344 PDBG("Metadata stream is plain text\n");
346 /* Check text-only metadata header and version */
347 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
349 PWARN("Ill-shapen or missing \"/* CTF major.minor\" header in plain text metadata file stream\n");
352 PDBG("Metadata version: %u.%u\n", major
, minor
);
354 if (!is_version_valid(major
, minor
)) {
355 PERR("Invalid metadata version: %u.%u\n", major
, minor
);
356 status
= CTF_METADATA_DECODER_STATUS_INVAL_VERSION
;
360 if (fseek(fp
, init_pos
, SEEK_SET
)) {
361 PERR("Cannot seek metadata file stream to initial position: %s\n",
363 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
368 /* Allocate a scanner and append the metadata text content */
369 scanner
= ctf_scanner_alloc();
371 PERR("Cannot allocate a metadata lexical scanner\n");
372 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
377 ret
= ctf_scanner_append_ast(scanner
, fp
);
379 PERR("Cannot create the metadata AST\n");
380 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
384 ret
= ctf_visitor_semantic_check(stderr
, 0, &scanner
->ast
->root
);
386 PERR("Metadata semantic validation failed\n");
387 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
391 ret
= ctf_visitor_generate_ir_visit_node(mdec
->visitor
,
392 &scanner
->ast
->root
);
398 PDBG("While visiting AST: incomplete data\n");
399 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
402 PERR("Cannot visit AST node to create CTF IR objects\n");
403 status
= CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
;
409 ctf_scanner_free(scanner
);
412 if (fp
&& close_fp
) {
414 PERR("Cannot close metadata file stream\n");
426 struct bt_ctf_trace
*ctf_metadata_decoder_get_trace(
427 struct ctf_metadata_decoder
*mdec
)
429 return ctf_visitor_generate_ir_get_trace(mdec
->visitor
);