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/event-types.h>
41 struct bt_ctf_stream_class
;
45 * bt_ctf_trace_create: create a trace instance.
47 * Allocate a new trace.
49 * A trace's default packet header is a structure initialized with the following
53 * - uint32_t stream_id
55 * Returns a new trace on success, NULL on error.
57 extern struct bt_ctf_trace
*bt_ctf_trace_create(void);
60 * bt_ctf_trace_create_stream: create a stream instance.
62 * Allocate a new stream instance and register it to the trace. The creation of
63 * a stream sets its reference count to 1.
65 * @param trace Trace instance.
66 * @param stream_class Stream class to instantiate.
68 * Returns a new stream on success, NULL on error.
70 extern struct bt_ctf_stream
*bt_ctf_trace_create_stream(
71 struct bt_ctf_trace
*trace
,
72 struct bt_ctf_stream_class
*stream_class
);
75 * bt_ctf_trace_add_environment_field: add an environment field to the trace.
77 * Add an environment field to the trace. The name and value parameters are
80 * @param trace Trace instance.
81 * @param name Name of the environment field (will be copied).
82 * @param value Value of the environment field (will be copied).
84 * Returns 0 on success, a negative value on error.
86 extern int bt_ctf_trace_add_environment_field(struct bt_ctf_trace
*trace
,
91 * bt_ctf_trace_add_clock: add a clock to the trace.
93 * Add a clock to the trace. Clocks assigned to stream classes must be
94 * added to the trace beforehand.
96 * @param trace Trace instance.
97 * @param clock Clock to add to the trace.
99 * Returns 0 on success, a negative value on error.
101 extern int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
102 struct bt_ctf_clock
*clock
);
105 * bt_ctf_trace_get_clock_count: get the number of clocks
106 * associated to the trace.
108 * @param trace Trace instance.
110 * Returns the clock count on success, a negative value on error.
112 extern int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
);
115 * bt_ctf_trace_get_clock: get a trace's clock at index.
117 * @param trace Trace instance.
118 * @param index Index of the clock in the given trace.
120 * Return a clock instance on success, NULL on error.
122 extern struct bt_ctf_clock
*bt_ctf_trace_get_clock(
123 struct bt_ctf_trace
*trace
, int index
);
126 * bt_ctf_trace_get_metadata_string: get metadata string.
128 * Get the trace's TSDL metadata. The caller assumes the ownership of the
131 * @param trace Trace instance.
133 * Returns the metadata string on success, NULL on error.
135 extern char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
);
138 * bt_ctf_trace_set_byte_order: set a field type's byte order.
140 * Set the trace's byte order. Defaults to the current host's endianness.
142 * @param trace Trace instance.
143 * @param byte_order Trace's byte order.
145 * Returns 0 on success, a negative value on error.
147 * Note: byte_order must not be BT_CTF_BYTE_ORDER_NATIVE since, according
148 * to the CTF specification, is defined as "the byte order described in the
149 * trace description".
151 extern int bt_ctf_trace_set_byte_order(struct bt_ctf_trace
*trace
,
152 enum bt_ctf_byte_order byte_order
);
155 * bt_ctf_trace_get_packet_header_type: get a trace's packet header type.
157 * Get the trace's packet header type.
159 * @param trace Trace instance.
161 * Returns the trace's packet header type (a structure) on success, NULL on
164 extern struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
165 struct bt_ctf_trace
*trace
);
168 * bt_ctf_trace_set_packet_header_type: set a trace's packet header type.
170 * Set the trace's packet header type.
172 * @param trace Trace instance.
173 * @param packet_header_type Packet header field type (must be a structure).
175 * Returns 0 on success, a negative value on error.
177 extern int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
178 struct bt_ctf_field_type
*packet_header_type
);
181 * bt_ctf_trace_get and bt_ctf_trace_put: increment and decrement the
182 * trace's reference count.
184 * These functions ensure that the trace won't be destroyed while it
185 * is in use. The same number of get and put (plus one extra put to
186 * release the initial reference done at creation) have to be done to
189 * When the trace's reference count is decremented to 0 by a
190 * bt_ctf_trace_put, the trace is freed.
192 * @param trace Trace instance.
194 extern void bt_ctf_trace_get(struct bt_ctf_trace
*trace
);
195 extern void bt_ctf_trace_put(struct bt_ctf_trace
*trace
);
201 #endif /* BABELTRACE_CTF_IR_TRACE_H */