blob: 75d7060e2d8e1b982d21ec85368f0fd97a2a0eaf [file] [log] [blame]
Ted Kremenek918fe842010-03-20 21:06:02 +00001//=- AnalysisBasedWarnings.cpp - Sema warnings based on libAnalysis -*- C++ -*-=//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defines analysis_warnings::[Policy,Executor].
11// Together they are used by Sema to issue warnings based on inexpensive
12// static analysis algorithms in libAnalysis.
13//
14//===----------------------------------------------------------------------===//
15
Douglas Gregorc3a6ade2010-08-12 20:07:10 +000016#include "clang/Sema/AnalysisBasedWarnings.h"
John McCall28a0cf72010-08-25 07:42:41 +000017#include "clang/AST/DeclCXX.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000018#include "clang/AST/DeclObjC.h"
Ted Kremenekb8d8c4e2011-04-04 20:56:00 +000019#include "clang/AST/EvaluatedExprVisitor.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "clang/AST/ExprCXX.h"
21#include "clang/AST/ExprObjC.h"
Jordan Rose76831c62012-10-11 16:10:19 +000022#include "clang/AST/ParentMap.h"
Richard Smith84837d52012-05-03 18:27:39 +000023#include "clang/AST/RecursiveASTVisitor.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "clang/AST/StmtCXX.h"
25#include "clang/AST/StmtObjC.h"
26#include "clang/AST/StmtVisitor.h"
27#include "clang/Analysis/Analyses/CFGReachabilityAnalysis.h"
DeLesley Hutchins48a31762013-08-12 21:20:55 +000028#include "clang/Analysis/Analyses/Consumed.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "clang/Analysis/Analyses/ReachableCode.h"
30#include "clang/Analysis/Analyses/ThreadSafety.h"
31#include "clang/Analysis/Analyses/UninitializedValues.h"
Ted Kremenek918fe842010-03-20 21:06:02 +000032#include "clang/Analysis/AnalysisContext.h"
33#include "clang/Analysis/CFG.h"
Ted Kremenek3427fac2011-02-23 01:52:04 +000034#include "clang/Analysis/CFGStmtMap.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000035#include "clang/Basic/SourceLocation.h"
36#include "clang/Basic/SourceManager.h"
37#include "clang/Lex/Lexer.h"
38#include "clang/Lex/Preprocessor.h"
39#include "clang/Sema/ScopeInfo.h"
40#include "clang/Sema/SemaInternal.h"
Alexander Kornienkoe61e5622012-09-28 22:24:03 +000041#include "llvm/ADT/ArrayRef.h"
Ted Kremenek918fe842010-03-20 21:06:02 +000042#include "llvm/ADT/BitVector.h"
Caitlin Sadowskiafbbd8e2011-08-23 18:46:34 +000043#include "llvm/ADT/FoldingSet.h"
44#include "llvm/ADT/ImmutableMap.h"
Enea Zaffanella2f40be72013-02-15 20:09:55 +000045#include "llvm/ADT/MapVector.h"
Caitlin Sadowskiafbbd8e2011-08-23 18:46:34 +000046#include "llvm/ADT/PostOrderIterator.h"
Dmitri Gribenko6743e042012-09-29 11:40:46 +000047#include "llvm/ADT/SmallString.h"
Caitlin Sadowskiafbbd8e2011-08-23 18:46:34 +000048#include "llvm/ADT/SmallVector.h"
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +000049#include "llvm/ADT/StringRef.h"
Ted Kremenek918fe842010-03-20 21:06:02 +000050#include "llvm/Support/Casting.h"
Caitlin Sadowskiafbbd8e2011-08-23 18:46:34 +000051#include <algorithm>
Chandler Carruth3a022472012-12-04 09:13:33 +000052#include <deque>
Richard Smith84837d52012-05-03 18:27:39 +000053#include <iterator>
Caitlin Sadowskiafbbd8e2011-08-23 18:46:34 +000054#include <vector>
Ted Kremenek918fe842010-03-20 21:06:02 +000055
56using namespace clang;
57
58//===----------------------------------------------------------------------===//
59// Unreachable code analysis.
60//===----------------------------------------------------------------------===//
61
62namespace {
63 class UnreachableCodeHandler : public reachable_code::Callback {
64 Sema &S;
65 public:
66 UnreachableCodeHandler(Sema &s) : S(s) {}
67
Ted Kremenek1a8641c2014-03-15 01:26:32 +000068 void HandleUnreachable(reachable_code::UnreachableKind UK,
Ted Kremenekec3bbf42014-03-29 00:35:20 +000069 SourceLocation L,
70 SourceRange SilenceableCondVal,
71 SourceRange R1,
Craig Toppere14c0f82014-03-12 04:55:44 +000072 SourceRange R2) override {
Ted Kremenek1a8641c2014-03-15 01:26:32 +000073 unsigned diag = diag::warn_unreachable;
74 switch (UK) {
75 case reachable_code::UK_Break:
76 diag = diag::warn_unreachable_break;
77 break;
Ted Kremenekf3c93bb2014-03-20 06:07:30 +000078 case reachable_code::UK_Return:
Ted Kremenekad8753c2014-03-15 05:47:06 +000079 diag = diag::warn_unreachable_return;
Ted Kremenek1a8641c2014-03-15 01:26:32 +000080 break;
Ted Kremenek14210372014-03-21 06:02:36 +000081 case reachable_code::UK_Loop_Increment:
82 diag = diag::warn_unreachable_loop_increment;
83 break;
Ted Kremenek1a8641c2014-03-15 01:26:32 +000084 case reachable_code::UK_Other:
85 break;
86 }
87
88 S.Diag(L, diag) << R1 << R2;
Ted Kremenekec3bbf42014-03-29 00:35:20 +000089
90 SourceLocation Open = SilenceableCondVal.getBegin();
91 if (Open.isValid()) {
92 SourceLocation Close = SilenceableCondVal.getEnd();
93 Close = S.PP.getLocForEndOfToken(Close);
94 if (Close.isValid()) {
95 S.Diag(Open, diag::note_unreachable_silence)
96 << FixItHint::CreateInsertion(Open, "/* DISABLES CODE */ (")
97 << FixItHint::CreateInsertion(Close, ")");
98 }
99 }
Ted Kremenek918fe842010-03-20 21:06:02 +0000100 }
101 };
102}
103
104/// CheckUnreachable - Check for unreachable code.
Ted Kremenek81ce1c82011-10-24 01:32:45 +0000105static void CheckUnreachable(Sema &S, AnalysisDeclContext &AC) {
Ted Kremenekc1b28752014-02-25 22:35:37 +0000106 // As a heuristic prune all diagnostics not in the main file. Currently
107 // the majority of warnings in headers are false positives. These
108 // are largely caused by configuration state, e.g. preprocessor
109 // defined code, etc.
110 //
111 // Note that this is also a performance optimization. Analyzing
112 // headers many times can be expensive.
113 if (!S.getSourceManager().isInMainFile(AC.getDecl()->getLocStart()))
114 return;
115
Ted Kremenek918fe842010-03-20 21:06:02 +0000116 UnreachableCodeHandler UC(S);
Ted Kremenek2dd810a2014-03-09 08:13:49 +0000117 reachable_code::FindUnreachableCode(AC, S.getPreprocessor(), UC);
Ted Kremenek918fe842010-03-20 21:06:02 +0000118}
119
120//===----------------------------------------------------------------------===//
Richard Trieu2f024f42013-12-21 02:33:43 +0000121// Check for infinite self-recursion in functions
122//===----------------------------------------------------------------------===//
123
124// All blocks are in one of three states. States are ordered so that blocks
125// can only move to higher states.
126enum RecursiveState {
127 FoundNoPath,
128 FoundPath,
129 FoundPathWithNoRecursiveCall
130};
131
132static void checkForFunctionCall(Sema &S, const FunctionDecl *FD,
133 CFGBlock &Block, unsigned ExitID,
134 llvm::SmallVectorImpl<RecursiveState> &States,
135 RecursiveState State) {
136 unsigned ID = Block.getBlockID();
137
138 // A block's state can only move to a higher state.
139 if (States[ID] >= State)
140 return;
141
142 States[ID] = State;
143
144 // Found a path to the exit node without a recursive call.
145 if (ID == ExitID && State == FoundPathWithNoRecursiveCall)
146 return;
147
148 if (State == FoundPathWithNoRecursiveCall) {
149 // If the current state is FoundPathWithNoRecursiveCall, the successors
150 // will be either FoundPathWithNoRecursiveCall or FoundPath. To determine
151 // which, process all the Stmt's in this block to find any recursive calls.
152 for (CFGBlock::iterator I = Block.begin(), E = Block.end(); I != E; ++I) {
153 if (I->getKind() != CFGElement::Statement)
154 continue;
155
156 const CallExpr *CE = dyn_cast<CallExpr>(I->getAs<CFGStmt>()->getStmt());
157 if (CE && CE->getCalleeDecl() &&
158 CE->getCalleeDecl()->getCanonicalDecl() == FD) {
Richard Trieu658eb682014-01-04 01:57:42 +0000159
160 // Skip function calls which are qualified with a templated class.
161 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(
162 CE->getCallee()->IgnoreParenImpCasts())) {
163 if (NestedNameSpecifier *NNS = DRE->getQualifier()) {
164 if (NNS->getKind() == NestedNameSpecifier::TypeSpec &&
165 isa<TemplateSpecializationType>(NNS->getAsType())) {
166 continue;
167 }
168 }
169 }
170
Richard Trieu2f024f42013-12-21 02:33:43 +0000171 if (const CXXMemberCallExpr *MCE = dyn_cast<CXXMemberCallExpr>(CE)) {
172 if (isa<CXXThisExpr>(MCE->getImplicitObjectArgument()) ||
173 !MCE->getMethodDecl()->isVirtual()) {
174 State = FoundPath;
175 break;
176 }
177 } else {
178 State = FoundPath;
179 break;
180 }
181 }
182 }
183 }
184
185 for (CFGBlock::succ_iterator I = Block.succ_begin(), E = Block.succ_end();
186 I != E; ++I)
187 if (*I)
188 checkForFunctionCall(S, FD, **I, ExitID, States, State);
189}
190
191static void checkRecursiveFunction(Sema &S, const FunctionDecl *FD,
192 const Stmt *Body,
193 AnalysisDeclContext &AC) {
194 FD = FD->getCanonicalDecl();
195
196 // Only run on non-templated functions and non-templated members of
197 // templated classes.
198 if (FD->getTemplatedKind() != FunctionDecl::TK_NonTemplate &&
199 FD->getTemplatedKind() != FunctionDecl::TK_MemberSpecialization)
200 return;
201
202 CFG *cfg = AC.getCFG();
203 if (cfg == 0) return;
204
205 // If the exit block is unreachable, skip processing the function.
206 if (cfg->getExit().pred_empty())
207 return;
208
209 // Mark all nodes as FoundNoPath, then begin processing the entry block.
210 llvm::SmallVector<RecursiveState, 16> states(cfg->getNumBlockIDs(),
211 FoundNoPath);
212 checkForFunctionCall(S, FD, cfg->getEntry(), cfg->getExit().getBlockID(),
213 states, FoundPathWithNoRecursiveCall);
214
215 // Check that the exit block is reachable. This prevents triggering the
216 // warning on functions that do not terminate.
217 if (states[cfg->getExit().getBlockID()] == FoundPath)
218 S.Diag(Body->getLocStart(), diag::warn_infinite_recursive_function);
219}
220
221//===----------------------------------------------------------------------===//
Ted Kremenek918fe842010-03-20 21:06:02 +0000222// Check for missing return value.
223//===----------------------------------------------------------------------===//
224
John McCall5c6ec8c2010-05-16 09:34:11 +0000225enum ControlFlowKind {
226 UnknownFallThrough,
227 NeverFallThrough,
228 MaybeFallThrough,
229 AlwaysFallThrough,
230 NeverFallThroughOrReturn
231};
Ted Kremenek918fe842010-03-20 21:06:02 +0000232
233/// CheckFallThrough - Check that we don't fall off the end of a
234/// Statement that should return a value.
235///
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +0000236/// \returns AlwaysFallThrough iff we always fall off the end of the statement,
237/// MaybeFallThrough iff we might or might not fall off the end,
238/// NeverFallThroughOrReturn iff we never fall off the end of the statement or
239/// return. We assume NeverFallThrough iff we never fall off the end of the
Ted Kremenek918fe842010-03-20 21:06:02 +0000240/// statement but we may return. We assume that functions not marked noreturn
241/// will return.
Ted Kremenek81ce1c82011-10-24 01:32:45 +0000242static ControlFlowKind CheckFallThrough(AnalysisDeclContext &AC) {
Ted Kremenek918fe842010-03-20 21:06:02 +0000243 CFG *cfg = AC.getCFG();
John McCall5c6ec8c2010-05-16 09:34:11 +0000244 if (cfg == 0) return UnknownFallThrough;
Ted Kremenek918fe842010-03-20 21:06:02 +0000245
246 // The CFG leaves in dead things, and we don't want the dead code paths to
247 // confuse us, so we mark all live things first.
Ted Kremenek918fe842010-03-20 21:06:02 +0000248 llvm::BitVector live(cfg->getNumBlockIDs());
Ted Kremenekbd913712011-08-23 23:05:11 +0000249 unsigned count = reachable_code::ScanReachableFromBlock(&cfg->getEntry(),
Ted Kremenek918fe842010-03-20 21:06:02 +0000250 live);
251
252 bool AddEHEdges = AC.getAddEHEdges();
253 if (!AddEHEdges && count != cfg->getNumBlockIDs())
254 // When there are things remaining dead, and we didn't add EH edges
255 // from CallExprs to the catch clauses, we have to go back and
256 // mark them as live.
257 for (CFG::iterator I = cfg->begin(), E = cfg->end(); I != E; ++I) {
258 CFGBlock &b = **I;
259 if (!live[b.getBlockID()]) {
260 if (b.pred_begin() == b.pred_end()) {
261 if (b.getTerminator() && isa<CXXTryStmt>(b.getTerminator()))
262 // When not adding EH edges from calls, catch clauses
263 // can otherwise seem dead. Avoid noting them as dead.
Ted Kremenekbd913712011-08-23 23:05:11 +0000264 count += reachable_code::ScanReachableFromBlock(&b, live);
Ted Kremenek918fe842010-03-20 21:06:02 +0000265 continue;
266 }
267 }
268 }
269
270 // Now we know what is live, we check the live precessors of the exit block
271 // and look for fall through paths, being careful to ignore normal returns,
272 // and exceptional paths.
273 bool HasLiveReturn = false;
274 bool HasFakeEdge = false;
275 bool HasPlainEdge = false;
276 bool HasAbnormalEdge = false;
Ted Kremenek50205742010-09-09 00:06:07 +0000277
278 // Ignore default cases that aren't likely to be reachable because all
279 // enums in a switch(X) have explicit case statements.
280 CFGBlock::FilterOptions FO;
281 FO.IgnoreDefaultsWithCoveredEnums = 1;
282
283 for (CFGBlock::filtered_pred_iterator
284 I = cfg->getExit().filtered_pred_start_end(FO); I.hasMore(); ++I) {
285 const CFGBlock& B = **I;
Ted Kremenek918fe842010-03-20 21:06:02 +0000286 if (!live[B.getBlockID()])
287 continue;
Ted Kremenek5d068492011-01-26 04:49:52 +0000288
Chandler Carruth03faf782011-09-13 09:53:58 +0000289 // Skip blocks which contain an element marked as no-return. They don't
290 // represent actually viable edges into the exit block, so mark them as
291 // abnormal.
292 if (B.hasNoReturnElement()) {
293 HasAbnormalEdge = true;
294 continue;
295 }
296
Ted Kremenek5d068492011-01-26 04:49:52 +0000297 // Destructors can appear after the 'return' in the CFG. This is
298 // normal. We need to look pass the destructors for the return
299 // statement (if it exists).
300 CFGBlock::const_reverse_iterator ri = B.rbegin(), re = B.rend();
Ted Kremeneke06a55c2011-03-02 20:32:29 +0000301
Chandler Carruth03faf782011-09-13 09:53:58 +0000302 for ( ; ri != re ; ++ri)
David Blaikie2a01f5d2013-02-21 20:58:29 +0000303 if (ri->getAs<CFGStmt>())
Ted Kremenek5d068492011-01-26 04:49:52 +0000304 break;
Chandler Carruth03faf782011-09-13 09:53:58 +0000305
Ted Kremenek5d068492011-01-26 04:49:52 +0000306 // No more CFGElements in the block?
307 if (ri == re) {
Ted Kremenek918fe842010-03-20 21:06:02 +0000308 if (B.getTerminator() && isa<CXXTryStmt>(B.getTerminator())) {
309 HasAbnormalEdge = true;
310 continue;
311 }
Ted Kremenek918fe842010-03-20 21:06:02 +0000312 // A labeled empty statement, or the entry block...
313 HasPlainEdge = true;
314 continue;
315 }
Ted Kremenekebe62602011-01-25 22:50:47 +0000316
David Blaikie2a01f5d2013-02-21 20:58:29 +0000317 CFGStmt CS = ri->castAs<CFGStmt>();
Ted Kremenekadfb4452011-08-23 23:05:04 +0000318 const Stmt *S = CS.getStmt();
Ted Kremenek918fe842010-03-20 21:06:02 +0000319 if (isa<ReturnStmt>(S)) {
320 HasLiveReturn = true;
321 continue;
322 }
323 if (isa<ObjCAtThrowStmt>(S)) {
324 HasFakeEdge = true;
325 continue;
326 }
327 if (isa<CXXThrowExpr>(S)) {
328 HasFakeEdge = true;
329 continue;
330 }
Chad Rosier32503022012-06-11 20:47:18 +0000331 if (isa<MSAsmStmt>(S)) {
332 // TODO: Verify this is correct.
333 HasFakeEdge = true;
334 HasLiveReturn = true;
335 continue;
336 }
Ted Kremenek918fe842010-03-20 21:06:02 +0000337 if (isa<CXXTryStmt>(S)) {
338 HasAbnormalEdge = true;
339 continue;
340 }
Chandler Carruth03faf782011-09-13 09:53:58 +0000341 if (std::find(B.succ_begin(), B.succ_end(), &cfg->getExit())
342 == B.succ_end()) {
343 HasAbnormalEdge = true;
344 continue;
Ted Kremenek918fe842010-03-20 21:06:02 +0000345 }
Chandler Carruth03faf782011-09-13 09:53:58 +0000346
347 HasPlainEdge = true;
Ted Kremenek918fe842010-03-20 21:06:02 +0000348 }
349 if (!HasPlainEdge) {
350 if (HasLiveReturn)
351 return NeverFallThrough;
352 return NeverFallThroughOrReturn;
353 }
354 if (HasAbnormalEdge || HasFakeEdge || HasLiveReturn)
355 return MaybeFallThrough;
356 // This says AlwaysFallThrough for calls to functions that are not marked
357 // noreturn, that don't return. If people would like this warning to be more
358 // accurate, such functions should be marked as noreturn.
359 return AlwaysFallThrough;
360}
361
Dan Gohman28ade552010-07-26 21:25:24 +0000362namespace {
363
Ted Kremenek918fe842010-03-20 21:06:02 +0000364struct CheckFallThroughDiagnostics {
365 unsigned diag_MaybeFallThrough_HasNoReturn;
366 unsigned diag_MaybeFallThrough_ReturnsNonVoid;
367 unsigned diag_AlwaysFallThrough_HasNoReturn;
368 unsigned diag_AlwaysFallThrough_ReturnsNonVoid;
369 unsigned diag_NeverFallThroughOrReturn;
Douglas Gregorcf11eb72012-02-15 16:20:15 +0000370 enum { Function, Block, Lambda } funMode;
Argyrios Kyrtzidis1cb0de12010-12-15 18:44:22 +0000371 SourceLocation FuncLoc;
Ted Kremenek0b405322010-03-23 00:13:23 +0000372
Douglas Gregor24f27692010-04-16 23:28:44 +0000373 static CheckFallThroughDiagnostics MakeForFunction(const Decl *Func) {
Ted Kremenek918fe842010-03-20 21:06:02 +0000374 CheckFallThroughDiagnostics D;
Argyrios Kyrtzidis1cb0de12010-12-15 18:44:22 +0000375 D.FuncLoc = Func->getLocation();
Ted Kremenek918fe842010-03-20 21:06:02 +0000376 D.diag_MaybeFallThrough_HasNoReturn =
377 diag::warn_falloff_noreturn_function;
378 D.diag_MaybeFallThrough_ReturnsNonVoid =
379 diag::warn_maybe_falloff_nonvoid_function;
380 D.diag_AlwaysFallThrough_HasNoReturn =
381 diag::warn_falloff_noreturn_function;
382 D.diag_AlwaysFallThrough_ReturnsNonVoid =
383 diag::warn_falloff_nonvoid_function;
Douglas Gregor24f27692010-04-16 23:28:44 +0000384
385 // Don't suggest that virtual functions be marked "noreturn", since they
386 // might be overridden by non-noreturn functions.
387 bool isVirtualMethod = false;
388 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(Func))
389 isVirtualMethod = Method->isVirtual();
390
Douglas Gregor0de57202011-10-10 18:15:57 +0000391 // Don't suggest that template instantiations be marked "noreturn"
392 bool isTemplateInstantiation = false;
Ted Kremenek85825ae2011-12-01 00:59:17 +0000393 if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(Func))
394 isTemplateInstantiation = Function->isTemplateInstantiation();
Douglas Gregor0de57202011-10-10 18:15:57 +0000395
396 if (!isVirtualMethod && !isTemplateInstantiation)
Douglas Gregor24f27692010-04-16 23:28:44 +0000397 D.diag_NeverFallThroughOrReturn =
398 diag::warn_suggest_noreturn_function;
399 else
400 D.diag_NeverFallThroughOrReturn = 0;
401
Douglas Gregorcf11eb72012-02-15 16:20:15 +0000402 D.funMode = Function;
Ted Kremenek918fe842010-03-20 21:06:02 +0000403 return D;
404 }
Ted Kremenek0b405322010-03-23 00:13:23 +0000405
Ted Kremenek918fe842010-03-20 21:06:02 +0000406 static CheckFallThroughDiagnostics MakeForBlock() {
407 CheckFallThroughDiagnostics D;
408 D.diag_MaybeFallThrough_HasNoReturn =
409 diag::err_noreturn_block_has_return_expr;
410 D.diag_MaybeFallThrough_ReturnsNonVoid =
411 diag::err_maybe_falloff_nonvoid_block;
412 D.diag_AlwaysFallThrough_HasNoReturn =
413 diag::err_noreturn_block_has_return_expr;
414 D.diag_AlwaysFallThrough_ReturnsNonVoid =
415 diag::err_falloff_nonvoid_block;
416 D.diag_NeverFallThroughOrReturn =
417 diag::warn_suggest_noreturn_block;
Douglas Gregorcf11eb72012-02-15 16:20:15 +0000418 D.funMode = Block;
419 return D;
420 }
421
422 static CheckFallThroughDiagnostics MakeForLambda() {
423 CheckFallThroughDiagnostics D;
424 D.diag_MaybeFallThrough_HasNoReturn =
425 diag::err_noreturn_lambda_has_return_expr;
426 D.diag_MaybeFallThrough_ReturnsNonVoid =
427 diag::warn_maybe_falloff_nonvoid_lambda;
428 D.diag_AlwaysFallThrough_HasNoReturn =
429 diag::err_noreturn_lambda_has_return_expr;
430 D.diag_AlwaysFallThrough_ReturnsNonVoid =
431 diag::warn_falloff_nonvoid_lambda;
432 D.diag_NeverFallThroughOrReturn = 0;
433 D.funMode = Lambda;
Ted Kremenek918fe842010-03-20 21:06:02 +0000434 return D;
435 }
Ted Kremenek0b405322010-03-23 00:13:23 +0000436
David Blaikie9c902b52011-09-25 23:23:43 +0000437 bool checkDiagnostics(DiagnosticsEngine &D, bool ReturnsVoid,
Ted Kremenek918fe842010-03-20 21:06:02 +0000438 bool HasNoReturn) const {
Douglas Gregorcf11eb72012-02-15 16:20:15 +0000439 if (funMode == Function) {
Argyrios Kyrtzidis1cb0de12010-12-15 18:44:22 +0000440 return (ReturnsVoid ||
441 D.getDiagnosticLevel(diag::warn_maybe_falloff_nonvoid_function,
David Blaikie9c902b52011-09-25 23:23:43 +0000442 FuncLoc) == DiagnosticsEngine::Ignored)
Argyrios Kyrtzidis1cb0de12010-12-15 18:44:22 +0000443 && (!HasNoReturn ||
444 D.getDiagnosticLevel(diag::warn_noreturn_function_has_return_expr,
David Blaikie9c902b52011-09-25 23:23:43 +0000445 FuncLoc) == DiagnosticsEngine::Ignored)
Argyrios Kyrtzidis1cb0de12010-12-15 18:44:22 +0000446 && (!ReturnsVoid ||
447 D.getDiagnosticLevel(diag::warn_suggest_noreturn_block, FuncLoc)
David Blaikie9c902b52011-09-25 23:23:43 +0000448 == DiagnosticsEngine::Ignored);
Ted Kremenek918fe842010-03-20 21:06:02 +0000449 }
Ted Kremenek0b405322010-03-23 00:13:23 +0000450
Douglas Gregorcf11eb72012-02-15 16:20:15 +0000451 // For blocks / lambdas.
452 return ReturnsVoid && !HasNoReturn
453 && ((funMode == Lambda) ||
Argyrios Kyrtzidis1cb0de12010-12-15 18:44:22 +0000454 D.getDiagnosticLevel(diag::warn_suggest_noreturn_block, FuncLoc)
David Blaikie9c902b52011-09-25 23:23:43 +0000455 == DiagnosticsEngine::Ignored);
Ted Kremenek918fe842010-03-20 21:06:02 +0000456 }
457};
458
Dan Gohman28ade552010-07-26 21:25:24 +0000459}
460
Ted Kremenek918fe842010-03-20 21:06:02 +0000461/// CheckFallThroughForFunctionDef - Check that we don't fall off the end of a
462/// function that should return a value. Check that we don't fall off the end
463/// of a noreturn function. We assume that functions and blocks not marked
464/// noreturn will return.
465static void CheckFallThroughForBody(Sema &S, const Decl *D, const Stmt *Body,
Ted Kremenek1767a272011-02-23 01:51:48 +0000466 const BlockExpr *blkExpr,
Ted Kremenek918fe842010-03-20 21:06:02 +0000467 const CheckFallThroughDiagnostics& CD,
Ted Kremenek81ce1c82011-10-24 01:32:45 +0000468 AnalysisDeclContext &AC) {
Ted Kremenek918fe842010-03-20 21:06:02 +0000469
470 bool ReturnsVoid = false;
471 bool HasNoReturn = false;
472
473 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
Alp Toker314cc812014-01-25 16:55:45 +0000474 ReturnsVoid = FD->getReturnType()->isVoidType();
Richard Smith10876ef2013-01-17 01:30:42 +0000475 HasNoReturn = FD->isNoReturn();
Ted Kremenek918fe842010-03-20 21:06:02 +0000476 }
477 else if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
Alp Toker314cc812014-01-25 16:55:45 +0000478 ReturnsVoid = MD->getReturnType()->isVoidType();
Ted Kremenek918fe842010-03-20 21:06:02 +0000479 HasNoReturn = MD->hasAttr<NoReturnAttr>();
480 }
481 else if (isa<BlockDecl>(D)) {
Ted Kremenek1767a272011-02-23 01:51:48 +0000482 QualType BlockTy = blkExpr->getType();
Ted Kremenek0b405322010-03-23 00:13:23 +0000483 if (const FunctionType *FT =
Ted Kremenek918fe842010-03-20 21:06:02 +0000484 BlockTy->getPointeeType()->getAs<FunctionType>()) {
Alp Toker314cc812014-01-25 16:55:45 +0000485 if (FT->getReturnType()->isVoidType())
Ted Kremenek918fe842010-03-20 21:06:02 +0000486 ReturnsVoid = true;
487 if (FT->getNoReturnAttr())
488 HasNoReturn = true;
489 }
490 }
491
David Blaikie9c902b52011-09-25 23:23:43 +0000492 DiagnosticsEngine &Diags = S.getDiagnostics();
Ted Kremenek918fe842010-03-20 21:06:02 +0000493
494 // Short circuit for compilation speed.
495 if (CD.checkDiagnostics(Diags, ReturnsVoid, HasNoReturn))
496 return;
Ted Kremenek0b405322010-03-23 00:13:23 +0000497
Ted Kremenek918fe842010-03-20 21:06:02 +0000498 // FIXME: Function try block
499 if (const CompoundStmt *Compound = dyn_cast<CompoundStmt>(Body)) {
500 switch (CheckFallThrough(AC)) {
John McCall5c6ec8c2010-05-16 09:34:11 +0000501 case UnknownFallThrough:
502 break;
503
Ted Kremenek918fe842010-03-20 21:06:02 +0000504 case MaybeFallThrough:
505 if (HasNoReturn)
506 S.Diag(Compound->getRBracLoc(),
507 CD.diag_MaybeFallThrough_HasNoReturn);
508 else if (!ReturnsVoid)
509 S.Diag(Compound->getRBracLoc(),
510 CD.diag_MaybeFallThrough_ReturnsNonVoid);
511 break;
512 case AlwaysFallThrough:
513 if (HasNoReturn)
514 S.Diag(Compound->getRBracLoc(),
515 CD.diag_AlwaysFallThrough_HasNoReturn);
516 else if (!ReturnsVoid)
517 S.Diag(Compound->getRBracLoc(),
518 CD.diag_AlwaysFallThrough_ReturnsNonVoid);
519 break;
520 case NeverFallThroughOrReturn:
Chandler Carruthc841b6e2011-08-31 09:01:53 +0000521 if (ReturnsVoid && !HasNoReturn && CD.diag_NeverFallThroughOrReturn) {
522 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
523 S.Diag(Compound->getLBracLoc(), CD.diag_NeverFallThroughOrReturn)
Douglas Gregor97e35902011-09-10 00:56:20 +0000524 << 0 << FD;
525 } else if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
526 S.Diag(Compound->getLBracLoc(), CD.diag_NeverFallThroughOrReturn)
527 << 1 << MD;
Chandler Carruthc841b6e2011-08-31 09:01:53 +0000528 } else {
529 S.Diag(Compound->getLBracLoc(), CD.diag_NeverFallThroughOrReturn);
530 }
531 }
Ted Kremenek918fe842010-03-20 21:06:02 +0000532 break;
533 case NeverFallThrough:
534 break;
535 }
536 }
537}
538
539//===----------------------------------------------------------------------===//
Ted Kremenekb749a6d2011-01-15 02:58:47 +0000540// -Wuninitialized
541//===----------------------------------------------------------------------===//
542
Ted Kremenekb8d8c4e2011-04-04 20:56:00 +0000543namespace {
Chandler Carruth4e021822011-04-05 06:48:00 +0000544/// ContainsReference - A visitor class to search for references to
545/// a particular declaration (the needle) within any evaluated component of an
546/// expression (recursively).
Ted Kremenekb8d8c4e2011-04-04 20:56:00 +0000547class ContainsReference : public EvaluatedExprVisitor<ContainsReference> {
Chandler Carruth4e021822011-04-05 06:48:00 +0000548 bool FoundReference;
549 const DeclRefExpr *Needle;
550
Ted Kremenekb8d8c4e2011-04-04 20:56:00 +0000551public:
Chandler Carruth4e021822011-04-05 06:48:00 +0000552 ContainsReference(ASTContext &Context, const DeclRefExpr *Needle)
553 : EvaluatedExprVisitor<ContainsReference>(Context),
554 FoundReference(false), Needle(Needle) {}
555
556 void VisitExpr(Expr *E) {
Ted Kremenekb8d8c4e2011-04-04 20:56:00 +0000557 // Stop evaluating if we already have a reference.
Chandler Carruth4e021822011-04-05 06:48:00 +0000558 if (FoundReference)
Ted Kremenekb8d8c4e2011-04-04 20:56:00 +0000559 return;
Chandler Carruth4e021822011-04-05 06:48:00 +0000560
561 EvaluatedExprVisitor<ContainsReference>::VisitExpr(E);
Ted Kremenekb8d8c4e2011-04-04 20:56:00 +0000562 }
Chandler Carruth4e021822011-04-05 06:48:00 +0000563
564 void VisitDeclRefExpr(DeclRefExpr *E) {
565 if (E == Needle)
566 FoundReference = true;
567 else
568 EvaluatedExprVisitor<ContainsReference>::VisitDeclRefExpr(E);
Ted Kremenekb8d8c4e2011-04-04 20:56:00 +0000569 }
Chandler Carruth4e021822011-04-05 06:48:00 +0000570
571 bool doesContainReference() const { return FoundReference; }
Ted Kremenekb8d8c4e2011-04-04 20:56:00 +0000572};
573}
574
David Blaikiee5f9a9e2011-09-10 05:35:08 +0000575static bool SuggestInitializationFixit(Sema &S, const VarDecl *VD) {
Fariborz Jahanian429fadb2012-03-08 00:22:50 +0000576 QualType VariableTy = VD->getType().getCanonicalType();
577 if (VariableTy->isBlockPointerType() &&
578 !VD->hasAttr<BlocksAttr>()) {
579 S.Diag(VD->getLocation(), diag::note_block_var_fixit_add_initialization) << VD->getDeclName()
580 << FixItHint::CreateInsertion(VD->getLocation(), "__block ");
581 return true;
582 }
Richard Smithf7ec86a2013-09-20 00:27:40 +0000583
David Blaikiee5f9a9e2011-09-10 05:35:08 +0000584 // Don't issue a fixit if there is already an initializer.
585 if (VD->getInit())
586 return false;
Richard Trieu2cdcf822012-05-03 01:09:59 +0000587
588 // Don't suggest a fixit inside macros.
589 if (VD->getLocEnd().isMacroID())
590 return false;
591
Richard Smith8d06f422012-01-12 23:53:29 +0000592 SourceLocation Loc = S.PP.getLocForEndOfToken(VD->getLocEnd());
Richard Smithf7ec86a2013-09-20 00:27:40 +0000593
594 // Suggest possible initialization (if any).
595 std::string Init = S.getFixItZeroInitializerForType(VariableTy, Loc);
596 if (Init.empty())
597 return false;
598
Richard Smith8d06f422012-01-12 23:53:29 +0000599 S.Diag(Loc, diag::note_var_fixit_add_initialization) << VD->getDeclName()
600 << FixItHint::CreateInsertion(Loc, Init);
601 return true;
David Blaikiee5f9a9e2011-09-10 05:35:08 +0000602}
603
Richard Smith1bb8edb82012-05-26 06:20:46 +0000604/// Create a fixit to remove an if-like statement, on the assumption that its
605/// condition is CondVal.
606static void CreateIfFixit(Sema &S, const Stmt *If, const Stmt *Then,
607 const Stmt *Else, bool CondVal,
608 FixItHint &Fixit1, FixItHint &Fixit2) {
609 if (CondVal) {
610 // If condition is always true, remove all but the 'then'.
611 Fixit1 = FixItHint::CreateRemoval(
612 CharSourceRange::getCharRange(If->getLocStart(),
613 Then->getLocStart()));
614 if (Else) {
615 SourceLocation ElseKwLoc = Lexer::getLocForEndOfToken(
616 Then->getLocEnd(), 0, S.getSourceManager(), S.getLangOpts());
617 Fixit2 = FixItHint::CreateRemoval(
618 SourceRange(ElseKwLoc, Else->getLocEnd()));
619 }
620 } else {
621 // If condition is always false, remove all but the 'else'.
622 if (Else)
623 Fixit1 = FixItHint::CreateRemoval(
624 CharSourceRange::getCharRange(If->getLocStart(),
625 Else->getLocStart()));
626 else
627 Fixit1 = FixItHint::CreateRemoval(If->getSourceRange());
628 }
629}
630
631/// DiagUninitUse -- Helper function to produce a diagnostic for an
632/// uninitialized use of a variable.
633static void DiagUninitUse(Sema &S, const VarDecl *VD, const UninitUse &Use,
634 bool IsCapturedByBlock) {
635 bool Diagnosed = false;
636
Richard Smithba8071e2013-09-12 18:49:10 +0000637 switch (Use.getKind()) {
638 case UninitUse::Always:
639 S.Diag(Use.getUser()->getLocStart(), diag::warn_uninit_var)
640 << VD->getDeclName() << IsCapturedByBlock
641 << Use.getUser()->getSourceRange();
642 return;
643
644 case UninitUse::AfterDecl:
645 case UninitUse::AfterCall:
646 S.Diag(VD->getLocation(), diag::warn_sometimes_uninit_var)
647 << VD->getDeclName() << IsCapturedByBlock
648 << (Use.getKind() == UninitUse::AfterDecl ? 4 : 5)
649 << const_cast<DeclContext*>(VD->getLexicalDeclContext())
650 << VD->getSourceRange();
651 S.Diag(Use.getUser()->getLocStart(), diag::note_uninit_var_use)
652 << IsCapturedByBlock << Use.getUser()->getSourceRange();
653 return;
654
655 case UninitUse::Maybe:
656 case UninitUse::Sometimes:
657 // Carry on to report sometimes-uninitialized branches, if possible,
658 // or a 'may be used uninitialized' diagnostic otherwise.
659 break;
660 }
661
Richard Smith1bb8edb82012-05-26 06:20:46 +0000662 // Diagnose each branch which leads to a sometimes-uninitialized use.
Richard Smith4323bf82012-05-25 02:17:09 +0000663 for (UninitUse::branch_iterator I = Use.branch_begin(), E = Use.branch_end();
664 I != E; ++I) {
Richard Smith1bb8edb82012-05-26 06:20:46 +0000665 assert(Use.getKind() == UninitUse::Sometimes);
666
667 const Expr *User = Use.getUser();
Richard Smith4323bf82012-05-25 02:17:09 +0000668 const Stmt *Term = I->Terminator;
Richard Smith1bb8edb82012-05-26 06:20:46 +0000669
670 // Information used when building the diagnostic.
Richard Smith4323bf82012-05-25 02:17:09 +0000671 unsigned DiagKind;
David Blaikie1d202a62012-10-08 01:11:04 +0000672 StringRef Str;
Richard Smith1bb8edb82012-05-26 06:20:46 +0000673 SourceRange Range;
674
Stefanus Du Toitb3318502013-03-01 21:41:22 +0000675 // FixIts to suppress the diagnostic by removing the dead condition.
Richard Smith1bb8edb82012-05-26 06:20:46 +0000676 // For all binary terminators, branch 0 is taken if the condition is true,
677 // and branch 1 is taken if the condition is false.
678 int RemoveDiagKind = -1;
679 const char *FixitStr =
680 S.getLangOpts().CPlusPlus ? (I->Output ? "true" : "false")
681 : (I->Output ? "1" : "0");
682 FixItHint Fixit1, Fixit2;
683
Richard Smithba8071e2013-09-12 18:49:10 +0000684 switch (Term ? Term->getStmtClass() : Stmt::DeclStmtClass) {
Richard Smith4323bf82012-05-25 02:17:09 +0000685 default:
Richard Smith1bb8edb82012-05-26 06:20:46 +0000686 // Don't know how to report this. Just fall back to 'may be used
Richard Smithba8071e2013-09-12 18:49:10 +0000687 // uninitialized'. FIXME: Can this happen?
Richard Smith4323bf82012-05-25 02:17:09 +0000688 continue;
689
690 // "condition is true / condition is false".
Richard Smith1bb8edb82012-05-26 06:20:46 +0000691 case Stmt::IfStmtClass: {
692 const IfStmt *IS = cast<IfStmt>(Term);
Richard Smith4323bf82012-05-25 02:17:09 +0000693 DiagKind = 0;
694 Str = "if";
Richard Smith1bb8edb82012-05-26 06:20:46 +0000695 Range = IS->getCond()->getSourceRange();
696 RemoveDiagKind = 0;
697 CreateIfFixit(S, IS, IS->getThen(), IS->getElse(),
698 I->Output, Fixit1, Fixit2);
Richard Smith4323bf82012-05-25 02:17:09 +0000699 break;
Richard Smith1bb8edb82012-05-26 06:20:46 +0000700 }
701 case Stmt::ConditionalOperatorClass: {
702 const ConditionalOperator *CO = cast<ConditionalOperator>(Term);
Richard Smith4323bf82012-05-25 02:17:09 +0000703 DiagKind = 0;
704 Str = "?:";
Richard Smith1bb8edb82012-05-26 06:20:46 +0000705 Range = CO->getCond()->getSourceRange();
706 RemoveDiagKind = 0;
707 CreateIfFixit(S, CO, CO->getTrueExpr(), CO->getFalseExpr(),
708 I->Output, Fixit1, Fixit2);
Richard Smith4323bf82012-05-25 02:17:09 +0000709 break;
Richard Smith1bb8edb82012-05-26 06:20:46 +0000710 }
Richard Smith4323bf82012-05-25 02:17:09 +0000711 case Stmt::BinaryOperatorClass: {
712 const BinaryOperator *BO = cast<BinaryOperator>(Term);
713 if (!BO->isLogicalOp())
714 continue;
715 DiagKind = 0;
716 Str = BO->getOpcodeStr();
717 Range = BO->getLHS()->getSourceRange();
Richard Smith1bb8edb82012-05-26 06:20:46 +0000718 RemoveDiagKind = 0;
719 if ((BO->getOpcode() == BO_LAnd && I->Output) ||
720 (BO->getOpcode() == BO_LOr && !I->Output))
721 // true && y -> y, false || y -> y.
722 Fixit1 = FixItHint::CreateRemoval(SourceRange(BO->getLocStart(),
723 BO->getOperatorLoc()));
724 else
725 // false && y -> false, true || y -> true.
726 Fixit1 = FixItHint::CreateReplacement(BO->getSourceRange(), FixitStr);
Richard Smith4323bf82012-05-25 02:17:09 +0000727 break;
728 }
729
730 // "loop is entered / loop is exited".
731 case Stmt::WhileStmtClass:
732 DiagKind = 1;
733 Str = "while";
734 Range = cast<WhileStmt>(Term)->getCond()->getSourceRange();
Richard Smith1bb8edb82012-05-26 06:20:46 +0000735 RemoveDiagKind = 1;
736 Fixit1 = FixItHint::CreateReplacement(Range, FixitStr);
Richard Smith4323bf82012-05-25 02:17:09 +0000737 break;
738 case Stmt::ForStmtClass:
739 DiagKind = 1;
740 Str = "for";
741 Range = cast<ForStmt>(Term)->getCond()->getSourceRange();
Richard Smith1bb8edb82012-05-26 06:20:46 +0000742 RemoveDiagKind = 1;
743 if (I->Output)
744 Fixit1 = FixItHint::CreateRemoval(Range);
745 else
746 Fixit1 = FixItHint::CreateReplacement(Range, FixitStr);
Richard Smith4323bf82012-05-25 02:17:09 +0000747 break;
Richard Smithba8071e2013-09-12 18:49:10 +0000748 case Stmt::CXXForRangeStmtClass:
749 if (I->Output == 1) {
750 // The use occurs if a range-based for loop's body never executes.
751 // That may be impossible, and there's no syntactic fix for this,
752 // so treat it as a 'may be uninitialized' case.
753 continue;
754 }
755 DiagKind = 1;
756 Str = "for";
757 Range = cast<CXXForRangeStmt>(Term)->getRangeInit()->getSourceRange();
758 break;
Richard Smith4323bf82012-05-25 02:17:09 +0000759
760 // "condition is true / loop is exited".
761 case Stmt::DoStmtClass:
762 DiagKind = 2;
763 Str = "do";
764 Range = cast<DoStmt>(Term)->getCond()->getSourceRange();
Richard Smith1bb8edb82012-05-26 06:20:46 +0000765 RemoveDiagKind = 1;
766 Fixit1 = FixItHint::CreateReplacement(Range, FixitStr);
Richard Smith4323bf82012-05-25 02:17:09 +0000767 break;
768
769 // "switch case is taken".
770 case Stmt::CaseStmtClass:
771 DiagKind = 3;
772 Str = "case";
773 Range = cast<CaseStmt>(Term)->getLHS()->getSourceRange();
774 break;
775 case Stmt::DefaultStmtClass:
776 DiagKind = 3;
777 Str = "default";
778 Range = cast<DefaultStmt>(Term)->getDefaultLoc();
779 break;
780 }
781
Richard Smith1bb8edb82012-05-26 06:20:46 +0000782 S.Diag(Range.getBegin(), diag::warn_sometimes_uninit_var)
783 << VD->getDeclName() << IsCapturedByBlock << DiagKind
784 << Str << I->Output << Range;
785 S.Diag(User->getLocStart(), diag::note_uninit_var_use)
786 << IsCapturedByBlock << User->getSourceRange();
787 if (RemoveDiagKind != -1)
788 S.Diag(Fixit1.RemoveRange.getBegin(), diag::note_uninit_fixit_remove_cond)
789 << RemoveDiagKind << Str << I->Output << Fixit1 << Fixit2;
790
791 Diagnosed = true;
Richard Smith4323bf82012-05-25 02:17:09 +0000792 }
Richard Smith1bb8edb82012-05-26 06:20:46 +0000793
794 if (!Diagnosed)
Richard Smithba8071e2013-09-12 18:49:10 +0000795 S.Diag(Use.getUser()->getLocStart(), diag::warn_maybe_uninit_var)
Richard Smith1bb8edb82012-05-26 06:20:46 +0000796 << VD->getDeclName() << IsCapturedByBlock
797 << Use.getUser()->getSourceRange();
Richard Smith4323bf82012-05-25 02:17:09 +0000798}
799
Chandler Carruthdd8f0d02011-04-05 18:27:05 +0000800/// DiagnoseUninitializedUse -- Helper function for diagnosing uses of an
801/// uninitialized variable. This manages the different forms of diagnostic
802/// emitted for particular types of uses. Returns true if the use was diagnosed
Richard Smith4323bf82012-05-25 02:17:09 +0000803/// as a warning. If a particular use is one we omit warnings for, returns
Chandler Carruthdd8f0d02011-04-05 18:27:05 +0000804/// false.
805static bool DiagnoseUninitializedUse(Sema &S, const VarDecl *VD,
Richard Smith4323bf82012-05-25 02:17:09 +0000806 const UninitUse &Use,
Ted Kremenek596fa162011-10-13 18:50:06 +0000807 bool alwaysReportSelfInit = false) {
Chandler Carruth895904da2011-04-05 18:18:05 +0000808
Richard Smith4323bf82012-05-25 02:17:09 +0000809 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Use.getUser())) {
Richard Trieu43a2fc72012-05-09 21:08:22 +0000810 // Inspect the initializer of the variable declaration which is
811 // being referenced prior to its initialization. We emit
812 // specialized diagnostics for self-initialization, and we
813 // specifically avoid warning about self references which take the
814 // form of:
815 //
816 // int x = x;
817 //
818 // This is used to indicate to GCC that 'x' is intentionally left
819 // uninitialized. Proven code paths which access 'x' in
820 // an uninitialized state after this will still warn.
821 if (const Expr *Initializer = VD->getInit()) {
822 if (!alwaysReportSelfInit && DRE == Initializer->IgnoreParenImpCasts())
823 return false;
Chandler Carruth895904da2011-04-05 18:18:05 +0000824
Richard Trieu43a2fc72012-05-09 21:08:22 +0000825 ContainsReference CR(S.Context, DRE);
826 CR.Visit(const_cast<Expr*>(Initializer));
827 if (CR.doesContainReference()) {
Chandler Carruth895904da2011-04-05 18:18:05 +0000828 S.Diag(DRE->getLocStart(),
829 diag::warn_uninit_self_reference_in_init)
Richard Trieu43a2fc72012-05-09 21:08:22 +0000830 << VD->getDeclName() << VD->getLocation() << DRE->getSourceRange();
831 return true;
Chandler Carruth895904da2011-04-05 18:18:05 +0000832 }
Chandler Carruth895904da2011-04-05 18:18:05 +0000833 }
Richard Trieu43a2fc72012-05-09 21:08:22 +0000834
Richard Smith1bb8edb82012-05-26 06:20:46 +0000835 DiagUninitUse(S, VD, Use, false);
Chandler Carruth895904da2011-04-05 18:18:05 +0000836 } else {
Richard Smith4323bf82012-05-25 02:17:09 +0000837 const BlockExpr *BE = cast<BlockExpr>(Use.getUser());
Richard Smith1bb8edb82012-05-26 06:20:46 +0000838 if (VD->getType()->isBlockPointerType() && !VD->hasAttr<BlocksAttr>())
839 S.Diag(BE->getLocStart(),
840 diag::warn_uninit_byref_blockvar_captured_by_block)
Fariborz Jahanian429fadb2012-03-08 00:22:50 +0000841 << VD->getDeclName();
Richard Smith1bb8edb82012-05-26 06:20:46 +0000842 else
843 DiagUninitUse(S, VD, Use, true);
Chandler Carruth895904da2011-04-05 18:18:05 +0000844 }
845
846 // Report where the variable was declared when the use wasn't within
David Blaikiee5f9a9e2011-09-10 05:35:08 +0000847 // the initializer of that declaration & we didn't already suggest
848 // an initialization fixit.
Richard Trieu43a2fc72012-05-09 21:08:22 +0000849 if (!SuggestInitializationFixit(S, VD))
Chandler Carruth895904da2011-04-05 18:18:05 +0000850 S.Diag(VD->getLocStart(), diag::note_uninit_var_def)
851 << VD->getDeclName();
852
Chandler Carruthdd8f0d02011-04-05 18:27:05 +0000853 return true;
Chandler Carruth7a037202011-04-05 18:18:08 +0000854}
855
Richard Smith84837d52012-05-03 18:27:39 +0000856namespace {
857 class FallthroughMapper : public RecursiveASTVisitor<FallthroughMapper> {
858 public:
859 FallthroughMapper(Sema &S)
860 : FoundSwitchStatements(false),
861 S(S) {
862 }
863
864 bool foundSwitchStatements() const { return FoundSwitchStatements; }
865
866 void markFallthroughVisited(const AttributedStmt *Stmt) {
867 bool Found = FallthroughStmts.erase(Stmt);
868 assert(Found);
Kaelyn Uhrain29a8eeb2012-05-03 19:46:38 +0000869 (void)Found;
Richard Smith84837d52012-05-03 18:27:39 +0000870 }
871
872 typedef llvm::SmallPtrSet<const AttributedStmt*, 8> AttrStmts;
873
874 const AttrStmts &getFallthroughStmts() const {
875 return FallthroughStmts;
876 }
877
Alexander Kornienkoafed1dd2013-01-30 03:49:44 +0000878 void fillReachableBlocks(CFG *Cfg) {
879 assert(ReachableBlocks.empty() && "ReachableBlocks already filled");
880 std::deque<const CFGBlock *> BlockQueue;
881
882 ReachableBlocks.insert(&Cfg->getEntry());
883 BlockQueue.push_back(&Cfg->getEntry());
Alexander Kornienkoc121b9b2013-02-07 02:17:19 +0000884 // Mark all case blocks reachable to avoid problems with switching on
885 // constants, covered enums, etc.
886 // These blocks can contain fall-through annotations, and we don't want to
887 // issue a warn_fallthrough_attr_unreachable for them.
888 for (CFG::iterator I = Cfg->begin(), E = Cfg->end(); I != E; ++I) {
889 const CFGBlock *B = *I;
890 const Stmt *L = B->getLabel();
891 if (L && isa<SwitchCase>(L) && ReachableBlocks.insert(B))
892 BlockQueue.push_back(B);
893 }
894
Alexander Kornienkoafed1dd2013-01-30 03:49:44 +0000895 while (!BlockQueue.empty()) {
896 const CFGBlock *P = BlockQueue.front();
897 BlockQueue.pop_front();
898 for (CFGBlock::const_succ_iterator I = P->succ_begin(),
899 E = P->succ_end();
900 I != E; ++I) {
Alexander Kornienko527fa4f2013-02-01 15:39:20 +0000901 if (*I && ReachableBlocks.insert(*I))
Alexander Kornienkoafed1dd2013-01-30 03:49:44 +0000902 BlockQueue.push_back(*I);
903 }
904 }
905 }
906
Richard Smith84837d52012-05-03 18:27:39 +0000907 bool checkFallThroughIntoBlock(const CFGBlock &B, int &AnnotatedCnt) {
Alexander Kornienkoafed1dd2013-01-30 03:49:44 +0000908 assert(!ReachableBlocks.empty() && "ReachableBlocks empty");
909
Richard Smith84837d52012-05-03 18:27:39 +0000910 int UnannotatedCnt = 0;
911 AnnotatedCnt = 0;
912
913 std::deque<const CFGBlock*> BlockQueue;
914
915 std::copy(B.pred_begin(), B.pred_end(), std::back_inserter(BlockQueue));
916
917 while (!BlockQueue.empty()) {
918 const CFGBlock *P = BlockQueue.front();
919 BlockQueue.pop_front();
Nick Lewyckycdf11082014-02-27 02:43:25 +0000920 if (!P) continue;
Richard Smith84837d52012-05-03 18:27:39 +0000921
922 const Stmt *Term = P->getTerminator();
923 if (Term && isa<SwitchStmt>(Term))
924 continue; // Switch statement, good.
925
926 const SwitchCase *SW = dyn_cast_or_null<SwitchCase>(P->getLabel());
927 if (SW && SW->getSubStmt() == B.getLabel() && P->begin() == P->end())
928 continue; // Previous case label has no statements, good.
929
Alexander Kornienko09f15f32013-01-25 20:44:56 +0000930 const LabelStmt *L = dyn_cast_or_null<LabelStmt>(P->getLabel());
931 if (L && L->getSubStmt() == B.getLabel() && P->begin() == P->end())
932 continue; // Case label is preceded with a normal label, good.
933
Alexander Kornienkoafed1dd2013-01-30 03:49:44 +0000934 if (!ReachableBlocks.count(P)) {
Alexander Kornienkoc121b9b2013-02-07 02:17:19 +0000935 for (CFGBlock::const_reverse_iterator ElemIt = P->rbegin(),
936 ElemEnd = P->rend();
937 ElemIt != ElemEnd; ++ElemIt) {
David Blaikie00be69a2013-02-23 00:29:34 +0000938 if (Optional<CFGStmt> CS = ElemIt->getAs<CFGStmt>()) {
939 if (const AttributedStmt *AS = asFallThroughAttr(CS->getStmt())) {
Richard Smith84837d52012-05-03 18:27:39 +0000940 S.Diag(AS->getLocStart(),
941 diag::warn_fallthrough_attr_unreachable);
942 markFallthroughVisited(AS);
943 ++AnnotatedCnt;
Alexander Kornienkoc121b9b2013-02-07 02:17:19 +0000944 break;
Richard Smith84837d52012-05-03 18:27:39 +0000945 }
946 // Don't care about other unreachable statements.
947 }
948 }
949 // If there are no unreachable statements, this may be a special
950 // case in CFG:
951 // case X: {
952 // A a; // A has a destructor.
953 // break;
954 // }
955 // // <<<< This place is represented by a 'hanging' CFG block.
956 // case Y:
957 continue;
958 }
959
960 const Stmt *LastStmt = getLastStmt(*P);
961 if (const AttributedStmt *AS = asFallThroughAttr(LastStmt)) {
962 markFallthroughVisited(AS);
963 ++AnnotatedCnt;
964 continue; // Fallthrough annotation, good.
965 }
966
967 if (!LastStmt) { // This block contains no executable statements.
968 // Traverse its predecessors.
969 std::copy(P->pred_begin(), P->pred_end(),
970 std::back_inserter(BlockQueue));
971 continue;
972 }
973
974 ++UnannotatedCnt;
975 }
976 return !!UnannotatedCnt;
977 }
978
979 // RecursiveASTVisitor setup.
980 bool shouldWalkTypesOfTypeLocs() const { return false; }
981
982 bool VisitAttributedStmt(AttributedStmt *S) {
983 if (asFallThroughAttr(S))
984 FallthroughStmts.insert(S);
985 return true;
986 }
987
988 bool VisitSwitchStmt(SwitchStmt *S) {
989 FoundSwitchStatements = true;
990 return true;
991 }
992
Alexander Kornienkoa9c809f2013-04-02 15:20:32 +0000993 // We don't want to traverse local type declarations. We analyze their
994 // methods separately.
995 bool TraverseDecl(Decl *D) { return true; }
996
Richard Smith84837d52012-05-03 18:27:39 +0000997 private:
998
999 static const AttributedStmt *asFallThroughAttr(const Stmt *S) {
1000 if (const AttributedStmt *AS = dyn_cast_or_null<AttributedStmt>(S)) {
1001 if (hasSpecificAttr<FallThroughAttr>(AS->getAttrs()))
1002 return AS;
1003 }
1004 return 0;
1005 }
1006
1007 static const Stmt *getLastStmt(const CFGBlock &B) {
1008 if (const Stmt *Term = B.getTerminator())
1009 return Term;
1010 for (CFGBlock::const_reverse_iterator ElemIt = B.rbegin(),
1011 ElemEnd = B.rend();
1012 ElemIt != ElemEnd; ++ElemIt) {
David Blaikie00be69a2013-02-23 00:29:34 +00001013 if (Optional<CFGStmt> CS = ElemIt->getAs<CFGStmt>())
1014 return CS->getStmt();
Richard Smith84837d52012-05-03 18:27:39 +00001015 }
1016 // Workaround to detect a statement thrown out by CFGBuilder:
1017 // case X: {} case Y:
1018 // case X: ; case Y:
1019 if (const SwitchCase *SW = dyn_cast_or_null<SwitchCase>(B.getLabel()))
1020 if (!isa<SwitchCase>(SW->getSubStmt()))
1021 return SW->getSubStmt();
1022
1023 return 0;
1024 }
1025
1026 bool FoundSwitchStatements;
1027 AttrStmts FallthroughStmts;
1028 Sema &S;
Alexander Kornienkoafed1dd2013-01-30 03:49:44 +00001029 llvm::SmallPtrSet<const CFGBlock *, 16> ReachableBlocks;
Richard Smith84837d52012-05-03 18:27:39 +00001030 };
1031}
1032
Alexander Kornienko06caf7d2012-06-02 01:01:07 +00001033static void DiagnoseSwitchLabelsFallthrough(Sema &S, AnalysisDeclContext &AC,
Alexis Hunt2178f142012-06-15 21:22:05 +00001034 bool PerFunction) {
Ted Kremenekda5919f2012-11-12 21:20:48 +00001035 // Only perform this analysis when using C++11. There is no good workflow
1036 // for this warning when not using C++11. There is no good way to silence
1037 // the warning (no attribute is available) unless we are using C++11's support
1038 // for generalized attributes. Once could use pragmas to silence the warning,
1039 // but as a general solution that is gross and not in the spirit of this
1040 // warning.
1041 //
1042 // NOTE: This an intermediate solution. There are on-going discussions on
1043 // how to properly support this warning outside of C++11 with an annotation.
Richard Smith2bf7fdb2013-01-02 11:42:31 +00001044 if (!AC.getASTContext().getLangOpts().CPlusPlus11)
Ted Kremenekda5919f2012-11-12 21:20:48 +00001045 return;
1046
Richard Smith84837d52012-05-03 18:27:39 +00001047 FallthroughMapper FM(S);
1048 FM.TraverseStmt(AC.getBody());
1049
1050 if (!FM.foundSwitchStatements())
1051 return;
1052
Alexis Hunt2178f142012-06-15 21:22:05 +00001053 if (PerFunction && FM.getFallthroughStmts().empty())
Alexander Kornienko06caf7d2012-06-02 01:01:07 +00001054 return;
1055
Richard Smith84837d52012-05-03 18:27:39 +00001056 CFG *Cfg = AC.getCFG();
1057
1058 if (!Cfg)
1059 return;
1060
Alexander Kornienkoafed1dd2013-01-30 03:49:44 +00001061 FM.fillReachableBlocks(Cfg);
Richard Smith84837d52012-05-03 18:27:39 +00001062
1063 for (CFG::reverse_iterator I = Cfg->rbegin(), E = Cfg->rend(); I != E; ++I) {
Alexander Kornienko55488792013-01-25 15:49:34 +00001064 const CFGBlock *B = *I;
1065 const Stmt *Label = B->getLabel();
Richard Smith84837d52012-05-03 18:27:39 +00001066
1067 if (!Label || !isa<SwitchCase>(Label))
1068 continue;
1069
Alexander Kornienkoafed1dd2013-01-30 03:49:44 +00001070 int AnnotatedCnt;
1071
Alexander Kornienko55488792013-01-25 15:49:34 +00001072 if (!FM.checkFallThroughIntoBlock(*B, AnnotatedCnt))
Richard Smith84837d52012-05-03 18:27:39 +00001073 continue;
1074
Alexander Kornienko06caf7d2012-06-02 01:01:07 +00001075 S.Diag(Label->getLocStart(),
Alexis Hunt2178f142012-06-15 21:22:05 +00001076 PerFunction ? diag::warn_unannotated_fallthrough_per_function
1077 : diag::warn_unannotated_fallthrough);
Richard Smith84837d52012-05-03 18:27:39 +00001078
1079 if (!AnnotatedCnt) {
1080 SourceLocation L = Label->getLocStart();
1081 if (L.isMacroID())
1082 continue;
Richard Smith2bf7fdb2013-01-02 11:42:31 +00001083 if (S.getLangOpts().CPlusPlus11) {
Alexander Kornienko55488792013-01-25 15:49:34 +00001084 const Stmt *Term = B->getTerminator();
1085 // Skip empty cases.
1086 while (B->empty() && !Term && B->succ_size() == 1) {
1087 B = *B->succ_begin();
1088 Term = B->getTerminator();
1089 }
1090 if (!(B->empty() && Term && isa<BreakStmt>(Term))) {
Alexander Kornienkoe61e5622012-09-28 22:24:03 +00001091 Preprocessor &PP = S.getPreprocessor();
1092 TokenValue Tokens[] = {
1093 tok::l_square, tok::l_square, PP.getIdentifierInfo("clang"),
1094 tok::coloncolon, PP.getIdentifierInfo("fallthrough"),
1095 tok::r_square, tok::r_square
1096 };
Dmitri Gribenko6743e042012-09-29 11:40:46 +00001097 StringRef AnnotationSpelling = "[[clang::fallthrough]]";
1098 StringRef MacroName = PP.getLastMacroWithSpelling(L, Tokens);
1099 if (!MacroName.empty())
1100 AnnotationSpelling = MacroName;
1101 SmallString<64> TextToInsert(AnnotationSpelling);
1102 TextToInsert += "; ";
Alexander Kornienko246e85d2012-05-26 00:49:15 +00001103 S.Diag(L, diag::note_insert_fallthrough_fixit) <<
Alexander Kornienkoe61e5622012-09-28 22:24:03 +00001104 AnnotationSpelling <<
Dmitri Gribenko6743e042012-09-29 11:40:46 +00001105 FixItHint::CreateInsertion(L, TextToInsert);
Alexander Kornienko246e85d2012-05-26 00:49:15 +00001106 }
Richard Smith84837d52012-05-03 18:27:39 +00001107 }
1108 S.Diag(L, diag::note_insert_break_fixit) <<
1109 FixItHint::CreateInsertion(L, "break; ");
1110 }
1111 }
1112
1113 const FallthroughMapper::AttrStmts &Fallthroughs = FM.getFallthroughStmts();
1114 for (FallthroughMapper::AttrStmts::const_iterator I = Fallthroughs.begin(),
1115 E = Fallthroughs.end();
1116 I != E; ++I) {
1117 S.Diag((*I)->getLocStart(), diag::warn_fallthrough_attr_invalid_placement);
1118 }
1119
1120}
1121
Jordan Rose25c0ea82012-10-29 17:46:47 +00001122static bool isInLoop(const ASTContext &Ctx, const ParentMap &PM,
1123 const Stmt *S) {
Jordan Rose76831c62012-10-11 16:10:19 +00001124 assert(S);
1125
1126 do {
1127 switch (S->getStmtClass()) {
Jordan Rose76831c62012-10-11 16:10:19 +00001128 case Stmt::ForStmtClass:
1129 case Stmt::WhileStmtClass:
1130 case Stmt::CXXForRangeStmtClass:
1131 case Stmt::ObjCForCollectionStmtClass:
1132 return true;
Jordan Rose25c0ea82012-10-29 17:46:47 +00001133 case Stmt::DoStmtClass: {
1134 const Expr *Cond = cast<DoStmt>(S)->getCond();
1135 llvm::APSInt Val;
1136 if (!Cond->EvaluateAsInt(Val, Ctx))
1137 return true;
1138 return Val.getBoolValue();
1139 }
Jordan Rose76831c62012-10-11 16:10:19 +00001140 default:
1141 break;
1142 }
1143 } while ((S = PM.getParent(S)));
1144
1145 return false;
1146}
1147
Jordan Rosed3934582012-09-28 22:21:30 +00001148
1149static void diagnoseRepeatedUseOfWeak(Sema &S,
1150 const sema::FunctionScopeInfo *CurFn,
Jordan Rose76831c62012-10-11 16:10:19 +00001151 const Decl *D,
1152 const ParentMap &PM) {
Jordan Rosed3934582012-09-28 22:21:30 +00001153 typedef sema::FunctionScopeInfo::WeakObjectProfileTy WeakObjectProfileTy;
1154 typedef sema::FunctionScopeInfo::WeakObjectUseMap WeakObjectUseMap;
1155 typedef sema::FunctionScopeInfo::WeakUseVector WeakUseVector;
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001156 typedef std::pair<const Stmt *, WeakObjectUseMap::const_iterator>
1157 StmtUsesPair;
Jordan Rosed3934582012-09-28 22:21:30 +00001158
Jordan Rose25c0ea82012-10-29 17:46:47 +00001159 ASTContext &Ctx = S.getASTContext();
1160
Jordan Rosed3934582012-09-28 22:21:30 +00001161 const WeakObjectUseMap &WeakMap = CurFn->getWeakObjectUses();
1162
1163 // Extract all weak objects that are referenced more than once.
1164 SmallVector<StmtUsesPair, 8> UsesByStmt;
1165 for (WeakObjectUseMap::const_iterator I = WeakMap.begin(), E = WeakMap.end();
1166 I != E; ++I) {
1167 const WeakUseVector &Uses = I->second;
Jordan Rosed3934582012-09-28 22:21:30 +00001168
1169 // Find the first read of the weak object.
1170 WeakUseVector::const_iterator UI = Uses.begin(), UE = Uses.end();
1171 for ( ; UI != UE; ++UI) {
1172 if (UI->isUnsafe())
1173 break;
1174 }
1175
1176 // If there were only writes to this object, don't warn.
1177 if (UI == UE)
1178 continue;
1179
Jordan Rose76831c62012-10-11 16:10:19 +00001180 // If there was only one read, followed by any number of writes, and the
Jordan Rose25c0ea82012-10-29 17:46:47 +00001181 // read is not within a loop, don't warn. Additionally, don't warn in a
1182 // loop if the base object is a local variable -- local variables are often
1183 // changed in loops.
Jordan Rose76831c62012-10-11 16:10:19 +00001184 if (UI == Uses.begin()) {
1185 WeakUseVector::const_iterator UI2 = UI;
1186 for (++UI2; UI2 != UE; ++UI2)
1187 if (UI2->isUnsafe())
1188 break;
1189
Jordan Rose25c0ea82012-10-29 17:46:47 +00001190 if (UI2 == UE) {
1191 if (!isInLoop(Ctx, PM, UI->getUseExpr()))
Jordan Rose76831c62012-10-11 16:10:19 +00001192 continue;
Jordan Rose25c0ea82012-10-29 17:46:47 +00001193
1194 const WeakObjectProfileTy &Profile = I->first;
1195 if (!Profile.isExactProfile())
1196 continue;
1197
1198 const NamedDecl *Base = Profile.getBase();
1199 if (!Base)
1200 Base = Profile.getProperty();
1201 assert(Base && "A profile always has a base or property.");
1202
1203 if (const VarDecl *BaseVar = dyn_cast<VarDecl>(Base))
1204 if (BaseVar->hasLocalStorage() && !isa<ParmVarDecl>(Base))
1205 continue;
1206 }
Jordan Rose76831c62012-10-11 16:10:19 +00001207 }
1208
Jordan Rosed3934582012-09-28 22:21:30 +00001209 UsesByStmt.push_back(StmtUsesPair(UI->getUseExpr(), I));
1210 }
1211
1212 if (UsesByStmt.empty())
1213 return;
1214
1215 // Sort by first use so that we emit the warnings in a deterministic order.
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001216 SourceManager &SM = S.getSourceManager();
Jordan Rosed3934582012-09-28 22:21:30 +00001217 std::sort(UsesByStmt.begin(), UsesByStmt.end(),
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001218 [&SM](const StmtUsesPair &LHS, const StmtUsesPair &RHS) {
1219 return SM.isBeforeInTranslationUnit(LHS.first->getLocStart(),
1220 RHS.first->getLocStart());
1221 });
Jordan Rosed3934582012-09-28 22:21:30 +00001222
1223 // Classify the current code body for better warning text.
1224 // This enum should stay in sync with the cases in
1225 // warn_arc_repeated_use_of_weak and warn_arc_possible_repeated_use_of_weak.
1226 // FIXME: Should we use a common classification enum and the same set of
1227 // possibilities all throughout Sema?
1228 enum {
1229 Function,
1230 Method,
1231 Block,
1232 Lambda
1233 } FunctionKind;
1234
1235 if (isa<sema::BlockScopeInfo>(CurFn))
1236 FunctionKind = Block;
1237 else if (isa<sema::LambdaScopeInfo>(CurFn))
1238 FunctionKind = Lambda;
1239 else if (isa<ObjCMethodDecl>(D))
1240 FunctionKind = Method;
1241 else
1242 FunctionKind = Function;
1243
1244 // Iterate through the sorted problems and emit warnings for each.
1245 for (SmallVectorImpl<StmtUsesPair>::const_iterator I = UsesByStmt.begin(),
1246 E = UsesByStmt.end();
1247 I != E; ++I) {
1248 const Stmt *FirstRead = I->first;
1249 const WeakObjectProfileTy &Key = I->second->first;
1250 const WeakUseVector &Uses = I->second->second;
1251
Jordan Rose657b5f42012-09-28 22:21:35 +00001252 // For complicated expressions like 'a.b.c' and 'x.b.c', WeakObjectProfileTy
1253 // may not contain enough information to determine that these are different
1254 // properties. We can only be 100% sure of a repeated use in certain cases,
1255 // and we adjust the diagnostic kind accordingly so that the less certain
1256 // case can be turned off if it is too noisy.
Jordan Rosed3934582012-09-28 22:21:30 +00001257 unsigned DiagKind;
1258 if (Key.isExactProfile())
1259 DiagKind = diag::warn_arc_repeated_use_of_weak;
1260 else
1261 DiagKind = diag::warn_arc_possible_repeated_use_of_weak;
1262
Jordan Rose657b5f42012-09-28 22:21:35 +00001263 // Classify the weak object being accessed for better warning text.
1264 // This enum should stay in sync with the cases in
1265 // warn_arc_repeated_use_of_weak and warn_arc_possible_repeated_use_of_weak.
1266 enum {
1267 Variable,
1268 Property,
1269 ImplicitProperty,
1270 Ivar
1271 } ObjectKind;
1272
1273 const NamedDecl *D = Key.getProperty();
1274 if (isa<VarDecl>(D))
1275 ObjectKind = Variable;
1276 else if (isa<ObjCPropertyDecl>(D))
1277 ObjectKind = Property;
1278 else if (isa<ObjCMethodDecl>(D))
1279 ObjectKind = ImplicitProperty;
1280 else if (isa<ObjCIvarDecl>(D))
1281 ObjectKind = Ivar;
1282 else
1283 llvm_unreachable("Unexpected weak object kind!");
1284
Jordan Rosed3934582012-09-28 22:21:30 +00001285 // Show the first time the object was read.
1286 S.Diag(FirstRead->getLocStart(), DiagKind)
Joerg Sonnenbergerffc6d492013-06-26 21:31:47 +00001287 << int(ObjectKind) << D << int(FunctionKind)
Jordan Rosed3934582012-09-28 22:21:30 +00001288 << FirstRead->getSourceRange();
1289
1290 // Print all the other accesses as notes.
1291 for (WeakUseVector::const_iterator UI = Uses.begin(), UE = Uses.end();
1292 UI != UE; ++UI) {
1293 if (UI->getUseExpr() == FirstRead)
1294 continue;
1295 S.Diag(UI->getUseExpr()->getLocStart(),
1296 diag::note_arc_weak_also_accessed_here)
1297 << UI->getUseExpr()->getSourceRange();
1298 }
1299 }
1300}
1301
Jordan Rosed3934582012-09-28 22:21:30 +00001302namespace {
Ted Kremenekb749a6d2011-01-15 02:58:47 +00001303class UninitValsDiagReporter : public UninitVariablesHandler {
1304 Sema &S;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001305 typedef SmallVector<UninitUse, 2> UsesVec;
Benjamin Kramereb8c4462013-06-29 17:52:13 +00001306 typedef llvm::PointerIntPair<UsesVec *, 1, bool> MappedType;
Enea Zaffanella2f40be72013-02-15 20:09:55 +00001307 // Prefer using MapVector to DenseMap, so that iteration order will be
1308 // the same as insertion order. This is needed to obtain a deterministic
1309 // order of diagnostics when calling flushDiagnostics().
1310 typedef llvm::MapVector<const VarDecl *, MappedType> UsesMap;
Ted Kremenek39fa0562011-01-21 19:41:41 +00001311 UsesMap *uses;
1312
Ted Kremenekb749a6d2011-01-15 02:58:47 +00001313public:
Ted Kremenek39fa0562011-01-21 19:41:41 +00001314 UninitValsDiagReporter(Sema &S) : S(S), uses(0) {}
1315 ~UninitValsDiagReporter() {
1316 flushDiagnostics();
1317 }
Ted Kremenek596fa162011-10-13 18:50:06 +00001318
Enea Zaffanella2f40be72013-02-15 20:09:55 +00001319 MappedType &getUses(const VarDecl *vd) {
Ted Kremenek39fa0562011-01-21 19:41:41 +00001320 if (!uses)
1321 uses = new UsesMap();
Ted Kremenek596fa162011-10-13 18:50:06 +00001322
Enea Zaffanella2f40be72013-02-15 20:09:55 +00001323 MappedType &V = (*uses)[vd];
Benjamin Kramereb8c4462013-06-29 17:52:13 +00001324 if (!V.getPointer())
1325 V.setPointer(new UsesVec());
Ted Kremenek39fa0562011-01-21 19:41:41 +00001326
Ted Kremenek596fa162011-10-13 18:50:06 +00001327 return V;
1328 }
Craig Toppere14c0f82014-03-12 04:55:44 +00001329
1330 void handleUseOfUninitVariable(const VarDecl *vd,
1331 const UninitUse &use) override {
Benjamin Kramereb8c4462013-06-29 17:52:13 +00001332 getUses(vd).getPointer()->push_back(use);
Ted Kremenek596fa162011-10-13 18:50:06 +00001333 }
1334
Craig Toppere14c0f82014-03-12 04:55:44 +00001335 void handleSelfInit(const VarDecl *vd) override {
Benjamin Kramereb8c4462013-06-29 17:52:13 +00001336 getUses(vd).setInt(true);
Ted Kremenek39fa0562011-01-21 19:41:41 +00001337 }
1338
1339 void flushDiagnostics() {
1340 if (!uses)
1341 return;
Enea Zaffanella2f40be72013-02-15 20:09:55 +00001342
Ted Kremenek39fa0562011-01-21 19:41:41 +00001343 for (UsesMap::iterator i = uses->begin(), e = uses->end(); i != e; ++i) {
1344 const VarDecl *vd = i->first;
Enea Zaffanella2f40be72013-02-15 20:09:55 +00001345 const MappedType &V = i->second;
Ted Kremenekb3dbe282011-02-02 23:35:53 +00001346
Benjamin Kramereb8c4462013-06-29 17:52:13 +00001347 UsesVec *vec = V.getPointer();
1348 bool hasSelfInit = V.getInt();
Ted Kremenek596fa162011-10-13 18:50:06 +00001349
1350 // Specially handle the case where we have uses of an uninitialized
1351 // variable, but the root cause is an idiomatic self-init. We want
1352 // to report the diagnostic at the self-init since that is the root cause.
Matt Beaumont-Gay4b489fa2011-10-19 18:53:03 +00001353 if (!vec->empty() && hasSelfInit && hasAlwaysUninitializedUse(vec))
Richard Smith4323bf82012-05-25 02:17:09 +00001354 DiagnoseUninitializedUse(S, vd,
1355 UninitUse(vd->getInit()->IgnoreParenCasts(),
1356 /* isAlwaysUninit */ true),
Matt Beaumont-Gay4b489fa2011-10-19 18:53:03 +00001357 /* alwaysReportSelfInit */ true);
Ted Kremenek596fa162011-10-13 18:50:06 +00001358 else {
1359 // Sort the uses by their SourceLocations. While not strictly
1360 // guaranteed to produce them in line/column order, this will provide
1361 // a stable ordering.
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00001362 std::sort(vec->begin(), vec->end(),
1363 [](const UninitUse &a, const UninitUse &b) {
1364 // Prefer a more confident report over a less confident one.
1365 if (a.getKind() != b.getKind())
1366 return a.getKind() > b.getKind();
1367 return a.getUser()->getLocStart() < b.getUser()->getLocStart();
1368 });
1369
Ted Kremenek596fa162011-10-13 18:50:06 +00001370 for (UsesVec::iterator vi = vec->begin(), ve = vec->end(); vi != ve;
1371 ++vi) {
Richard Smith4323bf82012-05-25 02:17:09 +00001372 // If we have self-init, downgrade all uses to 'may be uninitialized'.
1373 UninitUse Use = hasSelfInit ? UninitUse(vi->getUser(), false) : *vi;
1374
1375 if (DiagnoseUninitializedUse(S, vd, Use))
Ted Kremenek596fa162011-10-13 18:50:06 +00001376 // Skip further diagnostics for this variable. We try to warn only
1377 // on the first point at which a variable is used uninitialized.
1378 break;
1379 }
Chandler Carruth7a037202011-04-05 18:18:08 +00001380 }
Ted Kremenek596fa162011-10-13 18:50:06 +00001381
1382 // Release the uses vector.
Ted Kremenek39fa0562011-01-21 19:41:41 +00001383 delete vec;
1384 }
1385 delete uses;
Ted Kremenekb749a6d2011-01-15 02:58:47 +00001386 }
Matt Beaumont-Gay4b489fa2011-10-19 18:53:03 +00001387
1388private:
1389 static bool hasAlwaysUninitializedUse(const UsesVec* vec) {
1390 for (UsesVec::const_iterator i = vec->begin(), e = vec->end(); i != e; ++i) {
Richard Smithba8071e2013-09-12 18:49:10 +00001391 if (i->getKind() == UninitUse::Always ||
1392 i->getKind() == UninitUse::AfterCall ||
1393 i->getKind() == UninitUse::AfterDecl) {
Matt Beaumont-Gay4b489fa2011-10-19 18:53:03 +00001394 return true;
1395 }
1396 }
1397 return false;
1398}
Ted Kremenekb749a6d2011-01-15 02:58:47 +00001399};
1400}
1401
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001402namespace clang {
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001403namespace {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001404typedef SmallVector<PartialDiagnosticAt, 1> OptionalNotes;
Richard Smith92286672012-02-03 04:45:26 +00001405typedef std::pair<PartialDiagnosticAt, OptionalNotes> DelayedDiag;
Benjamin Kramer40b099b2012-03-26 14:05:40 +00001406typedef std::list<DelayedDiag> DiagList;
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001407
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001408struct SortDiagBySourceLocation {
Benjamin Kramer40b099b2012-03-26 14:05:40 +00001409 SourceManager &SM;
1410 SortDiagBySourceLocation(SourceManager &SM) : SM(SM) {}
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001411
1412 bool operator()(const DelayedDiag &left, const DelayedDiag &right) {
1413 // Although this call will be slow, this is only called when outputting
1414 // multiple warnings.
Benjamin Kramer40b099b2012-03-26 14:05:40 +00001415 return SM.isBeforeInTranslationUnit(left.first.first, right.first.first);
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001416 }
1417};
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001418}}
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001419
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001420//===----------------------------------------------------------------------===//
1421// -Wthread-safety
1422//===----------------------------------------------------------------------===//
1423namespace clang {
1424namespace thread_safety {
David Blaikie68e081d2011-12-20 02:48:34 +00001425namespace {
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001426class ThreadSafetyReporter : public clang::thread_safety::ThreadSafetyHandler {
1427 Sema &S;
1428 DiagList Warnings;
Richard Smith92286672012-02-03 04:45:26 +00001429 SourceLocation FunLocation, FunEndLocation;
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001430
1431 // Helper functions
1432 void warnLockMismatch(unsigned DiagID, Name LockName, SourceLocation Loc) {
DeLesley Hutchinsc2090512011-10-21 18:10:14 +00001433 // Gracefully handle rare cases when the analysis can't get a more
1434 // precise source location.
1435 if (!Loc.isValid())
1436 Loc = FunLocation;
Richard Smith92286672012-02-03 04:45:26 +00001437 PartialDiagnosticAt Warning(Loc, S.PDiag(DiagID) << LockName);
1438 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001439 }
1440
1441 public:
Richard Smith92286672012-02-03 04:45:26 +00001442 ThreadSafetyReporter(Sema &S, SourceLocation FL, SourceLocation FEL)
1443 : S(S), FunLocation(FL), FunEndLocation(FEL) {}
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001444
1445 /// \brief Emit all buffered diagnostics in order of sourcelocation.
1446 /// We need to output diagnostics produced while iterating through
1447 /// the lockset in deterministic order, so this function orders diagnostics
1448 /// and outputs them.
1449 void emitDiagnostics() {
Benjamin Kramer40b099b2012-03-26 14:05:40 +00001450 Warnings.sort(SortDiagBySourceLocation(S.getSourceManager()));
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001451 for (DiagList::iterator I = Warnings.begin(), E = Warnings.end();
Richard Smith92286672012-02-03 04:45:26 +00001452 I != E; ++I) {
1453 S.Diag(I->first.first, I->first.second);
1454 const OptionalNotes &Notes = I->second;
1455 for (unsigned NoteI = 0, NoteN = Notes.size(); NoteI != NoteN; ++NoteI)
1456 S.Diag(Notes[NoteI].first, Notes[NoteI].second);
1457 }
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001458 }
1459
Craig Toppere14c0f82014-03-12 04:55:44 +00001460 void handleInvalidLockExp(SourceLocation Loc) override {
Richard Smith92286672012-02-03 04:45:26 +00001461 PartialDiagnosticAt Warning(Loc,
1462 S.PDiag(diag::warn_cannot_resolve_lock) << Loc);
1463 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
Caitlin Sadowskiff2f3f82011-09-09 16:21:55 +00001464 }
Craig Toppere14c0f82014-03-12 04:55:44 +00001465 void handleUnmatchedUnlock(Name LockName, SourceLocation Loc) override {
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001466 warnLockMismatch(diag::warn_unlock_but_no_lock, LockName, Loc);
1467 }
Aaron Ballmandf115d92014-03-21 14:48:48 +00001468 void handleIncorrectUnlockKind(Name LockName, LockKind Expected,
1469 LockKind Received,
1470 SourceLocation Loc) override {
1471 if (Loc.isInvalid())
1472 Loc = FunLocation;
1473 PartialDiagnosticAt Warning(Loc, S.PDiag(diag::warn_unlock_kind_mismatch)
1474 << LockName << Received << Expected);
1475 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1476 }
Craig Toppere14c0f82014-03-12 04:55:44 +00001477 void handleDoubleLock(Name LockName, SourceLocation Loc) override {
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001478 warnLockMismatch(diag::warn_double_lock, LockName, Loc);
1479 }
1480
Richard Smith92286672012-02-03 04:45:26 +00001481 void handleMutexHeldEndOfScope(Name LockName, SourceLocation LocLocked,
1482 SourceLocation LocEndOfScope,
Craig Toppere14c0f82014-03-12 04:55:44 +00001483 LockErrorKind LEK) override {
Caitlin Sadowskiaf9b7c52011-09-15 17:25:19 +00001484 unsigned DiagID = 0;
1485 switch (LEK) {
1486 case LEK_LockedSomePredecessors:
Richard Smith92286672012-02-03 04:45:26 +00001487 DiagID = diag::warn_lock_some_predecessors;
Caitlin Sadowskiaf9b7c52011-09-15 17:25:19 +00001488 break;
1489 case LEK_LockedSomeLoopIterations:
1490 DiagID = diag::warn_expecting_lock_held_on_loop;
1491 break;
1492 case LEK_LockedAtEndOfFunction:
1493 DiagID = diag::warn_no_unlock;
1494 break;
DeLesley Hutchins6e6dbb72012-07-02 22:16:54 +00001495 case LEK_NotLockedAtEndOfFunction:
1496 DiagID = diag::warn_expecting_locked;
1497 break;
Caitlin Sadowskiaf9b7c52011-09-15 17:25:19 +00001498 }
Richard Smith92286672012-02-03 04:45:26 +00001499 if (LocEndOfScope.isInvalid())
1500 LocEndOfScope = FunEndLocation;
1501
1502 PartialDiagnosticAt Warning(LocEndOfScope, S.PDiag(DiagID) << LockName);
DeLesley Hutchinsfd374bb2013-04-08 20:11:11 +00001503 if (LocLocked.isValid()) {
1504 PartialDiagnosticAt Note(LocLocked, S.PDiag(diag::note_locked_here));
1505 Warnings.push_back(DelayedDiag(Warning, OptionalNotes(1, Note)));
1506 return;
1507 }
1508 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001509 }
1510
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001511
1512 void handleExclusiveAndShared(Name LockName, SourceLocation Loc1,
Craig Toppere14c0f82014-03-12 04:55:44 +00001513 SourceLocation Loc2) override {
Richard Smith92286672012-02-03 04:45:26 +00001514 PartialDiagnosticAt Warning(
1515 Loc1, S.PDiag(diag::warn_lock_exclusive_and_shared) << LockName);
1516 PartialDiagnosticAt Note(
1517 Loc2, S.PDiag(diag::note_lock_exclusive_and_shared) << LockName);
1518 Warnings.push_back(DelayedDiag(Warning, OptionalNotes(1, Note)));
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001519 }
1520
1521 void handleNoMutexHeld(const NamedDecl *D, ProtectedOperationKind POK,
Craig Toppere14c0f82014-03-12 04:55:44 +00001522 AccessKind AK, SourceLocation Loc) override {
Caitlin Sadowskie50d8c32011-09-14 20:09:09 +00001523 assert((POK == POK_VarAccess || POK == POK_VarDereference)
1524 && "Only works for variables");
1525 unsigned DiagID = POK == POK_VarAccess?
1526 diag::warn_variable_requires_any_lock:
1527 diag::warn_var_deref_requires_any_lock;
Richard Smith92286672012-02-03 04:45:26 +00001528 PartialDiagnosticAt Warning(Loc, S.PDiag(DiagID)
DeLesley Hutchinsa15e1b42012-09-19 19:18:29 +00001529 << D->getNameAsString() << getLockKindFromAccessKind(AK));
Richard Smith92286672012-02-03 04:45:26 +00001530 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001531 }
1532
1533 void handleMutexNotHeld(const NamedDecl *D, ProtectedOperationKind POK,
DeLesley Hutchins5ff16442012-09-10 19:58:23 +00001534 Name LockName, LockKind LK, SourceLocation Loc,
Craig Toppere14c0f82014-03-12 04:55:44 +00001535 Name *PossibleMatch) override {
Caitlin Sadowski427f42e2011-09-13 18:01:58 +00001536 unsigned DiagID = 0;
DeLesley Hutchins5ff16442012-09-10 19:58:23 +00001537 if (PossibleMatch) {
1538 switch (POK) {
1539 case POK_VarAccess:
1540 DiagID = diag::warn_variable_requires_lock_precise;
1541 break;
1542 case POK_VarDereference:
1543 DiagID = diag::warn_var_deref_requires_lock_precise;
1544 break;
1545 case POK_FunctionCall:
1546 DiagID = diag::warn_fun_requires_lock_precise;
1547 break;
1548 }
1549 PartialDiagnosticAt Warning(Loc, S.PDiag(DiagID)
DeLesley Hutchinsa15e1b42012-09-19 19:18:29 +00001550 << D->getNameAsString() << LockName << LK);
DeLesley Hutchins5ff16442012-09-10 19:58:23 +00001551 PartialDiagnosticAt Note(Loc, S.PDiag(diag::note_found_mutex_near_match)
1552 << *PossibleMatch);
1553 Warnings.push_back(DelayedDiag(Warning, OptionalNotes(1, Note)));
1554 } else {
1555 switch (POK) {
1556 case POK_VarAccess:
1557 DiagID = diag::warn_variable_requires_lock;
1558 break;
1559 case POK_VarDereference:
1560 DiagID = diag::warn_var_deref_requires_lock;
1561 break;
1562 case POK_FunctionCall:
1563 DiagID = diag::warn_fun_requires_lock;
1564 break;
1565 }
1566 PartialDiagnosticAt Warning(Loc, S.PDiag(DiagID)
DeLesley Hutchinsa15e1b42012-09-19 19:18:29 +00001567 << D->getNameAsString() << LockName << LK);
DeLesley Hutchins5ff16442012-09-10 19:58:23 +00001568 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001569 }
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001570 }
1571
Craig Toppere14c0f82014-03-12 04:55:44 +00001572 void handleFunExcludesLock(Name FunName, Name LockName,
1573 SourceLocation Loc) override {
Richard Smith92286672012-02-03 04:45:26 +00001574 PartialDiagnosticAt Warning(Loc,
1575 S.PDiag(diag::warn_fun_excludes_mutex) << FunName << LockName);
1576 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001577 }
1578};
1579}
1580}
David Blaikie68e081d2011-12-20 02:48:34 +00001581}
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001582
Ted Kremenekb749a6d2011-01-15 02:58:47 +00001583//===----------------------------------------------------------------------===//
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001584// -Wconsumed
1585//===----------------------------------------------------------------------===//
1586
1587namespace clang {
1588namespace consumed {
1589namespace {
1590class ConsumedWarningsHandler : public ConsumedWarningsHandlerBase {
1591
1592 Sema &S;
1593 DiagList Warnings;
1594
1595public:
1596
1597 ConsumedWarningsHandler(Sema &S) : S(S) {}
Craig Toppere14c0f82014-03-12 04:55:44 +00001598
1599 void emitDiagnostics() override {
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001600 Warnings.sort(SortDiagBySourceLocation(S.getSourceManager()));
1601
1602 for (DiagList::iterator I = Warnings.begin(), E = Warnings.end();
1603 I != E; ++I) {
1604
1605 const OptionalNotes &Notes = I->second;
1606 S.Diag(I->first.first, I->first.second);
1607
1608 for (unsigned NoteI = 0, NoteN = Notes.size(); NoteI != NoteN; ++NoteI) {
1609 S.Diag(Notes[NoteI].first, Notes[NoteI].second);
1610 }
1611 }
1612 }
Craig Toppere14c0f82014-03-12 04:55:44 +00001613
1614 void warnLoopStateMismatch(SourceLocation Loc,
1615 StringRef VariableName) override {
DeLesley Hutchins3277a612013-10-09 18:30:24 +00001616 PartialDiagnosticAt Warning(Loc, S.PDiag(diag::warn_loop_state_mismatch) <<
1617 VariableName);
1618
1619 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1620 }
1621
DeLesley Hutchins36ea1dd2013-10-17 22:53:04 +00001622 void warnParamReturnTypestateMismatch(SourceLocation Loc,
1623 StringRef VariableName,
1624 StringRef ExpectedState,
Craig Toppere14c0f82014-03-12 04:55:44 +00001625 StringRef ObservedState) override {
DeLesley Hutchins36ea1dd2013-10-17 22:53:04 +00001626
1627 PartialDiagnosticAt Warning(Loc, S.PDiag(
1628 diag::warn_param_return_typestate_mismatch) << VariableName <<
1629 ExpectedState << ObservedState);
1630
1631 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1632 }
1633
DeLesley Hutchins69391772013-10-17 23:23:53 +00001634 void warnParamTypestateMismatch(SourceLocation Loc, StringRef ExpectedState,
Craig Toppere14c0f82014-03-12 04:55:44 +00001635 StringRef ObservedState) override {
DeLesley Hutchins69391772013-10-17 23:23:53 +00001636
1637 PartialDiagnosticAt Warning(Loc, S.PDiag(
1638 diag::warn_param_typestate_mismatch) << ExpectedState << ObservedState);
1639
1640 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1641 }
1642
DeLesley Hutchinsfc368252013-09-03 20:11:38 +00001643 void warnReturnTypestateForUnconsumableType(SourceLocation Loc,
Craig Toppere14c0f82014-03-12 04:55:44 +00001644 StringRef TypeName) override {
DeLesley Hutchinsfc368252013-09-03 20:11:38 +00001645 PartialDiagnosticAt Warning(Loc, S.PDiag(
1646 diag::warn_return_typestate_for_unconsumable_type) << TypeName);
1647
1648 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1649 }
1650
1651 void warnReturnTypestateMismatch(SourceLocation Loc, StringRef ExpectedState,
Craig Toppere14c0f82014-03-12 04:55:44 +00001652 StringRef ObservedState) override {
DeLesley Hutchinsfc368252013-09-03 20:11:38 +00001653
1654 PartialDiagnosticAt Warning(Loc, S.PDiag(
1655 diag::warn_return_typestate_mismatch) << ExpectedState << ObservedState);
1656
1657 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1658 }
1659
DeLesley Hutchins210791a2013-10-04 21:28:06 +00001660 void warnUseOfTempInInvalidState(StringRef MethodName, StringRef State,
Craig Toppere14c0f82014-03-12 04:55:44 +00001661 SourceLocation Loc) override {
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001662
1663 PartialDiagnosticAt Warning(Loc, S.PDiag(
DeLesley Hutchins210791a2013-10-04 21:28:06 +00001664 diag::warn_use_of_temp_in_invalid_state) << MethodName << State);
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001665
1666 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1667 }
1668
DeLesley Hutchins210791a2013-10-04 21:28:06 +00001669 void warnUseInInvalidState(StringRef MethodName, StringRef VariableName,
Craig Toppere14c0f82014-03-12 04:55:44 +00001670 StringRef State, SourceLocation Loc) override {
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001671
DeLesley Hutchins210791a2013-10-04 21:28:06 +00001672 PartialDiagnosticAt Warning(Loc, S.PDiag(diag::warn_use_in_invalid_state) <<
1673 MethodName << VariableName << State);
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001674
1675 Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1676 }
1677};
1678}}}
1679
1680//===----------------------------------------------------------------------===//
Ted Kremenek918fe842010-03-20 21:06:02 +00001681// AnalysisBasedWarnings - Worker object used by Sema to execute analysis-based
1682// warnings on a function, method, or block.
1683//===----------------------------------------------------------------------===//
1684
Ted Kremenek0b405322010-03-23 00:13:23 +00001685clang::sema::AnalysisBasedWarnings::Policy::Policy() {
1686 enableCheckFallThrough = 1;
1687 enableCheckUnreachable = 0;
Caitlin Sadowskiafbbd8e2011-08-23 18:46:34 +00001688 enableThreadSafetyAnalysis = 0;
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001689 enableConsumedAnalysis = 0;
Ted Kremenek0b405322010-03-23 00:13:23 +00001690}
1691
Ted Kremenekad8753c2014-03-15 05:47:06 +00001692static unsigned isEnabled(DiagnosticsEngine &D, unsigned diag) {
1693 return (unsigned) D.getDiagnosticLevel(diag, SourceLocation()) !=
1694 DiagnosticsEngine::Ignored;
1695}
1696
Chandler Carruthb4836ea2011-07-06 16:21:37 +00001697clang::sema::AnalysisBasedWarnings::AnalysisBasedWarnings(Sema &s)
1698 : S(s),
1699 NumFunctionsAnalyzed(0),
Benjamin Kramer581f48f2011-07-08 20:38:53 +00001700 NumFunctionsWithBadCFGs(0),
Chandler Carruthb4836ea2011-07-06 16:21:37 +00001701 NumCFGBlocks(0),
Benjamin Kramer581f48f2011-07-08 20:38:53 +00001702 MaxCFGBlocksPerFunction(0),
1703 NumUninitAnalysisFunctions(0),
1704 NumUninitAnalysisVariables(0),
1705 MaxUninitAnalysisVariablesPerFunction(0),
1706 NumUninitAnalysisBlockVisits(0),
1707 MaxUninitAnalysisBlockVisitsPerFunction(0) {
Ted Kremenekad8753c2014-03-15 05:47:06 +00001708
1709 using namespace diag;
David Blaikie9c902b52011-09-25 23:23:43 +00001710 DiagnosticsEngine &D = S.getDiagnostics();
Ted Kremenekad8753c2014-03-15 05:47:06 +00001711
1712 DefaultPolicy.enableCheckUnreachable =
1713 isEnabled(D, warn_unreachable) ||
1714 isEnabled(D, warn_unreachable_break) ||
Ted Kremenek14210372014-03-21 06:02:36 +00001715 isEnabled(D, warn_unreachable_return) ||
1716 isEnabled(D, warn_unreachable_loop_increment);
Ted Kremenekad8753c2014-03-15 05:47:06 +00001717
1718 DefaultPolicy.enableThreadSafetyAnalysis =
1719 isEnabled(D, warn_double_lock);
1720
1721 DefaultPolicy.enableConsumedAnalysis =
1722 isEnabled(D, warn_use_in_invalid_state);
Ted Kremenek918fe842010-03-20 21:06:02 +00001723}
1724
Ted Kremenek3427fac2011-02-23 01:52:04 +00001725static void flushDiagnostics(Sema &S, sema::FunctionScopeInfo *fscope) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001726 for (SmallVectorImpl<sema::PossiblyUnreachableDiag>::iterator
Ted Kremenek3427fac2011-02-23 01:52:04 +00001727 i = fscope->PossiblyUnreachableDiags.begin(),
1728 e = fscope->PossiblyUnreachableDiags.end();
1729 i != e; ++i) {
1730 const sema::PossiblyUnreachableDiag &D = *i;
1731 S.Diag(D.Loc, D.PD);
1732 }
1733}
1734
Ted Kremenek0b405322010-03-23 00:13:23 +00001735void clang::sema::
1736AnalysisBasedWarnings::IssueWarnings(sema::AnalysisBasedWarnings::Policy P,
Ted Kremenekcc7f1f82011-02-23 01:51:53 +00001737 sema::FunctionScopeInfo *fscope,
Ted Kremenek1767a272011-02-23 01:51:48 +00001738 const Decl *D, const BlockExpr *blkExpr) {
Ted Kremenekb45ebee2010-03-20 21:11:09 +00001739
Ted Kremenek918fe842010-03-20 21:06:02 +00001740 // We avoid doing analysis-based warnings when there are errors for
1741 // two reasons:
1742 // (1) The CFGs often can't be constructed (if the body is invalid), so
1743 // don't bother trying.
1744 // (2) The code already has problems; running the analysis just takes more
1745 // time.
David Blaikie9c902b52011-09-25 23:23:43 +00001746 DiagnosticsEngine &Diags = S.getDiagnostics();
Ted Kremenekb8021922010-04-30 21:49:25 +00001747
Ted Kremenek0b405322010-03-23 00:13:23 +00001748 // Do not do any analysis for declarations in system headers if we are
1749 // going to just ignore them.
Ted Kremenekb8021922010-04-30 21:49:25 +00001750 if (Diags.getSuppressSystemWarnings() &&
Ted Kremenek0b405322010-03-23 00:13:23 +00001751 S.SourceMgr.isInSystemHeader(D->getLocation()))
1752 return;
1753
John McCall1d570a72010-08-25 05:56:39 +00001754 // For code in dependent contexts, we'll do this at instantiation time.
David Blaikie0f2ae782012-01-24 04:51:48 +00001755 if (cast<DeclContext>(D)->isDependentContext())
1756 return;
Ted Kremenek918fe842010-03-20 21:06:02 +00001757
DeLesley Hutchins8ecd4912012-12-07 22:53:48 +00001758 if (Diags.hasUncompilableErrorOccurred() || Diags.hasFatalErrorOccurred()) {
Ted Kremenek3427fac2011-02-23 01:52:04 +00001759 // Flush out any possibly unreachable diagnostics.
1760 flushDiagnostics(S, fscope);
1761 return;
1762 }
1763
Ted Kremenek918fe842010-03-20 21:06:02 +00001764 const Stmt *Body = D->getBody();
1765 assert(Body);
1766
Ted Kremenekb3a38a92013-10-14 19:11:25 +00001767 // Construct the analysis context with the specified CFG build options.
Jordy Rose4f8198e2012-04-28 01:58:08 +00001768 AnalysisDeclContext AC(/* AnalysisDeclContextManager */ 0, D);
Ted Kremenek189ecec2011-07-21 05:22:47 +00001769
Ted Kremenek918fe842010-03-20 21:06:02 +00001770 // Don't generate EH edges for CallExprs as we'd like to avoid the n^2
Benjamin Kramer60509af2013-09-09 14:48:42 +00001771 // explosion for destructors that can result and the compile time hit.
Ted Kremenek189ecec2011-07-21 05:22:47 +00001772 AC.getCFGBuildOptions().PruneTriviallyFalseEdges = true;
1773 AC.getCFGBuildOptions().AddEHEdges = false;
1774 AC.getCFGBuildOptions().AddInitializers = true;
1775 AC.getCFGBuildOptions().AddImplicitDtors = true;
Jordan Rose91f78402012-09-05 23:11:06 +00001776 AC.getCFGBuildOptions().AddTemporaryDtors = true;
Jordan Rosec9176072014-01-13 17:59:19 +00001777 AC.getCFGBuildOptions().AddCXXNewAllocator = false;
Jordan Rose91f78402012-09-05 23:11:06 +00001778
Ted Kremenek9e100ea2011-07-19 14:18:48 +00001779 // Force that certain expressions appear as CFGElements in the CFG. This
1780 // is used to speed up various analyses.
1781 // FIXME: This isn't the right factoring. This is here for initial
1782 // prototyping, but we need a way for analyses to say what expressions they
1783 // expect to always be CFGElements and then fill in the BuildOptions
1784 // appropriately. This is essentially a layering violation.
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001785 if (P.enableCheckUnreachable || P.enableThreadSafetyAnalysis ||
1786 P.enableConsumedAnalysis) {
DeLesley Hutchinsf7faa6a2011-12-08 20:23:06 +00001787 // Unreachable code analysis and thread safety require a linearized CFG.
Ted Kremenekbd913712011-08-23 23:05:11 +00001788 AC.getCFGBuildOptions().setAllAlwaysAdd();
1789 }
1790 else {
1791 AC.getCFGBuildOptions()
1792 .setAlwaysAdd(Stmt::BinaryOperatorClass)
Richard Smithb21dd022012-07-17 01:27:33 +00001793 .setAlwaysAdd(Stmt::CompoundAssignOperatorClass)
Ted Kremenekbd913712011-08-23 23:05:11 +00001794 .setAlwaysAdd(Stmt::BlockExprClass)
1795 .setAlwaysAdd(Stmt::CStyleCastExprClass)
1796 .setAlwaysAdd(Stmt::DeclRefExprClass)
1797 .setAlwaysAdd(Stmt::ImplicitCastExprClass)
Richard Smith84837d52012-05-03 18:27:39 +00001798 .setAlwaysAdd(Stmt::UnaryOperatorClass)
1799 .setAlwaysAdd(Stmt::AttributedStmtClass);
Ted Kremenekbd913712011-08-23 23:05:11 +00001800 }
Ted Kremenek918fe842010-03-20 21:06:02 +00001801
Ted Kremenekb3a38a92013-10-14 19:11:25 +00001802
Ted Kremenek3427fac2011-02-23 01:52:04 +00001803 // Emit delayed diagnostics.
David Blaikie0f2ae782012-01-24 04:51:48 +00001804 if (!fscope->PossiblyUnreachableDiags.empty()) {
Ted Kremenek3427fac2011-02-23 01:52:04 +00001805 bool analyzed = false;
Ted Kremeneka099c592011-03-10 03:50:34 +00001806
1807 // Register the expressions with the CFGBuilder.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001808 for (SmallVectorImpl<sema::PossiblyUnreachableDiag>::iterator
Ted Kremeneka099c592011-03-10 03:50:34 +00001809 i = fscope->PossiblyUnreachableDiags.begin(),
1810 e = fscope->PossiblyUnreachableDiags.end();
1811 i != e; ++i) {
1812 if (const Stmt *stmt = i->stmt)
1813 AC.registerForcedBlockExpression(stmt);
1814 }
1815
1816 if (AC.getCFG()) {
1817 analyzed = true;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001818 for (SmallVectorImpl<sema::PossiblyUnreachableDiag>::iterator
Ted Kremeneka099c592011-03-10 03:50:34 +00001819 i = fscope->PossiblyUnreachableDiags.begin(),
1820 e = fscope->PossiblyUnreachableDiags.end();
1821 i != e; ++i)
1822 {
1823 const sema::PossiblyUnreachableDiag &D = *i;
1824 bool processed = false;
1825 if (const Stmt *stmt = i->stmt) {
1826 const CFGBlock *block = AC.getBlockForRegisteredExpression(stmt);
Eli Friedmane0afc982012-01-21 01:01:51 +00001827 CFGReverseBlockReachabilityAnalysis *cra =
1828 AC.getCFGReachablityAnalysis();
1829 // FIXME: We should be able to assert that block is non-null, but
1830 // the CFG analysis can skip potentially-evaluated expressions in
1831 // edge cases; see test/Sema/vla-2.c.
1832 if (block && cra) {
Ted Kremenek3427fac2011-02-23 01:52:04 +00001833 // Can this block be reached from the entrance?
Ted Kremeneka099c592011-03-10 03:50:34 +00001834 if (cra->isReachable(&AC.getCFG()->getEntry(), block))
Ted Kremenek3427fac2011-02-23 01:52:04 +00001835 S.Diag(D.Loc, D.PD);
Ted Kremeneka099c592011-03-10 03:50:34 +00001836 processed = true;
Ted Kremenek3427fac2011-02-23 01:52:04 +00001837 }
1838 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001839 if (!processed) {
1840 // Emit the warning anyway if we cannot map to a basic block.
1841 S.Diag(D.Loc, D.PD);
1842 }
Ted Kremenek3427fac2011-02-23 01:52:04 +00001843 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001844 }
Ted Kremenek3427fac2011-02-23 01:52:04 +00001845
1846 if (!analyzed)
1847 flushDiagnostics(S, fscope);
1848 }
1849
1850
Ted Kremenek918fe842010-03-20 21:06:02 +00001851 // Warning: check missing 'return'
David Blaikie0f2ae782012-01-24 04:51:48 +00001852 if (P.enableCheckFallThrough) {
Ted Kremenek918fe842010-03-20 21:06:02 +00001853 const CheckFallThroughDiagnostics &CD =
1854 (isa<BlockDecl>(D) ? CheckFallThroughDiagnostics::MakeForBlock()
Douglas Gregorcf11eb72012-02-15 16:20:15 +00001855 : (isa<CXXMethodDecl>(D) &&
1856 cast<CXXMethodDecl>(D)->getOverloadedOperator() == OO_Call &&
1857 cast<CXXMethodDecl>(D)->getParent()->isLambda())
1858 ? CheckFallThroughDiagnostics::MakeForLambda()
1859 : CheckFallThroughDiagnostics::MakeForFunction(D));
Ted Kremenek1767a272011-02-23 01:51:48 +00001860 CheckFallThroughForBody(S, D, Body, blkExpr, CD, AC);
Ted Kremenek918fe842010-03-20 21:06:02 +00001861 }
1862
1863 // Warning: check for unreachable code
Ted Kremenek7f770032011-11-30 21:22:09 +00001864 if (P.enableCheckUnreachable) {
1865 // Only check for unreachable code on non-template instantiations.
1866 // Different template instantiations can effectively change the control-flow
1867 // and it is very difficult to prove that a snippet of code in a template
1868 // is unreachable for all instantiations.
Ted Kremenek85825ae2011-12-01 00:59:17 +00001869 bool isTemplateInstantiation = false;
1870 if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(D))
1871 isTemplateInstantiation = Function->isTemplateInstantiation();
1872 if (!isTemplateInstantiation)
Ted Kremenek7f770032011-11-30 21:22:09 +00001873 CheckUnreachable(S, AC);
1874 }
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001875
Caitlin Sadowskiafbbd8e2011-08-23 18:46:34 +00001876 // Check for thread safety violations
David Blaikie0f2ae782012-01-24 04:51:48 +00001877 if (P.enableThreadSafetyAnalysis) {
DeLesley Hutchinsc2090512011-10-21 18:10:14 +00001878 SourceLocation FL = AC.getDecl()->getLocation();
Richard Smith92286672012-02-03 04:45:26 +00001879 SourceLocation FEL = AC.getDecl()->getLocEnd();
1880 thread_safety::ThreadSafetyReporter Reporter(S, FL, FEL);
DeLesley Hutchins8edae132012-12-05 00:06:15 +00001881 if (Diags.getDiagnosticLevel(diag::warn_thread_safety_beta,D->getLocStart())
1882 != DiagnosticsEngine::Ignored)
1883 Reporter.setIssueBetaWarnings(true);
1884
Caitlin Sadowski0b3501c2011-09-09 16:04:02 +00001885 thread_safety::runThreadSafetyAnalysis(AC, Reporter);
1886 Reporter.emitDiagnostics();
1887 }
Caitlin Sadowskiafbbd8e2011-08-23 18:46:34 +00001888
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001889 // Check for violations of consumed properties.
1890 if (P.enableConsumedAnalysis) {
1891 consumed::ConsumedWarningsHandler WarningHandler(S);
Reid Klecknere846dea2013-08-12 23:49:39 +00001892 consumed::ConsumedAnalyzer Analyzer(WarningHandler);
DeLesley Hutchins48a31762013-08-12 21:20:55 +00001893 Analyzer.run(AC);
1894 }
1895
Ted Kremenekbcf848f2011-01-25 19:13:48 +00001896 if (Diags.getDiagnosticLevel(diag::warn_uninit_var, D->getLocStart())
David Blaikie9c902b52011-09-25 23:23:43 +00001897 != DiagnosticsEngine::Ignored ||
Richard Smith4323bf82012-05-25 02:17:09 +00001898 Diags.getDiagnosticLevel(diag::warn_sometimes_uninit_var,D->getLocStart())
1899 != DiagnosticsEngine::Ignored ||
Ted Kremenek1a47f362011-03-15 05:22:28 +00001900 Diags.getDiagnosticLevel(diag::warn_maybe_uninit_var, D->getLocStart())
David Blaikie9c902b52011-09-25 23:23:43 +00001901 != DiagnosticsEngine::Ignored) {
Ted Kremenek2551fbe2011-03-17 05:29:57 +00001902 if (CFG *cfg = AC.getCFG()) {
Ted Kremenekb63931e2011-01-18 21:18:58 +00001903 UninitValsDiagReporter reporter(S);
Fariborz Jahanian8809a9d2011-07-16 18:31:33 +00001904 UninitVariablesAnalysisStats stats;
Benjamin Kramere492cb42011-07-16 20:13:06 +00001905 std::memset(&stats, 0, sizeof(UninitVariablesAnalysisStats));
Ted Kremenekbcf848f2011-01-25 19:13:48 +00001906 runUninitializedVariablesAnalysis(*cast<DeclContext>(D), *cfg, AC,
Chandler Carruthb4836ea2011-07-06 16:21:37 +00001907 reporter, stats);
1908
1909 if (S.CollectStats && stats.NumVariablesAnalyzed > 0) {
1910 ++NumUninitAnalysisFunctions;
1911 NumUninitAnalysisVariables += stats.NumVariablesAnalyzed;
1912 NumUninitAnalysisBlockVisits += stats.NumBlockVisits;
1913 MaxUninitAnalysisVariablesPerFunction =
1914 std::max(MaxUninitAnalysisVariablesPerFunction,
1915 stats.NumVariablesAnalyzed);
1916 MaxUninitAnalysisBlockVisitsPerFunction =
1917 std::max(MaxUninitAnalysisBlockVisitsPerFunction,
1918 stats.NumBlockVisits);
1919 }
Ted Kremenekb749a6d2011-01-15 02:58:47 +00001920 }
1921 }
Chandler Carruthb4836ea2011-07-06 16:21:37 +00001922
Alexander Kornienko06caf7d2012-06-02 01:01:07 +00001923 bool FallThroughDiagFull =
1924 Diags.getDiagnosticLevel(diag::warn_unannotated_fallthrough,
1925 D->getLocStart()) != DiagnosticsEngine::Ignored;
Alexis Hunt2178f142012-06-15 21:22:05 +00001926 bool FallThroughDiagPerFunction =
1927 Diags.getDiagnosticLevel(diag::warn_unannotated_fallthrough_per_function,
Alexander Kornienko06caf7d2012-06-02 01:01:07 +00001928 D->getLocStart()) != DiagnosticsEngine::Ignored;
Alexis Hunt2178f142012-06-15 21:22:05 +00001929 if (FallThroughDiagFull || FallThroughDiagPerFunction) {
Alexander Kornienko06caf7d2012-06-02 01:01:07 +00001930 DiagnoseSwitchLabelsFallthrough(S, AC, !FallThroughDiagFull);
Richard Smith84837d52012-05-03 18:27:39 +00001931 }
1932
Jordan Rosed3934582012-09-28 22:21:30 +00001933 if (S.getLangOpts().ObjCARCWeak &&
1934 Diags.getDiagnosticLevel(diag::warn_arc_repeated_use_of_weak,
1935 D->getLocStart()) != DiagnosticsEngine::Ignored)
Jordan Rose76831c62012-10-11 16:10:19 +00001936 diagnoseRepeatedUseOfWeak(S, fscope, D, AC.getParentMap());
Jordan Rosed3934582012-09-28 22:21:30 +00001937
Richard Trieu2f024f42013-12-21 02:33:43 +00001938
1939 // Check for infinite self-recursion in functions
1940 if (Diags.getDiagnosticLevel(diag::warn_infinite_recursive_function,
1941 D->getLocStart())
1942 != DiagnosticsEngine::Ignored) {
1943 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
1944 checkRecursiveFunction(S, FD, Body, AC);
1945 }
1946 }
1947
Chandler Carruthb4836ea2011-07-06 16:21:37 +00001948 // Collect statistics about the CFG if it was built.
1949 if (S.CollectStats && AC.isCFGBuilt()) {
1950 ++NumFunctionsAnalyzed;
1951 if (CFG *cfg = AC.getCFG()) {
1952 // If we successfully built a CFG for this context, record some more
1953 // detail information about it.
Chandler Carruth50020d92011-07-06 22:21:45 +00001954 NumCFGBlocks += cfg->getNumBlockIDs();
Chandler Carruthb4836ea2011-07-06 16:21:37 +00001955 MaxCFGBlocksPerFunction = std::max(MaxCFGBlocksPerFunction,
Chandler Carruth50020d92011-07-06 22:21:45 +00001956 cfg->getNumBlockIDs());
Chandler Carruthb4836ea2011-07-06 16:21:37 +00001957 } else {
1958 ++NumFunctionsWithBadCFGs;
1959 }
1960 }
1961}
1962
1963void clang::sema::AnalysisBasedWarnings::PrintStats() const {
1964 llvm::errs() << "\n*** Analysis Based Warnings Stats:\n";
1965
1966 unsigned NumCFGsBuilt = NumFunctionsAnalyzed - NumFunctionsWithBadCFGs;
1967 unsigned AvgCFGBlocksPerFunction =
1968 !NumCFGsBuilt ? 0 : NumCFGBlocks/NumCFGsBuilt;
1969 llvm::errs() << NumFunctionsAnalyzed << " functions analyzed ("
1970 << NumFunctionsWithBadCFGs << " w/o CFGs).\n"
1971 << " " << NumCFGBlocks << " CFG blocks built.\n"
1972 << " " << AvgCFGBlocksPerFunction
1973 << " average CFG blocks per function.\n"
1974 << " " << MaxCFGBlocksPerFunction
1975 << " max CFG blocks per function.\n";
1976
1977 unsigned AvgUninitVariablesPerFunction = !NumUninitAnalysisFunctions ? 0
1978 : NumUninitAnalysisVariables/NumUninitAnalysisFunctions;
1979 unsigned AvgUninitBlockVisitsPerFunction = !NumUninitAnalysisFunctions ? 0
1980 : NumUninitAnalysisBlockVisits/NumUninitAnalysisFunctions;
1981 llvm::errs() << NumUninitAnalysisFunctions
1982 << " functions analyzed for uninitialiazed variables\n"
1983 << " " << NumUninitAnalysisVariables << " variables analyzed.\n"
1984 << " " << AvgUninitVariablesPerFunction
1985 << " average variables per function.\n"
1986 << " " << MaxUninitAnalysisVariablesPerFunction
1987 << " max variables per function.\n"
1988 << " " << NumUninitAnalysisBlockVisits << " block visits.\n"
1989 << " " << AvgUninitBlockVisitsPerFunction
1990 << " average block visits per function.\n"
1991 << " " << MaxUninitAnalysisBlockVisitsPerFunction
1992 << " max block visits per function.\n";
Ted Kremenek918fe842010-03-20 21:06:02 +00001993}