Repository navigation
Expand file tree
/
Copy pathdebug_utils.h
More file actions
199 lines (165 loc) · 7.71 KB
/
Copy pathdebug_utils.h
File metadata and controls
199 lines (165 loc) · 7.71 KB
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
#ifndef SRC_DEBUG_UTILS_H_
#define SRC_DEBUG_UTILS_H_
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
#include "async_wrap.h"
#include "util.h"
#include <algorithm>
#include <sstream>
#include <string>
// Use FORCE_INLINE on functions that have a debug-category-enabled check first
// and then ideally only a single function call following it, to maintain
// performance for the common case (no debugging used).
#ifdef __GNUC__
#define FORCE_INLINE __attribute__((always_inline))
#define COLD_NOINLINE __attribute__((cold, noinline))
#else
#define FORCE_INLINE
#define COLD_NOINLINE
#endif
namespace node {
class Environment;
template <typename T>
inline std::string ToString(const T& value);
template <typename T>
inline auto ToStringOrStringView(const T& value);
// C++-style variant of sprintf()/fprintf() that:
// - Returns an std::string
// - Handles \0 bytes correctly
// - Supports %p and %s. %d, %i and %u are aliases for %s.
// - Accepts any class that has a ToString() method for stringification.
template <typename... Args>
inline std::string SPrintF(std::string_view format, Args&&... args);
template <typename... Args>
inline void FPrintF(FILE* file, std::string_view format, Args&&... args);
void NODE_EXTERN_PRIVATE FWrite(FILE* file, const std::string& str);
// Listing the AsyncWrap provider types first enables us to cast directly
// from a provider type to a debug category.
#define DEBUG_CATEGORY_NAMES(V) \
NODE_ASYNC_PROVIDER_TYPES(V) \
V(BOOTSTRAP) \
V(CRYPTO) \
V(COMPILE_CACHE) \
V(CONTEXTIFY) \
V(DIAGNOSTICS) \
V(INSPECTOR_SERVER) \
V(INSPECTOR_CLIENT) \
V(INSPECTOR_PROFILER) \
V(CODE_CACHE) \
V(NGTCP2) \
V(NGHTTP3) \
V(SEA) \
V(WASI) \
V(MODULE) \
V(MKSNAPSHOT) \
V(SNAPSHOT_SERDES) \
V(PERFETTO) \
V(PERMISSION_MODEL) \
V(PLATFORM_MINIMAL) \
V(PLATFORM_VERBOSE) \
V(QUIC)
enum class DebugCategory : unsigned int {
#define V(name) name,
DEBUG_CATEGORY_NAMES(V)
#undef V
};
#define V(name) +1
constexpr unsigned int kDebugCategoryCount = DEBUG_CATEGORY_NAMES(V);
#undef V
class NODE_EXTERN_PRIVATE EnabledDebugList {
public:
bool FORCE_INLINE enabled(DebugCategory category) const {
DCHECK_LT(static_cast<unsigned int>(category), kDebugCategoryCount);
return enabled_[static_cast<unsigned int>(category)];
}
// Uses NODE_DEBUG_NATIVE to initialize the categories. env->env_vars()
// is parsed if it is not a nullptr, otherwise the system environment
// variables are parsed.
void Parse(Environment* env);
private:
// Enable all categories matching cats.
void Parse(const std::string& cats);
void set_enabled(DebugCategory category) {
DCHECK_LT(static_cast<unsigned int>(category), kDebugCategoryCount);
enabled_[static_cast<int>(category)] = true;
}
bool enabled_[kDebugCategoryCount] = {false};
};
template <typename... Args>
inline void FORCE_INLINE Debug(EnabledDebugList* list,
DebugCategory cat,
const char* format,
Args&&... args);
inline void FORCE_INLINE Debug(EnabledDebugList* list,
DebugCategory cat,
const char* message);
template <typename... Args>
inline void FORCE_INLINE
Debug(Environment* env, DebugCategory cat, const char* format, Args&&... args);
inline void FORCE_INLINE Debug(Environment* env,
DebugCategory cat,
const char* message);
template <typename... Args>
inline void Debug(Environment* env,
DebugCategory cat,
const std::string& format,
Args&&... args);
// Used internally by the 'real' Debug(AsyncWrap*, ...) functions below, so that
// the FORCE_INLINE flag on them doesn't apply to the contents of this function
// as well.
// We apply COLD_NOINLINE to tell the compiler that it's not worth optimizing
// this function for speed and it should rather focus on keeping it out of
// hot code paths. In particular, we want to keep the string concatenating code
// out of the function containing the original `Debug()` call.
template <typename... Args>
void COLD_NOINLINE UnconditionalAsyncWrapDebug(AsyncWrap* async_wrap,
const char* format,
Args&&... args);
template <typename... Args>
inline void FORCE_INLINE Debug(AsyncWrap* async_wrap,
const char* format,
Args&&... args);
template <typename... Args>
inline void FORCE_INLINE Debug(AsyncWrap* async_wrap,
const std::string& format,
Args&&... args);
// Debug helper for inspecting the currently running `node` executable.
class NativeSymbolDebuggingContext {
public:
static std::unique_ptr<NativeSymbolDebuggingContext> New();
class SymbolInfo {
public:
std::string name;
std::string filename;
size_t line = 0;
size_t dis = 0;
std::string Display() const;
};
NativeSymbolDebuggingContext() = default;
virtual ~NativeSymbolDebuggingContext() = default;
virtual SymbolInfo LookupSymbol(void* address) { return {}; }
virtual bool IsMapped(void* address) { return false; }
virtual int GetStackTrace(void** frames, int count) { return 0; }
NativeSymbolDebuggingContext(const NativeSymbolDebuggingContext&) = delete;
NativeSymbolDebuggingContext(NativeSymbolDebuggingContext&&) = delete;
NativeSymbolDebuggingContext operator=(NativeSymbolDebuggingContext&)
= delete;
NativeSymbolDebuggingContext operator=(NativeSymbolDebuggingContext&&)
= delete;
static std::vector<std::string> GetLoadedLibraries();
};
// Variant of `uv_loop_close` that tries to be as helpful as possible
// about giving information on currently existing handles, if there are any,
// but still aborts the process.
void CheckedUvLoopClose(uv_loop_t* loop);
void PrintLibuvHandleInformation(uv_loop_t* loop, FILE* stream);
namespace per_process {
extern NODE_EXTERN_PRIVATE EnabledDebugList enabled_debug_list;
template <typename... Args>
inline void FORCE_INLINE Debug(DebugCategory cat,
const char* format,
Args&&... args);
inline void FORCE_INLINE Debug(DebugCategory cat, const char* message);
} // namespace per_process
} // namespace node
#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
#endif // SRC_DEBUG_UTILS_H_