1 #ifndef BABELTRACE_CTF_IR_CLOCK_H
2 #define BABELTRACE_CTF_IR_CLOCK_H
5 * BabelTrace - CTF IR: Clock
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
42 * bt_ctf_clock_create: create a clock.
44 * Allocate a new clock setting its reference count to 1.
46 * @param name Name of the clock (will be copied); can be set to NULL
47 * for nameless clocks.
49 * Returns an allocated clock on success, NULL on error.
51 extern struct bt_ctf_clock
*bt_ctf_clock_create(const char *name
);
54 * bt_ctf_clock_get_name: get a clock's name.
56 * Get the clock's name.
58 * @param clock Clock instance.
60 * Returns the clock's name, NULL on error.
62 extern const char *bt_ctf_clock_get_name(struct bt_ctf_clock
*clock
);
65 * bt_ctf_clock_get_description: get a clock's description.
67 * Get the clock's description.
69 * @param clock Clock instance.
71 * Returns the clock's description, NULL if unset.
73 extern const char *bt_ctf_clock_get_description(struct bt_ctf_clock
*clock
);
76 * bt_ctf_clock_set_description: set a clock's description.
78 * Set the clock's description. The description appears in the clock's TSDL
81 * @param clock Clock instance.
82 * @param desc Description of the clock.
84 * Returns 0 on success, a negative value on error.
86 extern int bt_ctf_clock_set_description(struct bt_ctf_clock
*clock
,
90 * bt_ctf_clock_get_frequency: get a clock's frequency.
92 * Get the clock's frequency (Hz).
94 * @param clock Clock instance.
96 * Returns the clock's frequency, -1ULL on error.
98 extern uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock
*clock
);
101 * bt_ctf_clock_set_frequency: set a clock's frequency.
103 * Set the clock's frequency (Hz).
105 * @param clock Clock instance.
106 * @param freq Clock's frequency in Hz, defaults to 1 000 000 000 Hz (1ns).
108 * Returns 0 on success, a negative value on error.
110 extern int bt_ctf_clock_set_frequency(struct bt_ctf_clock
*clock
,
114 * bt_ctf_clock_get_precision: get a clock's precision.
116 * Get the clock's precision (in clock ticks).
118 * @param clock Clock instance.
120 * Returns the clock's precision, -1ULL on error.
122 extern uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock
*clock
);
125 * bt_ctf_clock_set_precision: set a clock's precision.
127 * Set the clock's precision.
129 * @param clock Clock instance.
130 * @param precision Clock's precision in clock ticks, defaults to 1.
132 * Returns 0 on success, a negative value on error.
134 extern int bt_ctf_clock_set_precision(struct bt_ctf_clock
*clock
,
138 * bt_ctf_clock_get_offset_s: get a clock's offset in seconds.
140 * Get the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01.
142 * @param clock Clock instance.
143 * @param offset_s Pointer to clock offset in seconds (output).
145 * Returns 0 on success, a negative value on error.
147 extern int bt_ctf_clock_get_offset_s(struct bt_ctf_clock
*clock
,
151 * bt_ctf_clock_set_offset_s: set a clock's offset in seconds.
153 * Set the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01,
156 * @param clock Clock instance.
157 * @param offset_s Clock's offset in seconds, defaults to 0.
159 * Returns 0 on success, a negative value on error.
161 extern int bt_ctf_clock_set_offset_s(struct bt_ctf_clock
*clock
,
165 * bt_ctf_clock_get_offset: get a clock's offset in ticks.
167 * Get the clock's offset in ticks from Epoch + offset_t.
169 * @param clock Clock instance.
170 * @param offset Clock offset in ticks from Epoch + offset_s (output).
172 * Returns 0 on success, a negative value on error.
174 extern int bt_ctf_clock_get_offset(struct bt_ctf_clock
*clock
,
178 * bt_ctf_clock_set_offset: set a clock's offset in ticks.
180 * Set the clock's offset in ticks from Epoch + offset_s.
182 * @param clock Clock instance.
183 * @param offset Clock's offset in ticks from Epoch + offset_s, defaults to 0.
185 * Returns 0 on success, a negative value on error.
187 extern int bt_ctf_clock_set_offset(struct bt_ctf_clock
*clock
,
191 * bt_ctf_clock_get_is_absolute: get a clock's absolute attribute.
193 * Get the clock's absolute attribute. A clock is absolute if the clock is a
194 * global reference across the trace's other clocks.
196 * @param clock Clock instance.
198 * Returns the clock's absolute attribute, a negative value on error.
200 extern int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock
*clock
);
203 * bt_ctf_clock_set_is_absolute: set a clock's absolute attribute.
205 * Set the clock's absolute attribute. A clock is absolute if the clock is a
206 * global reference across the trace's other clocks.
208 * @param clock Clock instance.
209 * @param is_absolute Clock's absolute attribute, defaults to FALSE.
211 * Returns 0 on success, a negative value on error.
213 extern int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock
*clock
,
217 * bt_ctf_clock_get_uuid: get a clock's UUID.
219 * Get the clock's UUID.
221 * @param clock Clock instance.
223 * Returns a pointer to the clock's UUID (16 byte array) on success,
226 extern const unsigned char *bt_ctf_clock_get_uuid(struct bt_ctf_clock
*clock
);
229 * bt_ctf_clock_set_uuid: set a clock's UUID.
231 * Set a clock's UUID.
233 * @param clock Clock instance.
234 * @param uuid A 16-byte array containing a UUID.
236 * Returns 0 on success, a negative value on error.
238 extern int bt_ctf_clock_set_uuid(struct bt_ctf_clock
*clock
,
239 const unsigned char *uuid
);
241 extern int64_t bt_ctf_clock_ns_from_value(struct bt_ctf_clock
*clock
,
248 #endif /* BABELTRACE_CTF_IR_CLOCK_H */
This page took 0.036959 seconds and 5 git commands to generate.