1 #ifndef BABELTRACE_CTF_WRITER_CLOCK_H
2 #define BABELTRACE_CTF_WRITER_CLOCK_H
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * The Common Trace Format (CTF) Specification is available at
28 * http://www.efficios.com/ctf
32 #include <babeltrace/ctf-writer/object.h>
33 #include <babeltrace/types.h>
40 struct bt_ctf_clock_class
;
43 * bt_ctf_clock_create: create a clock.
45 * Allocate a new clock setting its reference count to 1.
47 * @param name Name of the clock (will be copied); can be set to NULL
48 * for nameless clocks.
50 * Returns an allocated clock on success, NULL on error.
52 extern struct bt_ctf_clock
*bt_ctf_clock_create(const char *name
);
55 * bt_ctf_clock_get_name: get a clock's name.
57 * Get the clock's name.
59 * @param clock Clock instance.
61 * Returns the clock's name, NULL on error.
63 extern const char *bt_ctf_clock_get_name(struct bt_ctf_clock
*clock
);
66 * bt_ctf_clock_get_description: get a clock's description.
68 * Get the clock's description.
70 * @param clock Clock instance.
72 * Returns the clock's description, NULL if unset.
74 extern const char *bt_ctf_clock_get_description(struct bt_ctf_clock
*clock
);
77 * bt_ctf_clock_set_description: set a clock's description.
79 * Set the clock's description. The description appears in the clock's TSDL
82 * @param clock Clock instance.
83 * @param desc Description of the clock.
85 * Returns 0 on success, a negative value on error.
87 extern int bt_ctf_clock_set_description(struct bt_ctf_clock
*clock
,
91 * bt_ctf_clock_get_frequency: get a clock's frequency.
93 * Get the clock's frequency (Hz).
95 * @param clock Clock instance.
97 * Returns the clock's frequency, -1ULL on error.
99 extern uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock
*clock
);
102 * bt_ctf_clock_set_frequency: set a clock's frequency.
104 * Set the clock's frequency (Hz).
106 * @param clock Clock instance.
107 * @param freq Clock's frequency in Hz, defaults to 1 000 000 000 Hz (1ns).
109 * Returns 0 on success, a negative value on error.
111 extern int bt_ctf_clock_set_frequency(struct bt_ctf_clock
*clock
,
115 * bt_ctf_clock_get_precision: get a clock's precision.
117 * Get the clock's precision (in clock ticks).
119 * @param clock Clock instance.
121 * Returns the clock's precision, -1ULL on error.
123 extern uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock
*clock
);
126 * bt_ctf_clock_set_precision: set a clock's precision.
128 * Set the clock's precision.
130 * @param clock Clock instance.
131 * @param precision Clock's precision in clock ticks, defaults to 1.
133 * Returns 0 on success, a negative value on error.
135 extern int bt_ctf_clock_set_precision(struct bt_ctf_clock
*clock
,
139 * bt_ctf_clock_get_offset_s: get a clock's offset in seconds.
141 * Get the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01.
143 * @param clock Clock instance.
144 * @param offset_s Pointer to clock offset in seconds (output).
146 * Returns 0 on success, a negative value on error.
148 extern int bt_ctf_clock_get_offset_s(struct bt_ctf_clock
*clock
,
152 * bt_ctf_clock_set_offset_s: set a clock's offset in seconds.
154 * Set the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01,
157 * @param clock Clock instance.
158 * @param offset_s Clock's offset in seconds, defaults to 0.
160 * Returns 0 on success, a negative value on error.
162 extern int bt_ctf_clock_set_offset_s(struct bt_ctf_clock
*clock
,
166 * bt_ctf_clock_get_offset: get a clock's offset in ticks.
168 * Get the clock's offset in ticks from Epoch + offset_t.
170 * @param clock Clock instance.
171 * @param offset Clock offset in ticks from Epoch + offset_s (output).
173 * Returns 0 on success, a negative value on error.
175 extern int bt_ctf_clock_get_offset(struct bt_ctf_clock
*clock
,
179 * bt_ctf_clock_set_offset: set a clock's offset in ticks.
181 * Set the clock's offset in ticks from Epoch + offset_s.
183 * @param clock Clock instance.
184 * @param offset Clock's offset in ticks from Epoch + offset_s, defaults to 0.
186 * Returns 0 on success, a negative value on error.
188 extern int bt_ctf_clock_set_offset(struct bt_ctf_clock
*clock
,
192 * bt_ctf_clock_get_is_absolute: get a clock's absolute attribute.
194 * Get the clock's absolute attribute. A clock is absolute if the clock is a
195 * global reference across the trace's other clocks.
197 * @param clock Clock instance.
199 * Returns the clock's absolute attribute, a negative value on error.
201 extern int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock
*clock
);
204 * bt_ctf_clock_set_is_absolute: set a clock's absolute attribute.
206 * Set the clock's absolute attribute. A clock is absolute if the clock is a
207 * global reference across the trace's other clocks.
209 * @param clock Clock instance.
210 * @param is_absolute Clock's absolute attribute, defaults to FALSE.
212 * Returns 0 on success, a negative value on error.
214 extern int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock
*clock
,
218 * bt_ctf_clock_get_uuid: get a clock's UUID.
220 * Get the clock's UUID.
222 * @param clock Clock instance.
224 * Returns a pointer to the clock's UUID (16 byte array) on success,
227 extern const unsigned char *bt_ctf_clock_get_uuid(struct bt_ctf_clock
*clock
);
230 * bt_ctf_clock_set_uuid: set a clock's UUID.
232 * Set a clock's UUID.
234 * @param clock Clock instance.
235 * @param uuid A 16-byte array containing a UUID.
237 * Returns 0 on success, a negative value on error.
239 extern int bt_ctf_clock_set_uuid(struct bt_ctf_clock
*clock
,
240 const unsigned char *uuid
);
243 * bt_ctf_clock_set_time: set a clock's current time value.
245 * Set the current time in nanoseconds since the clock's origin (offset and
246 * offset_s attributes). Defaults to 0.
248 * Returns 0 on success, a negative value on error.
250 extern int bt_ctf_clock_set_time(struct bt_ctf_clock
*clock
,
254 * bt_ctf_clock_get and bt_ctf_clock_put: increment and decrement the
255 * refcount of the clock
257 * You may also use bt_ctf_get() and bt_ctf_put() with clock objects.
259 * These functions ensure that the clock won't be destroyed when it
260 * is in use. The same number of get and put (plus one extra put to
261 * release the initial reference done at creation) has to be done to
264 * When the clock refcount is decremented to 0 by a bt_ctf_clock_put,
265 * the clock is freed.
267 * @param clock Clock instance.
270 /* Pre-2.0 CTF writer compatibility */
272 void bt_ctf_clock_get(struct bt_ctf_clock
*clock
)
274 bt_ctf_object_get_ref(clock
);
277 /* Pre-2.0 CTF writer compatibility */
279 void bt_ctf_clock_put(struct bt_ctf_clock
*clock
)
281 bt_ctf_object_put_ref(clock
);
287 #endif /* BABELTRACE_CTF_WRITER_CLOCK_H */
This page took 0.036784 seconds and 4 git commands to generate.