1 #ifndef BABELTRACE_CTF_IR_STREAM_H
2 #define BABELTRACE_CTF_IR_STREAM_H
5 * BabelTrace - CTF IR: Stream
7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The Common Trace Format (CTF) Specification is available at
30 * http://www.efficios.com/ctf
33 #include <babeltrace/ctf-ir/stream-class.h>
43 * bt_ctf_stream_get_stream_class: get a stream's class.
45 * @param stream Stream instance.
47 * Returns the stream's class, NULL on error.
49 extern struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
50 struct bt_ctf_stream
*stream
);
53 * bt_ctf_stream_get_discarded_events_count: get the number of discarded
54 * events associated with this stream.
56 * Note that discarded events are not stored if the stream's packet
57 * context has no "events_discarded" field. An error will be returned
60 * @param stream Stream instance.
62 * Returns the number of discarded events, a negative value on error.
64 extern int bt_ctf_stream_get_discarded_events_count(
65 struct bt_ctf_stream
*stream
, uint64_t *count
);
68 * bt_ctf_stream_append_discarded_events: increment discarded events count.
70 * Increase the current packet's discarded event count. Has no effect if the
71 * stream class' packet context has no "events_discarded" field.
73 * @param stream Stream instance.
74 * @param event_count Number of discarded events to add to the stream's current
77 extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
78 uint64_t event_count
);
81 * bt_ctf_stream_append_event: append an event to the stream.
83 * Append "event" to the stream's current packet. The stream's associated clock
84 * will be sampled during this call. The event shall not be modified after
85 * being appended to a stream. The stream will share the event's ownership by
86 * incrementing its reference count. The current packet is not flushed to disk
87 * until the next call to bt_ctf_stream_flush.
89 * The stream event context will be sampled for every appended event if
90 * a stream event context was defined.
92 * @param stream Stream instance.
93 * @param event Event instance to append to the stream's current packet.
95 * Returns 0 on success, a negative value on error.
97 extern int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
98 struct bt_ctf_event
*event
);
101 * bt_ctf_stream_get_packet_context: get a stream's packet context.
103 * @param stream Stream instance.
105 * Returns a field instance on success, NULL on error.
107 extern struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
108 struct bt_ctf_stream
*stream
);
111 * bt_ctf_stream_set_packet_context: set a stream's packet context.
113 * The packet context's type must match the stream class' packet
116 * @param stream Stream instance.
117 * @param packet_context Packet context field instance.
119 * Returns a field instance on success, NULL on error.
121 extern int bt_ctf_stream_set_packet_context(
122 struct bt_ctf_stream
*stream
,
123 struct bt_ctf_field
*packet_context
);
126 * bt_ctf_stream_get_event_context: get a stream's event context.
128 * @param stream Stream instance.
130 * Returns a field instance on success, NULL on error.
132 extern struct bt_ctf_field
*bt_ctf_stream_get_event_context(
133 struct bt_ctf_stream
*stream
);
136 * bt_ctf_stream_set_event_context: set a stream's event context.
138 * The event context's type must match the stream class' event
141 * @param stream Stream instance.
142 * @param event_context Event context field instance.
144 * Returns a field instance on success, NULL on error.
146 extern int bt_ctf_stream_set_event_header(
147 struct bt_ctf_stream
*stream
,
148 struct bt_ctf_field
*event_header
);
151 * bt_ctf_stream_get_packet_header: get a stream's packet header.
153 * @param stream Stream instance.
155 * Returns a field instance on success, NULL on error.
157 extern struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
158 struct bt_ctf_stream
*stream
);
161 * bt_ctf_stream_set_packet_header: set a stream's packet header.
163 * The packet header's type must match the trace's packet header
166 * @param stream Stream instance.
167 * @param packet_header Packet header instance.
169 * Returns a field instance on success, NULL on error.
171 extern int bt_ctf_stream_set_packet_header(
172 struct bt_ctf_stream
*stream
,
173 struct bt_ctf_field
*packet_header
);
176 * bt_ctf_stream_flush: flush a stream.
178 * The stream's current packet's events will be flushed, thus closing the
179 * current packet. Events subsequently appended to the stream will be
180 * added to a new packet.
182 * Flushing will also set the packet context's default attributes if
183 * they remained unset while populating the current packet. These default
184 * attributes, along with their expected types, are detailed in stream-class.h.
186 * @param stream Stream instance.
188 * Returns 0 on success, a negative value on error.
190 extern int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
);
193 * bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
194 * stream's reference count.
196 * These functions ensure that the stream won't be destroyed while it
197 * is in use. The same number of get and put (plus one extra put to
198 * release the initial reference done at creation) have to be done to
201 * When the stream's reference count is decremented to 0 by a
202 * bt_ctf_stream_put, the stream is freed.
204 * @param stream Stream instance.
206 extern void bt_ctf_stream_get(struct bt_ctf_stream
*stream
);
207 extern void bt_ctf_stream_put(struct bt_ctf_stream
*stream
);
213 #endif /* BABELTRACE_CTF_IR_STREAM_H */
This page took 0.035799 seconds and 4 git commands to generate.