#include <stdint.h>
-/* For bt_get() */
-#include <babeltrace/ref.h>
+/* For enum bt_property_availability */
+#include <babeltrace/property.h>
-/* For bt_bool */
-#include <babeltrace/types.h>
+/* For enum bt_clock_value_status */
+#include <babeltrace/ctf-ir/clock-value.h>
#ifdef __cplusplus
extern "C" {
#endif
-/**
-@defgroup ctfirpacket CTF IR packet
-@ingroup ctfir
-@brief CTF IR packet.
-
-@code
-#include <babeltrace/ctf-ir/packet.h>
-@endcode
-
-A CTF IR <strong><em>packet</em></strong> is a container of packet
-fields, that is, of the <strong>trace packet header</strong> and
-<strong>stream packet context</strong> fields.
-
-As a reminder, here's the structure of a CTF packet:
-
-@imgpacketstructure
-
-You can create a CTF IR packet \em from a
-\link ctfirstream CTF IR stream\endlink with bt_packet_create(). The
-stream you use to create a packet object becomes its parent.
-
-When you set the trace packet header and stream packet context fields of
-a packet with resp. bt_packet_set_header() and
-bt_packet_set_context(), their field type \em must be equivalent to
-the field types returned by resp. bt_trace_get_packet_header_type()
-and bt_stream_class_get_packet_context_type() for its parent trace
-class and stream class.
-
-You can attach a packet object to a \link ctfirevent CTF IR
-event\endlink object with bt_event_set_packet().
-
-As with any Babeltrace object, CTF IR packet 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_notification_event_create() \em freezes its event parameter on
-success, which in turns freezes the event's associated packet object.
-This is the only way that a CTF IR packet object can be frozen.
-You cannot modify a frozen packet: it is considered immutable,
-except for \link refs reference counting\endlink.
-
-@sa ctfirstream
-@sa ctfirstreamclass
-@sa ctfirtraceclass
-
-@file
-@brief CTF IR packet type and functions.
-@sa ctfirpacket
-
-@addtogroup ctfirpacket
-@{
-*/
-
-/**
-@struct bt_packet
-@brief A CTF IR packet.
-@sa ctfirpacket
-*/
struct bt_packet;
struct bt_packet_header_field;
struct bt_packet_context_field;
struct bt_stream;
struct bt_clock_value;
-struct bt_clock_class;
-
-enum bt_packet_previous_packet_availability {
- BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_ERROR = -1,
- BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_AVAILABLE,
- BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_NOT_AVAILABLE,
- BT_PACKET_PREVIOUS_PACKET_AVAILABILITY_NONE,
-};
-
-enum bt_packet_property_availability {
- BT_PACKET_PROPERTY_AVAILABILITY_ERROR = -1,
- BT_PACKET_PROPERTY_AVAILABILITY_AVAILABLE,
- BT_PACKET_PROPERTY_AVAILABILITY_NOT_AVAILABLE,
-};
-
-/**
-@name Creation and parent access functions
-@{
-*/
-
-/**
-@brief Creates a default CTF IR packet with \p stream as its parent
- CTF IR stream.
-
-On success, the packet object's trace packet header and stream packet
-context fields are not set. You can set them with resp.
-bt_packet_set_header() and bt_packet_set_context().
-
-@param[in] stream Parent CTF IR stream of the packet to create.
-@returns Created packet, or \c NULL on error.
-
-@prenotnull{stream}
-@postsuccessrefcountret1
-*/
-extern struct bt_packet *bt_packet_create(struct bt_stream *stream,
- enum bt_packet_previous_packet_availability previous_packet_availability,
- struct bt_packet *previous_packet);
-extern struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet);
-
-/**
-@brief Returns the parent CTF IR stream of the CTF IR packet \p packet.
-
-This function returns a reference to the stream which was used to create
-the packet object in the first place with bt_packet_create().
-
-@param[in] packet Packet of which to get the parent stream.
-@returns Parent stream of \p packet, or \c NULL on error.
-
-@prenotnull{packet}
-@postrefcountsame{packet}
-@postsuccessrefcountretinc
-*/
-static inline
-struct bt_stream *bt_packet_get_stream(
- struct bt_packet *packet)
-{
- return bt_get(bt_packet_borrow_stream(packet));
-}
-
-/** @} */
+extern struct bt_packet *bt_packet_create(struct bt_stream *stream);
-/**
-@name Contained fields functions
-@{
-*/
+extern struct bt_stream *bt_packet_borrow_stream(struct bt_packet *packet);
extern
-struct bt_field *bt_packet_borrow_header(struct bt_packet *packet);
+struct bt_field *bt_packet_borrow_header_field(struct bt_packet *packet);
extern
-int bt_packet_move_header(struct bt_packet *packet,
+int bt_packet_move_header_field(struct bt_packet *packet,
struct bt_packet_header_field *header);
extern
-struct bt_field *bt_packet_borrow_context(struct bt_packet *packet);
+struct bt_field *bt_packet_borrow_context_field(struct bt_packet *packet);
extern
-int bt_packet_move_context(struct bt_packet *packet,
+int bt_packet_move_context_field(struct bt_packet *packet,
struct bt_packet_context_field *context);
-/** @} */
-
-extern
-enum bt_packet_property_availability
-bt_packet_borrow_default_beginning_clock_value(struct bt_packet *packet,
- struct bt_clock_value **clock_value);
-
extern
-enum bt_packet_property_availability
-bt_packet_borrow_default_end_clock_value(struct bt_packet *packet,
- struct bt_clock_value **clock_value);
+enum bt_clock_value_status bt_packet_borrow_default_beginning_clock_value(
+ struct bt_packet *packet, struct bt_clock_value **clock_value);
extern
-enum bt_packet_previous_packet_availability
-bt_packet_get_previous_packet_availability(struct bt_packet *packet);
+int bt_packet_set_default_beginning_clock_value(struct bt_packet *packet,
+ uint64_t value_cycles);
extern
-enum bt_packet_property_availability
-bt_packet_borrow_previous_packet_default_end_clock_value(
+enum bt_clock_value_status bt_packet_borrow_default_end_clock_valeu(
struct bt_packet *packet, struct bt_clock_value **clock_value);
extern
-enum bt_packet_property_availability bt_packet_get_discarded_event_counter(
- struct bt_packet *packet, uint64_t *counter);
+int bt_packet_set_default_end_clock_value(struct bt_packet *packet,
+ uint64_t value_cycles);
extern
-enum bt_packet_property_availability bt_packet_get_sequence_number(
- struct bt_packet *packet, uint64_t *sequence_number);
+enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
+ struct bt_packet *packet, uint64_t *value);
extern
-enum bt_packet_property_availability bt_packet_get_discarded_event_count(
- struct bt_packet *packet, uint64_t *count);
+int bt_packet_set_discarded_event_counter_snapshot(struct bt_packet *packet,
+ uint64_t value);
extern
-enum bt_packet_property_availability bt_packet_get_discarded_packet_count(
- struct bt_packet *packet, uint64_t *count);
+enum bt_property_availability bt_packet_get_packet_counter_snapshot(
+ struct bt_packet *packet, uint64_t *value);
-/** @} */
+extern
+int bt_packet_set_packet_counter_snapshot(struct bt_packet *packet,
+ uint64_t value);
#ifdef __cplusplus
}
projects / babeltrace.git / blobdiff