cf03ca8025180750702cd996e3e12934a5bb24db
[babeltrace.git] / include / babeltrace2 / trace-ir / clock-class.h
1 #ifndef BABELTRACE_TRACE_IR_CLOCK_CLASS_H
2 #define BABELTRACE_TRACE_IR_CLOCK_CLASS_H
3
4 /*
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
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>
31
32 /* For bt_bool, bt_uuid, bt_clock_class, bt_trace_class */
33 #include <babeltrace2/types.h>
34
35 /* For __BT_FUNC_STATUS_* */
36 #define __BT_FUNC_STATUS_ENABLE
37 #include <babeltrace2/func-status.h>
38 #undef __BT_FUNC_STATUS_ENABLE
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 extern bt_clock_class *bt_clock_class_create(bt_self_component *self_comp);
45
46 typedef enum bt_clock_class_set_name_status {
47 BT_CLOCK_CLASS_SET_NAME_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
48 BT_CLOCK_CLASS_SET_NAME_STATUS_OK = __BT_FUNC_STATUS_OK,
49 } bt_clock_class_set_name_status;
50
51 extern bt_clock_class_set_name_status bt_clock_class_set_name(
52 bt_clock_class *clock_class, const char *name);
53
54 typedef enum bt_clock_class_set_description_status {
55 BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
56 BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
57 } bt_clock_class_set_description_status;
58
59 extern bt_clock_class_set_description_status bt_clock_class_set_description(
60 bt_clock_class *clock_class, const char *description);
61
62 extern void bt_clock_class_set_frequency(bt_clock_class *clock_class,
63 uint64_t freq);
64
65 extern void bt_clock_class_set_precision(bt_clock_class *clock_class,
66 uint64_t precision);
67
68 extern void bt_clock_class_set_offset(bt_clock_class *clock_class,
69 int64_t seconds, uint64_t cycles);
70
71 extern void bt_clock_class_set_origin_is_unix_epoch(bt_clock_class *clock_class,
72 bt_bool origin_is_unix_epoch);
73
74 extern void bt_clock_class_set_uuid(bt_clock_class *clock_class,
75 bt_uuid uuid);
76
77 #ifdef __cplusplus
78 }
79 #endif
80
81 #include <babeltrace2/undef-func-status.h>
82
83 #endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_H */
This page took 0.030648 seconds and 3 git commands to generate.