+/**
+@brief Sets the environment entry named \p name in the
+ CTF IR trace class \p trace_class to \p value.
+
+If an environment entry named \p name exists in \p trace_class, its
+value is first put, and then replaced by a new
+\link bt_value_string_create() string value object\endlink
+containing \p value.
+
+@param[in] trace_class Trace class of which to set the environment
+ entry.
+@param[in] name Name of the environment entry to set (copied
+ on success).
+@param[in] value Value of the environment entry named \p name
+ (copied on success).
+@returns 0 on success, or a negative value on error.
+
+@prenotnull{trace_class}
+@prenotnull{name}
+@prenotnull{value}
+@prehot{trace_class}
+@postrefcountsame{trace_class}
+
+@sa bt_trace_set_environment_field(): Sets the value of a trace
+ class's environment entry.
+*/
+extern int bt_trace_set_environment_field_string(
+ struct bt_trace *trace_class, const char *name,
+ const char *value);
+
+/** @} */
+
+/**
+@name Contained field types functions
+@{
+*/
+
+extern struct bt_field_type *bt_trace_borrow_packet_header_field_type(
+ struct bt_trace *trace_class);
+
+/**
+@brief Returns the packet header field type of the CTF IR trace class
+ \p trace_class.
+
+@param[in] trace_class Trace class of which to get the packet
+ header field type.
+@returns Packet header field type of \p trace_class,
+ or \c NULL if \p trace_class has no packet header field
+ type or on error.
+
+@prenotnull{trace_class}
+@postrefcountsame{trace_class}
+@post <strong>On success, if the return value is a field type</strong>, its
+ reference count is incremented.
+
+@sa bt_trace_set_packet_header_field_type(): Sets the packet
+ header field type of a given trace class.
+*/
+static inline
+struct bt_field_type *bt_trace_get_packet_header_field_type(
+ struct bt_trace *trace_class)
+{
+ return bt_get(bt_trace_borrow_packet_header_field_type(trace_class));
+}
+
+extern struct bt_packet_header_field *bt_trace_create_packet_header_field(
+ struct bt_trace *trace);
+
+/**
+@brief Sets the packet header field type of the CTF IR trace class
+ \p trace_class to \p packet_header_type, or unsets the current packet
+ header field type from \p trace_class.
+
+If \p packet_header_type is \c NULL, then this function unsets the current
+packet header field type from \p trace_class, effectively making \p trace_class
+a trace without a packet header field type.
+
+As of Babeltrace \btversion, if \p packet_header_type is not \c NULL,
+\p packet_header_type \em must be a CTF IR structure field type object.
+
+@param[in] trace_class Trace class of which to set the packet
+ header field type.
+@param[in] packet_header_type Packet header field type, or \c NULL to unset
+ the current packet header field type.
+@returns 0 on success, or a negative value on error.
+
+@prenotnull{trace_class}
+@prehot{trace_class}
+@pre <strong>\p packet_header_type, if not \c NULL</strong>, is a CTF IR
+ structure field type.
+@postrefcountsame{trace_class}
+@post <strong>On success, if \p packet_header_type is not \c NULL</strong>,
+ the reference count of \p packet_header_type is incremented.
+
+@sa bt_trace_get_packet_header_field_type(): Returns the packet
+ header field type of a given trace class.
+*/
+extern int bt_trace_set_packet_header_field_type(struct bt_trace *trace_class,
+ struct bt_field_type *packet_header_type);
+
+/** @} */
+
+/**
+@name Contained clock classes functions
+@{
+*/
+
+/**
+@brief Returns the number of CTF IR clock classes contained in the
+ CTF IR trace class \p trace_class.
+
+@param[in] trace_class Trace class of which to get the number
+ of contained clock classes.
+@returns Number of contained clock classes
+ contained in \p trace_class, or a negative
+ value on error.
+
+@prenotnull{trace_class}
+@postrefcountsame{trace_class}
+*/
+extern int64_t bt_trace_get_clock_class_count(
+ struct bt_trace *trace_class);
+
+extern struct bt_clock_class *bt_trace_borrow_clock_class_by_index(
+ struct bt_trace *trace_class, uint64_t index);
+
+/**
+@brief Returns the CTF IR clock class at index \p index in the CTF
+ IR trace class \p trace_class.
+
+@param[in] trace_class Trace class of which to get the clock class
+ contained at index \p index.
+@param[in] index Index of the clock class to find in
+ \p trace_class.
+@returns Clock class at index \p index in \p trace_class,
+ or \c NULL on error.
+
+@prenotnull{trace_class}
+@pre \p index is lesser than the number of clock classes contained in
+ the trace class \p trace_class (see
+ bt_trace_get_clock_class_count()).
+@postrefcountsame{trace_class}
+@postsuccessrefcountretinc
+
+@sa bt_trace_get_clock_class_by_name(): Finds a clock class by name
+ in a given trace class.
+@sa bt_trace_add_clock_class(): Adds a clock class to a trace class.
+*/
+static inline
+struct bt_clock_class *bt_trace_get_clock_class_by_index(
+ struct bt_trace *trace_class, uint64_t index)
+{
+ return bt_get(bt_trace_borrow_clock_class_by_index(
+ trace_class, index));
+}
+
+extern struct bt_clock_class *bt_trace_borrow_clock_class_by_name(
+ struct bt_trace *trace_class, const char *name);
+
+/**
+@brief Returns the CTF IR clock class named \c name found in the CTF
+ IR trace class \p trace_class.
+
+@param[in] trace_class Trace class of which to get the clock class
+ named \p name.
+@param[in] name Name of the clock class to find in \p trace_class.
+@returns Clock class named \p name in \p trace_class,
+ or \c NULL on error.
+
+@prenotnull{trace_class}
+@prenotnull{name}
+@postrefcountsame{trace_class}
+@postsuccessrefcountretinc
+
+@sa bt_trace_get_clock_class_by_index(): Returns the clock class contained
+ in a given trace class at a given index.
+@sa bt_trace_add_clock_class(): Adds a clock class to a trace class.
+*/
+static inline
+struct bt_clock_class *bt_trace_get_clock_class_by_name(
+ struct bt_trace *trace_class, const char *name)
+{
+ return bt_get(bt_trace_borrow_clock_class_by_name(trace_class, name));
+}
+
+/**
+@brief Adds the CTF IR clock class \p clock_class to the CTF IR
+ trace class \p trace_class.
+
+On success, \p trace_class contains \p clock_class.
+
+You can call this function even if \p trace_class or \p clock_class
+are frozen.
+
+@param[in] trace_class Trace class to which to add \p clock_class.
+@param[in] clock_class Clock class to add to \p trace_class.
+@returns 0 on success, or a negative value on error.
+
+@prenotnull{trace_class}
+@prenotnull{clock_class}
+@postrefcountsame{trace_class}
+@postsuccessrefcountinc{clock_class}
+@post <strong>On success, if \p trace_class is frozen</strong>,
+ \p clock_class is frozen.
+
+@sa bt_trace_get_clock_class_by_index(): Returns the clock class contained
+ in a given trace class at a given index.
+@sa bt_trace_get_clock_class_by_name(): Finds a clock class by name
+ in a given trace class.
+*/
+extern int bt_trace_add_clock_class(struct bt_trace *trace_class,
+ struct bt_clock_class *clock_class);
+
+/** @} */
+
+/**
+@name Stream class children functions
+@{
+*/
+
+/**
+@brief Returns the number of stream classes contained in the
+ CTF IR trace class \p trace_class.
+
+@param[in] trace_class Trace class of which to get the number
+ of children stream classes.
+@returns Number of children stream classes
+ contained in \p trace_class, or a negative
+ value on error.
+
+@prenotnull{trace_class}
+@postrefcountsame{trace_class}
+*/
+extern int64_t bt_trace_get_stream_class_count(
+ struct bt_trace *trace_class);
+
+extern struct bt_stream_class *bt_trace_borrow_stream_class_by_index(
+ struct bt_trace *trace_class, uint64_t index);
+
+/**
+@brief Returns the stream class at index \p index in the CTF IR trace
+ class \p trace_class.
+
+@param[in] trace_class Trace class of which to get the stream class.
+@param[in] index Index of the stream class to find.
+@returns Stream class at index \p index, or \c NULL
+ on error.
+
+@prenotnull{trace_class}
+@pre \p index is lesser than the number of stream classes contained in
+ the trace class \p trace_class (see
+ bt_trace_get_stream_class_count()).
+@postrefcountsame{trace_class}
+
+@sa bt_trace_get_stream_class_by_id(): Finds a stream class by ID.
+@sa bt_trace_add_stream_class(): Adds a stream class to a trace class.
+*/
+static inline
+struct bt_stream_class *bt_trace_get_stream_class_by_index(
+ struct bt_trace *trace_class, uint64_t index)
+{
+ return bt_get(bt_trace_borrow_stream_class_by_index(
+ trace_class, index));
+}
+
+extern struct bt_stream_class *bt_trace_borrow_stream_class_by_id(
+ struct bt_trace *trace_class, uint64_t id);
+
+/**
+@brief Returns the stream class with ID \c id found in the CTF IR
+ trace class \p trace_class.
+
+@param[in] trace_class Trace class of which to get the stream class.
+@param[in] id ID of the stream class to find.
+@returns Stream class with ID \p id, or \c NULL
+ on error.
+
+@prenotnull{trace_class}
+@postrefcountsame{trace_class}
+@postsuccessrefcountretinc
+
+@sa bt_trace_get_stream_class_by_index(): Returns the stream class contained
+ in a given trace class at a given index.
+@sa bt_trace_add_stream_class(): Adds a stream class to a trace class.
+*/
+static inline
+struct bt_stream_class *bt_trace_get_stream_class_by_id(
+ struct bt_trace *trace_class, uint64_t id)
+{
+ return bt_get(bt_trace_borrow_stream_class_by_id(trace_class, id));
+}
+
+/**
+@brief Adds the CTF IR stream class \p stream_class to the
+ CTF IR trace class \p trace_class.
+
+On success, \p stream_class becomes the child of \p trace_class.
+
+You can only add a given stream class to one trace class.
+
+You can call this function even if \p trace_class is frozen.
+
+This function tries to resolve the needed
+\link ctfirfieldtypes CTF IR field type\endlink of the dynamic field
+types that are found anywhere in the root field types of
+\p stream_class and of all its currently contained
+\link ctfireventclass CTF IR event classes\endlink. If any automatic
+resolving fails, then this function fails.
+
+@param[in] trace_class Trace class to which to add \p stream_class.
+@param[in] stream_class Stream class to add to \p trace_class.
+@returns 0 on success, or a negative value on error.
+
+@prenotnull{trace_class}
+@prenotnull{stream_class}
+@postrefcountsame{trace_class}
+@postsuccessrefcountinc{stream_class}
+@postsuccessfrozen{stream_class}
+
+@sa bt_trace_get_stream_class_by_index(): Returns the stream class contained
+ in a given trace class at a given index.
+@sa bt_trace_get_stream_class_by_id(): Finds a stream class by ID.
+*/
+extern int bt_trace_add_stream_class(struct bt_trace *trace_class,
+ struct bt_stream_class *stream_class);
+
+/** @} */
+
+/**
+@name Stream children functions
+@{
+*/
+
+/**
+@brief Returns the number of streams contained in the CTF IR trace
+ class \p trace_class.
+
+@param[in] trace_class Trace class of which to get the number
+ of children streams.
+@returns Number of children streams
+ contained in \p trace_class, or a negative
+ value on error.
+
+@prenotnull{trace_class}
+@postrefcountsame{trace_class}
+*/
+extern int64_t bt_trace_get_stream_count(struct bt_trace *trace_class);
+
+extern struct bt_stream *bt_trace_borrow_stream_by_index(
+ struct bt_trace *trace_class, uint64_t index);
+
+/**
+@brief Returns the stream at index \p index in the CTF IR trace
+ class \p trace_class.
+
+@param[in] trace_class Trace class of which to get the stream.
+@param[in] index Index of the stream to find.
+@returns Stream at index \p index, or \c NULL
+ on error.
+
+@prenotnull{trace_class}
+@pre \p index is lesser than the number of streams contained in
+ the trace class \p trace_class (see
+ bt_trace_get_stream_count()).
+@postrefcountsame{trace_class}
+*/
+static inline
+struct bt_stream *bt_trace_get_stream_by_index(
+ struct bt_trace *trace_class, uint64_t index)
+{
+ return bt_get(bt_trace_borrow_stream_by_index(trace_class, index));
+}
+
+/** @} */
+
+/**
+@name Misc. functions
+@{
+*/
+
+/**
+@brief Returns whether or not the CTF IR trace class \p trace_class
+ is static.
+
+It is guaranteed that a static trace class will never contain new
+streams, stream classes, or clock classes. A static class is always
+frozen.
+
+This function returns #BT_TRUE if bt_trace_set_is_static() was
+previously called on it.
+
+@param[in] trace_class Trace class to check.
+@returns #BT_TRUE if \p trace_class is static,
+
+@sa bt_trace_set_is_static(): Makes a trace class static.
+*/
+extern bt_bool bt_trace_is_static(struct bt_trace *trace_class);
+
+/**
+@brief Makes the CTF IR trace class \p trace_class static.
+
+A static trace class is frozen and you cannot call any modifying
+function on it:
+
+- bt_trace_add_stream_class()
+- bt_trace_add_clock_class()
+- bt_trace_set_environment_field()
+- bt_trace_set_environment_field_integer()
+- bt_trace_set_environment_field_string()
+- bt_trace_add_is_static_listener()
+
+You cannot create a stream with bt_stream_create() with any of the
+stream classes of a static trace class.
+
+@param[in] trace_class Trace class to make static.
+@returns 0 on success, or a negative value on error.
+
+@prenotnull{trace_class}
+@postrefcountsame{trace_class}
+@postsuccessfrozen{trace_class}
+
+@sa bt_trace_is_static(): Checks whether or not a given trace class
+ is static.
+@sa bt_trace_add_is_static_listener(): Adds a listener to a trace
+ class which is called when the trace class is made static.
+*/
+extern int bt_trace_set_is_static(struct bt_trace *trace_class);
+
+/**
+@brief Adds the listener \p listener to the CTF IR trace class
+ \p trace_class which is called when the trace is made static.
+
+\p listener is called with \p data, the user data, the first time
+bt_trace_set_is_static() is called on \p trace_class.
+
+When the trace is destroyed, or when you remove the added listener with
+bt_trace_remove_is_static_listener(), \p listener_removed is called
+if it's not \c NULL. You can use \p listener_removed to free any dynamic
+data which exists only for the added listener. You cannot call
+any function which modifies \p trace_class during the execution of
+\p listener_removed, including bt_trace_remove_is_static_listener().
+
+This function fails if \p trace_class is already static: you need to
+check the condition first with bt_trace_is_static().
+
+On success, this function returns a unique numeric identifier for this
+listener within \p trace. You can use this identifier to remove the
+specific listener you added with
+bt_trace_remove_is_static_listener().
+
+@param[in] trace_class Trace class to which to add the
+ listener.
+@param[in] listener Listener to add to \p trace_class.
+@param[in] listener_removed Remove listener called when \p listener
+ is removed from \p trace_class, or
+ \c NULL if you don't need a remove
+ listener.
+@param[in] data User data passed when \p listener or
+ \p listener_removed is called.
+@returns A unique numeric identifier for this
+ listener on success (0 or greater), or a
+ negative value on error.
+
+@prenotnull{trace_class}
+@prenotnull{listener}
+@pre \p trace_class is not static.
+@postrefcountsame{trace_class}
+
+@sa bt_trace_remove_is_static_listener(): Removes a "trace is
+ static" listener from a trace class previously added with this
+ function.
+@sa bt_trace_is_static(): Checks whether or not a given trace class
+ is static.
+@sa bt_trace_set_is_static(): Makes a trace class static.
+*/
+extern int bt_trace_add_is_static_listener(
+ struct bt_trace *trace_class,
+ bt_trace_is_static_listener listener,
+ bt_trace_listener_removed listener_removed, void *data);
+
+/**
+@brief Removes the "trace is static" listener identified by
+ \p listener_id from the trace class \p trace_class.
+
+@param[in] trace_class Trace class from which to remove the listener
+ identified by \p listener_id.
+@param[in] listener_id Identifier of the listener to remove from
+ \p trace_class.
+@returns 0 if this function removed the listener, or
+ a negative value on error.
+
+@prenotnull{trace_class}
+@pre \p listener_id is the identifier of a listener that you previously
+ added with bt_trace_add_is_static_listener() and did not
+ already remove with this function.
+@postrefcountsame{trace_class}
+
+@sa bt_trace_add_is_static_listener(): Adds a listener to a trace
+ class which is called when the trace class is made static.
+*/
+extern int bt_trace_remove_is_static_listener(
+ struct bt_trace *trace_class, int listener_id);
+
+/**
+@brief Accepts the visitor \p visitor to visit the hierarchy of the
+ CTF IR trace class \p trace_class.
+
+This function traverses the hierarchy of \p trace_class in pre-order
+and calls \p visitor on each element.
+
+The trace class itself is visited first, then, for each children stream
+class, the stream class itself, and all its children event classes.
+
+@param[in] trace_class Trace class to visit.
+@param[in] visitor Visiting function.
+@param[in] data User data.
+@returns 0 on success, or a negative value on error.
+
+@prenotnull{trace_class}
+@prenotnull{visitor}
+*/
+extern int bt_trace_visit(struct bt_trace *trace_class,
+ bt_visitor visitor, void *data);
+
+/** @} */
+
+/** @} */