include/babeltrace/ctf-writer/clock.h

   1 #ifndef BABELTRACE_CTF_WRITER_CLOCK_H
   2 #define BABELTRACE_CTF_WRITER_CLOCK_H
   3
   4 /*
   5  * BabelTrace - CTF Writer: Clock
   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 <babeltrace/ctf-ir/clock.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 extern int bt_ctf_clock_get_time(struct bt_ctf_clock *clock, int64_t *time);
  40
  41 /*
  42  * bt_ctf_clock_set_time: set a clock's current time value.
  43  *
  44  * Set the current time in nanoseconds since the clock's origin (offset and
  45  * offset_s attributes). Defaults to 0.
  46  *
  47  * Returns 0 on success, a negative value on error.
  48  */
  49 extern int bt_ctf_clock_set_time(struct bt_ctf_clock *clock,
  50                 int64_t time);
  51
  52 extern uint64_t bt_ctf_clock_get_value(struct bt_ctf_clock *clock);
  53
  54 extern int bt_ctf_clock_set_value(struct bt_ctf_clock *clock,
  55                 uint64_t value);
  56
  57 /*
  58  * bt_ctf_clock_get and bt_ctf_clock_put: increment and decrement the
  59  * refcount of the clock
  60  *
  61  * You may also use bt_ctf_get() and bt_ctf_put() with clock objects.
  62  *
  63  * These functions ensure that the clock won't be destroyed when it
  64  * is in use. The same number of get and put (plus one extra put to
  65  * release the initial reference done at creation) has to be done to
  66  * destroy a clock.
  67  *
  68  * When the clock refcount is decremented to 0 by a bt_ctf_clock_put,
  69  * the clock is freed.
  70  *
  71  * @param clock Clock instance.
  72  */
  73 extern void bt_ctf_clock_get(struct bt_ctf_clock *clock);
  74 extern void bt_ctf_clock_put(struct bt_ctf_clock *clock);
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif
  79
  80 #endif /* BABELTRACE_CTF_WRITER_CLOCK_H */