include/babeltrace/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  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  *
  28  * The Common Trace Format (CTF) Specification is available at
  29  * http://www.efficios.com/ctf
  30  */
  31
  32 #include <stdint.h>
  33
  34 /* For bt_bool, bt_uuid */
  35 #include <babeltrace/types.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 struct bt_clock_class;
  42
  43 extern const char *bt_clock_class_get_name(struct bt_clock_class *clock_class);
  44
  45 extern const char *bt_clock_class_get_description(
  46                 struct bt_clock_class *clock_class);
  47
  48 extern uint64_t bt_clock_class_get_frequency(
  49                 struct bt_clock_class *clock_class);
  50
  51 extern uint64_t bt_clock_class_get_precision(
  52                 struct bt_clock_class *clock_class);
  53
  54 extern void bt_clock_class_get_offset(struct bt_clock_class *clock_class,
  55                 int64_t *seconds, uint64_t *cycles);
  56
  57 extern bt_bool bt_clock_class_is_absolute(struct bt_clock_class *clock_class);
  58
  59 extern bt_uuid bt_clock_class_get_uuid(struct bt_clock_class *clock_class);
  60
  61 extern int bt_clock_class_cycles_to_ns_from_origin(
  62                 struct bt_clock_class *clock_class,
  63                 uint64_t cycles, int64_t *ns_from_origin);
  64
  65 #ifdef __cplusplus
  66 }
  67 #endif
  68
  69 #endif /* BABELTRACE_TRACE_IR_CLOCK_CLASS_H */