* http://www.efficios.com/ctf
*/
-#include <babeltrace/ctf-ir/field-types.h>
+/* For bt_ctf_visitor */
#include <babeltrace/ctf-ir/visitor.h>
-#include <babeltrace/values.h>
-#include <babeltrace/graph/notification.h>
+
+/* For bt_bool */
+#include <babeltrace/types.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
+struct bt_ctf_field_type;
+struct bt_value;
+
/**
@defgroup ctfirtraceclass CTF IR trace class
@ingroup ctfir
A trace class has the following properties:
- A \b name.
-- A <strong>default byte order</strong>: all the
+- A <strong>native byte order</strong>: 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.
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().
+with bt_ctf_trace_get_stream_by_index().
A trace class owns the <strong>trace packet header</strong>
\link ctfirfieldtypes field type\endlink, which represents the
- 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
-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
struct bt_ctf_stream_class;
struct bt_ctf_clock_class;
+/**
+@brief User function type to use with
+ bt_ctf_trace_add_is_static_listener().
+
+@param[in] trace_class Trace class which is now static.
+@param[in] data User data as passed to
+ bt_ctf_trace_add_is_static_listener() when
+ you added the listener.
+
+@prenotnull{trace_class}
+*/
+typedef void (* bt_ctf_trace_is_static_listener)(
+ struct bt_ctf_trace *trace_class, void *data);
+
+/**
+@brief User function type to use with
+ bt_ctf_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_ctf_trace_add_is_static_listener() when
+ you added the listener.
+
+@prenotnull{trace_class}
+*/
+typedef void (* bt_ctf_trace_listener_removed)(
+ struct bt_ctf_trace *trace_class, void *data);
+
/**
@name Creation function
@{
@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:
-
-- <code>magic</code>: a 32-bit unsigned integer field type.
-- <code>uuid</code>: an array field type of 16 8-bit unsigned integer
- field types.
-- <code>stream_id</code>: 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_ctf_trace_get_packet_header_type() and
+bt_ctf_trace_set_packet_header_type().
The created trace class has the following initial properties:
- <strong>Name</strong>: none. You can set a name
with bt_ctf_trace_set_name().
-- <strong>Default byte order</strong>: #BT_CTF_BYTE_ORDER_NATIVE. You
- 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
- its event classes, has a byte order set to #BT_CTF_BYTE_ORDER_NATIVE.
+- <strong>UUID</strong>: none. You can set a UUID with
+ bt_ctf_trace_set_uuid().
+- <strong>Native byte order</strong>: #BT_CTF_BYTE_ORDER_UNSPECIFIED.
+ You can set a native byte order with
+ bt_ctf_trace_set_native_byte_order().
- <strong>Environment</strong>: empty. You can add environment entries
with bt_ctf_trace_set_environment_field(),
bt_ctf_trace_set_environment_field_integer(), and
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_CTF_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_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_byte_order(
+extern enum bt_ctf_byte_order bt_ctf_trace_get_native_byte_order(
struct bt_ctf_trace *trace_class);
/**
-@brief Sets the default byte order of the CTF IR 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
+- <strong>If the trace is not in CTF writer mode<strong>,
+ #BT_CTF_BYTE_ORDER_UNSPECIFIED.
-@param[in] trace_class Trace class of which to set the default byte
+@param[in] trace_class Trace class of which to set the native byte
order.
-@param[in] native_byte_order Default byte order of the trace class.
+@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 native_byte_order is either #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN,
- #BT_CTF_BYTE_ORDER_BIG_ENDIAN, or
+@pre \p native_byte_order is either #BT_CTF_BYTE_ORDER_UNSPECIFIED (if the
+ trace is not in CTF writer mode),
+ #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.
+@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.
@prenotnull{trace_class}
@postrefcountsame{trace_class}
*/
-extern int bt_ctf_trace_get_environment_field_count(
+extern int64_t bt_ctf_trace_get_environment_field_count(
struct bt_ctf_trace *trace_class);
/**
\p trace_class (see bt_ctf_trace_get_environment_field_count()).
@postrefcountsame{trace_class}
-@sa bt_ctf_trace_get_environment_field_value(): Finds a trace class's
+@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.
class's environment entry.
*/
extern const char *
-bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace *trace_class,
- int index);
+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
class's environment entry.
*/
extern struct bt_value *
-bt_ctf_trace_get_environment_field_value(struct bt_ctf_trace *trace_class,
- int index);
+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
@postrefcountsame{trace_class}
@postsuccessrefcountretinc
-@sa bt_ctf_trace_get_environment_field_value(): Finds a trace class's
+@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.
@postrefcountsame{trace_class}
@postsuccessrefcountinc{value}
-@sa bt_ctf_trace_get_environment_field_value(): Finds a trace class's
+@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.
@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_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
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);
+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
@postrefcountsame{trace_class}
@postsuccessrefcountretinc
-@sa bt_ctf_trace_get_clock_class(): Returns the clock class contained
+@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.
*/
@post <strong>On success, if \p trace_class is frozen</strong>,
\p clock_class is frozen.
-@sa bt_ctf_trace_get_clock_class(): Returns the clock class contained
+@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.
@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_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
@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(
- struct bt_ctf_trace *trace_class, int index);
+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
@postrefcountsame{trace_class}
@postsuccessrefcountretinc
-@sa bt_ctf_trace_get_stream_class(): Returns the stream class contained
+@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, uint32_t id);
+ struct bt_ctf_trace *trace_class, uint64_t id);
/**
@brief Adds the CTF IR stream class \p stream_class to the
@postsuccessrefcountinc{stream_class}
@postsuccessfrozen{stream_class}
-@sa bt_ctf_trace_get_stream_class(): Returns the stream class contained
+@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.
*/
@prenotnull{trace_class}
@postrefcountsame{trace_class}
*/
-extern int bt_ctf_trace_get_stream_count(struct bt_ctf_trace *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
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);
+extern struct bt_ctf_stream *bt_ctf_trace_get_stream_by_index(
+ struct bt_ctf_trace *trace_class, uint64_t index);
/** @} */
streams, stream classes, or clock classes. A static class is always
frozen.
-This function returns \c true if bt_ctf_trace_set_is_static() was
+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 \c true if \p trace_class is static,
+@returns #BT_TRUE if \p trace_class is static,
@sa bt_ctf_trace_set_is_static(): Makes a trace class static.
*/
-extern bool bt_ctf_trace_is_static(struct bt_ctf_trace *trace_class);
+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.
- bt_ctf_trace_add_stream_class()
- bt_ctf_trace_add_clock_class()
+- bt_ctf_trace_set_environment_field()
+- bt_ctf_trace_set_environment_field_integer()
+- bt_ctf_trace_set_environment_field_string()
+- bt_ctf_trace_add_is_static_listener()
You cannot create a stream with bt_ctf_stream_create() with any of the
stream classes of a static trace class.
@sa bt_ctf_trace_is_static(): Checks whether or not a given trace class
is static.
+@sa bt_ctf_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_ctf_trace_set_is_static(struct bt_ctf_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_ctf_trace_set_is_static() is called on \p trace_class.
+
+When the trace is destroyed, or when you remove the added listener with
+bt_ctf_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_ctf_trace_remove_is_static_listener().
+
+This function fails if \p trace_class is already static: you need to
+check the condition first with bt_ctf_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_ctf_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_ctf_trace_remove_is_static_listener(): Removes a "trace is
+ static" listener from a trace class previously added with this
+ function.
+@sa bt_ctf_trace_is_static(): Checks whether or not a given trace class
+ is static.
+@sa bt_ctf_trace_set_is_static(): Makes a trace class static.
+*/
+extern int bt_ctf_trace_add_is_static_listener(
+ struct bt_ctf_trace *trace_class,
+ bt_ctf_trace_is_static_listener listener,
+ bt_ctf_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_ctf_trace_add_is_static_listener() and did not
+ already remove with this function.
+@postrefcountsame{trace_class}
+
+@sa bt_ctf_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_ctf_trace_remove_is_static_listener(
+ struct bt_ctf_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.
/** @} */
-/*
- * 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
projects / babeltrace.git / blobdiff