clang  8.0.0svn
ScopeInfo.cpp
Go to the documentation of this file.
1 //===--- ScopeInfo.cpp - Information about a semantic context -------------===//
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 FunctionScopeInfo and its subclasses, which contain
11 // information about a single function, block, lambda, or method body.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "clang/Sema/ScopeInfo.h"
16 #include "clang/AST/Decl.h"
17 #include "clang/AST/DeclCXX.h"
18 #include "clang/AST/DeclObjC.h"
19 #include "clang/AST/Expr.h"
20 #include "clang/AST/ExprCXX.h"
21 #include "clang/AST/ExprObjC.h"
22 
23 using namespace clang;
24 using namespace sema;
25 
28  HasBranchIntoScope = false;
29  HasIndirectGoto = false;
30  HasDroppedStmt = false;
32  HasFallthroughStmt = false;
34  ObjCShouldCallSuper = false;
35  ObjCIsDesignatedInit = false;
37  ObjCIsSecondaryInit = false;
42 
43  // Coroutine state
45  CoroutinePromise = nullptr;
48  CoroutineSuspends.first = nullptr;
49  CoroutineSuspends.second = nullptr;
50 
51  SwitchStack.clear();
52  Returns.clear();
53  ErrorTrap.reset();
55  WeakObjectUses.clear();
56  ModifiedNonNullParams.clear();
57  Blocks.clear();
58  ByrefBlockVars.clear();
59 }
60 
61 static const NamedDecl *getBestPropertyDecl(const ObjCPropertyRefExpr *PropE) {
62  if (PropE->isExplicitProperty())
63  return PropE->getExplicitProperty();
64 
65  return PropE->getImplicitPropertyGetter();
66 }
67 
68 FunctionScopeInfo::WeakObjectProfileTy::BaseInfoTy
69 FunctionScopeInfo::WeakObjectProfileTy::getBaseInfo(const Expr *E) {
70  E = E->IgnoreParenCasts();
71 
72  const NamedDecl *D = nullptr;
73  bool IsExact = false;
74 
75  switch (E->getStmtClass()) {
76  case Stmt::DeclRefExprClass:
77  D = cast<DeclRefExpr>(E)->getDecl();
78  IsExact = isa<VarDecl>(D);
79  break;
80  case Stmt::MemberExprClass: {
81  const MemberExpr *ME = cast<MemberExpr>(E);
82  D = ME->getMemberDecl();
83  IsExact = isa<CXXThisExpr>(ME->getBase()->IgnoreParenImpCasts());
84  break;
85  }
86  case Stmt::ObjCIvarRefExprClass: {
87  const ObjCIvarRefExpr *IE = cast<ObjCIvarRefExpr>(E);
88  D = IE->getDecl();
89  IsExact = IE->getBase()->isObjCSelfExpr();
90  break;
91  }
92  case Stmt::PseudoObjectExprClass: {
93  const PseudoObjectExpr *POE = cast<PseudoObjectExpr>(E);
94  const ObjCPropertyRefExpr *BaseProp =
95  dyn_cast<ObjCPropertyRefExpr>(POE->getSyntacticForm());
96  if (BaseProp) {
97  D = getBestPropertyDecl(BaseProp);
98 
99  if (BaseProp->isObjectReceiver()) {
100  const Expr *DoubleBase = BaseProp->getBase();
101  if (const OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(DoubleBase))
102  DoubleBase = OVE->getSourceExpr();
103 
104  IsExact = DoubleBase->isObjCSelfExpr();
105  }
106  }
107  break;
108  }
109  default:
110  break;
111  }
112 
113  return BaseInfoTy(D, IsExact);
114 }
115 
117  RecordDecl *RD = nullptr;
118  if (auto *LSI = dyn_cast<LambdaScopeInfo>(this))
119  RD = LSI->Lambda;
120  else if (auto CRSI = dyn_cast<CapturedRegionScopeInfo>(this))
121  RD = CRSI->TheRecordDecl;
122 
123  if (RD)
124  for (auto *FD : RD->fields()) {
125  if (FD->hasCapturedVLAType() && FD->getCapturedVLAType() == VAT)
126  return true;
127  }
128  return false;
129 }
130 
131 FunctionScopeInfo::WeakObjectProfileTy::WeakObjectProfileTy(
132  const ObjCPropertyRefExpr *PropE)
133  : Base(nullptr, true), Property(getBestPropertyDecl(PropE)) {
134 
135  if (PropE->isObjectReceiver()) {
136  const OpaqueValueExpr *OVE = cast<OpaqueValueExpr>(PropE->getBase());
137  const Expr *E = OVE->getSourceExpr();
138  Base = getBaseInfo(E);
139  } else if (PropE->isClassReceiver()) {
140  Base.setPointer(PropE->getClassReceiver());
141  } else {
142  assert(PropE->isSuperReceiver());
143  }
144 }
145 
146 FunctionScopeInfo::WeakObjectProfileTy::WeakObjectProfileTy(const Expr *BaseE,
147  const ObjCPropertyDecl *Prop)
148  : Base(nullptr, true), Property(Prop) {
149  if (BaseE)
150  Base = getBaseInfo(BaseE);
151  // else, this is a message accessing a property on super.
152 }
153 
154 FunctionScopeInfo::WeakObjectProfileTy::WeakObjectProfileTy(
155  const DeclRefExpr *DRE)
156  : Base(nullptr, true), Property(DRE->getDecl()) {
157  assert(isa<VarDecl>(Property));
158 }
159 
160 FunctionScopeInfo::WeakObjectProfileTy::WeakObjectProfileTy(
161  const ObjCIvarRefExpr *IvarE)
162  : Base(getBaseInfo(IvarE->getBase())), Property(IvarE->getDecl()) {
163 }
164 
166  const ObjCPropertyDecl *Prop) {
167  assert(Msg && Prop);
168  WeakUseVector &Uses =
169  WeakObjectUses[WeakObjectProfileTy(Msg->getInstanceReceiver(), Prop)];
170  Uses.push_back(WeakUseTy(Msg, Msg->getNumArgs() == 0));
171 }
172 
174  E = E->IgnoreParenCasts();
175 
176  if (const PseudoObjectExpr *POE = dyn_cast<PseudoObjectExpr>(E)) {
177  markSafeWeakUse(POE->getSyntacticForm());
178  return;
179  }
180 
181  if (const ConditionalOperator *Cond = dyn_cast<ConditionalOperator>(E)) {
182  markSafeWeakUse(Cond->getTrueExpr());
183  markSafeWeakUse(Cond->getFalseExpr());
184  return;
185  }
186 
187  if (const BinaryConditionalOperator *Cond =
188  dyn_cast<BinaryConditionalOperator>(E)) {
189  markSafeWeakUse(Cond->getCommon());
190  markSafeWeakUse(Cond->getFalseExpr());
191  return;
192  }
193 
194  // Has this weak object been seen before?
195  FunctionScopeInfo::WeakObjectUseMap::iterator Uses = WeakObjectUses.end();
196  if (const ObjCPropertyRefExpr *RefExpr = dyn_cast<ObjCPropertyRefExpr>(E)) {
197  if (!RefExpr->isObjectReceiver())
198  return;
199  if (isa<OpaqueValueExpr>(RefExpr->getBase()))
200  Uses = WeakObjectUses.find(WeakObjectProfileTy(RefExpr));
201  else {
202  markSafeWeakUse(RefExpr->getBase());
203  return;
204  }
205  }
206  else if (const ObjCIvarRefExpr *IvarE = dyn_cast<ObjCIvarRefExpr>(E))
207  Uses = WeakObjectUses.find(WeakObjectProfileTy(IvarE));
208  else if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) {
209  if (isa<VarDecl>(DRE->getDecl()))
210  Uses = WeakObjectUses.find(WeakObjectProfileTy(DRE));
211  } else if (const ObjCMessageExpr *MsgE = dyn_cast<ObjCMessageExpr>(E)) {
212  if (const ObjCMethodDecl *MD = MsgE->getMethodDecl()) {
213  if (const ObjCPropertyDecl *Prop = MD->findPropertyDecl()) {
214  Uses =
215  WeakObjectUses.find(WeakObjectProfileTy(MsgE->getInstanceReceiver(),
216  Prop));
217  }
218  }
219  }
220  else
221  return;
222 
223  if (Uses == WeakObjectUses.end())
224  return;
225 
226  // Has there been a read from the object using this Expr?
227  FunctionScopeInfo::WeakUseVector::reverse_iterator ThisUse =
228  llvm::find(llvm::reverse(Uses->second), WeakUseTy(E, true));
229  if (ThisUse == Uses->second.rend())
230  return;
231 
232  ThisUse->markSafe();
233 }
234 
236  Expr *&E) const {
237  assert(Idx < getNumPotentialVariableCaptures() &&
238  "Index of potential capture must be within 0 to less than the "
239  "number of captures!");
240  E = PotentiallyCapturingExprs[Idx];
241  if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
242  VD = dyn_cast<VarDecl>(DRE->getFoundDecl());
243  else if (MemberExpr *ME = dyn_cast<MemberExpr>(E))
244  VD = dyn_cast<VarDecl>(ME->getMemberDecl());
245  else
246  llvm_unreachable("Only DeclRefExprs or MemberExprs should be added for "
247  "potential captures");
248  assert(VD);
249 }
250 
ObjCPropertyRefExpr - A dot-syntax expression to access an ObjC property.
Definition: ExprObjC.h:577
Expr * getSyntacticForm()
Return the syntactic form of this expression, i.e.
Definition: Expr.h:5289
ValueDecl * getMemberDecl() const
Retrieve the member declaration to which this expression refers.
Definition: Expr.h:2692
void getPotentialVariableCapture(unsigned Idx, VarDecl *&VD, Expr *&E) const
Definition: ScopeInfo.cpp:235
bool HasFallthroughStmt
Whether there is a fallthrough statement in this function.
Definition: ScopeInfo.h:127
bool isSuperReceiver() const
Definition: ExprObjC.h:739
bool isVLATypeCaptured(const VariableArrayType *VAT) const
Determine whether the given variable-array type has been captured.
Definition: ScopeInfo.cpp:116
Expr * getBase() const
Definition: Expr.h:2686
static const NamedDecl * getBestPropertyDecl(const ObjCPropertyRefExpr *PropE)
Definition: ScopeInfo.cpp:61
std::pair< Stmt *, Stmt * > CoroutineSuspends
The initial and final coroutine suspend points.
Definition: ScopeInfo.h:200
Represents a variable declaration or definition.
Definition: Decl.h:812
ObjCInterfaceDecl * getClassReceiver() const
Definition: ExprObjC.h:734
ObjCMethodDecl - Represents an instance or class method declaration.
Definition: DeclObjC.h:139
static ObjCPropertyDecl * findPropertyDecl(const DeclContext *DC, const IdentifierInfo *propertyID, ObjCPropertyQueryKind queryKind)
Lookup a property by name in the specified DeclContext.
Definition: DeclObjC.cpp:177
bool NeedsCoroutineSuspends
True only when this function has not already built, or attempted to build, the initial and final coro...
Definition: ScopeInfo.h:157
Defines the clang::Expr interface and subclasses for C++ expressions.
bool HasDroppedStmt
Whether a statement was dropped because it was invalid.
Definition: ScopeInfo.h:121
ObjCPropertyDecl * getExplicitProperty() const
Definition: ExprObjC.h:670
llvm::SmallMapVector< ParmVarDecl *, Stmt *, 4 > CoroutineParameterMoves
A mapping between the coroutine function parameters that were moved to the coroutine frame...
Definition: ScopeInfo.h:197
Represents a struct/union/class.
Definition: Decl.h:3602
bool isExplicitProperty() const
Definition: ExprObjC.h:668
field_range fields() const
Definition: Decl.h:3793
llvm::SmallPtrSet< const BlockDecl *, 1 > Blocks
The set of blocks that are introduced in this function.
Definition: ScopeInfo.h:207
Expr * getSourceExpr() const
The source expression of an opaque value expression is the expression which originally generated the ...
Definition: Expr.h:1004
SourceLocation FirstSEHTryLoc
First SEH &#39;__try&#39; statement in the current function.
Definition: ScopeInfo.h:174
DiagnosticErrorTrap ErrorTrap
Used to determine if errors occurred in this function or block.
Definition: ScopeInfo.h:177
bool isClassReceiver() const
Definition: ExprObjC.h:740
Expr * IgnoreParenCasts() LLVM_READONLY
IgnoreParenCasts - Ignore parentheses and casts.
Definition: Expr.cpp:2554
bool isObjCSelfExpr() const
Check if this expression is the ObjC &#39;self&#39; implicit parameter.
Definition: Expr.cpp:3540
SourceLocation FirstCXXTryLoc
First C++ &#39;try&#39; statement in the current function.
Definition: ScopeInfo.h:171
ObjCIvarDecl * getDecl()
Definition: ExprObjC.h:543
ConditionalOperator - The ?: ternary operator.
Definition: Expr.h:3528
SmallVector< ReturnStmt *, 4 > Returns
The list of return statements that occur within the function or block, if there is any chance of appl...
Definition: ScopeInfo.h:190
void recordUseOfWeak(const ExprT *E, bool IsRead=true)
Record that a weak object was accessed.
Definition: ScopeInfo.h:1001
This represents one expression.
Definition: Expr.h:106
SmallVector< SwitchInfo, 8 > SwitchStack
SwitchStack - This is the current set of active switch statements in the block.
Definition: ScopeInfo.h:185
bool HasBranchProtectedScope
Whether this function contains a VLA, @try, try, C++ initializer, or anything else that can&#39;t be jump...
Definition: ScopeInfo.h:112
An expression that sends a message to the given Objective-C object or class.
Definition: ExprObjC.h:904
ObjCMethodDecl * getImplicitPropertyGetter() const
Definition: ExprObjC.h:675
VarDecl * CoroutinePromise
The promise object for this coroutine, if any.
Definition: ScopeInfo.h:193
OpaqueValueExpr - An expression referring to an opaque object of a fixed type and value class...
Definition: Expr.h:945
unsigned getNumArgs() const
Return the number of actual arguments in this message, not counting the receiver. ...
Definition: ExprObjC.h:1329
PseudoObjectExpr - An expression which accesses a pseudo-object l-value.
Definition: Expr.h:5245
bool HasPotentialAvailabilityViolations
Whether we make reference to a declaration that could be unavailable.
Definition: ScopeInfo.h:131
Encodes a location in the source.
bool ObjCWarnForNoDesignatedInitChain
This starts true for a method marked as designated initializer and will be set to false if there is a...
Definition: ScopeInfo.h:144
void reset()
Set to initial state of "no errors occurred".
Definition: Diagnostic.h:1018
SourceLocation FirstCoroutineStmtLoc
First coroutine statement in the current function.
Definition: ScopeInfo.h:165
Represents one property declaration in an Objective-C interface.
Definition: DeclObjC.h:721
bool ObjCIsDesignatedInit
True when this is a method marked as a designated initializer.
Definition: ScopeInfo.h:139
bool ObjCShouldCallSuper
A flag that is set when parsing a method that must call super&#39;s implementation, such as -dealloc...
Definition: ScopeInfo.h:136
bool HasOMPDeclareReductionCombiner
True if current scope is for OpenMP declare reduction combiner.
Definition: ScopeInfo.h:124
Expr * getInstanceReceiver()
Returns the object expression (receiver) for an instance message, or null for a message that is not a...
Definition: ExprObjC.h:1207
Dataflow Directional Tag Classes.
bool ObjCIsSecondaryInit
True when this is an initializer method not marked as a designated initializer within a class that ha...
Definition: ScopeInfo.h:149
bool HasIndirectGoto
Whether this function contains any indirect gotos.
Definition: ScopeInfo.h:118
StmtClass getStmtClass() const
Definition: Stmt.h:809
Represents a simple identification of a weak object.
Definition: ScopeInfo.h:244
bool ObjCWarnForNoInitDelegation
This starts true for a secondary initializer method and will be set to false if there is an invocatio...
Definition: ScopeInfo.h:153
Expr * IgnoreParenImpCasts() LLVM_READONLY
IgnoreParenImpCasts - Ignore parentheses and implicit casts.
Definition: Expr.cpp:2652
SourceLocation FirstReturnLoc
First &#39;return&#39; statement in the current function.
Definition: ScopeInfo.h:168
void markSafeWeakUse(const Expr *E)
Record that a given expression is a "safe" access of a weak object (e.g.
Definition: ScopeInfo.cpp:173
const Expr * getBase() const
Definition: ExprObjC.h:547
ObjCIvarRefExpr - A reference to an ObjC instance variable.
Definition: ExprObjC.h:513
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate.h) and friends (in DeclFriend.h).
MemberExpr - [C99 6.5.2.3] Structure and Union Members.
Definition: Expr.h:2601
SmallVector< PossiblyUnreachableDiag, 4 > PossiblyUnreachableDiags
A list of PartialDiagnostics created but delayed within the current function scope.
Definition: ScopeInfo.h:215
BinaryConditionalOperator - The GNU extension to the conditional operator which allows the middle ope...
Definition: Expr.h:3601
llvm::SmallPtrSet< const ParmVarDecl *, 8 > ModifiedNonNullParams
A list of parameters which have the nonnull attribute and are modified in the function.
Definition: ScopeInfo.h:219
Represents a single use of a weak object.
Definition: ScopeInfo.h:328
bool isObjectReceiver() const
Definition: ExprObjC.h:738
A reference to a declared variable, function, enum, etc.
Definition: Expr.h:1042
#define true
Definition: stdbool.h:32
const Expr * getBase() const
Definition: ExprObjC.h:719
llvm::TinyPtrVector< VarDecl * > ByrefBlockVars
The set of __block variables that are introduced in this function.
Definition: ScopeInfo.h:210
This represents a decl that may have a name.
Definition: Decl.h:248
Represents a C array with a specified size that is not an integer-constant-expression.
Definition: Type.h:2977
void Clear()
Clear out the information in this function scope, making it suitable for reuse.
Definition: ScopeInfo.cpp:26
bool HasBranchIntoScope
Whether this function contains any switches or direct gotos.
Definition: ScopeInfo.h:115