1 //=- 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 
16 #include "clang/Sema/AnalysisBasedWarnings.h"
17 #include "clang/AST/DeclCXX.h"
18 #include "clang/AST/DeclObjC.h"
19 #include "clang/AST/EvaluatedExprVisitor.h"
20 #include "clang/AST/ExprCXX.h"
21 #include "clang/AST/ExprObjC.h"
22 #include "clang/AST/ParentMap.h"
23 #include "clang/AST/RecursiveASTVisitor.h"
24 #include "clang/AST/StmtCXX.h"
25 #include "clang/AST/StmtObjC.h"
26 #include "clang/AST/StmtVisitor.h"
27 #include "clang/Analysis/Analyses/CFGReachabilityAnalysis.h"
28 #include "clang/Analysis/Analyses/Consumed.h"
29 #include "clang/Analysis/Analyses/ReachableCode.h"
30 #include "clang/Analysis/Analyses/ThreadSafety.h"
31 #include "clang/Analysis/Analyses/UninitializedValues.h"
32 #include "clang/Analysis/AnalysisContext.h"
33 #include "clang/Analysis/CFG.h"
34 #include "clang/Analysis/CFGStmtMap.h"
35 #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"
41 #include "llvm/ADT/ArrayRef.h"
42 #include "llvm/ADT/BitVector.h"
43 #include "llvm/ADT/FoldingSet.h"
44 #include "llvm/ADT/ImmutableMap.h"
45 #include "llvm/ADT/MapVector.h"
46 #include "llvm/ADT/PostOrderIterator.h"
47 #include "llvm/ADT/SmallString.h"
48 #include "llvm/ADT/SmallVector.h"
49 #include "llvm/ADT/StringRef.h"
50 #include "llvm/Support/Casting.h"
51 #include <algorithm>
52 #include <deque>
53 #include <iterator>
54 #include <vector>
55 
56 using namespace clang;
57 
58 //===----------------------------------------------------------------------===//
59 // Unreachable code analysis.
60 //===----------------------------------------------------------------------===//
61 
62 namespace {
63   class UnreachableCodeHandler : public reachable_code::Callback {
64     Sema &S;
65   public:
66     UnreachableCodeHandler(Sema &s) : S(s) {}
67 
68     void HandleUnreachable(reachable_code::UnreachableKind UK,
69                            SourceLocation L,
70                            SourceRange SilenceableCondVal,
71                            SourceRange R1,
72                            SourceRange R2) override {
73       unsigned diag = diag::warn_unreachable;
74       switch (UK) {
75         case reachable_code::UK_Break:
76           diag = diag::warn_unreachable_break;
77           break;
78         case reachable_code::UK_Return:
79           diag = diag::warn_unreachable_return;
80           break;
81         case reachable_code::UK_Loop_Increment:
82           diag = diag::warn_unreachable_loop_increment;
83           break;
84         case reachable_code::UK_Other:
85           break;
86       }
87 
88       S.Diag(L, diag) << R1 << R2;
89 
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       }
100     }
101   };
102 }
103 
104 /// CheckUnreachable - Check for unreachable code.
105 static void CheckUnreachable(Sema &S, AnalysisDeclContext &AC) {
106   // 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 
116   UnreachableCodeHandler UC(S);
117   reachable_code::FindUnreachableCode(AC, S.getPreprocessor(), UC);
118 }
119 
120 //===----------------------------------------------------------------------===//
121 // 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.
126 enum RecursiveState {
127   FoundNoPath,
128   FoundPath,
129   FoundPathWithNoRecursiveCall
130 };
131 
132 static 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) {
159 
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 
171         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 
191 static 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 //===----------------------------------------------------------------------===//
222 // Check for missing return value.
223 //===----------------------------------------------------------------------===//
224 
225 enum ControlFlowKind {
226   UnknownFallThrough,
227   NeverFallThrough,
228   MaybeFallThrough,
229   AlwaysFallThrough,
230   NeverFallThroughOrReturn
231 };
232 
233 /// CheckFallThrough - Check that we don't fall off the end of a
234 /// Statement that should return a value.
235 ///
236 /// \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
240 /// statement but we may return.  We assume that functions not marked noreturn
241 /// will return.
242 static ControlFlowKind CheckFallThrough(AnalysisDeclContext &AC) {
243   CFG *cfg = AC.getCFG();
244   if (cfg == 0) return UnknownFallThrough;
245 
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.
248   llvm::BitVector live(cfg->getNumBlockIDs());
249   unsigned count = reachable_code::ScanReachableFromBlock(&cfg->getEntry(),
250                                                           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.
264             count += reachable_code::ScanReachableFromBlock(&b, live);
265           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;
277 
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;
286     if (!live[B.getBlockID()])
287       continue;
288 
289     // 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 
297     // 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();
301 
302     for ( ; ri != re ; ++ri)
303       if (ri->getAs<CFGStmt>())
304         break;
305 
306     // No more CFGElements in the block?
307     if (ri == re) {
308       if (B.getTerminator() && isa<CXXTryStmt>(B.getTerminator())) {
309         HasAbnormalEdge = true;
310         continue;
311       }
312       // A labeled empty statement, or the entry block...
313       HasPlainEdge = true;
314       continue;
315     }
316 
317     CFGStmt CS = ri->castAs<CFGStmt>();
318     const Stmt *S = CS.getStmt();
319     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     }
331     if (isa<MSAsmStmt>(S)) {
332       // TODO: Verify this is correct.
333       HasFakeEdge = true;
334       HasLiveReturn = true;
335       continue;
336     }
337     if (isa<CXXTryStmt>(S)) {
338       HasAbnormalEdge = true;
339       continue;
340     }
341     if (std::find(B.succ_begin(), B.succ_end(), &cfg->getExit())
342         == B.succ_end()) {
343       HasAbnormalEdge = true;
344       continue;
345     }
346 
347     HasPlainEdge = true;
348   }
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 
362 namespace {
363 
364 struct 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;
370   enum { Function, Block, Lambda } funMode;
371   SourceLocation FuncLoc;
372 
373   static CheckFallThroughDiagnostics MakeForFunction(const Decl *Func) {
374     CheckFallThroughDiagnostics D;
375     D.FuncLoc = Func->getLocation();
376     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;
384 
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 
391     // Don't suggest that template instantiations be marked "noreturn"
392     bool isTemplateInstantiation = false;
393     if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(Func))
394       isTemplateInstantiation = Function->isTemplateInstantiation();
395 
396     if (!isVirtualMethod && !isTemplateInstantiation)
397       D.diag_NeverFallThroughOrReturn =
398         diag::warn_suggest_noreturn_function;
399     else
400       D.diag_NeverFallThroughOrReturn = 0;
401 
402     D.funMode = Function;
403     return D;
404   }
405 
406   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;
418     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;
434     return D;
435   }
436 
437   bool checkDiagnostics(DiagnosticsEngine &D, bool ReturnsVoid,
438                         bool HasNoReturn) const {
439     if (funMode == Function) {
440       return (ReturnsVoid ||
441               D.getDiagnosticLevel(diag::warn_maybe_falloff_nonvoid_function,
442                                    FuncLoc) == DiagnosticsEngine::Ignored)
443         && (!HasNoReturn ||
444             D.getDiagnosticLevel(diag::warn_noreturn_function_has_return_expr,
445                                  FuncLoc) == DiagnosticsEngine::Ignored)
446         && (!ReturnsVoid ||
447             D.getDiagnosticLevel(diag::warn_suggest_noreturn_block, FuncLoc)
448               == DiagnosticsEngine::Ignored);
449     }
450 
451     // For blocks / lambdas.
452     return ReturnsVoid && !HasNoReturn
453             && ((funMode == Lambda) ||
454                 D.getDiagnosticLevel(diag::warn_suggest_noreturn_block, FuncLoc)
455                   == DiagnosticsEngine::Ignored);
456   }
457 };
458 
459 }
460 
461 /// 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.
465 static void CheckFallThroughForBody(Sema &S, const Decl *D, const Stmt *Body,
466                                     const BlockExpr *blkExpr,
467                                     const CheckFallThroughDiagnostics& CD,
468                                     AnalysisDeclContext &AC) {
469 
470   bool ReturnsVoid = false;
471   bool HasNoReturn = false;
472 
473   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
474     ReturnsVoid = FD->getReturnType()->isVoidType();
475     HasNoReturn = FD->isNoReturn();
476   }
477   else if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
478     ReturnsVoid = MD->getReturnType()->isVoidType();
479     HasNoReturn = MD->hasAttr<NoReturnAttr>();
480   }
481   else if (isa<BlockDecl>(D)) {
482     QualType BlockTy = blkExpr->getType();
483     if (const FunctionType *FT =
484           BlockTy->getPointeeType()->getAs<FunctionType>()) {
485       if (FT->getReturnType()->isVoidType())
486         ReturnsVoid = true;
487       if (FT->getNoReturnAttr())
488         HasNoReturn = true;
489     }
490   }
491 
492   DiagnosticsEngine &Diags = S.getDiagnostics();
493 
494   // Short circuit for compilation speed.
495   if (CD.checkDiagnostics(Diags, ReturnsVoid, HasNoReturn))
496       return;
497 
498   // FIXME: Function try block
499   if (const CompoundStmt *Compound = dyn_cast<CompoundStmt>(Body)) {
500     switch (CheckFallThrough(AC)) {
501       case UnknownFallThrough:
502         break;
503 
504       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:
521         if (ReturnsVoid && !HasNoReturn && CD.diag_NeverFallThroughOrReturn) {
522           if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
523             S.Diag(Compound->getLBracLoc(), CD.diag_NeverFallThroughOrReturn)
524               << 0 << FD;
525           } else if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
526             S.Diag(Compound->getLBracLoc(), CD.diag_NeverFallThroughOrReturn)
527               << 1 << MD;
528           } else {
529             S.Diag(Compound->getLBracLoc(), CD.diag_NeverFallThroughOrReturn);
530           }
531         }
532         break;
533       case NeverFallThrough:
534         break;
535     }
536   }
537 }
538 
539 //===----------------------------------------------------------------------===//
540 // -Wuninitialized
541 //===----------------------------------------------------------------------===//
542 
543 namespace {
544 /// ContainsReference - A visitor class to search for references to
545 /// a particular declaration (the needle) within any evaluated component of an
546 /// expression (recursively).
547 class ContainsReference : public EvaluatedExprVisitor<ContainsReference> {
548   bool FoundReference;
549   const DeclRefExpr *Needle;
550 
551 public:
552   ContainsReference(ASTContext &Context, const DeclRefExpr *Needle)
553     : EvaluatedExprVisitor<ContainsReference>(Context),
554       FoundReference(false), Needle(Needle) {}
555 
556   void VisitExpr(Expr *E) {
557     // Stop evaluating if we already have a reference.
558     if (FoundReference)
559       return;
560 
561     EvaluatedExprVisitor<ContainsReference>::VisitExpr(E);
562   }
563 
564   void VisitDeclRefExpr(DeclRefExpr *E) {
565     if (E == Needle)
566       FoundReference = true;
567     else
568       EvaluatedExprVisitor<ContainsReference>::VisitDeclRefExpr(E);
569   }
570 
571   bool doesContainReference() const { return FoundReference; }
572 };
573 }
574 
575 static bool SuggestInitializationFixit(Sema &S, const VarDecl *VD) {
576   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   }
583 
584   // Don't issue a fixit if there is already an initializer.
585   if (VD->getInit())
586     return false;
587 
588   // Don't suggest a fixit inside macros.
589   if (VD->getLocEnd().isMacroID())
590     return false;
591 
592   SourceLocation Loc = S.PP.getLocForEndOfToken(VD->getLocEnd());
593 
594   // Suggest possible initialization (if any).
595   std::string Init = S.getFixItZeroInitializerForType(VariableTy, Loc);
596   if (Init.empty())
597     return false;
598 
599   S.Diag(Loc, diag::note_var_fixit_add_initialization) << VD->getDeclName()
600     << FixItHint::CreateInsertion(Loc, Init);
601   return true;
602 }
603 
604 /// Create a fixit to remove an if-like statement, on the assumption that its
605 /// condition is CondVal.
606 static 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.
633 static void DiagUninitUse(Sema &S, const VarDecl *VD, const UninitUse &Use,
634                           bool IsCapturedByBlock) {
635   bool Diagnosed = false;
636 
637   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 
662   // Diagnose each branch which leads to a sometimes-uninitialized use.
663   for (UninitUse::branch_iterator I = Use.branch_begin(), E = Use.branch_end();
664        I != E; ++I) {
665     assert(Use.getKind() == UninitUse::Sometimes);
666 
667     const Expr *User = Use.getUser();
668     const Stmt *Term = I->Terminator;
669 
670     // Information used when building the diagnostic.
671     unsigned DiagKind;
672     StringRef Str;
673     SourceRange Range;
674 
675     // FixIts to suppress the diagnostic by removing the dead condition.
676     // 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 
684     switch (Term ? Term->getStmtClass() : Stmt::DeclStmtClass) {
685     default:
686       // Don't know how to report this. Just fall back to 'may be used
687       // uninitialized'. FIXME: Can this happen?
688       continue;
689 
690     // "condition is true / condition is false".
691     case Stmt::IfStmtClass: {
692       const IfStmt *IS = cast<IfStmt>(Term);
693       DiagKind = 0;
694       Str = "if";
695       Range = IS->getCond()->getSourceRange();
696       RemoveDiagKind = 0;
697       CreateIfFixit(S, IS, IS->getThen(), IS->getElse(),
698                     I->Output, Fixit1, Fixit2);
699       break;
700     }
701     case Stmt::ConditionalOperatorClass: {
702       const ConditionalOperator *CO = cast<ConditionalOperator>(Term);
703       DiagKind = 0;
704       Str = "?:";
705       Range = CO->getCond()->getSourceRange();
706       RemoveDiagKind = 0;
707       CreateIfFixit(S, CO, CO->getTrueExpr(), CO->getFalseExpr(),
708                     I->Output, Fixit1, Fixit2);
709       break;
710     }
711     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();
718       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);
727       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();
735       RemoveDiagKind = 1;
736       Fixit1 = FixItHint::CreateReplacement(Range, FixitStr);
737       break;
738     case Stmt::ForStmtClass:
739       DiagKind = 1;
740       Str = "for";
741       Range = cast<ForStmt>(Term)->getCond()->getSourceRange();
742       RemoveDiagKind = 1;
743       if (I->Output)
744         Fixit1 = FixItHint::CreateRemoval(Range);
745       else
746         Fixit1 = FixItHint::CreateReplacement(Range, FixitStr);
747       break;
748     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;
759 
760     // "condition is true / loop is exited".
761     case Stmt::DoStmtClass:
762       DiagKind = 2;
763       Str = "do";
764       Range = cast<DoStmt>(Term)->getCond()->getSourceRange();
765       RemoveDiagKind = 1;
766       Fixit1 = FixItHint::CreateReplacement(Range, FixitStr);
767       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 
782     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;
792   }
793 
794   if (!Diagnosed)
795     S.Diag(Use.getUser()->getLocStart(), diag::warn_maybe_uninit_var)
796         << VD->getDeclName() << IsCapturedByBlock
797         << Use.getUser()->getSourceRange();
798 }
799 
800 /// 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
803 /// as a warning. If a particular use is one we omit warnings for, returns
804 /// false.
805 static bool DiagnoseUninitializedUse(Sema &S, const VarDecl *VD,
806                                      const UninitUse &Use,
807                                      bool alwaysReportSelfInit = false) {
808 
809   if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(Use.getUser())) {
810     // 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;
824 
825       ContainsReference CR(S.Context, DRE);
826       CR.Visit(const_cast<Expr*>(Initializer));
827       if (CR.doesContainReference()) {
828         S.Diag(DRE->getLocStart(),
829                diag::warn_uninit_self_reference_in_init)
830           << VD->getDeclName() << VD->getLocation() << DRE->getSourceRange();
831         return true;
832       }
833     }
834 
835     DiagUninitUse(S, VD, Use, false);
836   } else {
837     const BlockExpr *BE = cast<BlockExpr>(Use.getUser());
838     if (VD->getType()->isBlockPointerType() && !VD->hasAttr<BlocksAttr>())
839       S.Diag(BE->getLocStart(),
840              diag::warn_uninit_byref_blockvar_captured_by_block)
841         << VD->getDeclName();
842     else
843       DiagUninitUse(S, VD, Use, true);
844   }
845 
846   // Report where the variable was declared when the use wasn't within
847   // the initializer of that declaration & we didn't already suggest
848   // an initialization fixit.
849   if (!SuggestInitializationFixit(S, VD))
850     S.Diag(VD->getLocStart(), diag::note_uninit_var_def)
851       << VD->getDeclName();
852 
853   return true;
854 }
855 
856 namespace {
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);
869       (void)Found;
870     }
871 
872     typedef llvm::SmallPtrSet<const AttributedStmt*, 8> AttrStmts;
873 
874     const AttrStmts &getFallthroughStmts() const {
875       return FallthroughStmts;
876     }
877 
878     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());
884       // 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 
895       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) {
901           if (*I && ReachableBlocks.insert(*I))
902             BlockQueue.push_back(*I);
903         }
904       }
905     }
906 
907     bool checkFallThroughIntoBlock(const CFGBlock &B, int &AnnotatedCnt) {
908       assert(!ReachableBlocks.empty() && "ReachableBlocks empty");
909 
910       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();
920         if (!P) continue;
921 
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 
930         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 
934         if (!ReachableBlocks.count(P)) {
935           for (CFGBlock::const_reverse_iterator ElemIt = P->rbegin(),
936                                                 ElemEnd = P->rend();
937                ElemIt != ElemEnd; ++ElemIt) {
938             if (Optional<CFGStmt> CS = ElemIt->getAs<CFGStmt>()) {
939               if (const AttributedStmt *AS = asFallThroughAttr(CS->getStmt())) {
940                 S.Diag(AS->getLocStart(),
941                        diag::warn_fallthrough_attr_unreachable);
942                 markFallthroughVisited(AS);
943                 ++AnnotatedCnt;
944                 break;
945               }
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 
993     // We don't want to traverse local type declarations. We analyze their
994     // methods separately.
995     bool TraverseDecl(Decl *D) { return true; }
996 
997   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) {
1013         if (Optional<CFGStmt> CS = ElemIt->getAs<CFGStmt>())
1014           return CS->getStmt();
1015       }
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;
1029     llvm::SmallPtrSet<const CFGBlock *, 16> ReachableBlocks;
1030   };
1031 }
1032 
1033 static void DiagnoseSwitchLabelsFallthrough(Sema &S, AnalysisDeclContext &AC,
1034                                             bool PerFunction) {
1035   // 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.
1044   if (!AC.getASTContext().getLangOpts().CPlusPlus11)
1045     return;
1046 
1047   FallthroughMapper FM(S);
1048   FM.TraverseStmt(AC.getBody());
1049 
1050   if (!FM.foundSwitchStatements())
1051     return;
1052 
1053   if (PerFunction && FM.getFallthroughStmts().empty())
1054     return;
1055 
1056   CFG *Cfg = AC.getCFG();
1057 
1058   if (!Cfg)
1059     return;
1060 
1061   FM.fillReachableBlocks(Cfg);
1062 
1063   for (CFG::reverse_iterator I = Cfg->rbegin(), E = Cfg->rend(); I != E; ++I) {
1064     const CFGBlock *B = *I;
1065     const Stmt *Label = B->getLabel();
1066 
1067     if (!Label || !isa<SwitchCase>(Label))
1068       continue;
1069 
1070     int AnnotatedCnt;
1071 
1072     if (!FM.checkFallThroughIntoBlock(*B, AnnotatedCnt))
1073       continue;
1074 
1075     S.Diag(Label->getLocStart(),
1076         PerFunction ? diag::warn_unannotated_fallthrough_per_function
1077                     : diag::warn_unannotated_fallthrough);
1078 
1079     if (!AnnotatedCnt) {
1080       SourceLocation L = Label->getLocStart();
1081       if (L.isMacroID())
1082         continue;
1083       if (S.getLangOpts().CPlusPlus11) {
1084         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))) {
1091           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           };
1097           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 += "; ";
1103           S.Diag(L, diag::note_insert_fallthrough_fixit) <<
1104               AnnotationSpelling <<
1105               FixItHint::CreateInsertion(L, TextToInsert);
1106         }
1107       }
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 
1122 static bool isInLoop(const ASTContext &Ctx, const ParentMap &PM,
1123                      const Stmt *S) {
1124   assert(S);
1125 
1126   do {
1127     switch (S->getStmtClass()) {
1128     case Stmt::ForStmtClass:
1129     case Stmt::WhileStmtClass:
1130     case Stmt::CXXForRangeStmtClass:
1131     case Stmt::ObjCForCollectionStmtClass:
1132       return true;
1133     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     }
1140     default:
1141       break;
1142     }
1143   } while ((S = PM.getParent(S)));
1144 
1145   return false;
1146 }
1147 
1148 
1149 static void diagnoseRepeatedUseOfWeak(Sema &S,
1150                                       const sema::FunctionScopeInfo *CurFn,
1151                                       const Decl *D,
1152                                       const ParentMap &PM) {
1153   typedef sema::FunctionScopeInfo::WeakObjectProfileTy WeakObjectProfileTy;
1154   typedef sema::FunctionScopeInfo::WeakObjectUseMap WeakObjectUseMap;
1155   typedef sema::FunctionScopeInfo::WeakUseVector WeakUseVector;
1156   typedef std::pair<const Stmt *, WeakObjectUseMap::const_iterator>
1157   StmtUsesPair;
1158 
1159   ASTContext &Ctx = S.getASTContext();
1160 
1161   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;
1168 
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 
1180     // If there was only one read, followed by any number of writes, and the
1181     // 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.
1184     if (UI == Uses.begin()) {
1185       WeakUseVector::const_iterator UI2 = UI;
1186       for (++UI2; UI2 != UE; ++UI2)
1187         if (UI2->isUnsafe())
1188           break;
1189 
1190       if (UI2 == UE) {
1191         if (!isInLoop(Ctx, PM, UI->getUseExpr()))
1192           continue;
1193 
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       }
1207     }
1208 
1209     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.
1216   SourceManager &SM = S.getSourceManager();
1217   std::sort(UsesByStmt.begin(), UsesByStmt.end(),
1218             [&SM](const StmtUsesPair &LHS, const StmtUsesPair &RHS) {
1219     return SM.isBeforeInTranslationUnit(LHS.first->getLocStart(),
1220                                         RHS.first->getLocStart());
1221   });
1222 
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 
1252     // 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.
1257     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 
1263     // 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 
1285     // Show the first time the object was read.
1286     S.Diag(FirstRead->getLocStart(), DiagKind)
1287       << int(ObjectKind) << D << int(FunctionKind)
1288       << 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 
1302 namespace {
1303 class UninitValsDiagReporter : public UninitVariablesHandler {
1304   Sema &S;
1305   typedef SmallVector<UninitUse, 2> UsesVec;
1306   typedef llvm::PointerIntPair<UsesVec *, 1, bool> MappedType;
1307   // 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;
1311   UsesMap *uses;
1312 
1313 public:
1314   UninitValsDiagReporter(Sema &S) : S(S), uses(0) {}
1315   ~UninitValsDiagReporter() {
1316     flushDiagnostics();
1317   }
1318 
1319   MappedType &getUses(const VarDecl *vd) {
1320     if (!uses)
1321       uses = new UsesMap();
1322 
1323     MappedType &V = (*uses)[vd];
1324     if (!V.getPointer())
1325       V.setPointer(new UsesVec());
1326 
1327     return V;
1328   }
1329 
1330   void handleUseOfUninitVariable(const VarDecl *vd,
1331                                  const UninitUse &use) override {
1332     getUses(vd).getPointer()->push_back(use);
1333   }
1334 
1335   void handleSelfInit(const VarDecl *vd) override {
1336     getUses(vd).setInt(true);
1337   }
1338 
1339   void flushDiagnostics() {
1340     if (!uses)
1341       return;
1342 
1343     for (UsesMap::iterator i = uses->begin(), e = uses->end(); i != e; ++i) {
1344       const VarDecl *vd = i->first;
1345       const MappedType &V = i->second;
1346 
1347       UsesVec *vec = V.getPointer();
1348       bool hasSelfInit = V.getInt();
1349 
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.
1353       if (!vec->empty() && hasSelfInit && hasAlwaysUninitializedUse(vec))
1354         DiagnoseUninitializedUse(S, vd,
1355                                  UninitUse(vd->getInit()->IgnoreParenCasts(),
1356                                            /* isAlwaysUninit */ true),
1357                                  /* alwaysReportSelfInit */ true);
1358       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.
1362         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 
1370         for (UsesVec::iterator vi = vec->begin(), ve = vec->end(); vi != ve;
1371              ++vi) {
1372           // 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))
1376             // 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         }
1380       }
1381 
1382       // Release the uses vector.
1383       delete vec;
1384     }
1385     delete uses;
1386   }
1387 
1388 private:
1389   static bool hasAlwaysUninitializedUse(const UsesVec* vec) {
1390   for (UsesVec::const_iterator i = vec->begin(), e = vec->end(); i != e; ++i) {
1391     if (i->getKind() == UninitUse::Always ||
1392         i->getKind() == UninitUse::AfterCall ||
1393         i->getKind() == UninitUse::AfterDecl) {
1394       return true;
1395     }
1396   }
1397   return false;
1398 }
1399 };
1400 }
1401 
1402 namespace clang {
1403 namespace {
1404 typedef SmallVector<PartialDiagnosticAt, 1> OptionalNotes;
1405 typedef std::pair<PartialDiagnosticAt, OptionalNotes> DelayedDiag;
1406 typedef std::list<DelayedDiag> DiagList;
1407 
1408 struct SortDiagBySourceLocation {
1409   SourceManager &SM;
1410   SortDiagBySourceLocation(SourceManager &SM) : SM(SM) {}
1411 
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.
1415     return SM.isBeforeInTranslationUnit(left.first.first, right.first.first);
1416   }
1417 };
1418 }}
1419 
1420 //===----------------------------------------------------------------------===//
1421 // -Wthread-safety
1422 //===----------------------------------------------------------------------===//
1423 namespace clang {
1424 namespace thread_safety {
1425 namespace {
1426 class ThreadSafetyReporter : public clang::thread_safety::ThreadSafetyHandler {
1427   Sema &S;
1428   DiagList Warnings;
1429   SourceLocation FunLocation, FunEndLocation;
1430 
1431   // Helper functions
1432   void warnLockMismatch(unsigned DiagID, Name LockName, SourceLocation Loc) {
1433     // Gracefully handle rare cases when the analysis can't get a more
1434     // precise source location.
1435     if (!Loc.isValid())
1436       Loc = FunLocation;
1437     PartialDiagnosticAt Warning(Loc, S.PDiag(DiagID) << LockName);
1438     Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1439   }
1440 
1441  public:
1442   ThreadSafetyReporter(Sema &S, SourceLocation FL, SourceLocation FEL)
1443     : S(S), FunLocation(FL), FunEndLocation(FEL) {}
1444 
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() {
1450     Warnings.sort(SortDiagBySourceLocation(S.getSourceManager()));
1451     for (DiagList::iterator I = Warnings.begin(), E = Warnings.end();
1452          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     }
1458   }
1459 
1460   void handleInvalidLockExp(SourceLocation Loc) override {
1461     PartialDiagnosticAt Warning(Loc,
1462                                 S.PDiag(diag::warn_cannot_resolve_lock) << Loc);
1463     Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1464   }
1465   void handleUnmatchedUnlock(Name LockName, SourceLocation Loc) override {
1466     warnLockMismatch(diag::warn_unlock_but_no_lock, LockName, Loc);
1467   }
1468   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   }
1477   void handleDoubleLock(Name LockName, SourceLocation Loc) override {
1478     warnLockMismatch(diag::warn_double_lock, LockName, Loc);
1479   }
1480 
1481   void handleMutexHeldEndOfScope(Name LockName, SourceLocation LocLocked,
1482                                  SourceLocation LocEndOfScope,
1483                                  LockErrorKind LEK) override {
1484     unsigned DiagID = 0;
1485     switch (LEK) {
1486       case LEK_LockedSomePredecessors:
1487         DiagID = diag::warn_lock_some_predecessors;
1488         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;
1495       case LEK_NotLockedAtEndOfFunction:
1496         DiagID = diag::warn_expecting_locked;
1497         break;
1498     }
1499     if (LocEndOfScope.isInvalid())
1500       LocEndOfScope = FunEndLocation;
1501 
1502     PartialDiagnosticAt Warning(LocEndOfScope, S.PDiag(DiagID) << LockName);
1503     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()));
1509   }
1510 
1511 
1512   void handleExclusiveAndShared(Name LockName, SourceLocation Loc1,
1513                                 SourceLocation Loc2) override {
1514     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)));
1519   }
1520 
1521   void handleNoMutexHeld(const NamedDecl *D, ProtectedOperationKind POK,
1522                          AccessKind AK, SourceLocation Loc) override {
1523     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;
1528     PartialDiagnosticAt Warning(Loc, S.PDiag(DiagID)
1529       << D->getNameAsString() << getLockKindFromAccessKind(AK));
1530     Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1531   }
1532 
1533   void handleMutexNotHeld(const NamedDecl *D, ProtectedOperationKind POK,
1534                           Name LockName, LockKind LK, SourceLocation Loc,
1535                           Name *PossibleMatch) override {
1536     unsigned DiagID = 0;
1537     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)
1550         << D->getNameAsString() << LockName << LK);
1551       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)
1567         << D->getNameAsString() << LockName << LK);
1568       Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1569     }
1570   }
1571 
1572   void handleFunExcludesLock(Name FunName, Name LockName,
1573                              SourceLocation Loc) override {
1574     PartialDiagnosticAt Warning(Loc,
1575       S.PDiag(diag::warn_fun_excludes_mutex) << FunName << LockName);
1576     Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1577   }
1578 };
1579 }
1580 }
1581 }
1582 
1583 //===----------------------------------------------------------------------===//
1584 // -Wconsumed
1585 //===----------------------------------------------------------------------===//
1586 
1587 namespace clang {
1588 namespace consumed {
1589 namespace {
1590 class ConsumedWarningsHandler : public ConsumedWarningsHandlerBase {
1591 
1592   Sema &S;
1593   DiagList Warnings;
1594 
1595 public:
1596 
1597   ConsumedWarningsHandler(Sema &S) : S(S) {}
1598 
1599   void emitDiagnostics() override {
1600     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   }
1613 
1614   void warnLoopStateMismatch(SourceLocation Loc,
1615                              StringRef VariableName) override {
1616     PartialDiagnosticAt Warning(Loc, S.PDiag(diag::warn_loop_state_mismatch) <<
1617       VariableName);
1618 
1619     Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1620   }
1621 
1622   void warnParamReturnTypestateMismatch(SourceLocation Loc,
1623                                         StringRef VariableName,
1624                                         StringRef ExpectedState,
1625                                         StringRef ObservedState) override {
1626 
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 
1634   void warnParamTypestateMismatch(SourceLocation Loc, StringRef ExpectedState,
1635                                   StringRef ObservedState) override {
1636 
1637     PartialDiagnosticAt Warning(Loc, S.PDiag(
1638       diag::warn_param_typestate_mismatch) << ExpectedState << ObservedState);
1639 
1640     Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1641   }
1642 
1643   void warnReturnTypestateForUnconsumableType(SourceLocation Loc,
1644                                               StringRef TypeName) override {
1645     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,
1652                                    StringRef ObservedState) override {
1653 
1654     PartialDiagnosticAt Warning(Loc, S.PDiag(
1655       diag::warn_return_typestate_mismatch) << ExpectedState << ObservedState);
1656 
1657     Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1658   }
1659 
1660   void warnUseOfTempInInvalidState(StringRef MethodName, StringRef State,
1661                                    SourceLocation Loc) override {
1662 
1663     PartialDiagnosticAt Warning(Loc, S.PDiag(
1664       diag::warn_use_of_temp_in_invalid_state) << MethodName << State);
1665 
1666     Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1667   }
1668 
1669   void warnUseInInvalidState(StringRef MethodName, StringRef VariableName,
1670                              StringRef State, SourceLocation Loc) override {
1671 
1672     PartialDiagnosticAt Warning(Loc, S.PDiag(diag::warn_use_in_invalid_state) <<
1673                                 MethodName << VariableName << State);
1674 
1675     Warnings.push_back(DelayedDiag(Warning, OptionalNotes()));
1676   }
1677 };
1678 }}}
1679 
1680 //===----------------------------------------------------------------------===//
1681 // AnalysisBasedWarnings - Worker object used by Sema to execute analysis-based
1682 //  warnings on a function, method, or block.
1683 //===----------------------------------------------------------------------===//
1684 
1685 clang::sema::AnalysisBasedWarnings::Policy::Policy() {
1686   enableCheckFallThrough = 1;
1687   enableCheckUnreachable = 0;
1688   enableThreadSafetyAnalysis = 0;
1689   enableConsumedAnalysis = 0;
1690 }
1691 
1692 static unsigned isEnabled(DiagnosticsEngine &D, unsigned diag) {
1693   return (unsigned) D.getDiagnosticLevel(diag, SourceLocation()) !=
1694                     DiagnosticsEngine::Ignored;
1695 }
1696 
1697 clang::sema::AnalysisBasedWarnings::AnalysisBasedWarnings(Sema &s)
1698   : S(s),
1699     NumFunctionsAnalyzed(0),
1700     NumFunctionsWithBadCFGs(0),
1701     NumCFGBlocks(0),
1702     MaxCFGBlocksPerFunction(0),
1703     NumUninitAnalysisFunctions(0),
1704     NumUninitAnalysisVariables(0),
1705     MaxUninitAnalysisVariablesPerFunction(0),
1706     NumUninitAnalysisBlockVisits(0),
1707     MaxUninitAnalysisBlockVisitsPerFunction(0) {
1708 
1709   using namespace diag;
1710   DiagnosticsEngine &D = S.getDiagnostics();
1711 
1712   DefaultPolicy.enableCheckUnreachable =
1713     isEnabled(D, warn_unreachable) ||
1714     isEnabled(D, warn_unreachable_break) ||
1715     isEnabled(D, warn_unreachable_return) ||
1716     isEnabled(D, warn_unreachable_loop_increment);
1717 
1718   DefaultPolicy.enableThreadSafetyAnalysis =
1719     isEnabled(D, warn_double_lock);
1720 
1721   DefaultPolicy.enableConsumedAnalysis =
1722     isEnabled(D, warn_use_in_invalid_state);
1723 }
1724 
1725 static void flushDiagnostics(Sema &S, sema::FunctionScopeInfo *fscope) {
1726   for (SmallVectorImpl<sema::PossiblyUnreachableDiag>::iterator
1727        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 
1735 void clang::sema::
1736 AnalysisBasedWarnings::IssueWarnings(sema::AnalysisBasedWarnings::Policy P,
1737                                      sema::FunctionScopeInfo *fscope,
1738                                      const Decl *D, const BlockExpr *blkExpr) {
1739 
1740   // 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.
1746   DiagnosticsEngine &Diags = S.getDiagnostics();
1747 
1748   // Do not do any analysis for declarations in system headers if we are
1749   // going to just ignore them.
1750   if (Diags.getSuppressSystemWarnings() &&
1751       S.SourceMgr.isInSystemHeader(D->getLocation()))
1752     return;
1753 
1754   // For code in dependent contexts, we'll do this at instantiation time.
1755   if (cast<DeclContext>(D)->isDependentContext())
1756     return;
1757 
1758   if (Diags.hasUncompilableErrorOccurred() || Diags.hasFatalErrorOccurred()) {
1759     // Flush out any possibly unreachable diagnostics.
1760     flushDiagnostics(S, fscope);
1761     return;
1762   }
1763 
1764   const Stmt *Body = D->getBody();
1765   assert(Body);
1766 
1767   // Construct the analysis context with the specified CFG build options.
1768   AnalysisDeclContext AC(/* AnalysisDeclContextManager */ 0, D);
1769 
1770   // Don't generate EH edges for CallExprs as we'd like to avoid the n^2
1771   // explosion for destructors that can result and the compile time hit.
1772   AC.getCFGBuildOptions().PruneTriviallyFalseEdges = true;
1773   AC.getCFGBuildOptions().AddEHEdges = false;
1774   AC.getCFGBuildOptions().AddInitializers = true;
1775   AC.getCFGBuildOptions().AddImplicitDtors = true;
1776   AC.getCFGBuildOptions().AddTemporaryDtors = true;
1777   AC.getCFGBuildOptions().AddCXXNewAllocator = false;
1778 
1779   // 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.
1785   if (P.enableCheckUnreachable || P.enableThreadSafetyAnalysis ||
1786       P.enableConsumedAnalysis) {
1787     // Unreachable code analysis and thread safety require a linearized CFG.
1788     AC.getCFGBuildOptions().setAllAlwaysAdd();
1789   }
1790   else {
1791     AC.getCFGBuildOptions()
1792       .setAlwaysAdd(Stmt::BinaryOperatorClass)
1793       .setAlwaysAdd(Stmt::CompoundAssignOperatorClass)
1794       .setAlwaysAdd(Stmt::BlockExprClass)
1795       .setAlwaysAdd(Stmt::CStyleCastExprClass)
1796       .setAlwaysAdd(Stmt::DeclRefExprClass)
1797       .setAlwaysAdd(Stmt::ImplicitCastExprClass)
1798       .setAlwaysAdd(Stmt::UnaryOperatorClass)
1799       .setAlwaysAdd(Stmt::AttributedStmtClass);
1800   }
1801 
1802 
1803   // Emit delayed diagnostics.
1804   if (!fscope->PossiblyUnreachableDiags.empty()) {
1805     bool analyzed = false;
1806 
1807     // Register the expressions with the CFGBuilder.
1808     for (SmallVectorImpl<sema::PossiblyUnreachableDiag>::iterator
1809          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;
1818       for (SmallVectorImpl<sema::PossiblyUnreachableDiag>::iterator
1819             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);
1827           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) {
1833             // Can this block be reached from the entrance?
1834             if (cra->isReachable(&AC.getCFG()->getEntry(), block))
1835               S.Diag(D.Loc, D.PD);
1836             processed = true;
1837           }
1838         }
1839         if (!processed) {
1840           // Emit the warning anyway if we cannot map to a basic block.
1841           S.Diag(D.Loc, D.PD);
1842         }
1843       }
1844     }
1845 
1846     if (!analyzed)
1847       flushDiagnostics(S, fscope);
1848   }
1849 
1850 
1851   // Warning: check missing 'return'
1852   if (P.enableCheckFallThrough) {
1853     const CheckFallThroughDiagnostics &CD =
1854       (isa<BlockDecl>(D) ? CheckFallThroughDiagnostics::MakeForBlock()
1855        : (isa<CXXMethodDecl>(D) &&
1856           cast<CXXMethodDecl>(D)->getOverloadedOperator() == OO_Call &&
1857           cast<CXXMethodDecl>(D)->getParent()->isLambda())
1858             ? CheckFallThroughDiagnostics::MakeForLambda()
1859             : CheckFallThroughDiagnostics::MakeForFunction(D));
1860     CheckFallThroughForBody(S, D, Body, blkExpr, CD, AC);
1861   }
1862 
1863   // Warning: check for unreachable code
1864   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.
1869     bool isTemplateInstantiation = false;
1870     if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(D))
1871       isTemplateInstantiation = Function->isTemplateInstantiation();
1872     if (!isTemplateInstantiation)
1873       CheckUnreachable(S, AC);
1874   }
1875 
1876   // Check for thread safety violations
1877   if (P.enableThreadSafetyAnalysis) {
1878     SourceLocation FL = AC.getDecl()->getLocation();
1879     SourceLocation FEL = AC.getDecl()->getLocEnd();
1880     thread_safety::ThreadSafetyReporter Reporter(S, FL, FEL);
1881     if (Diags.getDiagnosticLevel(diag::warn_thread_safety_beta,D->getLocStart())
1882         != DiagnosticsEngine::Ignored)
1883       Reporter.setIssueBetaWarnings(true);
1884 
1885     thread_safety::runThreadSafetyAnalysis(AC, Reporter);
1886     Reporter.emitDiagnostics();
1887   }
1888 
1889   // Check for violations of consumed properties.
1890   if (P.enableConsumedAnalysis) {
1891     consumed::ConsumedWarningsHandler WarningHandler(S);
1892     consumed::ConsumedAnalyzer Analyzer(WarningHandler);
1893     Analyzer.run(AC);
1894   }
1895 
1896   if (Diags.getDiagnosticLevel(diag::warn_uninit_var, D->getLocStart())
1897       != DiagnosticsEngine::Ignored ||
1898       Diags.getDiagnosticLevel(diag::warn_sometimes_uninit_var,D->getLocStart())
1899       != DiagnosticsEngine::Ignored ||
1900       Diags.getDiagnosticLevel(diag::warn_maybe_uninit_var, D->getLocStart())
1901       != DiagnosticsEngine::Ignored) {
1902     if (CFG *cfg = AC.getCFG()) {
1903       UninitValsDiagReporter reporter(S);
1904       UninitVariablesAnalysisStats stats;
1905       std::memset(&stats, 0, sizeof(UninitVariablesAnalysisStats));
1906       runUninitializedVariablesAnalysis(*cast<DeclContext>(D), *cfg, AC,
1907                                         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       }
1920     }
1921   }
1922 
1923   bool FallThroughDiagFull =
1924       Diags.getDiagnosticLevel(diag::warn_unannotated_fallthrough,
1925                                D->getLocStart()) != DiagnosticsEngine::Ignored;
1926   bool FallThroughDiagPerFunction =
1927       Diags.getDiagnosticLevel(diag::warn_unannotated_fallthrough_per_function,
1928                                D->getLocStart()) != DiagnosticsEngine::Ignored;
1929   if (FallThroughDiagFull || FallThroughDiagPerFunction) {
1930     DiagnoseSwitchLabelsFallthrough(S, AC, !FallThroughDiagFull);
1931   }
1932 
1933   if (S.getLangOpts().ObjCARCWeak &&
1934       Diags.getDiagnosticLevel(diag::warn_arc_repeated_use_of_weak,
1935                                D->getLocStart()) != DiagnosticsEngine::Ignored)
1936     diagnoseRepeatedUseOfWeak(S, fscope, D, AC.getParentMap());
1937 
1938 
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 
1948   // 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.
1954       NumCFGBlocks += cfg->getNumBlockIDs();
1955       MaxCFGBlocksPerFunction = std::max(MaxCFGBlocksPerFunction,
1956                                          cfg->getNumBlockIDs());
1957     } else {
1958       ++NumFunctionsWithBadCFGs;
1959     }
1960   }
1961 }
1962 
1963 void 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";
1993 }
1994