-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathStackOverflowRule.cpp
More file actions
371 lines (308 loc) · 8.92 KB
/
Copy pathStackOverflowRule.cpp
File metadata and controls
371 lines (308 loc) · 8.92 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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
/**
*
* @file StackOverflowRule.cpp
* @author Gaspard Kirira
*
* Copyright 2025, Gaspard Kirira. All rights reserved.
* https://github.com/vixcpp/vix
* Use of this source code is governed by a MIT license
* that can be found in the License file.
*
* Vix.cpp
*
*/
#include <vix/cli/errors/runtime/IRuntimeErrorRule.hpp>
#include <vix/cli/errors/runtime/RuntimeRuleUtils.hpp>
#include <cctype>
#include <cstdlib>
#include <filesystem>
#include <iostream>
#include <memory>
#include <string>
#include <vector>
#include <vix/cli/Style.hpp>
using namespace vix::cli::style;
namespace vix::cli::errors::runtime
{
namespace
{
enum class StackOverflowKind
{
RecursiveCallChain,
LargeStackAllocation,
AddressSanitizerStackOverflow,
GenericStackOverflow,
};
std::string trim_copy(const std::string &value)
{
std::size_t begin = 0;
while (begin < value.size() &&
std::isspace(
static_cast<unsigned char>(value[begin])) != 0)
{
++begin;
}
std::size_t end = value.size();
while (end > begin &&
std::isspace(
static_cast<unsigned char>(value[end - 1])) != 0)
{
--end;
}
return value.substr(begin, end - begin);
}
std::string lowercase_copy(std::string value)
{
for (char &character : value)
{
character = static_cast<char>(
std::tolower(
static_cast<unsigned char>(character)));
}
return value;
}
bool technical_details_enabled()
{
const char *level = std::getenv("VIX_LOG_LEVEL");
if (level == nullptr || *level == '\0')
return false;
const std::string value =
lowercase_copy(trim_copy(level));
return value == "debug" ||
value == "trace";
}
StackOverflowKind classify_issue(
const std::string &log)
{
if (icontains(log, "infinite recursion") ||
icontains(log, "recursive call") ||
icontains(log, "recursion depth") ||
icontains(log, "deep recursion"))
{
return StackOverflowKind::RecursiveCallChain;
}
if (icontains(log, "large stack frame") ||
icontains(log, "stack allocation") ||
icontains(log, "stack object") ||
icontains(log, "alloca"))
{
return StackOverflowKind::LargeStackAllocation;
}
if (icontains(log, "AddressSanitizer") &&
(icontains(log, "stack-overflow") ||
icontains(log, "stack overflow")))
{
return StackOverflowKind::
AddressSanitizerStackOverflow;
}
return StackOverflowKind::GenericStackOverflow;
}
std::string choose_message(
const std::string &log)
{
switch (classify_issue(log))
{
case StackOverflowKind::RecursiveCallChain:
return "stack exhausted by recursive calls";
case StackOverflowKind::LargeStackAllocation:
return "stack exhausted by a large local allocation";
case StackOverflowKind::AddressSanitizerStackOverflow:
case StackOverflowKind::GenericStackOverflow:
default:
return "stack overflow";
}
}
std::string choose_description(
const std::string &log)
{
switch (classify_issue(log))
{
case StackOverflowKind::RecursiveCallChain:
return "The call stack kept growing because a recursive call chain did not stop soon enough.";
case StackOverflowKind::LargeStackAllocation:
return "A local object required more stack memory than the current thread could provide.";
case StackOverflowKind::AddressSanitizerStackOverflow:
case StackOverflowKind::GenericStackOverflow:
default:
return "The current thread exhausted its available stack memory.";
}
}
std::string choose_hint(
const std::string &log)
{
switch (classify_issue(log))
{
case StackOverflowKind::RecursiveCallChain:
return "check the recursion base case and make sure every recursive call moves toward it";
case StackOverflowKind::LargeStackAllocation:
return "move large buffers or containers to the heap and reduce large local object sizes";
case StackOverflowKind::AddressSanitizerStackOverflow:
case StackOverflowKind::GenericStackOverflow:
default:
return "reduce recursion depth or move large local objects to the heap";
}
}
std::string choose_secondary_hint(
const std::string &log)
{
switch (classify_issue(log))
{
case StackOverflowKind::RecursiveCallChain:
return "consider replacing deep recursion with an iterative algorithm";
case StackOverflowKind::AddressSanitizerStackOverflow:
return "run with VIX_LOG_LEVEL=debug to inspect the repeated call frames";
case StackOverflowKind::LargeStackAllocation:
case StackOverflowKind::GenericStackOverflow:
default:
return {};
}
}
bool may_use_source_hint(
StackOverflowKind kind)
{
/*
* A recursion location cannot be found reliably by scanning
* for return statements or ordinary function calls.
*
* Source fallback is therefore allowed only for explicit
* stack-allocation operations.
*/
return kind ==
StackOverflowKind::LargeStackAllocation;
}
std::vector<std::string>
source_patterns_for_large_stack_allocation()
{
return {
"alloca(",
"std::array<",
};
}
bool looks_like_stack_overflow_log(
const std::string &log)
{
return icontains(log, "stack-overflow") ||
icontains(log, "stack overflow") ||
icontains(log, "stack exhausted");
}
void print_error(
const std::string &message,
const std::string &description)
{
std::cerr << RED
<< "runtime error: "
<< message
<< RESET
<< "\n";
if (!description.empty())
{
std::cerr << " "
<< description
<< "\n";
}
}
void print_hints_and_location(
const std::string &hint,
const std::string &secondaryHint,
const RuntimeLocation &location)
{
std::vector<std::string> hints;
if (!hint.empty())
hints.push_back(hint);
if (!secondaryHint.empty())
hints.push_back(secondaryHint);
const std::string at =
location.valid()
? make_at_text(
location,
std::filesystem::path{})
: std::string{};
if (hints.empty() && at.empty())
return;
std::cerr << "\n";
print_runtime_hints_and_at(
hints,
at);
}
void print_debug_details(
const std::string &log)
{
if (!technical_details_enabled())
return;
std::cerr << "\n"
<< GRAY
<< "technical details:"
<< RESET
<< "\n";
print_runtime_log_excerpt(
log,
24);
}
} // namespace
class StackOverflowRule final
: public IRuntimeErrorRule
{
public:
bool match(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
(void)sourceFile;
return looks_like_stack_overflow_log(log);
}
bool handle(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
const StackOverflowKind kind =
classify_issue(log);
const std::string message =
choose_message(log);
const std::string description =
choose_description(log);
const std::string hint =
choose_hint(log);
const std::string secondaryHint =
choose_secondary_hint(log);
RuntimeLocation location =
find_best_runtime_location(
log,
sourceFile);
if (!location.valid() &&
may_use_source_hint(kind))
{
location =
find_best_runtime_location_or_source_hint(
log,
sourceFile,
source_patterns_for_large_stack_allocation());
}
print_error(
message,
description);
if (location.valid())
{
std::cerr << "\n";
const auto error =
make_runtime_location(
location.file,
location.line,
location.column,
message);
print_runtime_codeframe(error);
}
print_hints_and_location(
hint,
secondaryHint,
location);
print_debug_details(log);
return true;
}
};
std::unique_ptr<IRuntimeErrorRule>
makeStackOverflowRule()
{
return std::make_unique<
StackOverflowRule>();
}
} // namespace vix::cli::errors::runtime