-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathThreadCreationFailureRule.cpp
More file actions
248 lines (209 loc) · 7.11 KB
/
Copy pathThreadCreationFailureRule.cpp
File metadata and controls
248 lines (209 loc) · 7.11 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
/**
*
* @file ThreadCreationFailureRule.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 <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 ThreadCreationFailureKind
{
ResourceLimitReached,
PthreadCreateFailed,
OutOfMemory,
StackSizeFailure,
TooManyThreads,
SystemErrorThreadFailure,
GenericThreadCreationFailure,
};
ThreadCreationFailureKind classify_issue(const std::string &log)
{
if (icontains(log, "resource temporarily unavailable") ||
icontains(log, "eagain") ||
icontains(log, "temporarily unavailable"))
{
return ThreadCreationFailureKind::ResourceLimitReached;
}
if (icontains(log, "pthread_create"))
{
return ThreadCreationFailureKind::PthreadCreateFailed;
}
if (icontains(log, "cannot allocate memory") ||
icontains(log, "out of memory") ||
icontains(log, "bad_alloc") ||
icontains(log, "enomem"))
{
return ThreadCreationFailureKind::OutOfMemory;
}
if (icontains(log, "stack size") ||
icontains(log, "thread stack") ||
icontains(log, "pthread_attr_setstacksize"))
{
return ThreadCreationFailureKind::StackSizeFailure;
}
if (icontains(log, "too many threads") ||
icontains(log, "thread limit") ||
icontains(log, "max user processes") ||
icontains(log, "ulimit"))
{
return ThreadCreationFailureKind::TooManyThreads;
}
if (icontains(log, "std::system_error") &&
(icontains(log, "thread") ||
icontains(log, "create")))
{
return ThreadCreationFailureKind::SystemErrorThreadFailure;
}
return ThreadCreationFailureKind::GenericThreadCreationFailure;
}
std::string choose_message(const std::string &log)
{
switch (classify_issue(log))
{
case ThreadCreationFailureKind::ResourceLimitReached:
return "thread resource limit reached";
case ThreadCreationFailureKind::PthreadCreateFailed:
return "pthread_create failed";
case ThreadCreationFailureKind::OutOfMemory:
return "not enough memory to create thread";
case ThreadCreationFailureKind::StackSizeFailure:
return "invalid or excessive thread stack size";
case ThreadCreationFailureKind::TooManyThreads:
return "too many threads created";
case ThreadCreationFailureKind::SystemErrorThreadFailure:
return "std::thread creation failed";
case ThreadCreationFailureKind::GenericThreadCreationFailure:
default:
return "thread creation failed";
}
}
std::string choose_hint(const std::string &log)
{
switch (classify_issue(log))
{
case ThreadCreationFailureKind::ResourceLimitReached:
return "reduce the number of concurrent threads or use a bounded thread pool";
case ThreadCreationFailureKind::PthreadCreateFailed:
return "check thread limits, available memory, stack size, and thread count";
case ThreadCreationFailureKind::OutOfMemory:
return "reduce thread count or memory usage; each thread needs stack memory";
case ThreadCreationFailureKind::StackSizeFailure:
return "use a smaller valid thread stack size or avoid custom pthread stack configuration";
case ThreadCreationFailureKind::TooManyThreads:
return "avoid creating one thread per task; use a thread pool or async queue";
case ThreadCreationFailureKind::SystemErrorThreadFailure:
return "std::thread could not start; check system limits and excessive thread creation";
case ThreadCreationFailureKind::GenericThreadCreationFailure:
default:
return "check system thread limits, available memory, and excessive thread creation";
}
}
std::vector<std::string> source_patterns_for_thread_creation()
{
return {
"std::thread",
"std::jthread",
"thread(",
"jthread(",
".detach(",
".detach()",
".join(",
".join()",
"pthread_create",
"emplace_back(",
"push_back(",
"std::async",
"async(",
"RuntimeExecutor",
"ThreadPool",
"threadpool",
};
}
bool looks_like_thread_creation_failure_log(const std::string &log)
{
const bool systemThreadFailure =
icontains(log, "std::system_error") &&
(icontains(log, "thread") ||
icontains(log, "resource temporarily unavailable") ||
icontains(log, "operation not permitted"));
return systemThreadFailure ||
icontains(log, "resource temporarily unavailable") ||
icontains(log, "thread constructor failed") ||
icontains(log, "failed to create thread") ||
icontains(log, "pthread_create") ||
icontains(log, "too many threads") ||
icontains(log, "thread resource limit") ||
icontains(log, "thread limit reached");
}
} // namespace
class ThreadCreationFailureRule final : public IRuntimeErrorRule
{
public:
bool match(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
(void)sourceFile;
return looks_like_thread_creation_failure_log(log);
}
bool handle(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
const std::string message = choose_message(log);
RuntimeLocation location =
find_best_runtime_location(log, sourceFile);
if (!location.valid())
{
location =
find_best_runtime_location_or_source_hint(
log,
sourceFile,
source_patterns_for_thread_creation());
}
std::cerr << RED
<< "runtime error: "
<< message
<< RESET << "\n";
if (location.valid())
{
const auto err = make_runtime_location(
location.file,
location.line,
location.column,
message);
print_runtime_codeframe(err);
}
print_runtime_hints_and_at(
{
choose_hint(log),
"do not ignore the runtime log: thread creation failures often include the OS error that explains the limit",
},
make_at_text(location, sourceFile));
print_runtime_log_excerpt(log, 20);
return true;
}
};
std::unique_ptr<IRuntimeErrorRule> makeThreadCreationFailureRule()
{
return std::make_unique<ThreadCreationFailureRule>();
}
} // namespace vix::cli::errors::runtime