X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Ftrace.h;h=e6a3bc47f779799be7ccc54cc8f81195860a0715;hb=c55a9f585da53ea54ac458155fac3cdec1779d47;hp=dea9f70a40c72e84d424bf6f2315bf38abf829f2;hpb=d246b1115dbace6a7d67828cfd3fb1d5dc1c4f58;p=babeltrace.git diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h index dea9f70a..e6a3bc47 100644 --- a/include/babeltrace/ctf-ir/trace.h +++ b/include/babeltrace/ctf-ir/trace.h @@ -30,166 +30,846 @@ * http://www.efficios.com/ctf */ -#include +#include +#include +#include +#include +#include +#include #ifdef __cplusplus extern "C" { #endif +/** +@defgroup ctfirtraceclass CTF IR trace class +@ingroup ctfir +@brief CTF IR trace class. + +@code +#include +@endcode + +A CTF IR trace class is a descriptor of +traces. + +You can obtain a trace class in two different modes: + +- Normal mode: use bt_ctf_trace_create() to create a + default, empty trace class. +- CTF writer mode: use bt_ctf_writer_get_trace() to + get the trace class created by a given CTF writer object. + +A trace class has the following properties: + +- A \b name. +- A native byte order: all the + \link ctfirfieldtypes field types\endlink eventually part of the trace + class with a byte order set to #BT_CTF_BYTE_ORDER_NATIVE have this + "real" byte order. +- A \b UUID. +- An \b environment, which is a custom key-value mapping. Keys are + strings and values can be strings or integers. + +In the Babeltrace CTF IR system, a trace class contains zero or more +\link ctfirstreamclass stream classes\endlink, and a stream class +contains zero or more \link ctfireventclass event classes\endlink. You +can add an event class to a stream class with +bt_ctf_stream_class_add_event_class(). You can add a stream class to a +trace class with bt_ctf_trace_add_stream_class(). + +You can access the streams of a trace, that is, the streams which were +created from the trace's stream classes with bt_ctf_stream_create(), +with bt_ctf_trace_get_stream_by_index(). + +A trace class owns the trace packet header +\link ctfirfieldtypes field type\endlink, which represents the +\c trace.packet.header CTF scope. This field type describes the +trace packet header fields of the traces that this trace class +describes. + +The trace packet header field type \em must be a structure field type as +of Babeltrace \btversion. + +As per the CTF specification, the trace packet header field type \em +must contain a field named \c stream_id if the trace class contains more +than one stream class. + +As a reminder, here's the structure of a CTF packet: + +@imgpacketstructure + +A trace class also contains zero or more +\link ctfirclockclass CTF IR clock classes\endlink. + +@todo +Elaborate about clock classes irt clock values. + +As with any Babeltrace object, CTF IR trace class objects have +reference +counts. See \ref refs to learn more about the reference counting +management of Babeltrace objects. + +The following functions \em freeze their trace class parameter on +success: + +- bt_ctf_trace_add_stream_class() +- bt_ctf_writer_create_stream() + (\link ctfwriter CTF writer\endlink mode only) + +You cannot modify a frozen trace class: it is considered immutable, +except for: + +- Adding a stream class to it with + bt_ctf_trace_add_stream_class(). +- Adding a CTF IR clock class to it with bt_ctf_trace_add_clock_class(). +- \link refs Reference counting\endlink. + +@sa ctfirstreamclass +@sa ctfireventclass +@sa ctfirclockclass + +@file +@brief CTF IR trace class type and functions. +@sa ctfirtraceclass + +@addtogroup ctfirtraceclass +@{ +*/ + +/** +@struct bt_ctf_trace +@brief A CTF IR trace class. +@sa ctfirtraceclass +*/ struct bt_ctf_trace; struct bt_ctf_stream; struct bt_ctf_stream_class; -struct bt_ctf_clock; +struct bt_ctf_clock_class; -/* - * bt_ctf_trace_create: create a trace instance. - * - * Allocate a new trace. - * - * A trace's default packet header is a structure initialized with the following - * fields: - * - uint32_t magic - * - uint8_t uuid[16] - * - uint32_t stream_id - * - * Returns a new trace on success, NULL on error. - */ +/** +@name Creation function +@{ +*/ + +/** +@brief Creates a default CTF IR trace class. + +On success, the trace packet header field type of the created trace +class is an empty structure field type. You can modify this default +trace packet header field type after the trace class is created with +bt_ctf_trace_get_packet_header_type() and +bt_ctf_trace_set_packet_header_type(). + +The created trace class has the following initial properties: + +- Name: none. You can set a name + with bt_ctf_trace_set_name(). +- UUID: none. You can set a UUID with + bt_ctf_trace_set_uuid(). +- Native byte order: #BT_CTF_BYTE_ORDER_NATIVE. You + can set a native byte order with bt_ctf_trace_set_native_byte_order(). + + Note that you \em must set the native byte order if any field type + contained in the created trace class, in its stream classes, or in + its event classes, has a byte order set to #BT_CTF_BYTE_ORDER_NATIVE. +- Environment: empty. You can add environment entries + with bt_ctf_trace_set_environment_field(), + bt_ctf_trace_set_environment_field_integer(), and + bt_ctf_trace_set_environment_field_string(). + +@returns Created trace class, or \c NULL on error. + +@postsuccessrefcountret1 +*/ extern struct bt_ctf_trace *bt_ctf_trace_create(void); -/* - * bt_ctf_trace_create_stream: create a stream instance. - * - * Allocate a new stream instance and register it to the trace. The creation of - * a stream sets its reference count to 1. - * - * @param trace Trace instance. - * @param stream_class Stream class to instantiate. - * - * Returns a new stream on success, NULL on error. - */ -extern struct bt_ctf_stream *bt_ctf_trace_create_stream( - struct bt_ctf_trace *trace, - struct bt_ctf_stream_class *stream_class); +/** @} */ -/* - * bt_ctf_trace_add_environment_field: add an environment field to the trace. - * - * Add an environment field to the trace. The name and value parameters are - * copied. - * - * @param trace Trace instance. - * @param name Name of the environment field (will be copied). - * @param value Value of the environment field (will be copied). - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_trace_add_environment_field(struct bt_ctf_trace *trace, - const char *name, +/** +@name Properties functions +@{ +*/ + +/** +@brief Returns the name of the CTF IR trace class \p trace_class. + +On success, \p trace_class remains the sole owner of the returned +string. The returned string is valid as long as \p trace_class exists +and is not modified. + +@param[in] trace_class Trace class of which to get the name. +@returns Name of trace class \p trace_class, or + \c NULL if \p trace_class is unnamed or + on error. + +@prenotnull{trace_class} +@postrefcountsame{trace_class} + +@sa bt_ctf_trace_set_name(): Sets the name of a given trace class. +*/ +extern const char *bt_ctf_trace_get_name(struct bt_ctf_trace *trace_class); + +/** +@brief Sets the name of the CTF IR trace class \p trace_class + to \p name. + +@param[in] trace_class Trace class of which to set the name. +@param[in] name Name of the trace class (copied on success). +@returns 0 on success, or a negative value on error. + +@prenotnull{trace_class} +@prenotnull{name} +@prehot{trace_class} +@postrefcountsame{trace_class} + +@sa bt_ctf_trace_get_name(): Returns the name of a given trace class. +*/ +extern int bt_ctf_trace_set_name(struct bt_ctf_trace *trace_class, + const char *name); + +/** +@brief Returns the native byte order of the CTF IR trace class + \p trace_class. + +@param[in] trace_class Trace class of which to get the default byte + order. +@returns Native byte order of \p trace_class, + or #BT_CTF_BYTE_ORDER_UNKNOWN on error. + +@prenotnull{trace_class} +@postrefcountsame{trace_class} + +@sa bt_ctf_trace_set_native_byte_order(): Sets the native byte order of + a given trace class. +*/ +extern enum bt_ctf_byte_order bt_ctf_trace_get_native_byte_order( + struct bt_ctf_trace *trace_class); + +/** +@brief Sets the native byte order of the CTF IR trace class + \p trace_class to \p native_byte_order. + +\p native_byte_order \em must be one of: + +- #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN +- #BT_CTF_BYTE_ORDER_BIG_ENDIAN +- #BT_CTF_BYTE_ORDER_NETWORK + +@param[in] trace_class Trace class of which to set the native byte + order. +@param[in] native_byte_order Native byte order of the trace class. +@returns 0 on success, or a negative value on error. + +@prenotnull{trace_class} +@prehot{trace_class} +@pre \p native_byte_order is either #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN, + #BT_CTF_BYTE_ORDER_BIG_ENDIAN, or + #BT_CTF_BYTE_ORDER_NETWORK. +@postrefcountsame{trace_class} + +@sa bt_ctf_trace_get_native_byte_order(): Returns the native byte order of a + given trace class. +*/ +extern int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace_class, + enum bt_ctf_byte_order native_byte_order); + +/** +@brief Returns the UUID of the CTF IR trace class \p trace_class. + +On success, the return value is an array of 16 bytes. + +@param[in] trace_class Trace class of which to get the UUID. +@returns UUID of trace class \p trace_class, or + \c NULL if \p trace_class has no UUID or on error. + +@prenotnull{trace_class} +@postrefcountsame{trace_class} + +@sa bt_ctf_trace_set_uuid(): Sets the UUID of a given trace class. +*/ +extern const unsigned char *bt_ctf_trace_get_uuid( + struct bt_ctf_trace *trace_class); + +/** +@brief Sets the UUID of the CTF IR trace class \p trace_class to + \p uuid. + +\p uuid \em must be an array of 16 bytes. + +@param[in] trace_class Trace class of which to set the UUID. +@param[in] uuid UUID of the \p trace_class (copied on + success). +@returns 0 on success, or a negative value on error. + +@prenotnull{trace_class} +@prenotnull{uuid} +@prehot{trace_class} +@pre \p uuid is an array of 16 bytes. +@postrefcountsame{trace_class} + +@sa bt_ctf_trace_get_uuid(): Returns the UUID of a given trace class. +*/ +extern int bt_ctf_trace_set_uuid(struct bt_ctf_trace *trace_class, + const unsigned char *uuid); + +/** +@brief Returns the number of entries contained in the environment of + the CTF IR trace class \p trace_class. + +@param[in] trace_class Trace class of which to get the number + of environment entries. +@returns Number of environment entries + contained in \p trace_class, or + a negative value on error. + +@prenotnull{trace_class} +@postrefcountsame{trace_class} +*/ +extern int64_t bt_ctf_trace_get_environment_field_count( + struct bt_ctf_trace *trace_class); + +/** +@brief Returns the field name of the environment entry at index + \p index in the CTF IR trace class \p trace_class. + +On success, the returned string is valid as long as this trace class +exists and is \em not modified. \p trace_class remains the sole owner of +the returned string. + +@param[in] trace_class Trace class of which to get the name of the + environment entry at index \p index. +@param[in] index Index of environment entry to find. +@returns Name of the environment entry 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 environment entries in + \p trace_class (see bt_ctf_trace_get_environment_field_count()). +@postrefcountsame{trace_class} + +@sa bt_ctf_trace_get_environment_field_value_by_index(): Finds a trace class's + environment entry by index. +@sa bt_ctf_trace_get_environment_field_value_by_name(): Finds a trace + class's environment entry by name. +@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace + class's environment entry. +*/ +extern const char * +bt_ctf_trace_get_environment_field_name_by_index( + struct bt_ctf_trace *trace_class, uint64_t index); + +/** +@brief Returns the value of the environment entry at index + \p index in the CTF IR trace class \p trace_class. + +@param[in] trace_class Trace class of which to get the value of the + environment entry at index \p index. +@param[in] index Index of the environment entry to find. +@returns Value of the environment entry 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 environment entries in + \p trace_class (see bt_ctf_trace_get_environment_field_count()). +@postrefcountsame{trace_class} +@postsuccessrefcountretinc + +@sa bt_ctf_trace_get_environment_field_value_by_name(): Finds a trace + class's environment entry by name. +@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace + class's environment entry. +*/ +extern struct bt_value * +bt_ctf_trace_get_environment_field_value_by_index(struct bt_ctf_trace *trace_class, + uint64_t index); + +/** +@brief Returns the value of the environment entry named \p name + in the CTF IR trace class \p trace_class. + +@param[in] trace_class Trace class of which to get the value of the + environment entry named \p name. +@param[in] name Name of the environment entry to find. +@returns Value of the environment entry named \p name + in \p trace_class, or \c NULL if there's no such + entry or on error. + +@prenotnull{trace_class} +@prenotnull{name} +@postrefcountsame{trace_class} +@postsuccessrefcountretinc + +@sa bt_ctf_trace_get_environment_field_value_by_index(): Finds a trace class's + environment entry by index. +@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace + class's environment entry. +*/ +extern struct bt_value * +bt_ctf_trace_get_environment_field_value_by_name( + struct bt_ctf_trace *trace_class, const char *name); + +/** +@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 \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. +@returns 0 on success, or a negative value on error. + +@prenotnull{trace_class} +@prenotnull{name} +@prenotnull{value} +@prehot{trace_class} +@pre \p value is an + \link bt_value_integer_create() integer value object\endlink + or a + \link bt_value_string_create() string value object\endlink. +@postrefcountsame{trace_class} +@postsuccessrefcountinc{value} + +@sa bt_ctf_trace_get_environment_field_value_by_index(): Finds a trace class's + environment entry by index. +@sa bt_ctf_trace_get_environment_field_value_by_name(): Finds a trace + class's environment entry by name. +*/ +extern int bt_ctf_trace_set_environment_field( + struct bt_ctf_trace *trace_class, const char *name, + struct bt_value *value); + +/** +@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_integer_create() integer 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. +@returns 0 on success, or a negative value on error. + +@prenotnull{trace_class} +@prenotnull{name} +@prehot{trace_class} +@postrefcountsame{trace_class} + +@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace + class's environment entry. +*/ +extern int bt_ctf_trace_set_environment_field_integer( + struct bt_ctf_trace *trace_class, const char *name, + int64_t value); + +/** +@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_ctf_trace_set_environment_field(): Sets the value of a trace + class's environment entry. +*/ +extern int bt_ctf_trace_set_environment_field_string( + struct bt_ctf_trace *trace_class, const char *name, const char *value); -/* - * bt_ctf_trace_add_clock: add a clock to the trace. - * - * Add a clock to the trace. Clocks assigned to stream classes must be - * added to the trace beforehand. - * - * @param trace Trace instance. - * @param clock Clock to add to the trace. - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_trace_add_clock(struct bt_ctf_trace *trace, - struct bt_ctf_clock *clock); +/** @} */ -/* - * bt_ctf_trace_get_clock_count: get the number of clocks - * associated to the trace. - * - * @param trace Trace instance. - * - * Returns the clock count on success, a negative value on error. - */ -extern int bt_ctf_trace_get_clock_count(struct bt_ctf_trace *trace); +/** +@name Contained field types functions +@{ +*/ -/* - * bt_ctf_trace_get_clock: get a trace's clock at index. - * - * @param trace Trace instance. - * @param index Index of the clock in the given trace. - * - * Return a clock instance on success, NULL on error. - */ -extern struct bt_ctf_clock *bt_ctf_trace_get_clock( - struct bt_ctf_trace *trace, int index); +/** +@brief Returns the packet header field type of the CTF IR trace class + \p trace_class. -/* - * bt_ctf_trace_get_metadata_string: get metadata string. - * - * Get the trace's TSDL metadata. The caller assumes the ownership of the - * returned string. - * - * @param trace Trace instance. - * - * Returns the metadata string on success, NULL on error. - */ -extern char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace *trace); +@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. -/* - * bt_ctf_trace_set_byte_order: set a field type's byte order. - * - * Set the trace's byte order. Defaults to BT_CTF_BYTE_ORDER_NATIVE, - * the host machine's endianness. - * - * @param trace Trace instance. - * @param byte_order Trace's byte order. - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_trace_set_byte_order(struct bt_ctf_trace *trace, - enum bt_ctf_byte_order byte_order); +@prenotnull{trace_class} +@postrefcountsame{trace_class} +@post On success, if the return value is a field type, its + reference count is incremented. -/* - * bt_ctf_trace_get_packet_header_type: get a trace's packet header type. - * - * Get the trace's packet header type. - * - * @param trace Trace instance. - * - * Returns the trace's packet header type (a structure) on success, NULL on - * error. - */ +@sa bt_ctf_trace_set_packet_header_type(): Sets the packet + header field type of a given trace class. +*/ extern struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_type( - struct bt_ctf_trace *trace); + struct bt_ctf_trace *trace_class); -/* - * bt_ctf_trace_set_packet_header_type: set a trace's packet header type. - * - * Set the trace's packet header type. - * - * @param trace Trace instance. - * @param packet_header_type Packet header field type (must be a structure). - * - * Returns 0 on success, a negative value on error. - */ -extern int bt_ctf_trace_set_packet_header_type(struct bt_ctf_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 \p packet_header_type, if not \c NULL, is a CTF IR + structure field type. +@postrefcountsame{trace_class} +@post On success, if \p packet_header_type is not \c NULL, + the reference count of \p packet_header_type is incremented. + +@sa bt_ctf_trace_get_packet_header_type(): Returns the packet + header field type of a given trace class. +*/ +extern int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace *trace_class, struct bt_ctf_field_type *packet_header_type); -/* - * bt_ctf_trace_get and bt_ctf_trace_put: increment and decrement the - * trace's reference count. - * - * These functions ensure that the trace won't be destroyed while it - * is in use. The same number of get and put (plus one extra put to - * release the initial reference done at creation) have to be done to - * destroy a trace. - * - * When the trace's reference count is decremented to 0 by a - * bt_ctf_trace_put, the trace is freed. - * - * @param trace Trace instance. - */ -extern void bt_ctf_trace_get(struct bt_ctf_trace *trace); -extern void bt_ctf_trace_put(struct bt_ctf_trace *trace); +/** @} */ + +/** +@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_ctf_trace_get_clock_class_count( + struct bt_ctf_trace *trace_class); + +/** +@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_ctf_trace_get_clock_class_count()). +@postrefcountsame{trace_class} +@postsuccessrefcountretinc + +@sa bt_ctf_trace_get_clock_class_by_name(): Finds a clock class by name + in a given trace class. +@sa bt_ctf_trace_add_clock_class(): Adds a clock class to a trace class. +*/ +extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_index( + struct bt_ctf_trace *trace_class, uint64_t index); + +/** +@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_ctf_trace_get_clock_class_by_index(): Returns the clock class contained + in a given trace class at a given index. +@sa bt_ctf_trace_add_clock_class(): Adds a clock class to a trace class. +*/ +extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_name( + struct bt_ctf_trace *trace_class, const char *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 On success, if \p trace_class is frozen, + \p clock_class is frozen. + +@sa bt_ctf_trace_get_clock_class_by_index(): Returns the clock class contained + in a given trace class at a given index. +@sa bt_ctf_trace_get_clock_class_by_name(): Finds a clock class by name + in a given trace class. +*/ +extern int bt_ctf_trace_add_clock_class(struct bt_ctf_trace *trace_class, + struct bt_ctf_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_ctf_trace_get_stream_class_count( + struct bt_ctf_trace *trace_class); + +/** +@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_ctf_trace_get_stream_class_count()). +@postrefcountsame{trace_class} + +@sa bt_ctf_trace_get_stream_class_by_id(): Finds a stream class by ID. +@sa bt_ctf_trace_add_stream_class(): Adds a stream class to a trace class. +*/ +extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_index( + struct bt_ctf_trace *trace_class, uint64_t index); + +/** +@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_ctf_trace_get_stream_class_by_index(): Returns the stream class contained + in a given trace class at a given index. +@sa bt_ctf_trace_add_stream_class(): Adds a stream class to a trace class. +*/ +extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_id( + struct bt_ctf_trace *trace_class, uint64_t 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_ctf_trace_get_stream_class_by_index(): Returns the stream class contained + in a given trace class at a given index. +@sa bt_ctf_trace_get_stream_class_by_id(): Finds a stream class by ID. +*/ +extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace_class, + struct bt_ctf_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_ctf_trace_get_stream_count(struct bt_ctf_trace *trace_class); + +/** +@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_ctf_trace_get_stream_count()). +@postrefcountsame{trace_class} +*/ +extern struct bt_ctf_stream *bt_ctf_trace_get_stream_by_index( + struct bt_ctf_trace *trace_class, uint64_t 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_ctf_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_ctf_trace_set_is_static(): Makes a trace class static. +*/ +extern bt_bool bt_ctf_trace_is_static(struct bt_ctf_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_ctf_trace_add_stream_class() +- bt_ctf_trace_add_clock_class() + +You cannot create a stream with bt_ctf_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_ctf_trace_is_static(): Checks whether or not a given trace class + is static. +*/ +extern int bt_ctf_trace_set_is_static(struct bt_ctf_trace *trace_class); + +/** +@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_ctf_trace_visit(struct bt_ctf_trace *trace_class, + bt_ctf_visitor visitor, void *data); + +/** @} */ + +/** @} */ #ifdef __cplusplus }