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 (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  30 #include <stdint.h>
  31
  32 #include <babeltrace2/types.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 extern const bt_value *bt_clock_class_borrow_user_attributes_const(
  39                 const bt_clock_class *clock_class);
  40
  41 extern const char *bt_clock_class_get_name(
  42                 const bt_clock_class *clock_class);
  43
  44 extern const char *bt_clock_class_get_description(
  45                 const bt_clock_class *clock_class);
  46
  47 extern uint64_t bt_clock_class_get_frequency(
  48                 const bt_clock_class *clock_class);
  49
  50 extern uint64_t bt_clock_class_get_precision(
  51                 const bt_clock_class *clock_class);
  52
  53 extern void bt_clock_class_get_offset(const bt_clock_class *clock_class,
  54                 int64_t *seconds, uint64_t *cycles);
  55
  56 extern bt_bool bt_clock_class_origin_is_unix_epoch(
  57                 const bt_clock_class *clock_class);
  58
  59 extern bt_uuid bt_clock_class_get_uuid(
  60                 const bt_clock_class *clock_class);
  61
  62 typedef enum bt_clock_class_cycles_to_ns_from_origin_status {
  63         BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR   = __BT_FUNC_STATUS_OVERFLOW_ERROR,
  64         BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK               = __BT_FUNC_STATUS_OK,
  65 } bt_clock_class_cycles_to_ns_from_origin_status;
  66
  67 extern bt_clock_class_cycles_to_ns_from_origin_status
  68 bt_clock_class_cycles_to_ns_from_origin(
  69                 const bt_clock_class *clock_class,
  70                 uint64_t cycles, int64_t *ns_from_origin);
  71
  72 extern void bt_clock_class_get_ref(const bt_clock_class *clock_class);
  73
  74 extern void bt_clock_class_put_ref(const bt_clock_class *clock_class);
  75
  76 #define BT_CLOCK_CLASS_PUT_REF_AND_RESET(_var)          \
  77         do {                                            \
  78                 bt_clock_class_put_ref(_var);           \
  79                 (_var) = NULL;                          \
  80         } while (0)
  81
  82 #define BT_CLOCK_CLASS_MOVE_REF(_var_dst, _var_src)     \
  83         do {                                            \
  84                 bt_clock_class_put_ref(_var_dst);       \
  85                 (_var_dst) = (_var_src);                \
  86                 (_var_src) = NULL;                      \
  87         } while (0)
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif /* BABELTRACE2_TRACE_IR_CLOCK_CLASS_CONST_H */