2 * SPDX-License-Identifier: MIT
4 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
7 #ifndef _METADATA_DECODER_H
8 #define _METADATA_DECODER_H
13 #include <babeltrace2/babeltrace.h>
15 #include "common/uuid.h"
17 /* CTF metadata decoder status */
18 enum ctf_metadata_decoder_status
20 CTF_METADATA_DECODER_STATUS_OK = 0,
21 CTF_METADATA_DECODER_STATUS_NONE = 1,
22 CTF_METADATA_DECODER_STATUS_ERROR = -1,
23 CTF_METADATA_DECODER_STATUS_INCOMPLETE = -2,
24 CTF_METADATA_DECODER_STATUS_INVAL_VERSION = -3,
25 CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR = -4,
28 /* Decoding configuration */
29 struct ctf_metadata_decoder_config
31 /* Active log level to use */
32 bt_logging_level log_level;
35 * Component or component class to use for logging (exactly one of
36 * them must be non-`NULL`); weak
38 bt_self_component *self_comp;
39 bt_self_component_class *self_comp_class;
41 /* Additional clock class offset to apply */
42 int64_t clock_class_offset_s;
43 int64_t clock_class_offset_ns;
44 bool force_clock_class_origin_unix_epoch;
46 /* True to create trace class objects */
47 bool create_trace_class;
50 * True to keep the plain text when content is appended with
51 * ctf_metadata_decoder_append_content().
57 * Creates a CTF metadata decoder.
59 * Returns `NULL` on error.
61 struct ctf_metadata_decoder *
62 ctf_metadata_decoder_create(const struct ctf_metadata_decoder_config *config);
65 * Destroys a CTF metadata decoder that you created with
66 * ctf_metadata_decoder_create().
68 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder *metadata_decoder);
71 * Appends content to the metadata decoder.
73 * This function reads the metadata from the current position of `fp`
74 * until the end of this file stream.
76 * The metadata can be packetized or not.
78 * The metadata chunk needs to be complete and lexically scannable, that
79 * is, zero or more complete top-level blocks. If it's incomplete, this
80 * function returns `CTF_METADATA_DECODER_STATUS_INCOMPLETE`. If this
81 * function returns `CTF_METADATA_DECODER_STATUS_INCOMPLETE`, then you
82 * need to call it again with the _same_ metadata and more to make it
83 * complete. For example:
85 * First call: event { name = hell
86 * Second call: event { name = hello_world; ... };
88 * If everything goes as expected, this function returns
89 * `CTF_METADATA_DECODER_STATUS_OK`.
91 enum ctf_metadata_decoder_status
92 ctf_metadata_decoder_append_content(struct ctf_metadata_decoder *metadata_decoder, FILE *fp);
95 * Returns the trace IR trace class of this metadata decoder (new
98 * Returns `NULL` if there's none yet or if the metadata decoder is not
99 * configured to create trace classes.
101 bt_trace_class *ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder *mdec);
104 * Returns the CTF IR trace class of this metadata decoder.
106 * Returns `NULL` if there's none yet or if the metadata decoder is not
107 * configured to create trace classes.
109 struct ctf_trace_class *
110 ctf_metadata_decoder_borrow_ctf_trace_class(struct ctf_metadata_decoder *mdec);
113 * Checks whether or not a given metadata file stream `fp` is
114 * packetized, setting `is_packetized` accordingly on success. On
115 * success, also sets `*byte_order` to the byte order of the first
118 * This function uses `log_level` and `self_comp` for logging purposes.
119 * `self_comp` can be `NULL` if not available.
121 int ctf_metadata_decoder_is_packetized(FILE *fp, bool *is_packetized, int *byte_order,
122 bt_logging_level log_level, bt_self_component *self_comp);
125 * Returns the byte order of the decoder's metadata stream as set by the
126 * last call to ctf_metadata_decoder_append_content().
128 * Returns -1 if unknown (plain text content).
130 int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder *mdec);
133 * Returns the UUID of the decoder's metadata stream as set by the last
134 * call to ctf_metadata_decoder_append_content().
136 int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid);
139 * Returns the UUID of the decoder's trace class, if available.
143 * * `CTF_METADATA_DECODER_STATUS_OK`: success.
144 * * `CTF_METADATA_DECODER_STATUS_NONE`: no UUID.
145 * * `CTF_METADATA_DECODER_STATUS_INCOMPLETE`: missing metadata content.
147 enum ctf_metadata_decoder_status
148 ctf_metadata_decoder_get_trace_class_uuid(struct ctf_metadata_decoder *mdec, bt_uuid_t uuid);
151 * Returns the metadata decoder's current metadata text.
153 const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder *mdec);
155 static inline bool ctf_metadata_decoder_is_packet_version_valid(unsigned int major,
158 return major == 1 && minor == 8;
161 #endif /* _METADATA_DECODER_H */