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

   1 #ifndef BABELTRACE_CTF_IR_CLOCK_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_CLOCK_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-writer/clock.h>
  31 #include <babeltrace/ctf-ir/trace-internal.h>
  32 #include <babeltrace/object-internal.h>
  33 #include <babeltrace/babeltrace-internal.h>
  34 #include <glib.h>
  35 #include <babeltrace/compat/uuid.h>
  36
  37 struct bt_ctf_clock {
  38         struct bt_object base;
  39         GString *name;
  40         GString *description;
  41         uint64_t frequency;
  42         uint64_t precision;
  43         int64_t offset_s;       /* Offset in seconds */
  44         int64_t offset;         /* Offset in ticks */
  45         uint64_t value;         /* Current clock value */
  46         uuid_t uuid;
  47         int uuid_set;
  48         int absolute;
  49
  50         /*
  51          * This field is set once a clock is added to a trace. If the
  52          * trace was created by a CTF writer, then the clock's value
  53          * can be set and returned. Otherwise both functions fail
  54          * because, in non-writer mode, clocks do not have global
  55          * values: values are per-stream.
  56          */
  57         int has_value;
  58
  59         /*
  60          * A clock's properties can't be modified once it is added to a stream
  61          * class.
  62          */
  63         int frozen;
  64 };
  65
  66 struct bt_ctf_clock_value {
  67         struct bt_object base;
  68         struct bt_ctf_clock *clock_class;
  69         uint64_t value;
  70 };
  71
  72 BT_HIDDEN
  73 void bt_ctf_clock_freeze(struct bt_ctf_clock *clock);
  74
  75 BT_HIDDEN
  76 void bt_ctf_clock_serialize(struct bt_ctf_clock *clock,
  77                 struct metadata_context *context);
  78
  79 BT_HIDDEN
  80 bool bt_ctf_clock_is_valid(struct bt_ctf_clock *clock);
  81
  82 BT_HIDDEN
  83 int bt_ctf_clock_get_value(struct bt_ctf_clock *clock, uint64_t *value);
  84
  85 #endif /* BABELTRACE_CTF_IR_CLOCK_INTERNAL_H */