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 * Returns a new trace on success, NULL on error.
51 extern struct bt_ctf_trace
*bt_ctf_trace_create(void);
54 * bt_ctf_trace_create_stream: create a stream instance.
56 * Allocate a new stream instance and register it to the trace. The creation of
57 * a stream sets its reference count to 1.
59 * @param trace Trace instance.
60 * @param stream_class Stream class to instantiate.
62 * Returns a new stream on success, NULL on error.
64 extern struct bt_ctf_stream
*bt_ctf_trace_create_stream(
65 struct bt_ctf_trace
*trace
,
66 struct bt_ctf_stream_class
*stream_class
);
69 * bt_ctf_trace_add_environment_field: add an environment field to the trace.
71 * Add an environment field to the trace. The name and value parameters are
74 * @param trace Trace instance.
75 * @param name Name of the environment field (will be copied).
76 * @param value Value of the environment field (will be copied).
78 * Returns 0 on success, a negative value on error.
80 extern int bt_ctf_trace_add_environment_field(struct bt_ctf_trace
*trace
,
85 * bt_ctf_trace_add_clock: add a clock to the trace.
87 * Add a clock to the trace. Clocks assigned to stream classes must be
88 * added to the trace beforehand.
90 * @param trace Trace instance.
91 * @param clock Clock to add to the trace.
93 * Returns 0 on success, a negative value on error.
95 extern int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
96 struct bt_ctf_clock
*clock
);
99 * bt_ctf_trace_get_clock_count: get the number of clocks
100 * associated to the trace.
102 * @param trace Trace instance.
104 * Returns the clock count on success, a negative value on error.
106 extern int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
);
109 * bt_ctf_trace_get_clock: get a trace's clock at index.
111 * @param trace Trace instance.
112 * @param index Index of the clock in the given trace.
114 * Return a clock instance on success, NULL on error.
116 extern struct bt_ctf_clock
*bt_ctf_trace_get_clock(
117 struct bt_ctf_trace
*trace
, int index
);
120 * bt_ctf_trace_get_metadata_string: get metadata string.
122 * Get the trace's TSDL metadata. The caller assumes the ownership of the
125 * @param trace Trace instance.
127 * Returns the metadata string on success, NULL on error.
129 extern char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
);
132 * bt_ctf_trace_set_byte_order: set a field type's byte order.
134 * Set the trace's byte order. Defaults to BT_CTF_BYTE_ORDER_NATIVE,
135 * the host machine's endianness.
137 * @param trace Trace instance.
138 * @param byte_order Trace's byte order.
140 * Returns 0 on success, a negative value on error.
142 extern int bt_ctf_trace_set_byte_order(struct bt_ctf_trace
*trace
,
143 enum bt_ctf_byte_order byte_order
);
146 * bt_ctf_trace_get and bt_ctf_trace_put: increment and decrement the
147 * trace's reference count.
149 * These functions ensure that the trace won't be destroyed while it
150 * is in use. The same number of get and put (plus one extra put to
151 * release the initial reference done at creation) have to be done to
154 * When the trace's reference count is decremented to 0 by a
155 * bt_ctf_trace_put, the trace is freed.
157 * @param trace Trace instance.
159 extern void bt_ctf_trace_get(struct bt_ctf_trace
*trace
);
160 extern void bt_ctf_trace_put(struct bt_ctf_trace
*trace
);
166 #endif /* BABELTRACE_CTF_IR_TRACE_H */