Commit | Line | Data |
---|---|---|
1e649dff | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
1e649dff | 3 | * |
0235b0db | 4 | * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com> |
1e649dff PP |
5 | */ |
6 | ||
0235b0db MJ |
7 | #ifndef _METADATA_DECODER_H |
8 | #define _METADATA_DECODER_H | |
9 | ||
c802cacb | 10 | #include <stdint.h> |
087cd0f5 | 11 | #include <stdio.h> |
1e649dff | 12 | |
3fadfbc0 | 13 | #include <babeltrace2/babeltrace.h> |
1e649dff | 14 | |
06be9946 | 15 | #include "common/uuid.h" |
0f5c5d5c SM |
16 | #include "cpp-common/bt2c/logging.hpp" |
17 | #include "cpp-common/vendor/fmt/format.h" /* IWYU pragma: keep */ | |
06be9946 | 18 | |
1e649dff | 19 | /* CTF metadata decoder status */ |
4164020e SM |
20 | enum ctf_metadata_decoder_status |
21 | { | |
22 | CTF_METADATA_DECODER_STATUS_OK = 0, | |
23 | CTF_METADATA_DECODER_STATUS_NONE = 1, | |
24 | CTF_METADATA_DECODER_STATUS_ERROR = -1, | |
25 | CTF_METADATA_DECODER_STATUS_INCOMPLETE = -2, | |
26 | CTF_METADATA_DECODER_STATUS_INVAL_VERSION = -3, | |
27 | CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR = -4, | |
1e649dff PP |
28 | }; |
29 | ||
0f5c5d5c SM |
30 | inline const char *format_as(ctf_metadata_decoder_status status) noexcept |
31 | { | |
32 | switch (status) { | |
33 | case CTF_METADATA_DECODER_STATUS_OK: | |
34 | return "CTF_METADATA_DECODER_STATUS_OK"; | |
35 | ||
36 | case CTF_METADATA_DECODER_STATUS_NONE: | |
37 | return "CTF_METADATA_DECODER_STATUS_NONE"; | |
38 | ||
39 | case CTF_METADATA_DECODER_STATUS_ERROR: | |
40 | return "CTF_METADATA_DECODER_STATUS_ERROR"; | |
41 | ||
42 | case CTF_METADATA_DECODER_STATUS_INCOMPLETE: | |
43 | return "CTF_METADATA_DECODER_STATUS_INCOMPLETE"; | |
44 | ||
45 | case CTF_METADATA_DECODER_STATUS_INVAL_VERSION: | |
46 | return "CTF_METADATA_DECODER_STATUS_INVAL_VERSION"; | |
47 | ||
48 | case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR: | |
49 | return "CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR"; | |
50 | } | |
51 | ||
52 | bt_common_abort(); | |
53 | } | |
54 | ||
a2a54545 | 55 | /* Decoding configuration */ |
4164020e SM |
56 | struct ctf_metadata_decoder_config |
57 | { | |
0f5c5d5c SM |
58 | explicit ctf_metadata_decoder_config(const bt2c::Logger& parentLogger) : |
59 | logger {parentLogger, "PLUGIN/CTF/META/DECODER-CONFIG"} | |
60 | { | |
61 | } | |
4164020e | 62 | |
0f5c5d5c SM |
63 | bt2c::Logger logger; |
64 | ||
65 | /* Weak, used to create a bt_trace_class, if not nullptr. */ | |
afb0f12b | 66 | bt_self_component *self_comp = nullptr; |
4164020e SM |
67 | |
68 | /* Additional clock class offset to apply */ | |
afb0f12b SM |
69 | int64_t clock_class_offset_s = 0; |
70 | int64_t clock_class_offset_ns = 0; | |
71 | bool force_clock_class_origin_unix_epoch = false; | |
4164020e SM |
72 | |
73 | /* True to create trace class objects */ | |
afb0f12b | 74 | bool create_trace_class = false; |
4164020e SM |
75 | |
76 | /* | |
77 | * True to keep the plain text when content is appended with | |
78 | * ctf_metadata_decoder_append_content(). | |
79 | */ | |
afb0f12b | 80 | bool keep_plain_text = false; |
a2a54545 PP |
81 | }; |
82 | ||
1fa280c9 SM |
83 | struct ctf_metadata_decoder_deleter |
84 | { | |
85 | void operator()(struct ctf_metadata_decoder *decoder); | |
86 | }; | |
87 | ||
88 | using ctf_metadata_decoder_up = std::unique_ptr<ctf_metadata_decoder, ctf_metadata_decoder_deleter>; | |
89 | ||
1e649dff | 90 | /* |
862ca4ed | 91 | * Creates a CTF metadata decoder. |
1e649dff PP |
92 | * |
93 | * Returns `NULL` on error. | |
94 | */ | |
1fa280c9 | 95 | ctf_metadata_decoder_up |
4164020e | 96 | ctf_metadata_decoder_create(const struct ctf_metadata_decoder_config *config); |
1e649dff PP |
97 | |
98 | /* | |
99 | * Destroys a CTF metadata decoder that you created with | |
100 | * ctf_metadata_decoder_create(). | |
101 | */ | |
4164020e | 102 | void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *metadata_decoder); |
1e649dff PP |
103 | |
104 | /* | |
06be9946 | 105 | * Appends content to the metadata decoder. |
1e649dff PP |
106 | * |
107 | * This function reads the metadata from the current position of `fp` | |
06be9946 | 108 | * until the end of this file stream. |
1e649dff PP |
109 | * |
110 | * The metadata can be packetized or not. | |
111 | * | |
06be9946 PP |
112 | * The metadata chunk needs to be complete and lexically scannable, that |
113 | * is, zero or more complete top-level blocks. If it's incomplete, this | |
1e649dff PP |
114 | * function returns `CTF_METADATA_DECODER_STATUS_INCOMPLETE`. If this |
115 | * function returns `CTF_METADATA_DECODER_STATUS_INCOMPLETE`, then you | |
06be9946 | 116 | * need to call it again with the _same_ metadata and more to make it |
1e649dff PP |
117 | * complete. For example: |
118 | * | |
119 | * First call: event { name = hell | |
120 | * Second call: event { name = hello_world; ... }; | |
121 | * | |
1e649dff PP |
122 | * If everything goes as expected, this function returns |
123 | * `CTF_METADATA_DECODER_STATUS_OK`. | |
124 | */ | |
4164020e SM |
125 | enum ctf_metadata_decoder_status |
126 | ctf_metadata_decoder_append_content(struct ctf_metadata_decoder *metadata_decoder, FILE *fp); | |
1e649dff | 127 | |
06be9946 PP |
128 | /* |
129 | * Returns the trace IR trace class of this metadata decoder (new | |
130 | * reference). | |
131 | * | |
132 | * Returns `NULL` if there's none yet or if the metadata decoder is not | |
133 | * configured to create trace classes. | |
134 | */ | |
4164020e | 135 | bt_trace_class *ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder *mdec); |
44c440bc | 136 | |
06be9946 PP |
137 | /* |
138 | * Returns the CTF IR trace class of this metadata decoder. | |
139 | * | |
140 | * Returns `NULL` if there's none yet or if the metadata decoder is not | |
141 | * configured to create trace classes. | |
142 | */ | |
4164020e SM |
143 | struct ctf_trace_class * |
144 | ctf_metadata_decoder_borrow_ctf_trace_class(struct ctf_metadata_decoder *mdec); | |
1e649dff PP |
145 | |
146 | /* | |
06be9946 PP |
147 | * Checks whether or not a given metadata file stream `fp` is |
148 | * packetized, setting `is_packetized` accordingly on success. On | |
149 | * success, also sets `*byte_order` to the byte order of the first | |
150 | * packet. | |
1e649dff | 151 | */ |
4164020e | 152 | int ctf_metadata_decoder_is_packetized(FILE *fp, bool *is_packetized, int *byte_order, |
0f5c5d5c | 153 | const bt2c::Logger& logger); |
1e649dff PP |
154 | |
155 | /* | |
06be9946 PP |
156 | * Returns the byte order of the decoder's metadata stream as set by the |
157 | * last call to ctf_metadata_decoder_append_content(). | |
158 | * | |
159 | * Returns -1 if unknown (plain text content). | |
1e649dff | 160 | */ |
06be9946 PP |
161 | int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec); |
162 | ||
163 | /* | |
164 | * Returns the UUID of the decoder's metadata stream as set by the last | |
165 | * call to ctf_metadata_decoder_append_content(). | |
1a6da3f9 | 166 | */ |
4164020e | 167 | int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid); |
1a6da3f9 PP |
168 | |
169 | /* | |
170 | * Returns the UUID of the decoder's trace class, if available. | |
06be9946 | 171 | * |
1a6da3f9 PP |
172 | * Returns: |
173 | * | |
174 | * * `CTF_METADATA_DECODER_STATUS_OK`: success. | |
175 | * * `CTF_METADATA_DECODER_STATUS_NONE`: no UUID. | |
176 | * * `CTF_METADATA_DECODER_STATUS_INCOMPLETE`: missing metadata content. | |
06be9946 | 177 | */ |
4164020e SM |
178 | enum ctf_metadata_decoder_status |
179 | ctf_metadata_decoder_get_trace_class_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid); | |
06be9946 PP |
180 | |
181 | /* | |
182 | * Returns the metadata decoder's current metadata text. | |
183 | */ | |
06be9946 | 184 | const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder *mdec); |
1e649dff | 185 | |
4164020e SM |
186 | static inline bool ctf_metadata_decoder_is_packet_version_valid(unsigned int major, |
187 | unsigned int minor) | |
3c8252a5 | 188 | { |
4164020e | 189 | return major == 1 && minor == 8; |
3c8252a5 PP |
190 | } |
191 | ||
1e649dff | 192 | #endif /* _METADATA_DECODER_H */ |