1 #ifndef BABELTRACE_CTF_IR_EVENT_H
2 #define BABELTRACE_CTF_IR_EVENT_H
5 * BabelTrace - CTF IR: Event
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
40 struct bt_ctf_event_class
;
43 struct bt_ctf_field_type
;
44 struct bt_ctf_stream_class
;
47 * bt_ctf_event_class_create: create an event class.
49 * Allocate a new event class of the given name. The creation of an event class
50 * sets its reference count to 1. A unique event id is automatically assigned
53 * @param name Event class name (will be copied).
55 * Returns an allocated event class on success, NULL on error.
57 extern struct bt_ctf_event_class
*bt_ctf_event_class_create(const char *name
);
60 * bt_ctf_event_class_get_name: Get an event class' name.
62 * @param event_class Event class.
64 * Returns the event class' name, NULL on error.
66 extern const char *bt_ctf_event_class_get_name(
67 struct bt_ctf_event_class
*event_class
);
70 * bt_ctf_event_class_get_id: Get an event class' id.
72 * @param event_class Event class.
74 * Returns the event class' id, a negative value on error.
76 extern int64_t bt_ctf_event_class_get_id(
77 struct bt_ctf_event_class
*event_class
);
80 * bt_ctf_event_class_set_id: Set an event class' id.
82 * Set an event class' id. Must be unique stream-wise.
83 * Note that event classes are already assigned a unique id when added to a
84 * stream class if none was set explicitly.
86 * @param event_class Event class.
87 * @param id Event class id.
89 * Returns 0 on success, a negative value on error.
91 extern int bt_ctf_event_class_set_id(
92 struct bt_ctf_event_class
*event_class
, uint32_t id
);
95 * bt_ctf_event_class_get_stream_class: Get an event class' stream class.
97 * @param event_class Event class.
99 * Returns the event class' stream class, NULL on error or if the event class
100 * is not associated with a stream class.
102 extern struct bt_ctf_stream_class
*bt_ctf_event_class_get_stream_class(
103 struct bt_ctf_event_class
*event_class
);
106 * bt_ctf_event_class_add_field: add a field to an event class.
108 * Add a field of type "type" to the event class. The event class will share
109 * type's ownership by increasing its reference count. The "name" will be
112 * @param event_class Event class.
113 * @param type Field type to add to the event class.
114 * @param name Name of the new field.
116 * Returns 0 on success, a negative value on error.
118 extern int bt_ctf_event_class_add_field(struct bt_ctf_event_class
*event_class
,
119 struct bt_ctf_field_type
*type
,
123 * bt_ctf_event_class_get_field_count: Get an event class' field count.
125 * @param event_class Event class.
127 * Returns the event class' field count, a negative value on error.
129 extern int bt_ctf_event_class_get_field_count(
130 struct bt_ctf_event_class
*event_class
);
133 * bt_ctf_event_class_get_field: Get event class' field type and name by index.
135 * @param event_class Event class.
136 * @param field_name Pointer to a const char* where the field's name will
138 * @param field_type Pointer to a bt_ctf_field_type* where the field's type will
140 * @param index Index of field.
142 * Returns 0 on success, a negative error on value.
144 extern int bt_ctf_event_class_get_field(struct bt_ctf_event_class
*event_class
,
145 const char **field_name
, struct bt_ctf_field_type
**field_type
,
149 * bt_ctf_event_class_get_field_type_by_name: Get an event class's field by name
151 * @param event_class Event class.
152 * @param name Name of the field.
154 * Returns a field type on success, NULL on error.
156 extern struct bt_ctf_field_type
*bt_ctf_event_class_get_field_by_name(
157 struct bt_ctf_event_class
*event_class
, const char *name
);
160 * bt_ctf_event_class_get_context_type: Get an event class's context type
162 * @param event_class Event class.
164 * Returns a field type (a structure) on success, NULL on error.
166 extern struct bt_ctf_field_type
*bt_ctf_event_class_get_context_type(
167 struct bt_ctf_event_class
*event_class
);
170 * bt_ctf_event_class_set_context_type: Set an event class's context type
172 * @param event_class Event class.
173 * @param context Event context field type (must be a structure).
175 * Returns 0 on success, a negative value on error.
177 extern int bt_ctf_event_class_set_context_type(
178 struct bt_ctf_event_class
*event_class
,
179 struct bt_ctf_field_type
*context
);
182 * bt_ctf_event_class_get and bt_ctf_event_class_put: increment and decrement
183 * the event class' reference count.
185 * These functions ensure that the event class won't be destroyed while it
186 * is in use. The same number of get and put (plus one extra put to
187 * release the initial reference done at creation) have to be done to
188 * destroy an event class.
190 * When the event class' reference count is decremented to 0 by a
191 * bt_ctf_event_class_put, the event class is freed.
193 * @param event_class Event class.
195 extern void bt_ctf_event_class_get(struct bt_ctf_event_class
*event_class
);
196 extern void bt_ctf_event_class_put(struct bt_ctf_event_class
*event_class
);
199 * bt_ctf_event_create: instanciate an event.
201 * Allocate a new event of the given event class. The creation of an event
202 * sets its reference count to 1. Each instance shares the ownership of the
203 * event class using its reference count.
205 * @param event_class Event class.
207 * Returns an allocated field type on success, NULL on error.
209 extern struct bt_ctf_event
*bt_ctf_event_create(
210 struct bt_ctf_event_class
*event_class
);
213 * bt_ctf_event_get_class: get an event's class.
215 * @param event Event.
217 * Returns the event's class, NULL on error.
219 extern struct bt_ctf_event_class
*bt_ctf_event_get_class(
220 struct bt_ctf_event
*event
);
223 * bt_ctf_event_get_clock: get an event's associated clock.
225 * @param event Event.
227 * Returns the event's clock, NULL on error.
229 extern struct bt_ctf_clock
*bt_ctf_event_get_clock(
230 struct bt_ctf_event
*event
);
233 * bt_ctf_event_get_payload: get an event's field.
235 * Returns the field matching "name". bt_ctf_field_put() must be called on the
238 * @param event Event instance.
239 * @param name Event field name.
241 * Returns a field instance on success, NULL on error.
243 extern struct bt_ctf_field
*bt_ctf_event_get_payload(struct bt_ctf_event
*event
,
247 * bt_ctf_event_set_payload: set an event's field.
249 * Set a manually allocated field as an event's payload. The event will share
250 * the field's ownership by using its reference count.
251 * bt_ctf_field_put() must be called on the returned value.
253 * @param event Event instance.
254 * @param name Event field name.
255 * @param value Instance of a field whose type corresponds to the event's field.
257 * Returns 0 on success, a negative value on error.
259 extern int bt_ctf_event_set_payload(struct bt_ctf_event
*event
,
261 struct bt_ctf_field
*value
);
264 * bt_ctf_event_get_payload_by_index: Get event's field by index.
266 * Returns the field associated with the provided index. bt_ctf_field_put()
267 * must be called on the returned value. The indexes to be provided are
268 * the same as can be retrieved from the event class.
270 * @param event Event.
271 * @param index Index of field.
273 * Returns the event's field, NULL on error.
275 extern struct bt_ctf_field
*bt_ctf_event_get_payload_by_index(
276 struct bt_ctf_event
*event
, int index
);
279 * bt_ctf_event_get_header: get an event's header.
281 * @param event Event instance.
283 * Returns a field instance on success, NULL on error.
285 extern struct bt_ctf_field
*bt_ctf_event_get_header(
286 struct bt_ctf_event
*event
);
289 * bt_ctf_event_set_header: set an event's header.
291 * The event header's type must match the stream class' event
294 * @param event Event instance.
295 * @param header Event header field instance.
297 * Returns a field instance on success, NULL on error.
299 extern int bt_ctf_event_set_header(
300 struct bt_ctf_event
*event
,
301 struct bt_ctf_field
*header
);
304 * bt_ctf_event_get_event_context: Get an event's context
306 * @param event_class Event class.
308 * Returns a field on success (a structure), NULL on error.
310 * Note: This function is named this way instead of the expected
311 * "bt_ctf_event_get_context" in order to work around a name clash with
312 * an unrelated function bearing this name in context.h.
314 extern struct bt_ctf_field
*bt_ctf_event_get_event_context(
315 struct bt_ctf_event
*event
);
318 * bt_ctf_event_set_event_context: Set an event's context
320 * @param event Event.
321 * @param context Event context field (must match the event class'
324 * Returns 0 on success, a negative value on error.
326 extern int bt_ctf_event_set_event_context(struct bt_ctf_event
*event
,
327 struct bt_ctf_field
*context
);
330 * bt_ctf_event_get and bt_ctf_event_put: increment and decrement
331 * the event's reference count.
333 * These functions ensure that the event won't be destroyed while it
334 * is in use. The same number of get and put (plus one extra put to
335 * release the initial reference done at creation) have to be done to
338 * When the event's reference count is decremented to 0 by a
339 * bt_ctf_event_put, the event is freed.
341 * @param event Event instance.
343 extern void bt_ctf_event_get(struct bt_ctf_event
*event
);
344 extern void bt_ctf_event_put(struct bt_ctf_event
*event
);
350 #endif /* BABELTRACE_CTF_IR_EVENT_H */
This page took 0.03949 seconds and 4 git commands to generate.