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
37 struct bt_ctf_event_class
;
38 struct bt_ctf_stream_class
;
42 * bt_ctf_stream_class_create: create a stream class.
44 * Allocate a new stream class of the given name. The creation of an event class
45 * sets its reference count to 1.
47 * A stream class' packet context is a structure initialized with the following
49 * - uint64_t timestamp_begin
50 * - uint64_t timestamp_end
51 * - uint64_t content_size
52 * - uint64_t packet_size
53 * - uint64_t events_discarded
55 * A stream class's event header is a structure initialized the following
58 * - uint64_t timestamp
60 * @param name Stream name.
62 * Returns an allocated stream class on success, NULL on error.
64 extern struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
);
67 * bt_ctf_stream_class_get_name: Get a stream class' name.
69 * @param stream_class Stream class.
71 * Returns the stream class' name, NULL on error.
73 extern const char *bt_ctf_stream_class_get_name(
74 struct bt_ctf_stream_class
*stream_class
);
77 * bt_ctf_stream_class_get_clock: get the clock associated with a stream class.
79 * @param stream_class Stream class.
81 * Returns a clock instance, NULL on error.
83 extern struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
84 struct bt_ctf_stream_class
*stream_class
);
87 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
89 * Assign a clock to a stream class. This clock will be sampled each time an
90 * event is appended to an instance of this stream class.
92 * @param stream_class Stream class.
93 * @param clock Clock to assign to the provided stream class.
95 * Returns 0 on success, a negative value on error.
97 extern int bt_ctf_stream_class_set_clock(
98 struct bt_ctf_stream_class
*stream_class
,
99 struct bt_ctf_clock
*clock
);
102 * bt_ctf_stream_class_get_id: Get a stream class' id.
104 * @param stream_class Stream class.
106 * Returns the stream class' id, a negative value on error.
108 extern int64_t bt_ctf_stream_class_get_id(
109 struct bt_ctf_stream_class
*stream_class
);
112 * bt_ctf_stream_class_set_id: Set a stream class' id.
114 * Set a stream class' id. Must be unique trace-wise.
115 * Note that stream classes are assigned a unique id when a stream instance
116 * is created for the first time from a trace or writer.
118 * @param stream_class Stream class.
119 * @param id Stream class id.
121 * Returns 0 on success, a negative value on error.
123 extern int bt_ctf_stream_class_set_id(
124 struct bt_ctf_stream_class
*stream_class
, uint32_t id
);
127 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
129 * Add an event class to a stream class. New events can be added even after a
130 * stream has beem instanciated and events have been appended. However, a stream
131 * will not accept events of a class that has not been registered beforehand.
132 * The stream class will share the ownership of "event_class" by incrementing
133 * its reference count.
135 * Note that an event class may only be added to one stream class.
137 * @param stream_class Stream class.
138 * @param event_class Event class to add to the provided stream class.
140 * Returns 0 on success, a negative value on error.
142 extern int bt_ctf_stream_class_add_event_class(
143 struct bt_ctf_stream_class
*stream_class
,
144 struct bt_ctf_event_class
*event_class
);
147 * bt_ctf_stream_class_get_event_class_count: Get a stream class' event class
150 * @param stream_class Stream class.
152 * Returns the stream class' event count, a negative value on error.
154 extern int bt_ctf_stream_class_get_event_class_count(
155 struct bt_ctf_stream_class
*stream_class
);
158 * bt_ctf_stream_class_get_event_class: Get stream class event class by index.
160 * @param stream_class Stream class.
161 * @param index Index of field.
163 * Returns event class, NULL on error.
165 extern struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
166 struct bt_ctf_stream_class
*stream_class
, int index
);
169 * bt_ctf_stream_class_get_event_class_by_name: Get stream class event class by
172 * @param stream_class Stream class.
173 * @param name Event name.
175 * Returns event class, NULL on error.
177 extern struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
178 struct bt_ctf_stream_class
*stream_class
, const char *name
);
181 * bt_ctf_stream_class_get_packet_context_type: get the stream class' packet
184 * @param stream_class Stream class.
186 * Returns the packet context's type (a structure), NULL on error.
188 extern struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
189 struct bt_ctf_stream_class
*stream_class
);
192 * bt_ctf_stream_class_set_packet_context_type: set the stream class' packet
195 * @param stream_class Stream class.
196 * @param packet_context_type Packet context type (must be a structure).
198 * Returns 0 on success, a negative value on error.
200 extern int bt_ctf_stream_class_set_packet_context_type(
201 struct bt_ctf_stream_class
*stream_class
,
202 struct bt_ctf_field_type
*packet_context_type
);
205 * bt_ctf_stream_class_get_event_header_type: get the stream class'
208 * @param stream_class Stream class.
210 * Returns the stream event header's type (a structure), NULL on error.
212 extern struct bt_ctf_field_type
*
213 bt_ctf_stream_class_get_event_header_type(
214 struct bt_ctf_stream_class
*stream_class
);
217 * bt_ctf_stream_class_set_event_header_type: set the stream class'
220 * @param stream_class Stream class.
221 * @param event_header_type Event header type (must be a structure).
223 * Returns 0 on success, a negative value on error.
225 extern int bt_ctf_stream_class_set_event_header_type(
226 struct bt_ctf_stream_class
*stream_class
,
227 struct bt_ctf_field_type
*event_header_type
);
230 * bt_ctf_stream_class_get_event_context_type: get the stream class'
231 * event context type.
233 * @param stream_class Stream class.
235 * Returns the stream event context's type (a structure), NULL on error.
237 extern struct bt_ctf_field_type
*
238 bt_ctf_stream_class_get_event_context_type(
239 struct bt_ctf_stream_class
*stream_class
);
242 * bt_ctf_stream_class_set_event_context_type: set the stream class'
243 * event context type.
245 * @param stream_class Stream class.
246 * @param event_context_type Event context type (must be a structure).
248 * Returns 0 on success, a negative value on error.
250 extern int bt_ctf_stream_class_set_event_context_type(
251 struct bt_ctf_stream_class
*stream_class
,
252 struct bt_ctf_field_type
*event_context_type
);
255 * bt_ctf_stream_class_get and bt_ctf_stream_class_put: increment and
256 * decrement the stream class' reference count.
258 * These functions ensure that the stream class won't be destroyed while it
259 * is in use. The same number of get and put (plus one extra put to
260 * release the initial reference done at creation) have to be done to
261 * destroy a stream class.
263 * When the stream class' reference count is decremented to 0 by a
264 * bt_ctf_stream_class_put, the stream class is freed.
266 * @param stream_class Stream class.
268 extern void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
);
269 extern void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
);
275 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */
This page took 0.036423 seconds and 4 git commands to generate.