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

   1 #ifndef BABELTRACE_CTF_WRITER_CLOCK_CLASS_INTERNAL_H
   2 #define BABELTRACE_CTF_WRITER_CLOCK_CLASS_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF writer: Clock class internal
   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
  30 #include <babeltrace/object-internal.h>
  31 #include <babeltrace/babeltrace-internal.h>
  32 #include <babeltrace/object-pool-internal.h>
  33 #include <babeltrace/compat/uuid-internal.h>
  34 #include <babeltrace/types.h>
  35 #include <stdbool.h>
  36 #include <stdint.h>
  37 #include <glib.h>
  38
  39 struct bt_ctf_clock_class {
  40         struct bt_object base;
  41         GString *name;
  42         GString *description;
  43         uint64_t frequency;
  44         uint64_t precision;
  45         int64_t offset_s;       /* Offset in seconds */
  46         int64_t offset;         /* Offset in ticks */
  47         unsigned char uuid[BABELTRACE_UUID_LEN];
  48         int uuid_set;
  49         int absolute;
  50
  51         /*
  52          * A clock's properties can't be modified once it is added to a stream
  53          * class.
  54          */
  55         int frozen;
  56 };
  57
  58 BT_HIDDEN
  59 void bt_ctf_clock_class_freeze(struct bt_ctf_clock_class *clock_class);
  60
  61 BT_HIDDEN
  62 bt_bool bt_ctf_clock_class_is_valid(struct bt_ctf_clock_class *clock_class);
  63
  64 BT_HIDDEN
  65 int bt_ctf_clock_class_compare(struct bt_ctf_clock_class *clock_class_a,
  66                 struct bt_ctf_clock_class *clock_class_b);
  67
  68 BT_HIDDEN
  69 struct bt_ctf_clock_class *bt_ctf_clock_class_create(const char *name,
  70                 uint64_t freq);
  71 BT_HIDDEN
  72 const char *bt_ctf_clock_class_get_name(
  73                 struct bt_ctf_clock_class *clock_class);
  74 BT_HIDDEN
  75 int bt_ctf_clock_class_set_name(struct bt_ctf_clock_class *clock_class,
  76                 const char *name);
  77 BT_HIDDEN
  78 const char *bt_ctf_clock_class_get_description(
  79                 struct bt_ctf_clock_class *clock_class);
  80 BT_HIDDEN
  81 int bt_ctf_clock_class_set_description(
  82                 struct bt_ctf_clock_class *clock_class,
  83                 const char *desc);
  84 BT_HIDDEN
  85 uint64_t bt_ctf_clock_class_get_frequency(
  86                 struct bt_ctf_clock_class *clock_class);
  87 BT_HIDDEN
  88 int bt_ctf_clock_class_set_frequency(
  89                 struct bt_ctf_clock_class *clock_class, uint64_t freq);
  90 BT_HIDDEN
  91 uint64_t bt_ctf_clock_class_get_precision(
  92                 struct bt_ctf_clock_class *clock_class);
  93 BT_HIDDEN
  94 int bt_ctf_clock_class_set_precision(
  95                 struct bt_ctf_clock_class *clock_class, uint64_t precision);
  96 BT_HIDDEN
  97 int bt_ctf_clock_class_get_offset_s(
  98                 struct bt_ctf_clock_class *clock_class, int64_t *seconds);
  99 BT_HIDDEN
 100 int bt_ctf_clock_class_set_offset_s(
 101                 struct bt_ctf_clock_class *clock_class, int64_t seconds);
 102 BT_HIDDEN
 103 int bt_ctf_clock_class_get_offset_cycles(
 104                 struct bt_ctf_clock_class *clock_class, int64_t *cycles);
 105 BT_HIDDEN
 106 int bt_ctf_clock_class_set_offset_cycles(
 107                 struct bt_ctf_clock_class *clock_class, int64_t cycles);
 108 BT_HIDDEN
 109 bt_bool bt_ctf_clock_class_is_absolute(
 110                 struct bt_ctf_clock_class *clock_class);
 111 BT_HIDDEN
 112 int bt_ctf_clock_class_set_is_absolute(
 113                 struct bt_ctf_clock_class *clock_class, bt_bool is_absolute);
 114 BT_HIDDEN
 115 const unsigned char *bt_ctf_clock_class_get_uuid(
 116                 struct bt_ctf_clock_class *clock_class);
 117 BT_HIDDEN
 118 int bt_ctf_clock_class_set_uuid(struct bt_ctf_clock_class *clock_class,
 119                 const unsigned char *uuid);
 120
 121 #endif /* BABELTRACE_CTF_WRITER_CLOCK_CLASS_INTERNAL_H */