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
|
//===- MemRegionDescriptiveNameTest.cpp -----------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "CheckerRegistration.h"
#include "clang/StaticAnalyzer/Core/Checker.h"
#include "clang/StaticAnalyzer/Core/PathSensitive/CallDescription.h"
#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
#include "clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h"
#include "gtest/gtest.h"
#include <fstream>
using namespace clang;
using namespace ento;
namespace {
class DescriptiveNameChecker : public Checker<check::PreCall> {
public:
void checkPreCall(const CallEvent &Call, CheckerContext &C) const {
if (!HandlerFn.matches(Call))
return;
const MemRegion *ArgReg = Call.getArgSVal(0).getAsRegion();
assert(ArgReg && "expecting a location as the first argument");
auto DescriptiveName = ArgReg->getDescriptiveName(/*UseQuotes=*/false);
if (ExplodedNode *Node = C.generateNonFatalErrorNode(C.getState())) {
auto Report =
std::make_unique<PathSensitiveBugReport>(Bug, DescriptiveName, Node);
C.emitReport(std::move(Report));
}
}
private:
const BugType Bug{this, "DescriptiveNameBug"};
const CallDescription HandlerFn = {
CDM::SimpleFunc, {"reportDescriptiveName"}, 1};
};
void addDescriptiveNameChecker(AnalysisASTConsumer &AnalysisConsumer,
AnalyzerOptions &AnOpts) {
AnOpts.CheckersAndPackages = {{"DescriptiveNameChecker", true}};
AnalysisConsumer.AddCheckerRegistrationFn([](CheckerRegistry &Registry) {
Registry.addChecker<DescriptiveNameChecker>("DescriptiveNameChecker",
"Desc", "DocsURI");
});
}
bool runChecker(StringRef Code, std::string &Output) {
return runCheckerOnCode<addDescriptiveNameChecker>(Code.str(), Output,
/*OnlyEmitWarnings=*/true);
}
TEST(MemRegionDescriptiveNameTest, ConcreteIntElementRegionIndex) {
StringRef Code = R"cpp(
void reportDescriptiveName(int *p);
const unsigned int index = 1;
extern int array[3];
void top() {
reportDescriptiveName(&array[index]);
})cpp";
std::string Output;
ASSERT_TRUE(runChecker(Code, Output));
EXPECT_EQ(Output, "DescriptiveNameChecker: array[1]\n");
}
TEST(MemRegionDescriptiveNameTest, SymbolicElementRegionIndex) {
StringRef Code = R"cpp(
void reportDescriptiveName(int *p);
extern unsigned int index;
extern int array[3];
void top() {
reportDescriptiveName(&array[index]);
})cpp";
std::string Output;
ASSERT_TRUE(runChecker(Code, Output));
EXPECT_EQ(Output, "DescriptiveNameChecker: array[index]\n");
}
TEST(MemRegionDescriptiveNameTest, SymbolicElementRegionIndexSymbolValFails) {
StringRef Code = R"cpp(
void reportDescriptiveName(int *p);
extern int* ptr;
extern int array[3];
void top() {
reportDescriptiveName(&array[(long long)ptr]);
})cpp";
std::string Output;
ASSERT_TRUE(runChecker(Code, Output));
EXPECT_EQ(Output, "DescriptiveNameChecker: \n");
}
TEST(MemRegionDescriptiveNameTest, SymbolicElementRegionIndexOrigRegionFails) {
StringRef Code = R"cpp(
void reportDescriptiveName(int *p);
extern int getInt(void);
extern int array[3];
void top() {
reportDescriptiveName(&array[getInt()]);
})cpp";
std::string Output;
ASSERT_TRUE(runChecker(Code, Output));
EXPECT_EQ(Output, "DescriptiveNameChecker: \n");
}
TEST(MemRegionDescriptiveNameTest, SymbolicElementRegionIndexDescrNameFails) {
StringRef Code = R"cpp(
void reportDescriptiveName(int *p);
extern int *ptr;
extern int array[3];
void top() {
reportDescriptiveName(&array[*ptr]);
})cpp";
std::string Output;
ASSERT_TRUE(runChecker(Code, Output));
EXPECT_EQ(Output, "DescriptiveNameChecker: \n");
}
TEST(MemRegionDescriptiveNameTest,
SymbolicElementRegionIndexIncorrectSymbolName) {
StringRef Code = R"cpp(
void reportDescriptiveName(int *p);
extern int x, y;
extern int array[3];
void top() {
y = x;
reportDescriptiveName(&array[y]);
})cpp";
std::string Output;
ASSERT_TRUE(runChecker(Code, Output));
// FIXME: Should return array[y], but returns array[x] (OriginRegion).
EXPECT_EQ(Output, "DescriptiveNameChecker: array[x]\n");
}
} // namespace
|
