bt2: split clock value module from clock class module
[babeltrace.git] / include / babeltrace / ctf-ir / clock-class.h
CommitLineData
ac0c6bdd
PP
1#ifndef BABELTRACE_CTF_IR_CLOCK_CLASS_H
2#define BABELTRACE_CTF_IR_CLOCK_CLASS_H
3
4/*
5 * BabelTrace - CTF IR: Clock class
6 *
7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
9 *
10 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a copy
13 * of this software and associated documentation files (the "Software"), to deal
14 * in the Software without restriction, including without limitation the rights
15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 * copies of the Software, and to permit persons to whom the Software is
17 * furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 * SOFTWARE.
29 *
30 * The Common Trace Format (CTF) Specification is available at
31 * http://www.efficios.com/ctf
32 */
33
34#include <stdint.h>
c55a9f58 35#include <babeltrace/types.h>
ac0c6bdd
PP
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41struct bt_ctf_clock_class;
42struct bt_ctf_clock_value;
43
f3534905
PP
44extern struct bt_ctf_clock_class *bt_ctf_clock_class_create(const char *name,
45 uint64_t freq);
ac0c6bdd
PP
46extern const char *bt_ctf_clock_class_get_name(
47 struct bt_ctf_clock_class *clock_class);
48extern int bt_ctf_clock_class_set_name(struct bt_ctf_clock_class *clock_class,
49 const char *name);
50extern const char *bt_ctf_clock_class_get_description(
51 struct bt_ctf_clock_class *clock_class);
52extern int bt_ctf_clock_class_set_description(
53 struct bt_ctf_clock_class *clock_class,
54 const char *desc);
55extern uint64_t bt_ctf_clock_class_get_frequency(
56 struct bt_ctf_clock_class *clock_class);
57extern int bt_ctf_clock_class_set_frequency(
58 struct bt_ctf_clock_class *clock_class, uint64_t freq);
59extern uint64_t bt_ctf_clock_class_get_precision(
60 struct bt_ctf_clock_class *clock_class);
61extern int bt_ctf_clock_class_set_precision(
62 struct bt_ctf_clock_class *clock_class, uint64_t precision);
63extern int bt_ctf_clock_class_get_offset_s(
64 struct bt_ctf_clock_class *clock_class, int64_t *seconds);
65extern int bt_ctf_clock_class_set_offset_s(
66 struct bt_ctf_clock_class *clock_class, int64_t seconds);
67extern int bt_ctf_clock_class_get_offset_cycles(
68 struct bt_ctf_clock_class *clock_class, int64_t *cycles);
69extern int bt_ctf_clock_class_set_offset_cycles(
70 struct bt_ctf_clock_class *clock_class, int64_t cycles);
a2b94977 71extern bt_bool bt_ctf_clock_class_is_absolute(
ac0c6bdd
PP
72 struct bt_ctf_clock_class *clock_class);
73extern int bt_ctf_clock_class_set_is_absolute(
a2b94977 74 struct bt_ctf_clock_class *clock_class, bt_bool is_absolute);
ac0c6bdd
PP
75extern const unsigned char *bt_ctf_clock_class_get_uuid(
76 struct bt_ctf_clock_class *clock_class);
77extern int bt_ctf_clock_class_set_uuid(struct bt_ctf_clock_class *clock_class,
78 const unsigned char *uuid);
79extern struct bt_ctf_clock_value *bt_ctf_clock_value_create(
80 struct bt_ctf_clock_class *clock_class, uint64_t value);
6f57e458
PP
81extern struct bt_ctf_clock_class *bt_ctf_clock_value_get_class(
82 struct bt_ctf_clock_value *clock_value);
ac0c6bdd
PP
83extern int bt_ctf_clock_value_get_value(
84 struct bt_ctf_clock_value *clock_value, uint64_t *raw_value);
85extern int bt_ctf_clock_value_get_value_ns_from_epoch(
86 struct bt_ctf_clock_value *clock_value, int64_t *value_ns);
87
88#ifdef __cplusplus
89}
90#endif
91
92#endif /* BABELTRACE_CTF_IR_CLOCK_CLASS_H */
This page took 0.034324 seconds and 4 git commands to generate.