clang  10.0.0svn
CGBlocks.cpp
Go to the documentation of this file.
1 //===--- CGBlocks.cpp - Emit LLVM Code for declarations ---------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This contains code to emit blocks.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "CGBlocks.h"
14 #include "CGCXXABI.h"
15 #include "CGDebugInfo.h"
16 #include "CGObjCRuntime.h"
17 #include "CGOpenCLRuntime.h"
18 #include "CodeGenFunction.h"
19 #include "CodeGenModule.h"
20 #include "ConstantEmitter.h"
21 #include "TargetInfo.h"
22 #include "clang/AST/DeclObjC.h"
24 #include "llvm/ADT/SmallSet.h"
25 #include "llvm/IR/DataLayout.h"
26 #include "llvm/IR/Module.h"
27 #include "llvm/Support/ScopedPrinter.h"
28 #include <algorithm>
29 #include <cstdio>
30 
31 using namespace clang;
32 using namespace CodeGen;
33 
34 CGBlockInfo::CGBlockInfo(const BlockDecl *block, StringRef name)
35  : Name(name), CXXThisIndex(0), CanBeGlobal(false), NeedsCopyDispose(false),
36  HasCXXObject(false), UsesStret(false), HasCapturedVariableLayout(false),
37  CapturesNonExternalType(false), LocalAddress(Address::invalid()),
38  StructureType(nullptr), Block(block), DominatingIP(nullptr) {
39 
40  // Skip asm prefix, if any. 'name' is usually taken directly from
41  // the mangled name of the enclosing function.
42  if (!name.empty() && name[0] == '\01')
43  name = name.substr(1);
44 }
45 
46 // Anchor the vtable to this translation unit.
48 
49 /// Build the given block as a global block.
50 static llvm::Constant *buildGlobalBlock(CodeGenModule &CGM,
51  const CGBlockInfo &blockInfo,
52  llvm::Constant *blockFn);
53 
54 /// Build the helper function to copy a block.
55 static llvm::Constant *buildCopyHelper(CodeGenModule &CGM,
56  const CGBlockInfo &blockInfo) {
57  return CodeGenFunction(CGM).GenerateCopyHelperFunction(blockInfo);
58 }
59 
60 /// Build the helper function to dispose of a block.
61 static llvm::Constant *buildDisposeHelper(CodeGenModule &CGM,
62  const CGBlockInfo &blockInfo) {
63  return CodeGenFunction(CGM).GenerateDestroyHelperFunction(blockInfo);
64 }
65 
66 namespace {
67 
68 /// Represents a type of copy/destroy operation that should be performed for an
69 /// entity that's captured by a block.
71  CXXRecord, // Copy or destroy
72  ARCWeak,
73  ARCStrong,
74  NonTrivialCStruct,
75  BlockObject, // Assign or release
76  None
77 };
78 
79 /// Represents a captured entity that requires extra operations in order for
80 /// this entity to be copied or destroyed correctly.
81 struct BlockCaptureManagedEntity {
82  BlockCaptureEntityKind CopyKind, DisposeKind;
83  BlockFieldFlags CopyFlags, DisposeFlags;
84  const BlockDecl::Capture *CI;
86 
87  BlockCaptureManagedEntity(BlockCaptureEntityKind CopyType,
88  BlockCaptureEntityKind DisposeType,
89  BlockFieldFlags CopyFlags,
90  BlockFieldFlags DisposeFlags,
91  const BlockDecl::Capture &CI,
92  const CGBlockInfo::Capture &Capture)
93  : CopyKind(CopyType), DisposeKind(DisposeType), CopyFlags(CopyFlags),
94  DisposeFlags(DisposeFlags), CI(&CI), Capture(&Capture) {}
95 
96  bool operator<(const BlockCaptureManagedEntity &Other) const {
97  return Capture->getOffset() < Other.Capture->getOffset();
98  }
99 };
100 
101 enum class CaptureStrKind {
102  // String for the copy helper.
103  CopyHelper,
104  // String for the dispose helper.
105  DisposeHelper,
106  // Merge the strings for the copy helper and dispose helper.
107  Merged
108 };
109 
110 } // end anonymous namespace
111 
113  const CGBlockInfo &BlockInfo, const LangOptions &LangOpts,
114  SmallVectorImpl<BlockCaptureManagedEntity> &ManagedCaptures);
115 
116 static std::string getBlockCaptureStr(const BlockCaptureManagedEntity &E,
117  CaptureStrKind StrKind,
118  CharUnits BlockAlignment,
119  CodeGenModule &CGM);
120 
121 static std::string getBlockDescriptorName(const CGBlockInfo &BlockInfo,
122  CodeGenModule &CGM) {
123  std::string Name = "__block_descriptor_";
124  Name += llvm::to_string(BlockInfo.BlockSize.getQuantity()) + "_";
125 
126  if (BlockInfo.needsCopyDisposeHelpers()) {
127  if (CGM.getLangOpts().Exceptions)
128  Name += "e";
129  if (CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
130  Name += "a";
131  Name += llvm::to_string(BlockInfo.BlockAlign.getQuantity()) + "_";
132 
135  ManagedCaptures);
136 
137  for (const BlockCaptureManagedEntity &E : ManagedCaptures) {
138  Name += llvm::to_string(E.Capture->getOffset().getQuantity());
139 
140  if (E.CopyKind == E.DisposeKind) {
141  // If CopyKind and DisposeKind are the same, merge the capture
142  // information.
143  assert(E.CopyKind != BlockCaptureEntityKind::None &&
144  "shouldn't see BlockCaptureManagedEntity that is None");
145  Name += getBlockCaptureStr(E, CaptureStrKind::Merged,
146  BlockInfo.BlockAlign, CGM);
147  } else {
148  // If CopyKind and DisposeKind are not the same, which can happen when
149  // either Kind is None or the captured object is a __strong block,
150  // concatenate the copy and dispose strings.
151  Name += getBlockCaptureStr(E, CaptureStrKind::CopyHelper,
152  BlockInfo.BlockAlign, CGM);
153  Name += getBlockCaptureStr(E, CaptureStrKind::DisposeHelper,
154  BlockInfo.BlockAlign, CGM);
155  }
156  }
157  Name += "_";
158  }
159 
160  std::string TypeAtEncoding =
162  /// Replace occurrences of '@' with '\1'. '@' is reserved on ELF platforms as
163  /// a separator between symbol name and symbol version.
164  std::replace(TypeAtEncoding.begin(), TypeAtEncoding.end(), '@', '\1');
165  Name += "e" + llvm::to_string(TypeAtEncoding.size()) + "_" + TypeAtEncoding;
166  Name += "l" + CGM.getObjCRuntime().getRCBlockLayoutStr(CGM, BlockInfo);
167  return Name;
168 }
169 
170 /// buildBlockDescriptor - Build the block descriptor meta-data for a block.
171 /// buildBlockDescriptor is accessed from 5th field of the Block_literal
172 /// meta-data and contains stationary information about the block literal.
173 /// Its definition will have 4 (or optionally 6) words.
174 /// \code
175 /// struct Block_descriptor {
176 /// unsigned long reserved;
177 /// unsigned long size; // size of Block_literal metadata in bytes.
178 /// void *copy_func_helper_decl; // optional copy helper.
179 /// void *destroy_func_decl; // optional destructor helper.
180 /// void *block_method_encoding_address; // @encode for block literal signature.
181 /// void *block_layout_info; // encoding of captured block variables.
182 /// };
183 /// \endcode
184 static llvm::Constant *buildBlockDescriptor(CodeGenModule &CGM,
185  const CGBlockInfo &blockInfo) {
186  ASTContext &C = CGM.getContext();
187 
188  llvm::IntegerType *ulong =
189  cast<llvm::IntegerType>(CGM.getTypes().ConvertType(C.UnsignedLongTy));
190  llvm::PointerType *i8p = nullptr;
191  if (CGM.getLangOpts().OpenCL)
192  i8p =
193  llvm::Type::getInt8PtrTy(
195  else
196  i8p = CGM.VoidPtrTy;
197 
198  std::string descName;
199 
200  // If an equivalent block descriptor global variable exists, return it.
201  if (C.getLangOpts().ObjC &&
202  CGM.getLangOpts().getGC() == LangOptions::NonGC) {
203  descName = getBlockDescriptorName(blockInfo, CGM);
204  if (llvm::GlobalValue *desc = CGM.getModule().getNamedValue(descName))
205  return llvm::ConstantExpr::getBitCast(desc,
206  CGM.getBlockDescriptorType());
207  }
208 
209  // If there isn't an equivalent block descriptor global variable, create a new
210  // one.
211  ConstantInitBuilder builder(CGM);
212  auto elements = builder.beginStruct();
213 
214  // reserved
215  elements.addInt(ulong, 0);
216 
217  // Size
218  // FIXME: What is the right way to say this doesn't fit? We should give
219  // a user diagnostic in that case. Better fix would be to change the
220  // API to size_t.
221  elements.addInt(ulong, blockInfo.BlockSize.getQuantity());
222 
223  // Optional copy/dispose helpers.
224  bool hasInternalHelper = false;
225  if (blockInfo.needsCopyDisposeHelpers()) {
226  // copy_func_helper_decl
227  llvm::Constant *copyHelper = buildCopyHelper(CGM, blockInfo);
228  elements.add(copyHelper);
229 
230  // destroy_func_decl
231  llvm::Constant *disposeHelper = buildDisposeHelper(CGM, blockInfo);
232  elements.add(disposeHelper);
233 
234  if (cast<llvm::Function>(copyHelper->getOperand(0))->hasInternalLinkage() ||
235  cast<llvm::Function>(disposeHelper->getOperand(0))
236  ->hasInternalLinkage())
237  hasInternalHelper = true;
238  }
239 
240  // Signature. Mandatory ObjC-style method descriptor @encode sequence.
241  std::string typeAtEncoding =
243  elements.add(llvm::ConstantExpr::getBitCast(
244  CGM.GetAddrOfConstantCString(typeAtEncoding).getPointer(), i8p));
245 
246  // GC layout.
247  if (C.getLangOpts().ObjC) {
248  if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
249  elements.add(CGM.getObjCRuntime().BuildGCBlockLayout(CGM, blockInfo));
250  else
251  elements.add(CGM.getObjCRuntime().BuildRCBlockLayout(CGM, blockInfo));
252  }
253  else
254  elements.addNullPointer(i8p);
255 
256  unsigned AddrSpace = 0;
257  if (C.getLangOpts().OpenCL)
259 
260  llvm::GlobalValue::LinkageTypes linkage;
261  if (descName.empty()) {
263  descName = "__block_descriptor_tmp";
264  } else if (hasInternalHelper) {
265  // If either the copy helper or the dispose helper has internal linkage,
266  // the block descriptor must have internal linkage too.
268  } else {
269  linkage = llvm::GlobalValue::LinkOnceODRLinkage;
270  }
271 
272  llvm::GlobalVariable *global =
273  elements.finishAndCreateGlobal(descName, CGM.getPointerAlign(),
274  /*constant*/ true, linkage, AddrSpace);
275 
276  if (linkage == llvm::GlobalValue::LinkOnceODRLinkage) {
277  if (CGM.supportsCOMDAT())
278  global->setComdat(CGM.getModule().getOrInsertComdat(descName));
279  global->setVisibility(llvm::GlobalValue::HiddenVisibility);
280  global->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
281  }
282 
283  return llvm::ConstantExpr::getBitCast(global, CGM.getBlockDescriptorType());
284 }
285 
286 /*
287  Purely notional variadic template describing the layout of a block.
288 
289  template <class _ResultType, class... _ParamTypes, class... _CaptureTypes>
290  struct Block_literal {
291  /// Initialized to one of:
292  /// extern void *_NSConcreteStackBlock[];
293  /// extern void *_NSConcreteGlobalBlock[];
294  ///
295  /// In theory, we could start one off malloc'ed by setting
296  /// BLOCK_NEEDS_FREE, giving it a refcount of 1, and using
297  /// this isa:
298  /// extern void *_NSConcreteMallocBlock[];
299  struct objc_class *isa;
300 
301  /// These are the flags (with corresponding bit number) that the
302  /// compiler is actually supposed to know about.
303  /// 23. BLOCK_IS_NOESCAPE - indicates that the block is non-escaping
304  /// 25. BLOCK_HAS_COPY_DISPOSE - indicates that the block
305  /// descriptor provides copy and dispose helper functions
306  /// 26. BLOCK_HAS_CXX_OBJ - indicates that there's a captured
307  /// object with a nontrivial destructor or copy constructor
308  /// 28. BLOCK_IS_GLOBAL - indicates that the block is allocated
309  /// as global memory
310  /// 29. BLOCK_USE_STRET - indicates that the block function
311  /// uses stret, which objc_msgSend needs to know about
312  /// 30. BLOCK_HAS_SIGNATURE - indicates that the block has an
313  /// @encoded signature string
314  /// And we're not supposed to manipulate these:
315  /// 24. BLOCK_NEEDS_FREE - indicates that the block has been moved
316  /// to malloc'ed memory
317  /// 27. BLOCK_IS_GC - indicates that the block has been moved to
318  /// to GC-allocated memory
319  /// Additionally, the bottom 16 bits are a reference count which
320  /// should be zero on the stack.
321  int flags;
322 
323  /// Reserved; should be zero-initialized.
324  int reserved;
325 
326  /// Function pointer generated from block literal.
327  _ResultType (*invoke)(Block_literal *, _ParamTypes...);
328 
329  /// Block description metadata generated from block literal.
330  struct Block_descriptor *block_descriptor;
331 
332  /// Captured values follow.
333  _CapturesTypes captures...;
334  };
335  */
336 
337 namespace {
338  /// A chunk of data that we actually have to capture in the block.
339  struct BlockLayoutChunk {
340  CharUnits Alignment;
341  CharUnits Size;
342  Qualifiers::ObjCLifetime Lifetime;
343  const BlockDecl::Capture *Capture; // null for 'this'
344  llvm::Type *Type;
345  QualType FieldType;
346 
347  BlockLayoutChunk(CharUnits align, CharUnits size,
348  Qualifiers::ObjCLifetime lifetime,
349  const BlockDecl::Capture *capture,
350  llvm::Type *type, QualType fieldType)
351  : Alignment(align), Size(size), Lifetime(lifetime),
352  Capture(capture), Type(type), FieldType(fieldType) {}
353 
354  /// Tell the block info that this chunk has the given field index.
355  void setIndex(CGBlockInfo &info, unsigned index, CharUnits offset) {
356  if (!Capture) {
357  info.CXXThisIndex = index;
358  info.CXXThisOffset = offset;
359  } else {
360  auto C = CGBlockInfo::Capture::makeIndex(index, offset, FieldType);
361  info.Captures.insert({Capture->getVariable(), C});
362  }
363  }
364  };
365 
366  /// Order by 1) all __strong together 2) next, all byfref together 3) next,
367  /// all __weak together. Preserve descending alignment in all situations.
368  bool operator<(const BlockLayoutChunk &left, const BlockLayoutChunk &right) {
369  if (left.Alignment != right.Alignment)
370  return left.Alignment > right.Alignment;
371 
372  auto getPrefOrder = [](const BlockLayoutChunk &chunk) {
373  if (chunk.Capture && chunk.Capture->isByRef())
374  return 1;
375  if (chunk.Lifetime == Qualifiers::OCL_Strong)
376  return 0;
377  if (chunk.Lifetime == Qualifiers::OCL_Weak)
378  return 2;
379  return 3;
380  };
381 
382  return getPrefOrder(left) < getPrefOrder(right);
383  }
384 } // end anonymous namespace
385 
386 /// Determines if the given type is safe for constant capture in C++.
388  const RecordType *recordType =
390 
391  // Only records can be unsafe.
392  if (!recordType) return true;
393 
394  const auto *record = cast<CXXRecordDecl>(recordType->getDecl());
395 
396  // Maintain semantics for classes with non-trivial dtors or copy ctors.
397  if (!record->hasTrivialDestructor()) return false;
398  if (record->hasNonTrivialCopyConstructor()) return false;
399 
400  // Otherwise, we just have to make sure there aren't any mutable
401  // fields that might have changed since initialization.
402  return !record->hasMutableFields();
403 }
404 
405 /// It is illegal to modify a const object after initialization.
406 /// Therefore, if a const object has a constant initializer, we don't
407 /// actually need to keep storage for it in the block; we'll just
408 /// rematerialize it at the start of the block function. This is
409 /// acceptable because we make no promises about address stability of
410 /// captured variables.
411 static llvm::Constant *tryCaptureAsConstant(CodeGenModule &CGM,
412  CodeGenFunction *CGF,
413  const VarDecl *var) {
414  // Return if this is a function parameter. We shouldn't try to
415  // rematerialize default arguments of function parameters.
416  if (isa<ParmVarDecl>(var))
417  return nullptr;
418 
419  QualType type = var->getType();
420 
421  // We can only do this if the variable is const.
422  if (!type.isConstQualified()) return nullptr;
423 
424  // Furthermore, in C++ we have to worry about mutable fields:
425  // C++ [dcl.type.cv]p4:
426  // Except that any class member declared mutable can be
427  // modified, any attempt to modify a const object during its
428  // lifetime results in undefined behavior.
429  if (CGM.getLangOpts().CPlusPlus && !isSafeForCXXConstantCapture(type))
430  return nullptr;
431 
432  // If the variable doesn't have any initializer (shouldn't this be
433  // invalid?), it's not clear what we should do. Maybe capture as
434  // zero?
435  const Expr *init = var->getInit();
436  if (!init) return nullptr;
437 
438  return ConstantEmitter(CGM, CGF).tryEmitAbstractForInitializer(*var);
439 }
440 
441 /// Get the low bit of a nonzero character count. This is the
442 /// alignment of the nth byte if the 0th byte is universally aligned.
444  return CharUnits::fromQuantity(v.getQuantity() & (~v.getQuantity() + 1));
445 }
446 
448  SmallVectorImpl<llvm::Type*> &elementTypes) {
449 
450  assert(elementTypes.empty());
451  if (CGM.getLangOpts().OpenCL) {
452  // The header is basically 'struct { int; int; generic void *;
453  // custom_fields; }'. Assert that struct is packed.
454  auto GenericAS =
456  auto GenPtrAlign =
457  CharUnits::fromQuantity(CGM.getTarget().getPointerAlign(GenericAS) / 8);
458  auto GenPtrSize =
459  CharUnits::fromQuantity(CGM.getTarget().getPointerWidth(GenericAS) / 8);
460  assert(CGM.getIntSize() <= GenPtrSize);
461  assert(CGM.getIntAlign() <= GenPtrAlign);
462  assert((2 * CGM.getIntSize()).isMultipleOf(GenPtrAlign));
463  elementTypes.push_back(CGM.IntTy); /* total size */
464  elementTypes.push_back(CGM.IntTy); /* align */
465  elementTypes.push_back(
466  CGM.getOpenCLRuntime()
467  .getGenericVoidPointerType()); /* invoke function */
468  unsigned Offset =
469  2 * CGM.getIntSize().getQuantity() + GenPtrSize.getQuantity();
470  unsigned BlockAlign = GenPtrAlign.getQuantity();
471  if (auto *Helper =
473  for (auto I : Helper->getCustomFieldTypes()) /* custom fields */ {
474  // TargetOpenCLBlockHelp needs to make sure the struct is packed.
475  // If necessary, add padding fields to the custom fields.
476  unsigned Align = CGM.getDataLayout().getABITypeAlignment(I);
477  if (BlockAlign < Align)
478  BlockAlign = Align;
479  assert(Offset % Align == 0);
480  Offset += CGM.getDataLayout().getTypeAllocSize(I);
481  elementTypes.push_back(I);
482  }
483  }
484  info.BlockAlign = CharUnits::fromQuantity(BlockAlign);
485  info.BlockSize = CharUnits::fromQuantity(Offset);
486  } else {
487  // The header is basically 'struct { void *; int; int; void *; void *; }'.
488  // Assert that the struct is packed.
489  assert(CGM.getIntSize() <= CGM.getPointerSize());
490  assert(CGM.getIntAlign() <= CGM.getPointerAlign());
491  assert((2 * CGM.getIntSize()).isMultipleOf(CGM.getPointerAlign()));
492  info.BlockAlign = CGM.getPointerAlign();
493  info.BlockSize = 3 * CGM.getPointerSize() + 2 * CGM.getIntSize();
494  elementTypes.push_back(CGM.VoidPtrTy);
495  elementTypes.push_back(CGM.IntTy);
496  elementTypes.push_back(CGM.IntTy);
497  elementTypes.push_back(CGM.VoidPtrTy);
498  elementTypes.push_back(CGM.getBlockDescriptorType());
499  }
500 }
501 
503  const BlockDecl::Capture &CI) {
504  const VarDecl *VD = CI.getVariable();
505 
506  // If the variable is captured by an enclosing block or lambda expression,
507  // use the type of the capture field.
508  if (CGF.BlockInfo && CI.isNested())
509  return CGF.BlockInfo->getCapture(VD).fieldType();
510  if (auto *FD = CGF.LambdaCaptureFields.lookup(VD))
511  return FD->getType();
512  // If the captured variable is a non-escaping __block variable, the field
513  // type is the reference type. If the variable is a __block variable that
514  // already has a reference type, the field type is the variable's type.
515  return VD->isNonEscapingByref() ?
516  CGF.getContext().getLValueReferenceType(VD->getType()) : VD->getType();
517 }
518 
519 /// Compute the layout of the given block. Attempts to lay the block
520 /// out with minimal space requirements.
522  CGBlockInfo &info) {
523  ASTContext &C = CGM.getContext();
524  const BlockDecl *block = info.getBlockDecl();
525 
526  SmallVector<llvm::Type*, 8> elementTypes;
527  initializeForBlockHeader(CGM, info, elementTypes);
528  bool hasNonConstantCustomFields = false;
529  if (auto *OpenCLHelper =
531  hasNonConstantCustomFields =
532  !OpenCLHelper->areAllCustomFieldValuesConstant(info);
533  if (!block->hasCaptures() && !hasNonConstantCustomFields) {
534  info.StructureType =
535  llvm::StructType::get(CGM.getLLVMContext(), elementTypes, true);
536  info.CanBeGlobal = true;
537  return;
538  }
539  else if (C.getLangOpts().ObjC &&
540  CGM.getLangOpts().getGC() == LangOptions::NonGC)
541  info.HasCapturedVariableLayout = true;
542 
543  // Collect the layout chunks.
545  layout.reserve(block->capturesCXXThis() +
546  (block->capture_end() - block->capture_begin()));
547 
548  CharUnits maxFieldAlign;
549 
550  // First, 'this'.
551  if (block->capturesCXXThis()) {
552  assert(CGF && CGF->CurFuncDecl && isa<CXXMethodDecl>(CGF->CurFuncDecl) &&
553  "Can't capture 'this' outside a method");
554  QualType thisType = cast<CXXMethodDecl>(CGF->CurFuncDecl)->getThisType();
555 
556  // Theoretically, this could be in a different address space, so
557  // don't assume standard pointer size/align.
558  llvm::Type *llvmType = CGM.getTypes().ConvertType(thisType);
559  std::pair<CharUnits,CharUnits> tinfo
560  = CGM.getContext().getTypeInfoInChars(thisType);
561  maxFieldAlign = std::max(maxFieldAlign, tinfo.second);
562 
563  layout.push_back(BlockLayoutChunk(tinfo.second, tinfo.first,
565  nullptr, llvmType, thisType));
566  }
567 
568  // Next, all the block captures.
569  for (const auto &CI : block->captures()) {
570  const VarDecl *variable = CI.getVariable();
571 
572  if (CI.isEscapingByref()) {
573  // We have to copy/dispose of the __block reference.
574  info.NeedsCopyDispose = true;
575 
576  // Just use void* instead of a pointer to the byref type.
578  maxFieldAlign = std::max(maxFieldAlign, align);
579 
580  // Since a __block variable cannot be captured by lambdas, its type and
581  // the capture field type should always match.
582  assert(getCaptureFieldType(*CGF, CI) == variable->getType() &&
583  "capture type differs from the variable type");
584  layout.push_back(BlockLayoutChunk(align, CGM.getPointerSize(),
586  CGM.VoidPtrTy, variable->getType()));
587  continue;
588  }
589 
590  // Otherwise, build a layout chunk with the size and alignment of
591  // the declaration.
592  if (llvm::Constant *constant = tryCaptureAsConstant(CGM, CGF, variable)) {
593  info.Captures[variable] = CGBlockInfo::Capture::makeConstant(constant);
594  continue;
595  }
596 
597  QualType VT = getCaptureFieldType(*CGF, CI);
598 
599  // If we have a lifetime qualifier, honor it for capture purposes.
600  // That includes *not* copying it if it's __unsafe_unretained.
602  if (lifetime) {
603  switch (lifetime) {
604  case Qualifiers::OCL_None: llvm_unreachable("impossible");
607  break;
608 
611  info.NeedsCopyDispose = true;
612  }
613 
614  // Block pointers require copy/dispose. So do Objective-C pointers.
615  } else if (VT->isObjCRetainableType()) {
616  // But honor the inert __unsafe_unretained qualifier, which doesn't
617  // actually make it into the type system.
619  lifetime = Qualifiers::OCL_ExplicitNone;
620  } else {
621  info.NeedsCopyDispose = true;
622  // used for mrr below.
623  lifetime = Qualifiers::OCL_Strong;
624  }
625 
626  // So do types that require non-trivial copy construction.
627  } else if (CI.hasCopyExpr()) {
628  info.NeedsCopyDispose = true;
629  info.HasCXXObject = true;
631  info.CapturesNonExternalType = true;
632 
633  // So do C structs that require non-trivial copy construction or
634  // destruction.
637  info.NeedsCopyDispose = true;
638 
639  // And so do types with destructors.
640  } else if (CGM.getLangOpts().CPlusPlus) {
641  if (const CXXRecordDecl *record = VT->getAsCXXRecordDecl()) {
642  if (!record->hasTrivialDestructor()) {
643  info.HasCXXObject = true;
644  info.NeedsCopyDispose = true;
645  if (!record->isExternallyVisible())
646  info.CapturesNonExternalType = true;
647  }
648  }
649  }
650 
651  CharUnits size = C.getTypeSizeInChars(VT);
652  CharUnits align = C.getDeclAlign(variable);
653 
654  maxFieldAlign = std::max(maxFieldAlign, align);
655 
656  llvm::Type *llvmType =
657  CGM.getTypes().ConvertTypeForMem(VT);
658 
659  layout.push_back(
660  BlockLayoutChunk(align, size, lifetime, &CI, llvmType, VT));
661  }
662 
663  // If that was everything, we're done here.
664  if (layout.empty()) {
665  info.StructureType =
666  llvm::StructType::get(CGM.getLLVMContext(), elementTypes, true);
667  info.CanBeGlobal = true;
668  return;
669  }
670 
671  // Sort the layout by alignment. We have to use a stable sort here
672  // to get reproducible results. There should probably be an
673  // llvm::array_pod_stable_sort.
674  llvm::stable_sort(layout);
675 
676  // Needed for blocks layout info.
679 
680  CharUnits &blockSize = info.BlockSize;
681  info.BlockAlign = std::max(maxFieldAlign, info.BlockAlign);
682 
683  // Assuming that the first byte in the header is maximally aligned,
684  // get the alignment of the first byte following the header.
685  CharUnits endAlign = getLowBit(blockSize);
686 
687  // If the end of the header isn't satisfactorily aligned for the
688  // maximum thing, look for things that are okay with the header-end
689  // alignment, and keep appending them until we get something that's
690  // aligned right. This algorithm is only guaranteed optimal if
691  // that condition is satisfied at some point; otherwise we can get
692  // things like:
693  // header // next byte has alignment 4
694  // something_with_size_5; // next byte has alignment 1
695  // something_with_alignment_8;
696  // which has 7 bytes of padding, as opposed to the naive solution
697  // which might have less (?).
698  if (endAlign < maxFieldAlign) {
699  SmallVectorImpl<BlockLayoutChunk>::iterator
700  li = layout.begin() + 1, le = layout.end();
701 
702  // Look for something that the header end is already
703  // satisfactorily aligned for.
704  for (; li != le && endAlign < li->Alignment; ++li)
705  ;
706 
707  // If we found something that's naturally aligned for the end of
708  // the header, keep adding things...
709  if (li != le) {
710  SmallVectorImpl<BlockLayoutChunk>::iterator first = li;
711  for (; li != le; ++li) {
712  assert(endAlign >= li->Alignment);
713 
714  li->setIndex(info, elementTypes.size(), blockSize);
715  elementTypes.push_back(li->Type);
716  blockSize += li->Size;
717  endAlign = getLowBit(blockSize);
718 
719  // ...until we get to the alignment of the maximum field.
720  if (endAlign >= maxFieldAlign) {
721  break;
722  }
723  }
724  // Don't re-append everything we just appended.
725  layout.erase(first, li);
726  }
727  }
728 
729  assert(endAlign == getLowBit(blockSize));
730 
731  // At this point, we just have to add padding if the end align still
732  // isn't aligned right.
733  if (endAlign < maxFieldAlign) {
734  CharUnits newBlockSize = blockSize.alignTo(maxFieldAlign);
735  CharUnits padding = newBlockSize - blockSize;
736 
737  // If we haven't yet added any fields, remember that there was an
738  // initial gap; this need to go into the block layout bit map.
739  if (blockSize == info.BlockHeaderForcedGapOffset) {
740  info.BlockHeaderForcedGapSize = padding;
741  }
742 
743  elementTypes.push_back(llvm::ArrayType::get(CGM.Int8Ty,
744  padding.getQuantity()));
745  blockSize = newBlockSize;
746  endAlign = getLowBit(blockSize); // might be > maxFieldAlign
747  }
748 
749  assert(endAlign >= maxFieldAlign);
750  assert(endAlign == getLowBit(blockSize));
751  // Slam everything else on now. This works because they have
752  // strictly decreasing alignment and we expect that size is always a
753  // multiple of alignment.
754  for (SmallVectorImpl<BlockLayoutChunk>::iterator
755  li = layout.begin(), le = layout.end(); li != le; ++li) {
756  if (endAlign < li->Alignment) {
757  // size may not be multiple of alignment. This can only happen with
758  // an over-aligned variable. We will be adding a padding field to
759  // make the size be multiple of alignment.
760  CharUnits padding = li->Alignment - endAlign;
761  elementTypes.push_back(llvm::ArrayType::get(CGM.Int8Ty,
762  padding.getQuantity()));
763  blockSize += padding;
764  endAlign = getLowBit(blockSize);
765  }
766  assert(endAlign >= li->Alignment);
767  li->setIndex(info, elementTypes.size(), blockSize);
768  elementTypes.push_back(li->Type);
769  blockSize += li->Size;
770  endAlign = getLowBit(blockSize);
771  }
772 
773  info.StructureType =
774  llvm::StructType::get(CGM.getLLVMContext(), elementTypes, true);
775 }
776 
777 /// Enter the scope of a block. This should be run at the entrance to
778 /// a full-expression so that the block's cleanups are pushed at the
779 /// right place in the stack.
780 static void enterBlockScope(CodeGenFunction &CGF, BlockDecl *block) {
781  assert(CGF.HaveInsertPoint());
782 
783  // Allocate the block info and place it at the head of the list.
784  CGBlockInfo &blockInfo =
785  *new CGBlockInfo(block, CGF.CurFn->getName());
786  blockInfo.NextBlockInfo = CGF.FirstBlockInfo;
787  CGF.FirstBlockInfo = &blockInfo;
788 
789  // Compute information about the layout, etc., of this block,
790  // pushing cleanups as necessary.
791  computeBlockInfo(CGF.CGM, &CGF, blockInfo);
792 
793  // Nothing else to do if it can be global.
794  if (blockInfo.CanBeGlobal) return;
795 
796  // Make the allocation for the block.
797  blockInfo.LocalAddress = CGF.CreateTempAlloca(blockInfo.StructureType,
798  blockInfo.BlockAlign, "block");
799 
800  // If there are cleanups to emit, enter them (but inactive).
801  if (!blockInfo.NeedsCopyDispose) return;
802 
803  // Walk through the captures (in order) and find the ones not
804  // captured by constant.
805  for (const auto &CI : block->captures()) {
806  // Ignore __block captures; there's nothing special in the
807  // on-stack block that we need to do for them.
808  if (CI.isByRef()) continue;
809 
810  // Ignore variables that are constant-captured.
811  const VarDecl *variable = CI.getVariable();
812  CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
813  if (capture.isConstant()) continue;
814 
815  // Ignore objects that aren't destructed.
816  QualType VT = getCaptureFieldType(CGF, CI);
818  if (dtorKind == QualType::DK_none) continue;
819 
820  CodeGenFunction::Destroyer *destroyer;
821 
822  // Block captures count as local values and have imprecise semantics.
823  // They also can't be arrays, so need to worry about that.
824  //
825  // For const-qualified captures, emit clang.arc.use to ensure the captured
826  // object doesn't get released while we are still depending on its validity
827  // within the block.
828  if (VT.isConstQualified() &&
830  CGF.CGM.getCodeGenOpts().OptimizationLevel != 0) {
831  assert(CGF.CGM.getLangOpts().ObjCAutoRefCount &&
832  "expected ObjC ARC to be enabled");
834  } else if (dtorKind == QualType::DK_objc_strong_lifetime) {
836  } else {
837  destroyer = CGF.getDestroyer(dtorKind);
838  }
839 
840  // GEP down to the address.
841  Address addr =
842  CGF.Builder.CreateStructGEP(blockInfo.LocalAddress, capture.getIndex());
843 
844  // We can use that GEP as the dominating IP.
845  if (!blockInfo.DominatingIP)
846  blockInfo.DominatingIP = cast<llvm::Instruction>(addr.getPointer());
847 
848  CleanupKind cleanupKind = InactiveNormalCleanup;
849  bool useArrayEHCleanup = CGF.needsEHCleanup(dtorKind);
850  if (useArrayEHCleanup)
851  cleanupKind = InactiveNormalAndEHCleanup;
852 
853  CGF.pushDestroy(cleanupKind, addr, VT,
854  destroyer, useArrayEHCleanup);
855 
856  // Remember where that cleanup was.
857  capture.setCleanup(CGF.EHStack.stable_begin());
858  }
859 }
860 
861 /// Enter a full-expression with a non-trivial number of objects to
862 /// clean up. This is in this file because, at the moment, the only
863 /// kind of cleanup object is a BlockDecl*.
865  if (const auto EWC = dyn_cast<ExprWithCleanups>(E)) {
866  assert(EWC->getNumObjects() != 0);
867  for (const ExprWithCleanups::CleanupObject &C : EWC->getObjects())
868  enterBlockScope(*this, C);
869  }
870 }
871 
872 /// Find the layout for the given block in a linked list and remove it.
874  const BlockDecl *block) {
875  while (true) {
876  assert(head && *head);
877  CGBlockInfo *cur = *head;
878 
879  // If this is the block we're looking for, splice it out of the list.
880  if (cur->getBlockDecl() == block) {
881  *head = cur->NextBlockInfo;
882  return cur;
883  }
884 
885  head = &cur->NextBlockInfo;
886  }
887 }
888 
889 /// Destroy a chain of block layouts.
891  assert(head && "destroying an empty chain");
892  do {
893  CGBlockInfo *cur = head;
894  head = cur->NextBlockInfo;
895  delete cur;
896  } while (head != nullptr);
897 }
898 
899 /// Emit a block literal expression in the current function.
901  // If the block has no captures, we won't have a pre-computed
902  // layout for it.
903  if (!blockExpr->getBlockDecl()->hasCaptures()) {
904  // The block literal is emitted as a global variable, and the block invoke
905  // function has to be extracted from its initializer.
906  if (llvm::Constant *Block = CGM.getAddrOfGlobalBlockIfEmitted(blockExpr)) {
907  return Block;
908  }
909  CGBlockInfo blockInfo(blockExpr->getBlockDecl(), CurFn->getName());
910  computeBlockInfo(CGM, this, blockInfo);
911  blockInfo.BlockExpression = blockExpr;
912  return EmitBlockLiteral(blockInfo);
913  }
914 
915  // Find the block info for this block and take ownership of it.
916  std::unique_ptr<CGBlockInfo> blockInfo;
917  blockInfo.reset(findAndRemoveBlockInfo(&FirstBlockInfo,
918  blockExpr->getBlockDecl()));
919 
920  blockInfo->BlockExpression = blockExpr;
921  return EmitBlockLiteral(*blockInfo);
922 }
923 
925  bool IsOpenCL = CGM.getContext().getLangOpts().OpenCL;
926  auto GenVoidPtrTy =
927  IsOpenCL ? CGM.getOpenCLRuntime().getGenericVoidPointerType() : VoidPtrTy;
928  LangAS GenVoidPtrAddr = IsOpenCL ? LangAS::opencl_generic : LangAS::Default;
929  auto GenVoidPtrSize = CharUnits::fromQuantity(
931  CGM.getContext().getTargetAddressSpace(GenVoidPtrAddr)) /
932  8);
933  // Using the computed layout, generate the actual block function.
934  bool isLambdaConv = blockInfo.getBlockDecl()->isConversionFromLambda();
935  CodeGenFunction BlockCGF{CGM, true};
936  BlockCGF.SanOpts = SanOpts;
937  auto *InvokeFn = BlockCGF.GenerateBlockFunction(
938  CurGD, blockInfo, LocalDeclMap, isLambdaConv, blockInfo.CanBeGlobal);
939  auto *blockFn = llvm::ConstantExpr::getPointerCast(InvokeFn, GenVoidPtrTy);
940 
941  // If there is nothing to capture, we can emit this as a global block.
942  if (blockInfo.CanBeGlobal)
943  return CGM.getAddrOfGlobalBlockIfEmitted(blockInfo.BlockExpression);
944 
945  // Otherwise, we have to emit this as a local block.
946 
947  Address blockAddr = blockInfo.LocalAddress;
948  assert(blockAddr.isValid() && "block has no address!");
949 
950  llvm::Constant *isa;
951  llvm::Constant *descriptor;
952  BlockFlags flags;
953  if (!IsOpenCL) {
954  // If the block is non-escaping, set field 'isa 'to NSConcreteGlobalBlock
955  // and set the BLOCK_IS_GLOBAL bit of field 'flags'. Copying a non-escaping
956  // block just returns the original block and releasing it is a no-op.
957  llvm::Constant *blockISA = blockInfo.getBlockDecl()->doesNotEscape()
959  : CGM.getNSConcreteStackBlock();
960  isa = llvm::ConstantExpr::getBitCast(blockISA, VoidPtrTy);
961 
962  // Build the block descriptor.
963  descriptor = buildBlockDescriptor(CGM, blockInfo);
964 
965  // Compute the initial on-stack block flags.
966  flags = BLOCK_HAS_SIGNATURE;
967  if (blockInfo.HasCapturedVariableLayout)
968  flags |= BLOCK_HAS_EXTENDED_LAYOUT;
969  if (blockInfo.needsCopyDisposeHelpers())
970  flags |= BLOCK_HAS_COPY_DISPOSE;
971  if (blockInfo.HasCXXObject)
972  flags |= BLOCK_HAS_CXX_OBJ;
973  if (blockInfo.UsesStret)
974  flags |= BLOCK_USE_STRET;
975  if (blockInfo.getBlockDecl()->doesNotEscape())
977  }
978 
979  auto projectField = [&](unsigned index, const Twine &name) -> Address {
980  return Builder.CreateStructGEP(blockAddr, index, name);
981  };
982  auto storeField = [&](llvm::Value *value, unsigned index, const Twine &name) {
983  Builder.CreateStore(value, projectField(index, name));
984  };
985 
986  // Initialize the block header.
987  {
988  // We assume all the header fields are densely packed.
989  unsigned index = 0;
990  CharUnits offset;
991  auto addHeaderField = [&](llvm::Value *value, CharUnits size,
992  const Twine &name) {
993  storeField(value, index, name);
994  offset += size;
995  index++;
996  };
997 
998  if (!IsOpenCL) {
999  addHeaderField(isa, getPointerSize(), "block.isa");
1000  addHeaderField(llvm::ConstantInt::get(IntTy, flags.getBitMask()),
1001  getIntSize(), "block.flags");
1002  addHeaderField(llvm::ConstantInt::get(IntTy, 0), getIntSize(),
1003  "block.reserved");
1004  } else {
1005  addHeaderField(
1006  llvm::ConstantInt::get(IntTy, blockInfo.BlockSize.getQuantity()),
1007  getIntSize(), "block.size");
1008  addHeaderField(
1009  llvm::ConstantInt::get(IntTy, blockInfo.BlockAlign.getQuantity()),
1010  getIntSize(), "block.align");
1011  }
1012  addHeaderField(blockFn, GenVoidPtrSize, "block.invoke");
1013  if (!IsOpenCL)
1014  addHeaderField(descriptor, getPointerSize(), "block.descriptor");
1015  else if (auto *Helper =
1017  for (auto I : Helper->getCustomFieldValues(*this, blockInfo)) {
1018  addHeaderField(
1019  I.first,
1021  CGM.getDataLayout().getTypeAllocSize(I.first->getType())),
1022  I.second);
1023  }
1024  }
1025  }
1026 
1027  // Finally, capture all the values into the block.
1028  const BlockDecl *blockDecl = blockInfo.getBlockDecl();
1029 
1030  // First, 'this'.
1031  if (blockDecl->capturesCXXThis()) {
1032  Address addr =
1033  projectField(blockInfo.CXXThisIndex, "block.captured-this.addr");
1034  Builder.CreateStore(LoadCXXThis(), addr);
1035  }
1036 
1037  // Next, captured variables.
1038  for (const auto &CI : blockDecl->captures()) {
1039  const VarDecl *variable = CI.getVariable();
1040  const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
1041 
1042  // Ignore constant captures.
1043  if (capture.isConstant()) continue;
1044 
1045  QualType type = capture.fieldType();
1046 
1047  // This will be a [[type]]*, except that a byref entry will just be
1048  // an i8**.
1049  Address blockField = projectField(capture.getIndex(), "block.captured");
1050 
1051  // Compute the address of the thing we're going to move into the
1052  // block literal.
1053  Address src = Address::invalid();
1054 
1055  if (blockDecl->isConversionFromLambda()) {
1056  // The lambda capture in a lambda's conversion-to-block-pointer is
1057  // special; we'll simply emit it directly.
1058  src = Address::invalid();
1059  } else if (CI.isEscapingByref()) {
1060  if (BlockInfo && CI.isNested()) {
1061  // We need to use the capture from the enclosing block.
1062  const CGBlockInfo::Capture &enclosingCapture =
1063  BlockInfo->getCapture(variable);
1064 
1065  // This is a [[type]]*, except that a byref entry will just be an i8**.
1066  src = Builder.CreateStructGEP(LoadBlockStruct(),
1067  enclosingCapture.getIndex(),
1068  "block.capture.addr");
1069  } else {
1070  auto I = LocalDeclMap.find(variable);
1071  assert(I != LocalDeclMap.end());
1072  src = I->second;
1073  }
1074  } else {
1075  DeclRefExpr declRef(getContext(), const_cast<VarDecl *>(variable),
1076  /*RefersToEnclosingVariableOrCapture*/ CI.isNested(),
1078  SourceLocation());
1079  src = EmitDeclRefLValue(&declRef).getAddress();
1080  };
1081 
1082  // For byrefs, we just write the pointer to the byref struct into
1083  // the block field. There's no need to chase the forwarding
1084  // pointer at this point, since we're building something that will
1085  // live a shorter life than the stack byref anyway.
1086  if (CI.isEscapingByref()) {
1087  // Get a void* that points to the byref struct.
1088  llvm::Value *byrefPointer;
1089  if (CI.isNested())
1090  byrefPointer = Builder.CreateLoad(src, "byref.capture");
1091  else
1092  byrefPointer = Builder.CreateBitCast(src.getPointer(), VoidPtrTy);
1093 
1094  // Write that void* into the capture field.
1095  Builder.CreateStore(byrefPointer, blockField);
1096 
1097  // If we have a copy constructor, evaluate that into the block field.
1098  } else if (const Expr *copyExpr = CI.getCopyExpr()) {
1099  if (blockDecl->isConversionFromLambda()) {
1100  // If we have a lambda conversion, emit the expression
1101  // directly into the block instead.
1102  AggValueSlot Slot =
1103  AggValueSlot::forAddr(blockField, Qualifiers(),
1108  EmitAggExpr(copyExpr, Slot);
1109  } else {
1110  EmitSynthesizedCXXCopyCtor(blockField, src, copyExpr);
1111  }
1112 
1113  // If it's a reference variable, copy the reference into the block field.
1114  } else if (type->isReferenceType()) {
1115  Builder.CreateStore(src.getPointer(), blockField);
1116 
1117  // If type is const-qualified, copy the value into the block field.
1118  } else if (type.isConstQualified() &&
1120  CGM.getCodeGenOpts().OptimizationLevel != 0) {
1121  llvm::Value *value = Builder.CreateLoad(src, "captured");
1122  Builder.CreateStore(value, blockField);
1123 
1124  // If this is an ARC __strong block-pointer variable, don't do a
1125  // block copy.
1126  //
1127  // TODO: this can be generalized into the normal initialization logic:
1128  // we should never need to do a block-copy when initializing a local
1129  // variable, because the local variable's lifetime should be strictly
1130  // contained within the stack block's.
1131  } else if (type.getObjCLifetime() == Qualifiers::OCL_Strong &&
1132  type->isBlockPointerType()) {
1133  // Load the block and do a simple retain.
1134  llvm::Value *value = Builder.CreateLoad(src, "block.captured_block");
1135  value = EmitARCRetainNonBlock(value);
1136 
1137  // Do a primitive store to the block field.
1138  Builder.CreateStore(value, blockField);
1139 
1140  // Otherwise, fake up a POD copy into the block field.
1141  } else {
1142  // Fake up a new variable so that EmitScalarInit doesn't think
1143  // we're referring to the variable in its own initializer.
1144  ImplicitParamDecl BlockFieldPseudoVar(getContext(), type,
1146 
1147  // We use one of these or the other depending on whether the
1148  // reference is nested.
1149  DeclRefExpr declRef(getContext(), const_cast<VarDecl *>(variable),
1150  /*RefersToEnclosingVariableOrCapture*/ CI.isNested(),
1152 
1153  ImplicitCastExpr l2r(ImplicitCastExpr::OnStack, type, CK_LValueToRValue,
1154  &declRef, VK_RValue);
1155  // FIXME: Pass a specific location for the expr init so that the store is
1156  // attributed to a reasonable location - otherwise it may be attributed to
1157  // locations of subexpressions in the initialization.
1158  EmitExprAsInit(&l2r, &BlockFieldPseudoVar,
1159  MakeAddrLValue(blockField, type, AlignmentSource::Decl),
1160  /*captured by init*/ false);
1161  }
1162 
1163  // Activate the cleanup if layout pushed one.
1164  if (!CI.isByRef()) {
1166  if (cleanup.isValid())
1167  ActivateCleanupBlock(cleanup, blockInfo.DominatingIP);
1168  }
1169  }
1170 
1171  // Cast to the converted block-pointer type, which happens (somewhat
1172  // unfortunately) to be a pointer to function type.
1173  llvm::Value *result = Builder.CreatePointerCast(
1174  blockAddr.getPointer(), ConvertType(blockInfo.getBlockExpr()->getType()));
1175 
1176  if (IsOpenCL) {
1177  CGM.getOpenCLRuntime().recordBlockInfo(blockInfo.BlockExpression, InvokeFn,
1178  result);
1179  }
1180 
1181  return result;
1182 }
1183 
1184 
1186  if (BlockDescriptorType)
1187  return BlockDescriptorType;
1188 
1189  llvm::Type *UnsignedLongTy =
1190  getTypes().ConvertType(getContext().UnsignedLongTy);
1191 
1192  // struct __block_descriptor {
1193  // unsigned long reserved;
1194  // unsigned long block_size;
1195  //
1196  // // later, the following will be added
1197  //
1198  // struct {
1199  // void (*copyHelper)();
1200  // void (*copyHelper)();
1201  // } helpers; // !!! optional
1202  //
1203  // const char *signature; // the block signature
1204  // const char *layout; // reserved
1205  // };
1206  BlockDescriptorType = llvm::StructType::create(
1207  "struct.__block_descriptor", UnsignedLongTy, UnsignedLongTy);
1208 
1209  // Now form a pointer to that.
1210  unsigned AddrSpace = 0;
1211  if (getLangOpts().OpenCL)
1212  AddrSpace = getContext().getTargetAddressSpace(LangAS::opencl_constant);
1213  BlockDescriptorType = llvm::PointerType::get(BlockDescriptorType, AddrSpace);
1214  return BlockDescriptorType;
1215 }
1216 
1218  if (GenericBlockLiteralType)
1219  return GenericBlockLiteralType;
1220 
1221  llvm::Type *BlockDescPtrTy = getBlockDescriptorType();
1222 
1223  if (getLangOpts().OpenCL) {
1224  // struct __opencl_block_literal_generic {
1225  // int __size;
1226  // int __align;
1227  // __generic void *__invoke;
1228  // /* custom fields */
1229  // };
1230  SmallVector<llvm::Type *, 8> StructFields(
1231  {IntTy, IntTy, getOpenCLRuntime().getGenericVoidPointerType()});
1232  if (auto *Helper = getTargetCodeGenInfo().getTargetOpenCLBlockHelper()) {
1233  for (auto I : Helper->getCustomFieldTypes())
1234  StructFields.push_back(I);
1235  }
1236  GenericBlockLiteralType = llvm::StructType::create(
1237  StructFields, "struct.__opencl_block_literal_generic");
1238  } else {
1239  // struct __block_literal_generic {
1240  // void *__isa;
1241  // int __flags;
1242  // int __reserved;
1243  // void (*__invoke)(void *);
1244  // struct __block_descriptor *__descriptor;
1245  // };
1246  GenericBlockLiteralType =
1247  llvm::StructType::create("struct.__block_literal_generic", VoidPtrTy,
1248  IntTy, IntTy, VoidPtrTy, BlockDescPtrTy);
1249  }
1250 
1251  return GenericBlockLiteralType;
1252 }
1253 
1256  const auto *BPT = E->getCallee()->getType()->castAs<BlockPointerType>();
1257  llvm::Value *BlockPtr = EmitScalarExpr(E->getCallee());
1258  llvm::Type *GenBlockTy = CGM.getGenericBlockLiteralType();
1259  llvm::Value *Func = nullptr;
1260  QualType FnType = BPT->getPointeeType();
1261  ASTContext &Ctx = getContext();
1262  CallArgList Args;
1263 
1264  if (getLangOpts().OpenCL) {
1265  // For OpenCL, BlockPtr is already casted to generic block literal.
1266 
1267  // First argument of a block call is a generic block literal casted to
1268  // generic void pointer, i.e. i8 addrspace(4)*
1269  llvm::Value *BlockDescriptor = Builder.CreatePointerCast(
1270  BlockPtr, CGM.getOpenCLRuntime().getGenericVoidPointerType());
1271  QualType VoidPtrQualTy = Ctx.getPointerType(
1273  Args.add(RValue::get(BlockDescriptor), VoidPtrQualTy);
1274  // And the rest of the arguments.
1275  EmitCallArgs(Args, FnType->getAs<FunctionProtoType>(), E->arguments());
1276 
1277  // We *can* call the block directly unless it is a function argument.
1278  if (!isa<ParmVarDecl>(E->getCalleeDecl()))
1279  Func = CGM.getOpenCLRuntime().getInvokeFunction(E->getCallee());
1280  else {
1281  llvm::Value *FuncPtr = Builder.CreateStructGEP(GenBlockTy, BlockPtr, 2);
1282  Func = Builder.CreateAlignedLoad(FuncPtr, getPointerAlign());
1283  }
1284  } else {
1285  // Bitcast the block literal to a generic block literal.
1286  BlockPtr = Builder.CreatePointerCast(
1287  BlockPtr, llvm::PointerType::get(GenBlockTy, 0), "block.literal");
1288  // Get pointer to the block invoke function
1289  llvm::Value *FuncPtr = Builder.CreateStructGEP(GenBlockTy, BlockPtr, 3);
1290 
1291  // First argument is a block literal casted to a void pointer
1292  BlockPtr = Builder.CreatePointerCast(BlockPtr, VoidPtrTy);
1293  Args.add(RValue::get(BlockPtr), Ctx.VoidPtrTy);
1294  // And the rest of the arguments.
1295  EmitCallArgs(Args, FnType->getAs<FunctionProtoType>(), E->arguments());
1296 
1297  // Load the function.
1298  Func = Builder.CreateAlignedLoad(FuncPtr, getPointerAlign());
1299  }
1300 
1301  const FunctionType *FuncTy = FnType->castAs<FunctionType>();
1302  const CGFunctionInfo &FnInfo =
1303  CGM.getTypes().arrangeBlockFunctionCall(Args, FuncTy);
1304 
1305  // Cast the function pointer to the right type.
1306  llvm::Type *BlockFTy = CGM.getTypes().GetFunctionType(FnInfo);
1307 
1308  llvm::Type *BlockFTyPtr = llvm::PointerType::getUnqual(BlockFTy);
1309  Func = Builder.CreatePointerCast(Func, BlockFTyPtr);
1310 
1311  // Prepare the callee.
1312  CGCallee Callee(CGCalleeInfo(), Func);
1313 
1314  // And call the block.
1315  return EmitCall(FnInfo, Callee, ReturnValue, Args);
1316 }
1317 
1319  assert(BlockInfo && "evaluating block ref without block information?");
1320  const CGBlockInfo::Capture &capture = BlockInfo->getCapture(variable);
1321 
1322  // Handle constant captures.
1323  if (capture.isConstant()) return LocalDeclMap.find(variable)->second;
1324 
1325  Address addr = Builder.CreateStructGEP(LoadBlockStruct(), capture.getIndex(),
1326  "block.capture.addr");
1327 
1328  if (variable->isEscapingByref()) {
1329  // addr should be a void** right now. Load, then cast the result
1330  // to byref*.
1331 
1332  auto &byrefInfo = getBlockByrefInfo(variable);
1333  addr = Address(Builder.CreateLoad(addr), byrefInfo.ByrefAlignment);
1334 
1335  auto byrefPointerType = llvm::PointerType::get(byrefInfo.Type, 0);
1336  addr = Builder.CreateBitCast(addr, byrefPointerType, "byref.addr");
1337 
1338  addr = emitBlockByrefAddress(addr, byrefInfo, /*follow*/ true,
1339  variable->getName());
1340  }
1341 
1342  assert((!variable->isNonEscapingByref() ||
1343  capture.fieldType()->isReferenceType()) &&
1344  "the capture field of a non-escaping variable should have a "
1345  "reference type");
1346  if (capture.fieldType()->isReferenceType())
1347  addr = EmitLoadOfReference(MakeAddrLValue(addr, capture.fieldType()));
1348 
1349  return addr;
1350 }
1351 
1353  llvm::Constant *Addr) {
1354  bool Ok = EmittedGlobalBlocks.insert(std::make_pair(BE, Addr)).second;
1355  (void)Ok;
1356  assert(Ok && "Trying to replace an already-existing global block!");
1357 }
1358 
1359 llvm::Constant *
1361  StringRef Name) {
1362  if (llvm::Constant *Block = getAddrOfGlobalBlockIfEmitted(BE))
1363  return Block;
1364 
1365  CGBlockInfo blockInfo(BE->getBlockDecl(), Name);
1366  blockInfo.BlockExpression = BE;
1367 
1368  // Compute information about the layout, etc., of this block.
1369  computeBlockInfo(*this, nullptr, blockInfo);
1370 
1371  // Using that metadata, generate the actual block function.
1372  {
1373  CodeGenFunction::DeclMapTy LocalDeclMap;
1375  GlobalDecl(), blockInfo, LocalDeclMap,
1376  /*IsLambdaConversionToBlock*/ false, /*BuildGlobalBlock*/ true);
1377  }
1378 
1379  return getAddrOfGlobalBlockIfEmitted(BE);
1380 }
1381 
1382 static llvm::Constant *buildGlobalBlock(CodeGenModule &CGM,
1383  const CGBlockInfo &blockInfo,
1384  llvm::Constant *blockFn) {
1385  assert(blockInfo.CanBeGlobal);
1386  // Callers should detect this case on their own: calling this function
1387  // generally requires computing layout information, which is a waste of time
1388  // if we've already emitted this block.
1389  assert(!CGM.getAddrOfGlobalBlockIfEmitted(blockInfo.BlockExpression) &&
1390  "Refusing to re-emit a global block.");
1391 
1392  // Generate the constants for the block literal initializer.
1393  ConstantInitBuilder builder(CGM);
1394  auto fields = builder.beginStruct();
1395 
1396  bool IsOpenCL = CGM.getLangOpts().OpenCL;
1397  bool IsWindows = CGM.getTarget().getTriple().isOSWindows();
1398  if (!IsOpenCL) {
1399  // isa
1400  if (IsWindows)
1401  fields.addNullPointer(CGM.Int8PtrPtrTy);
1402  else
1403  fields.add(CGM.getNSConcreteGlobalBlock());
1404 
1405  // __flags
1407  if (blockInfo.UsesStret)
1408  flags |= BLOCK_USE_STRET;
1409 
1410  fields.addInt(CGM.IntTy, flags.getBitMask());
1411 
1412  // Reserved
1413  fields.addInt(CGM.IntTy, 0);
1414  } else {
1415  fields.addInt(CGM.IntTy, blockInfo.BlockSize.getQuantity());
1416  fields.addInt(CGM.IntTy, blockInfo.BlockAlign.getQuantity());
1417  }
1418 
1419  // Function
1420  fields.add(blockFn);
1421 
1422  if (!IsOpenCL) {
1423  // Descriptor
1424  fields.add(buildBlockDescriptor(CGM, blockInfo));
1425  } else if (auto *Helper =
1427  for (auto I : Helper->getCustomFieldValues(CGM, blockInfo)) {
1428  fields.add(I);
1429  }
1430  }
1431 
1432  unsigned AddrSpace = 0;
1433  if (CGM.getContext().getLangOpts().OpenCL)
1435 
1436  llvm::GlobalVariable *literal = fields.finishAndCreateGlobal(
1437  "__block_literal_global", blockInfo.BlockAlign,
1438  /*constant*/ !IsWindows, llvm::GlobalVariable::InternalLinkage, AddrSpace);
1439 
1440  literal->addAttribute("objc_arc_inert");
1441 
1442  // Windows does not allow globals to be initialised to point to globals in
1443  // different DLLs. Any such variables must run code to initialise them.
1444  if (IsWindows) {
1445  auto *Init = llvm::Function::Create(llvm::FunctionType::get(CGM.VoidTy,
1446  {}), llvm::GlobalValue::InternalLinkage, ".block_isa_init",
1447  &CGM.getModule());
1448  llvm::IRBuilder<> b(llvm::BasicBlock::Create(CGM.getLLVMContext(), "entry",
1449  Init));
1450  b.CreateAlignedStore(CGM.getNSConcreteGlobalBlock(),
1451  b.CreateStructGEP(literal, 0), CGM.getPointerAlign().getQuantity());
1452  b.CreateRetVoid();
1453  // We can't use the normal LLVM global initialisation array, because we
1454  // need to specify that this runs early in library initialisation.
1455  auto *InitVar = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
1456  /*isConstant*/true, llvm::GlobalValue::InternalLinkage,
1457  Init, ".block_isa_init_ptr");
1458  InitVar->setSection(".CRT$XCLa");
1459  CGM.addUsedGlobal(InitVar);
1460  }
1461 
1462  // Return a constant of the appropriately-casted type.
1463  llvm::Type *RequiredType =
1464  CGM.getTypes().ConvertType(blockInfo.getBlockExpr()->getType());
1465  llvm::Constant *Result =
1466  llvm::ConstantExpr::getPointerCast(literal, RequiredType);
1467  CGM.setAddrOfGlobalBlock(blockInfo.BlockExpression, Result);
1468  if (CGM.getContext().getLangOpts().OpenCL)
1470  blockInfo.BlockExpression,
1471  cast<llvm::Function>(blockFn->stripPointerCasts()), Result);
1472  return Result;
1473 }
1474 
1476  unsigned argNum,
1477  llvm::Value *arg) {
1478  assert(BlockInfo && "not emitting prologue of block invocation function?!");
1479 
1480  // Allocate a stack slot like for any local variable to guarantee optimal
1481  // debug info at -O0. The mem2reg pass will eliminate it when optimizing.
1482  Address alloc = CreateMemTemp(D->getType(), D->getName() + ".addr");
1483  Builder.CreateStore(arg, alloc);
1484  if (CGDebugInfo *DI = getDebugInfo()) {
1485  if (CGM.getCodeGenOpts().getDebugInfo() >=
1487  DI->setLocation(D->getLocation());
1488  DI->EmitDeclareOfBlockLiteralArgVariable(
1489  *BlockInfo, D->getName(), argNum,
1490  cast<llvm::AllocaInst>(alloc.getPointer()), Builder);
1491  }
1492  }
1493 
1494  SourceLocation StartLoc = BlockInfo->getBlockExpr()->getBody()->getBeginLoc();
1495  ApplyDebugLocation Scope(*this, StartLoc);
1496 
1497  // Instead of messing around with LocalDeclMap, just set the value
1498  // directly as BlockPointer.
1499  BlockPointer = Builder.CreatePointerCast(
1500  arg,
1501  BlockInfo->StructureType->getPointerTo(
1502  getContext().getLangOpts().OpenCL
1503  ? getContext().getTargetAddressSpace(LangAS::opencl_generic)
1504  : 0),
1505  "block");
1506 }
1507 
1509  assert(BlockInfo && "not in a block invocation function!");
1510  assert(BlockPointer && "no block pointer set!");
1511  return Address(BlockPointer, BlockInfo->BlockAlign);
1512 }
1513 
1514 llvm::Function *
1516  const CGBlockInfo &blockInfo,
1517  const DeclMapTy &ldm,
1518  bool IsLambdaConversionToBlock,
1519  bool BuildGlobalBlock) {
1520  const BlockDecl *blockDecl = blockInfo.getBlockDecl();
1521 
1522  CurGD = GD;
1523 
1524  CurEHLocation = blockInfo.getBlockExpr()->getEndLoc();
1525 
1526  BlockInfo = &blockInfo;
1527 
1528  // Arrange for local static and local extern declarations to appear
1529  // to be local to this function as well, in case they're directly
1530  // referenced in a block.
1531  for (DeclMapTy::const_iterator i = ldm.begin(), e = ldm.end(); i != e; ++i) {
1532  const auto *var = dyn_cast<VarDecl>(i->first);
1533  if (var && !var->hasLocalStorage())
1534  setAddrOfLocalVar(var, i->second);
1535  }
1536 
1537  // Begin building the function declaration.
1538 
1539  // Build the argument list.
1540  FunctionArgList args;
1541 
1542  // The first argument is the block pointer. Just take it as a void*
1543  // and cast it later.
1544  QualType selfTy = getContext().VoidPtrTy;
1545 
1546  // For OpenCL passed block pointer can be private AS local variable or
1547  // global AS program scope variable (for the case with and without captures).
1548  // Generic AS is used therefore to be able to accommodate both private and
1549  // generic AS in one implementation.
1550  if (getLangOpts().OpenCL)
1551  selfTy = getContext().getPointerType(getContext().getAddrSpaceQualType(
1552  getContext().VoidTy, LangAS::opencl_generic));
1553 
1554  IdentifierInfo *II = &CGM.getContext().Idents.get(".block_descriptor");
1555 
1556  ImplicitParamDecl SelfDecl(getContext(), const_cast<BlockDecl *>(blockDecl),
1557  SourceLocation(), II, selfTy,
1559  args.push_back(&SelfDecl);
1560 
1561  // Now add the rest of the parameters.
1562  args.append(blockDecl->param_begin(), blockDecl->param_end());
1563 
1564  // Create the function declaration.
1565  const FunctionProtoType *fnType = blockInfo.getBlockExpr()->getFunctionType();
1566  const CGFunctionInfo &fnInfo =
1567  CGM.getTypes().arrangeBlockFunctionDeclaration(fnType, args);
1568  if (CGM.ReturnSlotInterferesWithArgs(fnInfo))
1569  blockInfo.UsesStret = true;
1570 
1571  llvm::FunctionType *fnLLVMType = CGM.getTypes().GetFunctionType(fnInfo);
1572 
1573  StringRef name = CGM.getBlockMangledName(GD, blockDecl);
1574  llvm::Function *fn = llvm::Function::Create(
1575  fnLLVMType, llvm::GlobalValue::InternalLinkage, name, &CGM.getModule());
1576  CGM.SetInternalFunctionAttributes(blockDecl, fn, fnInfo);
1577 
1578  if (BuildGlobalBlock) {
1579  auto GenVoidPtrTy = getContext().getLangOpts().OpenCL
1581  : VoidPtrTy;
1582  buildGlobalBlock(CGM, blockInfo,
1583  llvm::ConstantExpr::getPointerCast(fn, GenVoidPtrTy));
1584  }
1585 
1586  // Begin generating the function.
1587  StartFunction(blockDecl, fnType->getReturnType(), fn, fnInfo, args,
1588  blockDecl->getLocation(),
1589  blockInfo.getBlockExpr()->getBody()->getBeginLoc());
1590 
1591  // Okay. Undo some of what StartFunction did.
1592 
1593  // At -O0 we generate an explicit alloca for the BlockPointer, so the RA
1594  // won't delete the dbg.declare intrinsics for captured variables.
1595  llvm::Value *BlockPointerDbgLoc = BlockPointer;
1596  if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1597  // Allocate a stack slot for it, so we can point the debugger to it
1598  Address Alloca = CreateTempAlloca(BlockPointer->getType(),
1599  getPointerAlign(),
1600  "block.addr");
1601  // Set the DebugLocation to empty, so the store is recognized as a
1602  // frame setup instruction by llvm::DwarfDebug::beginFunction().
1603  auto NL = ApplyDebugLocation::CreateEmpty(*this);
1604  Builder.CreateStore(BlockPointer, Alloca);
1605  BlockPointerDbgLoc = Alloca.getPointer();
1606  }
1607 
1608  // If we have a C++ 'this' reference, go ahead and force it into
1609  // existence now.
1610  if (blockDecl->capturesCXXThis()) {
1611  Address addr = Builder.CreateStructGEP(
1612  LoadBlockStruct(), blockInfo.CXXThisIndex, "block.captured-this");
1613  CXXThisValue = Builder.CreateLoad(addr, "this");
1614  }
1615 
1616  // Also force all the constant captures.
1617  for (const auto &CI : blockDecl->captures()) {
1618  const VarDecl *variable = CI.getVariable();
1619  const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
1620  if (!capture.isConstant()) continue;
1621 
1622  CharUnits align = getContext().getDeclAlign(variable);
1623  Address alloca =
1624  CreateMemTemp(variable->getType(), align, "block.captured-const");
1625 
1626  Builder.CreateStore(capture.getConstant(), alloca);
1627 
1628  setAddrOfLocalVar(variable, alloca);
1629  }
1630 
1631  // Save a spot to insert the debug information for all the DeclRefExprs.
1632  llvm::BasicBlock *entry = Builder.GetInsertBlock();
1633  llvm::BasicBlock::iterator entry_ptr = Builder.GetInsertPoint();
1634  --entry_ptr;
1635 
1636  if (IsLambdaConversionToBlock)
1637  EmitLambdaBlockInvokeBody();
1638  else {
1639  PGO.assignRegionCounters(GlobalDecl(blockDecl), fn);
1640  incrementProfileCounter(blockDecl->getBody());
1641  EmitStmt(blockDecl->getBody());
1642  }
1643 
1644  // Remember where we were...
1645  llvm::BasicBlock *resume = Builder.GetInsertBlock();
1646 
1647  // Go back to the entry.
1648  ++entry_ptr;
1649  Builder.SetInsertPoint(entry, entry_ptr);
1650 
1651  // Emit debug information for all the DeclRefExprs.
1652  // FIXME: also for 'this'
1653  if (CGDebugInfo *DI = getDebugInfo()) {
1654  for (const auto &CI : blockDecl->captures()) {
1655  const VarDecl *variable = CI.getVariable();
1656  DI->EmitLocation(Builder, variable->getLocation());
1657 
1658  if (CGM.getCodeGenOpts().getDebugInfo() >=
1660  const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
1661  if (capture.isConstant()) {
1662  auto addr = LocalDeclMap.find(variable)->second;
1663  (void)DI->EmitDeclareOfAutoVariable(variable, addr.getPointer(),
1664  Builder);
1665  continue;
1666  }
1667 
1668  DI->EmitDeclareOfBlockDeclRefVariable(
1669  variable, BlockPointerDbgLoc, Builder, blockInfo,
1670  entry_ptr == entry->end() ? nullptr : &*entry_ptr);
1671  }
1672  }
1673  // Recover location if it was changed in the above loop.
1674  DI->EmitLocation(Builder,
1675  cast<CompoundStmt>(blockDecl->getBody())->getRBracLoc());
1676  }
1677 
1678  // And resume where we left off.
1679  if (resume == nullptr)
1680  Builder.ClearInsertionPoint();
1681  else
1682  Builder.SetInsertPoint(resume);
1683 
1684  FinishFunction(cast<CompoundStmt>(blockDecl->getBody())->getRBracLoc());
1685 
1686  return fn;
1687 }
1688 
1689 static std::pair<BlockCaptureEntityKind, BlockFieldFlags>
1691  const LangOptions &LangOpts) {
1692  if (CI.getCopyExpr()) {
1693  assert(!CI.isByRef());
1694  // don't bother computing flags
1695  return std::make_pair(BlockCaptureEntityKind::CXXRecord, BlockFieldFlags());
1696  }
1697  BlockFieldFlags Flags;
1698  if (CI.isEscapingByref()) {
1699  Flags = BLOCK_FIELD_IS_BYREF;
1700  if (T.isObjCGCWeak())
1701  Flags |= BLOCK_FIELD_IS_WEAK;
1702  return std::make_pair(BlockCaptureEntityKind::BlockObject, Flags);
1703  }
1704 
1705  Flags = BLOCK_FIELD_IS_OBJECT;
1706  bool isBlockPointer = T->isBlockPointerType();
1707  if (isBlockPointer)
1708  Flags = BLOCK_FIELD_IS_BLOCK;
1709 
1710  switch (T.isNonTrivialToPrimitiveCopy()) {
1711  case QualType::PCK_Struct:
1712  return std::make_pair(BlockCaptureEntityKind::NonTrivialCStruct,
1713  BlockFieldFlags());
1714  case QualType::PCK_ARCWeak:
1715  // We need to register __weak direct captures with the runtime.
1716  return std::make_pair(BlockCaptureEntityKind::ARCWeak, Flags);
1718  // We need to retain the copied value for __strong direct captures.
1719  // If it's a block pointer, we have to copy the block and assign that to
1720  // the destination pointer, so we might as well use _Block_object_assign.
1721  // Otherwise we can avoid that.
1722  return std::make_pair(!isBlockPointer ? BlockCaptureEntityKind::ARCStrong
1723  : BlockCaptureEntityKind::BlockObject,
1724  Flags);
1725  case QualType::PCK_Trivial:
1727  if (!T->isObjCRetainableType())
1728  // For all other types, the memcpy is fine.
1729  return std::make_pair(BlockCaptureEntityKind::None, BlockFieldFlags());
1730 
1731  // Special rules for ARC captures:
1732  Qualifiers QS = T.getQualifiers();
1733 
1734  // Non-ARC captures of retainable pointers are strong and
1735  // therefore require a call to _Block_object_assign.
1736  if (!QS.getObjCLifetime() && !LangOpts.ObjCAutoRefCount)
1737  return std::make_pair(BlockCaptureEntityKind::BlockObject, Flags);
1738 
1739  // Otherwise the memcpy is fine.
1740  return std::make_pair(BlockCaptureEntityKind::None, BlockFieldFlags());
1741  }
1742  }
1743  llvm_unreachable("after exhaustive PrimitiveCopyKind switch");
1744 }
1745 
1746 static std::pair<BlockCaptureEntityKind, BlockFieldFlags>
1748  const LangOptions &LangOpts);
1749 
1750 /// Find the set of block captures that need to be explicitly copied or destroy.
1752  const CGBlockInfo &BlockInfo, const LangOptions &LangOpts,
1753  SmallVectorImpl<BlockCaptureManagedEntity> &ManagedCaptures) {
1754  for (const auto &CI : BlockInfo.getBlockDecl()->captures()) {
1755  const VarDecl *Variable = CI.getVariable();
1756  const CGBlockInfo::Capture &Capture = BlockInfo.getCapture(Variable);
1757  if (Capture.isConstant())
1758  continue;
1759 
1760  QualType VT = Capture.fieldType();
1761  auto CopyInfo = computeCopyInfoForBlockCapture(CI, VT, LangOpts);
1762  auto DisposeInfo = computeDestroyInfoForBlockCapture(CI, VT, LangOpts);
1763  if (CopyInfo.first != BlockCaptureEntityKind::None ||
1764  DisposeInfo.first != BlockCaptureEntityKind::None)
1765  ManagedCaptures.emplace_back(CopyInfo.first, DisposeInfo.first,
1766  CopyInfo.second, DisposeInfo.second, CI,
1767  Capture);
1768  }
1769 
1770  // Sort the captures by offset.
1771  llvm::sort(ManagedCaptures);
1772 }
1773 
1774 namespace {
1775 /// Release a __block variable.
1776 struct CallBlockRelease final : EHScopeStack::Cleanup {
1777  Address Addr;
1778  BlockFieldFlags FieldFlags;
1779  bool LoadBlockVarAddr, CanThrow;
1780 
1781  CallBlockRelease(Address Addr, BlockFieldFlags Flags, bool LoadValue,
1782  bool CT)
1783  : Addr(Addr), FieldFlags(Flags), LoadBlockVarAddr(LoadValue),
1784  CanThrow(CT) {}
1785 
1786  void Emit(CodeGenFunction &CGF, Flags flags) override {
1787  llvm::Value *BlockVarAddr;
1788  if (LoadBlockVarAddr) {
1789  BlockVarAddr = CGF.Builder.CreateLoad(Addr);
1790  BlockVarAddr = CGF.Builder.CreateBitCast(BlockVarAddr, CGF.VoidPtrTy);
1791  } else {
1792  BlockVarAddr = Addr.getPointer();
1793  }
1794 
1795  CGF.BuildBlockRelease(BlockVarAddr, FieldFlags, CanThrow);
1796  }
1797 };
1798 } // end anonymous namespace
1799 
1800 /// Check if \p T is a C++ class that has a destructor that can throw.
1802  if (const auto *RD = T->getAsCXXRecordDecl())
1803  if (const CXXDestructorDecl *DD = RD->getDestructor())
1804  return DD->getType()->castAs<FunctionProtoType>()->canThrow();
1805  return false;
1806 }
1807 
1808 // Return a string that has the information about a capture.
1809 static std::string getBlockCaptureStr(const BlockCaptureManagedEntity &E,
1810  CaptureStrKind StrKind,
1811  CharUnits BlockAlignment,
1812  CodeGenModule &CGM) {
1813  std::string Str;
1814  ASTContext &Ctx = CGM.getContext();
1815  const BlockDecl::Capture &CI = *E.CI;
1816  QualType CaptureTy = CI.getVariable()->getType();
1817 
1819  BlockFieldFlags Flags;
1820 
1821  // CaptureStrKind::Merged should be passed only when the operations and the
1822  // flags are the same for copy and dispose.
1823  assert((StrKind != CaptureStrKind::Merged ||
1824  (E.CopyKind == E.DisposeKind && E.CopyFlags == E.DisposeFlags)) &&
1825  "different operations and flags");
1826 
1827  if (StrKind == CaptureStrKind::DisposeHelper) {
1828  Kind = E.DisposeKind;
1829  Flags = E.DisposeFlags;
1830  } else {
1831  Kind = E.CopyKind;
1832  Flags = E.CopyFlags;
1833  }
1834 
1835  switch (Kind) {
1836  case BlockCaptureEntityKind::CXXRecord: {
1837  Str += "c";
1838  SmallString<256> TyStr;
1839  llvm::raw_svector_ostream Out(TyStr);
1840  CGM.getCXXABI().getMangleContext().mangleTypeName(CaptureTy, Out);
1841  Str += llvm::to_string(TyStr.size()) + TyStr.c_str();
1842  break;
1843  }
1844  case BlockCaptureEntityKind::ARCWeak:
1845  Str += "w";
1846  break;
1847  case BlockCaptureEntityKind::ARCStrong:
1848  Str += "s";
1849  break;
1850  case BlockCaptureEntityKind::BlockObject: {
1851  const VarDecl *Var = CI.getVariable();
1852  unsigned F = Flags.getBitMask();
1853  if (F & BLOCK_FIELD_IS_BYREF) {
1854  Str += "r";
1855  if (F & BLOCK_FIELD_IS_WEAK)
1856  Str += "w";
1857  else {
1858  // If CaptureStrKind::Merged is passed, check both the copy expression
1859  // and the destructor.
1860  if (StrKind != CaptureStrKind::DisposeHelper) {
1861  if (Ctx.getBlockVarCopyInit(Var).canThrow())
1862  Str += "c";
1863  }
1864  if (StrKind != CaptureStrKind::CopyHelper) {
1866  Str += "d";
1867  }
1868  }
1869  } else {
1870  assert((F & BLOCK_FIELD_IS_OBJECT) && "unexpected flag value");
1871  if (F == BLOCK_FIELD_IS_BLOCK)
1872  Str += "b";
1873  else
1874  Str += "o";
1875  }
1876  break;
1877  }
1878  case BlockCaptureEntityKind::NonTrivialCStruct: {
1879  bool IsVolatile = CaptureTy.isVolatileQualified();
1880  CharUnits Alignment =
1881  BlockAlignment.alignmentAtOffset(E.Capture->getOffset());
1882 
1883  Str += "n";
1884  std::string FuncStr;
1885  if (StrKind == CaptureStrKind::DisposeHelper)
1887  CaptureTy, Alignment, IsVolatile, Ctx);
1888  else
1889  // If CaptureStrKind::Merged is passed, use the copy constructor string.
1890  // It has all the information that the destructor string has.
1892  CaptureTy, Alignment, IsVolatile, Ctx);
1893  // The underscore is necessary here because non-trivial copy constructor
1894  // and destructor strings can start with a number.
1895  Str += llvm::to_string(FuncStr.size()) + "_" + FuncStr;
1896  break;
1897  }
1899  break;
1900  }
1901 
1902  return Str;
1903 }
1904 
1905 static std::string getCopyDestroyHelperFuncName(
1906  const SmallVectorImpl<BlockCaptureManagedEntity> &Captures,
1907  CharUnits BlockAlignment, CaptureStrKind StrKind, CodeGenModule &CGM) {
1908  assert((StrKind == CaptureStrKind::CopyHelper ||
1909  StrKind == CaptureStrKind::DisposeHelper) &&
1910  "unexpected CaptureStrKind");
1911  std::string Name = StrKind == CaptureStrKind::CopyHelper
1912  ? "__copy_helper_block_"
1913  : "__destroy_helper_block_";
1914  if (CGM.getLangOpts().Exceptions)
1915  Name += "e";
1916  if (CGM.getCodeGenOpts().ObjCAutoRefCountExceptions)
1917  Name += "a";
1918  Name += llvm::to_string(BlockAlignment.getQuantity()) + "_";
1919 
1920  for (const BlockCaptureManagedEntity &E : Captures) {
1921  Name += llvm::to_string(E.Capture->getOffset().getQuantity());
1922  Name += getBlockCaptureStr(E, StrKind, BlockAlignment, CGM);
1923  }
1924 
1925  return Name;
1926 }
1927 
1929  Address Field, QualType CaptureType,
1930  BlockFieldFlags Flags, bool ForCopyHelper,
1931  VarDecl *Var, CodeGenFunction &CGF) {
1932  bool EHOnly = ForCopyHelper;
1933 
1934  switch (CaptureKind) {
1935  case BlockCaptureEntityKind::CXXRecord:
1936  case BlockCaptureEntityKind::ARCWeak:
1937  case BlockCaptureEntityKind::NonTrivialCStruct:
1938  case BlockCaptureEntityKind::ARCStrong: {
1939  if (CaptureType.isDestructedType() &&
1940  (!EHOnly || CGF.needsEHCleanup(CaptureType.isDestructedType()))) {
1941  CodeGenFunction::Destroyer *Destroyer =
1942  CaptureKind == BlockCaptureEntityKind::ARCStrong
1944  : CGF.getDestroyer(CaptureType.isDestructedType());
1945  CleanupKind Kind =
1946  EHOnly ? EHCleanup
1947  : CGF.getCleanupKind(CaptureType.isDestructedType());
1948  CGF.pushDestroy(Kind, Field, CaptureType, Destroyer, Kind & EHCleanup);
1949  }
1950  break;
1951  }
1952  case BlockCaptureEntityKind::BlockObject: {
1953  if (!EHOnly || CGF.getLangOpts().Exceptions) {
1955  // Calls to _Block_object_dispose along the EH path in the copy helper
1956  // function don't throw as newly-copied __block variables always have a
1957  // reference count of 2.
1958  bool CanThrow =
1959  !ForCopyHelper && CGF.cxxDestructorCanThrow(CaptureType);
1960  CGF.enterByrefCleanup(Kind, Field, Flags, /*LoadBlockVarAddr*/ true,
1961  CanThrow);
1962  }
1963  break;
1964  }
1966  break;
1967  }
1968 }
1969 
1971  llvm::Function *Fn,
1972  const CGFunctionInfo &FI,
1973  CodeGenModule &CGM) {
1974  if (CapturesNonExternalType) {
1976  } else {
1977  Fn->setVisibility(llvm::GlobalValue::HiddenVisibility);
1978  Fn->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1979  CGM.SetLLVMFunctionAttributes(GlobalDecl(), FI, Fn);
1980  CGM.SetLLVMFunctionAttributesForDefinition(nullptr, Fn);
1981  }
1982 }
1983 /// Generate the copy-helper function for a block closure object:
1984 /// static void block_copy_helper(block_t *dst, block_t *src);
1985 /// The runtime will have previously initialized 'dst' by doing a
1986 /// bit-copy of 'src'.
1987 ///
1988 /// Note that this copies an entire block closure object to the heap;
1989 /// it should not be confused with a 'byref copy helper', which moves
1990 /// the contents of an individual __block variable to the heap.
1991 llvm::Constant *
1994  findBlockCapturedManagedEntities(blockInfo, getLangOpts(), CopiedCaptures);
1995  std::string FuncName =
1996  getCopyDestroyHelperFuncName(CopiedCaptures, blockInfo.BlockAlign,
1997  CaptureStrKind::CopyHelper, CGM);
1998 
1999  if (llvm::GlobalValue *Func = CGM.getModule().getNamedValue(FuncName))
2000  return llvm::ConstantExpr::getBitCast(Func, VoidPtrTy);
2001 
2002  ASTContext &C = getContext();
2003 
2004  QualType ReturnTy = C.VoidTy;
2005 
2006  FunctionArgList args;
2008  args.push_back(&DstDecl);
2010  args.push_back(&SrcDecl);
2011 
2012  const CGFunctionInfo &FI =
2013  CGM.getTypes().arrangeBuiltinFunctionDeclaration(ReturnTy, args);
2014 
2015  // FIXME: it would be nice if these were mergeable with things with
2016  // identical semantics.
2017  llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
2018 
2019  llvm::Function *Fn =
2020  llvm::Function::Create(LTy, llvm::GlobalValue::LinkOnceODRLinkage,
2021  FuncName, &CGM.getModule());
2022  if (CGM.supportsCOMDAT())
2023  Fn->setComdat(CGM.getModule().getOrInsertComdat(FuncName));
2024 
2025  IdentifierInfo *II = &C.Idents.get(FuncName);
2026 
2027  SmallVector<QualType, 2> ArgTys;
2028  ArgTys.push_back(C.VoidPtrTy);
2029  ArgTys.push_back(C.VoidPtrTy);
2030  QualType FunctionTy = C.getFunctionType(ReturnTy, ArgTys, {});
2031 
2034  FunctionTy, nullptr, SC_Static, false, false);
2035 
2037  CGM);
2038  StartFunction(FD, ReturnTy, Fn, FI, args);
2039  ApplyDebugLocation NL{*this, blockInfo.getBlockExpr()->getBeginLoc()};
2040  llvm::Type *structPtrTy = blockInfo.StructureType->getPointerTo();
2041 
2042  Address src = GetAddrOfLocalVar(&SrcDecl);
2043  src = Address(Builder.CreateLoad(src), blockInfo.BlockAlign);
2044  src = Builder.CreateBitCast(src, structPtrTy, "block.source");
2045 
2046  Address dst = GetAddrOfLocalVar(&DstDecl);
2047  dst = Address(Builder.CreateLoad(dst), blockInfo.BlockAlign);
2048  dst = Builder.CreateBitCast(dst, structPtrTy, "block.dest");
2049 
2050  for (const auto &CopiedCapture : CopiedCaptures) {
2051  const BlockDecl::Capture &CI = *CopiedCapture.CI;
2052  const CGBlockInfo::Capture &capture = *CopiedCapture.Capture;
2053  QualType captureType = CI.getVariable()->getType();
2054  BlockFieldFlags flags = CopiedCapture.CopyFlags;
2055 
2056  unsigned index = capture.getIndex();
2057  Address srcField = Builder.CreateStructGEP(src, index);
2058  Address dstField = Builder.CreateStructGEP(dst, index);
2059 
2060  switch (CopiedCapture.CopyKind) {
2061  case BlockCaptureEntityKind::CXXRecord:
2062  // If there's an explicit copy expression, we do that.
2063  assert(CI.getCopyExpr() && "copy expression for variable is missing");
2064  EmitSynthesizedCXXCopyCtor(dstField, srcField, CI.getCopyExpr());
2065  break;
2066  case BlockCaptureEntityKind::ARCWeak:
2067  EmitARCCopyWeak(dstField, srcField);
2068  break;
2069  case BlockCaptureEntityKind::NonTrivialCStruct: {
2070  // If this is a C struct that requires non-trivial copy construction,
2071  // emit a call to its copy constructor.
2072  QualType varType = CI.getVariable()->getType();
2073  callCStructCopyConstructor(MakeAddrLValue(dstField, varType),
2074  MakeAddrLValue(srcField, varType));
2075  break;
2076  }
2077  case BlockCaptureEntityKind::ARCStrong: {
2078  llvm::Value *srcValue = Builder.CreateLoad(srcField, "blockcopy.src");
2079  // At -O0, store null into the destination field (so that the
2080  // storeStrong doesn't over-release) and then call storeStrong.
2081  // This is a workaround to not having an initStrong call.
2082  if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
2083  auto *ty = cast<llvm::PointerType>(srcValue->getType());
2084  llvm::Value *null = llvm::ConstantPointerNull::get(ty);
2085  Builder.CreateStore(null, dstField);
2086  EmitARCStoreStrongCall(dstField, srcValue, true);
2087 
2088  // With optimization enabled, take advantage of the fact that
2089  // the blocks runtime guarantees a memcpy of the block data, and
2090  // just emit a retain of the src field.
2091  } else {
2092  EmitARCRetainNonBlock(srcValue);
2093 
2094  // Unless EH cleanup is required, we don't need this anymore, so kill
2095  // it. It's not quite worth the annoyance to avoid creating it in the
2096  // first place.
2097  if (!needsEHCleanup(captureType.isDestructedType()))
2098  cast<llvm::Instruction>(dstField.getPointer())->eraseFromParent();
2099  }
2100  break;
2101  }
2102  case BlockCaptureEntityKind::BlockObject: {
2103  llvm::Value *srcValue = Builder.CreateLoad(srcField, "blockcopy.src");
2104  srcValue = Builder.CreateBitCast(srcValue, VoidPtrTy);
2105  llvm::Value *dstAddr =
2106  Builder.CreateBitCast(dstField.getPointer(), VoidPtrTy);
2107  llvm::Value *args[] = {
2108  dstAddr, srcValue, llvm::ConstantInt::get(Int32Ty, flags.getBitMask())
2109  };
2110 
2111  if (CI.isByRef() && C.getBlockVarCopyInit(CI.getVariable()).canThrow())
2112  EmitRuntimeCallOrInvoke(CGM.getBlockObjectAssign(), args);
2113  else
2114  EmitNounwindRuntimeCall(CGM.getBlockObjectAssign(), args);
2115  break;
2116  }
2118  continue;
2119  }
2120 
2121  // Ensure that we destroy the copied object if an exception is thrown later
2122  // in the helper function.
2123  pushCaptureCleanup(CopiedCapture.CopyKind, dstField, captureType, flags,
2124  /*ForCopyHelper*/ true, CI.getVariable(), *this);
2125  }
2126 
2127  FinishFunction();
2128 
2129  return llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
2130 }
2131 
2132 static BlockFieldFlags
2134  QualType T) {
2136  if (T->isBlockPointerType())
2137  Flags = BLOCK_FIELD_IS_BLOCK;
2138  return Flags;
2139 }
2140 
2141 static std::pair<BlockCaptureEntityKind, BlockFieldFlags>
2143  const LangOptions &LangOpts) {
2144  if (CI.isEscapingByref()) {
2146  if (T.isObjCGCWeak())
2147  Flags |= BLOCK_FIELD_IS_WEAK;
2148  return std::make_pair(BlockCaptureEntityKind::BlockObject, Flags);
2149  }
2150 
2151  switch (T.isDestructedType()) {
2153  return std::make_pair(BlockCaptureEntityKind::CXXRecord, BlockFieldFlags());
2155  // Use objc_storeStrong for __strong direct captures; the
2156  // dynamic tools really like it when we do this.
2157  return std::make_pair(BlockCaptureEntityKind::ARCStrong,
2160  // Support __weak direct captures.
2161  return std::make_pair(BlockCaptureEntityKind::ARCWeak,
2164  return std::make_pair(BlockCaptureEntityKind::NonTrivialCStruct,
2165  BlockFieldFlags());
2166  case QualType::DK_none: {
2167  // Non-ARC captures are strong, and we need to use _Block_object_dispose.
2168  if (T->isObjCRetainableType() && !T.getQualifiers().hasObjCLifetime() &&
2169  !LangOpts.ObjCAutoRefCount)
2170  return std::make_pair(BlockCaptureEntityKind::BlockObject,
2172  // Otherwise, we have nothing to do.
2173  return std::make_pair(BlockCaptureEntityKind::None, BlockFieldFlags());
2174  }
2175  }
2176  llvm_unreachable("after exhaustive DestructionKind switch");
2177 }
2178 
2179 /// Generate the destroy-helper function for a block closure object:
2180 /// static void block_destroy_helper(block_t *theBlock);
2181 ///
2182 /// Note that this destroys a heap-allocated block closure object;
2183 /// it should not be confused with a 'byref destroy helper', which
2184 /// destroys the heap-allocated contents of an individual __block
2185 /// variable.
2186 llvm::Constant *
2189  findBlockCapturedManagedEntities(blockInfo, getLangOpts(), DestroyedCaptures);
2190  std::string FuncName =
2191  getCopyDestroyHelperFuncName(DestroyedCaptures, blockInfo.BlockAlign,
2192  CaptureStrKind::DisposeHelper, CGM);
2193 
2194  if (llvm::GlobalValue *Func = CGM.getModule().getNamedValue(FuncName))
2195  return llvm::ConstantExpr::getBitCast(Func, VoidPtrTy);
2196 
2197  ASTContext &C = getContext();
2198 
2199  QualType ReturnTy = C.VoidTy;
2200 
2201  FunctionArgList args;
2203  args.push_back(&SrcDecl);
2204 
2205  const CGFunctionInfo &FI =
2206  CGM.getTypes().arrangeBuiltinFunctionDeclaration(ReturnTy, args);
2207 
2208  // FIXME: We'd like to put these into a mergable by content, with
2209  // internal linkage.
2210  llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
2211 
2212  llvm::Function *Fn =
2213  llvm::Function::Create(LTy, llvm::GlobalValue::LinkOnceODRLinkage,
2214  FuncName, &CGM.getModule());
2215  if (CGM.supportsCOMDAT())
2216  Fn->setComdat(CGM.getModule().getOrInsertComdat(FuncName));
2217 
2218  IdentifierInfo *II = &C.Idents.get(FuncName);
2219 
2220  SmallVector<QualType, 1> ArgTys;
2221  ArgTys.push_back(C.VoidPtrTy);
2222  QualType FunctionTy = C.getFunctionType(ReturnTy, ArgTys, {});
2223 
2226  FunctionTy, nullptr, SC_Static, false, false);
2227 
2229  CGM);
2230  StartFunction(FD, ReturnTy, Fn, FI, args);
2231  markAsIgnoreThreadCheckingAtRuntime(Fn);
2232 
2233  ApplyDebugLocation NL{*this, blockInfo.getBlockExpr()->getBeginLoc()};
2234 
2235  llvm::Type *structPtrTy = blockInfo.StructureType->getPointerTo();
2236 
2237  Address src = GetAddrOfLocalVar(&SrcDecl);
2238  src = Address(Builder.CreateLoad(src), blockInfo.BlockAlign);
2239  src = Builder.CreateBitCast(src, structPtrTy, "block");
2240 
2241  CodeGenFunction::RunCleanupsScope cleanups(*this);
2242 
2243  for (const auto &DestroyedCapture : DestroyedCaptures) {
2244  const BlockDecl::Capture &CI = *DestroyedCapture.CI;
2245  const CGBlockInfo::Capture &capture = *DestroyedCapture.Capture;
2246  BlockFieldFlags flags = DestroyedCapture.DisposeFlags;
2247 
2248  Address srcField = Builder.CreateStructGEP(src, capture.getIndex());
2249 
2250  pushCaptureCleanup(DestroyedCapture.DisposeKind, srcField,
2251  CI.getVariable()->getType(), flags,
2252  /*ForCopyHelper*/ false, CI.getVariable(), *this);
2253  }
2254 
2255  cleanups.ForceCleanup();
2256 
2257  FinishFunction();
2258 
2259  return llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
2260 }
2261 
2262 namespace {
2263 
2264 /// Emits the copy/dispose helper functions for a __block object of id type.
2265 class ObjectByrefHelpers final : public BlockByrefHelpers {
2266  BlockFieldFlags Flags;
2267 
2268 public:
2269  ObjectByrefHelpers(CharUnits alignment, BlockFieldFlags flags)
2270  : BlockByrefHelpers(alignment), Flags(flags) {}
2271 
2272  void emitCopy(CodeGenFunction &CGF, Address destField,
2273  Address srcField) override {
2274  destField = CGF.Builder.CreateBitCast(destField, CGF.VoidPtrTy);
2275 
2276  srcField = CGF.Builder.CreateBitCast(srcField, CGF.VoidPtrPtrTy);
2277  llvm::Value *srcValue = CGF.Builder.CreateLoad(srcField);
2278 
2279  unsigned flags = (Flags | BLOCK_BYREF_CALLER).getBitMask();
2280 
2281  llvm::Value *flagsVal = llvm::ConstantInt::get(CGF.Int32Ty, flags);
2282  llvm::FunctionCallee fn = CGF.CGM.getBlockObjectAssign();
2283 
2284  llvm::Value *args[] = { destField.getPointer(), srcValue, flagsVal };
2285  CGF.EmitNounwindRuntimeCall(fn, args);
2286  }
2287 
2288  void emitDispose(CodeGenFunction &CGF, Address field) override {
2289  field = CGF.Builder.CreateBitCast(field, CGF.Int8PtrTy->getPointerTo(0));
2290  llvm::Value *value = CGF.Builder.CreateLoad(field);
2291 
2292  CGF.BuildBlockRelease(value, Flags | BLOCK_BYREF_CALLER, false);
2293  }
2294 
2295  void profileImpl(llvm::FoldingSetNodeID &id) const override {
2296  id.AddInteger(Flags.getBitMask());
2297  }
2298 };
2299 
2300 /// Emits the copy/dispose helpers for an ARC __block __weak variable.
2301 class ARCWeakByrefHelpers final : public BlockByrefHelpers {
2302 public:
2303  ARCWeakByrefHelpers(CharUnits alignment) : BlockByrefHelpers(alignment) {}
2304 
2305  void emitCopy(CodeGenFunction &CGF, Address destField,
2306  Address srcField) override {
2307  CGF.EmitARCMoveWeak(destField, srcField);
2308  }
2309 
2310  void emitDispose(CodeGenFunction &CGF, Address field) override {
2311  CGF.EmitARCDestroyWeak(field);
2312  }
2313 
2314  void profileImpl(llvm::FoldingSetNodeID &id) const override {
2315  // 0 is distinguishable from all pointers and byref flags
2316  id.AddInteger(0);
2317  }
2318 };
2319 
2320 /// Emits the copy/dispose helpers for an ARC __block __strong variable
2321 /// that's not of block-pointer type.
2322 class ARCStrongByrefHelpers final : public BlockByrefHelpers {
2323 public:
2324  ARCStrongByrefHelpers(CharUnits alignment) : BlockByrefHelpers(alignment) {}
2325 
2326  void emitCopy(CodeGenFunction &CGF, Address destField,
2327  Address srcField) override {
2328  // Do a "move" by copying the value and then zeroing out the old
2329  // variable.
2330 
2331  llvm::Value *value = CGF.Builder.CreateLoad(srcField);
2332 
2333  llvm::Value *null =
2334  llvm::ConstantPointerNull::get(cast<llvm::PointerType>(value->getType()));
2335 
2336  if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0) {
2337  CGF.Builder.CreateStore(null, destField);
2338  CGF.EmitARCStoreStrongCall(destField, value, /*ignored*/ true);
2339  CGF.EmitARCStoreStrongCall(srcField, null, /*ignored*/ true);
2340  return;
2341  }
2342  CGF.Builder.CreateStore(value, destField);
2343  CGF.Builder.CreateStore(null, srcField);
2344  }
2345 
2346  void emitDispose(CodeGenFunction &CGF, Address field) override {
2348  }
2349 
2350  void profileImpl(llvm::FoldingSetNodeID &id) const override {
2351  // 1 is distinguishable from all pointers and byref flags
2352  id.AddInteger(1);
2353  }
2354 };
2355 
2356 /// Emits the copy/dispose helpers for an ARC __block __strong
2357 /// variable that's of block-pointer type.
2358 class ARCStrongBlockByrefHelpers final : public BlockByrefHelpers {
2359 public:
2360  ARCStrongBlockByrefHelpers(CharUnits alignment)
2361  : BlockByrefHelpers(alignment) {}
2362 
2363  void emitCopy(CodeGenFunction &CGF, Address destField,
2364  Address srcField) override {
2365  // Do the copy with objc_retainBlock; that's all that
2366  // _Block_object_assign would do anyway, and we'd have to pass the
2367  // right arguments to make sure it doesn't get no-op'ed.
2368  llvm::Value *oldValue = CGF.Builder.CreateLoad(srcField);
2369  llvm::Value *copy = CGF.EmitARCRetainBlock(oldValue, /*mandatory*/ true);
2370  CGF.Builder.CreateStore(copy, destField);
2371  }
2372 
2373  void emitDispose(CodeGenFunction &CGF, Address field) override {
2375  }
2376 
2377  void profileImpl(llvm::FoldingSetNodeID &id) const override {
2378  // 2 is distinguishable from all pointers and byref flags
2379  id.AddInteger(2);
2380  }
2381 };
2382 
2383 /// Emits the copy/dispose helpers for a __block variable with a
2384 /// nontrivial copy constructor or destructor.
2385 class CXXByrefHelpers final : public BlockByrefHelpers {
2386  QualType VarType;
2387  const Expr *CopyExpr;
2388 
2389 public:
2390  CXXByrefHelpers(CharUnits alignment, QualType type,
2391  const Expr *copyExpr)
2392  : BlockByrefHelpers(alignment), VarType(type), CopyExpr(copyExpr) {}
2393 
2394  bool needsCopy() const override { return CopyExpr != nullptr; }
2395  void emitCopy(CodeGenFunction &CGF, Address destField,
2396  Address srcField) override {
2397  if (!CopyExpr) return;
2398  CGF.EmitSynthesizedCXXCopyCtor(destField, srcField, CopyExpr);
2399  }
2400 
2401  void emitDispose(CodeGenFunction &CGF, Address field) override {
2402  EHScopeStack::stable_iterator cleanupDepth = CGF.EHStack.stable_begin();
2403  CGF.PushDestructorCleanup(VarType, field);
2404  CGF.PopCleanupBlocks(cleanupDepth);
2405  }
2406 
2407  void profileImpl(llvm::FoldingSetNodeID &id) const override {
2408  id.AddPointer(VarType.getCanonicalType().getAsOpaquePtr());
2409  }
2410 };
2411 
2412 /// Emits the copy/dispose helpers for a __block variable that is a non-trivial
2413 /// C struct.
2414 class NonTrivialCStructByrefHelpers final : public BlockByrefHelpers {
2415  QualType VarType;
2416 
2417 public:
2418  NonTrivialCStructByrefHelpers(CharUnits alignment, QualType type)
2419  : BlockByrefHelpers(alignment), VarType(type) {}
2420 
2421  void emitCopy(CodeGenFunction &CGF, Address destField,
2422  Address srcField) override {
2423  CGF.callCStructMoveConstructor(CGF.MakeAddrLValue(destField, VarType),
2424  CGF.MakeAddrLValue(srcField, VarType));
2425  }
2426 
2427  bool needsDispose() const override {
2428  return VarType.isDestructedType();
2429  }
2430 
2431  void emitDispose(CodeGenFunction &CGF, Address field) override {
2432  EHScopeStack::stable_iterator cleanupDepth = CGF.EHStack.stable_begin();
2433  CGF.pushDestroy(VarType.isDestructedType(), field, VarType);
2434  CGF.PopCleanupBlocks(cleanupDepth);
2435  }
2436 
2437  void profileImpl(llvm::FoldingSetNodeID &id) const override {
2438  id.AddPointer(VarType.getCanonicalType().getAsOpaquePtr());
2439  }
2440 };
2441 } // end anonymous namespace
2442 
2443 static llvm::Constant *
2445  BlockByrefHelpers &generator) {
2446  ASTContext &Context = CGF.getContext();
2447 
2448  QualType ReturnTy = Context.VoidTy;
2449 
2450  FunctionArgList args;
2451  ImplicitParamDecl Dst(Context, Context.VoidPtrTy, ImplicitParamDecl::Other);
2452  args.push_back(&Dst);
2453 
2454  ImplicitParamDecl Src(Context, Context.VoidPtrTy, ImplicitParamDecl::Other);
2455  args.push_back(&Src);
2456 
2457  const CGFunctionInfo &FI =
2458  CGF.CGM.getTypes().arrangeBuiltinFunctionDeclaration(ReturnTy, args);
2459 
2460  llvm::FunctionType *LTy = CGF.CGM.getTypes().GetFunctionType(FI);
2461 
2462  // FIXME: We'd like to put these into a mergable by content, with
2463  // internal linkage.
2464  llvm::Function *Fn =
2466  "__Block_byref_object_copy_", &CGF.CGM.getModule());
2467 
2468  IdentifierInfo *II
2469  = &Context.Idents.get("__Block_byref_object_copy_");
2470 
2471  SmallVector<QualType, 2> ArgTys;
2472  ArgTys.push_back(Context.VoidPtrTy);
2473  ArgTys.push_back(Context.VoidPtrTy);
2474  QualType FunctionTy = Context.getFunctionType(ReturnTy, ArgTys, {});
2475 
2477  Context, Context.getTranslationUnitDecl(), SourceLocation(),
2478  SourceLocation(), II, FunctionTy, nullptr, SC_Static, false, false);
2479 
2481 
2482  CGF.StartFunction(FD, ReturnTy, Fn, FI, args);
2483 
2484  if (generator.needsCopy()) {
2485  llvm::Type *byrefPtrType = byrefInfo.Type->getPointerTo(0);
2486 
2487  // dst->x
2488  Address destField = CGF.GetAddrOfLocalVar(&Dst);
2489  destField = Address(CGF.Builder.CreateLoad(destField),
2490  byrefInfo.ByrefAlignment);
2491  destField = CGF.Builder.CreateBitCast(destField, byrefPtrType);
2492  destField = CGF.emitBlockByrefAddress(destField, byrefInfo, false,
2493  "dest-object");
2494 
2495  // src->x
2496  Address srcField = CGF.GetAddrOfLocalVar(&Src);
2497  srcField = Address(CGF.Builder.CreateLoad(srcField),
2498  byrefInfo.ByrefAlignment);
2499  srcField = CGF.Builder.CreateBitCast(srcField, byrefPtrType);
2500  srcField = CGF.emitBlockByrefAddress(srcField, byrefInfo, false,
2501  "src-object");
2502 
2503  generator.emitCopy(CGF, destField, srcField);
2504  }
2505 
2506  CGF.FinishFunction();
2507 
2508  return llvm::ConstantExpr::getBitCast(Fn, CGF.Int8PtrTy);
2509 }
2510 
2511 /// Build the copy helper for a __block variable.
2512 static llvm::Constant *buildByrefCopyHelper(CodeGenModule &CGM,
2513  const BlockByrefInfo &byrefInfo,
2514  BlockByrefHelpers &generator) {
2515  CodeGenFunction CGF(CGM);
2516  return generateByrefCopyHelper(CGF, byrefInfo, generator);
2517 }
2518 
2519 /// Generate code for a __block variable's dispose helper.
2520 static llvm::Constant *
2522  const BlockByrefInfo &byrefInfo,
2523  BlockByrefHelpers &generator) {
2524  ASTContext &Context = CGF.getContext();
2525  QualType R = Context.VoidTy;
2526 
2527  FunctionArgList args;
2528  ImplicitParamDecl Src(CGF.getContext(), Context.VoidPtrTy,
2530  args.push_back(&Src);
2531 
2532  const CGFunctionInfo &FI =
2534 
2535  llvm::FunctionType *LTy = CGF.CGM.getTypes().GetFunctionType(FI);
2536 
2537  // FIXME: We'd like to put these into a mergable by content, with
2538  // internal linkage.
2539  llvm::Function *Fn =
2541  "__Block_byref_object_dispose_",
2542  &CGF.CGM.getModule());
2543 
2544  IdentifierInfo *II
2545  = &Context.Idents.get("__Block_byref_object_dispose_");
2546 
2547  SmallVector<QualType, 1> ArgTys;
2548  ArgTys.push_back(Context.VoidPtrTy);
2549  QualType FunctionTy = Context.getFunctionType(R, ArgTys, {});
2550 
2552  Context, Context.getTranslationUnitDecl(), SourceLocation(),
2553  SourceLocation(), II, FunctionTy, nullptr, SC_Static, false, false);
2554 
2556 
2557  CGF.StartFunction(FD, R, Fn, FI, args);
2558 
2559  if (generator.needsDispose()) {
2560  Address addr = CGF.GetAddrOfLocalVar(&Src);
2561  addr = Address(CGF.Builder.CreateLoad(addr), byrefInfo.ByrefAlignment);
2562  auto byrefPtrType = byrefInfo.Type->getPointerTo(0);
2563  addr = CGF.Builder.CreateBitCast(addr, byrefPtrType);
2564  addr = CGF.emitBlockByrefAddress(addr, byrefInfo, false, "object");
2565 
2566  generator.emitDispose(CGF, addr);
2567  }
2568 
2569  CGF.FinishFunction();
2570 
2571  return llvm::ConstantExpr::getBitCast(Fn, CGF.Int8PtrTy);
2572 }
2573 
2574 /// Build the dispose helper for a __block variable.
2575 static llvm::Constant *buildByrefDisposeHelper(CodeGenModule &CGM,
2576  const BlockByrefInfo &byrefInfo,
2577  BlockByrefHelpers &generator) {
2578  CodeGenFunction CGF(CGM);
2579  return generateByrefDisposeHelper(CGF, byrefInfo, generator);
2580 }
2581 
2582 /// Lazily build the copy and dispose helpers for a __block variable
2583 /// with the given information.
2584 template <class T>
2585 static T *buildByrefHelpers(CodeGenModule &CGM, const BlockByrefInfo &byrefInfo,
2586  T &&generator) {
2587  llvm::FoldingSetNodeID id;
2588  generator.Profile(id);
2589 
2590  void *insertPos;
2592  = CGM.ByrefHelpersCache.FindNodeOrInsertPos(id, insertPos);
2593  if (node) return static_cast<T*>(node);
2594 
2595  generator.CopyHelper = buildByrefCopyHelper(CGM, byrefInfo, generator);
2596  generator.DisposeHelper = buildByrefDisposeHelper(CGM, byrefInfo, generator);
2597 
2598  T *copy = new (CGM.getContext()) T(std::forward<T>(generator));
2599  CGM.ByrefHelpersCache.InsertNode(copy, insertPos);
2600  return copy;
2601 }
2602 
2603 /// Build the copy and dispose helpers for the given __block variable
2604 /// emission. Places the helpers in the global cache. Returns null
2605 /// if no helpers are required.
2607 CodeGenFunction::buildByrefHelpers(llvm::StructType &byrefType,
2608  const AutoVarEmission &emission) {
2609  const VarDecl &var = *emission.Variable;
2610  assert(var.isEscapingByref() &&
2611  "only escaping __block variables need byref helpers");
2612 
2613  QualType type = var.getType();
2614 
2615  auto &byrefInfo = getBlockByrefInfo(&var);
2616 
2617  // The alignment we care about for the purposes of uniquing byref
2618  // helpers is the alignment of the actual byref value field.
2619  CharUnits valueAlignment =
2620  byrefInfo.ByrefAlignment.alignmentAtOffset(byrefInfo.FieldOffset);
2621 
2622  if (const CXXRecordDecl *record = type->getAsCXXRecordDecl()) {
2623  const Expr *copyExpr =
2625  if (!copyExpr && record->hasTrivialDestructor()) return nullptr;
2626 
2628  CGM, byrefInfo, CXXByrefHelpers(valueAlignment, type, copyExpr));
2629  }
2630 
2631  // If type is a non-trivial C struct type that is non-trivial to
2632  // destructly move or destroy, build the copy and dispose helpers.
2633  if (type.isNonTrivialToPrimitiveDestructiveMove() == QualType::PCK_Struct ||
2634  type.isDestructedType() == QualType::DK_nontrivial_c_struct)
2636  CGM, byrefInfo, NonTrivialCStructByrefHelpers(valueAlignment, type));
2637 
2638  // Otherwise, if we don't have a retainable type, there's nothing to do.
2639  // that the runtime does extra copies.
2640  if (!type->isObjCRetainableType()) return nullptr;
2641 
2642  Qualifiers qs = type.getQualifiers();
2643 
2644  // If we have lifetime, that dominates.
2645  if (Qualifiers::ObjCLifetime lifetime = qs.getObjCLifetime()) {
2646  switch (lifetime) {
2647  case Qualifiers::OCL_None: llvm_unreachable("impossible");
2648 
2649  // These are just bits as far as the runtime is concerned.
2652  return nullptr;
2653 
2654  // Tell the runtime that this is ARC __weak, called by the
2655  // byref routines.
2656  case Qualifiers::OCL_Weak:
2657  return ::buildByrefHelpers(CGM, byrefInfo,
2658  ARCWeakByrefHelpers(valueAlignment));
2659 
2660  // ARC __strong __block variables need to be retained.
2662  // Block pointers need to be copied, and there's no direct
2663  // transfer possible.
2664  if (type->isBlockPointerType()) {
2665  return ::buildByrefHelpers(CGM, byrefInfo,
2666  ARCStrongBlockByrefHelpers(valueAlignment));
2667 
2668  // Otherwise, we transfer ownership of the retain from the stack
2669  // to the heap.
2670  } else {
2671  return ::buildByrefHelpers(CGM, byrefInfo,
2672  ARCStrongByrefHelpers(valueAlignment));
2673  }
2674  }
2675  llvm_unreachable("fell out of lifetime switch!");
2676  }
2677 
2678  BlockFieldFlags flags;
2679  if (type->isBlockPointerType()) {
2680  flags |= BLOCK_FIELD_IS_BLOCK;
2681  } else if (CGM.getContext().isObjCNSObjectType(type) ||
2682  type->isObjCObjectPointerType()) {
2683  flags |= BLOCK_FIELD_IS_OBJECT;
2684  } else {
2685  return nullptr;
2686  }
2687 
2688  if (type.isObjCGCWeak())
2689  flags |= BLOCK_FIELD_IS_WEAK;
2690 
2691  return ::buildByrefHelpers(CGM, byrefInfo,
2692  ObjectByrefHelpers(valueAlignment, flags));
2693 }
2694 
2696  const VarDecl *var,
2697  bool followForward) {
2698  auto &info = getBlockByrefInfo(var);
2699  return emitBlockByrefAddress(baseAddr, info, followForward, var->getName());
2700 }
2701 
2703  const BlockByrefInfo &info,
2704  bool followForward,
2705  const llvm::Twine &name) {
2706  // Chase the forwarding address if requested.
2707  if (followForward) {
2708  Address forwardingAddr = Builder.CreateStructGEP(baseAddr, 1, "forwarding");
2709  baseAddr = Address(Builder.CreateLoad(forwardingAddr), info.ByrefAlignment);
2710  }
2711 
2712  return Builder.CreateStructGEP(baseAddr, info.FieldIndex, name);
2713 }
2714 
2715 /// BuildByrefInfo - This routine changes a __block variable declared as T x
2716 /// into:
2717 ///
2718 /// struct {
2719 /// void *__isa;
2720 /// void *__forwarding;
2721 /// int32_t __flags;
2722 /// int32_t __size;
2723 /// void *__copy_helper; // only if needed
2724 /// void *__destroy_helper; // only if needed
2725 /// void *__byref_variable_layout;// only if needed
2726 /// char padding[X]; // only if needed
2727 /// T x;
2728 /// } x
2729 ///
2731  auto it = BlockByrefInfos.find(D);
2732  if (it != BlockByrefInfos.end())
2733  return it->second;
2734 
2735  llvm::StructType *byrefType =
2736  llvm::StructType::create(getLLVMContext(),
2737  "struct.__block_byref_" + D->getNameAsString());
2738 
2739  QualType Ty = D->getType();
2740 
2741  CharUnits size;
2743 
2744  // void *__isa;
2745  types.push_back(Int8PtrTy);
2746  size += getPointerSize();
2747 
2748  // void *__forwarding;
2749  types.push_back(llvm::PointerType::getUnqual(byrefType));
2750  size += getPointerSize();
2751 
2752  // int32_t __flags;
2753  types.push_back(Int32Ty);
2754  size += CharUnits::fromQuantity(4);
2755 
2756  // int32_t __size;
2757  types.push_back(Int32Ty);
2758  size += CharUnits::fromQuantity(4);
2759 
2760  // Note that this must match *exactly* the logic in buildByrefHelpers.
2761  bool hasCopyAndDispose = getContext().BlockRequiresCopying(Ty, D);
2762  if (hasCopyAndDispose) {
2763  /// void *__copy_helper;
2764  types.push_back(Int8PtrTy);
2765  size += getPointerSize();
2766 
2767  /// void *__destroy_helper;
2768  types.push_back(Int8PtrTy);
2769  size += getPointerSize();
2770  }
2771 
2772  bool HasByrefExtendedLayout = false;
2773  Qualifiers::ObjCLifetime Lifetime;
2774  if (getContext().getByrefLifetime(Ty, Lifetime, HasByrefExtendedLayout) &&
2775  HasByrefExtendedLayout) {
2776  /// void *__byref_variable_layout;
2777  types.push_back(Int8PtrTy);
2778  size += CharUnits::fromQuantity(PointerSizeInBytes);
2779  }
2780 
2781  // T x;
2782  llvm::Type *varTy = ConvertTypeForMem(Ty);
2783 
2784  bool packed = false;
2785  CharUnits varAlign = getContext().getDeclAlign(D);
2786  CharUnits varOffset = size.alignTo(varAlign);
2787 
2788  // We may have to insert padding.
2789  if (varOffset != size) {
2790  llvm::Type *paddingTy =
2791  llvm::ArrayType::get(Int8Ty, (varOffset - size).getQuantity());
2792 
2793  types.push_back(paddingTy);
2794  size = varOffset;
2795 
2796  // Conversely, we might have to prevent LLVM from inserting padding.
2797  } else if (CGM.getDataLayout().getABITypeAlignment(varTy)
2798  > varAlign.getQuantity()) {
2799  packed = true;
2800  }
2801  types.push_back(varTy);
2802 
2803  byrefType->setBody(types, packed);
2804 
2805  BlockByrefInfo info;
2806  info.Type = byrefType;
2807  info.FieldIndex = types.size() - 1;
2808  info.FieldOffset = varOffset;
2809  info.ByrefAlignment = std::max(varAlign, getPointerAlign());
2810 
2811  auto pair = BlockByrefInfos.insert({D, info});
2812  assert(pair.second && "info was inserted recursively?");
2813  return pair.first->second;
2814 }
2815 
2816 /// Initialize the structural components of a __block variable, i.e.
2817 /// everything but the actual object.
2819  // Find the address of the local.
2820  Address addr = emission.Addr;
2821 
2822  // That's an alloca of the byref structure type.
2823  llvm::StructType *byrefType = cast<llvm::StructType>(
2824  cast<llvm::PointerType>(addr.getPointer()->getType())->getElementType());
2825 
2826  unsigned nextHeaderIndex = 0;
2827  CharUnits nextHeaderOffset;
2828  auto storeHeaderField = [&](llvm::Value *value, CharUnits fieldSize,
2829  const Twine &name) {
2830  auto fieldAddr = Builder.CreateStructGEP(addr, nextHeaderIndex, name);
2831  Builder.CreateStore(value, fieldAddr);
2832 
2833  nextHeaderIndex++;
2834  nextHeaderOffset += fieldSize;
2835  };
2836 
2837  // Build the byref helpers if necessary. This is null if we don't need any.
2838  BlockByrefHelpers *helpers = buildByrefHelpers(*byrefType, emission);
2839 
2840  const VarDecl &D = *emission.Variable;
2841  QualType type = D.getType();
2842 
2843  bool HasByrefExtendedLayout;
2844  Qualifiers::ObjCLifetime ByrefLifetime;
2845  bool ByRefHasLifetime =
2846  getContext().getByrefLifetime(type, ByrefLifetime, HasByrefExtendedLayout);
2847 
2848  llvm::Value *V;
2849 
2850  // Initialize the 'isa', which is just 0 or 1.
2851  int isa = 0;
2852  if (type.isObjCGCWeak())
2853  isa = 1;
2854  V = Builder.CreateIntToPtr(Builder.getInt32(isa), Int8PtrTy, "isa");
2855  storeHeaderField(V, getPointerSize(), "byref.isa");
2856 
2857  // Store the address of the variable into its own forwarding pointer.
2858  storeHeaderField(addr.getPointer(), getPointerSize(), "byref.forwarding");
2859 
2860  // Blocks ABI:
2861  // c) the flags field is set to either 0 if no helper functions are
2862  // needed or BLOCK_BYREF_HAS_COPY_DISPOSE if they are,
2863  BlockFlags flags;
2864  if (helpers) flags |= BLOCK_BYREF_HAS_COPY_DISPOSE;
2865  if (ByRefHasLifetime) {
2866  if (HasByrefExtendedLayout) flags |= BLOCK_BYREF_LAYOUT_EXTENDED;
2867  else switch (ByrefLifetime) {
2869  flags |= BLOCK_BYREF_LAYOUT_STRONG;
2870  break;
2871  case Qualifiers::OCL_Weak:
2872  flags |= BLOCK_BYREF_LAYOUT_WEAK;
2873  break;
2876  break;
2877  case Qualifiers::OCL_None:
2878  if (!type->isObjCObjectPointerType() && !type->isBlockPointerType())
2880  break;
2881  default:
2882  break;
2883  }
2884  if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2885  printf("\n Inline flag for BYREF variable layout (%d):", flags.getBitMask());
2886  if (flags & BLOCK_BYREF_HAS_COPY_DISPOSE)
2887  printf(" BLOCK_BYREF_HAS_COPY_DISPOSE");
2888  if (flags & BLOCK_BYREF_LAYOUT_MASK) {
2889  BlockFlags ThisFlag(flags.getBitMask() & BLOCK_BYREF_LAYOUT_MASK);
2890  if (ThisFlag == BLOCK_BYREF_LAYOUT_EXTENDED)
2891  printf(" BLOCK_BYREF_LAYOUT_EXTENDED");
2892  if (ThisFlag == BLOCK_BYREF_LAYOUT_STRONG)
2893  printf(" BLOCK_BYREF_LAYOUT_STRONG");
2894  if (ThisFlag == BLOCK_BYREF_LAYOUT_WEAK)
2895  printf(" BLOCK_BYREF_LAYOUT_WEAK");
2896  if (ThisFlag == BLOCK_BYREF_LAYOUT_UNRETAINED)
2897  printf(" BLOCK_BYREF_LAYOUT_UNRETAINED");
2898  if (ThisFlag == BLOCK_BYREF_LAYOUT_NON_OBJECT)
2899  printf(" BLOCK_BYREF_LAYOUT_NON_OBJECT");
2900  }
2901  printf("\n");
2902  }
2903  }
2904  storeHeaderField(llvm::ConstantInt::get(IntTy, flags.getBitMask()),
2905  getIntSize(), "byref.flags");
2906 
2907  CharUnits byrefSize = CGM.GetTargetTypeStoreSize(byrefType);
2908  V = llvm::ConstantInt::get(IntTy, byrefSize.getQuantity());
2909  storeHeaderField(V, getIntSize(), "byref.size");
2910 
2911  if (helpers) {
2912  storeHeaderField(helpers->CopyHelper, getPointerSize(),
2913  "byref.copyHelper");
2914  storeHeaderField(helpers->DisposeHelper, getPointerSize(),
2915  "byref.disposeHelper");
2916  }
2917 
2918  if (ByRefHasLifetime && HasByrefExtendedLayout) {
2919  auto layoutInfo = CGM.getObjCRuntime().BuildByrefLayout(CGM, type);
2920  storeHeaderField(layoutInfo, getPointerSize(), "byref.layout");
2921  }
2922 }
2923 
2925  bool CanThrow) {
2926  llvm::FunctionCallee F = CGM.getBlockObjectDispose();
2927  llvm::Value *args[] = {
2928  Builder.CreateBitCast(V, Int8PtrTy),
2929  llvm::ConstantInt::get(Int32Ty, flags.getBitMask())
2930  };
2931 
2932  if (CanThrow)
2933  EmitRuntimeCallOrInvoke(F, args);
2934  else
2935  EmitNounwindRuntimeCall(F, args);
2936 }
2937 
2939  BlockFieldFlags Flags,
2940  bool LoadBlockVarAddr, bool CanThrow) {
2941  EHStack.pushCleanup<CallBlockRelease>(Kind, Addr, Flags, LoadBlockVarAddr,
2942  CanThrow);
2943 }
2944 
2945 /// Adjust the declaration of something from the blocks API.
2947  llvm::Constant *C) {
2948  auto *GV = cast<llvm::GlobalValue>(C->stripPointerCasts());
2949 
2950  if (CGM.getTarget().getTriple().isOSBinFormatCOFF()) {
2951  IdentifierInfo &II = CGM.getContext().Idents.get(C->getName());
2954 
2955  assert((isa<llvm::Function>(C->stripPointerCasts()) ||
2956  isa<llvm::GlobalVariable>(C->stripPointerCasts())) &&
2957  "expected Function or GlobalVariable");
2958 
2959  const NamedDecl *ND = nullptr;
2960  for (const auto &Result : DC->lookup(&II))
2961  if ((ND = dyn_cast<FunctionDecl>(Result)) ||
2962  (ND = dyn_cast<VarDecl>(Result)))
2963  break;
2964 
2965  // TODO: support static blocks runtime
2966  if (GV->isDeclaration() && (!ND || !ND->hasAttr<DLLExportAttr>())) {
2967  GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2968  GV->setLinkage(llvm::GlobalValue::ExternalLinkage);
2969  } else {
2970  GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2971  GV->setLinkage(llvm::GlobalValue::ExternalLinkage);
2972  }
2973  }
2974 
2975  if (CGM.getLangOpts().BlocksRuntimeOptional && GV->isDeclaration() &&
2976  GV->hasExternalLinkage())
2977  GV->setLinkage(llvm::GlobalValue::ExternalWeakLinkage);
2978 
2979  CGM.setDSOLocal(GV);
2980 }
2981 
2983  if (BlockObjectDispose)
2984  return BlockObjectDispose;
2985 
2986  llvm::Type *args[] = { Int8PtrTy, Int32Ty };
2987  llvm::FunctionType *fty
2988  = llvm::FunctionType::get(VoidTy, args, false);
2989  BlockObjectDispose = CreateRuntimeFunction(fty, "_Block_object_dispose");
2991  *this, cast<llvm::Constant>(BlockObjectDispose.getCallee()));
2992  return BlockObjectDispose;
2993 }
2994 
2995 llvm::FunctionCallee CodeGenModule::getBlockObjectAssign() {
2996  if (BlockObjectAssign)
2997  return BlockObjectAssign;
2998 
2999  llvm::Type *args[] = { Int8PtrTy, Int8PtrTy, Int32Ty };
3000  llvm::FunctionType *fty
3001  = llvm::FunctionType::get(VoidTy, args, false);
3002  BlockObjectAssign = CreateRuntimeFunction(fty, "_Block_object_assign");
3004  *this, cast<llvm::Constant>(BlockObjectAssign.getCallee()));
3005  return BlockObjectAssign;
3006 }
3007 
3009  if (NSConcreteGlobalBlock)
3010  return NSConcreteGlobalBlock;
3011 
3012  NSConcreteGlobalBlock = GetOrCreateLLVMGlobal("_NSConcreteGlobalBlock",
3013  Int8PtrTy->getPointerTo(),
3014  nullptr);
3015  configureBlocksRuntimeObject(*this, NSConcreteGlobalBlock);
3016  return NSConcreteGlobalBlock;
3017 }
3018 
3020  if (NSConcreteStackBlock)
3021  return NSConcreteStackBlock;
3022 
3023  NSConcreteStackBlock = GetOrCreateLLVMGlobal("_NSConcreteStackBlock",
3024  Int8PtrTy->getPointerTo(),
3025  nullptr);
3026  configureBlocksRuntimeObject(*this, NSConcreteStackBlock);
3027  return NSConcreteStackBlock;
3028 }
const CGFunctionInfo & arrangeBuiltinFunctionDeclaration(QualType resultType, const FunctionArgList &args)
A builtin function is a freestanding function using the default C conventions.
Definition: CGCall.cpp:652
const llvm::DataLayout & getDataLayout() const
CGOpenCLRuntime & getOpenCLRuntime()
Return a reference to the configured OpenCL runtime.
ReturnValueSlot - Contains the address where the return value of a function can be stored...
Definition: CGCall.h:363
const internal::VariadicAllOfMatcher< Type > type
Matches Types in the clang AST.
Address CreateStructGEP(Address Addr, unsigned Index, const llvm::Twine &Name="")
Definition: CGBuilder.h:178
QualType getAddrSpaceQualType(QualType T, LangAS AddressSpace) const
Return the uniqued reference to the type for an address space qualified type with the specified type ...
const BlockDecl * getBlockDecl() const
Definition: Expr.h:5565
Information about the layout of a __block variable.
Definition: CGBlocks.h:143
CharUnits alignTo(const CharUnits &Align) const
alignTo - Returns the next integer (mod 2**64) that is greater than or equal to this quantity and is ...
Definition: CharUnits.h:188
CaptureStrKind
Definition: CGBlocks.cpp:101
const Capture & getCapture(const VarDecl *var) const
Definition: CGBlocks.h:270
llvm::Constant * GenerateCopyHelperFunction(const CGBlockInfo &blockInfo)
Generate the copy-helper function for a block closure object: static void block_copy_helper(block_t *...
Definition: CGBlocks.cpp:1992
static llvm::Constant * generateByrefDisposeHelper(CodeGenFunction &CGF, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
Generate code for a __block variable&#39;s dispose helper.
Definition: CGBlocks.cpp:2521
Represents a function declaration or definition.
Definition: Decl.h:1784
llvm::IntegerType * IntTy
int
llvm::Type * getGenericBlockLiteralType()
The type of a generic block literal.
Definition: CGBlocks.cpp:1217
const CGFunctionInfo & arrangeBlockFunctionDeclaration(const FunctionProtoType *type, const FunctionArgList &args)
Block invocation functions are C functions with an implicit parameter.
Definition: CGCall.cpp:627
External linkage, which indicates that the entity can be referred to from other translation units...
Definition: Linkage.h:59
static FunctionDecl * Create(ASTContext &C, DeclContext *DC, SourceLocation StartLoc, SourceLocation NLoc, DeclarationName N, QualType T, TypeSourceInfo *TInfo, StorageClass SC, bool isInlineSpecified=false, bool hasWrittenPrototype=true, ConstexprSpecKind ConstexprKind=CSK_unspecified)
Definition: Decl.h:1931
Other implicit parameter.
Definition: Decl.h:1560
CharUnits BlockHeaderForcedGapOffset
Definition: CGBlocks.h:255
const FunctionProtoType * getFunctionType() const
getFunctionType - Return the underlying function type for this block.
Definition: Expr.cpp:2358
Expr * getCopyExpr() const
Definition: Decl.h:3997
static llvm::Constant * buildByrefDisposeHelper(CodeGenModule &CGM, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
Build the dispose helper for a __block variable.
Definition: CGBlocks.cpp:2575
void SetLLVMFunctionAttributes(GlobalDecl GD, const CGFunctionInfo &Info, llvm::Function *F)
Set the LLVM function attributes (sext, zext, etc).
A class which contains all the information about a particular captured value.
Definition: Decl.h:3957
CanQualType VoidPtrTy
Definition: ASTContext.h:1043
Destroyer * getDestroyer(QualType::DestructionKind destructionKind)
Definition: CGDecl.cpp:2026
A (possibly-)qualified type.
Definition: Type.h:643
bool isBlockPointerType() const
Definition: Type.h:6399
const CodeGenOptions & getCodeGenOpts() const
bool hasCaptures() const
True if this block (or its nested blocks) captures anything of local storage from its enclosing scope...
Definition: Decl.h:4070
bool HaveInsertPoint() const
HaveInsertPoint - True if an insertion point is defined.
capture_const_iterator capture_begin() const
Definition: Decl.h:4080
llvm::LLVMContext & getLLVMContext()
void EmitARCDestroyWeak(Address addr)
void @objc_destroyWeak(i8** addr) Essentially objc_storeWeak(addr, nil).
Definition: CGObjC.cpp:2436
The standard implementation of ConstantInitBuilder used in Clang.
BlockVarCopyInit getBlockVarCopyInit(const VarDecl *VD) const
Get the copy initialization expression of the VarDecl VD, or nullptr if none exists.
FunctionType - C99 6.7.5.3 - Function Declarators.
Definition: Type.h:3393
QualType getPointeeType() const
If this is a pointer, ObjC object pointer, or block pointer, this returns the respective pointee...
Definition: Type.cpp:557
const llvm::Triple & getTriple() const
Returns the target triple of the primary target.
Definition: TargetInfo.h:991
static T * buildByrefHelpers(CodeGenModule &CGM, const BlockByrefInfo &byrefInfo, T &&generator)
Lazily build the copy and dispose helpers for a __block variable with the given information.
Definition: CGBlocks.cpp:2585
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:2454
QualType getLValueReferenceType(QualType T, bool SpelledAsLValue=true) const
Return the uniqued reference to the type for an lvalue reference to the specified type...
param_iterator param_end()
Definition: Decl.h:4050
static llvm::Constant * buildBlockDescriptor(CodeGenModule &CGM, const CGBlockInfo &blockInfo)
buildBlockDescriptor - Build the block descriptor meta-data for a block.
Definition: CGBlocks.cpp:184
QualType getNonReferenceType() const
If Type is a reference type (e.g., const int&), returns the type that the reference refers to ("const...
Definition: Type.h:6339
constexpr size_t align(size_t Size)
Aligns a size to the pointer alignment.
Definition: PrimType.h:57
stable_iterator stable_begin() const
Create a stable reference to the top of the EH stack.
Definition: EHScopeStack.h:378
The l-value was an access to a declared entity or something equivalently strong, like the address of ...
llvm::IntegerType * Int8Ty
i8, i16, i32, and i64
capture_const_iterator capture_end() const
Definition: Decl.h:4081
The type would be trivial except that it is volatile-qualified.
Definition: Type.h:1116
Address GetAddrOfLocalVar(const VarDecl *VD)
GetAddrOfLocalVar - Return the address of a local variable.
bool ReturnValue(const T &V, APValue &R)
Convers a value to an APValue.
Definition: Interp.h:41
Represents a variable declaration or definition.
Definition: Decl.h:827
Objects with "hidden" visibility are not seen by the dynamic linker.
Definition: Visibility.h:36
CGBlockInfo(const BlockDecl *blockDecl, StringRef Name)
Definition: CGBlocks.cpp:34
const T * getAs() const
Member-template getAs<specific type>&#39;.
Definition: Type.h:6858
EHScopeStack::stable_iterator getCleanup() const
Definition: CGBlocks.h:182
static void setBlockHelperAttributesVisibility(bool CapturesNonExternalType, llvm::Function *Fn, const CGFunctionInfo &FI, CodeGenModule &CGM)
Definition: CGBlocks.cpp:1970
LangAS
Defines the address space values used by the address space qualifier of QualType. ...
Definition: AddressSpaces.h:25
This class gathers all debug information during compilation and is responsible for emitting to llvm g...
Definition: CGDebugInfo.h:54
static std::pair< BlockCaptureEntityKind, BlockFieldFlags > computeCopyInfoForBlockCapture(const BlockDecl::Capture &CI, QualType T, const LangOptions &LangOpts)
Definition: CGBlocks.cpp:1690
virtual llvm::Constant * BuildRCBlockLayout(CodeGen::CodeGenModule &CGM, const CodeGen::CGBlockInfo &blockInfo)=0
llvm::Value * getPointer() const
Definition: Address.h:37
llvm::Type * ConvertTypeForMem(QualType T)
ConvertTypeForMem - Convert type T into a llvm::Type.
const internal::VariadicDynCastAllOfMatcher< Stmt, BlockExpr > blockExpr
Matches a reference to a block.
static void pushCaptureCleanup(BlockCaptureEntityKind CaptureKind, Address Field, QualType CaptureType, BlockFieldFlags Flags, bool ForCopyHelper, VarDecl *Var, CodeGenFunction &CGF)
Definition: CGBlocks.cpp:1928
static void destroyBlockInfos(CGBlockInfo *info)
Destroy a chain of block layouts.
Definition: CGBlocks.cpp:890
The collection of all-type qualifiers we support.
Definition: Type.h:137
void add(RValue rvalue, QualType type)
Definition: CGCall.h:287
const AstTypeMatcher< RecordType > recordType
Matches record types (e.g.
const BlockDecl * Block
Definition: CGBlocks.h:246
llvm::DenseMap< const VarDecl *, FieldDecl * > LambdaCaptureFields
uint64_t getPointerWidth(unsigned AddrSpace) const
Return the width of pointers on this target, for the specified address space.
Definition: TargetInfo.h:360
static std::string getBlockCaptureStr(const BlockCaptureManagedEntity &E, CaptureStrKind StrKind, CharUnits BlockAlignment, CodeGenModule &CGM)
Definition: CGBlocks.cpp:1809
One of these records is kept for each identifier that is lexed.
bool doesNotEscape() const
Definition: Decl.h:4102
void emitByrefStructureInit(const AutoVarEmission &emission)
Initialize the structural components of a __block variable, i.e.
Definition: CGBlocks.cpp:2818
CGBlockInfo * FirstBlockInfo
FirstBlockInfo - The head of a singly-linked-list of block layouts.
CodeGenFunction - This class organizes the per-function state that is used while generating LLVM code...
llvm::Type * ConvertType(QualType T)
ConvertType - Convert type T into a llvm::Type.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:160
llvm::Constant * tryEmitAbstractForInitializer(const VarDecl &D)
Try to emit the initializer of the given declaration as an abstract constant.
bool isObjCInertUnsafeUnretainedType() const
Was this type written with the special inert-in-ARC __unsafe_unretained qualifier?
Definition: Type.h:2037
bool HasCapturedVariableLayout
HasCapturedVariableLayout : True if block has captured variables and their layout meta-data has been ...
Definition: CGBlocks.h:234
FullExpr - Represents a "full-expression" node.
Definition: Expr.h:925
SourceLocation getBeginLoc() const LLVM_READONLY
Definition: Stmt.cpp:274
bool isReferenceType() const
Definition: Type.h:6403
Denotes a cleanup that should run when a scope is exited using exceptional control flow (a throw stat...
Definition: EHScopeStack.h:80
std::string getObjCEncodingForBlock(const BlockExpr *blockExpr) const
Return the encoded type for this block declaration.
void recordBlockInfo(const BlockExpr *E, llvm::Function *InvokeF, llvm::Value *Block)
Record invoke function and block literal emitted during normal codegen for a block expression...
static AggValueSlot forAddr(Address addr, Qualifiers quals, IsDestructed_t isDestructed, NeedsGCBarriers_t needsGC, IsAliased_t isAliased, Overlap_t mayOverlap, IsZeroed_t isZeroed=IsNotZeroed, IsSanitizerChecked_t isChecked=IsNotSanitizerChecked)
forAddr - Make a slot for an aggregate value.
Definition: CGValue.h:513
static CharUnits Zero()
Zero - Construct a CharUnits quantity of zero.
Definition: CharUnits.h:53
static llvm::Constant * generateByrefCopyHelper(CodeGenFunction &CGF, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
Definition: CGBlocks.cpp:2444
Stmt * getBody() const override
getBody - If this Decl represents a declaration for a body of code, such as a function or method defi...
Definition: Decl.h:4030
static bool isSafeForCXXConstantCapture(QualType type)
Determines if the given type is safe for constant capture in C++.
Definition: CGBlocks.cpp:387
__DEVICE__ int max(int __a, int __b)
CleanupKind getCleanupKind(QualType::DestructionKind kind)
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:49
IdentifierTable & Idents
Definition: ASTContext.h:579
An r-value expression (a pr-value in the C++11 taxonomy) produces a temporary value.
Definition: Specifiers.h:125
CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const
Return the store size, in character units, of the given LLVM type.
llvm::Value * EmitARCStoreStrongCall(Address addr, llvm::Value *value, bool resultIgnored)
Store into a strong object.
Definition: CGObjC.cpp:2276
virtual std::string getRCBlockLayoutStr(CodeGen::CodeGenModule &CGM, const CGBlockInfo &blockInfo)
CharUnits - This is an opaque type for sizes expressed in character units.
Definition: CharUnits.h:38
void EmitARCDestroyStrong(Address addr, ARCPreciseLifetime_t precise)
Destroy a __strong variable.
Definition: CGObjC.cpp:2262
const BlockDecl * getBlockDecl() const
Definition: CGBlocks.h:280
void setDSOLocal(llvm::GlobalValue *GV) const
virtual TargetOpenCLBlockHelper * getTargetOpenCLBlockHelper() const
Definition: TargetInfo.h:298
bool HasCXXObject
HasCXXObject - True if the block&#39;s custom copy/dispose functions need to be run even in GC mode...
Definition: CGBlocks.h:226
llvm::Value * EmitBlockLiteral(const BlockExpr *)
Emit block literal.
Definition: CGBlocks.cpp:900
uint32_t getBitMask() const
Definition: CGBlocks.h:117
bool isByRef() const
Whether this is a "by ref" capture, i.e.
Definition: Decl.h:3982
bool isVolatileQualified() const
Determine whether this type is volatile-qualified.
Definition: Type.h:6218
bool needsEHCleanup(QualType::DestructionKind kind)
Determines whether an EH cleanup is required to destroy a type with the given destruction kind...
llvm::Constant * getAddrOfGlobalBlockIfEmitted(const BlockExpr *BE)
Returns the address of a block which requires no caputres, or null if we&#39;ve yet to emit the block for...
RangeSelector name(std::string ID)
Given a node with a "name", (like NamedDecl, DeclRefExpr or CxxCtorInitializer) selects the name&#39;s to...
The type is an Objective-C retainable pointer type that is qualified with the ARC __strong qualifier...
Definition: Type.h:1120
CharUnits getDeclAlign(const Decl *D, bool ForAlignof=false) const
Return a conservative estimate of the alignment of the specified decl D.
Scope - A scope is a transient data structure that is used while parsing the program.
Definition: Scope.h:40
void ForceCleanup(std::initializer_list< llvm::Value **> ValuesToReload={})
Force the emission of cleanups now, instead of waiting until this object is destroyed.
static Capture makeConstant(llvm::Value *value)
Definition: CGBlocks.h:209
llvm::AllocaInst * CreateTempAlloca(llvm::Type *Ty, const Twine &Name="tmp", llvm::Value *ArraySize=nullptr)
CreateTempAlloca - This creates an alloca and inserts it into the entry block if ArraySize is nullptr...
Definition: CGExpr.cpp:106
void callCStructMoveConstructor(LValue Dst, LValue Src)
const Stmt * getBody() const
Definition: Expr.cpp:2367
llvm::Constant * getNSConcreteStackBlock()
Definition: CGBlocks.cpp:3019
static std::string getNonTrivialCopyConstructorStr(QualType QT, CharUnits Alignment, bool IsVolatile, ASTContext &Ctx)
The type does not fall into any of the following categories.
Definition: Type.h:1111
This object can be modified without requiring retains or releases.
Definition: Type.h:158
StringRef Name
Name - The name of the block, kindof.
Definition: CGBlocks.h:155
bool isEscapingByref() const
Definition: Decl.h:3984
bool NeedsCopyDispose
True if the block has captures that would necessitate custom copy or dispose helper functions if the ...
Definition: CGBlocks.h:222
lookup_result lookup(DeclarationName Name) const
lookup - Find the declarations (if any) with the given Name in this context.
Definition: DeclBase.cpp:1609
const BlockExpr * BlockExpression
Definition: CGBlocks.h:247
static llvm::Constant * buildCopyHelper(CodeGenModule &CGM, const CGBlockInfo &blockInfo)
Build the helper function to copy a block.
Definition: CGBlocks.cpp:55
bool isValid() const
Definition: Address.h:35
CXXRecordDecl * getAsCXXRecordDecl() const
Retrieves the CXXRecordDecl that this type refers to, either because the type is a RecordType or beca...
Definition: Type.cpp:1692
Represents a prototype with parameter type info, e.g.
Definition: Type.h:3725
uint32_t getBitMask() const
Definition: CGBlocks.h:73
const CodeGen::CGBlockInfo * BlockInfo
const TargetCodeGenInfo & getTargetCodeGenInfo()
CGBlockInfo - Information to generate a block literal.
Definition: CGBlocks.h:152
virtual void emitCopy(CodeGenFunction &CGF, Address dest, Address src)=0
RValue - This trivial value class is used to represent the result of an expression that is evaluated...
Definition: CGValue.h:38
bool CanBeGlobal
CanBeGlobal - True if the block can be global, i.e.
Definition: CGBlocks.h:218
StringRef getBlockMangledName(GlobalDecl GD, const BlockDecl *BD)
static void findBlockCapturedManagedEntities(const CGBlockInfo &BlockInfo, const LangOptions &LangOpts, SmallVectorImpl< BlockCaptureManagedEntity > &ManagedCaptures)
Find the set of block captures that need to be explicitly copied or destroy.
Definition: CGBlocks.cpp:1751
QuantityType getQuantity() const
getQuantity - Get the raw integer representation of this quantity.
Definition: CharUnits.h:179
unsigned Offset
Definition: Format.cpp:1809
static void initializeForBlockHeader(CodeGenModule &CGM, CGBlockInfo &info, SmallVectorImpl< llvm::Type *> &elementTypes)
Definition: CGBlocks.cpp:447
CGBlockInfo * NextBlockInfo
The next block in the block-info chain.
Definition: CGBlocks.h:268
CGObjCRuntime & getObjCRuntime()
Return a reference to the configured Objective-C runtime.
Represents a block literal declaration, which is like an unnamed FunctionDecl.
Definition: Decl.h:3951
This represents one expression.
Definition: Expr.h:108
void EmitARCMoveWeak(Address dst, Address src)
void @objc_moveWeak(i8** dest, i8** src) Disregards the current value in dest.
Definition: CGObjC.cpp:2452
Emit only debug info necessary for generating line number tables (-gline-tables-only).
static Address invalid()
Definition: Address.h:34
unsigned long ulong
An unsigned 64-bit integer.
Definition: opencl-c-base.h:32
Enters a new scope for capturing cleanups, all of which will be executed once the scope is exited...
const T * castAs() const
Member-template castAs<specific type>.
Definition: Type.h:6923
bool isObjCRetainableType() const
Definition: Type.cpp:4057
#define V(N, I)
Definition: ASTContext.h:2921
BlockExpr - Adaptor class for mixing a BlockDecl with expressions.
Definition: Expr.h:5551
Represents a C++ destructor within a class.
Definition: DeclCXX.h:2629
BlockCaptureEntityKind
Represents a type of copy/destroy operation that should be performed for an entity that&#39;s captured by...
Definition: CGBlocks.cpp:70
static llvm::Constant * buildGlobalBlock(CodeGenModule &CGM, const CGBlockInfo &blockInfo, llvm::Constant *blockFn)
Build the given block as a global block.
Definition: CGBlocks.cpp:1382
Expr * getCallee()
Definition: Expr.h:2638
llvm::Constant * GenerateDestroyHelperFunction(const CGBlockInfo &blockInfo)
Generate the destroy-helper function for a block closure object: static void block_destroy_helper(blo...
Definition: CGBlocks.cpp:2187
ObjCLifetime getObjCLifetime() const
Definition: Type.h:327
static CharUnits fromQuantity(QuantityType Quantity)
fromQuantity - Construct a CharUnits quantity from a raw integer type.
Definition: CharUnits.h:63
bool needsCopyDisposeHelpers() const
Definition: CGBlocks.h:290
bool ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI)
Return true iff the given type uses an argument slot when &#39;sret&#39; is used as a return type...
Definition: CGCall.cpp:1502
static Capture makeIndex(unsigned index, CharUnits offset, QualType FieldType)
Definition: CGBlocks.h:200
QualType getType() const
Definition: Expr.h:137
llvm::FunctionCallee getBlockObjectAssign()
Definition: CGBlocks.cpp:2995
bool isa(CodeGen::Address addr)
Definition: Address.h:111
QualType getFunctionType(QualType ResultTy, ArrayRef< QualType > Args, const FunctionProtoType::ExtProtoInfo &EPI) const
Return a normal function type with a typed argument list.
Definition: ASTContext.h:1387
static bool CanThrow(Expr *E, ASTContext &Ctx)
Definition: CFG.cpp:2549
static CharUnits getLowBit(CharUnits v)
Get the low bit of a nonzero character count.
Definition: CGBlocks.cpp:443
const Type * getBaseElementTypeUnsafe() const
Get the base element type of this type, potentially discarding type qualifiers.
Definition: Type.h:6798
const TargetInfo & getTarget() const
const LangOptions & getLangOpts() const
ASTContext & getContext() const
static BlockFieldFlags getBlockFieldFlagsForObjCObjectPointer(const BlockDecl::Capture &CI, QualType T)
Definition: CGBlocks.cpp:2133
do v
Definition: arm_acle.h:64
Address GetAddrOfBlockDecl(const VarDecl *var)
Definition: CGBlocks.cpp:1318
static QualType getCaptureFieldType(const CodeGenFunction &CGF, const BlockDecl::Capture &CI)
Definition: CGBlocks.cpp:502
llvm::Function * getInvokeFunction(const Expr *E)
GlobalDecl - represents a global declaration.
Definition: GlobalDecl.h:40
static std::string getBlockDescriptorName(const CGBlockInfo &BlockInfo, CodeGenModule &CGM)
Definition: CGBlocks.cpp:121
virtual bool needsCopy() const
virtual llvm::Constant * BuildByrefLayout(CodeGen::CodeGenModule &CGM, QualType T)=0
Returns an i8* which points to the byref layout information.
bool isConstQualified() const
Determine whether this type is const-qualified.
Definition: Type.h:6207
param_iterator param_begin()
Definition: Decl.h:4049
The l-value was considered opaque, so the alignment was determined from a type.
RecordDecl * getDecl() const
Definition: Type.h:4454
void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum, llvm::Value *ptr)
Definition: CGBlocks.cpp:1475
void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize, std::initializer_list< llvm::Value **> ValuesToReload={})
Takes the old cleanup stack size and emits the cleanup blocks that have been added.
Definition: CGCleanup.cpp:417
bool UsesStret
UsesStret : True if the block uses an stret return.
Definition: CGBlocks.h:230
There is no lifetime qualification on this type.
Definition: Type.h:154
Address CreateBitCast(Address Addr, llvm::Type *Ty, const llvm::Twine &Name="")
Definition: CGBuilder.h:141
llvm::FunctionCallee getBlockObjectDispose()
Definition: CGBlocks.cpp:2982
#define false
Definition: stdbool.h:17
Assigning into this object requires the old value to be released and the new value to be retained...
Definition: Type.h:165
Kind
void PushDestructorCleanup(QualType T, Address Addr)
PushDestructorCleanup - Push a cleanup to call the complete-object destructor of an object of the giv...
Definition: CGClass.cpp:2445
void pushDestroy(QualType::DestructionKind dtorKind, Address addr, QualType type)
pushDestroy - Push the standard destructor for the given type as at least a normal cleanup...
Definition: CGDecl.cpp:2053
Encodes a location in the source.
static DeclContext * castToDeclContext(const TranslationUnitDecl *D)
Definition: Decl.h:129
void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags, bool CanThrow)
Definition: CGBlocks.cpp:2924
QualType getReturnType() const
Definition: Type.h:3651
IdentifierInfo & get(StringRef Name)
Return the identifier token info for the specified named identifier.
SourceLocation getBeginLoc() const LLVM_READONLY
Definition: Expr.h:5574
A saved depth on the scope stack.
Definition: EHScopeStack.h:106
llvm::StructType * StructureType
Definition: CGBlocks.h:245
std::string getNameAsString() const
Get a human-readable name for the declaration, even if it is one of the special kinds of names (C++ c...
Definition: Decl.h:291
static std::string getCopyDestroyHelperFuncName(const SmallVectorImpl< BlockCaptureManagedEntity > &Captures, CharUnits BlockAlignment, CaptureStrKind StrKind, CodeGenModule &CGM)
Definition: CGBlocks.cpp:1905
static void configureBlocksRuntimeObject(CodeGenModule &CGM, llvm::Constant *C)
Adjust the declaration of something from the blocks API.
Definition: CGBlocks.cpp:2946
The type is a struct containing a field whose type is neither PCK_Trivial nor PCK_VolatileTrivial.
Definition: Type.h:1132
An aggregate value slot.
Definition: CGValue.h:436
const BlockByrefInfo & getBlockByrefInfo(const VarDecl *var)
BuildByrefInfo - This routine changes a __block variable declared as T x into:
Definition: CGBlocks.cpp:2730
A scoped helper to set the current debug location to the specified location or preferred location of ...
Definition: CGDebugInfo.h:711
bool CapturesNonExternalType
Indicates whether an object of a non-external C++ class is captured.
Definition: CGBlocks.h:239
static bool cxxDestructorCanThrow(QualType T)
Check if T is a C++ class that has a destructor that can throw.
Definition: CGBlocks.cpp:1801
bool isConversionFromLambda() const
Definition: Decl.h:4094
void enterNonTrivialFullExpression(const FullExpr *E)
Enter a full-expression with a non-trivial number of objects to clean up.
Definition: CGBlocks.cpp:864
CanQualType VoidTy
Definition: ASTContext.h:1015
llvm::DenseMap< const VarDecl *, Capture > Captures
The mapping of allocated indexes within the block.
Definition: CGBlocks.h:242
bool isNonEscapingByref() const
Indicates the capture is a __block variable that is never captured by an escaping block...
Definition: Decl.cpp:2465
arg_range arguments()
Definition: Expr.h:2714
bool isObjCObjectPointerType() const
Definition: Type.h:6495
static bool isBlockPointer(Expr *Arg)
An aligned address.
Definition: Address.h:24
void StartFunction(GlobalDecl GD, QualType RetTy, llvm::Function *Fn, const CGFunctionInfo &FnInfo, const FunctionArgList &Args, SourceLocation Loc=SourceLocation(), SourceLocation StartLoc=SourceLocation())
Emit code for the start of a function.
void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F)
Set the LLVM function attributes which only apply to a function definition.
ImplicitCastExpr - Allows us to explicitly represent implicit type conversions, which have no direct ...
Definition: Expr.h:3249
DestructionKind isDestructedType() const
Returns a nonzero value if objects of this type require non-trivial work to clean up after...
Definition: Type.h:1160
llvm::Value * getConstant() const
Definition: CGBlocks.h:191
const BlockExpr * getBlockExpr() const
Definition: CGBlocks.h:281
All available information about a concrete callee.
Definition: CGCall.h:66
MangleContext & getMangleContext()
Gets the mangle context.
Definition: CGCXXABI.h:96
void enterByrefCleanup(CleanupKind Kind, Address Addr, BlockFieldFlags Flags, bool LoadBlockVarAddr, bool CanThrow)
Enter a cleanup to destroy a __block variable.
Definition: CGBlocks.cpp:2938
virtual bool needsDispose() const
bool operator<(DeclarationName LHS, DeclarationName RHS)
Ordering on two declaration names.
VarDecl * getVariable() const
The variable being captured.
Definition: Decl.h:3978
PrimitiveCopyKind isNonTrivialToPrimitiveCopy() const
Check if this is a non-trivial type that would cause a C struct transitively containing this type to ...
Definition: Type.cpp:2364
unsigned CXXThisIndex
The field index of &#39;this&#39; within the block, if there is one.
Definition: CGBlocks.h:158
Assigning into this object requires a lifetime extension.
Definition: Type.h:171
static Destroyer destroyARCStrongImprecise
void FinishFunction(SourceLocation EndLoc=SourceLocation())
FinishFunction - Complete IR generation of the current function.
virtual void mangleTypeName(QualType T, raw_ostream &)=0
Generates a unique string for an externally visible type for use with TBAA or type uniquing...
The type is an Objective-C retainable pointer type that is qualified with the ARC __weak qualifier...
Definition: Type.h:1124
const CGFunctionInfo & arrangeBlockFunctionCall(const CallArgList &args, const FunctionType *type)
A block function is essentially a free function with an extra implicit argument.
Definition: CGCall.cpp:620
std::pair< CharUnits, CharUnits > getTypeInfoInChars(const Type *T) const
ConstantAddress GetAddrOfConstantCString(const std::string &Str, const char *GlobalName=nullptr)
Returns a pointer to a character array containing the literal and a terminating &#39;\0&#39; character...
void addUsedGlobal(llvm::GlobalValue *GV)
Add a global to a list to be added to the llvm.used metadata.
FunctionArgList - Type for representing both the decl and type of parameters to a function...
Definition: CGCall.h:358
bool isObjCGCWeak() const
true when Type is objc&#39;s weak.
Definition: Type.h:1056
static llvm::Constant * tryCaptureAsConstant(CodeGenModule &CGM, CodeGenFunction *CGF, const VarDecl *var)
It is illegal to modify a const object after initialization.
Definition: CGBlocks.cpp:411
CGFunctionInfo - Class to encapsulate the information about a function definition.
This class organizes the cross-function state that is used while generating LLVM code.
CharUnits alignmentAtOffset(CharUnits offset) const
Given that this is a non-zero alignment value, what is the alignment at the given offset...
Definition: CharUnits.h:194
Dataflow Directional Tag Classes.
virtual llvm::Constant * BuildGCBlockLayout(CodeGen::CodeGenModule &CGM, const CodeGen::CGBlockInfo &blockInfo)=0
static void computeBlockInfo(CodeGenModule &CGM, CodeGenFunction *CGF, CGBlockInfo &info)
Compute the layout of the given block.
Definition: CGBlocks.cpp:521
llvm::FoldingSet< BlockByrefHelpers > ByrefHelpersCache
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1271
ArrayRef< Capture > captures() const
Definition: Decl.h:4078
bool isNested() const
Whether this is a nested capture, i.e.
Definition: Decl.h:3994
Parameter for Objective-C &#39;self&#39; argument.
Definition: Decl.h:1545
static llvm::Constant * buildDisposeHelper(CodeGenModule &CGM, const CGBlockInfo &blockInfo)
Build the helper function to dispose of a block.
Definition: CGBlocks.cpp:61
const Expr * getInit() const
Definition: Decl.h:1234
llvm::Constant * getPointer() const
Definition: Address.h:83
std::unique_ptr< DiagnosticConsumer > create(StringRef OutputFile, DiagnosticOptions *Diags, bool MergeChildRecords=false)
Returns a DiagnosticConsumer that serializes diagnostics to a bitcode file.
llvm::LoadInst * CreateLoad(Address Addr, const llvm::Twine &Name="")
Definition: CGBuilder.h:69
int printf(__constant const char *st,...) __attribute__((format(printf
bool hasObjCLifetime() const
Definition: Type.h:326
llvm::StoreInst * CreateStore(llvm::Value *Val, Address Addr, bool IsVolatile=false)
Definition: CGBuilder.h:107
bool isEscapingByref() const
Indicates the capture is a __block variable that is captured by a block that can potentially escape (...
Definition: Decl.cpp:2461
llvm::Module & getModule() const
llvm::StructType * Type
Definition: CGBlocks.h:145
LValue MakeAddrLValue(Address Addr, QualType T, AlignmentSource Source=AlignmentSource::Type)
llvm::DenseMap< const Decl *, Address > DeclMapTy
static void enterBlockScope(CodeGenFunction &CGF, BlockDecl *block)
Enter the scope of a block.
Definition: CGBlocks.cpp:780
Pointer to a block type.
Definition: Type.h:2687
A helper class that allows the use of isa/cast/dyncast to detect TagType objects of structs/unions/cl...
Definition: Type.h:4444
StructBuilder beginStruct(llvm::StructType *structTy=nullptr)
CanQualType UnsignedLongTy
Definition: ASTContext.h:1025
static llvm::Constant * buildByrefCopyHelper(CodeGenModule &CGM, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
Build the copy helper for a __block variable.
Definition: CGBlocks.cpp:2512
void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp)
Definition: CGExprCXX.cpp:638
static CGBlockInfo * findAndRemoveBlockInfo(CGBlockInfo **head, const BlockDecl *block)
Find the layout for the given block in a linked list and remove it.
Definition: CGBlocks.cpp:873
void SetInternalFunctionAttributes(GlobalDecl GD, llvm::Function *F, const CGFunctionInfo &FI)
Set the attributes on the LLVM function for the given decl and function info.
virtual void emitDispose(CodeGenFunction &CGF, Address field)=0
Internal linkage, which indicates that the entity can be referred to from within the translation unit...
Definition: Linkage.h:31
const Decl * CurFuncDecl
CurFuncDecl - Holds the Decl for the current outermost non-closure context.
A pair of helper functions for a __block variable.
bool capturesCXXThis() const
Definition: Decl.h:4083
Reading or writing from this object requires a barrier call.
Definition: Type.h:168
TranslationUnitDecl * getTranslationUnitDecl() const
Definition: ASTContext.h:1008
Represents a C++ struct/union/class.
Definition: DeclCXX.h:255
static std::string getNonTrivialDestructorStr(QualType QT, CharUnits Alignment, bool IsVolatile, ASTContext &Ctx)
Qualifiers getQualifiers() const
Retrieve the set of qualifiers applied to this type.
Definition: Type.h:6175
void setAddrOfGlobalBlock(const BlockExpr *BE, llvm::Constant *Addr)
Notes that BE&#39;s global block is available via Addr.
Definition: CGBlocks.cpp:1352
QualType getPointerType(QualType T) const
Return the uniqued reference to the type for a pointer to the specified type.
CharUnits BlockHeaderForcedGapSize
Definition: CGBlocks.h:258
SourceLocation getEndLoc() const LLVM_READONLY
Definition: Expr.h:5577
llvm::Value * EmitARCRetainBlock(llvm::Value *value, bool mandatory)
Retain the given block, with _Block_copy semantics.
Definition: CGObjC.cpp:2134
uint64_t getPointerAlign(unsigned AddrSpace) const
Definition: TargetInfo.h:363
CallExpr - Represents a function call (C99 6.5.2.2, C++ [expr.call]).
Definition: Expr.h:2521
StringRef getName() const
Get the name of identifier for this declaration as a StringRef.
Definition: Decl.h:275
CGCXXABI & getCXXABI() const
llvm::Function * GenerateBlockFunction(GlobalDecl GD, const CGBlockInfo &Info, const DeclMapTy &ldm, bool IsLambdaConversionToBlock, bool BuildGlobalBlock)
Definition: CGBlocks.cpp:1515
The top declaration context.
Definition: Decl.h:107
A reference to a declared variable, function, enum, etc.
Definition: Expr.h:1146
static RValue get(llvm::Value *V)
Definition: CGValue.h:85
RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue)
Definition: CGBlocks.cpp:1254
const internal::VariadicDynCastAllOfMatcher< Decl, BlockDecl > blockDecl
Matches block declarations.
CharUnits getTypeSizeInChars(QualType T) const
Return the size of the specified (complete) type T, in characters.
static ApplyDebugLocation CreateEmpty(CodeGenFunction &CGF)
Set the IRBuilder to not attach debug locations.
Definition: CGDebugInfo.h:759
llvm::Constant * getNSConcreteGlobalBlock()
Definition: CGBlocks.cpp:3008
RangeSelector node(std::string ID)
Selects a node, including trailing semicolon (for non-expression statements).
llvm::Type * getBlockDescriptorType()
Fetches the type of a generic block descriptor.
Definition: CGBlocks.cpp:1185
llvm::Constant * GetAddrOfGlobalBlock(const BlockExpr *BE, StringRef Name)
Gets the address of a block which requires no captures.
Definition: CGBlocks.cpp:1360
QualType getType() const
Definition: Decl.h:655
An l-value expression is a reference to an object with independent storage.
Definition: Specifiers.h:129
llvm::PointerType * getGenericVoidPointerType()
Information for lazily generating a cleanup.
Definition: EHScopeStack.h:146
This represents a decl that may have a name.
Definition: Decl.h:248
llvm::Instruction * DominatingIP
An instruction which dominates the full-expression that the block is inside.
Definition: CGBlocks.h:262
const LangOptions & getLangOpts() const
unsigned getTargetAddressSpace(QualType T) const
Definition: ASTContext.h:2541
llvm::CallInst * EmitNounwindRuntimeCall(llvm::FunctionCallee callee, const Twine &name="")
static bool isObjCNSObjectType(QualType Ty)
Return true if this is an NSObject object with its NSObject attribute set.
Definition: ASTContext.h:2068
Decl * getCalleeDecl()
Definition: Expr.h:2650
CallArgList - Type for representing both the value and type of arguments in a call.
Definition: CGCall.h:262
const LangOptions & getLangOpts() const
Definition: ASTContext.h:723
Address emitBlockByrefAddress(Address baseAddr, const VarDecl *V, bool followForward=true)
BuildBlockByrefAddress - Computes the location of the data in a variable which is declared as __block...
Definition: CGBlocks.cpp:2695
Abstract information about a function or function prototype.
Definition: CGCall.h:44
SourceLocation getLocation() const
Definition: DeclBase.h:429
static std::pair< BlockCaptureEntityKind, BlockFieldFlags > computeDestroyInfoForBlockCapture(const BlockDecl::Capture &CI, QualType T, const LangOptions &LangOpts)
Definition: CGBlocks.cpp:2142
bool isExternallyVisible() const
Definition: Decl.h:387
void setCleanup(EHScopeStack::stable_iterator cleanup)
Definition: CGBlocks.h:186
static OMPLinearClause * Create(const ASTContext &C, SourceLocation StartLoc, SourceLocation LParenLoc, OpenMPLinearClauseKind Modifier, SourceLocation ModifierLoc, SourceLocation ColonLoc, SourceLocation EndLoc, ArrayRef< Expr *> VL, ArrayRef< Expr *> PL, ArrayRef< Expr *> IL, Expr *Step, Expr *CalcStep, Stmt *PreInit, Expr *PostUpdate)
Creates clause with a list of variables VL and a linear step Step.
void Destroyer(CodeGenFunction &CGF, Address addr, QualType ty)
Qualifiers::ObjCLifetime getObjCLifetime() const
Returns lifetime attribute of this type.
Definition: Type.h:1066
llvm::FunctionType * GetFunctionType(const CGFunctionInfo &Info)
GetFunctionType - Get the LLVM function type for.
Definition: CGCall.cpp:1541