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         uint64_t offset_s;      /* Offset in seconds */
  44         uint64_t offset;        /* Offset in ticks */
  45         uint64_t time;          /* Current clock value */
  46         uuid_t uuid;
  47         int uuid_set;
  48         int absolute;
  49         /*
  50          * A clock's properties can't be modified once it is added to a stream
  51          * class.
  52          */
  53         int frozen;
  54 };
  55
  56 /*
  57  * This is not part of the public API to prevent users from creating clocks
  58  * in an invalid state (being nameless, in this case).
  59  *
  60  * The only legitimate use-case for this function is to allocate a clock
  61  * while the TSDL metadata is being parsed.
  62  */
  63 BT_HIDDEN
  64 struct bt_ctf_clock *_bt_ctf_clock_create(void);
  65
  66 /*
  67  * Not exposed as part of the public API since the only usecase
  68  * for this is when we are creating clocks from the TSDL metadata.
  69  */
  70 BT_HIDDEN
  71 int bt_ctf_clock_set_name(struct bt_ctf_clock *clock,
  72                 const char *name);
  73
  74 BT_HIDDEN
  75 void bt_ctf_clock_freeze(struct bt_ctf_clock *clock);
  76
  77 BT_HIDDEN
  78 void bt_ctf_clock_serialize(struct bt_ctf_clock *clock,
  79                 struct metadata_context *context);
  80
  81 #endif /* BABELTRACE_CTF_IR_CLOCK_INTERNAL_H */