1 #ifndef BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H
2 #define BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H
5 * Babeltrace - CTF IR: Event class internal
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
30 #include <babeltrace/ctf-ir/field-types.h>
31 #include <babeltrace/ctf-ir/fields.h>
32 #include <babeltrace/babeltrace-internal.h>
33 #include <babeltrace/values.h>
34 #include <babeltrace/ctf/types.h>
35 #include <babeltrace/ctf-ir/stream-class.h>
36 #include <babeltrace/object-internal.h>
39 #define BT_CTF_EVENT_CLASS_ATTR_ID_INDEX 0
40 #define BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX 1
42 struct bt_ctf_event_class
{
43 struct bt_object base
;
44 struct bt_value
*attributes
;
45 /* Structure type containing the event's context */
46 struct bt_ctf_field_type
*context
;
47 /* Structure type containing the event's fields */
48 struct bt_ctf_field_type
*fields
;
52 * This flag indicates if the event class is valid. A valid
53 * event class is _always_ frozen. However, an event class
54 * may be frozen, but not valid yet. This is okay, as long as
55 * no events are created out of this event class.
61 void bt_ctf_event_class_freeze(struct bt_ctf_event_class
*event_class
);
64 int bt_ctf_event_class_serialize(struct bt_ctf_event_class
*event_class
,
65 struct metadata_context
*context
);
68 void bt_ctf_event_class_set_native_byte_order(
69 struct bt_ctf_event_class
*event_class
,
73 int bt_ctf_event_class_set_stream_id(struct bt_ctf_event_class
*event_class
,
77 * bt_ctf_event_class_set_attribute: sets an attribute to the event
80 * Sets an attribute to the event class. The name parameter is copied,
81 * whereas the value parameter's reference count is incremented
82 * (if the function succeeds).
84 * If an attribute exists in the event class for the specified name, it
85 * is replaced by the new value.
87 * Valid attributes and object types are:
89 * - "id": integer object with a value >= 0
90 * - "name": string object
91 * - "loglevel": integer object with a value >= 0
92 * - "model.emf.uri": string object
94 * @param event_class Event class.
95 * @param name Name of the attribute (will be copied).
96 * @param value Value of the attribute.
98 * Returns 0 on success, a negative value on error.
101 int bt_ctf_event_class_set_attribute(
102 struct bt_ctf_event_class
*event_class
, const char *name
,
103 struct bt_value
*value
);
106 * bt_ctf_event_class_get_attribute_count: get the number of attributes
107 * in this event class.
109 * Get the event class' attribute count.
111 * @param event_class Event class.
113 * Returns the attribute count, a negative value on error.
116 int bt_ctf_event_class_get_attribute_count(
117 struct bt_ctf_event_class
*event_class
);
120 * bt_ctf_event_class_get_attribute_name: get attribute name.
122 * Get an attribute's name. The string's ownership is not
123 * transferred to the caller. The string data is valid as long as
124 * this event class' attributes are not modified.
126 * @param event_class Event class.
127 * @param index Index of the attribute.
129 * Returns the attribute's name, NULL on error.
133 bt_ctf_event_class_get_attribute_name(
134 struct bt_ctf_event_class
*event_class
, int index
);
137 * bt_ctf_event_class_get_attribute_value: get attribute value (an object).
139 * Get an attribute's value (an object). The returned object's
140 * reference count is incremented. When done with the object, the caller
141 * must call bt_value_put() on it.
143 * @param event_class Event class.
144 * @param index Index of the attribute.
146 * Returns the attribute's object value, NULL on error.
150 bt_ctf_event_class_get_attribute_value(struct bt_ctf_event_class
*event_class
,
154 * bt_ctf_event_class_get_attribute_value_by_name: get attribute
155 * value (an object) by name.
157 * Get an attribute's value (an object) by its name. The returned object's
158 * reference count is incremented. When done with the object, the caller
159 * must call bt_value_put() on it.
161 * @param event_class Event class.
162 * @param name Attribute's name
164 * Returns the attribute's object value, NULL on error.
168 bt_ctf_event_class_get_attribute_value_by_name(
169 struct bt_ctf_event_class
*event_class
, const char *name
);
172 * bt_ctf_event_class_get_context_type: Get an event class's context type
174 * @param event_class Event class.
176 * Returns a field type (a structure) on success, NULL on error.
179 struct bt_ctf_field_type
*bt_ctf_event_class_get_context_type(
180 struct bt_ctf_event_class
*event_class
);
184 * bt_ctf_event_class_get_field_count: Get an event class' field count.
186 * @param event_class Event class.
188 * Returns the event class' field count, a negative value on error.
190 * Note: Returns an error if the payload is not a structure.
193 int bt_ctf_event_class_get_field_count(
194 struct bt_ctf_event_class
*event_class
);
197 * bt_ctf_event_class_get_field: Get event class' field type and name by index.
199 * @param event_class Event class.
200 * @param field_name Pointer to a const char* where the field's name will
202 * @param field_type Pointer to a bt_ctf_field_type* where the field's type will
204 * @param index Index of field.
206 * Returns 0 on success, a negative error on value.
208 * Note: Returns an error if the payload is not a structure.
211 int bt_ctf_event_class_get_field(struct bt_ctf_event_class
*event_class
,
212 const char **field_name
, struct bt_ctf_field_type
**field_type
,
216 * bt_ctf_event_class_get_id: Get an event class' id.
218 * @param event_class Event class.
220 * Returns the event class' id, a negative value on error.
223 int64_t bt_ctf_event_class_get_id(struct bt_ctf_event_class
*event_class
);
226 * bt_ctf_event_class_get_name: Get an event class' name.
228 * @param event_class Event class.
230 * Returns the event class' name, NULL on error.
233 const char *bt_ctf_event_class_get_name(
234 struct bt_ctf_event_class
*event_class
);
237 * bt_ctf_event_class_get_stream_class: Get an event class' stream class.
239 * @param event_class Event class.
241 * Returns the event class' stream class, NULL on error or if the event class
242 * is not associated with a stream class.
245 struct bt_ctf_stream_class
*bt_ctf_event_class_get_stream_class(
246 struct bt_ctf_event_class
*event_class
);
249 * bt_ctf_event_class_get_payload_type: get an event class' payload.
251 * Get an event class' payload type.
253 * @param event_class Event class.
255 * Returns the event class' payload, NULL on error.
258 struct bt_ctf_field_type
*bt_ctf_event_class_get_payload_type(
259 struct bt_ctf_event_class
*event_class
);
262 * bt_ctf_event_class_set_id: Set an event class' id.
264 * Set an event class' id. Must be unique stream-wise.
265 * Note that event classes are already assigned a unique id when added to a
266 * stream class if none was set explicitly.
268 * @param event_class Event class.
269 * @param id Event class id.
271 * Returns 0 on success, a negative value on error.
274 int bt_ctf_event_class_set_id(
275 struct bt_ctf_event_class
*event_class
, uint32_t id
);
278 * bt_ctf_event_class_set_payload_type: set an event class' payload.
280 * Set an event class' payload type.
282 * @param event_class Event class.
283 * @param payload The payload's type (must be a structure).
285 * Returns 0 on success, a negative value on error.
288 int bt_ctf_event_class_set_payload_type(
289 struct bt_ctf_event_class
*event_class
,
290 struct bt_ctf_field_type
*payload
);
293 * bt_ctf_event_class_set_context_type: Set an event class's context type
295 * @param event_class Event class.
296 * @param context Event context field type (must be a structure).
298 * Returns 0 on success, a negative value on error.
301 int bt_ctf_event_class_set_context_type(
302 struct bt_ctf_event_class
*event_class
,
303 struct bt_ctf_field_type
*context
);
305 #endif /* BABELTRACE_CTF_IR_EVENT_CLASS_INTERNAL_H */
This page took 0.045384 seconds and 4 git commands to generate.