include/babeltrace/trace-ir/clock-value.h

   1 #ifndef BABELTRACE_TRACE_IR_CLOCK_VALUE_H
   2 #define BABELTRACE_TRACE_IR_CLOCK_VALUE_H
   3
   4 /*
   5  * BabelTrace - Trace IR: Clock class
   6  *
   7  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  *
  30  * The Common Trace Format (CTF) Specification is available at
  31  * http://www.efficios.com/ctf
  32  */
  33
  34 #include <stdint.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 struct bt_clock_class;
  41 struct bt_clock_value;
  42
  43 enum bt_clock_value_status {
  44         BT_CLOCK_VALUE_STATUS_KNOWN,
  45         BT_CLOCK_VALUE_STATUS_UNKNOWN,
  46 };
  47
  48 extern struct bt_clock_class *bt_clock_value_borrow_clock_class(
  49                 struct bt_clock_value *clock_value);
  50
  51 extern uint64_t bt_clock_value_get_value(
  52                 struct bt_clock_value *clock_value);
  53
  54 extern int bt_clock_value_get_ns_from_origin(
  55                 struct bt_clock_value *clock_value, int64_t *ns_from_origin);
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif /* BABELTRACE_TRACE_IR_CLOCK_VALUE_H */