trace-class.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_TRACE_IR_TRACE_CLASS_H
#define BABELTRACE2_TRACE_IR_TRACE_CLASS_H
 
/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
 
#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_trace_class *bt_trace_class_create(bt_self_component *self_component)
        __BT_NOEXCEPT;
 
extern uint64_t bt_trace_class_get_stream_class_count(
        const bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_stream_class *bt_trace_class_borrow_stream_class_by_index(
        bt_trace_class *trace_class, uint64_t index) __BT_NOEXCEPT;
 
extern const bt_stream_class *
bt_trace_class_borrow_stream_class_by_index_const(
        const bt_trace_class *trace_class,
        uint64_t index) __BT_NOEXCEPT;
 
extern bt_stream_class *bt_trace_class_borrow_stream_class_by_id(
        bt_trace_class *trace_class, uint64_t id) __BT_NOEXCEPT;
 
extern const bt_stream_class *bt_trace_class_borrow_stream_class_by_id_const(
        const bt_trace_class *trace_class, uint64_t id) __BT_NOEXCEPT;
 
extern void bt_trace_class_set_assigns_automatic_stream_class_id(
        bt_trace_class *trace_class,
        bt_bool assigns_automatic_stream_class_id) __BT_NOEXCEPT;
 
extern bt_bool bt_trace_class_assigns_automatic_stream_class_id(
        const bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern void bt_trace_class_set_user_attributes(
        bt_trace_class *trace_class,
        const bt_value *user_attributes) __BT_NOEXCEPT;
 
extern bt_value *bt_trace_class_borrow_user_attributes(
        bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern const bt_value *bt_trace_class_borrow_user_attributes_const(
        const bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern uint64_t bt_trace_class_get_graph_mip_version(
        const bt_trace_class *trace_class) __BT_NOEXCEPT;
 
typedef void (* bt_trace_class_destruction_listener_func)(
        const bt_trace_class *trace_class, void *user_data);
 
typedef enum bt_trace_class_add_listener_status {
    BT_TRACE_CLASS_ADD_LISTENER_STATUS_OK       = __BT_FUNC_STATUS_OK,
 
    BT_TRACE_CLASS_ADD_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_trace_class_add_listener_status;
 
extern bt_trace_class_add_listener_status
bt_trace_class_add_destruction_listener(
        const bt_trace_class *trace_class,
        bt_trace_class_destruction_listener_func user_func,
        void *user_data, bt_listener_id *listener_id) __BT_NOEXCEPT;
 
typedef enum bt_trace_class_remove_listener_status {
    BT_TRACE_CLASS_REMOVE_LISTENER_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_TRACE_CLASS_REMOVE_LISTENER_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_trace_class_remove_listener_status;
 
extern bt_trace_class_remove_listener_status
bt_trace_class_remove_destruction_listener(
        const bt_trace_class *trace_class, bt_listener_id listener_id)
        __BT_NOEXCEPT;
 
extern void bt_trace_class_get_ref(
        const bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern void bt_trace_class_put_ref(
        const bt_trace_class *trace_class) __BT_NOEXCEPT;
 
#define BT_TRACE_CLASS_PUT_REF_AND_RESET(_trace_class)      \
    do {                            \
        bt_trace_class_put_ref(_trace_class);       \
        (_trace_class) = NULL;              \
    } while (0)
 
#define BT_TRACE_CLASS_MOVE_REF(_dst, _src) \
    do {                    \
        bt_trace_class_put_ref(_dst);   \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_TRACE_IR_TRACE_CLASS_H */