5052f70fa551452ef09e745cf222b7f6e583e963
1 #ifndef BABELTRACE_CTF_IR_EVENT_CLASS_H
2 #define BABELTRACE_CTF_IR_EVENT_CLASS_H
5 * BabelTrace - CTF IR: Event class
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
35 #include <babeltrace/values.h>
42 @defgroup ctfireventclass CTF IR event class
44 @brief CTF IR event class.
47 #include <babeltrace/ctf-ir/event-class.h>
50 A CTF IR <strong><em>event class</em></strong> is a template that you
51 can use to create concrete \link ctfirevent CTF IR events\endlink.
53 An event class has the following properties, both of which \em must
54 be unique amongst all the event classes contained in the same
55 \link ctfirstreamclass CTF IR stream class\endlink:
60 A CTF IR event class owns two
61 \link ctfirfieldtypes field types\endlink:
63 - An optional <strong>event context</strong> field type, which
64 represents the \c event.context CTF scope.
65 - A mandatory <strong>event payload</strong> field type, which
66 represents the \c event.fields CTF scope.
68 Both field types \em must be structure field types as of
69 Babeltrace \btversion.
70 The event payload field type <em>must not</em> be empty.
72 As a reminder, here's the structure of a CTF packet:
76 In the Babeltrace CTF IR system, a \link ctfirtraceclass trace
77 class\endlink contains zero or more \link ctfirstreamclass stream
78 classes\endlink, and a stream class contains zero or more event classes.
80 Before you can create an event from an event class with
81 bt_ctf_event_create(), you \em must add the prepared event class to a
82 stream class by calling bt_ctf_stream_class_add_event_class(). This
83 function, when successful, \em freezes the event class, disallowing any
84 future modification of its properties and field types by the user.
86 As with any Babeltrace object, CTF IR event class objects have
87 <a href="https://en.wikipedia.org/wiki/Reference_counting">reference
88 counts</a>. See \ref refs to learn more about the reference counting
89 management of Babeltrace objects.
91 bt_ctf_stream_class_add_event_class() \em freezes its event class
92 parameter on success. You cannot modify a frozen event class: it is
93 considered immutable, except for \link refs reference counting\endlink.
99 @brief CTF IR event class type and functions.
102 @addtogroup ctfireventclass
107 @struct bt_ctf_event_class
108 @brief A CTF IR event class.
111 struct bt_ctf_event_class
;
113 struct bt_ctf_field_type
;
114 struct bt_ctf_stream_class
;
117 @name Creation and parent access functions
122 @brief Creates a default CTF IR event class named \p name.
124 The event class is created \em without an event context
125 \link ctfirfieldtypes field type\endlink and with an empty event
128 Upon creation, the event class's ID is <em>not set</em>. You
129 can set it to a specific value with bt_ctf_event_class_set_id(). If it
130 is still unset when you call bt_ctf_stream_class_add_event_class(), then
131 the stream class assigns a unique ID to this event class before
134 @param[in] name Name of the event class to create (copied on success).
135 @returns Created event class, or \c NULL on error.
138 @postsuccessrefcountret1
140 extern struct bt_ctf_event_class
*bt_ctf_event_class_create(const char *name
);
143 @brief Returns the parent CTF IR stream class of the CTF IR event
144 class \p event_class.
146 It is possible that the event class was not added to a stream class
147 yet, in which case this function returns \c NULL. You can add an
148 event class to a stream class with
149 bt_ctf_stream_class_add_event_class().
151 @param[in] event_class Event class of which to get the parent
153 @returns Parent stream class of \p event_class,
154 or \c NULL if \p event_class was not
155 added to a stream class yet or on error.
157 @prenotnull{event_class}
158 @postrefcountsame{event_class}
159 @postsuccessrefcountretinc
161 @sa bt_ctf_stream_class_add_event_class(): Add an event class to
164 extern struct bt_ctf_stream_class
*bt_ctf_event_class_get_stream_class(
165 struct bt_ctf_event_class
*event_class
);
170 @name Attribute functions
175 @brief Returns the name of the CTF IR event class \p event_class.
177 On success, \p event_class remains the sole owner of the returned
180 @param[in] event_class Event class of which to get the name.
181 @returns Name of event class \p event_class, or
184 @prenotnull{event_class}
185 @postrefcountsame{event_class}
187 extern const char *bt_ctf_event_class_get_name(
188 struct bt_ctf_event_class
*event_class
);
191 @brief Returns the numeric ID of the CTF IR event class \p event_class.
193 @param[in] event_class Event class of which to get the numeric ID.
194 @returns ID of event class \p event_class, or a
195 negative value on error.
197 @prenotnull{event_class}
198 @postrefcountsame{event_class}
200 @sa bt_ctf_event_class_set_id(): Sets the numeric ID of a given
203 extern int64_t bt_ctf_event_class_get_id(
204 struct bt_ctf_event_class
*event_class
);
207 @brief Sets the numeric ID of the CTF IR event class
208 \p event_class to \p id.
210 \p id must be unique amongst the IDs of all the event classes
211 of the stream class to which you eventually add \p event_class.
213 @param[in] event_class Event class of which to set the numeric ID.
214 @param[in] id ID of the event class.
215 @returns 0 on success, or a negative value on error.
217 @prenotnull{event_class}
219 @pre \p id is lesser than or equal to 9223372036854775807 (\c INT64_MAX).
220 @postrefcountsame{event_class}
222 @sa bt_ctf_event_class_get_id(): Returns the numeric ID of a given
225 extern int bt_ctf_event_class_set_id(
226 struct bt_ctf_event_class
*event_class
, uint64_t id
);
229 @brief Returns the number of attributes contained in the CTF IR event
230 class \p event_class.
232 @param[in] event_class Event class of which to get the number
233 of contained attributes.
234 @returns Number of contained attributes in
235 \p event_class, or a negative value on error.
237 @prenotnull{event_class}
238 @postrefcountsame{event_class}
240 @sa bt_ctf_event_class_get_attribute_name_by_index(): Returns the name
241 of the attribute of a given event class at a given index.
242 @sa bt_ctf_event_class_get_attribute_value_by_index(): Returns the value
243 of the attribute of a given event class at a given index.
245 extern int64_t bt_ctf_event_class_get_attribute_count(
246 struct bt_ctf_event_class
*event_class
);
249 @brief Returns the name of the attribute at the index \p index of the
250 CTF IR event class \p event_class.
252 On success, \p event_class remains the sole owner of the returned
255 @param[in] event_class Event class of which to get the name
257 @param[in] index Index of the attribute of which to get the name.
258 @returns Attribute name, or \c NULL on error.
260 @prenotnull{event_class}
261 @pre \p index is lesser than the number of attributes contained by
263 @postrefcountsame{event_class}
265 @sa bt_ctf_event_class_get_attribute_value_by_index(): Returns the value
266 of the attribute of a given event class at a given index.
269 bt_ctf_event_class_get_attribute_name_by_index(
270 struct bt_ctf_event_class
*event_class
, uint64_t index
);
273 @brief Returns the value of the attribute at the index \p index of the
274 CTF IR event class \p event_class.
276 @param[in] event_class Event class of which to get the value
278 @param[in] index Index of the attribute of which to get the value.
279 @returns Attribute value, or \c NULL on error.
281 @prenotnull{event_class}
282 @pre \p index is lesser than the number of attributes contained by
284 @postsuccessrefcountretinc
285 @postrefcountsame{event_class}
287 @sa bt_ctf_event_class_get_attribute_name_by_index(): Returns the name
288 of the attribute of a given event class at a given index.
290 extern struct bt_value
*
291 bt_ctf_event_class_get_attribute_value_by_index(
292 struct bt_ctf_event_class
*event_class
, uint64_t index
);
295 @brief Returns the value of the attribute named \p name of the CTF IR
296 event class \p event_class.
298 On success, the reference count of the returned value object is
301 @param[in] event_class Event class of which to get the value
303 @param[in] name Name of the attribute to get.
304 @returns Attribute value, or \c NULL on error.
306 @prenotnull{event_class}
308 @postsuccessrefcountretinc
309 @postrefcountsame{event_class}
311 extern struct bt_value
*
312 bt_ctf_event_class_get_attribute_value_by_name(
313 struct bt_ctf_event_class
*event_class
, const char *name
);
316 @brief Sets the attribute named \p name of the CTF IR event class
317 \p event_class to the value \p value.
319 Valid attributes, as of Babeltrace \btversion, are:
321 - <code>id</code>: \em must be an integer value object with a raw value
322 that is greater than or equal to 0. This represents the event class's
323 numeric ID and you can also set it with bt_ctf_event_class_set_id().
325 - <code>name</code>: must be a string value object. This represents
326 the name of the event class.
328 - <code>loglevel</code>: must be an integer value object with a raw
329 value greater than or equal to 0. This represents the numeric log level
330 associated with this event class. Log level values
331 are application-specific.
333 - <code>model.emf.uri</code>: must be a string value object. This
334 represents the application-specific Eclipse Modeling Framework URI
337 @param[in] event_class Event class of which to set an
339 @param[in] name Attribute name (copied on success).
340 @param[in] value Attribute value.
341 @returns 0 on success, or a negative value on error.
343 @prenotnull{event_class}
347 @postrefcountsame{event_class}
348 @postsuccessrefcountinc{value}
350 @sa bt_ctf_event_class_get_attribute_value_by_name(): Returns the
351 attribute of a given event class having a given name.
353 extern int bt_ctf_event_class_set_attribute(
354 struct bt_ctf_event_class
*event_class
, const char *name
,
355 struct bt_value
*value
);
360 @name Contained field types functions
365 @brief Returns the context field type of the CTF IR event class
368 @param[in] event_class Event class of which to get the context field type.
369 @returns Context field type of \p event_class, or \c NULL if
370 \p event_class has no context field type or on error.
372 @prenotnull{event_class}
373 @postrefcountsame{event_class}
374 @post <strong>On success, if the return value is a field type</strong>, its
375 reference count is incremented.
377 @sa bt_ctf_event_class_set_context_type(): Sets the context field type of a
380 extern struct bt_ctf_field_type
*bt_ctf_event_class_get_context_type(
381 struct bt_ctf_event_class
*event_class
);
384 @brief Sets the context field type of the CTF IR event class \p event_class to
385 \p context_type, or unsets the current context field type from
388 If \p context_type is \c NULL, then this function unsets the current context
389 field type from \p event_class, effectively making \p event_class an event class
390 without a context field type.
392 As of Babeltrace \btversion, if \p context_type is not \c NULL,
393 \p context_type \em must be a CTF IR structure field type object.
395 @param[in] event_class Event class of which to set the context field
397 @param[in] context_type Context field type, or \c NULL to unset the
398 current context field type.
399 @returns 0 on success, or a negative value on error.
401 @prenotnull{event_class}
403 @pre <strong>If \p context_type is not \c NULL</strong>, \p context_type is a
404 CTF IR structure field type.
405 @postrefcountsame{event_class}
406 @post <strong>On success, if \p context_type is not \c NULL</strong>,
407 the reference count of \p context_type is incremented.
409 @sa bt_ctf_event_class_get_context_type(): Returns the context field type of a
412 extern int bt_ctf_event_class_set_context_type(
413 struct bt_ctf_event_class
*event_class
,
414 struct bt_ctf_field_type
*context_type
);
417 @brief Returns the payload field type of the CTF IR event class
420 @param[in] event_class Event class of which to get the payload field type.
421 @returns Payload field type of \p event_class, or \c NULL if
422 \p event_class has no payload field type or on error.
424 @prenotnull{event_class}
425 @postrefcountsame{event_class}
426 @post <strong>On success, if the return value is a field type</strong>, its
427 reference count is incremented.
429 @sa bt_ctf_event_class_set_payload_type(): Sets the payload field type of a
432 extern struct bt_ctf_field_type
*bt_ctf_event_class_get_payload_type(
433 struct bt_ctf_event_class
*event_class
);
436 @brief Sets the payload field type of the CTF IR event class \p event_class to
437 \p payload_type, or unsets the current payload field type from
440 If \p payload_type is \c NULL, then this function unsets the current payload
441 field type from \p event_class, effectively making \p event_class an event class
442 without a payload field type.
444 As of Babeltrace \btversion, if \p payload_type is not \c NULL,
445 \p payload_type \em must be a CTF IR structure field type object.
447 @param[in] event_class Event class of which to set the payload field
449 @param[in] payload_type Payload field type, or \c NULL to unset the
450 current payload field type.
451 @returns 0 on success, or a negative value on error.
453 @prenotnull{event_class}
455 @pre <strong>If \p payload_type is not \c NULL</strong>, \p payload_type is a
456 CTF IR structure field type.
457 @postrefcountsame{event_class}
458 @post <strong>On success, if \p payload_type is not \c NULL</strong>,
459 the reference count of \p payload_type is incremented.
461 @sa bt_ctf_event_class_get_payload_type(): Returns the payload field type of a
464 extern int bt_ctf_event_class_set_payload_type(
465 struct bt_ctf_event_class
*event_class
,
466 struct bt_ctf_field_type
*payload_type
);
469 @brief Returns the number of fields contained in the
470 payload field type of the CTF IR event class \p event_class.
473 Calling this function is the equivalent of getting the payload field
474 type of \p event_class with bt_ctf_event_class_get_payload_type() and
475 getting its field count with
476 bt_ctf_field_type_structure_get_field_count().
478 @param[in] event_class Event class of which to get the number
479 of fields contained in its payload field type.
480 @returns Number of fields in the payload field type
481 of \p event_class, or a negative value on error.
483 @prenotnull{event_class}
484 @postrefcountsame{event_class}
486 extern int64_t bt_ctf_event_class_get_payload_type_field_count(
487 struct bt_ctf_event_class
*event_class
);
490 @brief Returns the type and the name of the field at index \p index
491 in the payload field type of the CTF IR event class
494 On success, the field's type is placed in \p *field_type if
495 \p field_type is not \c NULL. The field's name is placed in
496 \p *name if \p name is not \c NULL. \p event_class remains the sole
499 Both \p name and \p field_type can be \c NULL if the caller is not
500 interested in one of them.
503 Calling this function is the equivalent of getting the payload field
504 type of \p event_class with bt_ctf_event_class_get_payload_type() and
505 getting the type and name of one of its field with
506 bt_ctf_field_type_structure_get_field().
508 @param[in] event_class Event class of which to get the type and name
509 of a field in its payload field type.
510 @param[out] field_name Name of the field at the index
511 \p index in the payload field type of
512 \p event_class (can be \c NULL).
513 @param[out] field_type Type of the field at the index \p index in the
514 payload field type of \p event_class
516 @param[in] index Index of the payload field type's field to find.
517 @returns 0 on success, or a negative value on error.
519 @prenotnull{event_class}
520 @pre \p index is lesser than the number of fields contained in the
521 payload field type of \p event_class (see
522 bt_ctf_event_class_get_payload_type_field_count()).
523 @postrefcountsame{event_class}
524 @post <strong>On success, if \p field_type is not \c NULL</strong>, the
525 reference count of \p *field_type is incremented.
527 extern int bt_ctf_event_class_get_payload_type_field_by_index(
528 struct bt_ctf_event_class
*event_class
,
529 const char **field_name
, struct bt_ctf_field_type
**field_type
,
533 @brief Returns the type of the field named \p name in the payload
534 field type of the CTF IR event class \p event_class.
537 Calling this function is the equivalent of getting the payload field
538 type of \p event_class with bt_ctf_event_class_get_payload_type() and
539 getting the type of one of its field with
540 bt_ctf_field_type_structure_get_field_type_by_name().
542 @param[in] event_class Event class of which to get the type of a
543 payload field type's field.
544 @param[in] name Name of the payload field type's field to get.
545 @returns Type of the field named \p name in the payload
546 field type of \p event_class, or \c NULL if
547 the function cannot find the field or
550 @prenotnull{event_class}
552 @postrefcountsame{event_class}
553 @postsuccessrefcountretinc
555 extern struct bt_ctf_field_type
*
556 bt_ctf_event_class_get_payload_type_field_type_by_name(
557 struct bt_ctf_event_class
*event_class
, const char *name
);
559 /* Pre-2.0 CTF writer compatibility */
560 #define bt_ctf_event_class_get_field_by_name bt_ctf_event_class_get_payload_type_field_type_by_name
563 @brief Adds a field named \p name with the type \p field_type to the
564 payload field type of the CTF IR event class \p event_class.
567 Calling this function is the equivalent of getting the payload field
568 type of \p event_class with bt_ctf_event_class_get_payload_type() and
569 adding a field to it with bt_ctf_field_type_structure_add_field().
571 @param[in] event_class Event class containing the payload field
572 type in which to add a field.
573 @param[in] field_type Type of the field to add.
574 @param[in] name Name of the field to add (copied on
576 @returns 0 on success, or a negative value on error.
578 @prenotnull{event_class}
582 @postrefcountsame{event_class}
583 @postsuccessrefcountinc{field_type}
585 extern int bt_ctf_event_class_add_field(struct bt_ctf_event_class
*event_class
,
586 struct bt_ctf_field_type
*field_type
,
597 #endif /* BABELTRACE_CTF_IR_EVENT_CLASS_H */
This page took 0.042547 seconds and 4 git commands to generate.