library/cpp/dwarf_backtrace/backtrace.h


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

#pragma once

#include <util/generic/array_ref.h>
#include <util/generic/maybe.h>
#include <util/generic/string.h>
#include <util/generic/vector.h>

#include <functional>

namespace NDwarf {
    struct TLineInfo {
        TString FileName;
        int Line;
        int Col;
        TString FunctionName;
        uintptr_t Address;
        int Index;
    };

    struct TError {
        int Code;
        TString Message;
    };

    enum class EResolving {
        Continue = 0,
        Break = 1,
    };

    using TCallback = std::function<EResolving(const TLineInfo&)>;

    // Resolves backtrace addresses and calls the callback for all line infos of inlined functions there.
    // Stops execution if the callback returns `EResolving::Break`.
    [[nodiscard]] TMaybe<TError> ResolveBacktrace(TArrayRef<const void* const> backtrace, TCallback callback);

    // Same as `ResolveBacktrace` but uses a separate single-threaded `backtrace_state` protected by a static mutex.
    //
    // libbacktrace may leak memory when used concurrently even with the `threaded` option set to 1,
    // which is explicitly stated in its source code (contrib/libs/backtrace/dwarf.c:dwarf_lookup_pc,
    // contrib/libs/backtrace/fileline.c:fileline_initialize) and confirmed in MAPSBKOFCT-1959.
    [[nodiscard]] TMaybe<TError> ResolveBacktraceLocked(TArrayRef<const void* const> backtrace, TCallback callback);
}