X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Fevent.h;h=67df08b5e53c390f67592c9ba34e87727500ecd6;hp=44112125d69ca09802c9cc260da6943d778eff96;hb=44c440bc5fe8219cc17d1b786d91fd83c4c9860a;hpb=c800eb3790218d2f33df01e77ec38cbd43cc02a1 diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h index 44112125..67df08b5 100644 --- a/include/babeltrace/ctf-ir/event.h +++ b/include/babeltrace/ctf-ir/event.h @@ -30,250 +30,47 @@ * http://www.efficios.com/ctf */ -/* For bt_get() */ -#include - -/* For bt_bool */ -#include - #include #include +/* For enum bt_clock_value_status */ +#include + #ifdef __cplusplus extern "C" { #endif -struct bt_value; -struct bt_clock_class; - -/** -@defgroup ctfirevent CTF IR event -@ingroup ctfir -@brief CTF IR event. - -@code -#include -@endcode - -A CTF IR event is a container of event -fields: - -- Stream event header field, described by the - stream event header field type of a - \link ctfirstreamclass CTF IR stream class\endlink. -- Stream event context field, described by the - stream event context field type of a stream class. -- Event context field, described by the - event context field type of a - \link ctfireventclass CTF IR event class\endlink. -- Event payload, described by the - event payload field type of an event class. - -As a reminder, here's the structure of a CTF packet: - -@imgpacketstructure - -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. - -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. - -You can attach a \link ctfirpacket CTF IR packet object\endlink to an -event object with bt_event_set_packet(). - -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(). - -As with any Babeltrace object, CTF IR event objects have -reference -counts. See \ref refs to learn more about the reference counting -management of Babeltrace objects. - -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. - -@sa ctfireventclass -@sa ctfirpacket - -@file -@brief CTF IR event type and functions. -@sa ctfirevent - -@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 struct bt_field *bt_event_borrow_header_field(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( +extern struct bt_field *bt_event_borrow_common_context_field( 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 int bt_event_set_clock_value(struct bt_event *event, - struct bt_clock_class *clock_class, uint64_t raw_value, - bt_bool is_default); - -extern struct bt_clock_value *bt_event_borrow_default_clock_value( +extern struct bt_field *bt_event_borrow_specific_context_field( struct bt_event *event); -/** @} */ +extern struct bt_field *bt_event_borrow_payload_field(struct bt_event *event); + +extern int bt_event_set_default_clock_value(struct bt_event *event, + uint64_t value_cycles); -/** @} */ +extern enum bt_clock_value_status bt_event_borrow_default_clock_value( + struct bt_event *event, struct bt_clock_value **clock_value); #ifdef __cplusplus }