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

   1 #ifndef BABELTRACE2_TRACE_IR_CLOCK_CLASS_H
   2 #define BABELTRACE2_TRACE_IR_CLOCK_CLASS_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 bt_clock_class *bt_clock_class_create(bt_self_component *self_comp);
  39
  40 typedef enum bt_clock_class_set_name_status {
  41         BT_CLOCK_CLASS_SET_NAME_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  42         BT_CLOCK_CLASS_SET_NAME_STATUS_OK               = __BT_FUNC_STATUS_OK,
  43 } bt_clock_class_set_name_status;
  44
  45 extern bt_clock_class_set_name_status bt_clock_class_set_name(
  46                 bt_clock_class *clock_class, const char *name);
  47
  48 typedef enum bt_clock_class_set_description_status {
  49         BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  50         BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_OK                = __BT_FUNC_STATUS_OK,
  51 } bt_clock_class_set_description_status;
  52
  53 extern bt_clock_class_set_description_status bt_clock_class_set_description(
  54                 bt_clock_class *clock_class, const char *description);
  55
  56 extern void bt_clock_class_set_frequency(bt_clock_class *clock_class,
  57                 uint64_t freq);
  58
  59 extern void bt_clock_class_set_precision(bt_clock_class *clock_class,
  60                 uint64_t precision);
  61
  62 extern void bt_clock_class_set_offset(bt_clock_class *clock_class,
  63                 int64_t seconds, uint64_t cycles);
  64
  65 extern void bt_clock_class_set_origin_is_unix_epoch(bt_clock_class *clock_class,
  66                 bt_bool origin_is_unix_epoch);
  67
  68 extern void bt_clock_class_set_uuid(bt_clock_class *clock_class,
  69                 bt_uuid uuid);
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif
  74
  75 #endif /* BABELTRACE2_TRACE_IR_CLOCK_CLASS_H */