Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H |
2 | #define BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H | |
c057dea0 PP |
3 | |
4 | /* | |
40f4ba76 | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
e2f7325d | 6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
c057dea0 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 | ||
4fa90f32 PP |
30 | #ifndef __BT_IN_BABELTRACE_H |
31 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
32 | #endif | |
33 | ||
c057dea0 | 34 | #include <stdint.h> |
c057dea0 | 35 | |
b19ff26f | 36 | /* For bt_bool, bt_uuid, bt_clock_class */ |
3fadfbc0 | 37 | #include <babeltrace2/types.h> |
40f4ba76 | 38 | |
c057dea0 PP |
39 | #ifdef __cplusplus |
40 | extern "C" { | |
41 | #endif | |
42 | ||
40f4ba76 | 43 | extern const char *bt_clock_class_get_name( |
b19ff26f | 44 | const bt_clock_class *clock_class); |
40f4ba76 PP |
45 | |
46 | extern const char *bt_clock_class_get_description( | |
b19ff26f | 47 | const bt_clock_class *clock_class); |
40f4ba76 PP |
48 | |
49 | extern uint64_t bt_clock_class_get_frequency( | |
b19ff26f | 50 | const bt_clock_class *clock_class); |
40f4ba76 PP |
51 | |
52 | extern uint64_t bt_clock_class_get_precision( | |
b19ff26f | 53 | const bt_clock_class *clock_class); |
40f4ba76 | 54 | |
b19ff26f | 55 | extern void bt_clock_class_get_offset(const bt_clock_class *clock_class, |
40f4ba76 | 56 | int64_t *seconds, uint64_t *cycles); |
44c440bc | 57 | |
5552377a | 58 | extern bt_bool bt_clock_class_origin_is_unix_epoch( |
b19ff26f | 59 | const bt_clock_class *clock_class); |
094ff7c0 | 60 | |
40f4ba76 | 61 | extern bt_uuid bt_clock_class_get_uuid( |
b19ff26f | 62 | const bt_clock_class *clock_class); |
094ff7c0 | 63 | |
d24d5663 PP |
64 | typedef enum bt_clock_class_cycles_to_ns_from_origin_status { |
65 | BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW = __BT_FUNC_STATUS_OVERFLOW, | |
66 | BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK = __BT_FUNC_STATUS_OK, | |
67 | } bt_clock_class_cycles_to_ns_from_origin_status; | |
68 | ||
69 | extern bt_clock_class_cycles_to_ns_from_origin_status | |
70 | bt_clock_class_cycles_to_ns_from_origin( | |
b19ff26f | 71 | const bt_clock_class *clock_class, |
40f4ba76 | 72 | uint64_t cycles, int64_t *ns_from_origin); |
c057dea0 | 73 | |
b19ff26f | 74 | extern void bt_clock_class_get_ref(const bt_clock_class *clock_class); |
c5b9b441 | 75 | |
b19ff26f | 76 | extern void bt_clock_class_put_ref(const bt_clock_class *clock_class); |
c5b9b441 PP |
77 | |
78 | #define BT_CLOCK_CLASS_PUT_REF_AND_RESET(_var) \ | |
79 | do { \ | |
80 | bt_clock_class_put_ref(_var); \ | |
81 | (_var) = NULL; \ | |
82 | } while (0) | |
83 | ||
84 | #define BT_CLOCK_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
85 | do { \ | |
86 | bt_clock_class_put_ref(_var_dst); \ | |
87 | (_var_dst) = (_var_src); \ | |
88 | (_var_src) = NULL; \ | |
89 | } while (0) | |
90 | ||
c057dea0 PP |
91 | #ifdef __cplusplus |
92 | } | |
93 | #endif | |
94 | ||
924dc299 | 95 | #endif /* BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H */ |