include/babeltrace2/trace-ir/clock-class-const.h

   1 #ifndef BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H
   2 #define BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@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 #ifndef __BT_IN_BABELTRACE_H
  31 # error "Please include <babeltrace2/babeltrace.h> instead."
  32 #endif
  33
  34 #include <stdint.h>
  35
  36 /* For bt_bool, bt_uuid, bt_clock_class */
  37 #include <babeltrace2/types.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 extern const char *bt_clock_class_get_name(
  44                 const bt_clock_class *clock_class);
  45
  46 extern const char *bt_clock_class_get_description(
  47                 const bt_clock_class *clock_class);
  48
  49 extern uint64_t bt_clock_class_get_frequency(
  50                 const bt_clock_class *clock_class);
  51
  52 extern uint64_t bt_clock_class_get_precision(
  53                 const bt_clock_class *clock_class);
  54
  55 extern void bt_clock_class_get_offset(const bt_clock_class *clock_class,
  56                 int64_t *seconds, uint64_t *cycles);
  57
  58 extern bt_bool bt_clock_class_origin_is_unix_epoch(
  59                 const bt_clock_class *clock_class);
  60
  61 extern bt_uuid bt_clock_class_get_uuid(
  62                 const bt_clock_class *clock_class);
  63
  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(
  71                 const bt_clock_class *clock_class,
  72                 uint64_t cycles, int64_t *ns_from_origin);
  73
  74 extern void bt_clock_class_get_ref(const bt_clock_class *clock_class);
  75
  76 extern void bt_clock_class_put_ref(const bt_clock_class *clock_class);
  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
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif /* BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H */