1959d9569a4643ac4d62c7fb7e7eecb38385e3fb
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
34 #include <babeltrace/ctf-ir/visitor.h>
41 @defgroup ctfirstreamclass CTF IR stream class
43 @brief CTF IR stream class.
46 #include <babeltrace/ctf-ir/stream-class.h>
50 See \ref ctfirwriterstreamclass which documents additional CTF IR stream
51 class functions exclusive to the CTF IR writer mode.
53 A CTF IR <strong><em>stream class</em></strong> is a template that you
54 can use to create concrete \link ctfirstream CTF IR streams\endlink.
56 A stream class has the following properties, both of which \em must
57 be unique amongst all the stream classes contained in the same
58 \link ctfirtraceclass CTF IR trace class\endlink:
63 In the Babeltrace CTF IR system, a \link ctfirtraceclass trace class\endlink
64 contains zero or more stream classes,
65 and a stream class contains zero or more
66 \link ctfireventclass event classes\endlink.
67 You can add an event class
68 to a stream class with bt_ctf_stream_class_add_event_class().
69 You can add a stream class to a trace class with
70 bt_ctf_trace_add_stream_class().
72 A stream class owns three \link ctfirfieldtypes field types\endlink:
74 - An optional <strong>stream packet context</strong> field type, which
75 represents the \c stream.packet.context CTF scope.
76 - An optional <strong>stream event header</strong> field type, which
77 represents the \c stream.event.header CTF scope.
78 - An optional <strong>stream event context</strong> field type, which
79 represents the \c stream.event.context CTF scope.
81 Those three field types \em must be structure field types as of
82 Babeltrace \btversion.
84 As per the CTF specification, the event header field type \em must
85 contain a field named \c id if the stream class contains more than one
88 As a reminder, here's the structure of a CTF packet:
92 Before you can create a stream from a stream class with
93 bt_ctf_stream_create(), you \em must add the prepared stream class to a
94 trace class by calling bt_ctf_trace_add_stream_class().
96 As with any Babeltrace object, CTF IR stream class objects have
97 <a href="https://en.wikipedia.org/wiki/Reference_counting">reference
98 counts</a>. See \ref refs to learn more about the reference counting
99 management of Babeltrace objects.
101 The following functions \em freeze their stream class parameter on
104 - bt_ctf_trace_add_stream_class()
105 - bt_ctf_event_create()
106 - bt_ctf_writer_create_stream()
107 (\link ctfirwriter CTF IR writer\endlink mode only)
109 You cannot modify a frozen stream class: it is considered immutable,
112 - Adding an event class to it with
113 bt_ctf_stream_class_add_event_class().
114 - \link refs Reference counting\endlink.
119 @sa ctfirwriterstreamclass
122 @brief CTF IR stream class type and functions.
125 @addtogroup ctfirstreamclass
130 @struct bt_ctf_stream_class
131 @brief A CTF IR stream class.
134 struct bt_ctf_stream_class
;
135 struct bt_ctf_event_class
;
139 @name Creation and parent access functions
144 @brief Creates a default CTF IR stream class named \p name, or a
145 default unnamed stream class if \p name is \c NULL.
147 On success, the packet context field type of the created stream class
148 has the following fields:
150 - <code>timestamp_begin</code>: a 64-bit unsigned integer field type.
151 - <code>timestamp_end</code>: a 64-bit unsigned integer field type.
152 - <code>content_size</code>: a 64-bit unsigned integer field type.
153 - <code>packet_size</code>: a 64-bit unsigned integer field type.
154 - <code>events_discarded</code>: a 64-bit unsigned integer field type.
156 On success, the event header field type of the created stream class
157 has the following fields:
159 - <code>code</code>: a 32-bit unsigned integer field type.
160 - <code>timestamp</code>: a 64-bit unsigned integer field type.
162 You can modify those default field types after the stream class is
163 created with bt_ctf_stream_class_set_packet_context_type() and
164 bt_ctf_stream_class_set_event_header_type().
166 @param[in] name Name of the stream class to create (can be \c NULL to
167 create an unnamed stream class).
168 @returns Created stream class, or \c NULL on error.
170 @postsuccessrefcountret1
172 extern struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
);
175 @brief Returns the parent CTF IR trace class of the CTF IR stream
176 class \p stream_class.
178 It is possible that the stream class was not added to a trace class
179 yet, in which case this function returns \c NULL. You can add a
180 stream class to a trace class with
181 bt_ctf_trace_add_stream_class().
183 @param[in] stream_class Stream class of which to get the parent
185 @returns Parent trace class of \p stream_class,
186 or \c NULL if \p stream_class was not
187 added to a trace class yet or on error.
189 @prenotnull{stream_class}
190 @postsuccessrefcountretinc
192 @sa bt_ctf_trace_add_stream_class(): Add a stream class to
195 extern struct bt_ctf_trace
*bt_ctf_stream_class_get_trace(
196 struct bt_ctf_stream_class
*stream_class
);
201 @name Properties functions
206 @brief Returns the name of the CTF IR stream class \p stream_class.
208 On success, \p stream_class remains the sole owner of the returned
211 @param[in] stream_class Stream class of which to get the name.
212 @returns Name of stream class \p stream_class, or
213 \c NULL if \p stream_class is unnamed or
216 @prenotnull{stream_class}
217 @postrefcountsame{stream_class}
219 @sa bt_ctf_stream_class_set_name(): Sets the name of a given
222 extern const char *bt_ctf_stream_class_get_name(
223 struct bt_ctf_stream_class
*stream_class
);
226 @brief Sets the name of the CTF IR stream class
227 \p stream_class to \p name.
229 \p name must be unique amongst the names of all the stream classes
230 of the trace class to which you eventually add \p stream_class.
232 @param[in] stream_class Stream class of which to set the name.
233 @param[in] name Name of the stream class (copied on success).
234 @returns 0 on success, or a negative value on error.
236 @prenotnull{stream_class}
238 @prehot{stream_class}
239 @postrefcountsame{stream_class}
241 @sa bt_ctf_stream_class_get_name(): Returns the name of a given
244 extern int bt_ctf_stream_class_set_name(
245 struct bt_ctf_stream_class
*stream_class
, const char *name
);
248 @brief Returns the numeric ID of the CTF IR stream class \p stream_class.
250 @param[in] stream_class Stream class of which to get the numeric ID.
251 @returns ID of stream class \p stream_class, or a
252 negative value on error.
254 @prenotnull{stream_class}
255 @postrefcountsame{stream_class}
257 @sa bt_ctf_stream_class_set_id(): Sets the numeric ID of a given
260 extern int64_t bt_ctf_stream_class_get_id(
261 struct bt_ctf_stream_class
*stream_class
);
264 @brief Sets the numeric ID of the CTF IR stream class
265 \p stream_class to \p id.
267 \p id must be unique amongst the IDs of all the stream classes
268 of the trace class to which you eventually add \p stream_class.
270 @param[in] stream_class Stream class of which to set the numeric ID.
271 @param[in] id ID of the stream class.
272 @returns 0 on success, or a negative value on error.
274 @prenotnull{stream_class}
275 @prehot{stream_class}
276 @postrefcountsame{stream_class}
278 @sa bt_ctf_stream_class_get_id(): Returns the numeric ID of a given
281 extern int bt_ctf_stream_class_set_id(
282 struct bt_ctf_stream_class
*stream_class
, uint32_t id
);
287 @name Contained field types functions
292 @brief Returns the packet context field type of the CTF IR stream class
295 @param[in] stream_class Stream class of which to get the packet
297 @returns Packet context field type of \p stream_class,
300 @prenotnull{stream_class}
301 @postsuccessrefcountretinc
303 @sa bt_ctf_stream_class_set_packet_context_type(): Sets the packet
304 context field type of a given stream class.
306 extern struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
307 struct bt_ctf_stream_class
*stream_class
);
310 @brief Sets the packet context field type of the CTF IR stream class
311 \p stream_class to \p packet_context_type.
313 As of Babeltrace \btversion, \p packet_context_type \em must be a
314 CTF IR structure field type object.
316 @param[in] stream_class Stream class of which to set the packet
318 @param[in] packet_context_type Packet context field type.
319 @returns 0 on success, or a negative value on error.
321 @prenotnull{stream_class}
322 @prenotnull{packet_context_type}
323 @prehot{stream_class}
324 @preisstructft{packet_context_type}
325 @postrefcountsame{stream_class}
326 @postsuccessrefcountinc{packet_context_type}
328 @sa bt_ctf_stream_class_get_packet_context_type(): Returns the packet
329 context field type of a given stream class.
331 extern int bt_ctf_stream_class_set_packet_context_type(
332 struct bt_ctf_stream_class
*stream_class
,
333 struct bt_ctf_field_type
*packet_context_type
);
336 @brief Returns the event header field type of the CTF IR stream class
339 @param[in] stream_class Stream class of which to get the event header
341 @returns Event header field type of \p stream_class,
344 @prenotnull{stream_class}
345 @postsuccessrefcountretinc
347 @sa bt_ctf_stream_class_set_event_header_type(): Sets the event
348 header field type of a given stream class.
350 extern struct bt_ctf_field_type
*
351 bt_ctf_stream_class_get_event_header_type(
352 struct bt_ctf_stream_class
*stream_class
);
355 @brief Sets the event header field type of the CTF IR stream class
356 \p stream_class to \p event_header_type.
358 As of Babeltrace \btversion, \p event_header_type \em must be a
359 CTF IR structure field type object.
361 @param[in] stream_class Stream class of which to set the event
363 @param[in] event_header_type Event header field type.
364 @returns 0 on success, or a negative value on error.
366 @prenotnull{stream_class}
367 @prenotnull{event_header_type}
368 @prehot{stream_class}
369 @preisstructft{event_header_type}
370 @postrefcountsame{stream_class}
371 @postsuccessrefcountinc{event_header_type}
373 @sa bt_ctf_stream_class_get_event_header_type(): Returns the event
374 header field type of a given stream class.
376 extern int bt_ctf_stream_class_set_event_header_type(
377 struct bt_ctf_stream_class
*stream_class
,
378 struct bt_ctf_field_type
*event_header_type
);
381 @brief Returns the per-stream class event context field type of the
382 CTF IR stream class \p stream_class.
384 @param[in] stream_class Stream class of which to get the per-stream
385 class event context field type.
386 @returns Per-stream class event context field type of
387 \p stream_class, or \c NULL on error.
389 @prenotnull{stream_class}
390 @postsuccessrefcountretinc
392 @sa bt_ctf_stream_class_set_event_context_type(): Sets the per-stream
393 class event context field type of a given stream class.
395 extern struct bt_ctf_field_type
*
396 bt_ctf_stream_class_get_event_context_type(
397 struct bt_ctf_stream_class
*stream_class
);
400 @brief Sets the per-stream class event context field type of the CTF
401 IR stream class \p stream_class to \p event_context_type.
403 As of Babeltrace \btversion, \p event_context_type \em must be a
404 CTF IR structure field type object.
406 @param[in] stream_class Stream class of which to set the
407 per-stream class event context
409 @param[in] event_context_type Per-stream class event context context
411 @returns 0 on success, or a negative value on error.
413 @prenotnull{stream_class}
414 @prenotnull{event_context_type}
415 @prehot{stream_class}
416 @preisstructft{event_context_type}
417 @postrefcountsame{stream_class}
418 @postsuccessrefcountinc{event_context_type}
420 @sa bt_ctf_stream_class_get_event_context_type(): Returns the per-stream
421 class event context field type of a given stream class.
423 extern int bt_ctf_stream_class_set_event_context_type(
424 struct bt_ctf_stream_class
*stream_class
,
425 struct bt_ctf_field_type
*event_context_type
);
430 @name Event class children functions
435 @brief Returns the number of event classes contained in the
436 CTF IR stream class \p stream_class.
438 @param[in] stream_class Stream class of which to get the number
439 of children event classes.
440 @returns Number of children event classes
441 contained in \p stream_class, or
442 a negative value on error.
444 @prenotnull{stream_class}
445 @postrefcountsame{stream_class}
447 extern int bt_ctf_stream_class_get_event_class_count(
448 struct bt_ctf_stream_class
*stream_class
);
451 @brief Returns the event class at index \p index in the CTF IR stream
452 class \p stream_class.
454 @param[in] stream_class Stream class of which to get the event class.
455 @param[in] index Index of the event class to find.
456 @returns Event class at index \p index, or \c NULL
459 @prenotnull{stream_class}
460 @pre \p index is lesser than the number of event classes contained in the
461 stream class \p stream_class (see
462 bt_ctf_stream_class_get_event_class_count()).
463 @postrefcountsame{stream_class}
464 @postsuccessrefcountretinc
466 @sa bt_ctf_stream_class_get_event_class_by_id(): Finds an event class
468 @sa bt_ctf_stream_class_get_event_class_by_name(): Finds an event class
471 extern struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class(
472 struct bt_ctf_stream_class
*stream_class
, int index
);
475 @brief Returns the event class named \c name found in the CTF IR stream
476 class \p stream_class.
478 @param[in] stream_class Stream class of which to get the event class.
479 @param[in] name Name of the event class to find.
480 @returns Event class named \p name, or \c NULL
483 @prenotnull{stream_class}
485 @postrefcountsame{stream_class}
486 @postsuccessrefcountretinc
488 @sa bt_ctf_stream_class_get_event_class_by_id(): Finds an event class
491 extern struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_name(
492 struct bt_ctf_stream_class
*stream_class
, const char *name
);
495 @brief Returns the event class with ID \c id found in the CTF IR stream
496 class \p stream_class.
498 @param[in] stream_class Stream class of which to get the event class.
499 @param[in] id ID of the event class to find.
500 @returns Event class with ID \p id, or \c NULL
503 @prenotnull{stream_class}
504 @postrefcountsame{stream_class}
505 @postsuccessrefcountretinc
507 @sa bt_ctf_stream_class_get_event_class_by_name(): Finds an event class
510 extern struct bt_ctf_event_class
*bt_ctf_stream_class_get_event_class_by_id(
511 struct bt_ctf_stream_class
*stream_class
, uint32_t id
);
514 @brief Adds the CTF IR event class \p event_class to the
515 CTF IR stream class \p stream_class.
517 On success, \p event_class becomes the child of \p stream_class.
519 You can only add a given event class to one stream class.
521 You can call this function even if \p stream_class is frozen. Adding
522 event classes is the only operation that is permitted
523 on a frozen stream class.
525 @param[in] stream_class Stream class to which to add \p event_class.
526 @param[in] event_class Event class to add to \p stream_class.
527 @returns 0 on success, or a negative value on error.
529 @prenotnull{stream_class}
530 @prenotnull{event_class}
532 @postrefcountsame{stream_class}
533 @postsuccessrefcountinc{event_class}
534 @postsuccessfrozen{event_class}
536 extern int bt_ctf_stream_class_add_event_class(
537 struct bt_ctf_stream_class
*stream_class
,
538 struct bt_ctf_event_class
*event_class
);
548 @brief Accepts the visitor \p visitor to visit the hierarchy of the
549 CTF IR stream class \p stream_class.
551 This function traverses the hierarchy of \p stream_class in pre-order
552 and calls \p visitor on each element.
554 The stream class itself is visited first, and then all its children
557 @param[in] stream_class Stream class to visit.
558 @param[in] visitor Visiting function.
559 @param[in] data User data.
560 @returns 0 on success, or a negative value on error.
562 @prenotnull{stream_class}
565 extern int bt_ctf_stream_class_visit(struct bt_ctf_stream_class
*stream_class
,
566 bt_ctf_visitor visitor
, void *data
);
572 // TODO: document for writer
573 extern struct bt_ctf_clock
*bt_ctf_stream_class_get_clock(
574 struct bt_ctf_stream_class
*stream_class
);
580 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */
This page took 0.041098 seconds and 4 git commands to generate.