Commit | Line | Data |
---|---|---|
1e649dff PP |
1 | /* |
2 | * Copyright 2016-2017 - Philippe Proulx <pproulx@efficios.com> | |
3 | * | |
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: | |
10 | * | |
11 | * The above copyright notice and this permission notice shall be included in | |
12 | * all copies or substantial portions of the Software. | |
13 | */ | |
14 | ||
16699f85 | 15 | #define BT_COMP_LOG_SELF_COMP (mdec->config.self_comp) |
1f1f2720 | 16 | #define BT_LOG_OUTPUT_LEVEL (mdec->config.log_level) |
b03487ab | 17 | #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER" |
3fa1b6a3 | 18 | #include "logging/comp-logging.h" |
5c343eef | 19 | |
1e649dff PP |
20 | #include <stdio.h> |
21 | #include <stdbool.h> | |
22 | #include <stdint.h> | |
23 | #include <stdlib.h> | |
5c343eef | 24 | #include <inttypes.h> |
57952005 | 25 | #include "common/assert.h" |
d126826c | 26 | #include "common/uuid.h" |
57952005 | 27 | #include "compat/memstream.h" |
71c5da58 | 28 | #include <babeltrace2/babeltrace.h> |
1e649dff | 29 | #include <glib.h> |
e9383dfd | 30 | #include <string.h> |
1e649dff PP |
31 | |
32 | #include "ast.h" | |
33 | #include "decoder.h" | |
34 | #include "scanner.h" | |
16699f85 | 35 | #include "logging.h" |
1e649dff | 36 | |
1e649dff PP |
37 | #define TSDL_MAGIC 0x75d11d57 |
38 | ||
b7c70610 | 39 | extern |
33c81e6f PP |
40 | int yydebug; |
41 | ||
1e649dff | 42 | struct ctf_metadata_decoder { |
526c3a49 PP |
43 | struct ctf_scanner *scanner; |
44 | GString *text; | |
1e649dff | 45 | struct ctf_visitor_generate_ir *visitor; |
d126826c | 46 | bt_uuid_t uuid; |
1e649dff PP |
47 | bool is_uuid_set; |
48 | int bo; | |
53ac3428 | 49 | struct ctf_metadata_decoder_config config; |
526c3a49 | 50 | struct meta_log_config log_cfg; |
1e649dff PP |
51 | }; |
52 | ||
53 | struct packet_header { | |
54 | uint32_t magic; | |
d126826c | 55 | bt_uuid_t uuid; |
1e649dff PP |
56 | uint32_t checksum; |
57 | uint32_t content_size; | |
58 | uint32_t packet_size; | |
59 | uint8_t compression_scheme; | |
60 | uint8_t encryption_scheme; | |
61 | uint8_t checksum_scheme; | |
62 | uint8_t major; | |
63 | uint8_t minor; | |
64 | } __attribute__((__packed__)); | |
65 | ||
66 | BT_HIDDEN | |
526c3a49 PP |
67 | int ctf_metadata_decoder_packetized_file_stream_to_buf(FILE *fp, |
68 | char **buf, int byte_order, bool *is_uuid_set, | |
69 | uint8_t *uuid, bt_logging_level log_level, | |
70 | bt_self_component *self_comp); | |
71 | ||
72 | BT_HIDDEN | |
73 | int ctf_metadata_decoder_is_packetized(FILE *fp, bool *is_packetized, | |
74 | int *byte_order, bt_logging_level log_level, | |
75 | bt_self_component *self_comp) | |
1e649dff PP |
76 | { |
77 | uint32_t magic; | |
78 | size_t len; | |
79 | int ret = 0; | |
80 | ||
526c3a49 | 81 | *is_packetized = false; |
1e649dff PP |
82 | len = fread(&magic, sizeof(magic), 1, fp); |
83 | if (len != 1) { | |
16699f85 | 84 | BT_COMP_LOG_CUR_LVL(BT_LOG_INFO, log_level, self_comp, |
1f1f2720 | 85 | "Cannot read first metadata packet header: assuming the stream is not packetized."); |
526c3a49 | 86 | ret = -1; |
1e649dff PP |
87 | goto end; |
88 | } | |
89 | ||
90 | if (byte_order) { | |
91 | if (magic == TSDL_MAGIC) { | |
526c3a49 | 92 | *is_packetized = true; |
1e649dff PP |
93 | *byte_order = BYTE_ORDER; |
94 | } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) { | |
526c3a49 | 95 | *is_packetized = true; |
1e649dff PP |
96 | *byte_order = BYTE_ORDER == BIG_ENDIAN ? |
97 | LITTLE_ENDIAN : BIG_ENDIAN; | |
98 | } | |
99 | } | |
100 | ||
101 | end: | |
102 | rewind(fp); | |
103 | ||
104 | return ret; | |
105 | } | |
106 | ||
1e649dff | 107 | BT_HIDDEN |
55314f2a | 108 | struct ctf_metadata_decoder *ctf_metadata_decoder_create( |
10b7a2e4 | 109 | const struct ctf_metadata_decoder_config *config) |
1e649dff PP |
110 | { |
111 | struct ctf_metadata_decoder *mdec = | |
112 | g_new0(struct ctf_metadata_decoder, 1); | |
53ac3428 | 113 | |
16699f85 PP |
114 | BT_ASSERT(config); |
115 | BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG, config->log_level, config->self_comp, | |
116 | "Creating CTF metadata decoder: " | |
53ac3428 | 117 | "clock-class-offset-s=%" PRId64 ", " |
10b7a2e4 PP |
118 | "clock-class-offset-ns=%" PRId64, |
119 | config->clock_class_offset_s, config->clock_class_offset_ns); | |
5c343eef | 120 | |
1e649dff | 121 | if (!mdec) { |
16699f85 PP |
122 | BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, config->log_level, |
123 | config->self_comp, | |
124 | "Failed to allocate one CTF metadata decoder."); | |
1e649dff PP |
125 | goto end; |
126 | } | |
127 | ||
526c3a49 PP |
128 | mdec->log_cfg.log_level = config->log_level; |
129 | mdec->log_cfg.self_comp = config->self_comp; | |
130 | mdec->scanner = ctf_scanner_alloc(); | |
131 | if (!mdec->scanner) { | |
132 | BT_COMP_LOGE("Cannot allocate a metadata lexical scanner: " | |
133 | "mdec-addr=%p", mdec); | |
134 | goto error; | |
135 | } | |
136 | ||
137 | mdec->text = g_string_new(NULL); | |
138 | if (!mdec->text) { | |
139 | BT_COMP_LOGE("Failed to allocate one GString: " | |
140 | "mdec-addr=%p", mdec); | |
141 | goto error; | |
142 | } | |
143 | ||
144 | mdec->bo = -1; | |
53ac3428 | 145 | mdec->config = *config; |
16699f85 | 146 | mdec->visitor = ctf_visitor_generate_ir_create(config); |
1e649dff | 147 | if (!mdec->visitor) { |
16699f85 | 148 | BT_COMP_LOGE("Failed to create a CTF IR metadata AST visitor: " |
5c343eef | 149 | "mdec-addr=%p", mdec); |
526c3a49 | 150 | goto error; |
1e649dff PP |
151 | } |
152 | ||
16699f85 | 153 | BT_COMP_LOGD("Creating CTF metadata decoder: " |
53ac3428 | 154 | "clock-class-offset-s=%" PRId64 ", " |
10b7a2e4 | 155 | "clock-class-offset-ns=%" PRId64 ", addr=%p", |
53ac3428 | 156 | config->clock_class_offset_s, config->clock_class_offset_ns, |
10b7a2e4 | 157 | mdec); |
526c3a49 PP |
158 | goto end; |
159 | ||
160 | error: | |
161 | ctf_metadata_decoder_destroy(mdec); | |
162 | mdec = NULL; | |
5c343eef | 163 | |
1e649dff PP |
164 | end: |
165 | return mdec; | |
166 | } | |
167 | ||
168 | BT_HIDDEN | |
169 | void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *mdec) | |
170 | { | |
171 | if (!mdec) { | |
172 | return; | |
173 | } | |
174 | ||
526c3a49 PP |
175 | if (mdec->scanner) { |
176 | ctf_scanner_free(mdec->scanner); | |
177 | } | |
178 | ||
179 | if (mdec->text) { | |
180 | g_string_free(mdec->text, TRUE); | |
181 | } | |
182 | ||
16699f85 | 183 | BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec); |
1e649dff PP |
184 | ctf_visitor_generate_ir_destroy(mdec->visitor); |
185 | g_free(mdec); | |
186 | } | |
187 | ||
188 | BT_HIDDEN | |
526c3a49 | 189 | enum ctf_metadata_decoder_status ctf_metadata_decoder_append_content( |
1e649dff PP |
190 | struct ctf_metadata_decoder *mdec, FILE *fp) |
191 | { | |
192 | enum ctf_metadata_decoder_status status = | |
193 | CTF_METADATA_DECODER_STATUS_OK; | |
194 | int ret; | |
1e649dff PP |
195 | char *buf = NULL; |
196 | bool close_fp = false; | |
526c3a49 PP |
197 | long start_pos = -1; |
198 | bool is_packetized; | |
1e649dff | 199 | |
8b45963b | 200 | BT_ASSERT(mdec); |
526c3a49 PP |
201 | ret = ctf_metadata_decoder_is_packetized(fp, &is_packetized, &mdec->bo, |
202 | mdec->config.log_level, mdec->config.self_comp); | |
203 | if (ret) { | |
204 | status = CTF_METADATA_DECODER_STATUS_ERROR; | |
205 | goto end; | |
206 | } | |
1e649dff | 207 | |
526c3a49 | 208 | if (is_packetized) { |
16699f85 | 209 | BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec); |
a248254b PP |
210 | ret = ctf_metadata_decoder_packetized_file_stream_to_buf(fp, |
211 | &buf, mdec->bo, &mdec->is_uuid_set, | |
212 | mdec->uuid, mdec->config.log_level, | |
16699f85 | 213 | mdec->config.self_comp); |
1e649dff | 214 | if (ret) { |
16699f85 | 215 | BT_COMP_LOGE("Cannot decode packetized metadata packets to metadata text: " |
5c343eef | 216 | "mdec-addr=%p, ret=%d", mdec, ret); |
1e649dff PP |
217 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
218 | goto end; | |
219 | } | |
220 | ||
7cdc2bab MD |
221 | if (strlen(buf) == 0) { |
222 | /* An empty metadata packet is OK. */ | |
223 | goto end; | |
224 | } | |
225 | ||
1e649dff PP |
226 | /* Convert the real file pointer to a memory file pointer */ |
227 | fp = bt_fmemopen(buf, strlen(buf), "rb"); | |
228 | close_fp = true; | |
229 | if (!fp) { | |
16699f85 | 230 | BT_COMP_LOGE("Cannot memory-open metadata buffer: %s: " |
5c343eef | 231 | "mdec-addr=%p", strerror(errno), mdec); |
1e649dff PP |
232 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
233 | goto end; | |
234 | } | |
235 | } else { | |
236 | unsigned int major, minor; | |
237 | ssize_t nr_items; | |
238 | const long init_pos = ftell(fp); | |
239 | ||
16699f85 | 240 | BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec); |
1e649dff | 241 | |
f5662635 | 242 | if (init_pos < 0) { |
16699f85 | 243 | BT_COMP_LOGE_ERRNO("Failed to get current file position", "."); |
f5662635 MD |
244 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
245 | goto end; | |
246 | } | |
247 | ||
1e649dff PP |
248 | /* Check text-only metadata header and version */ |
249 | nr_items = fscanf(fp, "/* CTF %10u.%10u", &major, &minor); | |
250 | if (nr_items < 2) { | |
16699f85 | 251 | BT_COMP_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: " |
5c343eef | 252 | "mdec-addr=%p", mdec); |
1e649dff PP |
253 | } |
254 | ||
16699f85 | 255 | BT_COMP_LOGI("Found metadata stream version in signature: version=%u.%u", major, minor); |
1e649dff | 256 | |
a248254b PP |
257 | if (!ctf_metadata_decoder_is_packet_version_valid(major, |
258 | minor)) { | |
16699f85 | 259 | BT_COMP_LOGE("Invalid metadata version found in plain text signature: " |
5c343eef PP |
260 | "version=%u.%u, mdec-addr=%p", major, minor, |
261 | mdec); | |
1e649dff PP |
262 | status = CTF_METADATA_DECODER_STATUS_INVAL_VERSION; |
263 | goto end; | |
264 | } | |
265 | ||
266 | if (fseek(fp, init_pos, SEEK_SET)) { | |
16699f85 | 267 | BT_COMP_LOGE("Cannot seek metadata file stream to initial position: %s: " |
5c343eef | 268 | "mdec-addr=%p", strerror(errno), mdec); |
1e649dff PP |
269 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
270 | goto end; | |
271 | } | |
272 | } | |
273 | ||
c9ecaa78 | 274 | if (BT_LOG_ON_TRACE) { |
33c81e6f PP |
275 | yydebug = 1; |
276 | } | |
277 | ||
526c3a49 PP |
278 | /* Save the file's position: we'll seek back to append the plain text */ |
279 | BT_ASSERT(fp); | |
280 | ||
281 | if (mdec->config.keep_plain_text) { | |
282 | start_pos = ftell(fp); | |
1e649dff PP |
283 | } |
284 | ||
526c3a49 PP |
285 | /* Append the metadata text content */ |
286 | ret = ctf_scanner_append_ast(mdec->scanner, fp); | |
1e649dff | 287 | if (ret) { |
16699f85 | 288 | BT_COMP_LOGE("Cannot create the metadata AST out of the metadata text: " |
5c343eef | 289 | "mdec-addr=%p", mdec); |
1e649dff PP |
290 | status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; |
291 | goto end; | |
292 | } | |
293 | ||
526c3a49 PP |
294 | /* We know it's complete: append plain text */ |
295 | if (mdec->config.keep_plain_text) { | |
296 | BT_ASSERT(start_pos != -1); | |
297 | ret = fseek(fp, start_pos, SEEK_SET); | |
298 | if (ret) { | |
299 | BT_COMP_LOGE("Failed to seek file: ret=%d, mdec-addr=%p", | |
300 | ret, mdec); | |
301 | status = CTF_METADATA_DECODER_STATUS_ERROR; | |
302 | goto end; | |
303 | } | |
304 | ||
305 | ret = bt_common_append_file_content_to_g_string(mdec->text, fp); | |
306 | if (ret) { | |
307 | BT_COMP_LOGE("Failed to append to current plain text: " | |
308 | "ret=%d, mdec-addr=%p", ret, mdec); | |
309 | status = CTF_METADATA_DECODER_STATUS_ERROR; | |
310 | goto end; | |
311 | } | |
312 | } | |
313 | ||
314 | ret = ctf_visitor_semantic_check(0, &mdec->scanner->ast->root, | |
315 | &mdec->log_cfg); | |
1e649dff | 316 | if (ret) { |
16699f85 | 317 | BT_COMP_LOGE("Validation of the metadata semantics failed: " |
5c343eef | 318 | "mdec-addr=%p", mdec); |
1e649dff PP |
319 | status = CTF_METADATA_DECODER_STATUS_ERROR; |
320 | goto end; | |
321 | } | |
322 | ||
526c3a49 PP |
323 | if (mdec->config.create_trace_class) { |
324 | ret = ctf_visitor_generate_ir_visit_node(mdec->visitor, | |
325 | &mdec->scanner->ast->root); | |
326 | switch (ret) { | |
327 | case 0: | |
328 | /* Success */ | |
329 | break; | |
330 | case -EINCOMPLETE: | |
331 | BT_COMP_LOGD("While visiting metadata AST: incomplete data: " | |
332 | "mdec-addr=%p", mdec); | |
333 | status = CTF_METADATA_DECODER_STATUS_INCOMPLETE; | |
334 | goto end; | |
335 | default: | |
336 | BT_COMP_LOGE("Failed to visit AST node to create CTF IR objects: " | |
337 | "mdec-addr=%p, ret=%d", mdec, ret); | |
338 | status = CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR; | |
339 | goto end; | |
340 | } | |
1e649dff PP |
341 | } |
342 | ||
343 | end: | |
33c81e6f PP |
344 | yydebug = 0; |
345 | ||
1e649dff PP |
346 | if (fp && close_fp) { |
347 | if (fclose(fp)) { | |
16699f85 | 348 | BT_COMP_LOGE("Cannot close metadata file stream: " |
5c343eef | 349 | "mdec-addr=%p", mdec); |
1e649dff PP |
350 | } |
351 | } | |
352 | ||
b17fd38d | 353 | free(buf); |
1e649dff PP |
354 | |
355 | return status; | |
356 | } | |
357 | ||
358 | BT_HIDDEN | |
8eee8ea2 | 359 | bt_trace_class *ctf_metadata_decoder_get_ir_trace_class( |
7b33a0e0 PP |
360 | struct ctf_metadata_decoder *mdec) |
361 | { | |
526c3a49 PP |
362 | BT_ASSERT(mdec); |
363 | BT_ASSERT(mdec->config.create_trace_class); | |
10b7a2e4 | 364 | return ctf_visitor_generate_ir_get_ir_trace_class(mdec->visitor); |
7b33a0e0 PP |
365 | } |
366 | ||
367 | BT_HIDDEN | |
368 | struct ctf_trace_class *ctf_metadata_decoder_borrow_ctf_trace_class( | |
1e649dff PP |
369 | struct ctf_metadata_decoder *mdec) |
370 | { | |
526c3a49 PP |
371 | BT_ASSERT(mdec); |
372 | BT_ASSERT(mdec->config.create_trace_class); | |
7b33a0e0 | 373 | return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec->visitor); |
1e649dff | 374 | } |
526c3a49 PP |
375 | |
376 | BT_HIDDEN | |
377 | const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder *mdec) | |
378 | { | |
379 | BT_ASSERT(mdec); | |
380 | BT_ASSERT(mdec->config.keep_plain_text); | |
381 | return mdec->text->str; | |
382 | } | |
383 | ||
384 | BT_HIDDEN | |
385 | int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec) | |
386 | { | |
387 | BT_ASSERT(mdec); | |
388 | return mdec->bo; | |
389 | } | |
390 | ||
391 | BT_HIDDEN | |
392 | int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec, | |
393 | bt_uuid_t uuid) | |
394 | { | |
395 | int ret = 0; | |
396 | ||
397 | BT_ASSERT(mdec); | |
398 | ||
399 | if (!mdec->is_uuid_set) { | |
400 | ret = -1; | |
401 | goto end; | |
402 | } | |
403 | ||
404 | bt_uuid_copy(uuid, mdec->uuid); | |
405 | ||
406 | end: | |
407 | return ret; | |
408 | } |