Commit | Line | Data |
---|---|---|
78cf9df6 PP |
1 | #ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_CONST_H |
2 | #define BABELTRACE_TRACE_IR_CLOCK_CLASS_CONST_H | |
a62f9ba0 PP |
3 | |
4 | /* | |
78cf9df6 | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
f2b0325d | 6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
a62f9ba0 PP |
7 | * |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | * | |
26 | * The Common Trace Format (CTF) Specification is available at | |
27 | * http://www.efficios.com/ctf | |
28 | */ | |
29 | ||
30 | #include <stdint.h> | |
a62f9ba0 | 31 | |
8eee8ea2 | 32 | /* For bt_bool, bt_uuid, bt_clock_class */ |
78cf9df6 PP |
33 | #include <babeltrace/types.h> |
34 | ||
a62f9ba0 PP |
35 | #ifdef __cplusplus |
36 | extern "C" { | |
37 | #endif | |
38 | ||
d10c1e1a PP |
39 | enum bt_clock_class_status { |
40 | BT_CLOCK_CLASS_STATUS_OK = 0, | |
41 | BT_CLOCK_CLASS_STATUS_NOMEM = -12, | |
42 | BT_CLOCK_CLASS_STATUS_OVERFLOW = -75, | |
43 | }; | |
44 | ||
78cf9df6 | 45 | extern const char *bt_clock_class_get_name( |
8eee8ea2 | 46 | const bt_clock_class *clock_class); |
78cf9df6 PP |
47 | |
48 | extern const char *bt_clock_class_get_description( | |
8eee8ea2 | 49 | const bt_clock_class *clock_class); |
78cf9df6 PP |
50 | |
51 | extern uint64_t bt_clock_class_get_frequency( | |
8eee8ea2 | 52 | const bt_clock_class *clock_class); |
78cf9df6 PP |
53 | |
54 | extern uint64_t bt_clock_class_get_precision( | |
8eee8ea2 | 55 | const bt_clock_class *clock_class); |
78cf9df6 | 56 | |
8eee8ea2 | 57 | extern void bt_clock_class_get_offset(const bt_clock_class *clock_class, |
78cf9df6 | 58 | int64_t *seconds, uint64_t *cycles); |
7b33a0e0 | 59 | |
78cf9df6 | 60 | extern bt_bool bt_clock_class_is_absolute( |
8eee8ea2 | 61 | const bt_clock_class *clock_class); |
5fe68922 | 62 | |
78cf9df6 | 63 | extern bt_uuid bt_clock_class_get_uuid( |
8eee8ea2 | 64 | const bt_clock_class *clock_class); |
5fe68922 | 65 | |
d10c1e1a | 66 | extern enum bt_clock_class_status bt_clock_class_cycles_to_ns_from_origin( |
8eee8ea2 | 67 | const bt_clock_class *clock_class, |
78cf9df6 | 68 | uint64_t cycles, int64_t *ns_from_origin); |
a62f9ba0 | 69 | |
8eee8ea2 | 70 | extern void bt_clock_class_get_ref(const bt_clock_class *clock_class); |
8c6884d9 | 71 | |
8eee8ea2 | 72 | extern void bt_clock_class_put_ref(const bt_clock_class *clock_class); |
8c6884d9 PP |
73 | |
74 | #define BT_CLOCK_CLASS_PUT_REF_AND_RESET(_var) \ | |
75 | do { \ | |
76 | bt_clock_class_put_ref(_var); \ | |
77 | (_var) = NULL; \ | |
78 | } while (0) | |
79 | ||
80 | #define BT_CLOCK_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
81 | do { \ | |
82 | bt_clock_class_put_ref(_var_dst); \ | |
83 | (_var_dst) = (_var_src); \ | |
84 | (_var_src) = NULL; \ | |
85 | } while (0) | |
86 | ||
a62f9ba0 PP |
87 | #ifdef __cplusplus |
88 | } | |
89 | #endif | |
90 | ||
78cf9df6 | 91 | #endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_CONST_H */ |