clock-class.h

#ifndef BABELTRACE2_TRACE_IR_CLOCK_CLASS_H
#define BABELTRACE2_TRACE_IR_CLOCK_CLASS_H
 
/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#include <stdint.h>
 
#include <babeltrace2/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern bt_clock_class *bt_clock_class_create(bt_self_component *self_component);
 
extern void bt_clock_class_set_frequency(bt_clock_class *clock_class,
        uint64_t frequency);
 
extern uint64_t bt_clock_class_get_frequency(
        const bt_clock_class *clock_class);
 
extern void bt_clock_class_set_offset(bt_clock_class *clock_class,
        int64_t offset_seconds, uint64_t offset_cycles);
 
extern void bt_clock_class_get_offset(const bt_clock_class *clock_class,
        int64_t *offset_seconds, uint64_t *offset_cycles);
 
extern void bt_clock_class_set_precision(bt_clock_class *clock_class,
        uint64_t precision);
 
extern uint64_t bt_clock_class_get_precision(
        const bt_clock_class *clock_class);
 
extern void bt_clock_class_set_origin_is_unix_epoch(bt_clock_class *clock_class,
        bt_bool origin_is_unix_epoch);
 
extern bt_bool bt_clock_class_origin_is_unix_epoch(
        const bt_clock_class *clock_class);
 
typedef enum bt_clock_class_set_name_status {
    BT_CLOCK_CLASS_SET_NAME_STATUS_OK       = __BT_FUNC_STATUS_OK,
 
    BT_CLOCK_CLASS_SET_NAME_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_clock_class_set_name_status;
 
extern bt_clock_class_set_name_status bt_clock_class_set_name(
        bt_clock_class *clock_class, const char *name);
 
extern const char *bt_clock_class_get_name(
        const bt_clock_class *clock_class);
 
typedef enum bt_clock_class_set_description_status {
    BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_CLOCK_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_clock_class_set_description_status;
 
extern bt_clock_class_set_description_status bt_clock_class_set_description(
        bt_clock_class *clock_class, const char *description);
 
extern const char *bt_clock_class_get_description(
        const bt_clock_class *clock_class);
 
extern void bt_clock_class_set_uuid(bt_clock_class *clock_class,
        bt_uuid uuid);
 
extern bt_uuid bt_clock_class_get_uuid(
        const bt_clock_class *clock_class);
 
extern void bt_clock_class_set_user_attributes(
        bt_clock_class *clock_class, const bt_value *user_attributes);
 
extern bt_value *bt_clock_class_borrow_user_attributes(
        bt_clock_class *clock_class);
 
extern const bt_value *bt_clock_class_borrow_user_attributes_const(
        const bt_clock_class *clock_class);
 
typedef enum bt_clock_class_cycles_to_ns_from_origin_status {
    BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OK       = __BT_FUNC_STATUS_OK,
 
    BT_CLOCK_CLASS_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR   = __BT_FUNC_STATUS_OVERFLOW_ERROR,
} bt_clock_class_cycles_to_ns_from_origin_status;
 
extern bt_clock_class_cycles_to_ns_from_origin_status
bt_clock_class_cycles_to_ns_from_origin(
        const bt_clock_class *clock_class,
        uint64_t value, int64_t *ns_from_origin);
 
extern void bt_clock_class_get_ref(const bt_clock_class *clock_class);
 
extern void bt_clock_class_put_ref(const bt_clock_class *clock_class);
 
#define BT_CLOCK_CLASS_PUT_REF_AND_RESET(_clock_class)  \
    do {                        \
        bt_clock_class_put_ref(_clock_class);   \
        (_clock_class) = NULL;          \
    } while (0)
 
#define BT_CLOCK_CLASS_MOVE_REF(_dst, _src) \
    do {                    \
        bt_clock_class_put_ref(_dst);   \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_TRACE_IR_CLOCK_CLASS_H */