annotate clang-tools-extra/clang-tidy/bugprone/UseAfterMoveCheck.cpp @ 173:0572611fdcc8 llvm10 llvm12

reorgnization done
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 11:55:54 +0900
parents 1d019706d866
children 2e18cbf3894f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===--- UseAfterMoveCheck.cpp - clang-tidy -------------------------------===//
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
anatofuz
parents:
diff changeset
9 #include "UseAfterMoveCheck.h"
anatofuz
parents:
diff changeset
10
anatofuz
parents:
diff changeset
11 #include "clang/AST/Expr.h"
anatofuz
parents:
diff changeset
12 #include "clang/AST/ExprCXX.h"
anatofuz
parents:
diff changeset
13 #include "clang/AST/ExprConcepts.h"
anatofuz
parents:
diff changeset
14 #include "clang/ASTMatchers/ASTMatchers.h"
anatofuz
parents:
diff changeset
15 #include "clang/Analysis/CFG.h"
anatofuz
parents:
diff changeset
16 #include "clang/Lex/Lexer.h"
anatofuz
parents:
diff changeset
17
anatofuz
parents:
diff changeset
18 #include "../utils/ExprSequence.h"
anatofuz
parents:
diff changeset
19
anatofuz
parents:
diff changeset
20 using namespace clang::ast_matchers;
anatofuz
parents:
diff changeset
21 using namespace clang::tidy::utils;
anatofuz
parents:
diff changeset
22
anatofuz
parents:
diff changeset
23
anatofuz
parents:
diff changeset
24 namespace clang {
anatofuz
parents:
diff changeset
25 namespace tidy {
anatofuz
parents:
diff changeset
26 namespace bugprone {
anatofuz
parents:
diff changeset
27
anatofuz
parents:
diff changeset
28 namespace {
anatofuz
parents:
diff changeset
29
anatofuz
parents:
diff changeset
30 AST_MATCHER(Expr, hasUnevaluatedContext) {
anatofuz
parents:
diff changeset
31 if (isa<CXXNoexceptExpr>(Node) || isa<RequiresExpr>(Node))
anatofuz
parents:
diff changeset
32 return true;
anatofuz
parents:
diff changeset
33 if (const auto *UnaryExpr = dyn_cast<UnaryExprOrTypeTraitExpr>(&Node)) {
anatofuz
parents:
diff changeset
34 switch (UnaryExpr->getKind()) {
anatofuz
parents:
diff changeset
35 case UETT_SizeOf:
anatofuz
parents:
diff changeset
36 case UETT_AlignOf:
anatofuz
parents:
diff changeset
37 return true;
anatofuz
parents:
diff changeset
38 default:
anatofuz
parents:
diff changeset
39 return false;
anatofuz
parents:
diff changeset
40 }
anatofuz
parents:
diff changeset
41 }
anatofuz
parents:
diff changeset
42 if (const auto *TypeIDExpr = dyn_cast<CXXTypeidExpr>(&Node))
anatofuz
parents:
diff changeset
43 return !TypeIDExpr->isPotentiallyEvaluated();
anatofuz
parents:
diff changeset
44 return false;
anatofuz
parents:
diff changeset
45 }
anatofuz
parents:
diff changeset
46
anatofuz
parents:
diff changeset
47 /// Contains information about a use-after-move.
anatofuz
parents:
diff changeset
48 struct UseAfterMove {
anatofuz
parents:
diff changeset
49 // The DeclRefExpr that constituted the use of the object.
anatofuz
parents:
diff changeset
50 const DeclRefExpr *DeclRef;
anatofuz
parents:
diff changeset
51
anatofuz
parents:
diff changeset
52 // Is the order in which the move and the use are evaluated undefined?
anatofuz
parents:
diff changeset
53 bool EvaluationOrderUndefined;
anatofuz
parents:
diff changeset
54 };
anatofuz
parents:
diff changeset
55
anatofuz
parents:
diff changeset
56 /// Finds uses of a variable after a move (and maintains state required by the
anatofuz
parents:
diff changeset
57 /// various internal helper functions).
anatofuz
parents:
diff changeset
58 class UseAfterMoveFinder {
anatofuz
parents:
diff changeset
59 public:
anatofuz
parents:
diff changeset
60 UseAfterMoveFinder(ASTContext *TheContext);
anatofuz
parents:
diff changeset
61
anatofuz
parents:
diff changeset
62 // Within the given function body, finds the first use of 'MovedVariable' that
anatofuz
parents:
diff changeset
63 // occurs after 'MovingCall' (the expression that performs the move). If a
anatofuz
parents:
diff changeset
64 // use-after-move is found, writes information about it to 'TheUseAfterMove'.
anatofuz
parents:
diff changeset
65 // Returns whether a use-after-move was found.
anatofuz
parents:
diff changeset
66 bool find(Stmt *FunctionBody, const Expr *MovingCall,
anatofuz
parents:
diff changeset
67 const ValueDecl *MovedVariable, UseAfterMove *TheUseAfterMove);
anatofuz
parents:
diff changeset
68
anatofuz
parents:
diff changeset
69 private:
anatofuz
parents:
diff changeset
70 bool findInternal(const CFGBlock *Block, const Expr *MovingCall,
anatofuz
parents:
diff changeset
71 const ValueDecl *MovedVariable,
anatofuz
parents:
diff changeset
72 UseAfterMove *TheUseAfterMove);
anatofuz
parents:
diff changeset
73 void getUsesAndReinits(const CFGBlock *Block, const ValueDecl *MovedVariable,
anatofuz
parents:
diff changeset
74 llvm::SmallVectorImpl<const DeclRefExpr *> *Uses,
anatofuz
parents:
diff changeset
75 llvm::SmallPtrSetImpl<const Stmt *> *Reinits);
anatofuz
parents:
diff changeset
76 void getDeclRefs(const CFGBlock *Block, const Decl *MovedVariable,
anatofuz
parents:
diff changeset
77 llvm::SmallPtrSetImpl<const DeclRefExpr *> *DeclRefs);
anatofuz
parents:
diff changeset
78 void getReinits(const CFGBlock *Block, const ValueDecl *MovedVariable,
anatofuz
parents:
diff changeset
79 llvm::SmallPtrSetImpl<const Stmt *> *Stmts,
anatofuz
parents:
diff changeset
80 llvm::SmallPtrSetImpl<const DeclRefExpr *> *DeclRefs);
anatofuz
parents:
diff changeset
81
anatofuz
parents:
diff changeset
82 ASTContext *Context;
anatofuz
parents:
diff changeset
83 std::unique_ptr<ExprSequence> Sequence;
anatofuz
parents:
diff changeset
84 std::unique_ptr<StmtToBlockMap> BlockMap;
anatofuz
parents:
diff changeset
85 llvm::SmallPtrSet<const CFGBlock *, 8> Visited;
anatofuz
parents:
diff changeset
86 };
anatofuz
parents:
diff changeset
87
anatofuz
parents:
diff changeset
88 } // namespace
anatofuz
parents:
diff changeset
89
anatofuz
parents:
diff changeset
90
anatofuz
parents:
diff changeset
91 // Matches nodes that are
anatofuz
parents:
diff changeset
92 // - Part of a decltype argument or class template argument (we check this by
anatofuz
parents:
diff changeset
93 // seeing if they are children of a TypeLoc), or
anatofuz
parents:
diff changeset
94 // - Part of a function template argument (we check this by seeing if they are
anatofuz
parents:
diff changeset
95 // children of a DeclRefExpr that references a function template).
anatofuz
parents:
diff changeset
96 // DeclRefExprs that fulfill these conditions should not be counted as a use or
anatofuz
parents:
diff changeset
97 // move.
anatofuz
parents:
diff changeset
98 static StatementMatcher inDecltypeOrTemplateArg() {
anatofuz
parents:
diff changeset
99 return anyOf(hasAncestor(typeLoc()),
anatofuz
parents:
diff changeset
100 hasAncestor(declRefExpr(
anatofuz
parents:
diff changeset
101 to(functionDecl(ast_matchers::isTemplateInstantiation())))),
anatofuz
parents:
diff changeset
102 hasAncestor(expr(hasUnevaluatedContext())));
anatofuz
parents:
diff changeset
103 }
anatofuz
parents:
diff changeset
104
anatofuz
parents:
diff changeset
105 UseAfterMoveFinder::UseAfterMoveFinder(ASTContext *TheContext)
anatofuz
parents:
diff changeset
106 : Context(TheContext) {}
anatofuz
parents:
diff changeset
107
anatofuz
parents:
diff changeset
108 bool UseAfterMoveFinder::find(Stmt *FunctionBody, const Expr *MovingCall,
anatofuz
parents:
diff changeset
109 const ValueDecl *MovedVariable,
anatofuz
parents:
diff changeset
110 UseAfterMove *TheUseAfterMove) {
anatofuz
parents:
diff changeset
111 // Generate the CFG manually instead of through an AnalysisDeclContext because
anatofuz
parents:
diff changeset
112 // it seems the latter can't be used to generate a CFG for the body of a
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
113 // lambda.
150
anatofuz
parents:
diff changeset
114 //
anatofuz
parents:
diff changeset
115 // We include implicit and temporary destructors in the CFG so that
anatofuz
parents:
diff changeset
116 // destructors marked [[noreturn]] are handled correctly in the control flow
anatofuz
parents:
diff changeset
117 // analysis. (These are used in some styles of assertion macros.)
anatofuz
parents:
diff changeset
118 CFG::BuildOptions Options;
anatofuz
parents:
diff changeset
119 Options.AddImplicitDtors = true;
anatofuz
parents:
diff changeset
120 Options.AddTemporaryDtors = true;
anatofuz
parents:
diff changeset
121 std::unique_ptr<CFG> TheCFG =
anatofuz
parents:
diff changeset
122 CFG::buildCFG(nullptr, FunctionBody, Context, Options);
anatofuz
parents:
diff changeset
123 if (!TheCFG)
anatofuz
parents:
diff changeset
124 return false;
anatofuz
parents:
diff changeset
125
anatofuz
parents:
diff changeset
126 Sequence =
anatofuz
parents:
diff changeset
127 std::make_unique<ExprSequence>(TheCFG.get(), FunctionBody, Context);
anatofuz
parents:
diff changeset
128 BlockMap = std::make_unique<StmtToBlockMap>(TheCFG.get(), Context);
anatofuz
parents:
diff changeset
129 Visited.clear();
anatofuz
parents:
diff changeset
130
anatofuz
parents:
diff changeset
131 const CFGBlock *Block = BlockMap->blockContainingStmt(MovingCall);
anatofuz
parents:
diff changeset
132 if (!Block)
anatofuz
parents:
diff changeset
133 return false;
anatofuz
parents:
diff changeset
134
anatofuz
parents:
diff changeset
135 return findInternal(Block, MovingCall, MovedVariable, TheUseAfterMove);
anatofuz
parents:
diff changeset
136 }
anatofuz
parents:
diff changeset
137
anatofuz
parents:
diff changeset
138 bool UseAfterMoveFinder::findInternal(const CFGBlock *Block,
anatofuz
parents:
diff changeset
139 const Expr *MovingCall,
anatofuz
parents:
diff changeset
140 const ValueDecl *MovedVariable,
anatofuz
parents:
diff changeset
141 UseAfterMove *TheUseAfterMove) {
anatofuz
parents:
diff changeset
142 if (Visited.count(Block))
anatofuz
parents:
diff changeset
143 return false;
anatofuz
parents:
diff changeset
144
anatofuz
parents:
diff changeset
145 // Mark the block as visited (except if this is the block containing the
anatofuz
parents:
diff changeset
146 // std::move() and it's being visited the first time).
anatofuz
parents:
diff changeset
147 if (!MovingCall)
anatofuz
parents:
diff changeset
148 Visited.insert(Block);
anatofuz
parents:
diff changeset
149
anatofuz
parents:
diff changeset
150 // Get all uses and reinits in the block.
anatofuz
parents:
diff changeset
151 llvm::SmallVector<const DeclRefExpr *, 1> Uses;
anatofuz
parents:
diff changeset
152 llvm::SmallPtrSet<const Stmt *, 1> Reinits;
anatofuz
parents:
diff changeset
153 getUsesAndReinits(Block, MovedVariable, &Uses, &Reinits);
anatofuz
parents:
diff changeset
154
anatofuz
parents:
diff changeset
155 // Ignore all reinitializations where the move potentially comes after the
anatofuz
parents:
diff changeset
156 // reinit.
anatofuz
parents:
diff changeset
157 llvm::SmallVector<const Stmt *, 1> ReinitsToDelete;
anatofuz
parents:
diff changeset
158 for (const Stmt *Reinit : Reinits) {
anatofuz
parents:
diff changeset
159 if (MovingCall && Sequence->potentiallyAfter(MovingCall, Reinit))
anatofuz
parents:
diff changeset
160 ReinitsToDelete.push_back(Reinit);
anatofuz
parents:
diff changeset
161 }
anatofuz
parents:
diff changeset
162 for (const Stmt *Reinit : ReinitsToDelete) {
anatofuz
parents:
diff changeset
163 Reinits.erase(Reinit);
anatofuz
parents:
diff changeset
164 }
anatofuz
parents:
diff changeset
165
anatofuz
parents:
diff changeset
166 // Find all uses that potentially come after the move.
anatofuz
parents:
diff changeset
167 for (const DeclRefExpr *Use : Uses) {
anatofuz
parents:
diff changeset
168 if (!MovingCall || Sequence->potentiallyAfter(Use, MovingCall)) {
anatofuz
parents:
diff changeset
169 // Does the use have a saving reinit? A reinit is saving if it definitely
anatofuz
parents:
diff changeset
170 // comes before the use, i.e. if there's no potential that the reinit is
anatofuz
parents:
diff changeset
171 // after the use.
anatofuz
parents:
diff changeset
172 bool HaveSavingReinit = false;
anatofuz
parents:
diff changeset
173 for (const Stmt *Reinit : Reinits) {
anatofuz
parents:
diff changeset
174 if (!Sequence->potentiallyAfter(Reinit, Use))
anatofuz
parents:
diff changeset
175 HaveSavingReinit = true;
anatofuz
parents:
diff changeset
176 }
anatofuz
parents:
diff changeset
177
anatofuz
parents:
diff changeset
178 if (!HaveSavingReinit) {
anatofuz
parents:
diff changeset
179 TheUseAfterMove->DeclRef = Use;
anatofuz
parents:
diff changeset
180
anatofuz
parents:
diff changeset
181 // Is this a use-after-move that depends on order of evaluation?
anatofuz
parents:
diff changeset
182 // This is the case if the move potentially comes after the use (and we
anatofuz
parents:
diff changeset
183 // already know that use potentially comes after the move, which taken
anatofuz
parents:
diff changeset
184 // together tells us that the ordering is unclear).
anatofuz
parents:
diff changeset
185 TheUseAfterMove->EvaluationOrderUndefined =
anatofuz
parents:
diff changeset
186 MovingCall != nullptr &&
anatofuz
parents:
diff changeset
187 Sequence->potentiallyAfter(MovingCall, Use);
anatofuz
parents:
diff changeset
188
anatofuz
parents:
diff changeset
189 return true;
anatofuz
parents:
diff changeset
190 }
anatofuz
parents:
diff changeset
191 }
anatofuz
parents:
diff changeset
192 }
anatofuz
parents:
diff changeset
193
anatofuz
parents:
diff changeset
194 // If the object wasn't reinitialized, call ourselves recursively on all
anatofuz
parents:
diff changeset
195 // successors.
anatofuz
parents:
diff changeset
196 if (Reinits.empty()) {
anatofuz
parents:
diff changeset
197 for (const auto &Succ : Block->succs()) {
anatofuz
parents:
diff changeset
198 if (Succ && findInternal(Succ, nullptr, MovedVariable, TheUseAfterMove))
anatofuz
parents:
diff changeset
199 return true;
anatofuz
parents:
diff changeset
200 }
anatofuz
parents:
diff changeset
201 }
anatofuz
parents:
diff changeset
202
anatofuz
parents:
diff changeset
203 return false;
anatofuz
parents:
diff changeset
204 }
anatofuz
parents:
diff changeset
205
anatofuz
parents:
diff changeset
206 void UseAfterMoveFinder::getUsesAndReinits(
anatofuz
parents:
diff changeset
207 const CFGBlock *Block, const ValueDecl *MovedVariable,
anatofuz
parents:
diff changeset
208 llvm::SmallVectorImpl<const DeclRefExpr *> *Uses,
anatofuz
parents:
diff changeset
209 llvm::SmallPtrSetImpl<const Stmt *> *Reinits) {
anatofuz
parents:
diff changeset
210 llvm::SmallPtrSet<const DeclRefExpr *, 1> DeclRefs;
anatofuz
parents:
diff changeset
211 llvm::SmallPtrSet<const DeclRefExpr *, 1> ReinitDeclRefs;
anatofuz
parents:
diff changeset
212
anatofuz
parents:
diff changeset
213 getDeclRefs(Block, MovedVariable, &DeclRefs);
anatofuz
parents:
diff changeset
214 getReinits(Block, MovedVariable, Reinits, &ReinitDeclRefs);
anatofuz
parents:
diff changeset
215
anatofuz
parents:
diff changeset
216 // All references to the variable that aren't reinitializations are uses.
anatofuz
parents:
diff changeset
217 Uses->clear();
anatofuz
parents:
diff changeset
218 for (const DeclRefExpr *DeclRef : DeclRefs) {
anatofuz
parents:
diff changeset
219 if (!ReinitDeclRefs.count(DeclRef))
anatofuz
parents:
diff changeset
220 Uses->push_back(DeclRef);
anatofuz
parents:
diff changeset
221 }
anatofuz
parents:
diff changeset
222
anatofuz
parents:
diff changeset
223 // Sort the uses by their occurrence in the source code.
anatofuz
parents:
diff changeset
224 std::sort(Uses->begin(), Uses->end(),
anatofuz
parents:
diff changeset
225 [](const DeclRefExpr *D1, const DeclRefExpr *D2) {
anatofuz
parents:
diff changeset
226 return D1->getExprLoc() < D2->getExprLoc();
anatofuz
parents:
diff changeset
227 });
anatofuz
parents:
diff changeset
228 }
anatofuz
parents:
diff changeset
229
anatofuz
parents:
diff changeset
230 bool isStandardSmartPointer(const ValueDecl *VD) {
anatofuz
parents:
diff changeset
231 const Type *TheType = VD->getType().getNonReferenceType().getTypePtrOrNull();
anatofuz
parents:
diff changeset
232 if (!TheType)
anatofuz
parents:
diff changeset
233 return false;
anatofuz
parents:
diff changeset
234
anatofuz
parents:
diff changeset
235 const CXXRecordDecl *RecordDecl = TheType->getAsCXXRecordDecl();
anatofuz
parents:
diff changeset
236 if (!RecordDecl)
anatofuz
parents:
diff changeset
237 return false;
anatofuz
parents:
diff changeset
238
anatofuz
parents:
diff changeset
239 const IdentifierInfo *ID = RecordDecl->getIdentifier();
anatofuz
parents:
diff changeset
240 if (!ID)
anatofuz
parents:
diff changeset
241 return false;
anatofuz
parents:
diff changeset
242
anatofuz
parents:
diff changeset
243 StringRef Name = ID->getName();
anatofuz
parents:
diff changeset
244 if (Name != "unique_ptr" && Name != "shared_ptr" && Name != "weak_ptr")
anatofuz
parents:
diff changeset
245 return false;
anatofuz
parents:
diff changeset
246
anatofuz
parents:
diff changeset
247 return RecordDecl->getDeclContext()->isStdNamespace();
anatofuz
parents:
diff changeset
248 }
anatofuz
parents:
diff changeset
249
anatofuz
parents:
diff changeset
250 void UseAfterMoveFinder::getDeclRefs(
anatofuz
parents:
diff changeset
251 const CFGBlock *Block, const Decl *MovedVariable,
anatofuz
parents:
diff changeset
252 llvm::SmallPtrSetImpl<const DeclRefExpr *> *DeclRefs) {
anatofuz
parents:
diff changeset
253 DeclRefs->clear();
anatofuz
parents:
diff changeset
254 for (const auto &Elem : *Block) {
anatofuz
parents:
diff changeset
255 Optional<CFGStmt> S = Elem.getAs<CFGStmt>();
anatofuz
parents:
diff changeset
256 if (!S)
anatofuz
parents:
diff changeset
257 continue;
anatofuz
parents:
diff changeset
258
anatofuz
parents:
diff changeset
259 auto addDeclRefs = [this, Block,
anatofuz
parents:
diff changeset
260 DeclRefs](const ArrayRef<BoundNodes> Matches) {
anatofuz
parents:
diff changeset
261 for (const auto &Match : Matches) {
anatofuz
parents:
diff changeset
262 const auto *DeclRef = Match.getNodeAs<DeclRefExpr>("declref");
anatofuz
parents:
diff changeset
263 const auto *Operator = Match.getNodeAs<CXXOperatorCallExpr>("operator");
anatofuz
parents:
diff changeset
264 if (DeclRef && BlockMap->blockContainingStmt(DeclRef) == Block) {
anatofuz
parents:
diff changeset
265 // Ignore uses of a standard smart pointer that don't dereference the
anatofuz
parents:
diff changeset
266 // pointer.
anatofuz
parents:
diff changeset
267 if (Operator || !isStandardSmartPointer(DeclRef->getDecl())) {
anatofuz
parents:
diff changeset
268 DeclRefs->insert(DeclRef);
anatofuz
parents:
diff changeset
269 }
anatofuz
parents:
diff changeset
270 }
anatofuz
parents:
diff changeset
271 }
anatofuz
parents:
diff changeset
272 };
anatofuz
parents:
diff changeset
273
anatofuz
parents:
diff changeset
274 auto DeclRefMatcher = declRefExpr(hasDeclaration(equalsNode(MovedVariable)),
anatofuz
parents:
diff changeset
275 unless(inDecltypeOrTemplateArg()))
anatofuz
parents:
diff changeset
276 .bind("declref");
anatofuz
parents:
diff changeset
277
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
278 addDeclRefs(
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
279 match(traverse(ast_type_traits::TK_AsIs, findAll(DeclRefMatcher)),
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
280 *S->getStmt(), *Context));
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
281 addDeclRefs(match(findAll(cxxOperatorCallExpr(
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
282 hasAnyOverloadedOperatorName("*", "->", "[]"),
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
283 hasArgument(0, DeclRefMatcher))
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
284 .bind("operator")),
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
285 *S->getStmt(), *Context));
150
anatofuz
parents:
diff changeset
286 }
anatofuz
parents:
diff changeset
287 }
anatofuz
parents:
diff changeset
288
anatofuz
parents:
diff changeset
289 void UseAfterMoveFinder::getReinits(
anatofuz
parents:
diff changeset
290 const CFGBlock *Block, const ValueDecl *MovedVariable,
anatofuz
parents:
diff changeset
291 llvm::SmallPtrSetImpl<const Stmt *> *Stmts,
anatofuz
parents:
diff changeset
292 llvm::SmallPtrSetImpl<const DeclRefExpr *> *DeclRefs) {
anatofuz
parents:
diff changeset
293 auto DeclRefMatcher =
anatofuz
parents:
diff changeset
294 declRefExpr(hasDeclaration(equalsNode(MovedVariable))).bind("declref");
anatofuz
parents:
diff changeset
295
anatofuz
parents:
diff changeset
296 auto StandardContainerTypeMatcher = hasType(hasUnqualifiedDesugaredType(
anatofuz
parents:
diff changeset
297 recordType(hasDeclaration(cxxRecordDecl(hasAnyName(
anatofuz
parents:
diff changeset
298 "::std::basic_string", "::std::vector", "::std::deque",
anatofuz
parents:
diff changeset
299 "::std::forward_list", "::std::list", "::std::set", "::std::map",
anatofuz
parents:
diff changeset
300 "::std::multiset", "::std::multimap", "::std::unordered_set",
anatofuz
parents:
diff changeset
301 "::std::unordered_map", "::std::unordered_multiset",
anatofuz
parents:
diff changeset
302 "::std::unordered_multimap"))))));
anatofuz
parents:
diff changeset
303
anatofuz
parents:
diff changeset
304 auto StandardSmartPointerTypeMatcher = hasType(hasUnqualifiedDesugaredType(
anatofuz
parents:
diff changeset
305 recordType(hasDeclaration(cxxRecordDecl(hasAnyName(
anatofuz
parents:
diff changeset
306 "::std::unique_ptr", "::std::shared_ptr", "::std::weak_ptr"))))));
anatofuz
parents:
diff changeset
307
anatofuz
parents:
diff changeset
308 // Matches different types of reinitialization.
anatofuz
parents:
diff changeset
309 auto ReinitMatcher =
anatofuz
parents:
diff changeset
310 stmt(anyOf(
anatofuz
parents:
diff changeset
311 // Assignment. In addition to the overloaded assignment operator,
anatofuz
parents:
diff changeset
312 // test for built-in assignment as well, since template functions
anatofuz
parents:
diff changeset
313 // may be instantiated to use std::move() on built-in types.
anatofuz
parents:
diff changeset
314 binaryOperator(hasOperatorName("="), hasLHS(DeclRefMatcher)),
anatofuz
parents:
diff changeset
315 cxxOperatorCallExpr(hasOverloadedOperatorName("="),
anatofuz
parents:
diff changeset
316 hasArgument(0, DeclRefMatcher)),
anatofuz
parents:
diff changeset
317 // Declaration. We treat this as a type of reinitialization too,
anatofuz
parents:
diff changeset
318 // so we don't need to treat it separately.
anatofuz
parents:
diff changeset
319 declStmt(hasDescendant(equalsNode(MovedVariable))),
anatofuz
parents:
diff changeset
320 // clear() and assign() on standard containers.
anatofuz
parents:
diff changeset
321 cxxMemberCallExpr(
anatofuz
parents:
diff changeset
322 on(expr(DeclRefMatcher, StandardContainerTypeMatcher)),
anatofuz
parents:
diff changeset
323 // To keep the matcher simple, we check for assign() calls
anatofuz
parents:
diff changeset
324 // on all standard containers, even though only vector,
anatofuz
parents:
diff changeset
325 // deque, forward_list and list have assign(). If assign()
anatofuz
parents:
diff changeset
326 // is called on any of the other containers, this will be
anatofuz
parents:
diff changeset
327 // flagged by a compile error anyway.
anatofuz
parents:
diff changeset
328 callee(cxxMethodDecl(hasAnyName("clear", "assign")))),
anatofuz
parents:
diff changeset
329 // reset() on standard smart pointers.
anatofuz
parents:
diff changeset
330 cxxMemberCallExpr(
anatofuz
parents:
diff changeset
331 on(expr(DeclRefMatcher, StandardSmartPointerTypeMatcher)),
anatofuz
parents:
diff changeset
332 callee(cxxMethodDecl(hasName("reset")))),
anatofuz
parents:
diff changeset
333 // Methods that have the [[clang::reinitializes]] attribute.
anatofuz
parents:
diff changeset
334 cxxMemberCallExpr(
anatofuz
parents:
diff changeset
335 on(DeclRefMatcher),
anatofuz
parents:
diff changeset
336 callee(cxxMethodDecl(hasAttr(clang::attr::Reinitializes)))),
anatofuz
parents:
diff changeset
337 // Passing variable to a function as a non-const pointer.
anatofuz
parents:
diff changeset
338 callExpr(forEachArgumentWithParam(
anatofuz
parents:
diff changeset
339 unaryOperator(hasOperatorName("&"),
anatofuz
parents:
diff changeset
340 hasUnaryOperand(DeclRefMatcher)),
anatofuz
parents:
diff changeset
341 unless(parmVarDecl(hasType(pointsTo(isConstQualified())))))),
anatofuz
parents:
diff changeset
342 // Passing variable to a function as a non-const lvalue reference
anatofuz
parents:
diff changeset
343 // (unless that function is std::move()).
anatofuz
parents:
diff changeset
344 callExpr(forEachArgumentWithParam(
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
345 traverse(ast_type_traits::TK_AsIs, DeclRefMatcher),
150
anatofuz
parents:
diff changeset
346 unless(parmVarDecl(hasType(
anatofuz
parents:
diff changeset
347 references(qualType(isConstQualified())))))),
anatofuz
parents:
diff changeset
348 unless(callee(functionDecl(hasName("::std::move")))))))
anatofuz
parents:
diff changeset
349 .bind("reinit");
anatofuz
parents:
diff changeset
350
anatofuz
parents:
diff changeset
351 Stmts->clear();
anatofuz
parents:
diff changeset
352 DeclRefs->clear();
anatofuz
parents:
diff changeset
353 for (const auto &Elem : *Block) {
anatofuz
parents:
diff changeset
354 Optional<CFGStmt> S = Elem.getAs<CFGStmt>();
anatofuz
parents:
diff changeset
355 if (!S)
anatofuz
parents:
diff changeset
356 continue;
anatofuz
parents:
diff changeset
357
anatofuz
parents:
diff changeset
358 SmallVector<BoundNodes, 1> Matches =
anatofuz
parents:
diff changeset
359 match(findAll(ReinitMatcher), *S->getStmt(), *Context);
anatofuz
parents:
diff changeset
360
anatofuz
parents:
diff changeset
361 for (const auto &Match : Matches) {
anatofuz
parents:
diff changeset
362 const auto *TheStmt = Match.getNodeAs<Stmt>("reinit");
anatofuz
parents:
diff changeset
363 const auto *TheDeclRef = Match.getNodeAs<DeclRefExpr>("declref");
anatofuz
parents:
diff changeset
364 if (TheStmt && BlockMap->blockContainingStmt(TheStmt) == Block) {
anatofuz
parents:
diff changeset
365 Stmts->insert(TheStmt);
anatofuz
parents:
diff changeset
366
anatofuz
parents:
diff changeset
367 // We count DeclStmts as reinitializations, but they don't have a
anatofuz
parents:
diff changeset
368 // DeclRefExpr associated with them -- so we need to check 'TheDeclRef'
anatofuz
parents:
diff changeset
369 // before adding it to the set.
anatofuz
parents:
diff changeset
370 if (TheDeclRef)
anatofuz
parents:
diff changeset
371 DeclRefs->insert(TheDeclRef);
anatofuz
parents:
diff changeset
372 }
anatofuz
parents:
diff changeset
373 }
anatofuz
parents:
diff changeset
374 }
anatofuz
parents:
diff changeset
375 }
anatofuz
parents:
diff changeset
376
anatofuz
parents:
diff changeset
377 static void emitDiagnostic(const Expr *MovingCall, const DeclRefExpr *MoveArg,
anatofuz
parents:
diff changeset
378 const UseAfterMove &Use, ClangTidyCheck *Check,
anatofuz
parents:
diff changeset
379 ASTContext *Context) {
anatofuz
parents:
diff changeset
380 SourceLocation UseLoc = Use.DeclRef->getExprLoc();
anatofuz
parents:
diff changeset
381 SourceLocation MoveLoc = MovingCall->getExprLoc();
anatofuz
parents:
diff changeset
382
anatofuz
parents:
diff changeset
383 Check->diag(UseLoc, "'%0' used after it was moved")
anatofuz
parents:
diff changeset
384 << MoveArg->getDecl()->getName();
anatofuz
parents:
diff changeset
385 Check->diag(MoveLoc, "move occurred here", DiagnosticIDs::Note);
anatofuz
parents:
diff changeset
386 if (Use.EvaluationOrderUndefined) {
anatofuz
parents:
diff changeset
387 Check->diag(UseLoc,
anatofuz
parents:
diff changeset
388 "the use and move are unsequenced, i.e. there is no guarantee "
anatofuz
parents:
diff changeset
389 "about the order in which they are evaluated",
anatofuz
parents:
diff changeset
390 DiagnosticIDs::Note);
anatofuz
parents:
diff changeset
391 } else if (UseLoc < MoveLoc || Use.DeclRef == MoveArg) {
anatofuz
parents:
diff changeset
392 Check->diag(UseLoc,
anatofuz
parents:
diff changeset
393 "the use happens in a later loop iteration than the move",
anatofuz
parents:
diff changeset
394 DiagnosticIDs::Note);
anatofuz
parents:
diff changeset
395 }
anatofuz
parents:
diff changeset
396 }
anatofuz
parents:
diff changeset
397
anatofuz
parents:
diff changeset
398 void UseAfterMoveCheck::registerMatchers(MatchFinder *Finder) {
anatofuz
parents:
diff changeset
399 auto CallMoveMatcher =
anatofuz
parents:
diff changeset
400 callExpr(callee(functionDecl(hasName("::std::move"))), argumentCountIs(1),
anatofuz
parents:
diff changeset
401 hasArgument(0, declRefExpr().bind("arg")),
anatofuz
parents:
diff changeset
402 anyOf(hasAncestor(lambdaExpr().bind("containing-lambda")),
anatofuz
parents:
diff changeset
403 hasAncestor(functionDecl().bind("containing-func"))),
anatofuz
parents:
diff changeset
404 unless(inDecltypeOrTemplateArg()))
anatofuz
parents:
diff changeset
405 .bind("call-move");
anatofuz
parents:
diff changeset
406
anatofuz
parents:
diff changeset
407 Finder->addMatcher(
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
408 traverse(
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
409 ast_type_traits::TK_AsIs,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
410 // To find the Stmt that we assume performs the actual move, we look
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
411 // for the direct ancestor of the std::move() that isn't one of the
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
412 // node types ignored by ignoringParenImpCasts().
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
413 stmt(
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
414 forEach(expr(ignoringParenImpCasts(CallMoveMatcher))),
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
415 // Don't allow an InitListExpr to be the moving call. An
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
416 // InitListExpr has both a syntactic and a semantic form, and the
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
417 // parent-child relationships are different between the two. This
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
418 // could cause an InitListExpr to be analyzed as the moving call
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
419 // in addition to the Expr that we actually want, resulting in two
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
420 // diagnostics with different code locations for the same move.
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
421 unless(initListExpr()),
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
422 unless(expr(ignoringParenImpCasts(equalsBoundNode("call-move")))))
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
423 .bind("moving-call")),
150
anatofuz
parents:
diff changeset
424 this);
anatofuz
parents:
diff changeset
425 }
anatofuz
parents:
diff changeset
426
anatofuz
parents:
diff changeset
427 void UseAfterMoveCheck::check(const MatchFinder::MatchResult &Result) {
anatofuz
parents:
diff changeset
428 const auto *ContainingLambda =
anatofuz
parents:
diff changeset
429 Result.Nodes.getNodeAs<LambdaExpr>("containing-lambda");
anatofuz
parents:
diff changeset
430 const auto *ContainingFunc =
anatofuz
parents:
diff changeset
431 Result.Nodes.getNodeAs<FunctionDecl>("containing-func");
anatofuz
parents:
diff changeset
432 const auto *CallMove = Result.Nodes.getNodeAs<CallExpr>("call-move");
anatofuz
parents:
diff changeset
433 const auto *MovingCall = Result.Nodes.getNodeAs<Expr>("moving-call");
anatofuz
parents:
diff changeset
434 const auto *Arg = Result.Nodes.getNodeAs<DeclRefExpr>("arg");
anatofuz
parents:
diff changeset
435
anatofuz
parents:
diff changeset
436 if (!MovingCall || !MovingCall->getExprLoc().isValid())
anatofuz
parents:
diff changeset
437 MovingCall = CallMove;
anatofuz
parents:
diff changeset
438
anatofuz
parents:
diff changeset
439 Stmt *FunctionBody = nullptr;
anatofuz
parents:
diff changeset
440 if (ContainingLambda)
anatofuz
parents:
diff changeset
441 FunctionBody = ContainingLambda->getBody();
anatofuz
parents:
diff changeset
442 else if (ContainingFunc)
anatofuz
parents:
diff changeset
443 FunctionBody = ContainingFunc->getBody();
anatofuz
parents:
diff changeset
444 else
anatofuz
parents:
diff changeset
445 return;
anatofuz
parents:
diff changeset
446
anatofuz
parents:
diff changeset
447 // Ignore the std::move if the variable that was passed to it isn't a local
anatofuz
parents:
diff changeset
448 // variable.
anatofuz
parents:
diff changeset
449 if (!Arg->getDecl()->getDeclContext()->isFunctionOrMethod())
anatofuz
parents:
diff changeset
450 return;
anatofuz
parents:
diff changeset
451
anatofuz
parents:
diff changeset
452 UseAfterMoveFinder finder(Result.Context);
anatofuz
parents:
diff changeset
453 UseAfterMove Use;
anatofuz
parents:
diff changeset
454 if (finder.find(FunctionBody, MovingCall, Arg->getDecl(), &Use))
anatofuz
parents:
diff changeset
455 emitDiagnostic(MovingCall, Arg, Use, this, Result.Context);
anatofuz
parents:
diff changeset
456 }
anatofuz
parents:
diff changeset
457
anatofuz
parents:
diff changeset
458 } // namespace bugprone
anatofuz
parents:
diff changeset
459 } // namespace tidy
anatofuz
parents:
diff changeset
460 } // namespace clang