include/babeltrace/trace-ir/clock-snapshot-const.h

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