-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathMisalignedAccessRule.cpp
More file actions
125 lines (107 loc) · 3.01 KB
/
Copy pathMisalignedAccessRule.cpp
File metadata and controls
125 lines (107 loc) · 3.01 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
/**
*
* @file MisalignedAccessRule.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
{
std::string choose_message(const std::string &log)
{
(void)log;
return "misaligned memory access";
}
std::string choose_hint(const std::string &log)
{
(void)log;
return "check casts, packed structs, alignment requirements, and pointer reinterpretation";
}
std::vector<std::string> source_patterns_for_misaligned()
{
return {
"reinterpret_cast",
"static_cast",
"alignas",
"std::bit_cast",
"std::span",
"std::byte",
"char*",
};
}
bool looks_like_misaligned_log(const std::string &log)
{
return icontains(log, "misaligned address") ||
icontains(log, "load of misaligned address") ||
icontains(log, "store to misaligned address") ||
icontains(log, "reference binding to misaligned address");
}
} // namespace
class MisalignedAccessRule final : public IRuntimeErrorRule
{
public:
bool match(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
(void)sourceFile;
return looks_like_misaligned_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_misaligned());
}
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),
"prefer std::memcpy for type punning instead of reinterpret_cast on misaligned buffers",
},
make_at_text(location, sourceFile));
print_runtime_log_excerpt(log, 20);
return true;
}
};
std::unique_ptr<IRuntimeErrorRule> makeMisalignedAccessRule()
{
return std::make_unique<MisalignedAccessRule>();
}
} // namespace vix::cli::errors::runtime