1 #ifndef BABELTRACE_CTF_IR_TRACE_H
2 #define BABELTRACE_CTF_IR_TRACE_H
5 * BabelTrace - CTF IR: Trace
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
33 #include <babeltrace/ctf-ir/field-types.h>
34 #include <babeltrace/values.h>
43 struct bt_ctf_stream_class
;
47 * bt_ctf_trace_create: create a trace instance.
49 * Allocate a new trace.
51 * A trace's default packet header is a structure initialized with the following
55 * - uint32_t stream_id
57 * Returns a new trace on success, NULL on error.
59 extern struct bt_ctf_trace
*bt_ctf_trace_create(void);
62 * bt_ctf_trace_set_environment_field: sets an environment field to the
65 * Sets an environment field to the trace. The name parameter is
66 * copied, whereas the value parameter's reference count is incremented
67 * (if the function succeeds).
69 * If a value exists in the environment for the specified name, it is
70 * replaced by the new value.
72 * The value parameter _must_ be either an integer value object or a
73 * string value object. Other object types are not supported.
75 * @param trace Trace instance.
76 * @param name Name of the environment field (will be copied).
77 * @param value Value of the environment field.
79 * Returns 0 on success, a negative value on error.
81 extern int bt_ctf_trace_set_environment_field(
82 struct bt_ctf_trace
*trace
, const char *name
,
83 struct bt_value
*value
);
86 * bt_ctf_trace_set_environment_field_string: sets a string environment
89 * Sets a string environment field to the trace. This is a helper
90 * function which corresponds to calling
91 * bt_ctf_trace_set_environment_field() with a string object.
93 * @param trace Trace instance.
94 * @param name Name of the environment field (will be copied).
95 * @param value Value of the environment field (will be copied).
97 * Returns 0 on success, a negative value on error.
99 extern int bt_ctf_trace_set_environment_field_string(
100 struct bt_ctf_trace
*trace
, const char *name
,
104 * bt_ctf_trace_set_environment_field_integer: sets an integer environment
105 * field to the trace.
107 * Sets an integer environment field to the trace. This is a helper
108 * function which corresponds to calling
109 * bt_ctf_trace_set_environment_field() with an integer object.
111 * @param trace Trace instance.
112 * @param name Name of the environment field (will be copied).
113 * @param value Value of the environment field.
115 * Returns 0 on success, a negative value on error.
117 extern int bt_ctf_trace_set_environment_field_integer(
118 struct bt_ctf_trace
*trace
, const char *name
,
122 * bt_ctf_trace_get_environment_field_count: get environment field count.
124 * Get the trace's environment field count.
126 * @param trace Trace instance.
128 * Returns the environment field count, a negative value on error.
130 extern int bt_ctf_trace_get_environment_field_count(
131 struct bt_ctf_trace
*trace
);
134 * bt_ctf_trace_get_environment_field_name: get environment field name.
136 * Get an environment field's name. The string's ownership is not
137 * transferred to the caller. The string data is valid as long as
138 * this trace's environment is not modified.
140 * @param trace Trace instance.
141 * @param index Index of the environment field.
143 * Returns the environment field's name, NULL on error.
146 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace
*trace
,
150 * bt_ctf_trace_get_environment_field_value: get environment
151 * field value (an object).
153 * Get an environment field's value (an object). The returned object's
154 * reference count is incremented. When done with the object, the caller
155 * must call bt_value_put() on it.
157 * @param trace Trace instance.
158 * @param index Index of the environment field.
160 * Returns the environment field's object value, NULL on error.
162 extern struct bt_value
*
163 bt_ctf_trace_get_environment_field_value(struct bt_ctf_trace
*trace
,
167 * bt_ctf_trace_get_environment_field_value_by_name: get environment
168 * field value (an object) by name.
170 * Get an environment field's value (an object) by its field name. The
171 * returned object's reference count is incremented. When done with the
172 * object, the caller must call bt_value_put() on it.
174 * @param trace Trace instance.
175 * @param name Environment field's name
177 * Returns the environment field's object value, NULL on error.
179 extern struct bt_value
*
180 bt_ctf_trace_get_environment_field_value_by_name(struct bt_ctf_trace
*trace
,
184 * bt_ctf_trace_add_clock: add a clock to the trace.
186 * Add a clock to the trace. Clocks assigned to stream classes must be
187 * added to the trace beforehand.
189 * @param trace Trace instance.
190 * @param clock Clock to add to the trace.
192 * Returns 0 on success, a negative value on error.
194 extern int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
195 struct bt_ctf_clock
*clock
);
198 * bt_ctf_trace_get_clock_count: get the number of clocks
199 * associated with the trace.
201 * @param trace Trace instance.
203 * Returns the clock count on success, a negative value on error.
205 extern int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
);
208 * bt_ctf_trace_get_clock: get a trace's clock at index.
210 * @param trace Trace instance.
211 * @param index Index of the clock in the given trace.
213 * Return a clock instance on success, NULL on error.
215 extern struct bt_ctf_clock
*bt_ctf_trace_get_clock(
216 struct bt_ctf_trace
*trace
, int index
);
219 * bt_ctf_trace_add_stream_class: add a stream_class to the trace.
221 * Add a stream class to the trace.
223 * @param trace Trace instance.
224 * @param stream_class Stream class to add to the trace.
226 * Returns 0 on success, a negative value on error.
228 extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace
*trace
,
229 struct bt_ctf_stream_class
*stream_class
);
232 * bt_ctf_trace_get_stream_class_count: get the number of stream classes
233 * associated with the trace.
235 * @param trace Trace instance.
237 * Returns the stream class count on success, a negative value on error.
239 extern int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace
*trace
);
242 * bt_ctf_trace_get_stream_class: get a trace's stream class at index.
244 * @param trace Trace instance.
245 * @param index Index of the stream class in the given trace.
247 * Return a stream class on success, NULL on error.
249 extern struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class(
250 struct bt_ctf_trace
*trace
, int index
);
253 * bt_ctf_trace_get_stream_class_by_id: get a trace's stream class by ID.
255 * @param trace Trace instance.
256 * @param index ID of the stream class in the given trace.
258 * Return a stream class on success, NULL on error.
260 extern struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class_by_id(
261 struct bt_ctf_trace
*trace
, uint32_t id
);
264 * bt_ctf_trace_get_clock_by_name: get a trace's clock by name
266 * @param trace Trace instance.
267 * @param name Name of the clock in the given trace.
269 * Return a clock instance on success, NULL on error.
271 extern struct bt_ctf_clock
*bt_ctf_trace_get_clock_by_name(
272 struct bt_ctf_trace
*trace
, const char *name
);
275 * bt_ctf_trace_get_metadata_string: get metadata string.
277 * Get the trace's TSDL metadata. The caller assumes the ownership of the
280 * @param trace Trace instance.
282 * Returns the metadata string on success, NULL on error.
284 extern char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
);
287 * bt_ctf_trace_get_byte_order: get a trace's byte order.
289 * Get the trace's byte order.
291 * @param trace Trace instance.
293 * Returns the trace's endianness, BT_CTF_BYTE_ORDER_UNKNOWN on error.
295 extern enum bt_ctf_byte_order
bt_ctf_trace_get_byte_order(
296 struct bt_ctf_trace
*trace
);
299 * bt_ctf_trace_set_byte_order: set a trace's byte order.
301 * Set the trace's byte order. Defaults to the current host's endianness.
303 * @param trace Trace instance.
304 * @param byte_order Trace's byte order.
306 * Returns 0 on success, a negative value on error.
308 * Note: byte_order must not be BT_CTF_BYTE_ORDER_NATIVE since, according
309 * to the CTF specification, is defined as "the byte order described in the
310 * trace description".
312 extern int bt_ctf_trace_set_byte_order(struct bt_ctf_trace
*trace
,
313 enum bt_ctf_byte_order byte_order
);
316 * bt_ctf_trace_get_packet_header_type: get a trace's packet header type.
318 * Get the trace's packet header type.
320 * @param trace Trace instance.
322 * Returns the trace's packet header type (a structure) on success, NULL on
325 extern struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
326 struct bt_ctf_trace
*trace
);
329 * bt_ctf_trace_set_packet_header_type: set a trace's packet header type.
331 * Set the trace's packet header type.
333 * @param trace Trace instance.
334 * @param packet_header_type Packet header field type (must be a structure).
336 * Returns 0 on success, a negative value on error.
338 extern int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
339 struct bt_ctf_field_type
*packet_header_type
);
345 #endif /* BABELTRACE_CTF_IR_TRACE_H */