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 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   6  * Copyright 2017-2018 Philippe Proulx <pproulx@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, bt_trace_class */
  37 #include <babeltrace2/types.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 extern bt_clock_class *bt_clock_class_create(bt_self_component *self_comp);
  44
  45 typedef enum bt_clock_class_set_name_status {
  46         BT_CLOCK_CLASS_SET_NAME_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  47         BT_CLOCK_CLASS_SET_NAME_STATUS_OK               = __BT_FUNC_STATUS_OK,
  48 } bt_clock_class_set_name_status;
  49
  50 extern bt_clock_class_set_name_status bt_clock_class_set_name(
  51                 bt_clock_class *clock_class, const char *name);
  52
  53 typedef enum bt_clock_class_set_description_status {
  54         BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  55         BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_OK                = __BT_FUNC_STATUS_OK,
  56 } bt_clock_class_set_description_status;
  57
  58 extern bt_clock_class_set_description_status bt_clock_class_set_description(
  59                 bt_clock_class *clock_class, const char *description);
  60
  61 extern void bt_clock_class_set_frequency(bt_clock_class *clock_class,
  62                 uint64_t freq);
  63
  64 extern void bt_clock_class_set_precision(bt_clock_class *clock_class,
  65                 uint64_t precision);
  66
  67 extern void bt_clock_class_set_offset(bt_clock_class *clock_class,
  68                 int64_t seconds, uint64_t cycles);
  69
  70 extern void bt_clock_class_set_origin_is_unix_epoch(bt_clock_class *clock_class,
  71                 bt_bool origin_is_unix_epoch);
  72
  73 extern void bt_clock_class_set_uuid(bt_clock_class *clock_class,
  74                 bt_uuid uuid);
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif
  79
  80 #endif /* BABELTRACE2_TRACE_IR_CLOCK_CLASS_H */