blob: e073b3dc236626bf6cfe9585fcd6e719a1af98c5 [file] [log] [blame]
Ted Kremenekdbdbaaf2010-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 Gregore737f502010-08-12 20:07:10 +000016#include "clang/Sema/AnalysisBasedWarnings.h"
John McCall2d887082010-08-25 22:03:47 +000017#include "clang/Sema/SemaInternal.h"
Ted Kremenek351ba912011-02-23 01:52:04 +000018#include "clang/Sema/ScopeInfo.h"
Ted Kremenekd068aab2010-03-20 21:11:09 +000019#include "clang/Basic/SourceManager.h"
Ted Kremenekfbb178a2011-01-21 19:41:46 +000020#include "clang/Lex/Preprocessor.h"
John McCall7cd088e2010-08-24 07:21:54 +000021#include "clang/AST/DeclObjC.h"
John McCall384aff82010-08-25 07:42:41 +000022#include "clang/AST/DeclCXX.h"
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +000023#include "clang/AST/ExprObjC.h"
24#include "clang/AST/ExprCXX.h"
25#include "clang/AST/StmtObjC.h"
26#include "clang/AST/StmtCXX.h"
Ted Kremenek6f417152011-04-04 20:56:00 +000027#include "clang/AST/EvaluatedExprVisitor.h"
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +000028#include "clang/Analysis/AnalysisContext.h"
29#include "clang/Analysis/CFG.h"
30#include "clang/Analysis/Analyses/ReachableCode.h"
Ted Kremenek351ba912011-02-23 01:52:04 +000031#include "clang/Analysis/Analyses/CFGReachabilityAnalysis.h"
32#include "clang/Analysis/CFGStmtMap.h"
Ted Kremenek6f342132011-03-15 03:17:07 +000033#include "clang/Analysis/Analyses/UninitializedValues.h"
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +000034#include "llvm/ADT/BitVector.h"
35#include "llvm/Support/Casting.h"
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +000036
37using namespace clang;
38
39//===----------------------------------------------------------------------===//
40// Unreachable code analysis.
41//===----------------------------------------------------------------------===//
42
43namespace {
44 class UnreachableCodeHandler : public reachable_code::Callback {
45 Sema &S;
46 public:
47 UnreachableCodeHandler(Sema &s) : S(s) {}
48
49 void HandleUnreachable(SourceLocation L, SourceRange R1, SourceRange R2) {
50 S.Diag(L, diag::warn_unreachable) << R1 << R2;
51 }
52 };
53}
54
55/// CheckUnreachable - Check for unreachable code.
56static void CheckUnreachable(Sema &S, AnalysisContext &AC) {
57 UnreachableCodeHandler UC(S);
58 reachable_code::FindUnreachableCode(AC, UC);
59}
60
61//===----------------------------------------------------------------------===//
62// Check for missing return value.
63//===----------------------------------------------------------------------===//
64
John McCall16565aa2010-05-16 09:34:11 +000065enum ControlFlowKind {
66 UnknownFallThrough,
67 NeverFallThrough,
68 MaybeFallThrough,
69 AlwaysFallThrough,
70 NeverFallThroughOrReturn
71};
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +000072
73/// CheckFallThrough - Check that we don't fall off the end of a
74/// Statement that should return a value.
75///
76/// \returns AlwaysFallThrough iff we always fall off the end of the statement,
77/// MaybeFallThrough iff we might or might not fall off the end,
78/// NeverFallThroughOrReturn iff we never fall off the end of the statement or
79/// return. We assume NeverFallThrough iff we never fall off the end of the
80/// statement but we may return. We assume that functions not marked noreturn
81/// will return.
82static ControlFlowKind CheckFallThrough(AnalysisContext &AC) {
83 CFG *cfg = AC.getCFG();
John McCall16565aa2010-05-16 09:34:11 +000084 if (cfg == 0) return UnknownFallThrough;
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +000085
86 // The CFG leaves in dead things, and we don't want the dead code paths to
87 // confuse us, so we mark all live things first.
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +000088 llvm::BitVector live(cfg->getNumBlockIDs());
89 unsigned count = reachable_code::ScanReachableFromBlock(cfg->getEntry(),
90 live);
91
92 bool AddEHEdges = AC.getAddEHEdges();
93 if (!AddEHEdges && count != cfg->getNumBlockIDs())
94 // When there are things remaining dead, and we didn't add EH edges
95 // from CallExprs to the catch clauses, we have to go back and
96 // mark them as live.
97 for (CFG::iterator I = cfg->begin(), E = cfg->end(); I != E; ++I) {
98 CFGBlock &b = **I;
99 if (!live[b.getBlockID()]) {
100 if (b.pred_begin() == b.pred_end()) {
101 if (b.getTerminator() && isa<CXXTryStmt>(b.getTerminator()))
102 // When not adding EH edges from calls, catch clauses
103 // can otherwise seem dead. Avoid noting them as dead.
104 count += reachable_code::ScanReachableFromBlock(b, live);
105 continue;
106 }
107 }
108 }
109
110 // Now we know what is live, we check the live precessors of the exit block
111 // and look for fall through paths, being careful to ignore normal returns,
112 // and exceptional paths.
113 bool HasLiveReturn = false;
114 bool HasFakeEdge = false;
115 bool HasPlainEdge = false;
116 bool HasAbnormalEdge = false;
Ted Kremenek90b828a2010-09-09 00:06:07 +0000117
118 // Ignore default cases that aren't likely to be reachable because all
119 // enums in a switch(X) have explicit case statements.
120 CFGBlock::FilterOptions FO;
121 FO.IgnoreDefaultsWithCoveredEnums = 1;
122
123 for (CFGBlock::filtered_pred_iterator
124 I = cfg->getExit().filtered_pred_start_end(FO); I.hasMore(); ++I) {
125 const CFGBlock& B = **I;
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000126 if (!live[B.getBlockID()])
127 continue;
Ted Kremenek5811f592011-01-26 04:49:52 +0000128
129 // Destructors can appear after the 'return' in the CFG. This is
130 // normal. We need to look pass the destructors for the return
131 // statement (if it exists).
132 CFGBlock::const_reverse_iterator ri = B.rbegin(), re = B.rend();
Ted Kremenekc9f8f5a2011-03-02 20:32:29 +0000133 bool hasNoReturnDtor = false;
134
Ted Kremenek5811f592011-01-26 04:49:52 +0000135 for ( ; ri != re ; ++ri) {
136 CFGElement CE = *ri;
Ted Kremenekc9f8f5a2011-03-02 20:32:29 +0000137
138 // FIXME: The right solution is to just sever the edges in the
139 // CFG itself.
140 if (const CFGImplicitDtor *iDtor = ri->getAs<CFGImplicitDtor>())
Ted Kremenekc5aff442011-03-03 01:21:32 +0000141 if (iDtor->isNoReturn(AC.getASTContext())) {
Ted Kremenekc9f8f5a2011-03-02 20:32:29 +0000142 hasNoReturnDtor = true;
143 HasFakeEdge = true;
144 break;
145 }
146
Ted Kremenek5811f592011-01-26 04:49:52 +0000147 if (isa<CFGStmt>(CE))
148 break;
149 }
150
Ted Kremenekc9f8f5a2011-03-02 20:32:29 +0000151 if (hasNoReturnDtor)
152 continue;
153
Ted Kremenek5811f592011-01-26 04:49:52 +0000154 // No more CFGElements in the block?
155 if (ri == re) {
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000156 if (B.getTerminator() && isa<CXXTryStmt>(B.getTerminator())) {
157 HasAbnormalEdge = true;
158 continue;
159 }
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000160 // A labeled empty statement, or the entry block...
161 HasPlainEdge = true;
162 continue;
163 }
Ted Kremenekf39e6a32011-01-25 22:50:47 +0000164
Ted Kremenek5811f592011-01-26 04:49:52 +0000165 CFGStmt CS = cast<CFGStmt>(*ri);
Zhongxing Xub36cd3e2010-09-16 01:25:47 +0000166 Stmt *S = CS.getStmt();
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000167 if (isa<ReturnStmt>(S)) {
168 HasLiveReturn = true;
169 continue;
170 }
171 if (isa<ObjCAtThrowStmt>(S)) {
172 HasFakeEdge = true;
173 continue;
174 }
175 if (isa<CXXThrowExpr>(S)) {
176 HasFakeEdge = true;
177 continue;
178 }
179 if (const AsmStmt *AS = dyn_cast<AsmStmt>(S)) {
180 if (AS->isMSAsm()) {
181 HasFakeEdge = true;
182 HasLiveReturn = true;
183 continue;
184 }
185 }
186 if (isa<CXXTryStmt>(S)) {
187 HasAbnormalEdge = true;
188 continue;
189 }
190
191 bool NoReturnEdge = false;
192 if (CallExpr *C = dyn_cast<CallExpr>(S)) {
John McCall259d48e2010-04-30 07:10:06 +0000193 if (std::find(B.succ_begin(), B.succ_end(), &cfg->getExit())
194 == B.succ_end()) {
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000195 HasAbnormalEdge = true;
196 continue;
197 }
198 Expr *CEE = C->getCallee()->IgnoreParenCasts();
John McCall1de85332011-05-11 07:19:11 +0000199 QualType calleeType = CEE->getType();
200 if (calleeType == AC.getASTContext().BoundMemberTy) {
201 calleeType = Expr::findBoundMemberType(CEE);
202 assert(!calleeType.isNull() && "analyzing unresolved call?");
203 }
204 if (getFunctionExtInfo(calleeType).getNoReturn()) {
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000205 NoReturnEdge = true;
206 HasFakeEdge = true;
207 } else if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(CEE)) {
208 ValueDecl *VD = DRE->getDecl();
209 if (VD->hasAttr<NoReturnAttr>()) {
210 NoReturnEdge = true;
211 HasFakeEdge = true;
212 }
213 }
214 }
215 // FIXME: Add noreturn message sends.
216 if (NoReturnEdge == false)
217 HasPlainEdge = true;
218 }
219 if (!HasPlainEdge) {
220 if (HasLiveReturn)
221 return NeverFallThrough;
222 return NeverFallThroughOrReturn;
223 }
224 if (HasAbnormalEdge || HasFakeEdge || HasLiveReturn)
225 return MaybeFallThrough;
226 // This says AlwaysFallThrough for calls to functions that are not marked
227 // noreturn, that don't return. If people would like this warning to be more
228 // accurate, such functions should be marked as noreturn.
229 return AlwaysFallThrough;
230}
231
Dan Gohman3c46e8d2010-07-26 21:25:24 +0000232namespace {
233
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000234struct CheckFallThroughDiagnostics {
235 unsigned diag_MaybeFallThrough_HasNoReturn;
236 unsigned diag_MaybeFallThrough_ReturnsNonVoid;
237 unsigned diag_AlwaysFallThrough_HasNoReturn;
238 unsigned diag_AlwaysFallThrough_ReturnsNonVoid;
239 unsigned diag_NeverFallThroughOrReturn;
240 bool funMode;
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000241 SourceLocation FuncLoc;
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000242
Douglas Gregorca7eaee2010-04-16 23:28:44 +0000243 static CheckFallThroughDiagnostics MakeForFunction(const Decl *Func) {
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000244 CheckFallThroughDiagnostics D;
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000245 D.FuncLoc = Func->getLocation();
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000246 D.diag_MaybeFallThrough_HasNoReturn =
247 diag::warn_falloff_noreturn_function;
248 D.diag_MaybeFallThrough_ReturnsNonVoid =
249 diag::warn_maybe_falloff_nonvoid_function;
250 D.diag_AlwaysFallThrough_HasNoReturn =
251 diag::warn_falloff_noreturn_function;
252 D.diag_AlwaysFallThrough_ReturnsNonVoid =
253 diag::warn_falloff_nonvoid_function;
Douglas Gregorca7eaee2010-04-16 23:28:44 +0000254
255 // Don't suggest that virtual functions be marked "noreturn", since they
256 // might be overridden by non-noreturn functions.
257 bool isVirtualMethod = false;
258 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(Func))
259 isVirtualMethod = Method->isVirtual();
260
261 if (!isVirtualMethod)
262 D.diag_NeverFallThroughOrReturn =
263 diag::warn_suggest_noreturn_function;
264 else
265 D.diag_NeverFallThroughOrReturn = 0;
266
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000267 D.funMode = true;
268 return D;
269 }
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000270
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000271 static CheckFallThroughDiagnostics MakeForBlock() {
272 CheckFallThroughDiagnostics D;
273 D.diag_MaybeFallThrough_HasNoReturn =
274 diag::err_noreturn_block_has_return_expr;
275 D.diag_MaybeFallThrough_ReturnsNonVoid =
276 diag::err_maybe_falloff_nonvoid_block;
277 D.diag_AlwaysFallThrough_HasNoReturn =
278 diag::err_noreturn_block_has_return_expr;
279 D.diag_AlwaysFallThrough_ReturnsNonVoid =
280 diag::err_falloff_nonvoid_block;
281 D.diag_NeverFallThroughOrReturn =
282 diag::warn_suggest_noreturn_block;
283 D.funMode = false;
284 return D;
285 }
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000286
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000287 bool checkDiagnostics(Diagnostic &D, bool ReturnsVoid,
288 bool HasNoReturn) const {
289 if (funMode) {
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000290 return (ReturnsVoid ||
291 D.getDiagnosticLevel(diag::warn_maybe_falloff_nonvoid_function,
292 FuncLoc) == Diagnostic::Ignored)
293 && (!HasNoReturn ||
294 D.getDiagnosticLevel(diag::warn_noreturn_function_has_return_expr,
295 FuncLoc) == Diagnostic::Ignored)
296 && (!ReturnsVoid ||
297 D.getDiagnosticLevel(diag::warn_suggest_noreturn_block, FuncLoc)
298 == Diagnostic::Ignored);
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000299 }
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000300
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000301 // For blocks.
302 return ReturnsVoid && !HasNoReturn
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000303 && (!ReturnsVoid ||
304 D.getDiagnosticLevel(diag::warn_suggest_noreturn_block, FuncLoc)
305 == Diagnostic::Ignored);
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000306 }
307};
308
Dan Gohman3c46e8d2010-07-26 21:25:24 +0000309}
310
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000311/// CheckFallThroughForFunctionDef - Check that we don't fall off the end of a
312/// function that should return a value. Check that we don't fall off the end
313/// of a noreturn function. We assume that functions and blocks not marked
314/// noreturn will return.
315static void CheckFallThroughForBody(Sema &S, const Decl *D, const Stmt *Body,
Ted Kremenek3ed6fc02011-02-23 01:51:48 +0000316 const BlockExpr *blkExpr,
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000317 const CheckFallThroughDiagnostics& CD,
318 AnalysisContext &AC) {
319
320 bool ReturnsVoid = false;
321 bool HasNoReturn = false;
322
323 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
324 ReturnsVoid = FD->getResultType()->isVoidType();
325 HasNoReturn = FD->hasAttr<NoReturnAttr>() ||
Rafael Espindola264ba482010-03-30 20:24:48 +0000326 FD->getType()->getAs<FunctionType>()->getNoReturnAttr();
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000327 }
328 else if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
329 ReturnsVoid = MD->getResultType()->isVoidType();
330 HasNoReturn = MD->hasAttr<NoReturnAttr>();
331 }
332 else if (isa<BlockDecl>(D)) {
Ted Kremenek3ed6fc02011-02-23 01:51:48 +0000333 QualType BlockTy = blkExpr->getType();
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000334 if (const FunctionType *FT =
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000335 BlockTy->getPointeeType()->getAs<FunctionType>()) {
336 if (FT->getResultType()->isVoidType())
337 ReturnsVoid = true;
338 if (FT->getNoReturnAttr())
339 HasNoReturn = true;
340 }
341 }
342
343 Diagnostic &Diags = S.getDiagnostics();
344
345 // Short circuit for compilation speed.
346 if (CD.checkDiagnostics(Diags, ReturnsVoid, HasNoReturn))
347 return;
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000348
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000349 // FIXME: Function try block
350 if (const CompoundStmt *Compound = dyn_cast<CompoundStmt>(Body)) {
351 switch (CheckFallThrough(AC)) {
John McCall16565aa2010-05-16 09:34:11 +0000352 case UnknownFallThrough:
353 break;
354
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000355 case MaybeFallThrough:
356 if (HasNoReturn)
357 S.Diag(Compound->getRBracLoc(),
358 CD.diag_MaybeFallThrough_HasNoReturn);
359 else if (!ReturnsVoid)
360 S.Diag(Compound->getRBracLoc(),
361 CD.diag_MaybeFallThrough_ReturnsNonVoid);
362 break;
363 case AlwaysFallThrough:
364 if (HasNoReturn)
365 S.Diag(Compound->getRBracLoc(),
366 CD.diag_AlwaysFallThrough_HasNoReturn);
367 else if (!ReturnsVoid)
368 S.Diag(Compound->getRBracLoc(),
369 CD.diag_AlwaysFallThrough_ReturnsNonVoid);
370 break;
371 case NeverFallThroughOrReturn:
Douglas Gregorca7eaee2010-04-16 23:28:44 +0000372 if (ReturnsVoid && !HasNoReturn && CD.diag_NeverFallThroughOrReturn)
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000373 S.Diag(Compound->getLBracLoc(),
374 CD.diag_NeverFallThroughOrReturn);
375 break;
376 case NeverFallThrough:
377 break;
378 }
379 }
380}
381
382//===----------------------------------------------------------------------===//
Ted Kremenek610068c2011-01-15 02:58:47 +0000383// -Wuninitialized
384//===----------------------------------------------------------------------===//
385
Ted Kremenek6f417152011-04-04 20:56:00 +0000386namespace {
Chandler Carruth9f649462011-04-05 06:48:00 +0000387/// ContainsReference - A visitor class to search for references to
388/// a particular declaration (the needle) within any evaluated component of an
389/// expression (recursively).
Ted Kremenek6f417152011-04-04 20:56:00 +0000390class ContainsReference : public EvaluatedExprVisitor<ContainsReference> {
Chandler Carruth9f649462011-04-05 06:48:00 +0000391 bool FoundReference;
392 const DeclRefExpr *Needle;
393
Ted Kremenek6f417152011-04-04 20:56:00 +0000394public:
Chandler Carruth9f649462011-04-05 06:48:00 +0000395 ContainsReference(ASTContext &Context, const DeclRefExpr *Needle)
396 : EvaluatedExprVisitor<ContainsReference>(Context),
397 FoundReference(false), Needle(Needle) {}
398
399 void VisitExpr(Expr *E) {
Ted Kremenek6f417152011-04-04 20:56:00 +0000400 // Stop evaluating if we already have a reference.
Chandler Carruth9f649462011-04-05 06:48:00 +0000401 if (FoundReference)
Ted Kremenek6f417152011-04-04 20:56:00 +0000402 return;
Chandler Carruth9f649462011-04-05 06:48:00 +0000403
404 EvaluatedExprVisitor<ContainsReference>::VisitExpr(E);
Ted Kremenek6f417152011-04-04 20:56:00 +0000405 }
Chandler Carruth9f649462011-04-05 06:48:00 +0000406
407 void VisitDeclRefExpr(DeclRefExpr *E) {
408 if (E == Needle)
409 FoundReference = true;
410 else
411 EvaluatedExprVisitor<ContainsReference>::VisitDeclRefExpr(E);
Ted Kremenek6f417152011-04-04 20:56:00 +0000412 }
Chandler Carruth9f649462011-04-05 06:48:00 +0000413
414 bool doesContainReference() const { return FoundReference; }
Ted Kremenek6f417152011-04-04 20:56:00 +0000415};
416}
417
Chandler Carruth262d50e2011-04-05 18:27:05 +0000418/// DiagnoseUninitializedUse -- Helper function for diagnosing uses of an
419/// uninitialized variable. This manages the different forms of diagnostic
420/// emitted for particular types of uses. Returns true if the use was diagnosed
421/// as a warning. If a pariticular use is one we omit warnings for, returns
422/// false.
423static bool DiagnoseUninitializedUse(Sema &S, const VarDecl *VD,
Chandler Carruth64fb9592011-04-05 18:18:08 +0000424 const Expr *E, bool isAlwaysUninit) {
Chandler Carruth4c4983b2011-04-05 18:18:05 +0000425 bool isSelfInit = false;
426
427 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) {
428 if (isAlwaysUninit) {
429 // Inspect the initializer of the variable declaration which is
430 // being referenced prior to its initialization. We emit
431 // specialized diagnostics for self-initialization, and we
432 // specifically avoid warning about self references which take the
433 // form of:
434 //
435 // int x = x;
436 //
437 // This is used to indicate to GCC that 'x' is intentionally left
438 // uninitialized. Proven code paths which access 'x' in
439 // an uninitialized state after this will still warn.
440 //
441 // TODO: Should we suppress maybe-uninitialized warnings for
442 // variables initialized in this way?
443 if (const Expr *Initializer = VD->getInit()) {
444 if (DRE == Initializer->IgnoreParenImpCasts())
Chandler Carruth262d50e2011-04-05 18:27:05 +0000445 return false;
Chandler Carruth4c4983b2011-04-05 18:18:05 +0000446
447 ContainsReference CR(S.Context, DRE);
448 CR.Visit(const_cast<Expr*>(Initializer));
449 isSelfInit = CR.doesContainReference();
450 }
451 if (isSelfInit) {
452 S.Diag(DRE->getLocStart(),
453 diag::warn_uninit_self_reference_in_init)
454 << VD->getDeclName() << VD->getLocation() << DRE->getSourceRange();
455 } else {
456 S.Diag(DRE->getLocStart(), diag::warn_uninit_var)
457 << VD->getDeclName() << DRE->getSourceRange();
458 }
459 } else {
460 S.Diag(DRE->getLocStart(), diag::warn_maybe_uninit_var)
461 << VD->getDeclName() << DRE->getSourceRange();
462 }
463 } else {
464 const BlockExpr *BE = cast<BlockExpr>(E);
465 S.Diag(BE->getLocStart(),
466 isAlwaysUninit ? diag::warn_uninit_var_captured_by_block
467 : diag::warn_maybe_uninit_var_captured_by_block)
468 << VD->getDeclName();
469 }
470
471 // Report where the variable was declared when the use wasn't within
472 // the initializer of that declaration.
473 if (!isSelfInit)
474 S.Diag(VD->getLocStart(), diag::note_uninit_var_def)
475 << VD->getDeclName();
476
Chandler Carruth262d50e2011-04-05 18:27:05 +0000477 return true;
Chandler Carruth64fb9592011-04-05 18:18:08 +0000478}
479
Chandler Carruth262d50e2011-04-05 18:27:05 +0000480static void SuggestInitializationFixit(Sema &S, const VarDecl *VD) {
Chandler Carruth4c4983b2011-04-05 18:18:05 +0000481 // Don't issue a fixit if there is already an initializer.
482 if (VD->getInit())
483 return;
484
485 // Suggest possible initialization (if any).
486 const char *initialization = 0;
487 QualType VariableTy = VD->getType().getCanonicalType();
488
Douglas Gregor8ba44262011-07-02 00:59:18 +0000489 if (VariableTy->isObjCObjectPointerType() ||
490 VariableTy->isBlockPointerType()) {
Chandler Carruth4c4983b2011-04-05 18:18:05 +0000491 // Check if 'nil' is defined.
492 if (S.PP.getMacroInfo(&S.getASTContext().Idents.get("nil")))
493 initialization = " = nil";
494 else
495 initialization = " = 0";
496 }
497 else if (VariableTy->isRealFloatingType())
498 initialization = " = 0.0";
499 else if (VariableTy->isBooleanType() && S.Context.getLangOptions().CPlusPlus)
500 initialization = " = false";
501 else if (VariableTy->isEnumeralType())
502 return;
Douglas Gregor8ba44262011-07-02 00:59:18 +0000503 else if (VariableTy->isPointerType() || VariableTy->isMemberPointerType()) {
504 // Check if 'NULL' is defined.
505 if (S.PP.getMacroInfo(&S.getASTContext().Idents.get("NULL")))
506 initialization = " = NULL";
507 else
508 initialization = " = 0";
509 }
Chandler Carruth4c4983b2011-04-05 18:18:05 +0000510 else if (VariableTy->isScalarType())
511 initialization = " = 0";
512
513 if (initialization) {
514 SourceLocation loc = S.PP.getLocForEndOfToken(VD->getLocEnd());
515 S.Diag(loc, diag::note_var_fixit_add_initialization)
516 << FixItHint::CreateInsertion(loc, initialization);
517 }
518}
519
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000520typedef std::pair<const Expr*, bool> UninitUse;
521
Ted Kremenek610068c2011-01-15 02:58:47 +0000522namespace {
Ted Kremenek94b1b4d2011-01-21 19:41:41 +0000523struct SLocSort {
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000524 bool operator()(const UninitUse &a, const UninitUse &b) {
525 SourceLocation aLoc = a.first->getLocStart();
526 SourceLocation bLoc = b.first->getLocStart();
Ted Kremenek94b1b4d2011-01-21 19:41:41 +0000527 return aLoc.getRawEncoding() < bLoc.getRawEncoding();
528 }
529};
530
Ted Kremenek610068c2011-01-15 02:58:47 +0000531class UninitValsDiagReporter : public UninitVariablesHandler {
532 Sema &S;
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000533 typedef llvm::SmallVector<UninitUse, 2> UsesVec;
Ted Kremenek94b1b4d2011-01-21 19:41:41 +0000534 typedef llvm::DenseMap<const VarDecl *, UsesVec*> UsesMap;
535 UsesMap *uses;
536
Ted Kremenek610068c2011-01-15 02:58:47 +0000537public:
Ted Kremenek94b1b4d2011-01-21 19:41:41 +0000538 UninitValsDiagReporter(Sema &S) : S(S), uses(0) {}
539 ~UninitValsDiagReporter() {
540 flushDiagnostics();
541 }
Ted Kremenek610068c2011-01-15 02:58:47 +0000542
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000543 void handleUseOfUninitVariable(const Expr *ex, const VarDecl *vd,
544 bool isAlwaysUninit) {
Ted Kremenek94b1b4d2011-01-21 19:41:41 +0000545 if (!uses)
546 uses = new UsesMap();
547
548 UsesVec *&vec = (*uses)[vd];
549 if (!vec)
550 vec = new UsesVec();
551
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000552 vec->push_back(std::make_pair(ex, isAlwaysUninit));
Ted Kremenek94b1b4d2011-01-21 19:41:41 +0000553 }
554
555 void flushDiagnostics() {
556 if (!uses)
557 return;
Ted Kremenek609e3172011-02-02 23:35:53 +0000558
Ted Kremenek94b1b4d2011-01-21 19:41:41 +0000559 for (UsesMap::iterator i = uses->begin(), e = uses->end(); i != e; ++i) {
560 const VarDecl *vd = i->first;
561 UsesVec *vec = i->second;
Ted Kremenek609e3172011-02-02 23:35:53 +0000562
563 bool fixitIssued = false;
564
Ted Kremenek94b1b4d2011-01-21 19:41:41 +0000565 // Sort the uses by their SourceLocations. While not strictly
566 // guaranteed to produce them in line/column order, this will provide
567 // a stable ordering.
568 std::sort(vec->begin(), vec->end(), SLocSort());
569
Chandler Carruth64fb9592011-04-05 18:18:08 +0000570 for (UsesVec::iterator vi = vec->begin(), ve = vec->end(); vi != ve;
571 ++vi) {
Chandler Carruth262d50e2011-04-05 18:27:05 +0000572 if (!DiagnoseUninitializedUse(S, vd, vi->first,
573 /*isAlwaysUninit=*/vi->second))
574 continue;
575
576 // Suggest a fixit hint the first time we diagnose a use of a variable.
577 if (!fixitIssued) {
578 SuggestInitializationFixit(S, vd);
579 fixitIssued = true;
580 }
Chandler Carruth64fb9592011-04-05 18:18:08 +0000581 }
Ted Kremenekd40066b2011-04-04 23:29:12 +0000582
Ted Kremenek94b1b4d2011-01-21 19:41:41 +0000583 delete vec;
584 }
585 delete uses;
Ted Kremenek610068c2011-01-15 02:58:47 +0000586 }
587};
588}
589
590//===----------------------------------------------------------------------===//
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000591// AnalysisBasedWarnings - Worker object used by Sema to execute analysis-based
592// warnings on a function, method, or block.
593//===----------------------------------------------------------------------===//
594
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000595clang::sema::AnalysisBasedWarnings::Policy::Policy() {
596 enableCheckFallThrough = 1;
597 enableCheckUnreachable = 0;
598}
599
Chandler Carruth5d989942011-07-06 16:21:37 +0000600clang::sema::AnalysisBasedWarnings::AnalysisBasedWarnings(Sema &s)
601 : S(s),
602 NumFunctionsAnalyzed(0),
Benjamin Kramer54cf3412011-07-08 20:38:53 +0000603 NumFunctionsWithBadCFGs(0),
Chandler Carruth5d989942011-07-06 16:21:37 +0000604 NumCFGBlocks(0),
Benjamin Kramer54cf3412011-07-08 20:38:53 +0000605 MaxCFGBlocksPerFunction(0),
606 NumUninitAnalysisFunctions(0),
607 NumUninitAnalysisVariables(0),
608 MaxUninitAnalysisVariablesPerFunction(0),
609 NumUninitAnalysisBlockVisits(0),
610 MaxUninitAnalysisBlockVisitsPerFunction(0) {
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000611 Diagnostic &D = S.getDiagnostics();
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000612 DefaultPolicy.enableCheckUnreachable = (unsigned)
Argyrios Kyrtzidis08274082010-12-15 18:44:22 +0000613 (D.getDiagnosticLevel(diag::warn_unreachable, SourceLocation()) !=
614 Diagnostic::Ignored);
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000615}
616
Ted Kremenek351ba912011-02-23 01:52:04 +0000617static void flushDiagnostics(Sema &S, sema::FunctionScopeInfo *fscope) {
618 for (llvm::SmallVectorImpl<sema::PossiblyUnreachableDiag>::iterator
619 i = fscope->PossiblyUnreachableDiags.begin(),
620 e = fscope->PossiblyUnreachableDiags.end();
621 i != e; ++i) {
622 const sema::PossiblyUnreachableDiag &D = *i;
623 S.Diag(D.Loc, D.PD);
624 }
625}
626
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000627void clang::sema::
628AnalysisBasedWarnings::IssueWarnings(sema::AnalysisBasedWarnings::Policy P,
Ted Kremenek283a3582011-02-23 01:51:53 +0000629 sema::FunctionScopeInfo *fscope,
Ted Kremenek3ed6fc02011-02-23 01:51:48 +0000630 const Decl *D, const BlockExpr *blkExpr) {
Ted Kremenekd068aab2010-03-20 21:11:09 +0000631
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000632 // We avoid doing analysis-based warnings when there are errors for
633 // two reasons:
634 // (1) The CFGs often can't be constructed (if the body is invalid), so
635 // don't bother trying.
636 // (2) The code already has problems; running the analysis just takes more
637 // time.
Ted Kremenek99e81922010-04-30 21:49:25 +0000638 Diagnostic &Diags = S.getDiagnostics();
639
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000640 // Do not do any analysis for declarations in system headers if we are
641 // going to just ignore them.
Ted Kremenek99e81922010-04-30 21:49:25 +0000642 if (Diags.getSuppressSystemWarnings() &&
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000643 S.SourceMgr.isInSystemHeader(D->getLocation()))
644 return;
645
John McCalle0054f62010-08-25 05:56:39 +0000646 // For code in dependent contexts, we'll do this at instantiation time.
647 if (cast<DeclContext>(D)->isDependentContext())
648 return;
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000649
Ted Kremenek351ba912011-02-23 01:52:04 +0000650 if (Diags.hasErrorOccurred() || Diags.hasFatalErrorOccurred()) {
651 // Flush out any possibly unreachable diagnostics.
652 flushDiagnostics(S, fscope);
653 return;
654 }
655
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000656 const Stmt *Body = D->getBody();
657 assert(Body);
658
659 // Don't generate EH edges for CallExprs as we'd like to avoid the n^2
660 // explosion for destrutors that can result and the compile time hit.
Chandler Carrutheeef9242011-01-08 06:54:40 +0000661 AnalysisContext AC(D, 0, /*useUnoptimizedCFG=*/false, /*addehedges=*/false,
662 /*addImplicitDtors=*/true, /*addInitializers=*/true);
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000663
Ted Kremenek351ba912011-02-23 01:52:04 +0000664 // Emit delayed diagnostics.
665 if (!fscope->PossiblyUnreachableDiags.empty()) {
666 bool analyzed = false;
Ted Kremenek0d28d362011-03-10 03:50:34 +0000667
668 // Register the expressions with the CFGBuilder.
669 for (llvm::SmallVectorImpl<sema::PossiblyUnreachableDiag>::iterator
670 i = fscope->PossiblyUnreachableDiags.begin(),
671 e = fscope->PossiblyUnreachableDiags.end();
672 i != e; ++i) {
673 if (const Stmt *stmt = i->stmt)
674 AC.registerForcedBlockExpression(stmt);
675 }
676
677 if (AC.getCFG()) {
678 analyzed = true;
679 for (llvm::SmallVectorImpl<sema::PossiblyUnreachableDiag>::iterator
680 i = fscope->PossiblyUnreachableDiags.begin(),
681 e = fscope->PossiblyUnreachableDiags.end();
682 i != e; ++i)
683 {
684 const sema::PossiblyUnreachableDiag &D = *i;
685 bool processed = false;
686 if (const Stmt *stmt = i->stmt) {
687 const CFGBlock *block = AC.getBlockForRegisteredExpression(stmt);
688 assert(block);
Ted Kremenekaf13d5b2011-03-19 01:00:33 +0000689 if (CFGReverseBlockReachabilityAnalysis *cra = AC.getCFGReachablityAnalysis()) {
Ted Kremenek351ba912011-02-23 01:52:04 +0000690 // Can this block be reached from the entrance?
Ted Kremenek0d28d362011-03-10 03:50:34 +0000691 if (cra->isReachable(&AC.getCFG()->getEntry(), block))
Ted Kremenek351ba912011-02-23 01:52:04 +0000692 S.Diag(D.Loc, D.PD);
Ted Kremenek0d28d362011-03-10 03:50:34 +0000693 processed = true;
Ted Kremenek351ba912011-02-23 01:52:04 +0000694 }
695 }
Ted Kremenek0d28d362011-03-10 03:50:34 +0000696 if (!processed) {
697 // Emit the warning anyway if we cannot map to a basic block.
698 S.Diag(D.Loc, D.PD);
699 }
Ted Kremenek351ba912011-02-23 01:52:04 +0000700 }
Ted Kremenek0d28d362011-03-10 03:50:34 +0000701 }
Ted Kremenek351ba912011-02-23 01:52:04 +0000702
703 if (!analyzed)
704 flushDiagnostics(S, fscope);
705 }
706
707
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000708 // Warning: check missing 'return'
Ted Kremenekd064fdc2010-03-23 00:13:23 +0000709 if (P.enableCheckFallThrough) {
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000710 const CheckFallThroughDiagnostics &CD =
711 (isa<BlockDecl>(D) ? CheckFallThroughDiagnostics::MakeForBlock()
Douglas Gregorca7eaee2010-04-16 23:28:44 +0000712 : CheckFallThroughDiagnostics::MakeForFunction(D));
Ted Kremenek3ed6fc02011-02-23 01:51:48 +0000713 CheckFallThroughForBody(S, D, Body, blkExpr, CD, AC);
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000714 }
715
716 // Warning: check for unreachable code
Ted Kremenekb7e5f142010-04-08 18:51:44 +0000717 if (P.enableCheckUnreachable)
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000718 CheckUnreachable(S, AC);
Ted Kremenek610068c2011-01-15 02:58:47 +0000719
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000720 if (Diags.getDiagnosticLevel(diag::warn_uninit_var, D->getLocStart())
Ted Kremenek76709bf2011-03-15 05:22:28 +0000721 != Diagnostic::Ignored ||
722 Diags.getDiagnosticLevel(diag::warn_maybe_uninit_var, D->getLocStart())
Ted Kremenek610068c2011-01-15 02:58:47 +0000723 != Diagnostic::Ignored) {
Ted Kremenekc5e43c12011-03-17 05:29:57 +0000724 if (CFG *cfg = AC.getCFG()) {
Ted Kremenekc21fed32011-01-18 21:18:58 +0000725 UninitValsDiagReporter reporter(S);
Chandler Carruth5d989942011-07-06 16:21:37 +0000726 UninitVariablesAnalysisStats stats = {};
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000727 runUninitializedVariablesAnalysis(*cast<DeclContext>(D), *cfg, AC,
Chandler Carruth5d989942011-07-06 16:21:37 +0000728 reporter, stats);
729
730 if (S.CollectStats && stats.NumVariablesAnalyzed > 0) {
731 ++NumUninitAnalysisFunctions;
732 NumUninitAnalysisVariables += stats.NumVariablesAnalyzed;
733 NumUninitAnalysisBlockVisits += stats.NumBlockVisits;
734 MaxUninitAnalysisVariablesPerFunction =
735 std::max(MaxUninitAnalysisVariablesPerFunction,
736 stats.NumVariablesAnalyzed);
737 MaxUninitAnalysisBlockVisitsPerFunction =
738 std::max(MaxUninitAnalysisBlockVisitsPerFunction,
739 stats.NumBlockVisits);
740 }
Ted Kremenek610068c2011-01-15 02:58:47 +0000741 }
742 }
Chandler Carruth5d989942011-07-06 16:21:37 +0000743
744 // Collect statistics about the CFG if it was built.
745 if (S.CollectStats && AC.isCFGBuilt()) {
746 ++NumFunctionsAnalyzed;
747 if (CFG *cfg = AC.getCFG()) {
748 // If we successfully built a CFG for this context, record some more
749 // detail information about it.
Chandler Carruth3ea4c492011-07-06 22:21:45 +0000750 NumCFGBlocks += cfg->getNumBlockIDs();
Chandler Carruth5d989942011-07-06 16:21:37 +0000751 MaxCFGBlocksPerFunction = std::max(MaxCFGBlocksPerFunction,
Chandler Carruth3ea4c492011-07-06 22:21:45 +0000752 cfg->getNumBlockIDs());
Chandler Carruth5d989942011-07-06 16:21:37 +0000753 } else {
754 ++NumFunctionsWithBadCFGs;
755 }
756 }
757}
758
759void clang::sema::AnalysisBasedWarnings::PrintStats() const {
760 llvm::errs() << "\n*** Analysis Based Warnings Stats:\n";
761
762 unsigned NumCFGsBuilt = NumFunctionsAnalyzed - NumFunctionsWithBadCFGs;
763 unsigned AvgCFGBlocksPerFunction =
764 !NumCFGsBuilt ? 0 : NumCFGBlocks/NumCFGsBuilt;
765 llvm::errs() << NumFunctionsAnalyzed << " functions analyzed ("
766 << NumFunctionsWithBadCFGs << " w/o CFGs).\n"
767 << " " << NumCFGBlocks << " CFG blocks built.\n"
768 << " " << AvgCFGBlocksPerFunction
769 << " average CFG blocks per function.\n"
770 << " " << MaxCFGBlocksPerFunction
771 << " max CFG blocks per function.\n";
772
773 unsigned AvgUninitVariablesPerFunction = !NumUninitAnalysisFunctions ? 0
774 : NumUninitAnalysisVariables/NumUninitAnalysisFunctions;
775 unsigned AvgUninitBlockVisitsPerFunction = !NumUninitAnalysisFunctions ? 0
776 : NumUninitAnalysisBlockVisits/NumUninitAnalysisFunctions;
777 llvm::errs() << NumUninitAnalysisFunctions
778 << " functions analyzed for uninitialiazed variables\n"
779 << " " << NumUninitAnalysisVariables << " variables analyzed.\n"
780 << " " << AvgUninitVariablesPerFunction
781 << " average variables per function.\n"
782 << " " << MaxUninitAnalysisVariablesPerFunction
783 << " max variables per function.\n"
784 << " " << NumUninitAnalysisBlockVisits << " block visits.\n"
785 << " " << AvgUninitBlockVisitsPerFunction
786 << " average block visits per function.\n"
787 << " " << MaxUninitAnalysisBlockVisitsPerFunction
788 << " max block visits per function.\n";
Ted Kremenekdbdbaaf2010-03-20 21:06:02 +0000789}