X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Ftrace.h;h=949672266188b879f6faabe658d82c1890312a8b;hp=07daabe3adf7fac6c9da0d979a26e9d94181ee7d;hb=312c056ae3d374b253fa0cfe5ed576c0b0e5e569;hpb=b2e0c9076135f47110af2d96dfaee397c597bc90 diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h index 07daabe3..94967226 100644 --- a/include/babeltrace/ctf-ir/trace.h +++ b/include/babeltrace/ctf-ir/trace.h @@ -30,10 +30,14 @@ * http://www.efficios.com/ctf */ -#include +/* For bt_get() */ +#include + +/* For bt_visitor */ #include -#include -#include + +/* For bt_bool */ +#include #include #ifdef __cplusplus @@ -54,18 +58,19 @@ traces. You can obtain a trace class in two different modes: -- Normal mode: use bt_ctf_trace_create() to create a +- Normal mode: use bt_trace_create() to create a default, empty trace class. -- CTF writer mode: use bt_ctf_writer_get_trace() to +- CTF writer mode: use bt_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 default byte order: all the +- 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 + class with a byte order set to #BT_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. @@ -73,8 +78,12 @@ 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(). +bt_stream_class_add_event_class(). You can add a stream class to a +trace class with bt_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_stream_create(), +with bt_trace_get_stream_by_index(). A trace class owns the trace packet header \link ctfirfieldtypes field type\endlink, which represents the @@ -94,7 +103,7 @@ As a reminder, here's the structure of a CTF packet: @imgpacketstructure A trace class also contains zero or more -\link ctfirclockclass clock classes\endlink. +\link ctfirclockclass CTF IR clock classes\endlink. @todo Elaborate about clock classes irt clock values. @@ -107,23 +116,18 @@ 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() +- bt_trace_add_stream_class() +- bt_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 clock class to it with bt_ctf_trace_add_clock_class(). + bt_trace_add_stream_class(). +- Adding a CTF IR clock class to it with bt_trace_add_clock_class(). - \link refs Reference counting\endlink. -You can add a custom listener with bt_ctf_trace_add_listener() to get -notified if anything changes in a trace class, that is, if an event -class is added to one of its stream class, if a stream class is added, -or if a clock class is added. - @sa ctfirstreamclass @sa ctfireventclass @sa ctfirclockclass @@ -137,14 +141,45 @@ or if a clock class is added. */ /** -@struct bt_ctf_trace +@struct bt_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_class; +struct bt_trace; +struct bt_stream; +struct bt_stream_class; +struct bt_clock_class; +struct bt_field_type; +struct bt_value; +struct bt_packet_header_field; + +/** +@brief User function type to use with + bt_trace_add_is_static_listener(). + +@param[in] trace_class Trace class which is now static. +@param[in] data User data as passed to + bt_trace_add_is_static_listener() when + you added the listener. + +@prenotnull{trace_class} +*/ +typedef void (* bt_trace_is_static_listener)( + struct bt_trace *trace_class, void *data); + +/** +@brief User function type to use with + bt_trace_add_is_static_listener(). + +@param[in] trace_class Trace class to which the listener was added. +@param[in] data User data as passed to + bt_trace_add_is_static_listener() when + you added the listener. + +@prenotnull{trace_class} +*/ +typedef void (* bt_trace_listener_removed)( + struct bt_trace *trace_class, void *data); /** @name Creation function @@ -155,36 +190,30 @@ struct bt_ctf_clock_class; @brief Creates a default CTF IR trace class. On success, the trace packet header field type of the created trace -class has the following fields: - -- magic: a 32-bit unsigned integer field type. -- uuid: an array field type of 16 8-bit unsigned integer - field types. -- stream_id: a 32-bit unsigned integer field type. - -You can modify this default trace packet header field type after the -trace class is created with bt_ctf_trace_set_packet_header_type(). +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_trace_get_packet_header_field_type() and +bt_trace_set_packet_header_field_type(). The created trace class has the following initial properties: - Name: none. You can set a name - with bt_ctf_trace_set_name(). -- Default byte order: #BT_CTF_BYTE_ORDER_NATIVE. You - can set a default byte order with bt_ctf_trace_set_byte_order(). - - Note that you \em must set the default 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. + with bt_trace_set_name(). +- UUID: none. You can set a UUID with + bt_trace_set_uuid(). +- Native byte order: #BT_BYTE_ORDER_UNSPECIFIED. + You can set a native byte order with + bt_trace_set_native_byte_order(). - 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(). + with bt_trace_set_environment_field(), + bt_trace_set_environment_field_integer(), and + bt_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); +extern struct bt_trace *bt_trace_create(void); /** @} */ @@ -208,9 +237,9 @@ and is not modified. @prenotnull{trace_class} @postrefcountsame{trace_class} -@sa bt_ctf_trace_set_name(): Sets the name of a given trace class. +@sa bt_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); +extern const char *bt_trace_get_name(struct bt_trace *trace_class); /** @brief Sets the name of the CTF IR trace class \p trace_class @@ -225,56 +254,98 @@ extern const char *bt_ctf_trace_get_name(struct bt_ctf_trace *trace_class); @prehot{trace_class} @postrefcountsame{trace_class} -@sa bt_ctf_trace_get_name(): Returns the name of a given trace class. +@sa bt_trace_get_name(): Returns the name of a given trace class. */ -extern int bt_ctf_trace_set_name(struct bt_ctf_trace *trace_class, +extern int bt_trace_set_name(struct bt_trace *trace_class, const char *name); /** -@brief Returns the default byte order of the CTF IR trace class +@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 Default byte order of trace class - \p trace_class, or #BT_CTF_BYTE_ORDER_UNKNOWN - on error. +@returns Native byte order of \p trace_class, + or #BT_BYTE_ORDER_UNKNOWN on error. @prenotnull{trace_class} @postrefcountsame{trace_class} -@sa bt_ctf_trace_set_name(): Sets the name of a given trace class. +@sa bt_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_byte_order( - struct bt_ctf_trace *trace_class); +extern enum bt_byte_order bt_trace_get_native_byte_order( + struct bt_trace *trace_class); /** -@brief Sets the default byte order of the CTF IR trace class - \p trace_class to \p name. +@brief Sets the native byte order of the CTF IR trace class + \p trace_class to \p native_byte_order. -\p byte_order \em must be one of: +\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 +- #BT_BYTE_ORDER_LITTLE_ENDIAN +- #BT_BYTE_ORDER_BIG_ENDIAN +- #BT_BYTE_ORDER_NETWORK +- If the trace is not in CTF writer mode, + #BT_BYTE_ORDER_UNSPECIFIED. -@param[in] trace_class Trace class of which to set the default byte - order. -@param[in] byte_order Default byte order of the trace class. -@returns 0 on success, or a negative value on error. +@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} -@prenotnull{name} @prehot{trace_class} -@pre \p byte_order is either #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN, - #BT_CTF_BYTE_ORDER_BIG_ENDIAN, or - #BT_CTF_BYTE_ORDER_NETWORK. +@pre \p native_byte_order is either #BT_BYTE_ORDER_UNSPECIFIED (if the + trace is not in CTF writer mode), + #BT_BYTE_ORDER_LITTLE_ENDIAN, #BT_BYTE_ORDER_BIG_ENDIAN, or + #BT_BYTE_ORDER_NETWORK. +@postrefcountsame{trace_class} + +@sa bt_trace_get_native_byte_order(): Returns the native byte order of a + given trace class. +*/ +extern int bt_trace_set_native_byte_order(struct bt_trace *trace_class, + enum bt_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_trace_set_uuid(): Sets the UUID of a given trace class. +*/ +extern const unsigned char *bt_trace_get_uuid( + struct bt_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_name(): Returns the name of a given trace class. +@sa bt_trace_get_uuid(): Returns the UUID of a given trace class. */ -extern int bt_ctf_trace_set_byte_order(struct bt_ctf_trace *trace_class, - enum bt_ctf_byte_order byte_order); +extern int bt_trace_set_uuid(struct bt_trace *trace_class, + const unsigned char *uuid); /** @brief Returns the number of entries contained in the environment of @@ -289,8 +360,8 @@ extern int bt_ctf_trace_set_byte_order(struct bt_ctf_trace *trace_class, @prenotnull{trace_class} @postrefcountsame{trace_class} */ -extern int bt_ctf_trace_get_environment_field_count( - struct bt_ctf_trace *trace_class); +extern int64_t bt_trace_get_environment_field_count( + struct bt_trace *trace_class); /** @brief Returns the field name of the environment entry at index @@ -308,19 +379,23 @@ the returned string. @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()). + \p trace_class (see bt_trace_get_environment_field_count()). @postrefcountsame{trace_class} -@sa bt_ctf_trace_get_environment_field_value(): Finds a trace class's +@sa bt_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 +@sa bt_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 +@sa bt_trace_set_environment_field(): Sets the value of a trace class's environment entry. */ extern const char * -bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace *trace_class, - int index); +bt_trace_get_environment_field_name_by_index( + struct bt_trace *trace_class, uint64_t index); + +extern struct bt_value * +bt_trace_borrow_environment_field_value_by_index(struct bt_trace *trace_class, + uint64_t index); /** @brief Returns the value of the environment entry at index @@ -334,18 +409,26 @@ bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace *trace_class, @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()). + \p trace_class (see bt_trace_get_environment_field_count()). @postrefcountsame{trace_class} @postsuccessrefcountretinc -@sa bt_ctf_trace_get_environment_field_value_by_name(): Finds a trace +@sa bt_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 +@sa bt_trace_set_environment_field(): Sets the value of a trace class's environment entry. */ +static inline +struct bt_value *bt_trace_get_environment_field_value_by_index( + struct bt_trace *trace_class, uint64_t index) +{ + return bt_get(bt_trace_borrow_environment_field_value_by_index( + trace_class, index)); +} + extern struct bt_value * -bt_ctf_trace_get_environment_field_value(struct bt_ctf_trace *trace_class, - int index); +bt_trace_borrow_environment_field_value_by_name( + struct bt_trace *trace_class, const char *name); /** @brief Returns the value of the environment entry named \p name @@ -363,14 +446,20 @@ bt_ctf_trace_get_environment_field_value(struct bt_ctf_trace *trace_class, @postrefcountsame{trace_class} @postsuccessrefcountretinc -@sa bt_ctf_trace_get_environment_field_value(): Finds a trace class's +@sa bt_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 +@sa bt_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); +static inline +struct bt_value * +bt_trace_get_environment_field_value_by_name( + struct bt_trace *trace_class, const char *name) +{ + return bt_get( + bt_trace_borrow_environment_field_value_by_name( + trace_class, name)); +} /** @brief Sets the environment entry named \p name in the @@ -397,13 +486,13 @@ value is first put, and then replaced by \p value. @postrefcountsame{trace_class} @postsuccessrefcountinc{value} -@sa bt_ctf_trace_get_environment_field_value(): Finds a trace class's +@sa bt_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 +@sa bt_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, +extern int bt_trace_set_environment_field( + struct bt_trace *trace_class, const char *name, struct bt_value *value); /** @@ -427,11 +516,11 @@ containing \p value. @prehot{trace_class} @postrefcountsame{trace_class} -@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace +@sa bt_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, +extern int bt_trace_set_environment_field_integer( + struct bt_trace *trace_class, const char *name, int64_t value); /** @@ -457,11 +546,11 @@ containing \p value. @prehot{trace_class} @postrefcountsame{trace_class} -@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace +@sa bt_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, +extern int bt_trace_set_environment_field_string( + struct bt_trace *trace_class, const char *name, const char *value); /** @} */ @@ -471,6 +560,9 @@ extern int bt_ctf_trace_set_environment_field_string( @{ */ +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. @@ -486,11 +578,18 @@ extern int bt_ctf_trace_set_environment_field_string( @post On success, if the return value is a field type, its reference count is incremented. -@sa bt_ctf_trace_set_packet_header_type(): Sets the packet +@sa bt_trace_set_packet_header_field_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_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 @@ -518,84 +617,105 @@ As of Babeltrace \btversion, if \p packet_header_type is not \c NULL, @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 +@sa bt_trace_get_packet_header_field_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); +extern int bt_trace_set_packet_header_field_type(struct bt_trace *trace_class, + struct bt_field_type *packet_header_type); /** @} */ /** -@name Clock class children functions +@name Contained clock classes functions @{ */ /** -@brief Returns the number of clock classes contained in the +@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 children clock classes. -@returns Number of children clock classes + 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 int bt_ctf_trace_get_clock_class_count(struct bt_ctf_trace *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 clock class at index \p index in the CTF IR trace - class \p 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. -@param[in] index Index of the clock class to find. -@returns Clock class at index \p index, or \c NULL - on error. +@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()). + bt_trace_get_clock_class_count()). @postrefcountsame{trace_class} @postsuccessrefcountretinc -@sa bt_ctf_trace_get_clock_class_by_name(): Finds a clock class by name. -@sa bt_ctf_trace_add_clock_class(): Adds a clock class to a trace class. +@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. */ -extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class( - struct bt_ctf_trace *trace_class, int index); +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 clock class named \c name found in the CTF IR trace - class \p trace_class. +@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. -@param[in] name Name of the clock class to find. -@returns Clock class named \p name, or \c NULL - on error. +@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(): Returns the clock class contained +@sa bt_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. +@sa bt_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); +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 clock_class becomes the child of \p trace_class. +On success, \p trace_class contains \p clock_class. -You can call this function even if \p trace_class is frozen. +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. @@ -608,12 +728,13 @@ You can call this function even if \p trace_class is frozen. @post On success, if \p trace_class is frozen, \p clock_class is frozen. -@sa bt_ctf_trace_get_clock_class(): Returns the clock class contained +@sa bt_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. +@sa bt_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); +extern int bt_trace_add_clock_class(struct bt_trace *trace_class, + struct bt_clock_class *clock_class); /** @} */ @@ -635,7 +756,11 @@ extern int bt_ctf_trace_add_clock_class(struct bt_ctf_trace *trace_class, @prenotnull{trace_class} @postrefcountsame{trace_class} */ -extern int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace *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 @@ -649,15 +774,22 @@ extern int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace *trace_class) @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()). + bt_trace_get_stream_class_count()). @postrefcountsame{trace_class} -@postsuccessrefcountretinc -@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. +@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. */ -extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class( - struct bt_ctf_trace *trace_class, int index); +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 @@ -672,12 +804,16 @@ extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class( @postrefcountsame{trace_class} @postsuccessrefcountretinc -@sa bt_ctf_trace_get_stream_class(): Returns the stream class contained +@sa bt_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. +@sa bt_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, uint32_t id); +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 @@ -706,12 +842,59 @@ resolving fails, then this function fails. @postsuccessrefcountinc{stream_class} @postsuccessfrozen{stream_class} -@sa bt_ctf_trace_get_stream_class(): Returns the stream class contained +@sa bt_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. +@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} */ -extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace_class, - struct bt_ctf_stream_class *stream_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)); +} /** @} */ @@ -721,35 +904,127 @@ extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace_class, */ /** -@brief User function type to use with bt_ctf_trace_add_listener(). +@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. -@param[in] obj New CTF IR object which is part of the trace - class hierarchy. -@param[in] data User data. +This function returns #BT_TRUE if bt_trace_set_is_static() was +previously called on it. -@prenotnull{obj} +@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. */ -typedef void (*bt_ctf_listener_cb)(struct bt_ctf_object *obj, void *data); +extern bt_bool bt_trace_is_static(struct bt_trace *trace_class); /** -@brief Adds the trace class modification listener \p listener to - the CTF IR trace class \p trace_class. +@brief Makes the CTF IR trace class \p trace_class static. -Once you add \p listener to \p trace_class, whenever \p trace_class -is modified, \p listener is called with the new element and with -\p data (user data). +A static trace class is frozen and you cannot call any modifying +function on it: -@param[in] trace_class Trace class to which to add \p listener. -@param[in] listener Modification listener function. -@param[in] data User data. +- 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_ctf_trace_add_listener(struct bt_ctf_trace *trace_class, - bt_ctf_listener_cb listener, void *data); +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 @@ -769,25 +1044,13 @@ class, the stream class itself, and all its children event classes. @prenotnull{trace_class} @prenotnull{visitor} */ -extern int bt_ctf_trace_visit(struct bt_ctf_trace *trace_class, - bt_ctf_visitor visitor, void *data); +extern int bt_trace_visit(struct bt_trace *trace_class, + bt_visitor visitor, void *data); /** @} */ /** @} */ -/* - * 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); - #ifdef __cplusplus } #endif