2 * SPDX-License-Identifier: MIT
4 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
7 #ifndef _METADATA_DECODER_H
8 #define _METADATA_DECODER_H
14 #include <babeltrace2/babeltrace.h>
16 #include "common/macros.h"
17 #include "common/uuid.h"
19 struct ctf_trace_class;
21 /* A CTF metadata decoder object */
22 struct ctf_metadata_decoder;
24 /* CTF metadata decoder status */
25 enum ctf_metadata_decoder_status
27 CTF_METADATA_DECODER_STATUS_OK = 0,
28 CTF_METADATA_DECODER_STATUS_NONE = 1,
29 CTF_METADATA_DECODER_STATUS_ERROR = -1,
30 CTF_METADATA_DECODER_STATUS_INCOMPLETE = -2,
31 CTF_METADATA_DECODER_STATUS_INVAL_VERSION = -3,
32 CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR = -4,
35 /* Decoding configuration */
36 struct ctf_metadata_decoder_config
38 /* Active log level to use */
39 bt_logging_level log_level;
42 * Component or component class to use for logging (exactly one of
43 * them must be non-`NULL`); weak
45 bt_self_component *self_comp;
46 bt_self_component_class *self_comp_class;
48 /* Additional clock class offset to apply */
49 int64_t clock_class_offset_s;
50 int64_t clock_class_offset_ns;
51 bool force_clock_class_origin_unix_epoch;
53 /* True to create trace class objects */
54 bool create_trace_class;
57 * True to keep the plain text when content is appended with
58 * ctf_metadata_decoder_append_content().
64 * Creates a CTF metadata decoder.
66 * Returns `NULL` on error.
69 struct ctf_metadata_decoder *
70 ctf_metadata_decoder_create(const struct ctf_metadata_decoder_config *config);
73 * Destroys a CTF metadata decoder that you created with
74 * ctf_metadata_decoder_create().
77 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *metadata_decoder);
80 * Appends content to the metadata decoder.
82 * This function reads the metadata from the current position of `fp`
83 * until the end of this file stream.
85 * The metadata can be packetized or not.
87 * The metadata chunk needs to be complete and lexically scannable, that
88 * is, zero or more complete top-level blocks. If it's incomplete, this
89 * function returns `CTF_METADATA_DECODER_STATUS_INCOMPLETE`. If this
90 * function returns `CTF_METADATA_DECODER_STATUS_INCOMPLETE`, then you
91 * need to call it again with the _same_ metadata and more to make it
92 * complete. For example:
94 * First call: event { name = hell
95 * Second call: event { name = hello_world; ... };
97 * If everything goes as expected, this function returns
98 * `CTF_METADATA_DECODER_STATUS_OK`.
101 enum ctf_metadata_decoder_status
102 ctf_metadata_decoder_append_content(struct ctf_metadata_decoder *metadata_decoder, FILE *fp);
105 * Returns the trace IR trace class of this metadata decoder (new
108 * Returns `NULL` if there's none yet or if the metadata decoder is not
109 * configured to create trace classes.
112 bt_trace_class *ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder *mdec);
115 * Returns the CTF IR trace class of this metadata decoder.
117 * Returns `NULL` if there's none yet or if the metadata decoder is not
118 * configured to create trace classes.
121 struct ctf_trace_class *
122 ctf_metadata_decoder_borrow_ctf_trace_class(struct ctf_metadata_decoder *mdec);
125 * Checks whether or not a given metadata file stream `fp` is
126 * packetized, setting `is_packetized` accordingly on success. On
127 * success, also sets `*byte_order` to the byte order of the first
130 * This function uses `log_level` and `self_comp` for logging purposes.
131 * `self_comp` can be `NULL` if not available.
134 int ctf_metadata_decoder_is_packetized(FILE *fp, bool *is_packetized, int *byte_order,
135 bt_logging_level log_level, bt_self_component *self_comp);
138 * Returns the byte order of the decoder's metadata stream as set by the
139 * last call to ctf_metadata_decoder_append_content().
141 * Returns -1 if unknown (plain text content).
144 int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec);
147 * Returns the UUID of the decoder's metadata stream as set by the last
148 * call to ctf_metadata_decoder_append_content().
151 int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid);
154 * Returns the UUID of the decoder's trace class, if available.
158 * * `CTF_METADATA_DECODER_STATUS_OK`: success.
159 * * `CTF_METADATA_DECODER_STATUS_NONE`: no UUID.
160 * * `CTF_METADATA_DECODER_STATUS_INCOMPLETE`: missing metadata content.
163 enum ctf_metadata_decoder_status
164 ctf_metadata_decoder_get_trace_class_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid);
167 * Returns the metadata decoder's current metadata text.
170 const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder *mdec);
172 static inline bool ctf_metadata_decoder_is_packet_version_valid(unsigned int major,
175 return major == 1 && minor == 8;
178 #endif /* _METADATA_DECODER_H */