-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathIntegerOverflowRule.cpp
More file actions
180 lines (152 loc) · 4.31 KB
/
Copy pathIntegerOverflowRule.cpp
File metadata and controls
180 lines (152 loc) · 4.31 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
/**
*
* @file IntegerOverflowRule.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 IntegerOverflowKind
{
SignedIntegerOverflow,
UnsignedIntegerOverflow,
InvalidShift,
UnsignedOffset,
GenericOverflow,
};
IntegerOverflowKind classify_issue(const std::string &log)
{
if (icontains(log, "signed integer overflow"))
return IntegerOverflowKind::SignedIntegerOverflow;
if (icontains(log, "unsigned integer overflow"))
return IntegerOverflowKind::UnsignedIntegerOverflow;
if (icontains(log, "shift exponent") ||
icontains(log, "shift out of bounds"))
{
return IntegerOverflowKind::InvalidShift;
}
if (icontains(log, "addition of unsigned offset"))
return IntegerOverflowKind::UnsignedOffset;
return IntegerOverflowKind::GenericOverflow;
}
std::string choose_message(const std::string &log)
{
switch (classify_issue(log))
{
case IntegerOverflowKind::SignedIntegerOverflow:
return "signed integer overflow";
case IntegerOverflowKind::InvalidShift:
return "invalid shift";
case IntegerOverflowKind::UnsignedIntegerOverflow:
case IntegerOverflowKind::UnsignedOffset:
case IntegerOverflowKind::GenericOverflow:
default:
return "integer overflow";
}
}
std::string choose_hint(const std::string &log)
{
(void)log;
return "use wider integer types or check bounds before arithmetic";
}
std::vector<std::string> source_patterns_for_integer_overflow()
{
return {
"+=",
"-=",
"*=",
"<<",
">>",
"std::int64_t",
"std::size_t",
"+",
"-",
"*",
};
}
bool looks_like_integer_overflow_log(const std::string &log)
{
if (icontains(log, "signed integer overflow") ||
icontains(log, "unsigned integer overflow") ||
icontains(log, "integer overflow"))
{
return true;
}
if (icontains(log, "addition of unsigned offset") ||
icontains(log, "shift exponent") ||
icontains(log, "shift out of bounds"))
{
return true;
}
return false;
}
} // namespace
class IntegerOverflowRule final : public IRuntimeErrorRule
{
public:
bool match(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
(void)sourceFile;
return looks_like_integer_overflow_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_integer_overflow());
}
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),
"signed overflow is undefined behavior; validate inputs from untrusted sources",
},
make_at_text(location, sourceFile));
print_runtime_log_excerpt(log, 20);
return true;
}
};
std::unique_ptr<IRuntimeErrorRule> makeIntegerOverflowRule()
{
return std::make_unique<IntegerOverflowRule>();
}
} // namespace vix::cli::errors::runtime