aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/cxx/include/aesxx/debug.hpp
blob: 96e81b50dabe74960de9e6a9bfe2b07204fc0a75 (plain) (blame)
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
// Copyright (c) 2015 Egor Tensin <Egor.Tensin@gmail.com>
// This file is part of the "AES tools" project.
// For details, see https://github.com/egor-tensin/aes-tools.
// Distributed under the MIT License.

#pragma once

#ifdef WIN32
#include <windows.h>
#include <DbgHelp.h>
#pragma comment(lib, "DbgHelp.Lib")
#endif

#include <cstddef>

#include <sstream>
#include <string>

namespace aes
{
    namespace aux
    {
        class CallStackFormatter
        {
        public:
            CallStackFormatter() = default;

            std::string format_address(const void* addr) const
            {
                #ifdef WIN32
                return format_address_win32(addr);
                #else
                return format_address_fallback(addr);
                #endif
            }

        private:
            template <typename T>
            static std::string put_between_brackets(const T& x)
            {
                std::ostringstream oss;
                oss << "[" << x << "]";
                return oss.str();
            }

            template <typename T>
            static std::string stringify(const T& x)
            {
                std::ostringstream oss;
                oss << x;
                return oss.str();
            }

            static std::string format_address_fallback(const void* addr)
            {
                return put_between_brackets(addr);
            }

            static std::string format_module(
                const std::string& module_name,
                const void* offset = nullptr)
            {
                if (offset == nullptr)
                    return put_between_brackets(module_name);
                else
                    return put_between_brackets(module_name + "+" + stringify(offset));
            }

            static std::string format_symbol(
                const std::string& symbol_name,
                const void* offset = nullptr)
            {
                return format_module(symbol_name, offset);
            }

            static std::string format_symbol(
                const std::string& module_name,
                const std::string& symbol_name,
                const void* offset = nullptr)
            {
                return format_symbol(module_name + "!" + symbol_name, offset);
            }

            #ifdef WIN32
            class DbgHelp
            {
            public:
                DbgHelp()
                {
                    initialized_flag = SymInitialize(GetCurrentProcess(), NULL, TRUE) != FALSE;
                }

                bool initialized() const
                {
                    return initialized_flag;
                }

                ~DbgHelp()
                {
                    if (initialized_flag)
                        SymCleanup(GetCurrentProcess());
                }

            private:
                bool initialized_flag = false;

                DbgHelp(const DbgHelp&) = delete;
                DbgHelp& operator=(const DbgHelp&) = delete;
            };

            DbgHelp dbghelp;

            std::string format_address_win32(const void* addr) const
            {
                if (!dbghelp.initialized())
                    return format_address_fallback(addr);

                DWORD64 symbol_info_buf[sizeof(SYMBOL_INFO) + MAX_SYM_NAME];
                const auto symbol_info = reinterpret_cast<SYMBOL_INFO*>(symbol_info_buf);
                symbol_info->SizeOfStruct = sizeof(SYMBOL_INFO);
                symbol_info->MaxNameLen = MAX_SYM_NAME;

                IMAGEHLP_MODULE64 module_info;
                module_info.SizeOfStruct = sizeof(IMAGEHLP_MODULE64);

                DWORD64 symbol_offset;

                const auto symbol_resolved = SymFromAddr(
                    GetCurrentProcess(),
                    reinterpret_cast<DWORD64>(addr),
                    &symbol_offset,
                    symbol_info);

                if (symbol_resolved)
                {
                    const auto module_resolved = SymGetModuleInfo64(
                        GetCurrentProcess(),
                        symbol_info->ModBase,
                        &module_info);

                    if (module_resolved)
                    {
                        return format_symbol(
                            module_info.ModuleName,
                            symbol_info->Name,
                            reinterpret_cast<const void*>(symbol_offset));
                    }
                    else
                    {
                        return format_symbol(symbol_info->Name, addr);
                    }
                }
                else
                {
                    const auto module_resolved = SymGetModuleInfo64(
                        GetCurrentProcess(),
                        reinterpret_cast<DWORD64>(addr),
                        &module_info);

                    if (module_resolved)
                    {
                        const auto module_offset = reinterpret_cast<const char*>(addr) - module_info.BaseOfImage;
                        return format_module(module_info.ModuleName, module_offset);
                    }
                    else
                    {
                        return format_address_fallback(addr);
                    }
                }
            }
            #endif
        };
    }
}