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
35 #include <babeltrace/values.h>
41 struct bt_ctf_event_class
;
44 struct bt_ctf_field_type
;
45 struct bt_ctf_stream_class
;
48 * bt_ctf_event_create: instanciate an event.
50 * Allocate a new event of the given event class. The creation of an event
51 * sets its reference count to 1. Each instance shares the ownership of the
52 * event class using its reference count.
54 * An event class must be associated with a stream class before events
55 * may be instanciated.
57 * @param event_class Event class.
59 * Returns an allocated field type on success, NULL on error.
61 extern struct bt_ctf_event
*bt_ctf_event_create(
62 struct bt_ctf_event_class
*event_class
);
65 * bt_ctf_event_get_class: get an event's class.
69 * Returns the event's class, NULL on error.
71 extern struct bt_ctf_event_class
*bt_ctf_event_get_class(
72 struct bt_ctf_event
*event
);
75 * bt_ctf_event_get_stream: get an event's associated stream.
79 * Returns the event's associated stream, NULL on error.
81 extern struct bt_ctf_stream
*bt_ctf_event_get_stream(
82 struct bt_ctf_event
*event
);
85 * bt_ctf_event_get_clock: get an event's associated clock.
89 * Returns the event's clock, NULL on error.
91 extern struct bt_ctf_clock
*bt_ctf_event_get_clock(
92 struct bt_ctf_event
*event
);
95 * bt_ctf_event_get_payload_field: get an event's payload.
97 * @param event Event instance.
99 * Returns a field instance on success, NULL on error.
101 extern struct bt_ctf_field
*bt_ctf_event_get_payload_field(
102 struct bt_ctf_event
*event
);
105 * bt_ctf_event_set_payload_field: set an event's payload.
107 * @param event Event instance.
108 * @param payload Field instance (must be a structure).
110 * Returns 0 on success, a negative value on error.
112 extern int bt_ctf_event_set_payload_field(struct bt_ctf_event
*event
,
113 struct bt_ctf_field
*payload
);
116 * bt_ctf_event_get_payload: get an event's field.
118 * Returns the field matching "name". bt_ctf_field_put() must be called on the
121 * @param event Event instance.
122 * @param name Event field name, see notes.
124 * Returns a field instance on success, NULL on error.
126 * Note: Passing a name will cause the function to perform a look-up by
127 * name assuming the event's payload is a structure. This will return
128 * the raw payload instance if name is NULL.
130 extern struct bt_ctf_field
*bt_ctf_event_get_payload(struct bt_ctf_event
*event
,
134 * bt_ctf_event_set_payload: set an event's field.
136 * Set a manually allocated field as an event's payload. The event will share
137 * the field's ownership by using its reference count.
138 * bt_ctf_field_put() must be called on the returned value.
140 * @param event Event instance.
141 * @param name Event field name, see notes.
142 * @param value Instance of a field whose type corresponds to the event's field.
144 * Returns 0 on success, a negative value on error.
146 * Note: The function will return an error if a name is provided and the payload
147 * type is not a structure. If name is NULL, the payload field will be set
148 * directly and must match the event class' payload's type.
150 extern int bt_ctf_event_set_payload(struct bt_ctf_event
*event
,
152 struct bt_ctf_field
*value
);
155 * bt_ctf_event_get_payload_by_index: Get event's field by index.
157 * Returns the field associated with the provided index. bt_ctf_field_put()
158 * must be called on the returned value. The indexes to be provided are
159 * the same as can be retrieved from the event class.
161 * @param event Event.
162 * @param index Index of field.
164 * Returns the event's field, NULL on error.
166 * Note: Will return an error if the payload's type is not a structure.
168 extern struct bt_ctf_field
*bt_ctf_event_get_payload_by_index(
169 struct bt_ctf_event
*event
, int index
);
172 * bt_ctf_event_get_header: get an event's header.
174 * @param event Event instance.
176 * Returns a field instance on success, NULL on error.
178 extern struct bt_ctf_field
*bt_ctf_event_get_header(
179 struct bt_ctf_event
*event
);
182 * bt_ctf_event_set_header: set an event's header.
184 * The event header's type must match the stream class' event
187 * @param event Event instance.
188 * @param header Event header field instance.
190 * Returns a field instance on success, NULL on error.
192 extern int bt_ctf_event_set_header(
193 struct bt_ctf_event
*event
,
194 struct bt_ctf_field
*header
);
197 * bt_ctf_event_get_event_context: Get an event's context
199 * @param event_class Event class.
201 * Returns a field on success (a structure), NULL on error.
203 * Note: This function is named this way instead of the expected
204 * "bt_ctf_event_get_context" in order to work around a name clash with
205 * an unrelated function bearing this name in context.h.
207 extern struct bt_ctf_field
*bt_ctf_event_get_event_context(
208 struct bt_ctf_event
*event
);
211 * bt_ctf_event_set_event_context: Set an event's context
213 * @param event Event.
214 * @param context Event context field (must match the event class'
217 * Returns 0 on success, a negative value on error.
219 extern int bt_ctf_event_set_event_context(struct bt_ctf_event
*event
,
220 struct bt_ctf_field
*context
);
223 * bt_ctf_event_get_stream_event_context: Get an event's stream event context
225 * @param event_class Event class.
227 * Returns a field on success (a structure), NULL on error.
229 extern struct bt_ctf_field
*bt_ctf_event_get_stream_event_context(
230 struct bt_ctf_event
*event
);
233 * bt_ctf_event_set_stream_event_context: Set an event's stream event context
235 * @param event Event.
236 * @param context Event stream context field (must match the stream class'
237 * stream event context type).
239 * Returns 0 on success, a negative value on error.
241 extern int bt_ctf_event_set_stream_event_context(struct bt_ctf_event
*event
,
242 struct bt_ctf_field
*context
);
245 * bt_ctf_event_copy: Deep-copy an event.
247 * Get an event's deep copy.
249 * On success, the returned copy has its reference count set to 1.
251 * @param event Event to copy.
253 * Returns the deep-copied event on success, NULL on error.
255 extern struct bt_ctf_event
*bt_ctf_event_copy(struct bt_ctf_event
*event
);
258 * bt_ctf_event_get and bt_ctf_event_put: increment and decrement
259 * the event's reference count.
261 * You may also use bt_ctf_get() and bt_ctf_put() with event objects.
263 * These functions ensure that the event won't be destroyed while it
264 * is in use. The same number of get and put (plus one extra put to
265 * release the initial reference done at creation) have to be done to
268 * When the event's reference count is decremented to 0 by a
269 * bt_ctf_event_put, the event is freed.
271 * @param event Event instance.
273 extern void bt_ctf_event_get(struct bt_ctf_event
*event
);
274 extern void bt_ctf_event_put(struct bt_ctf_event
*event
);
280 #endif /* BABELTRACE_CTF_IR_EVENT_H */
This page took 0.042102 seconds and 4 git commands to generate.