1 #ifndef BABELTRACE_CTF_IR_STREAM_CLASS_H
2 #define BABELTRACE_CTF_IR_STREAM_CLASS_H
5 * BabelTrace - CTF IR: Stream Class
7 * Copyright 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
39 struct bt_ctf_event_class
;
40 struct bt_ctf_stream_class
;
44 * bt_ctf_stream_class_create: create a stream class.
46 * Allocate a new stream class of the given name. The creation of an event class
47 * sets its reference count to 1.
49 * A stream class' packet context is a structure initialized with the following
51 * - uint64_t timestamp_begin
52 * - uint64_t timestamp_end
53 * - uint64_t content_size
54 * - uint64_t packet_size
55 * - uint64_t events_discarded
57 * A stream class's event header is a structure initialized the following
60 * - uint64_t timestamp
62 * @param name Stream name, NULL to create an unnamed stream class.
64 * Returns an allocated stream class on success, NULL on error.
66 extern struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
);
69 * bt_ctf_stream_class_get_trace: Get a stream class' associated trace.
71 * @param stream_class Stream class.
73 * Returns the stream class' associated trace, NULL on error.
75 extern struct bt_ctf_trace
*bt_ctf_stream_class_get_trace(
76 struct bt_ctf_stream_class
*stream_class
);
79 * bt_ctf_stream_class_get_name: Get a stream class' name.
81 * @param stream_class Stream class.
83 * Returns the stream class' name, NULL on error.
85 extern const char *bt_ctf_stream_class_get_name(
86 struct bt_ctf_stream_class
*stream_class
);
89 * bt_ctf_stream_class_set_name: Set a stream class' name.
91 * @param stream_class Stream class.
93 * Returns 0 on success, a negative value on error.
95 extern int bt_ctf_stream_class_set_name(
96 struct bt_ctf_stream_class
*stream_class
, const char *name
);
99 * bt_ctf_stream_class_get_clock: get the clock associated with a stream class.
101 * @param stream_class Stream class.
103 * Returns a clock instance, NULL on error.
105 extern struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
106 struct bt_ctf_stream_class
*stream_class
);
109 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
111 * Assign a clock to a stream class. This clock will be sampled each time an
112 * event is appended to an instance of this stream class.
114 * @param stream_class Stream class.
115 * @param clock Clock to assign to the provided stream class.
117 * Returns 0 on success, a negative value on error.
119 extern int bt_ctf_stream_class_set_clock(
120 struct bt_ctf_stream_class
*stream_class
,
121 struct bt_ctf_clock
*clock
);
124 * bt_ctf_stream_class_get_id: Get a stream class' id.
126 * @param stream_class Stream class.
128 * Returns the stream class' id, a negative value on error.
130 extern int64_t bt_ctf_stream_class_get_id(
131 struct bt_ctf_stream_class
*stream_class
);
134 * bt_ctf_stream_class_set_id: Set a stream class' id.
136 * Set a stream class' id. Must be unique trace-wise.
137 * Note that stream classes are assigned a unique id when a stream instance
138 * is created for the first time from a trace or writer.
140 * @param stream_class Stream class.
141 * @param id Stream class id.
143 * Returns 0 on success, a negative value on error.
145 extern int bt_ctf_stream_class_set_id(
146 struct bt_ctf_stream_class
*stream_class
, uint32_t id
);
149 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
151 * Add an event class to a stream class. New events can be added even after a
152 * stream has beem instanciated and events have been appended. However, a stream
153 * will not accept events of a class that has not been registered beforehand.
154 * The stream class will share the ownership of "event_class" by incrementing
155 * its reference count.
157 * Note that an event class may only be added to one stream class. It
158 * also becomes immutable.
160 * @param stream_class Stream class.
161 * @param event_class Event class to add to the provided stream class.
163 * Returns 0 on success, a negative value on error.
165 extern int bt_ctf_stream_class_add_event_class(
166 struct bt_ctf_stream_class
*stream_class
,
167 struct bt_ctf_event_class
*event_class
);
170 * bt_ctf_stream_class_get_event_class_count: Get a stream class' event class
173 * @param stream_class Stream class.
175 * Returns the stream class' event count, a negative value on error.
177 extern int bt_ctf_stream_class_get_event_class_count(
178 struct bt_ctf_stream_class
*stream_class
);
181 * bt_ctf_stream_class_get_event_class: Get stream class event class by index.
183 * @param stream_class Stream class.
184 * @param index Index of field.
186 * Returns event class, NULL on error.
188 extern struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
189 struct bt_ctf_stream_class
*stream_class
, int index
);
192 * bt_ctf_stream_class_get_event_class_by_name: Get stream class event class by
195 * @param stream_class Stream class.
196 * @param name Event name.
198 * Returns event class, NULL on error.
200 extern struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
201 struct bt_ctf_stream_class
*stream_class
, const char *name
);
204 * bt_ctf_stream_class_get_event_class_by_name: Get stream class event class by
207 * @param stream_class Stream class.
208 * @param id Event class ID.
210 * Returns event class, NULL on error.
212 extern struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_id(
213 struct bt_ctf_stream_class
*stream_class
, uint32_t id
);
216 * bt_ctf_stream_class_get_packet_context_type: get the stream class' packet
219 * @param stream_class Stream class.
221 * Returns the packet context's type (a structure), NULL on error.
223 extern struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
224 struct bt_ctf_stream_class
*stream_class
);
227 * bt_ctf_stream_class_set_packet_context_type: set the stream class' packet
230 * @param stream_class Stream class.
231 * @param packet_context_type Packet context type (must be a structure).
233 * Returns 0 on success, a negative value on error.
235 extern int bt_ctf_stream_class_set_packet_context_type(
236 struct bt_ctf_stream_class
*stream_class
,
237 struct bt_ctf_field_type
*packet_context_type
);
240 * bt_ctf_stream_class_get_event_header_type: get the stream class'
243 * @param stream_class Stream class.
245 * Returns the stream event header's type (a structure), NULL on error.
247 extern struct bt_ctf_field_type
*
248 bt_ctf_stream_class_get_event_header_type(
249 struct bt_ctf_stream_class
*stream_class
);
252 * bt_ctf_stream_class_set_event_header_type: set the stream class'
255 * @param stream_class Stream class.
256 * @param event_header_type Event header type (must be a structure).
258 * Returns 0 on success, a negative value on error.
260 extern int bt_ctf_stream_class_set_event_header_type(
261 struct bt_ctf_stream_class
*stream_class
,
262 struct bt_ctf_field_type
*event_header_type
);
265 * bt_ctf_stream_class_get_event_context_type: get the stream class'
266 * event context type.
268 * @param stream_class Stream class.
270 * Returns the stream event context's type (a structure), NULL on error.
272 extern struct bt_ctf_field_type
*
273 bt_ctf_stream_class_get_event_context_type(
274 struct bt_ctf_stream_class
*stream_class
);
277 * bt_ctf_stream_class_set_event_context_type: set the stream class'
278 * event context type.
280 * @param stream_class Stream class.
281 * @param event_context_type Event context type (must be a structure).
283 * Returns 0 on success, a negative value on error.
285 extern int bt_ctf_stream_class_set_event_context_type(
286 struct bt_ctf_stream_class
*stream_class
,
287 struct bt_ctf_field_type
*event_context_type
);
290 * bt_ctf_stream_class_get and bt_ctf_stream_class_put: increment and
291 * decrement the stream class' reference count.
293 * You may also use bt_ctf_get() and bt_ctf_put() with stream class objects.
295 * These functions ensure that the stream class won't be destroyed while it
296 * is in use. The same number of get and put (plus one extra put to
297 * release the initial reference done at creation) have to be done to
298 * destroy a stream class.
300 * When the stream class' reference count is decremented to 0 by a
301 * bt_ctf_stream_class_put, the stream class is freed.
303 * @param stream_class Stream class.
305 extern void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
);
306 extern void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
);
312 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */
This page took 0.03526 seconds and 4 git commands to generate.