1 #ifndef BABELTRACE_CTF_WRITER_CLOCK_H
2 #define BABELTRACE_CTF_WRITER_CLOCK_H
5 * BabelTrace - CTF Writer: 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
34 #include <babeltrace/object.h>
35 #include <babeltrace/types.h>
42 struct bt_ctf_clock_class
;
45 * bt_ctf_clock_create: create a clock.
47 * Allocate a new clock setting its reference count to 1.
49 * @param name Name of the clock (will be copied); can be set to NULL
50 * for nameless clocks.
52 * Returns an allocated clock on success, NULL on error.
54 extern struct bt_ctf_clock
*bt_ctf_clock_create(const char *name
);
57 * bt_ctf_clock_get_name: get a clock's name.
59 * Get the clock's name.
61 * @param clock Clock instance.
63 * Returns the clock's name, NULL on error.
65 extern const char *bt_ctf_clock_get_name(struct bt_ctf_clock
*clock
);
68 * bt_ctf_clock_get_description: get a clock's description.
70 * Get the clock's description.
72 * @param clock Clock instance.
74 * Returns the clock's description, NULL if unset.
76 extern const char *bt_ctf_clock_get_description(struct bt_ctf_clock
*clock
);
79 * bt_ctf_clock_set_description: set a clock's description.
81 * Set the clock's description. The description appears in the clock's TSDL
84 * @param clock Clock instance.
85 * @param desc Description of the clock.
87 * Returns 0 on success, a negative value on error.
89 extern int bt_ctf_clock_set_description(struct bt_ctf_clock
*clock
,
93 * bt_ctf_clock_get_frequency: get a clock's frequency.
95 * Get the clock's frequency (Hz).
97 * @param clock Clock instance.
99 * Returns the clock's frequency, -1ULL on error.
101 extern uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock
*clock
);
104 * bt_ctf_clock_set_frequency: set a clock's frequency.
106 * Set the clock's frequency (Hz).
108 * @param clock Clock instance.
109 * @param freq Clock's frequency in Hz, defaults to 1 000 000 000 Hz (1ns).
111 * Returns 0 on success, a negative value on error.
113 extern int bt_ctf_clock_set_frequency(struct bt_ctf_clock
*clock
,
117 * bt_ctf_clock_get_precision: get a clock's precision.
119 * Get the clock's precision (in clock ticks).
121 * @param clock Clock instance.
123 * Returns the clock's precision, -1ULL on error.
125 extern uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock
*clock
);
128 * bt_ctf_clock_set_precision: set a clock's precision.
130 * Set the clock's precision.
132 * @param clock Clock instance.
133 * @param precision Clock's precision in clock ticks, defaults to 1.
135 * Returns 0 on success, a negative value on error.
137 extern int bt_ctf_clock_set_precision(struct bt_ctf_clock
*clock
,
141 * bt_ctf_clock_get_offset_s: get a clock's offset in seconds.
143 * Get the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01.
145 * @param clock Clock instance.
146 * @param offset_s Pointer to clock offset in seconds (output).
148 * Returns 0 on success, a negative value on error.
150 extern int bt_ctf_clock_get_offset_s(struct bt_ctf_clock
*clock
,
154 * bt_ctf_clock_set_offset_s: set a clock's offset in seconds.
156 * Set the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01,
159 * @param clock Clock instance.
160 * @param offset_s Clock's offset in seconds, defaults to 0.
162 * Returns 0 on success, a negative value on error.
164 extern int bt_ctf_clock_set_offset_s(struct bt_ctf_clock
*clock
,
168 * bt_ctf_clock_get_offset: get a clock's offset in ticks.
170 * Get the clock's offset in ticks from Epoch + offset_t.
172 * @param clock Clock instance.
173 * @param offset Clock offset in ticks from Epoch + offset_s (output).
175 * Returns 0 on success, a negative value on error.
177 extern int bt_ctf_clock_get_offset(struct bt_ctf_clock
*clock
,
181 * bt_ctf_clock_set_offset: set a clock's offset in ticks.
183 * Set the clock's offset in ticks from Epoch + offset_s.
185 * @param clock Clock instance.
186 * @param offset Clock's offset in ticks from Epoch + offset_s, defaults to 0.
188 * Returns 0 on success, a negative value on error.
190 extern int bt_ctf_clock_set_offset(struct bt_ctf_clock
*clock
,
194 * bt_ctf_clock_get_is_absolute: get a clock's absolute attribute.
196 * Get the clock's absolute attribute. A clock is absolute if the clock is a
197 * global reference across the trace's other clocks.
199 * @param clock Clock instance.
201 * Returns the clock's absolute attribute, a negative value on error.
203 extern int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock
*clock
);
206 * bt_ctf_clock_set_is_absolute: set a clock's absolute attribute.
208 * Set the clock's absolute attribute. A clock is absolute if the clock is a
209 * global reference across the trace's other clocks.
211 * @param clock Clock instance.
212 * @param is_absolute Clock's absolute attribute, defaults to FALSE.
214 * Returns 0 on success, a negative value on error.
216 extern int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock
*clock
,
220 * bt_ctf_clock_get_uuid: get a clock's UUID.
222 * Get the clock's UUID.
224 * @param clock Clock instance.
226 * Returns a pointer to the clock's UUID (16 byte array) on success,
229 extern const unsigned char *bt_ctf_clock_get_uuid(struct bt_ctf_clock
*clock
);
232 * bt_ctf_clock_set_uuid: set a clock's UUID.
234 * Set a clock's UUID.
236 * @param clock Clock instance.
237 * @param uuid A 16-byte array containing a UUID.
239 * Returns 0 on success, a negative value on error.
241 extern int bt_ctf_clock_set_uuid(struct bt_ctf_clock
*clock
,
242 const unsigned char *uuid
);
245 * bt_ctf_clock_set_time: set a clock's current time value.
247 * Set the current time in nanoseconds since the clock's origin (offset and
248 * offset_s attributes). Defaults to 0.
250 * Returns 0 on success, a negative value on error.
252 extern int bt_ctf_clock_set_time(struct bt_ctf_clock
*clock
,
256 * bt_ctf_clock_get and bt_ctf_clock_put: increment and decrement the
257 * refcount of the clock
259 * You may also use bt_ctf_get() and bt_ctf_put() with clock objects.
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.
272 /* Pre-2.0 CTF writer compatibility */
274 void bt_ctf_clock_get(struct bt_ctf_clock
*clock
)
276 bt_object_get_ref(clock
);
279 /* Pre-2.0 CTF writer compatibility */
281 void bt_ctf_clock_put(struct bt_ctf_clock
*clock
)
283 bt_object_put_ref(clock
);
286 extern struct bt_ctf_clock_class
*bt_ctf_clock_class_create(const char *name
,
289 extern const char *bt_ctf_clock_class_get_name(
290 struct bt_ctf_clock_class
*clock_class
);
292 extern int bt_ctf_clock_class_set_name(struct bt_ctf_clock_class
*clock_class
,
295 extern const char *bt_ctf_clock_class_get_description(
296 struct bt_ctf_clock_class
*clock_class
);
298 extern int bt_ctf_clock_class_set_description(
299 struct bt_ctf_clock_class
*clock_class
,
302 extern uint64_t bt_ctf_clock_class_get_frequency(
303 struct bt_ctf_clock_class
*clock_class
);
305 extern int bt_ctf_clock_class_set_frequency(
306 struct bt_ctf_clock_class
*clock_class
, uint64_t freq
);
308 extern uint64_t bt_ctf_clock_class_get_precision(
309 struct bt_ctf_clock_class
*clock_class
);
311 extern int bt_ctf_clock_class_set_precision(
312 struct bt_ctf_clock_class
*clock_class
, uint64_t precision
);
314 extern int bt_ctf_clock_class_get_offset_s(
315 struct bt_ctf_clock_class
*clock_class
, int64_t *seconds
);
317 extern int bt_ctf_clock_class_set_offset_s(
318 struct bt_ctf_clock_class
*clock_class
, int64_t seconds
);
320 extern int bt_ctf_clock_class_get_offset_cycles(
321 struct bt_ctf_clock_class
*clock_class
, int64_t *cycles
);
323 extern int bt_ctf_clock_class_set_offset_cycles(
324 struct bt_ctf_clock_class
*clock_class
, int64_t cycles
);
326 extern bt_bool
bt_ctf_clock_class_is_absolute(
327 struct bt_ctf_clock_class
*clock_class
);
329 extern int bt_ctf_clock_class_set_is_absolute(
330 struct bt_ctf_clock_class
*clock_class
, bt_bool is_absolute
);
332 extern const unsigned char *bt_ctf_clock_class_get_uuid(
333 struct bt_ctf_clock_class
*clock_class
);
335 extern int bt_ctf_clock_class_set_uuid(struct bt_ctf_clock_class
*clock_class
,
336 const unsigned char *uuid
);
342 #endif /* BABELTRACE_CTF_WRITER_CLOCK_H */
This page took 0.035597 seconds and 4 git commands to generate.