1 #ifndef BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H
2 #define BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
26 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
30 #ifndef __BT_IN_BABELTRACE_H
31 # error "Please include <babeltrace2/babeltrace.h> instead."
36 #include <babeltrace2/types.h>
42 extern const char *bt_clock_class_get_name(
43 const bt_clock_class
*clock_class
);
45 extern const char *bt_clock_class_get_description(
46 const bt_clock_class
*clock_class
);
48 extern uint64_t bt_clock_class_get_frequency(
49 const bt_clock_class
*clock_class
);
51 extern uint64_t bt_clock_class_get_precision(
52 const bt_clock_class
*clock_class
);
54 extern void bt_clock_class_get_offset(const bt_clock_class
*clock_class
,
55 int64_t *seconds
, uint64_t *cycles
);
57 extern bt_bool
bt_clock_class_origin_is_unix_epoch(
58 const bt_clock_class
*clock_class
);
60 extern bt_uuid
bt_clock_class_get_uuid(
61 const bt_clock_class
*clock_class
);
63 typedef enum bt_clock_class_cycles_to_ns_from_origin_status
{
64 BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW
= __BT_FUNC_STATUS_OVERFLOW
,
65 BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK
= __BT_FUNC_STATUS_OK
,
66 } bt_clock_class_cycles_to_ns_from_origin_status
;
68 extern bt_clock_class_cycles_to_ns_from_origin_status
69 bt_clock_class_cycles_to_ns_from_origin(
70 const bt_clock_class
*clock_class
,
71 uint64_t cycles
, int64_t *ns_from_origin
);
73 extern void bt_clock_class_get_ref(const bt_clock_class
*clock_class
);
75 extern void bt_clock_class_put_ref(const bt_clock_class
*clock_class
);
77 #define BT_CLOCK_CLASS_PUT_REF_AND_RESET(_var) \
79 bt_clock_class_put_ref(_var); \
83 #define BT_CLOCK_CLASS_MOVE_REF(_var_dst, _var_src) \
85 bt_clock_class_put_ref(_var_dst); \
86 (_var_dst) = (_var_src); \
94 #endif /* BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H */