Commit | Line | Data |
---|---|---|
1c822dfb JG |
1 | #ifndef BABELTRACE_CTF_IR_CLOCK_H |
2 | #define BABELTRACE_CTF_IR_CLOCK_H | |
3 | ||
4 | /* | |
5 | * BabelTrace - CTF IR: Clock | |
6 | * | |
7 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
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: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
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 | |
27 | * SOFTWARE. | |
28 | * | |
29 | * The Common Trace Format (CTF) Specification is available at | |
30 | * http://www.efficios.com/ctf | |
31 | */ | |
32 | ||
33 | #include <stdint.h> | |
34 | ||
35 | #ifdef __cplusplus | |
36 | extern "C" { | |
37 | #endif | |
38 | ||
39 | struct bt_ctf_clock; | |
40 | ||
41 | /* | |
42 | * bt_ctf_clock_create: create a clock. | |
43 | * | |
44 | * Allocate a new clock setting its reference count to 1. | |
45 | * | |
46 | * @param name Name of the clock (will be copied). | |
47 | * | |
48 | * Returns an allocated clock on success, NULL on error. | |
49 | */ | |
50 | extern struct bt_ctf_clock *bt_ctf_clock_create(const char *name); | |
51 | ||
1c822dfb JG |
52 | /* |
53 | * bt_ctf_clock_set_description: set a clock's description. | |
54 | * | |
55 | * Set the clock's description. The description appears in the clock's TSDL | |
56 | * meta-data. | |
57 | * | |
58 | * @param clock Clock instance. | |
59 | * @param desc Description of the clock. | |
60 | * | |
61 | * Returns 0 on success, a negative value on error. | |
62 | */ | |
63 | extern int bt_ctf_clock_set_description(struct bt_ctf_clock *clock, | |
64 | const char *desc); | |
65 | ||
1c822dfb JG |
66 | /* |
67 | * bt_ctf_clock_set_frequency: set a clock's frequency. | |
68 | * | |
69 | * Set the clock's frequency (Hz). | |
70 | * | |
71 | * @param clock Clock instance. | |
72 | * @param freq Clock's frequency in Hz, defaults to 1 000 000 000 Hz (1ns). | |
73 | * | |
74 | * Returns 0 on success, a negative value on error. | |
75 | */ | |
76 | extern int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, | |
77 | uint64_t freq); | |
78 | ||
1c822dfb JG |
79 | /* |
80 | * bt_ctf_clock_set_precision: set a clock's precision. | |
81 | * | |
82 | * Set the clock's precision. | |
83 | * | |
84 | * @param clock Clock instance. | |
85 | * @param precision Clock's precision in clock ticks, defaults to 1. | |
86 | * | |
87 | * Returns 0 on success, a negative value on error. | |
88 | */ | |
89 | extern int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, | |
90 | uint64_t precision); | |
91 | ||
1c822dfb JG |
92 | /* |
93 | * bt_ctf_clock_set_offset_s: set a clock's offset in seconds. | |
94 | * | |
95 | * Set the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01, | |
96 | * defaults to 0. | |
97 | * | |
98 | * @param clock Clock instance. | |
99 | * @param offset_s Clock's offset in seconds, defaults to 0. | |
100 | * | |
101 | * Returns 0 on success, a negative value on error. | |
102 | */ | |
103 | extern int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, | |
104 | int64_t offset_s); | |
105 | ||
1c822dfb JG |
106 | /* |
107 | * bt_ctf_clock_set_offset: set a clock's offset in ticks. | |
108 | * | |
109 | * Set the clock's offset in ticks from Epoch + offset_s. | |
110 | * | |
111 | * @param clock Clock instance. | |
112 | * @param offset Clock's offset in ticks from Epoch + offset_s, defaults to 0. | |
113 | * | |
114 | * Returns 0 on success, a negative value on error. | |
115 | */ | |
116 | extern int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, | |
117 | int64_t offset); | |
118 | ||
1c822dfb JG |
119 | /* |
120 | * bt_ctf_clock_set_is_absolute: set a clock's absolute attribute. | |
121 | * | |
122 | * Set the clock's absolute attribute. A clock is absolute if the clock is a | |
123 | * global reference across the trace's other clocks. | |
124 | * | |
125 | * @param clock Clock instance. | |
126 | * @param is_absolute Clock's absolute attribute, defaults to FALSE. | |
127 | * | |
128 | * Returns 0 on success, a negative value on error. | |
129 | */ | |
130 | extern int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, | |
131 | int is_absolute); | |
132 | ||
133 | /* | |
98923034 | 134 | * bt_ctf_clock_set_time: set a clock's current time value. |
1c822dfb | 135 | * |
98923034 JG |
136 | * Set the current time in nanoseconds since the clock's origin (offset and |
137 | * offset_s attributes). Defaults to 0. | |
1c822dfb JG |
138 | * |
139 | * Returns 0 on success, a negative value on error. | |
140 | */ | |
98923034 | 141 | extern int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, int64_t time); |
1c822dfb JG |
142 | |
143 | #ifdef __cplusplus | |
144 | } | |
145 | #endif | |
146 | ||
147 | #endif /* BABELTRACE_CTF_IR_CLOCK_H */ |