-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathInvalidFreeRule.cpp
More file actions
194 lines (165 loc) · 4.95 KB
/
Copy pathInvalidFreeRule.cpp
File metadata and controls
194 lines (165 loc) · 4.95 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
/**
*
* @file InvalidFreeRule.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 InvalidFreeKind
{
AllocDeallocMismatch,
AsanBadFree,
LibcInvalidPointer,
LibcMunmapInvalid,
GenericInvalidFree,
};
InvalidFreeKind classify_issue(const std::string &log)
{
if (icontains(log, "alloc-dealloc-mismatch") ||
icontains(log, "new-delete-type-mismatch") ||
(icontains(log, "mismatch") &&
((icontains(log, "new[]") && icontains(log, "delete")) ||
(icontains(log, "malloc") && icontains(log, "delete")) ||
(icontains(log, "operator new") && icontains(log, "free")))))
{
return InvalidFreeKind::AllocDeallocMismatch;
}
if (icontains(log, "AddressSanitizer") &&
(icontains(log, "bad-free") ||
icontains(log, "attempting free") ||
icontains(log, "not malloc()-ed")))
{
return InvalidFreeKind::AsanBadFree;
}
if (icontains(log, "munmap_chunk(): invalid pointer"))
return InvalidFreeKind::LibcMunmapInvalid;
if (icontains(log, "free(): invalid pointer"))
return InvalidFreeKind::LibcInvalidPointer;
return InvalidFreeKind::GenericInvalidFree;
}
std::string choose_message(const std::string &log)
{
if (classify_issue(log) == InvalidFreeKind::AllocDeallocMismatch)
return "alloc/dealloc mismatch";
return "invalid free";
}
std::string choose_hint(const std::string &log)
{
switch (classify_issue(log))
{
case InvalidFreeKind::AllocDeallocMismatch:
return "free memory with its matching API: new/delete, new[]/delete[], or malloc/free";
case InvalidFreeKind::AsanBadFree:
case InvalidFreeKind::LibcInvalidPointer:
case InvalidFreeKind::LibcMunmapInvalid:
case InvalidFreeKind::GenericInvalidFree:
default:
return "only free memory allocated by the matching allocation API";
}
}
std::vector<std::string> source_patterns_for_invalid_free()
{
return {
"delete[]",
"delete",
"free(",
"malloc(",
"new[]",
"new ",
"std::vector",
"std::string",
};
}
bool looks_like_invalid_free_log(const std::string &log)
{
if (icontains(log, "alloc-dealloc-mismatch") ||
icontains(log, "new-delete-type-mismatch"))
{
return true;
}
if (icontains(log, "free(): invalid pointer") ||
icontains(log, "munmap_chunk(): invalid pointer") ||
icontains(log, "bad-free"))
{
return true;
}
if (icontains(log, "AddressSanitizer") &&
(icontains(log, "attempting free") ||
icontains(log, "not malloc()-ed")))
{
return true;
}
// "invalid pointer" alone is too generic without one of the above signals
return false;
}
} // namespace
class InvalidFreeRule final : public IRuntimeErrorRule
{
public:
bool match(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
(void)sourceFile;
return looks_like_invalid_free_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_invalid_free());
}
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 free stack memory, string literals, or memory owned by containers",
},
make_at_text(location, sourceFile));
print_runtime_log_excerpt(log, 20);
return true;
}
};
std::unique_ptr<IRuntimeErrorRule> makeInvalidFreeRule()
{
return std::make_unique<InvalidFreeRule>();
}
} // namespace vix::cli::errors::runtime