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

   1 #ifndef BABELTRACE_CTF_IR_CLOCK_CLASS_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_CLOCK_CLASS_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Clock 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/ctf-ir/clock-class.h>
  31 #include <babeltrace/object-internal.h>
  32 #include <babeltrace/babeltrace-internal.h>
  33 #include <babeltrace/object-pool-internal.h>
  34 #include <babeltrace/compat/uuid-internal.h>
  35 #include <babeltrace/types.h>
  36 #include <stdbool.h>
  37 #include <stdint.h>
  38 #include <glib.h>
  39
  40 struct bt_clock_class {
  41         struct bt_object base;
  42         GString *name;
  43         GString *description;
  44         uint64_t frequency;
  45         uint64_t precision;
  46         int64_t offset_s;       /* Offset in seconds */
  47         int64_t offset;         /* Offset in ticks */
  48         unsigned char uuid[BABELTRACE_UUID_LEN];
  49         int uuid_set;
  50         int absolute;
  51
  52         /*
  53          * A clock's properties can't be modified once it is added to a stream
  54          * class.
  55          */
  56         int frozen;
  57
  58         /* Pool of `struct bt_clock_value *` */
  59         struct bt_object_pool cv_pool;
  60 };
  61
  62 BT_HIDDEN
  63 void bt_clock_class_freeze(struct bt_clock_class *clock_class);
  64
  65 BT_HIDDEN
  66 bt_bool bt_clock_class_is_valid(struct bt_clock_class *clock_class);
  67
  68 BT_HIDDEN
  69 int bt_clock_class_compare(struct bt_clock_class *clock_class_a,
  70                 struct bt_clock_class *clock_class_b);
  71
  72 #endif /* BABELTRACE_CTF_IR_CLOCK_CLASS_INTERNAL_H */