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).
48 * Returns an allocated clock on success, NULL on error.
50 extern struct bt_ctf_clock
*bt_ctf_clock_create(const char *name
);
53 * bt_ctf_clock_get_name: get a clock's name.
55 * Get the clock's name.
57 * @param clock Clock instance.
59 * Returns the clock's name, NULL on error.
61 extern const char *bt_ctf_clock_get_name(struct bt_ctf_clock
*clock
);
64 * bt_ctf_clock_get_description: get a clock's description.
66 * Get the clock's description.
68 * @param clock Clock instance.
70 * Returns the clock's description, NULL if unset.
72 extern const char *bt_ctf_clock_get_description(struct bt_ctf_clock
*clock
);
75 * bt_ctf_clock_set_description: set a clock's description.
77 * Set the clock's description. The description appears in the clock's TSDL
80 * @param clock Clock instance.
81 * @param desc Description of the clock.
83 * Returns 0 on success, a negative value on error.
85 extern int bt_ctf_clock_set_description(struct bt_ctf_clock
*clock
,
89 * bt_ctf_clock_get_frequency: get a clock's frequency.
91 * Get the clock's frequency (Hz).
93 * @param clock Clock instance.
95 * Returns the clock's frequency, -1ULL on error.
97 extern uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock
*clock
);
100 * bt_ctf_clock_set_frequency: set a clock's frequency.
102 * Set the clock's frequency (Hz).
104 * @param clock Clock instance.
105 * @param freq Clock's frequency in Hz, defaults to 1 000 000 000 Hz (1ns).
107 * Returns 0 on success, a negative value on error.
109 extern int bt_ctf_clock_set_frequency(struct bt_ctf_clock
*clock
,
113 * bt_ctf_clock_get_precision: get a clock's precision.
115 * Get the clock's precision (in clock ticks).
117 * @param clock Clock instance.
119 * Returns the clock's precision, -1ULL on error.
121 extern uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock
*clock
);
124 * bt_ctf_clock_set_precision: set a clock's precision.
126 * Set the clock's precision.
128 * @param clock Clock instance.
129 * @param precision Clock's precision in clock ticks, defaults to 1.
131 * Returns 0 on success, a negative value on error.
133 extern int bt_ctf_clock_set_precision(struct bt_ctf_clock
*clock
,
137 * bt_ctf_clock_get_offset_s: get a clock's offset in seconds.
139 * Get the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01.
141 * @param clock Clock instance.
143 * Returns the clock's offset in seconds, -1ULL on error.
145 extern uint64_t bt_ctf_clock_get_offset_s(struct bt_ctf_clock
*clock
);
148 * bt_ctf_clock_set_offset_s: set a clock's offset in seconds.
150 * Set the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01,
153 * @param clock Clock instance.
154 * @param offset_s Clock's offset in seconds, defaults to 0.
156 * Returns 0 on success, a negative value on error.
158 extern int bt_ctf_clock_set_offset_s(struct bt_ctf_clock
*clock
,
162 * bt_ctf_clock_get_offset_s: get a clock's offset in ticks.
164 * Get the clock's offset in ticks from Epoch + offset_t.
166 * @param clock Clock instance.
168 * Returns the clock's offset in ticks from Epoch + offset_s, -1ULL on error.
170 extern uint64_t bt_ctf_clock_get_offset(struct bt_ctf_clock
*clock
);
173 * bt_ctf_clock_set_offset: set a clock's offset in ticks.
175 * Set the clock's offset in ticks from Epoch + offset_s.
177 * @param clock Clock instance.
178 * @param offset Clock's offset in ticks from Epoch + offset_s, defaults to 0.
180 * Returns 0 on success, a negative value on error.
182 extern int bt_ctf_clock_set_offset(struct bt_ctf_clock
*clock
,
186 * bt_ctf_clock_get_is_absolute: get a clock's absolute attribute.
188 * Get the clock's absolute attribute. A clock is absolute if the clock is a
189 * global reference across the trace's other clocks.
191 * @param clock Clock instance.
193 * Returns the clock's absolute attribute, a negative value on error.
195 extern int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock
*clock
);
198 * bt_ctf_clock_set_is_absolute: set a clock's absolute attribute.
200 * Set the clock's absolute attribute. A clock is absolute if the clock is a
201 * global reference across the trace's other clocks.
203 * @param clock Clock instance.
204 * @param is_absolute Clock's absolute attribute, defaults to FALSE.
206 * Returns 0 on success, a negative value on error.
208 extern int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock
*clock
,
212 * bt_ctf_clock_get_uuid: get a clock's UUID.
214 * Get the clock's UUID.
216 * @param clock Clock instance.
218 * Returns a pointer to the clock's UUID (16 byte array) on success,
221 extern const unsigned char *bt_ctf_clock_get_uuid(struct bt_ctf_clock
*clock
);
224 * bt_ctf_clock_set_uuid: set a clock's UUID.
226 * Set a clock's UUID.
228 * @param clock Clock instance.
229 * @param uuid A 16-byte array containing a UUID.
231 * Returns 0 on success, a negative value on error.
233 extern int bt_ctf_clock_set_uuid(struct bt_ctf_clock
*clock
,
234 const unsigned char *uuid
);
237 * bt_ctf_clock_get_time: get a clock's current time value.
239 * Get the current time in nanoseconds since the clock's origin (offset and
240 * offset_s attributes).
242 * Returns the clock's current time value, -1ULL on error.
244 extern uint64_t bt_ctf_clock_get_time(struct bt_ctf_clock
*clock
);
247 * bt_ctf_clock_set_time: set a clock's current time value.
249 * Set the current time in nanoseconds since the clock's origin (offset and
250 * offset_s attributes). Defaults to 0.
252 * Returns 0 on success, a negative value on error.
254 extern int bt_ctf_clock_set_time(struct bt_ctf_clock
*clock
,
258 * bt_ctf_clock_get and bt_ctf_clock_put: increment and decrement the
259 * refcount of the clock
261 * These functions ensure that the clock won't be destroyed when it
262 * is in use. The same number of get and put (plus one extra put to
263 * release the initial reference done at creation) has to be done to
266 * When the clock refcount is decremented to 0 by a bt_ctf_clock_put,
267 * the clock is freed.
269 * @param clock Clock instance.
271 extern void bt_ctf_clock_get(struct bt_ctf_clock
*clock
);
272 extern void bt_ctf_clock_put(struct bt_ctf_clock
*clock
);
278 #endif /* BABELTRACE_CTF_IR_CLOCK_H */
This page took 0.049277 seconds and 4 git commands to generate.