lib/Sema/JumpDiagnostics.cpp

   1 //===--- JumpDiagnostics.cpp - Analyze Jump Targets for VLA issues --------===//
   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 implements the JumpScopeChecker class, which is used to diagnose
  11 // jumps that enter a VLA scope in an invalid way.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "Sema.h"
  16 #include "clang/AST/Expr.h"
  17 #include "clang/AST/StmtObjC.h"
  18 #include "clang/AST/StmtCXX.h"
  19 using namespace clang;
  20
  21 namespace {
  22
  23 /// JumpScopeChecker - This object is used by Sema to diagnose invalid jumps
  24 /// into VLA and other protected scopes.  For example, this rejects:
  25 ///    goto L;
  26 ///    int a[n];
  27 ///  L:
  28 ///
  29 class JumpScopeChecker {
  30   Sema &S;
  31
  32   /// GotoScope - This is a record that we use to keep track of all of the
  33   /// scopes that are introduced by VLAs and other things that scope jumps like
  34   /// gotos.  This scope tree has nothing to do with the source scope tree,
  35   /// because you can have multiple VLA scopes per compound statement, and most
  36   /// compound statements don't introduce any scopes.
  37   struct GotoScope {
  38     /// ParentScope - The index in ScopeMap of the parent scope.  This is 0 for
  39     /// the parent scope is the function body.
  40     unsigned ParentScope;
  41
  42     /// Diag - The diagnostic to emit if there is a jump into this scope.
  43     unsigned Diag;
  44
  45     /// Loc - Location to emit the diagnostic.
  46     SourceLocation Loc;
  47
  48     GotoScope(unsigned parentScope, unsigned diag, SourceLocation L)
  49     : ParentScope(parentScope), Diag(diag), Loc(L) {}
  50   };
  51
  52   llvm::SmallVector<GotoScope, 48> Scopes;
  53   llvm::DenseMap<Stmt*, unsigned> LabelAndGotoScopes;
  54   llvm::SmallVector<Stmt*, 16> Jumps;
  55 public:
  56   JumpScopeChecker(Stmt *Body, Sema &S);
  57 private:
  58   void BuildScopeInformation(Stmt *S, unsigned ParentScope);
  59   void VerifyJumps();
  60   void CheckJump(Stmt *From, Stmt *To,
  61                  SourceLocation DiagLoc, unsigned JumpDiag);
  62 };
  63 } // end anonymous namespace
  64
  65
  66 JumpScopeChecker::JumpScopeChecker(Stmt *Body, Sema &s) : S(s) {
  67   // Add a scope entry for function scope.
  68   Scopes.push_back(GotoScope(~0U, ~0U, SourceLocation()));
  69
  70   // Build information for the top level compound statement, so that we have a
  71   // defined scope record for every "goto" and label.
  72   BuildScopeInformation(Body, 0);
  73
  74   // Check that all jumps we saw are kosher.
  75   VerifyJumps();
  76 }
  77
  78 /// GetDiagForGotoScopeDecl - If this decl induces a new goto scope, return a
  79 /// diagnostic that should be emitted if control goes over it. If not, return 0.
  80 static unsigned GetDiagForGotoScopeDecl(const Decl *D) {
  81   if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
  82     if (VD->getType()->isVariablyModifiedType())
  83       return diag::note_protected_by_vla;
  84     if (VD->hasAttr<CleanupAttr>())
  85       return diag::note_protected_by_cleanup;
  86     if (VD->hasAttr<BlocksAttr>())
  87       return diag::note_protected_by___block;
  88   } else if (const TypedefDecl *TD = dyn_cast<TypedefDecl>(D)) {
  89     if (TD->getUnderlyingType()->isVariablyModifiedType())
  90       return diag::note_protected_by_vla_typedef;
  91   }
  92
  93   return 0;
  94 }
  95
  96
  97 /// BuildScopeInformation - The statements from CI to CE are known to form a
  98 /// coherent VLA scope with a specified parent node.  Walk through the
  99 /// statements, adding any labels or gotos to LabelAndGotoScopes and recursively
 100 /// walking the AST as needed.
 101 void JumpScopeChecker::BuildScopeInformation(Stmt *S, unsigned ParentScope) {
 102
 103   // If we found a label, remember that it is in ParentScope scope.
 104   if (isa<LabelStmt>(S) || isa<DefaultStmt>(S) || isa<CaseStmt>(S)) {
 105     LabelAndGotoScopes[S] = ParentScope;
 106   } else if (isa<GotoStmt>(S) || isa<SwitchStmt>(S) ||
 107              isa<IndirectGotoStmt>(S) || isa<AddrLabelExpr>(S)) {
 108     // Remember both what scope a goto is in as well as the fact that we have
 109     // it.  This makes the second scan not have to walk the AST again.
 110     LabelAndGotoScopes[S] = ParentScope;
 111     Jumps.push_back(S);
 112   }
 113
 114   for (Stmt::child_iterator CI = S->child_begin(), E = S->child_end(); CI != E;
 115        ++CI) {
 116     Stmt *SubStmt = *CI;
 117     if (SubStmt == 0) continue;
 118
 119     // FIXME: diagnose jumps past initialization: required in C++, warning in C.
 120     //   goto L; int X = 4;   L: ;
 121
 122     // If this is a declstmt with a VLA definition, it defines a scope from here
 123     // to the end of the containing context.
 124     if (DeclStmt *DS = dyn_cast<DeclStmt>(SubStmt)) {
 125       // The decl statement creates a scope if any of the decls in it are VLAs or
 126       // have the cleanup attribute.
 127       for (DeclStmt::decl_iterator I = DS->decl_begin(), E = DS->decl_end();
 128            I != E; ++I) {
 129         // If this decl causes a new scope, push and switch to it.
 130         if (unsigned Diag = GetDiagForGotoScopeDecl(*I)) {
 131           Scopes.push_back(GotoScope(ParentScope, Diag, (*I)->getLocation()));
 132           ParentScope = Scopes.size()-1;
 133         }
 134
 135         // If the decl has an initializer, walk it with the potentially new
 136         // scope we just installed.
 137         if (VarDecl *VD = dyn_cast<VarDecl>(*I))
 138           if (Expr *Init = VD->getInit())
 139             BuildScopeInformation(Init, ParentScope);
 140       }
 141       continue;
 142     }
 143
 144     // Disallow jumps into any part of an @try statement by pushing a scope and
 145     // walking all sub-stmts in that scope.
 146     if (ObjCAtTryStmt *AT = dyn_cast<ObjCAtTryStmt>(SubStmt)) {
 147       // Recursively walk the AST for the @try part.
 148       Scopes.push_back(GotoScope(ParentScope,diag::note_protected_by_objc_try,
 149                                  AT->getAtTryLoc()));
 150       if (Stmt *TryPart = AT->getTryBody())
 151         BuildScopeInformation(TryPart, Scopes.size()-1);
 152
 153       // Jump from the catch to the finally or try is not valid.
 154       for (ObjCAtCatchStmt *AC = AT->getCatchStmts(); AC;
 155            AC = AC->getNextCatchStmt()) {
 156         Scopes.push_back(GotoScope(ParentScope,
 157                                    diag::note_protected_by_objc_catch,
 158                                    AC->getAtCatchLoc()));
 159         // @catches are nested and it isn't
 160         BuildScopeInformation(AC->getCatchBody(), Scopes.size()-1);
 161       }
 162
 163       // Jump from the finally to the try or catch is not valid.
 164       if (ObjCAtFinallyStmt *AF = AT->getFinallyStmt()) {
 165         Scopes.push_back(GotoScope(ParentScope,
 166                                    diag::note_protected_by_objc_finally,
 167                                    AF->getAtFinallyLoc()));
 168         BuildScopeInformation(AF, Scopes.size()-1);
 169       }
 170
 171       continue;
 172     }
 173
 174     // Disallow jumps into the protected statement of an @synchronized, but
 175     // allow jumps into the object expression it protects.
 176     if (ObjCAtSynchronizedStmt *AS = dyn_cast<ObjCAtSynchronizedStmt>(SubStmt)){
 177       // Recursively walk the AST for the @synchronized object expr, it is
 178       // evaluated in the normal scope.
 179       BuildScopeInformation(AS->getSynchExpr(), ParentScope);
 180
 181       // Recursively walk the AST for the @synchronized part, protected by a new
 182       // scope.
 183       Scopes.push_back(GotoScope(ParentScope,
 184                                  diag::note_protected_by_objc_synchronized,
 185                                  AS->getAtSynchronizedLoc()));
 186       BuildScopeInformation(AS->getSynchBody(), Scopes.size()-1);
 187       continue;
 188     }
 189
 190     // Disallow jumps into any part of a C++ try statement. This is pretty
 191     // much the same as for Obj-C.
 192     if (CXXTryStmt *TS = dyn_cast<CXXTryStmt>(SubStmt)) {
 193       Scopes.push_back(GotoScope(ParentScope, diag::note_protected_by_cxx_try,
 194                                  TS->getSourceRange().getBegin()));
 195       if (Stmt *TryBlock = TS->getTryBlock())
 196         BuildScopeInformation(TryBlock, Scopes.size()-1);
 197
 198       // Jump from the catch into the try is not allowed either.
 199       for (unsigned I = 0, E = TS->getNumHandlers(); I != E; ++I) {
 200         CXXCatchStmt *CS = TS->getHandler(I);
 201         Scopes.push_back(GotoScope(ParentScope,
 202                                    diag::note_protected_by_cxx_catch,
 203                                    CS->getSourceRange().getBegin()));
 204         BuildScopeInformation(CS->getHandlerBlock(), Scopes.size()-1);
 205       }
 206
 207       continue;
 208     }
 209
 210     // Recursively walk the AST.
 211     BuildScopeInformation(SubStmt, ParentScope);
 212   }
 213 }
 214
 215 /// VerifyJumps - Verify each element of the Jumps array to see if they are
 216 /// valid, emitting diagnostics if not.
 217 void JumpScopeChecker::VerifyJumps() {
 218   while (!Jumps.empty()) {
 219     Stmt *Jump = Jumps.pop_back_val();
 220
 221     // With a goto,
 222     if (GotoStmt *GS = dyn_cast<GotoStmt>(Jump)) {
 223       CheckJump(GS, GS->getLabel(), GS->getGotoLoc(),
 224                 diag::err_goto_into_protected_scope);
 225       continue;
 226     }
 227
 228     if (SwitchStmt *SS = dyn_cast<SwitchStmt>(Jump)) {
 229       for (SwitchCase *SC = SS->getSwitchCaseList(); SC;
 230            SC = SC->getNextSwitchCase()) {
 231         assert(LabelAndGotoScopes.count(SC) && "Case not visited?");
 232         CheckJump(SS, SC, SC->getLocStart(),
 233                   diag::err_switch_into_protected_scope);
 234       }
 235       continue;
 236     }
 237
 238     unsigned DiagnosticScope;
 239
 240     // We don't know where an indirect goto goes, require that it be at the
 241     // top level of scoping.
 242     if (IndirectGotoStmt *IG = dyn_cast<IndirectGotoStmt>(Jump)) {
 243       assert(LabelAndGotoScopes.count(Jump) &&
 244              "Jump didn't get added to scopes?");
 245       unsigned GotoScope = LabelAndGotoScopes[IG];
 246       if (GotoScope == 0) continue;  // indirect jump is ok.
 247       S.Diag(IG->getGotoLoc(), diag::err_indirect_goto_in_protected_scope);
 248       DiagnosticScope = GotoScope;
 249     } else {
 250       // We model &&Label as a jump for purposes of scope tracking.  We actually
 251       // don't care *where* the address of label is, but we require the *label
 252       // itself* to be in scope 0.  If it is nested inside of a VLA scope, then
 253       // it is possible for an indirect goto to illegally enter the VLA scope by
 254       // indirectly jumping to the label.
 255       assert(isa<AddrLabelExpr>(Jump) && "Unknown jump type");
 256       LabelStmt *TheLabel = cast<AddrLabelExpr>(Jump)->getLabel();
 257
 258       assert(LabelAndGotoScopes.count(TheLabel) &&
 259              "Referenced label didn't get added to scopes?");
 260       unsigned LabelScope = LabelAndGotoScopes[TheLabel];
 261       if (LabelScope == 0) continue; // Addr of label is ok.
 262
 263       S.Diag(Jump->getLocStart(), diag::err_addr_of_label_in_protected_scope);
 264       DiagnosticScope = LabelScope;
 265     }
 266
 267     // Report all the things that would be skipped over by this &&label or
 268     // indirect goto.
 269     while (DiagnosticScope != 0) {
 270       S.Diag(Scopes[DiagnosticScope].Loc, Scopes[DiagnosticScope].Diag);
 271       DiagnosticScope = Scopes[DiagnosticScope].ParentScope;
 272     }
 273   }
 274 }
 275
 276 /// CheckJump - Validate that the specified jump statement is valid: that it is
 277 /// jumping within or out of its current scope, not into a deeper one.
 278 void JumpScopeChecker::CheckJump(Stmt *From, Stmt *To,
 279                                  SourceLocation DiagLoc, unsigned JumpDiag) {
 280   assert(LabelAndGotoScopes.count(From) && "Jump didn't get added to scopes?");
 281   unsigned FromScope = LabelAndGotoScopes[From];
 282
 283   assert(LabelAndGotoScopes.count(To) && "Jump didn't get added to scopes?");
 284   unsigned ToScope = LabelAndGotoScopes[To];
 285
 286   // Common case: exactly the same scope, which is fine.
 287   if (FromScope == ToScope) return;
 288
 289   // The only valid mismatch jump case happens when the jump is more deeply
 290   // nested inside the jump target.  Do a quick scan to see if the jump is valid
 291   // because valid code is more common than invalid code.
 292   unsigned TestScope = Scopes[FromScope].ParentScope;
 293   while (TestScope != ~0U) {
 294     // If we found the jump target, then we're jumping out of our current scope,
 295     // which is perfectly fine.
 296     if (TestScope == ToScope) return;
 297
 298     // Otherwise, scan up the hierarchy.
 299     TestScope = Scopes[TestScope].ParentScope;
 300   }
 301
 302   // If we get here, then we know we have invalid code.  Diagnose the bad jump,
 303   // and then emit a note at each VLA being jumped out of.
 304   S.Diag(DiagLoc, JumpDiag);
 305
 306   // Eliminate the common prefix of the jump and the target.  Start by
 307   // linearizing both scopes, reversing them as we go.
 308   std::vector<unsigned> FromScopes, ToScopes;
 309   for (TestScope = FromScope; TestScope != ~0U;
 310        TestScope = Scopes[TestScope].ParentScope)
 311     FromScopes.push_back(TestScope);
 312   for (TestScope = ToScope; TestScope != ~0U;
 313        TestScope = Scopes[TestScope].ParentScope)
 314     ToScopes.push_back(TestScope);
 315
 316   // Remove any common entries (such as the top-level function scope).
 317   while (!FromScopes.empty() && FromScopes.back() == ToScopes.back()) {
 318     FromScopes.pop_back();
 319     ToScopes.pop_back();
 320   }
 321
 322   // Emit diagnostics for whatever is left in ToScopes.
 323   for (unsigned i = 0, e = ToScopes.size(); i != e; ++i)
 324     S.Diag(Scopes[ToScopes[i]].Loc, Scopes[ToScopes[i]].Diag);
 325 }
 326
 327 void Sema::DiagnoseInvalidJumps(Stmt *Body) {
 328   (void)JumpScopeChecker(Body, *this);
 329 }