trace.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_TRACE_IR_TRACE_H
#define BABELTRACE2_TRACE_IR_TRACE_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 *bt_trace_create(bt_trace_class *trace_class) __BT_NOEXCEPT;
 
extern bt_trace_class *bt_trace_borrow_class(bt_trace *trace) __BT_NOEXCEPT;
 
extern const bt_trace_class *bt_trace_borrow_class_const(
        const bt_trace *trace) __BT_NOEXCEPT;
 
extern uint64_t bt_trace_get_stream_count(const bt_trace *trace) __BT_NOEXCEPT;
 
extern bt_stream *bt_trace_borrow_stream_by_index(bt_trace *trace,
        uint64_t index) __BT_NOEXCEPT;
 
extern const bt_stream *bt_trace_borrow_stream_by_index_const(
        const bt_trace *trace, uint64_t index) __BT_NOEXCEPT;
 
extern bt_stream *bt_trace_borrow_stream_by_id(bt_trace *trace,
        uint64_t id) __BT_NOEXCEPT;
 
extern const bt_stream *bt_trace_borrow_stream_by_id_const(
        const bt_trace *trace, uint64_t id) __BT_NOEXCEPT;
 
typedef enum bt_trace_set_namespace_status {
    BT_TRACE_SET_NAMESPACE_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_TRACE_SET_NAMESPACE_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_trace_set_namespace_status;
 
extern bt_trace_set_namespace_status bt_trace_set_namespace(bt_trace *trace,
        const char *ns) __BT_NOEXCEPT;
 
extern const char *bt_trace_get_namespace(const bt_trace *trace) __BT_NOEXCEPT;
 
typedef enum bt_trace_set_name_status {
    BT_TRACE_SET_NAME_STATUS_OK     = __BT_FUNC_STATUS_OK,
 
    BT_TRACE_SET_NAME_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_trace_set_name_status;
 
extern bt_trace_set_name_status bt_trace_set_name(bt_trace *trace,
        const char *name) __BT_NOEXCEPT;
 
extern const char *bt_trace_get_name(const bt_trace *trace) __BT_NOEXCEPT;
 
extern void bt_trace_set_uuid(bt_trace *trace, bt_uuid uuid) __BT_NOEXCEPT;
 
extern bt_uuid bt_trace_get_uuid(const bt_trace *trace) __BT_NOEXCEPT;
 
typedef enum bt_trace_set_uid_status {
    BT_TRACE_SET_UID_STATUS_OK      = __BT_FUNC_STATUS_OK,
 
    BT_TRACE_SET_UID_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_trace_set_uid_status;
 
extern bt_trace_set_uid_status bt_trace_set_uid(bt_trace *trace, const char *uid);
 
extern const char *bt_trace_get_uid(const bt_trace *trace);
 
typedef enum bt_trace_set_environment_entry_status {
    BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_trace_set_environment_entry_status;
 
extern bt_trace_set_environment_entry_status
bt_trace_set_environment_entry_integer(bt_trace *trace, const char *name,
        int64_t value) __BT_NOEXCEPT;
 
extern bt_trace_set_environment_entry_status
bt_trace_set_environment_entry_string(bt_trace *trace, const char *name,
        const char *value) __BT_NOEXCEPT;
 
extern uint64_t bt_trace_get_environment_entry_count(
        const bt_trace *trace) __BT_NOEXCEPT;
 
extern void bt_trace_borrow_environment_entry_by_index_const(
        const bt_trace *trace, uint64_t index,
        const char **name, const bt_value **value) __BT_NOEXCEPT;
 
extern const bt_value *bt_trace_borrow_environment_entry_value_by_name_const(
        const bt_trace *trace, const char *name) __BT_NOEXCEPT;
 
extern void bt_trace_set_user_attributes(
        bt_trace *trace, const bt_value *user_attributes) __BT_NOEXCEPT;
 
extern bt_value *bt_trace_borrow_user_attributes(bt_trace *trace) __BT_NOEXCEPT;
 
extern const bt_value *bt_trace_borrow_user_attributes_const(
        const bt_trace *trace) __BT_NOEXCEPT;
 
typedef void (* bt_trace_destruction_listener_func)(
        const bt_trace *trace, void *user_data);
 
typedef enum bt_trace_add_listener_status {
    BT_TRACE_ADD_LISTENER_STATUS_OK         = __BT_FUNC_STATUS_OK,
 
    BT_TRACE_ADD_LISTENER_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_trace_add_listener_status;
 
extern bt_trace_add_listener_status bt_trace_add_destruction_listener(
        const bt_trace *trace,
        bt_trace_destruction_listener_func user_func,
        void *user_data, bt_listener_id *listener_id) __BT_NOEXCEPT;
 
typedef enum bt_trace_remove_listener_status {
    BT_TRACE_REMOVE_LISTENER_STATUS_OK      = __BT_FUNC_STATUS_OK,
 
    BT_TRACE_REMOVE_LISTENER_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_trace_remove_listener_status;
 
extern bt_trace_remove_listener_status bt_trace_remove_destruction_listener(
        const bt_trace *trace, bt_listener_id listener_id)
        __BT_NOEXCEPT;
 
extern void bt_trace_get_ref(const bt_trace *trace) __BT_NOEXCEPT;
 
extern void bt_trace_put_ref(const bt_trace *trace) __BT_NOEXCEPT;
 
#define BT_TRACE_PUT_REF_AND_RESET(_trace)      \
    do {                        \
        bt_trace_put_ref(_trace);       \
        (_trace) = NULL;            \
    } while (0)
 
#define BT_TRACE_MOVE_REF(_dst, _src)       \
    do {                    \
        bt_trace_put_ref(_dst);     \
        (_dst) = (_src);        \
        (_src) = NULL;          \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_TRACE_IR_TRACE_H */