* http://www.efficios.com/ctf
*/
+/* For bt_get() */
+#include <babeltrace/ref.h>
+
#include <stdint.h>
#include <stddef.h>
-#include <babeltrace/values.h>
#ifdef __cplusplus
extern "C" {
#endif
-struct bt_ctf_event_class;
-struct bt_ctf_event;
-struct bt_ctf_field;
-struct bt_ctf_field_type;
-struct bt_ctf_stream_class;
-struct bt_ctf_packet;
+struct bt_value;
+struct bt_clock_class;
-/*
- * bt_ctf_event_create: instanciate an event.
- *
- * Allocate a new event of the given event class. The creation of an event
- * sets its reference count to 1. Each instance shares the ownership of the
- * event class using its reference count.
- *
- * An event class must be associated with a stream class before events
- * may be instanciated.
- *
- * @param event_class Event class.
- *
- * Returns an allocated field type on success, NULL on error.
- */
-extern struct bt_ctf_event *bt_ctf_event_create(
- struct bt_ctf_event_class *event_class);
+/**
+@defgroup ctfirevent CTF IR event
+@ingroup ctfir
+@brief CTF IR event.
-/*
- * bt_ctf_event_get_class: get an event's class.
- *
- * @param event Event.
- *
- * Returns the event's class, NULL on error.
- */
-extern struct bt_ctf_event_class *bt_ctf_event_get_class(
- struct bt_ctf_event *event);
+@code
+#include <babeltrace/ctf-ir/event.h>
+@endcode
-/*
- * bt_ctf_event_get_stream: get an event's associated stream.
- *
- * @param event Event.
- *
- * Returns the event's associated stream, NULL on error.
- */
-extern struct bt_ctf_stream *bt_ctf_event_get_stream(
- struct bt_ctf_event *event);
+A CTF IR <strong><em>event</em></strong> is a container of event
+fields:
-/*
- * bt_ctf_event_get_clock: get an event's associated clock.
- *
- * @param event Event.
- *
- * Returns the event's clock, NULL on error.
- */
-extern struct bt_ctf_clock *bt_ctf_event_get_clock(
- struct bt_ctf_event *event);
+- <strong>Stream event header</strong> field, described by the
+ <em>stream event header field type</em> of a
+ \link ctfirstreamclass CTF IR stream class\endlink.
+- <strong>Stream event context</strong> field, described by the
+ <em>stream event context field type</em> of a stream class.
+- <strong>Event context</strong> field, described by the
+ <em>event context field type</em> of a
+ \link ctfireventclass CTF IR event class\endlink.
+- <strong>Event payload</strong>, described by the
+ <em>event payload field type</em> of an event class.
-/*
- * bt_ctf_event_get_payload_field: get an event's payload.
- *
- * @param event Event instance.
- *
- * Returns a field instance on success, NULL on error.
- */
-extern struct bt_ctf_field *bt_ctf_event_get_payload_field(
- struct bt_ctf_event *event);
+As a reminder, here's the structure of a CTF packet:
-/*
- * bt_ctf_event_set_payload_field: set an event's payload.
- *
- * @param event Event instance.
- * @param payload Field instance (must be a structure).
- *
- * Returns 0 on success, a negative value on error.
- */
-extern int bt_ctf_event_set_payload_field(struct bt_ctf_event *event,
- struct bt_ctf_field *payload);
+@imgpacketstructure
-/*
- * bt_ctf_event_get_payload: get an event's field.
- *
- * Returns the field matching "name". bt_put() must be called on the
- * returned value.
- *
- * @param event Event instance.
- * @param name Event field name, see notes.
- *
- * Returns a field instance on success, NULL on error.
- *
- * Note: Passing a name will cause the function to perform a look-up by
- * name assuming the event's payload is a structure. This will return
- * the raw payload instance if name is NULL.
- */
-extern struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event,
- const char *name);
+You can create a CTF IR event \em from a
+\link ctfireventclass CTF IR event class\endlink with
+bt_event_create(). The event class you use to create an event
+object becomes its parent.
-/*
- * bt_ctf_event_set_payload: set an event's field.
- *
- * Set a manually allocated field as an event's payload. The event will share
- * the field's ownership by using its reference count.
- * bt_put() must be called on the returned value.
- *
- * @param event Event instance.
- * @param name Event field name, see notes.
- * @param value Instance of a field whose type corresponds to the event's field.
- *
- * Returns 0 on success, a negative value on error.
- *
- * Note: The function will return an error if a name is provided and the payload
- * type is not a structure. If name is NULL, the payload field will be set
- * directly and must match the event class' payload's type.
- */
-extern int bt_ctf_event_set_payload(struct bt_ctf_event *event,
- const char *name,
- struct bt_ctf_field *value);
+If the \link ctfirtraceclass CTF IR trace class\endlink of an event
+object (parent of its \link ctfirstreamclass CTF IR stream class\endlink,
+which is the parent of its event class) was created by a
+\link ctfwriter CTF writer\endlink object, then the only possible
+action you can do with this event object is to append it to a
+\link ctfirstream CTF IR stream\endlink with
+bt_stream_append_event(). Otherwise, you can create an event
+notification with bt_notification_event_create(). The event you pass
+to this function \em must have an attached packet object first.
-/*
- * bt_ctf_event_get_payload_by_index: Get event's field by index.
- *
- * Returns the field associated with the provided index. bt_put()
- * must be called on the returned value. The indexes to be provided are
- * the same as can be retrieved from the event class.
- *
- * @param event Event.
- * @param index Index of field.
- *
- * Returns the event's field, NULL on error.
- *
- * Note: Will return an error if the payload's type is not a structure.
- */
-extern struct bt_ctf_field *bt_ctf_event_get_payload_by_index(
- struct bt_ctf_event *event, int index);
+You can attach a \link ctfirpacket CTF IR packet object\endlink to an
+event object with bt_event_set_packet().
-/*
- * bt_ctf_event_get_header: get an event's header.
- *
- * @param event Event instance.
- *
- * Returns a field instance on success, NULL on error.
- */
-extern struct bt_ctf_field *bt_ctf_event_get_header(
- struct bt_ctf_event *event);
+A CTF IR event has a mapping of
+\link ctfirclockvalue CTF IR clock values\endlink. A clock value is
+an instance of a specific
+\link ctfirclockclass CTF IR clock class\endlink when the event is
+emitted. You can set an event object's clock value with
+bt_event_set_clock_value().
-/*
- * bt_ctf_event_set_header: set an event's header.
- *
- * The event header's type must match the stream class' event
- * header type.
- *
- * @param event Event instance.
- * @param header Event header field instance.
- *
- * Returns a field instance on success, NULL on error.
- */
-extern int bt_ctf_event_set_header(
- struct bt_ctf_event *event,
- struct bt_ctf_field *header);
+As with any Babeltrace object, CTF IR event objects have
+<a href="https://en.wikipedia.org/wiki/Reference_counting">reference
+counts</a>. See \ref refs to learn more about the reference counting
+management of Babeltrace objects.
-/*
- * bt_ctf_event_get_event_context: Get an event's context
- *
- * @param event_class Event class.
- *
- * Returns a field on success (a structure), NULL on error.
- *
- * Note: This function is named this way instead of the expected
- * "bt_ctf_event_get_context" in order to work around a name clash with
- * an unrelated function bearing this name in context.h.
- */
-extern struct bt_ctf_field *bt_ctf_event_get_event_context(
- struct bt_ctf_event *event);
+bt_notification_event_create() \em freezes its event parameter on
+success. You cannot modify a frozen event object: it is considered
+immutable, except for \link refs reference counting\endlink.
-/*
- * bt_ctf_event_set_event_context: Set an event's context
- *
- * @param event Event.
- * @param context Event context field (must match the event class'
- * context type).
- *
- * Returns 0 on success, a negative value on error.
- */
-extern int bt_ctf_event_set_event_context(struct bt_ctf_event *event,
- struct bt_ctf_field *context);
+@sa ctfireventclass
+@sa ctfirpacket
-/*
- * bt_ctf_event_get_stream_event_context: Get an event's stream event context
- *
- * @param event_class Event class.
- *
- * Returns a field on success (a structure), NULL on error.
- */
-extern struct bt_ctf_field *bt_ctf_event_get_stream_event_context(
- struct bt_ctf_event *event);
+@file
+@brief CTF IR event type and functions.
+@sa ctfirevent
-/*
- * bt_ctf_event_set_stream_event_context: Set an event's stream event context
- *
- * @param event Event.
- * @param context Event stream context field (must match the stream class'
- * stream event context type).
- *
- * Returns 0 on success, a negative value on error.
- */
-extern int bt_ctf_event_set_stream_event_context(struct bt_ctf_event *event,
- struct bt_ctf_field *context);
+@addtogroup ctfirevent
+@{
+*/
+
+/**
+@struct bt_event
+@brief A CTF IR event.
+@sa ctfirevent
+*/
+struct bt_event;
+struct bt_event_header_field;
+struct bt_clock;
+struct bt_clock_value;
+struct bt_event_class;
+struct bt_field;
+struct bt_field_type;
+struct bt_stream_class;
+struct bt_packet;
+
+/**
+@name Creation and parent access functions
+@{
+*/
+
+/**
+@brief Creates a default CTF IR event from the CTF IR event class
+ \p event_class.
+
+\p event_class \em must have a parent
+\link ctfirstreamclass CTF IR stream class\endlink.
+
+On success, the four fields of the created event object are not set. You
+can set them with bt_event_set_header(),
+bt_event_set_stream_event_context(),
+bt_event_set_context(), and bt_event_set_payload().
+
+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 context or payload field
+types of \p event_class and in the root field types of the
+parent stream class of \p event_class. If any automatic resolving fails,
+this function fails. This means that, if any dynamic field type need
+a field type which should be found in the trace packet header root
+field type, and if the parent stream class of \p event_class was not
+added to a \link ctfirtraceclass CTF IR trace class\endlink yet
+with bt_trace_add_stream_class(), then this function fails.
+
+@param[in] event_class CTF IR event class to use to create the
+ CTF IR event.
+@returns Created event object, or \c NULL on error.
+
+@prenotnull{event_class}
+@pre \p event_class has a parent stream class.
+@postsuccessrefcountret1
+*/
+extern struct bt_event_class *bt_event_borrow_class(struct bt_event *event);
+
+/**
+@brief Returns the parent CTF IR event class of the CTF IR event
+ \p event.
+
+This function returns a reference to the event class which was used to
+create the event object in the first place with bt_event_create().
+
+@param[in] event Event of which to get the parent event class.
+@returns Parent event class of \p event,
+ or \c NULL on error.
+
+@prenotnull{event}
+@postrefcountsame{event}
+@postsuccessrefcountretinc
+*/
+static inline
+struct bt_event_class *bt_event_get_class(struct bt_event *event)
+{
+ return bt_get(bt_event_borrow_class(event));
+}
+
+extern struct bt_packet *bt_event_borrow_packet(struct bt_event *event);
+
+/**
+@brief Returns the CTF IR packet associated to the CTF IR event
+ \p event.
+
+This function returns a reference to the event class which was set to
+\p event in the first place with bt_event_set_packet().
+
+@param[in] event Event of which to get the associated packet.
+@returns Packet associated to \p event,
+ or \c NULL if no packet is associated to
+ \p event or on error.
+
+@prenotnull{event}
+@postrefcountsame{event}
+@postsuccessrefcountretinc
+
+@sa bt_event_set_packet(): Associates a given event to a given
+ packet.
+*/
+static inline
+struct bt_packet *bt_event_get_packet(struct bt_event *event)
+{
+ return bt_get(bt_event_borrow_packet(event));
+}
+
+extern struct bt_stream *bt_event_borrow_stream(struct bt_event *event);
+
+/**
+@brief Returns the parent CTF IR stream associated to the CTF IR event
+ \p event.
+
+@param[in] event Event of which to get the parent stream.
+@returns Parent stream of \p event, or \c NULL on error.
+
+@prenotnull{event}
+@postrefcountsame{event}
+@postsuccessrefcountretinc
+*/
+static inline
+struct bt_stream *bt_event_get_stream(struct bt_event *event)
+{
+ return bt_get(bt_event_borrow_stream(event));
+}
+
+/** @} */
+
+/**
+@name Contained fields functions
+@{
+*/
+
+extern struct bt_field *bt_event_borrow_header(struct bt_event *event);
+
+extern int bt_event_move_header(struct bt_event *event,
+ struct bt_event_header_field *header);
+
+extern struct bt_field *bt_event_borrow_stream_event_context(
+ struct bt_event *event);
+
+extern struct bt_field *bt_event_borrow_context(struct bt_event *event);
+
+extern struct bt_field *bt_event_borrow_payload(struct bt_event *event);
+
+/** @} */
+
+/**
+@name Clock value functions
+@{
+*/
-extern struct bt_ctf_packet *bt_ctf_event_get_packet(
- struct bt_ctf_event *event);
+extern struct bt_clock_value *bt_event_borrow_clock_value(
+ struct bt_event *event,
+ struct bt_clock_class *clock_class);
-extern int bt_ctf_event_set_packet(struct bt_ctf_event *event,
- struct bt_ctf_packet *packet);
+/** @} */
-extern uint64_t bt_ctf_event_get_clock_value(struct bt_ctf_event *event,
- struct bt_ctf_clock *clock);
+/** @} */
#ifdef __cplusplus
}
projects / babeltrace.git / blobdiff