clang  8.0.0svn
CGBlocks.h
Go to the documentation of this file.
1 //===-- CGBlocks.h - state for LLVM CodeGen for blocks ----------*- 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 is the internal state used for llvm translation for block literals.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LIB_CODEGEN_CGBLOCKS_H
15 #define LLVM_CLANG_LIB_CODEGEN_CGBLOCKS_H
16 
17 #include "CGBuilder.h"
18 #include "CGCall.h"
19 #include "CGValue.h"
20 #include "CodeGenFunction.h"
21 #include "CodeGenTypes.h"
22 #include "clang/AST/CharUnits.h"
23 #include "clang/AST/Expr.h"
24 #include "clang/AST/ExprCXX.h"
25 #include "clang/AST/ExprObjC.h"
26 #include "clang/AST/Type.h"
27 #include "clang/Basic/TargetInfo.h"
28 
29 namespace llvm {
30 class Constant;
31 class Function;
32 class GlobalValue;
33 class DataLayout;
34 class FunctionType;
35 class PointerType;
36 class Value;
37 class LLVMContext;
38 }
39 
40 namespace clang {
41 namespace CodeGen {
42 
43 class CGBlockInfo;
44 
45 // Flags stored in __block variables.
47  BLOCK_BYREF_HAS_COPY_DISPOSE = (1 << 25), // compiler
48  BLOCK_BYREF_LAYOUT_MASK = (0xF << 28), // compiler
54 };
55 
57  BLOCK_IS_NOESCAPE = (1 << 23),
59  BLOCK_HAS_CXX_OBJ = (1 << 26),
60  BLOCK_IS_GLOBAL = (1 << 28),
61  BLOCK_USE_STRET = (1 << 29),
62  BLOCK_HAS_SIGNATURE = (1 << 30),
64 };
65 class BlockFlags {
66  uint32_t flags;
67 
68 public:
69  BlockFlags(uint32_t flags) : flags(flags) {}
70  BlockFlags() : flags(0) {}
71  BlockFlags(BlockLiteralFlags flag) : flags(flag) {}
72  BlockFlags(BlockByrefFlags flag) : flags(flag) {}
73 
74  uint32_t getBitMask() const { return flags; }
75  bool empty() const { return flags == 0; }
76 
78  return BlockFlags(l.flags | r.flags);
79  }
81  l.flags |= r.flags;
82  return l;
83  }
84  friend bool operator&(BlockFlags l, BlockFlags r) {
85  return (l.flags & r.flags);
86  }
88  return (flags == r.flags);
89  }
90 };
92  return BlockFlags(l) | BlockFlags(r);
93 }
94 
96  BLOCK_FIELD_IS_OBJECT = 0x03, /* id, NSObject, __attribute__((NSObject)),
97  block, ... */
98  BLOCK_FIELD_IS_BLOCK = 0x07, /* a block variable */
99 
100  BLOCK_FIELD_IS_BYREF = 0x08, /* the on stack structure holding the __block
101  variable */
102  BLOCK_FIELD_IS_WEAK = 0x10, /* declared __weak, only used in byref copy
103  helpers */
104  BLOCK_FIELD_IS_ARC = 0x40, /* field has ARC-specific semantics */
105  BLOCK_BYREF_CALLER = 128, /* called from __block (byref) copy/dispose
106  support routines */
108 };
109 
111  uint32_t flags;
112 
113  BlockFieldFlags(uint32_t flags) : flags(flags) {}
114 public:
115  BlockFieldFlags() : flags(0) {}
116  BlockFieldFlags(BlockFieldFlag_t flag) : flags(flag) {}
117 
118  uint32_t getBitMask() const { return flags; }
119  bool empty() const { return flags == 0; }
120 
121  /// Answers whether the flags indicate that this field is an object
122  /// or block pointer that requires _Block_object_assign/dispose.
123  bool isSpecialPointer() const { return flags & BLOCK_FIELD_IS_OBJECT; }
124 
126  return BlockFieldFlags(l.flags | r.flags);
127  }
129  l.flags |= r.flags;
130  return l;
131  }
133  return (l.flags & r.flags);
134  }
135  bool operator==(BlockFieldFlags Other) const {
136  return flags == Other.flags;
137  }
138 };
140  return BlockFieldFlags(l) | BlockFieldFlags(r);
141 }
142 
143 /// Information about the layout of a __block variable.
145 public:
146  llvm::StructType *Type;
147  unsigned FieldIndex;
150 };
151 
152 /// CGBlockInfo - Information to generate a block literal.
153 class CGBlockInfo {
154 public:
155  /// Name - The name of the block, kindof.
156  StringRef Name;
157 
158  /// The field index of 'this' within the block, if there is one.
159  unsigned CXXThisIndex;
160 
161  class Capture {
162  uintptr_t Data;
165 
166  /// Type of the capture field. Normally, this is identical to the type of
167  /// the capture's VarDecl, but can be different if there is an enclosing
168  /// lambda.
169  QualType FieldType;
170 
171  public:
172  bool isIndex() const { return (Data & 1) != 0; }
173  bool isConstant() const { return !isIndex(); }
174 
175  unsigned getIndex() const {
176  assert(isIndex());
177  return Data >> 1;
178  }
180  assert(isIndex());
181  return CharUnits::fromQuantity(Offset);
182  }
184  assert(isIndex());
185  return Cleanup;
186  }
188  assert(isIndex());
189  Cleanup = cleanup;
190  }
191 
193  assert(isConstant());
194  return reinterpret_cast<llvm::Value*>(Data);
195  }
196 
197  QualType fieldType() const {
198  return FieldType;
199  }
200 
201  static Capture makeIndex(unsigned index, CharUnits offset,
202  QualType FieldType) {
203  Capture v;
204  v.Data = (index << 1) | 1;
205  v.Offset = offset.getQuantity();
206  v.FieldType = FieldType;
207  return v;
208  }
209 
211  Capture v;
212  v.Data = reinterpret_cast<uintptr_t>(value);
213  return v;
214  }
215  };
216 
217  /// CanBeGlobal - True if the block can be global, i.e. it has
218  /// no non-constant captures.
219  bool CanBeGlobal : 1;
220 
221  /// True if the block has captures that would necessitate custom copy or
222  /// dispose helper functions if the block were escaping.
224 
225  /// HasCXXObject - True if the block's custom copy/dispose functions
226  /// need to be run even in GC mode.
227  bool HasCXXObject : 1;
228 
229  /// UsesStret : True if the block uses an stret return. Mutable
230  /// because it gets set later in the block-creation process.
231  mutable bool UsesStret : 1;
232 
233  /// HasCapturedVariableLayout : True if block has captured variables
234  /// and their layout meta-data has been generated.
236 
237  /// Indicates whether an object of a non-external C++ class is captured. This
238  /// bit is used to determine the linkage of the block copy/destroy helper
239  /// functions.
241 
242  /// The mapping of allocated indexes within the block.
243  llvm::DenseMap<const VarDecl*, Capture> Captures;
244 
246  llvm::StructType *StructureType;
247  const BlockDecl *Block;
252 
253  // Offset of the gap caused by block header having a smaller
254  // alignment than the alignment of the block descriptor. This
255  // is the gap offset before the first capturued field.
257  // Gap size caused by aligning first field after block header.
258  // This could be zero if no forced alignment is required.
260 
261  /// An instruction which dominates the full-expression that the
262  /// block is inside.
263  llvm::Instruction *DominatingIP;
264 
265  /// The next block in the block-info chain. Invalid if this block
266  /// info is not part of the CGF's block-info chain, which is true
267  /// if it corresponds to a global block or a block whose expression
268  /// has been encountered.
270 
271  const Capture &getCapture(const VarDecl *var) const {
272  return const_cast<CGBlockInfo*>(this)->getCapture(var);
273  }
274  Capture &getCapture(const VarDecl *var) {
275  llvm::DenseMap<const VarDecl*, Capture>::iterator
276  it = Captures.find(var);
277  assert(it != Captures.end() && "no entry for variable!");
278  return it->second;
279  }
280 
281  const BlockDecl *getBlockDecl() const { return Block; }
282  const BlockExpr *getBlockExpr() const {
283  assert(BlockExpression);
284  assert(BlockExpression->getBlockDecl() == Block);
285  return BlockExpression;
286  }
287 
288  CGBlockInfo(const BlockDecl *blockDecl, StringRef Name);
289 
290  // Indicates whether the block needs a custom copy or dispose function.
291  bool needsCopyDisposeHelpers() const {
292  return NeedsCopyDispose && !Block->doesNotEscape();
293  }
294 };
295 
296 } // end namespace CodeGen
297 } // end namespace clang
298 
299 #endif
const BlockDecl * getBlockDecl() const
Definition: Expr.h:5110
Information about the layout of a __block variable.
Definition: CGBlocks.h:144
const Capture & getCapture(const VarDecl *var) const
Definition: CGBlocks.h:271
int64_t QuantityType
Definition: CharUnits.h:40
CharUnits BlockHeaderForcedGapOffset
Definition: CGBlocks.h:256
A (possibly-)qualified type.
Definition: Type.h:642
Capture & getCapture(const VarDecl *var)
Definition: CGBlocks.h:274
DominatorTree GraphTraits specialization so the DominatorTree can be iterable by generic graph iterat...
Definition: Dominators.h:30
tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code, ArrayRef< tooling::Range > Ranges, StringRef FileName="<stdin>")
Clean up any erroneous/redundant code in the given Ranges in Code.
Definition: Format.cpp:2228
C Language Family Type Representation.
friend BlockFieldFlags operator|(BlockFieldFlags l, BlockFieldFlags r)
Definition: CGBlocks.h:125
bool operator==(BlockFlags r)
Definition: CGBlocks.h:87
constexpr XRayInstrMask Function
Definition: XRayInstr.h:39
BlockFlags(uint32_t flags)
Definition: CGBlocks.h:69
Represents a variable declaration or definition.
Definition: Decl.h:812
EHScopeStack::stable_iterator getCleanup() const
Definition: CGBlocks.h:183
Defines the clang::Expr interface and subclasses for C++ expressions.
const BlockDecl * Block
Definition: CGBlocks.h:247
bool doesNotEscape() const
Definition: Decl.h:4005
bool HasCapturedVariableLayout
HasCapturedVariableLayout : True if block has captured variables and their layout meta-data has been ...
Definition: CGBlocks.h:235
BlockFlags(BlockByrefFlags flag)
Definition: CGBlocks.h:72
BlockFieldFlags operator|(BlockFieldFlag_t l, BlockFieldFlag_t r)
Definition: CGBlocks.h:139
BlockFieldFlags(BlockFieldFlag_t flag)
Definition: CGBlocks.h:116
CharUnits - This is an opaque type for sizes expressed in character units.
Definition: CharUnits.h:38
const BlockDecl * getBlockDecl() const
Definition: CGBlocks.h:281
uint32_t Offset
Definition: CacheTokens.cpp:43
bool HasCXXObject
HasCXXObject - True if the block&#39;s custom copy/dispose functions need to be run even in GC mode...
Definition: CGBlocks.h:227
uint32_t getBitMask() const
Definition: CGBlocks.h:118
static Capture makeConstant(llvm::Value *value)
Definition: CGBlocks.h:210
friend BlockFieldFlags & operator|=(BlockFieldFlags &l, BlockFieldFlags r)
Definition: CGBlocks.h:128
StringRef Name
Name - The name of the block, kindof.
Definition: CGBlocks.h:156
bool NeedsCopyDispose
True if the block has captures that would necessitate custom copy or dispose helper functions if the ...
Definition: CGBlocks.h:223
const BlockExpr * BlockExpression
Definition: CGBlocks.h:248
uint32_t getBitMask() const
Definition: CGBlocks.h:74
CGBlockInfo - Information to generate a block literal.
Definition: CGBlocks.h:153
bool CanBeGlobal
CanBeGlobal - True if the block can be global, i.e.
Definition: CGBlocks.h:219
QuantityType getQuantity() const
getQuantity - Get the raw integer representation of this quantity.
Definition: CharUnits.h:179
BlockFlags(BlockLiteralFlags flag)
Definition: CGBlocks.h:71
CGBlockInfo * NextBlockInfo
The next block in the block-info chain.
Definition: CGBlocks.h:269
DiagnosticLevelMask operator &(DiagnosticLevelMask LHS, DiagnosticLevelMask RHS)
Pepresents a block literal declaration, which is like an unnamed FunctionDecl.
Definition: Decl.h:3854
BlockExpr - Adaptor class for mixing a BlockDecl with expressions.
Definition: Expr.h:5096
friend BlockFlags operator|(BlockFlags l, BlockFlags r)
Definition: CGBlocks.h:77
bool needsCopyDisposeHelpers() const
Definition: CGBlocks.h:291
static Capture makeIndex(unsigned index, CharUnits offset, QualType FieldType)
Definition: CGBlocks.h:201
do v
Definition: arm_acle.h:78
__UINTPTR_TYPE__ uintptr_t
An unsigned integer type with the property that any valid pointer to void can be converted to this ty...
Definition: opencl-c.h:90
bool UsesStret
UsesStret : True if the block uses an stret return.
Definition: CGBlocks.h:231
A saved depth on the scope stack.
Definition: EHScopeStack.h:107
llvm::StructType * StructureType
Definition: CGBlocks.h:246
bool CapturesNonExternalType
Indicates whether an object of a non-external C++ class is captured.
Definition: CGBlocks.h:240
llvm::DenseMap< const VarDecl *, Capture > Captures
The mapping of allocated indexes within the block.
Definition: CGBlocks.h:243
An aligned address.
Definition: Address.h:25
llvm::Value * getConstant() const
Definition: CGBlocks.h:192
const BlockExpr * getBlockExpr() const
Definition: CGBlocks.h:282
unsigned CXXThisIndex
The field index of &#39;this&#39; within the block, if there is one.
Definition: CGBlocks.h:159
Dataflow Directional Tag Classes.
bool isSpecialPointer() const
Answers whether the flags indicate that this field is an object or block pointer that requires _Block...
Definition: CGBlocks.h:123
friend BlockFlags & operator|=(BlockFlags &l, BlockFlags r)
Definition: CGBlocks.h:80
llvm::StructType * Type
Definition: CGBlocks.h:146
CharUnits BlockHeaderForcedGapSize
Definition: CGBlocks.h:259
bool operator==(BlockFieldFlags Other) const
Definition: CGBlocks.h:135
Defines the clang::TargetInfo interface.
const internal::VariadicDynCastAllOfMatcher< Decl, BlockDecl > blockDecl
Matches block declarations.
llvm::Instruction * DominatingIP
An instruction which dominates the full-expression that the block is inside.
Definition: CGBlocks.h:263
void setCleanup(EHScopeStack::stable_iterator cleanup)
Definition: CGBlocks.h:187