backtrace.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_backtrace_api.h>
 
#include "core/analyze.h"
#include "core/compiler.h"
 
#include "core/source_info.h"
#include "core/text.h"
 
#include <inttypes.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
CT_BEGIN_API
 
 
typedef uint_least64_t bt_address_t;
 
#define BT_PRI_ADDRESS PRIuLEAST64
 
typedef struct bt_symbol_t
{
    source_line_t line;
 
    text_t name;
 
    text_t path;
} bt_symbol_t;
 
typedef enum bt_resolve_t
{
    eResolveNothing = (0),
 
    eResolveLine = (1 << 0),
 
    eResolveName = (1 << 1),
 
    eResolveDemangledName = (1 << 2) | eResolveName,
 
    eResolveFile = (1 << 3),
 
    eResolveAll = eResolveLine | eResolveName | eResolveFile,
} bt_resolve_t;
 
typedef void (*bt_trace_t)(bt_address_t frame, void *user);
 
typedef void (*bt_error_begin_t)(size_t error, void *user);
 
typedef void (*bt_error_end_t)(void *user);
 
typedef struct bt_error_t
{
    bt_error_begin_t begin;
 
    bt_error_end_t end;
 
    bt_trace_t next;
 
    void *user;
} bt_error_t;
 
CT_BACKTRACE_API extern bt_error_t gSystemError;
 
CT_BACKTRACE_API void bt_init(void);
 
CT_BACKTRACE_API void bt_update(void);
 
STA_RET_STRING CT_CONSTFN
CT_BACKTRACE_API const char *bt_backend(void);
 
CT_BACKTRACE_API void bt_read(IN_NOTNULL bt_trace_t callback, void *user);
 
CT_BACKTRACE_API bt_resolve_t bt_resolve_symbol(bt_address_t frame, IN_NOTNULL bt_symbol_t *symbol);
 
 
CT_END_API
 
CT_ENUM_FLAGS(bt_resolve_t, int)
 
#if CT_CPLUSPLUS >= 202002L
namespace ctu::bt {
    template<typename T>
    concept AddressCallback = requires (T it) {
        { it(bt_address_t{}) };
    };
 
    void read(AddressCallback auto& fn) {
        using FnType = decltype(fn);
 
        bt_read([](bt_address_t address, void *user) {
            auto& fn = *static_cast<FnType*>(user);
            fn(address);
        }, static_cast<void*>(&fn));
    }
}
#endif