annotate clang/lib/Analysis/ExprMutationAnalyzer.cpp @ 176:de4ac79aef9d

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 17:13:11 +0900
parents 0572611fdcc8
children 2e18cbf3894f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===---------- ExprMutationAnalyzer.cpp ----------------------------------===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8 #include "clang/Analysis/Analyses/ExprMutationAnalyzer.h"
anatofuz
parents:
diff changeset
9 #include "clang/ASTMatchers/ASTMatchFinder.h"
anatofuz
parents:
diff changeset
10 #include "llvm/ADT/STLExtras.h"
anatofuz
parents:
diff changeset
11
anatofuz
parents:
diff changeset
12 namespace clang {
anatofuz
parents:
diff changeset
13 using namespace ast_matchers;
anatofuz
parents:
diff changeset
14
anatofuz
parents:
diff changeset
15 namespace {
anatofuz
parents:
diff changeset
16
anatofuz
parents:
diff changeset
17 AST_MATCHER_P(LambdaExpr, hasCaptureInit, const Expr *, E) {
anatofuz
parents:
diff changeset
18 return llvm::is_contained(Node.capture_inits(), E);
anatofuz
parents:
diff changeset
19 }
anatofuz
parents:
diff changeset
20
anatofuz
parents:
diff changeset
21 AST_MATCHER_P(CXXForRangeStmt, hasRangeStmt,
anatofuz
parents:
diff changeset
22 ast_matchers::internal::Matcher<DeclStmt>, InnerMatcher) {
anatofuz
parents:
diff changeset
23 const DeclStmt *const Range = Node.getRangeStmt();
anatofuz
parents:
diff changeset
24 return InnerMatcher.matches(*Range, Finder, Builder);
anatofuz
parents:
diff changeset
25 }
anatofuz
parents:
diff changeset
26
anatofuz
parents:
diff changeset
27 AST_MATCHER_P(Expr, maybeEvalCommaExpr,
anatofuz
parents:
diff changeset
28 ast_matchers::internal::Matcher<Expr>, InnerMatcher) {
anatofuz
parents:
diff changeset
29 const Expr* Result = &Node;
anatofuz
parents:
diff changeset
30 while (const auto *BOComma =
anatofuz
parents:
diff changeset
31 dyn_cast_or_null<BinaryOperator>(Result->IgnoreParens())) {
anatofuz
parents:
diff changeset
32 if (!BOComma->isCommaOp())
anatofuz
parents:
diff changeset
33 break;
anatofuz
parents:
diff changeset
34 Result = BOComma->getRHS();
anatofuz
parents:
diff changeset
35 }
anatofuz
parents:
diff changeset
36 return InnerMatcher.matches(*Result, Finder, Builder);
anatofuz
parents:
diff changeset
37 }
anatofuz
parents:
diff changeset
38
anatofuz
parents:
diff changeset
39 const ast_matchers::internal::VariadicDynCastAllOfMatcher<Stmt, CXXTypeidExpr>
anatofuz
parents:
diff changeset
40 cxxTypeidExpr;
anatofuz
parents:
diff changeset
41
anatofuz
parents:
diff changeset
42 AST_MATCHER(CXXTypeidExpr, isPotentiallyEvaluated) {
anatofuz
parents:
diff changeset
43 return Node.isPotentiallyEvaluated();
anatofuz
parents:
diff changeset
44 }
anatofuz
parents:
diff changeset
45
anatofuz
parents:
diff changeset
46 const ast_matchers::internal::VariadicDynCastAllOfMatcher<Stmt,
anatofuz
parents:
diff changeset
47 GenericSelectionExpr>
anatofuz
parents:
diff changeset
48 genericSelectionExpr;
anatofuz
parents:
diff changeset
49
anatofuz
parents:
diff changeset
50 AST_MATCHER_P(GenericSelectionExpr, hasControllingExpr,
anatofuz
parents:
diff changeset
51 ast_matchers::internal::Matcher<Expr>, InnerMatcher) {
anatofuz
parents:
diff changeset
52 return InnerMatcher.matches(*Node.getControllingExpr(), Finder, Builder);
anatofuz
parents:
diff changeset
53 }
anatofuz
parents:
diff changeset
54
anatofuz
parents:
diff changeset
55 const auto nonConstReferenceType = [] {
anatofuz
parents:
diff changeset
56 return hasUnqualifiedDesugaredType(
anatofuz
parents:
diff changeset
57 referenceType(pointee(unless(isConstQualified()))));
anatofuz
parents:
diff changeset
58 };
anatofuz
parents:
diff changeset
59
anatofuz
parents:
diff changeset
60 const auto nonConstPointerType = [] {
anatofuz
parents:
diff changeset
61 return hasUnqualifiedDesugaredType(
anatofuz
parents:
diff changeset
62 pointerType(pointee(unless(isConstQualified()))));
anatofuz
parents:
diff changeset
63 };
anatofuz
parents:
diff changeset
64
anatofuz
parents:
diff changeset
65 const auto isMoveOnly = [] {
anatofuz
parents:
diff changeset
66 return cxxRecordDecl(
anatofuz
parents:
diff changeset
67 hasMethod(cxxConstructorDecl(isMoveConstructor(), unless(isDeleted()))),
anatofuz
parents:
diff changeset
68 hasMethod(cxxMethodDecl(isMoveAssignmentOperator(), unless(isDeleted()))),
anatofuz
parents:
diff changeset
69 unless(anyOf(hasMethod(cxxConstructorDecl(isCopyConstructor(),
anatofuz
parents:
diff changeset
70 unless(isDeleted()))),
anatofuz
parents:
diff changeset
71 hasMethod(cxxMethodDecl(isCopyAssignmentOperator(),
anatofuz
parents:
diff changeset
72 unless(isDeleted()))))));
anatofuz
parents:
diff changeset
73 };
anatofuz
parents:
diff changeset
74
anatofuz
parents:
diff changeset
75 template <class T> struct NodeID;
anatofuz
parents:
diff changeset
76 template <> struct NodeID<Expr> { static const std::string value; };
anatofuz
parents:
diff changeset
77 template <> struct NodeID<Decl> { static const std::string value; };
anatofuz
parents:
diff changeset
78 const std::string NodeID<Expr>::value = "expr";
anatofuz
parents:
diff changeset
79 const std::string NodeID<Decl>::value = "decl";
anatofuz
parents:
diff changeset
80
anatofuz
parents:
diff changeset
81 template <class T, class F = const Stmt *(ExprMutationAnalyzer::*)(const T *)>
anatofuz
parents:
diff changeset
82 const Stmt *tryEachMatch(ArrayRef<ast_matchers::BoundNodes> Matches,
anatofuz
parents:
diff changeset
83 ExprMutationAnalyzer *Analyzer, F Finder) {
anatofuz
parents:
diff changeset
84 const StringRef ID = NodeID<T>::value;
anatofuz
parents:
diff changeset
85 for (const auto &Nodes : Matches) {
anatofuz
parents:
diff changeset
86 if (const Stmt *S = (Analyzer->*Finder)(Nodes.getNodeAs<T>(ID)))
anatofuz
parents:
diff changeset
87 return S;
anatofuz
parents:
diff changeset
88 }
anatofuz
parents:
diff changeset
89 return nullptr;
anatofuz
parents:
diff changeset
90 }
anatofuz
parents:
diff changeset
91
anatofuz
parents:
diff changeset
92 } // namespace
anatofuz
parents:
diff changeset
93
anatofuz
parents:
diff changeset
94 const Stmt *ExprMutationAnalyzer::findMutation(const Expr *Exp) {
anatofuz
parents:
diff changeset
95 return findMutationMemoized(Exp,
anatofuz
parents:
diff changeset
96 {&ExprMutationAnalyzer::findDirectMutation,
anatofuz
parents:
diff changeset
97 &ExprMutationAnalyzer::findMemberMutation,
anatofuz
parents:
diff changeset
98 &ExprMutationAnalyzer::findArrayElementMutation,
anatofuz
parents:
diff changeset
99 &ExprMutationAnalyzer::findCastMutation,
anatofuz
parents:
diff changeset
100 &ExprMutationAnalyzer::findRangeLoopMutation,
anatofuz
parents:
diff changeset
101 &ExprMutationAnalyzer::findReferenceMutation,
anatofuz
parents:
diff changeset
102 &ExprMutationAnalyzer::findFunctionArgMutation},
anatofuz
parents:
diff changeset
103 Results);
anatofuz
parents:
diff changeset
104 }
anatofuz
parents:
diff changeset
105
anatofuz
parents:
diff changeset
106 const Stmt *ExprMutationAnalyzer::findMutation(const Decl *Dec) {
anatofuz
parents:
diff changeset
107 return tryEachDeclRef(Dec, &ExprMutationAnalyzer::findMutation);
anatofuz
parents:
diff changeset
108 }
anatofuz
parents:
diff changeset
109
anatofuz
parents:
diff changeset
110 const Stmt *ExprMutationAnalyzer::findPointeeMutation(const Expr *Exp) {
anatofuz
parents:
diff changeset
111 return findMutationMemoized(Exp, {/*TODO*/}, PointeeResults);
anatofuz
parents:
diff changeset
112 }
anatofuz
parents:
diff changeset
113
anatofuz
parents:
diff changeset
114 const Stmt *ExprMutationAnalyzer::findPointeeMutation(const Decl *Dec) {
anatofuz
parents:
diff changeset
115 return tryEachDeclRef(Dec, &ExprMutationAnalyzer::findPointeeMutation);
anatofuz
parents:
diff changeset
116 }
anatofuz
parents:
diff changeset
117
anatofuz
parents:
diff changeset
118 const Stmt *ExprMutationAnalyzer::findMutationMemoized(
anatofuz
parents:
diff changeset
119 const Expr *Exp, llvm::ArrayRef<MutationFinder> Finders,
anatofuz
parents:
diff changeset
120 ResultMap &MemoizedResults) {
anatofuz
parents:
diff changeset
121 const auto Memoized = MemoizedResults.find(Exp);
anatofuz
parents:
diff changeset
122 if (Memoized != MemoizedResults.end())
anatofuz
parents:
diff changeset
123 return Memoized->second;
anatofuz
parents:
diff changeset
124
anatofuz
parents:
diff changeset
125 if (isUnevaluated(Exp))
anatofuz
parents:
diff changeset
126 return MemoizedResults[Exp] = nullptr;
anatofuz
parents:
diff changeset
127
anatofuz
parents:
diff changeset
128 for (const auto &Finder : Finders) {
anatofuz
parents:
diff changeset
129 if (const Stmt *S = (this->*Finder)(Exp))
anatofuz
parents:
diff changeset
130 return MemoizedResults[Exp] = S;
anatofuz
parents:
diff changeset
131 }
anatofuz
parents:
diff changeset
132
anatofuz
parents:
diff changeset
133 return MemoizedResults[Exp] = nullptr;
anatofuz
parents:
diff changeset
134 }
anatofuz
parents:
diff changeset
135
anatofuz
parents:
diff changeset
136 const Stmt *ExprMutationAnalyzer::tryEachDeclRef(const Decl *Dec,
anatofuz
parents:
diff changeset
137 MutationFinder Finder) {
anatofuz
parents:
diff changeset
138 const auto Refs =
anatofuz
parents:
diff changeset
139 match(findAll(declRefExpr(to(equalsNode(Dec))).bind(NodeID<Expr>::value)),
anatofuz
parents:
diff changeset
140 Stm, Context);
anatofuz
parents:
diff changeset
141 for (const auto &RefNodes : Refs) {
anatofuz
parents:
diff changeset
142 const auto *E = RefNodes.getNodeAs<Expr>(NodeID<Expr>::value);
anatofuz
parents:
diff changeset
143 if ((this->*Finder)(E))
anatofuz
parents:
diff changeset
144 return E;
anatofuz
parents:
diff changeset
145 }
anatofuz
parents:
diff changeset
146 return nullptr;
anatofuz
parents:
diff changeset
147 }
anatofuz
parents:
diff changeset
148
anatofuz
parents:
diff changeset
149 bool ExprMutationAnalyzer::isUnevaluated(const Expr *Exp) {
anatofuz
parents:
diff changeset
150 return selectFirst<Expr>(
anatofuz
parents:
diff changeset
151 NodeID<Expr>::value,
anatofuz
parents:
diff changeset
152 match(
anatofuz
parents:
diff changeset
153 findAll(
anatofuz
parents:
diff changeset
154 expr(equalsNode(Exp),
anatofuz
parents:
diff changeset
155 anyOf(
anatofuz
parents:
diff changeset
156 // `Exp` is part of the underlying expression of
anatofuz
parents:
diff changeset
157 // decltype/typeof if it has an ancestor of
anatofuz
parents:
diff changeset
158 // typeLoc.
anatofuz
parents:
diff changeset
159 hasAncestor(typeLoc(unless(
anatofuz
parents:
diff changeset
160 hasAncestor(unaryExprOrTypeTraitExpr())))),
anatofuz
parents:
diff changeset
161 hasAncestor(expr(anyOf(
anatofuz
parents:
diff changeset
162 // `UnaryExprOrTypeTraitExpr` is unevaluated
anatofuz
parents:
diff changeset
163 // unless it's sizeof on VLA.
anatofuz
parents:
diff changeset
164 unaryExprOrTypeTraitExpr(unless(sizeOfExpr(
anatofuz
parents:
diff changeset
165 hasArgumentOfType(variableArrayType())))),
anatofuz
parents:
diff changeset
166 // `CXXTypeidExpr` is unevaluated unless it's
anatofuz
parents:
diff changeset
167 // applied to an expression of glvalue of
anatofuz
parents:
diff changeset
168 // polymorphic class type.
anatofuz
parents:
diff changeset
169 cxxTypeidExpr(
anatofuz
parents:
diff changeset
170 unless(isPotentiallyEvaluated())),
anatofuz
parents:
diff changeset
171 // The controlling expression of
anatofuz
parents:
diff changeset
172 // `GenericSelectionExpr` is unevaluated.
anatofuz
parents:
diff changeset
173 genericSelectionExpr(hasControllingExpr(
anatofuz
parents:
diff changeset
174 hasDescendant(equalsNode(Exp)))),
anatofuz
parents:
diff changeset
175 cxxNoexceptExpr())))))
anatofuz
parents:
diff changeset
176 .bind(NodeID<Expr>::value)),
anatofuz
parents:
diff changeset
177 Stm, Context)) != nullptr;
anatofuz
parents:
diff changeset
178 }
anatofuz
parents:
diff changeset
179
anatofuz
parents:
diff changeset
180 const Stmt *
anatofuz
parents:
diff changeset
181 ExprMutationAnalyzer::findExprMutation(ArrayRef<BoundNodes> Matches) {
anatofuz
parents:
diff changeset
182 return tryEachMatch<Expr>(Matches, this, &ExprMutationAnalyzer::findMutation);
anatofuz
parents:
diff changeset
183 }
anatofuz
parents:
diff changeset
184
anatofuz
parents:
diff changeset
185 const Stmt *
anatofuz
parents:
diff changeset
186 ExprMutationAnalyzer::findDeclMutation(ArrayRef<BoundNodes> Matches) {
anatofuz
parents:
diff changeset
187 return tryEachMatch<Decl>(Matches, this, &ExprMutationAnalyzer::findMutation);
anatofuz
parents:
diff changeset
188 }
anatofuz
parents:
diff changeset
189
anatofuz
parents:
diff changeset
190 const Stmt *ExprMutationAnalyzer::findExprPointeeMutation(
anatofuz
parents:
diff changeset
191 ArrayRef<ast_matchers::BoundNodes> Matches) {
anatofuz
parents:
diff changeset
192 return tryEachMatch<Expr>(Matches, this,
anatofuz
parents:
diff changeset
193 &ExprMutationAnalyzer::findPointeeMutation);
anatofuz
parents:
diff changeset
194 }
anatofuz
parents:
diff changeset
195
anatofuz
parents:
diff changeset
196 const Stmt *ExprMutationAnalyzer::findDeclPointeeMutation(
anatofuz
parents:
diff changeset
197 ArrayRef<ast_matchers::BoundNodes> Matches) {
anatofuz
parents:
diff changeset
198 return tryEachMatch<Decl>(Matches, this,
anatofuz
parents:
diff changeset
199 &ExprMutationAnalyzer::findPointeeMutation);
anatofuz
parents:
diff changeset
200 }
anatofuz
parents:
diff changeset
201
anatofuz
parents:
diff changeset
202 const Stmt *ExprMutationAnalyzer::findDirectMutation(const Expr *Exp) {
anatofuz
parents:
diff changeset
203 // LHS of any assignment operators.
anatofuz
parents:
diff changeset
204 const auto AsAssignmentLhs =
anatofuz
parents:
diff changeset
205 binaryOperator(isAssignmentOperator(),
anatofuz
parents:
diff changeset
206 hasLHS(maybeEvalCommaExpr(equalsNode(Exp))));
anatofuz
parents:
diff changeset
207
anatofuz
parents:
diff changeset
208 // Operand of increment/decrement operators.
anatofuz
parents:
diff changeset
209 const auto AsIncDecOperand =
anatofuz
parents:
diff changeset
210 unaryOperator(anyOf(hasOperatorName("++"), hasOperatorName("--")),
anatofuz
parents:
diff changeset
211 hasUnaryOperand(maybeEvalCommaExpr(equalsNode(Exp))));
anatofuz
parents:
diff changeset
212
anatofuz
parents:
diff changeset
213 // Invoking non-const member function.
anatofuz
parents:
diff changeset
214 // A member function is assumed to be non-const when it is unresolved.
anatofuz
parents:
diff changeset
215 const auto NonConstMethod = cxxMethodDecl(unless(isConst()));
anatofuz
parents:
diff changeset
216 const auto AsNonConstThis =
anatofuz
parents:
diff changeset
217 expr(anyOf(cxxMemberCallExpr(callee(NonConstMethod),
anatofuz
parents:
diff changeset
218 on(maybeEvalCommaExpr(equalsNode(Exp)))),
anatofuz
parents:
diff changeset
219 cxxOperatorCallExpr(callee(NonConstMethod),
anatofuz
parents:
diff changeset
220 hasArgument(0,
anatofuz
parents:
diff changeset
221 maybeEvalCommaExpr(equalsNode(Exp)))),
anatofuz
parents:
diff changeset
222 callExpr(callee(expr(anyOf(
anatofuz
parents:
diff changeset
223 unresolvedMemberExpr(
anatofuz
parents:
diff changeset
224 hasObjectExpression(maybeEvalCommaExpr(equalsNode(Exp)))),
anatofuz
parents:
diff changeset
225 cxxDependentScopeMemberExpr(
anatofuz
parents:
diff changeset
226 hasObjectExpression(maybeEvalCommaExpr(equalsNode(Exp))))))))));
anatofuz
parents:
diff changeset
227
anatofuz
parents:
diff changeset
228 // Taking address of 'Exp'.
anatofuz
parents:
diff changeset
229 // We're assuming 'Exp' is mutated as soon as its address is taken, though in
anatofuz
parents:
diff changeset
230 // theory we can follow the pointer and see whether it escaped `Stm` or is
anatofuz
parents:
diff changeset
231 // dereferenced and then mutated. This is left for future improvements.
anatofuz
parents:
diff changeset
232 const auto AsAmpersandOperand =
anatofuz
parents:
diff changeset
233 unaryOperator(hasOperatorName("&"),
anatofuz
parents:
diff changeset
234 // A NoOp implicit cast is adding const.
anatofuz
parents:
diff changeset
235 unless(hasParent(implicitCastExpr(hasCastKind(CK_NoOp)))),
anatofuz
parents:
diff changeset
236 hasUnaryOperand(maybeEvalCommaExpr(equalsNode(Exp))));
anatofuz
parents:
diff changeset
237 const auto AsPointerFromArrayDecay =
anatofuz
parents:
diff changeset
238 castExpr(hasCastKind(CK_ArrayToPointerDecay),
anatofuz
parents:
diff changeset
239 unless(hasParent(arraySubscriptExpr())),
anatofuz
parents:
diff changeset
240 has(maybeEvalCommaExpr(equalsNode(Exp))));
anatofuz
parents:
diff changeset
241 // Treat calling `operator->()` of move-only classes as taking address.
anatofuz
parents:
diff changeset
242 // These are typically smart pointers with unique ownership so we treat
anatofuz
parents:
diff changeset
243 // mutation of pointee as mutation of the smart pointer itself.
anatofuz
parents:
diff changeset
244 const auto AsOperatorArrowThis =
anatofuz
parents:
diff changeset
245 cxxOperatorCallExpr(hasOverloadedOperatorName("->"),
anatofuz
parents:
diff changeset
246 callee(cxxMethodDecl(ofClass(isMoveOnly()),
anatofuz
parents:
diff changeset
247 returns(nonConstPointerType()))),
anatofuz
parents:
diff changeset
248 argumentCountIs(1),
anatofuz
parents:
diff changeset
249 hasArgument(0, maybeEvalCommaExpr(equalsNode(Exp))));
anatofuz
parents:
diff changeset
250
anatofuz
parents:
diff changeset
251 // Used as non-const-ref argument when calling a function.
anatofuz
parents:
diff changeset
252 // An argument is assumed to be non-const-ref when the function is unresolved.
anatofuz
parents:
diff changeset
253 // Instantiated template functions are not handled here but in
anatofuz
parents:
diff changeset
254 // findFunctionArgMutation which has additional smarts for handling forwarding
anatofuz
parents:
diff changeset
255 // references.
anatofuz
parents:
diff changeset
256 const auto NonConstRefParam = forEachArgumentWithParam(
anatofuz
parents:
diff changeset
257 maybeEvalCommaExpr(equalsNode(Exp)),
anatofuz
parents:
diff changeset
258 parmVarDecl(hasType(nonConstReferenceType())));
anatofuz
parents:
diff changeset
259 const auto NotInstantiated = unless(hasDeclaration(isInstantiated()));
anatofuz
parents:
diff changeset
260 const auto AsNonConstRefArg = anyOf(
anatofuz
parents:
diff changeset
261 callExpr(NonConstRefParam, NotInstantiated),
anatofuz
parents:
diff changeset
262 cxxConstructExpr(NonConstRefParam, NotInstantiated),
anatofuz
parents:
diff changeset
263 callExpr(callee(expr(anyOf(unresolvedLookupExpr(), unresolvedMemberExpr(),
anatofuz
parents:
diff changeset
264 cxxDependentScopeMemberExpr(),
anatofuz
parents:
diff changeset
265 hasType(templateTypeParmType())))),
anatofuz
parents:
diff changeset
266 hasAnyArgument(maybeEvalCommaExpr(equalsNode(Exp)))),
anatofuz
parents:
diff changeset
267 cxxUnresolvedConstructExpr(hasAnyArgument(maybeEvalCommaExpr(equalsNode(Exp)))));
anatofuz
parents:
diff changeset
268
anatofuz
parents:
diff changeset
269 // Captured by a lambda by reference.
anatofuz
parents:
diff changeset
270 // If we're initializing a capture with 'Exp' directly then we're initializing
anatofuz
parents:
diff changeset
271 // a reference capture.
anatofuz
parents:
diff changeset
272 // For value captures there will be an ImplicitCastExpr <LValueToRValue>.
anatofuz
parents:
diff changeset
273 const auto AsLambdaRefCaptureInit = lambdaExpr(hasCaptureInit(Exp));
anatofuz
parents:
diff changeset
274
anatofuz
parents:
diff changeset
275 // Returned as non-const-ref.
anatofuz
parents:
diff changeset
276 // If we're returning 'Exp' directly then it's returned as non-const-ref.
anatofuz
parents:
diff changeset
277 // For returning by value there will be an ImplicitCastExpr <LValueToRValue>.
anatofuz
parents:
diff changeset
278 // For returning by const-ref there will be an ImplicitCastExpr <NoOp> (for
anatofuz
parents:
diff changeset
279 // adding const.)
anatofuz
parents:
diff changeset
280 const auto AsNonConstRefReturn = returnStmt(hasReturnValue(
anatofuz
parents:
diff changeset
281 maybeEvalCommaExpr(equalsNode(Exp))));
anatofuz
parents:
diff changeset
282
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
283 const auto Matches = match(
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
284 traverse(
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
285 ast_type_traits::TK_AsIs,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
286 findAll(stmt(anyOf(AsAssignmentLhs, AsIncDecOperand, AsNonConstThis,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
287 AsAmpersandOperand, AsPointerFromArrayDecay,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
288 AsOperatorArrowThis, AsNonConstRefArg,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
289 AsLambdaRefCaptureInit, AsNonConstRefReturn))
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
290 .bind("stmt"))),
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
291 Stm, Context);
150
anatofuz
parents:
diff changeset
292 return selectFirst<Stmt>("stmt", Matches);
anatofuz
parents:
diff changeset
293 }
anatofuz
parents:
diff changeset
294
anatofuz
parents:
diff changeset
295 const Stmt *ExprMutationAnalyzer::findMemberMutation(const Expr *Exp) {
anatofuz
parents:
diff changeset
296 // Check whether any member of 'Exp' is mutated.
anatofuz
parents:
diff changeset
297 const auto MemberExprs =
anatofuz
parents:
diff changeset
298 match(findAll(expr(anyOf(memberExpr(hasObjectExpression(equalsNode(Exp))),
anatofuz
parents:
diff changeset
299 cxxDependentScopeMemberExpr(
anatofuz
parents:
diff changeset
300 hasObjectExpression(equalsNode(Exp)))))
anatofuz
parents:
diff changeset
301 .bind(NodeID<Expr>::value)),
anatofuz
parents:
diff changeset
302 Stm, Context);
anatofuz
parents:
diff changeset
303 return findExprMutation(MemberExprs);
anatofuz
parents:
diff changeset
304 }
anatofuz
parents:
diff changeset
305
anatofuz
parents:
diff changeset
306 const Stmt *ExprMutationAnalyzer::findArrayElementMutation(const Expr *Exp) {
anatofuz
parents:
diff changeset
307 // Check whether any element of an array is mutated.
anatofuz
parents:
diff changeset
308 const auto SubscriptExprs = match(
anatofuz
parents:
diff changeset
309 findAll(arraySubscriptExpr(hasBase(ignoringImpCasts(equalsNode(Exp))))
anatofuz
parents:
diff changeset
310 .bind(NodeID<Expr>::value)),
anatofuz
parents:
diff changeset
311 Stm, Context);
anatofuz
parents:
diff changeset
312 return findExprMutation(SubscriptExprs);
anatofuz
parents:
diff changeset
313 }
anatofuz
parents:
diff changeset
314
anatofuz
parents:
diff changeset
315 const Stmt *ExprMutationAnalyzer::findCastMutation(const Expr *Exp) {
anatofuz
parents:
diff changeset
316 // If 'Exp' is casted to any non-const reference type, check the castExpr.
anatofuz
parents:
diff changeset
317 const auto Casts =
anatofuz
parents:
diff changeset
318 match(findAll(castExpr(hasSourceExpression(equalsNode(Exp)),
anatofuz
parents:
diff changeset
319 anyOf(explicitCastExpr(hasDestinationType(
anatofuz
parents:
diff changeset
320 nonConstReferenceType())),
anatofuz
parents:
diff changeset
321 implicitCastExpr(hasImplicitDestinationType(
anatofuz
parents:
diff changeset
322 nonConstReferenceType()))))
anatofuz
parents:
diff changeset
323 .bind(NodeID<Expr>::value)),
anatofuz
parents:
diff changeset
324 Stm, Context);
anatofuz
parents:
diff changeset
325 if (const Stmt *S = findExprMutation(Casts))
anatofuz
parents:
diff changeset
326 return S;
anatofuz
parents:
diff changeset
327 // Treat std::{move,forward} as cast.
anatofuz
parents:
diff changeset
328 const auto Calls =
anatofuz
parents:
diff changeset
329 match(findAll(callExpr(callee(namedDecl(
anatofuz
parents:
diff changeset
330 hasAnyName("::std::move", "::std::forward"))),
anatofuz
parents:
diff changeset
331 hasArgument(0, equalsNode(Exp)))
anatofuz
parents:
diff changeset
332 .bind("expr")),
anatofuz
parents:
diff changeset
333 Stm, Context);
anatofuz
parents:
diff changeset
334 return findExprMutation(Calls);
anatofuz
parents:
diff changeset
335 }
anatofuz
parents:
diff changeset
336
anatofuz
parents:
diff changeset
337 const Stmt *ExprMutationAnalyzer::findRangeLoopMutation(const Expr *Exp) {
anatofuz
parents:
diff changeset
338 // If range for looping over 'Exp' with a non-const reference loop variable,
anatofuz
parents:
diff changeset
339 // check all declRefExpr of the loop variable.
anatofuz
parents:
diff changeset
340 const auto LoopVars =
anatofuz
parents:
diff changeset
341 match(findAll(cxxForRangeStmt(
anatofuz
parents:
diff changeset
342 hasLoopVariable(varDecl(hasType(nonConstReferenceType()))
anatofuz
parents:
diff changeset
343 .bind(NodeID<Decl>::value)),
anatofuz
parents:
diff changeset
344 hasRangeInit(equalsNode(Exp)))),
anatofuz
parents:
diff changeset
345 Stm, Context);
anatofuz
parents:
diff changeset
346 return findDeclMutation(LoopVars);
anatofuz
parents:
diff changeset
347 }
anatofuz
parents:
diff changeset
348
anatofuz
parents:
diff changeset
349 const Stmt *ExprMutationAnalyzer::findReferenceMutation(const Expr *Exp) {
anatofuz
parents:
diff changeset
350 // Follow non-const reference returned by `operator*()` of move-only classes.
anatofuz
parents:
diff changeset
351 // These are typically smart pointers with unique ownership so we treat
anatofuz
parents:
diff changeset
352 // mutation of pointee as mutation of the smart pointer itself.
anatofuz
parents:
diff changeset
353 const auto Ref =
anatofuz
parents:
diff changeset
354 match(findAll(cxxOperatorCallExpr(
anatofuz
parents:
diff changeset
355 hasOverloadedOperatorName("*"),
anatofuz
parents:
diff changeset
356 callee(cxxMethodDecl(ofClass(isMoveOnly()),
anatofuz
parents:
diff changeset
357 returns(nonConstReferenceType()))),
anatofuz
parents:
diff changeset
358 argumentCountIs(1), hasArgument(0, equalsNode(Exp)))
anatofuz
parents:
diff changeset
359 .bind(NodeID<Expr>::value)),
anatofuz
parents:
diff changeset
360 Stm, Context);
anatofuz
parents:
diff changeset
361 if (const Stmt *S = findExprMutation(Ref))
anatofuz
parents:
diff changeset
362 return S;
anatofuz
parents:
diff changeset
363
anatofuz
parents:
diff changeset
364 // If 'Exp' is bound to a non-const reference, check all declRefExpr to that.
anatofuz
parents:
diff changeset
365 const auto Refs = match(
anatofuz
parents:
diff changeset
366 stmt(forEachDescendant(
anatofuz
parents:
diff changeset
367 varDecl(
anatofuz
parents:
diff changeset
368 hasType(nonConstReferenceType()),
anatofuz
parents:
diff changeset
369 hasInitializer(anyOf(equalsNode(Exp),
anatofuz
parents:
diff changeset
370 conditionalOperator(anyOf(
anatofuz
parents:
diff changeset
371 hasTrueExpression(equalsNode(Exp)),
anatofuz
parents:
diff changeset
372 hasFalseExpression(equalsNode(Exp)))))),
anatofuz
parents:
diff changeset
373 hasParent(declStmt().bind("stmt")),
anatofuz
parents:
diff changeset
374 // Don't follow the reference in range statement, we've handled
anatofuz
parents:
diff changeset
375 // that separately.
anatofuz
parents:
diff changeset
376 unless(hasParent(declStmt(hasParent(
anatofuz
parents:
diff changeset
377 cxxForRangeStmt(hasRangeStmt(equalsBoundNode("stmt"))))))))
anatofuz
parents:
diff changeset
378 .bind(NodeID<Decl>::value))),
anatofuz
parents:
diff changeset
379 Stm, Context);
anatofuz
parents:
diff changeset
380 return findDeclMutation(Refs);
anatofuz
parents:
diff changeset
381 }
anatofuz
parents:
diff changeset
382
anatofuz
parents:
diff changeset
383 const Stmt *ExprMutationAnalyzer::findFunctionArgMutation(const Expr *Exp) {
anatofuz
parents:
diff changeset
384 const auto NonConstRefParam = forEachArgumentWithParam(
anatofuz
parents:
diff changeset
385 equalsNode(Exp),
anatofuz
parents:
diff changeset
386 parmVarDecl(hasType(nonConstReferenceType())).bind("parm"));
anatofuz
parents:
diff changeset
387 const auto IsInstantiated = hasDeclaration(isInstantiated());
anatofuz
parents:
diff changeset
388 const auto FuncDecl = hasDeclaration(functionDecl().bind("func"));
anatofuz
parents:
diff changeset
389 const auto Matches = match(
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
390 traverse(
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
391 ast_type_traits::TK_AsIs,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
392 findAll(
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
393 expr(anyOf(callExpr(NonConstRefParam, IsInstantiated, FuncDecl,
150
anatofuz
parents:
diff changeset
394 unless(callee(namedDecl(hasAnyName(
anatofuz
parents:
diff changeset
395 "::std::move", "::std::forward"))))),
anatofuz
parents:
diff changeset
396 cxxConstructExpr(NonConstRefParam, IsInstantiated,
anatofuz
parents:
diff changeset
397 FuncDecl)))
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
398 .bind(NodeID<Expr>::value))),
150
anatofuz
parents:
diff changeset
399 Stm, Context);
anatofuz
parents:
diff changeset
400 for (const auto &Nodes : Matches) {
anatofuz
parents:
diff changeset
401 const auto *Exp = Nodes.getNodeAs<Expr>(NodeID<Expr>::value);
anatofuz
parents:
diff changeset
402 const auto *Func = Nodes.getNodeAs<FunctionDecl>("func");
anatofuz
parents:
diff changeset
403 if (!Func->getBody() || !Func->getPrimaryTemplate())
anatofuz
parents:
diff changeset
404 return Exp;
anatofuz
parents:
diff changeset
405
anatofuz
parents:
diff changeset
406 const auto *Parm = Nodes.getNodeAs<ParmVarDecl>("parm");
anatofuz
parents:
diff changeset
407 const ArrayRef<ParmVarDecl *> AllParams =
anatofuz
parents:
diff changeset
408 Func->getPrimaryTemplate()->getTemplatedDecl()->parameters();
anatofuz
parents:
diff changeset
409 QualType ParmType =
anatofuz
parents:
diff changeset
410 AllParams[std::min<size_t>(Parm->getFunctionScopeIndex(),
anatofuz
parents:
diff changeset
411 AllParams.size() - 1)]
anatofuz
parents:
diff changeset
412 ->getType();
anatofuz
parents:
diff changeset
413 if (const auto *T = ParmType->getAs<PackExpansionType>())
anatofuz
parents:
diff changeset
414 ParmType = T->getPattern();
anatofuz
parents:
diff changeset
415
anatofuz
parents:
diff changeset
416 // If param type is forwarding reference, follow into the function
anatofuz
parents:
diff changeset
417 // definition and see whether the param is mutated inside.
anatofuz
parents:
diff changeset
418 if (const auto *RefType = ParmType->getAs<RValueReferenceType>()) {
anatofuz
parents:
diff changeset
419 if (!RefType->getPointeeType().getQualifiers() &&
anatofuz
parents:
diff changeset
420 RefType->getPointeeType()->getAs<TemplateTypeParmType>()) {
anatofuz
parents:
diff changeset
421 std::unique_ptr<FunctionParmMutationAnalyzer> &Analyzer =
anatofuz
parents:
diff changeset
422 FuncParmAnalyzer[Func];
anatofuz
parents:
diff changeset
423 if (!Analyzer)
anatofuz
parents:
diff changeset
424 Analyzer.reset(new FunctionParmMutationAnalyzer(*Func, Context));
anatofuz
parents:
diff changeset
425 if (Analyzer->findMutation(Parm))
anatofuz
parents:
diff changeset
426 return Exp;
anatofuz
parents:
diff changeset
427 continue;
anatofuz
parents:
diff changeset
428 }
anatofuz
parents:
diff changeset
429 }
anatofuz
parents:
diff changeset
430 // Not forwarding reference.
anatofuz
parents:
diff changeset
431 return Exp;
anatofuz
parents:
diff changeset
432 }
anatofuz
parents:
diff changeset
433 return nullptr;
anatofuz
parents:
diff changeset
434 }
anatofuz
parents:
diff changeset
435
anatofuz
parents:
diff changeset
436 FunctionParmMutationAnalyzer::FunctionParmMutationAnalyzer(
anatofuz
parents:
diff changeset
437 const FunctionDecl &Func, ASTContext &Context)
anatofuz
parents:
diff changeset
438 : BodyAnalyzer(*Func.getBody(), Context) {
anatofuz
parents:
diff changeset
439 if (const auto *Ctor = dyn_cast<CXXConstructorDecl>(&Func)) {
anatofuz
parents:
diff changeset
440 // CXXCtorInitializer might also mutate Param but they're not part of
anatofuz
parents:
diff changeset
441 // function body, check them eagerly here since they're typically trivial.
anatofuz
parents:
diff changeset
442 for (const CXXCtorInitializer *Init : Ctor->inits()) {
anatofuz
parents:
diff changeset
443 ExprMutationAnalyzer InitAnalyzer(*Init->getInit(), Context);
anatofuz
parents:
diff changeset
444 for (const ParmVarDecl *Parm : Ctor->parameters()) {
anatofuz
parents:
diff changeset
445 if (Results.find(Parm) != Results.end())
anatofuz
parents:
diff changeset
446 continue;
anatofuz
parents:
diff changeset
447 if (const Stmt *S = InitAnalyzer.findMutation(Parm))
anatofuz
parents:
diff changeset
448 Results[Parm] = S;
anatofuz
parents:
diff changeset
449 }
anatofuz
parents:
diff changeset
450 }
anatofuz
parents:
diff changeset
451 }
anatofuz
parents:
diff changeset
452 }
anatofuz
parents:
diff changeset
453
anatofuz
parents:
diff changeset
454 const Stmt *
anatofuz
parents:
diff changeset
455 FunctionParmMutationAnalyzer::findMutation(const ParmVarDecl *Parm) {
anatofuz
parents:
diff changeset
456 const auto Memoized = Results.find(Parm);
anatofuz
parents:
diff changeset
457 if (Memoized != Results.end())
anatofuz
parents:
diff changeset
458 return Memoized->second;
anatofuz
parents:
diff changeset
459
anatofuz
parents:
diff changeset
460 if (const Stmt *S = BodyAnalyzer.findMutation(Parm))
anatofuz
parents:
diff changeset
461 return Results[Parm] = S;
anatofuz
parents:
diff changeset
462
anatofuz
parents:
diff changeset
463 return Results[Parm] = nullptr;
anatofuz
parents:
diff changeset
464 }
anatofuz
parents:
diff changeset
465
anatofuz
parents:
diff changeset
466 } // namespace clang