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

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