include/babeltrace/ctf-ir/clock-class.h

   1 #ifndef BABELTRACE_CTF_IR_CLOCK_CLASS_H
   2 #define BABELTRACE_CTF_IR_CLOCK_CLASS_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Clock class
   6  *
   7  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  *
  30  * The Common Trace Format (CTF) Specification is available at
  31  * http://www.efficios.com/ctf
  32  */
  33
  34 #include <stdint.h>
  35
  36 /* For bt_bool, bt_uuid */
  37 #include <babeltrace/types.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 struct bt_clock_class;
  44 struct bt_clock_value;
  45
  46 extern struct bt_clock_class *bt_clock_class_create(void);
  47
  48 extern const char *bt_clock_class_get_name(struct bt_clock_class *clock_class);
  49
  50 extern int bt_clock_class_set_name(struct bt_clock_class *clock_class,
  51                 const char *name);
  52
  53 extern const char *bt_clock_class_get_description(
  54                 struct bt_clock_class *clock_class);
  55
  56 extern int bt_clock_class_set_description(struct bt_clock_class *clock_class,
  57                 const char *description);
  58
  59 extern uint64_t bt_clock_class_get_frequency(
  60                 struct bt_clock_class *clock_class);
  61
  62 extern int bt_clock_class_set_frequency(struct bt_clock_class *clock_class,
  63                 uint64_t freq);
  64
  65 extern uint64_t bt_clock_class_get_precision(
  66                 struct bt_clock_class *clock_class);
  67
  68 extern int bt_clock_class_set_precision(struct bt_clock_class *clock_class,
  69                 uint64_t precision);
  70
  71 extern void bt_clock_class_get_offset(struct bt_clock_class *clock_class,
  72                 int64_t *seconds, uint64_t *cycles);
  73
  74 extern int bt_clock_class_set_offset(struct bt_clock_class *clock_class,
  75                 int64_t seconds, uint64_t cycles);
  76
  77 extern bt_bool bt_clock_class_is_absolute(struct bt_clock_class *clock_class);
  78
  79 extern int bt_clock_class_set_is_absolute(struct bt_clock_class *clock_class,
  80                 bt_bool is_absolute);
  81
  82 extern bt_uuid bt_clock_class_get_uuid(struct bt_clock_class *clock_class);
  83
  84 extern int bt_clock_class_set_uuid(struct bt_clock_class *clock_class,
  85                 bt_uuid uuid);
  86
  87 extern int bt_clock_class_cycles_to_ns_from_origin(
  88                 struct bt_clock_class *clock_class,
  89                 uint64_t cycles, int64_t *ns_from_origin);
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif /* BABELTRACE_CTF_IR_CLOCK_CLASS_H */