X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Ftrace.h;h=a9e4fa89e1bc6cd76e7eab6e5aee87c78c704878;hb=5acf2ae6bdfb2bc6fa88e250a87ccc6ba3546d89;hp=a95e206ee4fc6790ccd5709b100658bbeb0781d8;hpb=ac0c6bddcdde51dcbb46fc73c61d4f2330774451;p=babeltrace.git diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h index a95e206e..a9e4fa89 100644 --- a/include/babeltrace/ctf-ir/trace.h +++ b/include/babeltrace/ctf-ir/trace.h @@ -33,7 +33,7 @@ #include #include #include -#include +#include #include #ifdef __cplusplus @@ -76,6 +76,10 @@ 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(). + 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 @@ -94,7 +98,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. @@ -116,7 +120,7 @@ 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(). +- Adding a CTF IR clock class to it with bt_ctf_trace_add_clock_class(). - \link refs Reference counting\endlink. You can add a custom listener with bt_ctf_trace_add_listener() to get @@ -170,7 +174,7 @@ 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(). + can set a default byte order with bt_ctf_trace_set_native_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 @@ -250,31 +254,31 @@ extern enum bt_ctf_byte_order bt_ctf_trace_get_byte_order( /** @brief Sets the default byte order of the CTF IR trace class - \p trace_class to \p name. + \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 -@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 default byte + order. +@param[in] native_byte_order Default 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, +@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_name(): Returns the name 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_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace_class, + enum bt_ctf_byte_order native_byte_order); /** @brief Returns the number of entries contained in the environment of @@ -527,17 +531,17 @@ extern int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace *trace_class, /** @} */ /** -@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. @@ -547,13 +551,15 @@ extern int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace *trace_class, extern int bt_ctf_trace_get_clock_class_count(struct bt_ctf_trace *trace_class); /** -@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 @@ -562,20 +568,22 @@ extern int bt_ctf_trace_get_clock_class_count(struct bt_ctf_trace *trace_class); @postrefcountsame{trace_class} @postsuccessrefcountretinc -@sa bt_ctf_trace_get_clock_class_by_name(): Finds a clock class by name. +@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( struct bt_ctf_trace *trace_class, int index); /** -@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} @@ -593,9 +601,10 @@ extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_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. @@ -610,7 +619,8 @@ You can call this function even if \p trace_class is frozen. @sa bt_ctf_trace_get_clock_class(): 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_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); @@ -651,7 +661,6 @@ extern int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace *trace_class) the trace class \p trace_class (see bt_ctf_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. @@ -715,41 +724,92 @@ extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace_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 int 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( + struct bt_ctf_trace *trace_class, int index); + +/** @} */ + /** @name Misc. functions @{ */ /** -@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. -@param[in] obj New CTF IR object which is part of the trace - class hierarchy. -@param[in] data User data. +It is guaranteed that a static trace class will never contain new +streams, stream classes, or clock classes. A static class is always +frozen. -@prenotnull{obj} +This function returns \c true if bt_ctf_trace_set_is_static() was +previously called on it. + +@param[in] trace_class Trace class to check. +@returns \c true if \p trace_class is static, + +@sa bt_ctf_trace_set_is_static(): Makes a trace class static. */ -typedef void (*bt_ctf_listener_cb)(struct bt_ctf_object *obj, void *data); +extern bool bt_ctf_trace_is_static(struct bt_ctf_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_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} -@prenotnull{listener} @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_add_listener(struct bt_ctf_trace *trace_class, - bt_ctf_listener_cb listener, void *data); +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