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
|
//===---- CheckerHelpers.cpp - Helper functions for checkers ----*- C++ -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This file defines several static functions for use in checkers.
//
//===----------------------------------------------------------------------===//
#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerHelpers.h"
#include "clang/AST/Decl.h"
#include "clang/AST/Expr.h"
#include "clang/Lex/Preprocessor.h"
#include <optional>
namespace clang {
namespace ento {
// Recursively find any substatements containing macros
bool containsMacro(const Stmt *S) {
if (S->getBeginLoc().isMacroID())
return true;
if (S->getEndLoc().isMacroID())
return true;
for (const Stmt *Child : S->children())
if (Child && containsMacro(Child))
return true;
return false;
}
// Recursively find any substatements containing enum constants
bool containsEnum(const Stmt *S) {
const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(S);
if (DR && isa<EnumConstantDecl>(DR->getDecl()))
return true;
for (const Stmt *Child : S->children())
if (Child && containsEnum(Child))
return true;
return false;
}
// Recursively find any substatements containing static vars
bool containsStaticLocal(const Stmt *S) {
const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(S);
if (DR)
if (const VarDecl *VD = dyn_cast<VarDecl>(DR->getDecl()))
if (VD->isStaticLocal())
return true;
for (const Stmt *Child : S->children())
if (Child && containsStaticLocal(Child))
return true;
return false;
}
// Recursively find any substatements containing __builtin_offsetof
bool containsBuiltinOffsetOf(const Stmt *S) {
if (isa<OffsetOfExpr>(S))
return true;
for (const Stmt *Child : S->children())
if (Child && containsBuiltinOffsetOf(Child))
return true;
return false;
}
// Extract lhs and rhs from assignment statement
std::pair<const clang::VarDecl *, const clang::Expr *>
parseAssignment(const Stmt *S) {
const VarDecl *VD = nullptr;
const Expr *RHS = nullptr;
if (auto Assign = dyn_cast_or_null<BinaryOperator>(S)) {
if (Assign->isAssignmentOp()) {
// Ordinary assignment
RHS = Assign->getRHS();
if (auto DE = dyn_cast_or_null<DeclRefExpr>(Assign->getLHS()))
VD = dyn_cast_or_null<VarDecl>(DE->getDecl());
}
} else if (auto PD = dyn_cast_or_null<DeclStmt>(S)) {
// Initialization
assert(PD->isSingleDecl() && "We process decls one by one");
VD = cast<VarDecl>(PD->getSingleDecl());
RHS = VD->getAnyInitializer();
}
return std::make_pair(VD, RHS);
}
Nullability getNullabilityAnnotation(QualType Type) {
const auto *AttrType = Type->getAs<AttributedType>();
if (!AttrType)
return Nullability::Unspecified;
if (AttrType->getAttrKind() == attr::TypeNullable)
return Nullability::Nullable;
else if (AttrType->getAttrKind() == attr::TypeNonNull)
return Nullability::Nonnull;
return Nullability::Unspecified;
}
std::optional<int> tryExpandAsInteger(StringRef Macro, const Preprocessor &PP) {
const auto *MacroII = PP.getIdentifierInfo(Macro);
if (!MacroII)
return std::nullopt;
const MacroInfo *MI = PP.getMacroInfo(MacroII);
if (!MI)
return std::nullopt;
// Filter out parens.
std::vector<Token> FilteredTokens;
FilteredTokens.reserve(MI->tokens().size());
for (auto &T : MI->tokens())
if (!T.isOneOf(tok::l_paren, tok::r_paren))
FilteredTokens.push_back(T);
// Parse an integer at the end of the macro definition.
const Token &T = FilteredTokens.back();
// FIXME: EOF macro token coming from a PCH file on macOS while marked as
// literal, doesn't contain any literal data
if (!T.isLiteral() || !T.getLiteralData())
return std::nullopt;
StringRef ValueStr = StringRef(T.getLiteralData(), T.getLength());
llvm::APInt IntValue;
constexpr unsigned AutoSenseRadix = 0;
if (ValueStr.getAsInteger(AutoSenseRadix, IntValue))
return std::nullopt;
// Parse an optional minus sign.
size_t Size = FilteredTokens.size();
if (Size >= 2) {
if (FilteredTokens[Size - 2].is(tok::minus))
IntValue = -IntValue;
}
return IntValue.getSExtValue();
}
OperatorKind operationKindFromOverloadedOperator(OverloadedOperatorKind OOK,
bool IsBinary) {
llvm::StringMap<BinaryOperatorKind> BinOps{
#define BINARY_OPERATION(Name, Spelling) {Spelling, BO_##Name},
#include "clang/AST/OperationKinds.def"
};
llvm::StringMap<UnaryOperatorKind> UnOps{
#define UNARY_OPERATION(Name, Spelling) {Spelling, UO_##Name},
#include "clang/AST/OperationKinds.def"
};
switch (OOK) {
#define OVERLOADED_OPERATOR(Name, Spelling, Token, Unary, Binary, MemberOnly) \
case OO_##Name: \
if (IsBinary) { \
auto BinOpIt = BinOps.find(Spelling); \
if (BinOpIt != BinOps.end()) \
return OperatorKind(BinOpIt->second); \
else \
llvm_unreachable("operator was expected to be binary but is not"); \
} else { \
auto UnOpIt = UnOps.find(Spelling); \
if (UnOpIt != UnOps.end()) \
return OperatorKind(UnOpIt->second); \
else \
llvm_unreachable("operator was expected to be unary but is not"); \
} \
break;
#include "clang/Basic/OperatorKinds.def"
default:
llvm_unreachable("unexpected operator kind");
}
}
} // namespace ento
} // namespace clang
|
