error-reporting.h

#ifndef BABELTRACE2_ERROR_REPORTING_H
#define BABELTRACE2_ERROR_REPORTING_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 <stdarg.h>
 
#include <babeltrace2/types.h>
#include <babeltrace2/graph/component-class.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern
const bt_error *bt_current_thread_take_error(void);
 
extern
void bt_current_thread_move_error(const bt_error *error);
 
#define BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(_error)  \
    do {                        \
        bt_current_thread_move_error(_error);   \
        (_error) = NULL;            \
    } while (0)
 
extern
void bt_current_thread_clear_error(void);
 
typedef enum bt_current_thread_error_append_cause_status {
    BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_STATUS_OK          = __BT_FUNC_STATUS_OK,
 
    BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_current_thread_error_append_cause_status;
 
extern
bt_current_thread_error_append_cause_status
bt_current_thread_error_append_cause_from_component(
        bt_self_component *self_component, const char *file_name,
        uint64_t line_number, const char *message_format, ...);
 
#define BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(_self_component, _message_format, ...) \
    bt_current_thread_error_append_cause_from_component( \
        (_self_component), __FILE__, __LINE__, (_message_format), ##__VA_ARGS__)
 
extern
bt_current_thread_error_append_cause_status
bt_current_thread_error_append_cause_from_message_iterator(
        bt_self_message_iterator *self_message_iterator,
        const char *file_name, uint64_t line_number,
        const char *message_format, ...);
 
#define BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_MESSAGE_ITERATOR(_self_message_iterator, _message_format, ...) \
    bt_current_thread_error_append_cause_from_message_iterator( \
        (_self_message_iterator), __FILE__, __LINE__, (_message_format), ##__VA_ARGS__)
 
extern
bt_current_thread_error_append_cause_status
bt_current_thread_error_append_cause_from_component_class(
        bt_self_component_class *self_component_class,
        const char *file_name, uint64_t line_number,
        const char *message_format, ...);
 
#define BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT_CLASS(_self_component_class, _message_format, ...) \
    bt_current_thread_error_append_cause_from_component_class( \
        (_self_component_class), __FILE__, __LINE__, (_message_format), ##__VA_ARGS__)
 
extern
bt_current_thread_error_append_cause_status
bt_current_thread_error_append_cause_from_unknown(
        const char *module_name, const char *file_name,
        uint64_t line_number, const char *message_format, ...);
 
#define BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(_module_name, _message_format, ...) \
    bt_current_thread_error_append_cause_from_unknown( \
        (_module_name), __FILE__, __LINE__, (_message_format), ##__VA_ARGS__)
 
extern
uint64_t bt_error_get_cause_count(const bt_error *error);
 
extern
const bt_error_cause *bt_error_borrow_cause_by_index(
        const bt_error *error, uint64_t index);
 
extern
void bt_error_release(const bt_error *error);
 
typedef enum bt_error_cause_actor_type {
    BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN       = 1 << 0,
 
    BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT     = 1 << 1,
 
    BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS   = 1 << 2,
 
    BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR  = 1 << 3,
} bt_error_cause_actor_type;
 
extern
bt_error_cause_actor_type bt_error_cause_get_actor_type(
        const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_get_message(const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_get_module_name(const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_get_file_name(const bt_error_cause *error_cause);
 
extern
uint64_t bt_error_cause_get_line_number(const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_component_actor_get_component_name(
        const bt_error_cause *error_cause);
 
extern
bt_component_class_type bt_error_cause_component_actor_get_component_class_type(
        const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_component_actor_get_component_class_name(
        const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_component_actor_get_plugin_name(
        const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_message_iterator_actor_get_component_output_port_name(
        const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_message_iterator_actor_get_component_name(
        const bt_error_cause *error_cause);
 
extern
bt_component_class_type
bt_error_cause_message_iterator_actor_get_component_class_type(
        const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_message_iterator_actor_get_component_class_name(
        const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_message_iterator_actor_get_plugin_name(
        const bt_error_cause *error_cause);
 
extern
bt_component_class_type
bt_error_cause_component_class_actor_get_component_class_type(
        const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_component_class_actor_get_component_class_name(
        const bt_error_cause *error_cause);
 
extern
const char *bt_error_cause_component_class_actor_get_plugin_name(
        const bt_error_cause *error_cause);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_ERROR_REPORTING_H */