clang  5.0.0svn
CGBlocks.cpp
Go to the documentation of this file.
1 //===--- CGBlocks.cpp - Emit LLVM Code for declarations ---------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This contains code to emit blocks.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CGBlocks.h"
15 #include "CGDebugInfo.h"
16 #include "CGObjCRuntime.h"
17 #include "CodeGenFunction.h"
18 #include "CodeGenModule.h"
19 #include "ConstantBuilder.h"
20 #include "clang/AST/DeclObjC.h"
21 #include "llvm/ADT/SmallSet.h"
22 #include "llvm/IR/CallSite.h"
23 #include "llvm/IR/DataLayout.h"
24 #include "llvm/IR/Module.h"
25 #include <algorithm>
26 #include <cstdio>
27 
28 using namespace clang;
29 using namespace CodeGen;
30 
31 CGBlockInfo::CGBlockInfo(const BlockDecl *block, StringRef name)
32  : Name(name), CXXThisIndex(0), CanBeGlobal(false), NeedsCopyDispose(false),
33  HasCXXObject(false), UsesStret(false), HasCapturedVariableLayout(false),
34  LocalAddress(Address::invalid()), StructureType(nullptr), Block(block),
35  DominatingIP(nullptr) {
36 
37  // Skip asm prefix, if any. 'name' is usually taken directly from
38  // the mangled name of the enclosing function.
39  if (!name.empty() && name[0] == '\01')
40  name = name.substr(1);
41 }
42 
43 // Anchor the vtable to this translation unit.
45 
46 /// Build the given block as a global block.
47 static llvm::Constant *buildGlobalBlock(CodeGenModule &CGM,
48  const CGBlockInfo &blockInfo,
49  llvm::Constant *blockFn);
50 
51 /// Build the helper function to copy a block.
52 static llvm::Constant *buildCopyHelper(CodeGenModule &CGM,
53  const CGBlockInfo &blockInfo) {
54  return CodeGenFunction(CGM).GenerateCopyHelperFunction(blockInfo);
55 }
56 
57 /// Build the helper function to dispose of a block.
58 static llvm::Constant *buildDisposeHelper(CodeGenModule &CGM,
59  const CGBlockInfo &blockInfo) {
60  return CodeGenFunction(CGM).GenerateDestroyHelperFunction(blockInfo);
61 }
62 
63 /// buildBlockDescriptor - Build the block descriptor meta-data for a block.
64 /// buildBlockDescriptor is accessed from 5th field of the Block_literal
65 /// meta-data and contains stationary information about the block literal.
66 /// Its definition will have 4 (or optinally 6) words.
67 /// \code
68 /// struct Block_descriptor {
69 /// unsigned long reserved;
70 /// unsigned long size; // size of Block_literal metadata in bytes.
71 /// void *copy_func_helper_decl; // optional copy helper.
72 /// void *destroy_func_decl; // optioanl destructor helper.
73 /// void *block_method_encoding_address; // @encode for block literal signature.
74 /// void *block_layout_info; // encoding of captured block variables.
75 /// };
76 /// \endcode
77 static llvm::Constant *buildBlockDescriptor(CodeGenModule &CGM,
78  const CGBlockInfo &blockInfo) {
79  ASTContext &C = CGM.getContext();
80 
81  llvm::IntegerType *ulong =
82  cast<llvm::IntegerType>(CGM.getTypes().ConvertType(C.UnsignedLongTy));
83  llvm::PointerType *i8p = nullptr;
84  if (CGM.getLangOpts().OpenCL)
85  i8p =
86  llvm::Type::getInt8PtrTy(
88  else
89  i8p = CGM.VoidPtrTy;
90 
91  ConstantInitBuilder builder(CGM);
92  auto elements = builder.beginStruct();
93 
94  // reserved
95  elements.addInt(ulong, 0);
96 
97  // Size
98  // FIXME: What is the right way to say this doesn't fit? We should give
99  // a user diagnostic in that case. Better fix would be to change the
100  // API to size_t.
101  elements.addInt(ulong, blockInfo.BlockSize.getQuantity());
102 
103  // Optional copy/dispose helpers.
104  if (blockInfo.NeedsCopyDispose) {
105  // copy_func_helper_decl
106  elements.add(buildCopyHelper(CGM, blockInfo));
107 
108  // destroy_func_decl
109  elements.add(buildDisposeHelper(CGM, blockInfo));
110  }
111 
112  // Signature. Mandatory ObjC-style method descriptor @encode sequence.
113  std::string typeAtEncoding =
115  elements.add(llvm::ConstantExpr::getBitCast(
116  CGM.GetAddrOfConstantCString(typeAtEncoding).getPointer(), i8p));
117 
118  // GC layout.
119  if (C.getLangOpts().ObjC1) {
120  if (CGM.getLangOpts().getGC() != LangOptions::NonGC)
121  elements.add(CGM.getObjCRuntime().BuildGCBlockLayout(CGM, blockInfo));
122  else
123  elements.add(CGM.getObjCRuntime().BuildRCBlockLayout(CGM, blockInfo));
124  }
125  else
126  elements.addNullPointer(i8p);
127 
128  unsigned AddrSpace = 0;
129  if (C.getLangOpts().OpenCL)
131 
132  llvm::GlobalVariable *global =
133  elements.finishAndCreateGlobal("__block_descriptor_tmp",
134  CGM.getPointerAlign(),
135  /*constant*/ true,
137  AddrSpace);
138 
139  return llvm::ConstantExpr::getBitCast(global, CGM.getBlockDescriptorType());
140 }
141 
142 /*
143  Purely notional variadic template describing the layout of a block.
144 
145  template <class _ResultType, class... _ParamTypes, class... _CaptureTypes>
146  struct Block_literal {
147  /// Initialized to one of:
148  /// extern void *_NSConcreteStackBlock[];
149  /// extern void *_NSConcreteGlobalBlock[];
150  ///
151  /// In theory, we could start one off malloc'ed by setting
152  /// BLOCK_NEEDS_FREE, giving it a refcount of 1, and using
153  /// this isa:
154  /// extern void *_NSConcreteMallocBlock[];
155  struct objc_class *isa;
156 
157  /// These are the flags (with corresponding bit number) that the
158  /// compiler is actually supposed to know about.
159  /// 25. BLOCK_HAS_COPY_DISPOSE - indicates that the block
160  /// descriptor provides copy and dispose helper functions
161  /// 26. BLOCK_HAS_CXX_OBJ - indicates that there's a captured
162  /// object with a nontrivial destructor or copy constructor
163  /// 28. BLOCK_IS_GLOBAL - indicates that the block is allocated
164  /// as global memory
165  /// 29. BLOCK_USE_STRET - indicates that the block function
166  /// uses stret, which objc_msgSend needs to know about
167  /// 30. BLOCK_HAS_SIGNATURE - indicates that the block has an
168  /// @encoded signature string
169  /// And we're not supposed to manipulate these:
170  /// 24. BLOCK_NEEDS_FREE - indicates that the block has been moved
171  /// to malloc'ed memory
172  /// 27. BLOCK_IS_GC - indicates that the block has been moved to
173  /// to GC-allocated memory
174  /// Additionally, the bottom 16 bits are a reference count which
175  /// should be zero on the stack.
176  int flags;
177 
178  /// Reserved; should be zero-initialized.
179  int reserved;
180 
181  /// Function pointer generated from block literal.
182  _ResultType (*invoke)(Block_literal *, _ParamTypes...);
183 
184  /// Block description metadata generated from block literal.
185  struct Block_descriptor *block_descriptor;
186 
187  /// Captured values follow.
188  _CapturesTypes captures...;
189  };
190  */
191 
192 namespace {
193  /// A chunk of data that we actually have to capture in the block.
194  struct BlockLayoutChunk {
195  CharUnits Alignment;
196  CharUnits Size;
197  Qualifiers::ObjCLifetime Lifetime;
198  const BlockDecl::Capture *Capture; // null for 'this'
199  llvm::Type *Type;
200  QualType FieldType;
201 
202  BlockLayoutChunk(CharUnits align, CharUnits size,
203  Qualifiers::ObjCLifetime lifetime,
204  const BlockDecl::Capture *capture,
205  llvm::Type *type, QualType fieldType)
206  : Alignment(align), Size(size), Lifetime(lifetime),
207  Capture(capture), Type(type), FieldType(fieldType) {}
208 
209  /// Tell the block info that this chunk has the given field index.
210  void setIndex(CGBlockInfo &info, unsigned index, CharUnits offset) {
211  if (!Capture) {
212  info.CXXThisIndex = index;
213  info.CXXThisOffset = offset;
214  } else {
215  auto C = CGBlockInfo::Capture::makeIndex(index, offset, FieldType);
216  info.Captures.insert({Capture->getVariable(), C});
217  }
218  }
219  };
220 
221  /// Order by 1) all __strong together 2) next, all byfref together 3) next,
222  /// all __weak together. Preserve descending alignment in all situations.
223  bool operator<(const BlockLayoutChunk &left, const BlockLayoutChunk &right) {
224  if (left.Alignment != right.Alignment)
225  return left.Alignment > right.Alignment;
226 
227  auto getPrefOrder = [](const BlockLayoutChunk &chunk) {
228  if (chunk.Capture && chunk.Capture->isByRef())
229  return 1;
230  if (chunk.Lifetime == Qualifiers::OCL_Strong)
231  return 0;
232  if (chunk.Lifetime == Qualifiers::OCL_Weak)
233  return 2;
234  return 3;
235  };
236 
237  return getPrefOrder(left) < getPrefOrder(right);
238  }
239 } // end anonymous namespace
240 
241 /// Determines if the given type is safe for constant capture in C++.
243  const RecordType *recordType =
245 
246  // Only records can be unsafe.
247  if (!recordType) return true;
248 
249  const auto *record = cast<CXXRecordDecl>(recordType->getDecl());
250 
251  // Maintain semantics for classes with non-trivial dtors or copy ctors.
252  if (!record->hasTrivialDestructor()) return false;
253  if (record->hasNonTrivialCopyConstructor()) return false;
254 
255  // Otherwise, we just have to make sure there aren't any mutable
256  // fields that might have changed since initialization.
257  return !record->hasMutableFields();
258 }
259 
260 /// It is illegal to modify a const object after initialization.
261 /// Therefore, if a const object has a constant initializer, we don't
262 /// actually need to keep storage for it in the block; we'll just
263 /// rematerialize it at the start of the block function. This is
264 /// acceptable because we make no promises about address stability of
265 /// captured variables.
266 static llvm::Constant *tryCaptureAsConstant(CodeGenModule &CGM,
267  CodeGenFunction *CGF,
268  const VarDecl *var) {
269  // Return if this is a function paramter. We shouldn't try to
270  // rematerialize default arguments of function parameters.
271  if (isa<ParmVarDecl>(var))
272  return nullptr;
273 
274  QualType type = var->getType();
275 
276  // We can only do this if the variable is const.
277  if (!type.isConstQualified()) return nullptr;
278 
279  // Furthermore, in C++ we have to worry about mutable fields:
280  // C++ [dcl.type.cv]p4:
281  // Except that any class member declared mutable can be
282  // modified, any attempt to modify a const object during its
283  // lifetime results in undefined behavior.
284  if (CGM.getLangOpts().CPlusPlus && !isSafeForCXXConstantCapture(type))
285  return nullptr;
286 
287  // If the variable doesn't have any initializer (shouldn't this be
288  // invalid?), it's not clear what we should do. Maybe capture as
289  // zero?
290  const Expr *init = var->getInit();
291  if (!init) return nullptr;
292 
293  return CGM.EmitConstantInit(*var, CGF);
294 }
295 
296 /// Get the low bit of a nonzero character count. This is the
297 /// alignment of the nth byte if the 0th byte is universally aligned.
299  return CharUnits::fromQuantity(v.getQuantity() & (~v.getQuantity() + 1));
300 }
301 
303  SmallVectorImpl<llvm::Type*> &elementTypes) {
304  // The header is basically 'struct { void *; int; int; void *; void *; }'.
305  // Assert that that struct is packed.
306  assert(CGM.getIntSize() <= CGM.getPointerSize());
307  assert(CGM.getIntAlign() <= CGM.getPointerAlign());
308  assert((2 * CGM.getIntSize()).isMultipleOf(CGM.getPointerAlign()));
309 
310  info.BlockAlign = CGM.getPointerAlign();
311  info.BlockSize = 3 * CGM.getPointerSize() + 2 * CGM.getIntSize();
312 
313  assert(elementTypes.empty());
314  elementTypes.push_back(CGM.VoidPtrTy);
315  elementTypes.push_back(CGM.IntTy);
316  elementTypes.push_back(CGM.IntTy);
317  elementTypes.push_back(CGM.VoidPtrTy);
318  elementTypes.push_back(CGM.getBlockDescriptorType());
319 }
320 
321 /// Compute the layout of the given block. Attempts to lay the block
322 /// out with minimal space requirements.
324  CGBlockInfo &info) {
325  ASTContext &C = CGM.getContext();
326  const BlockDecl *block = info.getBlockDecl();
327 
328  SmallVector<llvm::Type*, 8> elementTypes;
329  initializeForBlockHeader(CGM, info, elementTypes);
330 
331  if (!block->hasCaptures()) {
332  info.StructureType =
333  llvm::StructType::get(CGM.getLLVMContext(), elementTypes, true);
334  info.CanBeGlobal = true;
335  return;
336  }
337  else if (C.getLangOpts().ObjC1 &&
338  CGM.getLangOpts().getGC() == LangOptions::NonGC)
339  info.HasCapturedVariableLayout = true;
340 
341  // Collect the layout chunks.
343  layout.reserve(block->capturesCXXThis() +
344  (block->capture_end() - block->capture_begin()));
345 
346  CharUnits maxFieldAlign;
347 
348  // First, 'this'.
349  if (block->capturesCXXThis()) {
350  assert(CGF && CGF->CurFuncDecl && isa<CXXMethodDecl>(CGF->CurFuncDecl) &&
351  "Can't capture 'this' outside a method");
352  QualType thisType = cast<CXXMethodDecl>(CGF->CurFuncDecl)->getThisType(C);
353 
354  // Theoretically, this could be in a different address space, so
355  // don't assume standard pointer size/align.
356  llvm::Type *llvmType = CGM.getTypes().ConvertType(thisType);
357  std::pair<CharUnits,CharUnits> tinfo
358  = CGM.getContext().getTypeInfoInChars(thisType);
359  maxFieldAlign = std::max(maxFieldAlign, tinfo.second);
360 
361  layout.push_back(BlockLayoutChunk(tinfo.second, tinfo.first,
363  nullptr, llvmType, thisType));
364  }
365 
366  // Next, all the block captures.
367  for (const auto &CI : block->captures()) {
368  const VarDecl *variable = CI.getVariable();
369 
370  if (CI.isByRef()) {
371  // We have to copy/dispose of the __block reference.
372  info.NeedsCopyDispose = true;
373 
374  // Just use void* instead of a pointer to the byref type.
375  CharUnits align = CGM.getPointerAlign();
376  maxFieldAlign = std::max(maxFieldAlign, align);
377 
378  layout.push_back(BlockLayoutChunk(align, CGM.getPointerSize(),
380  CGM.VoidPtrTy, variable->getType()));
381  continue;
382  }
383 
384  // Otherwise, build a layout chunk with the size and alignment of
385  // the declaration.
386  if (llvm::Constant *constant = tryCaptureAsConstant(CGM, CGF, variable)) {
387  info.Captures[variable] = CGBlockInfo::Capture::makeConstant(constant);
388  continue;
389  }
390 
391  // If we have a lifetime qualifier, honor it for capture purposes.
392  // That includes *not* copying it if it's __unsafe_unretained.
393  Qualifiers::ObjCLifetime lifetime =
394  variable->getType().getObjCLifetime();
395  if (lifetime) {
396  switch (lifetime) {
397  case Qualifiers::OCL_None: llvm_unreachable("impossible");
400  break;
401 
404  info.NeedsCopyDispose = true;
405  }
406 
407  // Block pointers require copy/dispose. So do Objective-C pointers.
408  } else if (variable->getType()->isObjCRetainableType()) {
409  // But honor the inert __unsafe_unretained qualifier, which doesn't
410  // actually make it into the type system.
411  if (variable->getType()->isObjCInertUnsafeUnretainedType()) {
412  lifetime = Qualifiers::OCL_ExplicitNone;
413  } else {
414  info.NeedsCopyDispose = true;
415  // used for mrr below.
416  lifetime = Qualifiers::OCL_Strong;
417  }
418 
419  // So do types that require non-trivial copy construction.
420  } else if (CI.hasCopyExpr()) {
421  info.NeedsCopyDispose = true;
422  info.HasCXXObject = true;
423 
424  // And so do types with destructors.
425  } else if (CGM.getLangOpts().CPlusPlus) {
426  if (const CXXRecordDecl *record =
427  variable->getType()->getAsCXXRecordDecl()) {
428  if (!record->hasTrivialDestructor()) {
429  info.HasCXXObject = true;
430  info.NeedsCopyDispose = true;
431  }
432  }
433  }
434 
435  QualType VT = variable->getType();
436 
437  // If the variable is captured by an enclosing block or lambda expression,
438  // use the type of the capture field.
439  if (CGF->BlockInfo && CI.isNested())
440  VT = CGF->BlockInfo->getCapture(variable).fieldType();
441  else if (auto *FD = CGF->LambdaCaptureFields.lookup(variable))
442  VT = FD->getType();
443 
444  CharUnits size = C.getTypeSizeInChars(VT);
445  CharUnits align = C.getDeclAlign(variable);
446 
447  maxFieldAlign = std::max(maxFieldAlign, align);
448 
449  llvm::Type *llvmType =
450  CGM.getTypes().ConvertTypeForMem(VT);
451 
452  layout.push_back(
453  BlockLayoutChunk(align, size, lifetime, &CI, llvmType, VT));
454  }
455 
456  // If that was everything, we're done here.
457  if (layout.empty()) {
458  info.StructureType =
459  llvm::StructType::get(CGM.getLLVMContext(), elementTypes, true);
460  info.CanBeGlobal = true;
461  return;
462  }
463 
464  // Sort the layout by alignment. We have to use a stable sort here
465  // to get reproducible results. There should probably be an
466  // llvm::array_pod_stable_sort.
467  std::stable_sort(layout.begin(), layout.end());
468 
469  // Needed for blocks layout info.
472 
473  CharUnits &blockSize = info.BlockSize;
474  info.BlockAlign = std::max(maxFieldAlign, info.BlockAlign);
475 
476  // Assuming that the first byte in the header is maximally aligned,
477  // get the alignment of the first byte following the header.
478  CharUnits endAlign = getLowBit(blockSize);
479 
480  // If the end of the header isn't satisfactorily aligned for the
481  // maximum thing, look for things that are okay with the header-end
482  // alignment, and keep appending them until we get something that's
483  // aligned right. This algorithm is only guaranteed optimal if
484  // that condition is satisfied at some point; otherwise we can get
485  // things like:
486  // header // next byte has alignment 4
487  // something_with_size_5; // next byte has alignment 1
488  // something_with_alignment_8;
489  // which has 7 bytes of padding, as opposed to the naive solution
490  // which might have less (?).
491  if (endAlign < maxFieldAlign) {
493  li = layout.begin() + 1, le = layout.end();
494 
495  // Look for something that the header end is already
496  // satisfactorily aligned for.
497  for (; li != le && endAlign < li->Alignment; ++li)
498  ;
499 
500  // If we found something that's naturally aligned for the end of
501  // the header, keep adding things...
502  if (li != le) {
504  for (; li != le; ++li) {
505  assert(endAlign >= li->Alignment);
506 
507  li->setIndex(info, elementTypes.size(), blockSize);
508  elementTypes.push_back(li->Type);
509  blockSize += li->Size;
510  endAlign = getLowBit(blockSize);
511 
512  // ...until we get to the alignment of the maximum field.
513  if (endAlign >= maxFieldAlign) {
514  break;
515  }
516  }
517  // Don't re-append everything we just appended.
518  layout.erase(first, li);
519  }
520  }
521 
522  assert(endAlign == getLowBit(blockSize));
523 
524  // At this point, we just have to add padding if the end align still
525  // isn't aligned right.
526  if (endAlign < maxFieldAlign) {
527  CharUnits newBlockSize = blockSize.alignTo(maxFieldAlign);
528  CharUnits padding = newBlockSize - blockSize;
529 
530  // If we haven't yet added any fields, remember that there was an
531  // initial gap; this need to go into the block layout bit map.
532  if (blockSize == info.BlockHeaderForcedGapOffset) {
533  info.BlockHeaderForcedGapSize = padding;
534  }
535 
536  elementTypes.push_back(llvm::ArrayType::get(CGM.Int8Ty,
537  padding.getQuantity()));
538  blockSize = newBlockSize;
539  endAlign = getLowBit(blockSize); // might be > maxFieldAlign
540  }
541 
542  assert(endAlign >= maxFieldAlign);
543  assert(endAlign == getLowBit(blockSize));
544  // Slam everything else on now. This works because they have
545  // strictly decreasing alignment and we expect that size is always a
546  // multiple of alignment.
548  li = layout.begin(), le = layout.end(); li != le; ++li) {
549  if (endAlign < li->Alignment) {
550  // size may not be multiple of alignment. This can only happen with
551  // an over-aligned variable. We will be adding a padding field to
552  // make the size be multiple of alignment.
553  CharUnits padding = li->Alignment - endAlign;
554  elementTypes.push_back(llvm::ArrayType::get(CGM.Int8Ty,
555  padding.getQuantity()));
556  blockSize += padding;
557  endAlign = getLowBit(blockSize);
558  }
559  assert(endAlign >= li->Alignment);
560  li->setIndex(info, elementTypes.size(), blockSize);
561  elementTypes.push_back(li->Type);
562  blockSize += li->Size;
563  endAlign = getLowBit(blockSize);
564  }
565 
566  info.StructureType =
567  llvm::StructType::get(CGM.getLLVMContext(), elementTypes, true);
568 }
569 
570 /// Enter the scope of a block. This should be run at the entrance to
571 /// a full-expression so that the block's cleanups are pushed at the
572 /// right place in the stack.
573 static void enterBlockScope(CodeGenFunction &CGF, BlockDecl *block) {
574  assert(CGF.HaveInsertPoint());
575 
576  // Allocate the block info and place it at the head of the list.
577  CGBlockInfo &blockInfo =
578  *new CGBlockInfo(block, CGF.CurFn->getName());
579  blockInfo.NextBlockInfo = CGF.FirstBlockInfo;
580  CGF.FirstBlockInfo = &blockInfo;
581 
582  // Compute information about the layout, etc., of this block,
583  // pushing cleanups as necessary.
584  computeBlockInfo(CGF.CGM, &CGF, blockInfo);
585 
586  // Nothing else to do if it can be global.
587  if (blockInfo.CanBeGlobal) return;
588 
589  // Make the allocation for the block.
590  blockInfo.LocalAddress = CGF.CreateTempAlloca(blockInfo.StructureType,
591  blockInfo.BlockAlign, "block");
592 
593  // If there are cleanups to emit, enter them (but inactive).
594  if (!blockInfo.NeedsCopyDispose) return;
595 
596  // Walk through the captures (in order) and find the ones not
597  // captured by constant.
598  for (const auto &CI : block->captures()) {
599  // Ignore __block captures; there's nothing special in the
600  // on-stack block that we need to do for them.
601  if (CI.isByRef()) continue;
602 
603  // Ignore variables that are constant-captured.
604  const VarDecl *variable = CI.getVariable();
605  CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
606  if (capture.isConstant()) continue;
607 
608  // Ignore objects that aren't destructed.
609  QualType::DestructionKind dtorKind =
610  variable->getType().isDestructedType();
611  if (dtorKind == QualType::DK_none) continue;
612 
613  CodeGenFunction::Destroyer *destroyer;
614 
615  // Block captures count as local values and have imprecise semantics.
616  // They also can't be arrays, so need to worry about that.
617  if (dtorKind == QualType::DK_objc_strong_lifetime) {
619  } else {
620  destroyer = CGF.getDestroyer(dtorKind);
621  }
622 
623  // GEP down to the address.
624  Address addr = CGF.Builder.CreateStructGEP(blockInfo.LocalAddress,
625  capture.getIndex(),
626  capture.getOffset());
627 
628  // We can use that GEP as the dominating IP.
629  if (!blockInfo.DominatingIP)
630  blockInfo.DominatingIP = cast<llvm::Instruction>(addr.getPointer());
631 
632  CleanupKind cleanupKind = InactiveNormalCleanup;
633  bool useArrayEHCleanup = CGF.needsEHCleanup(dtorKind);
634  if (useArrayEHCleanup)
635  cleanupKind = InactiveNormalAndEHCleanup;
636 
637  CGF.pushDestroy(cleanupKind, addr, variable->getType(),
638  destroyer, useArrayEHCleanup);
639 
640  // Remember where that cleanup was.
641  capture.setCleanup(CGF.EHStack.stable_begin());
642  }
643 }
644 
645 /// Enter a full-expression with a non-trivial number of objects to
646 /// clean up. This is in this file because, at the moment, the only
647 /// kind of cleanup object is a BlockDecl*.
649  assert(E->getNumObjects() != 0);
652  i = cleanups.begin(), e = cleanups.end(); i != e; ++i) {
653  enterBlockScope(*this, *i);
654  }
655 }
656 
657 /// Find the layout for the given block in a linked list and remove it.
659  const BlockDecl *block) {
660  while (true) {
661  assert(head && *head);
662  CGBlockInfo *cur = *head;
663 
664  // If this is the block we're looking for, splice it out of the list.
665  if (cur->getBlockDecl() == block) {
666  *head = cur->NextBlockInfo;
667  return cur;
668  }
669 
670  head = &cur->NextBlockInfo;
671  }
672 }
673 
674 /// Destroy a chain of block layouts.
676  assert(head && "destroying an empty chain");
677  do {
678  CGBlockInfo *cur = head;
679  head = cur->NextBlockInfo;
680  delete cur;
681  } while (head != nullptr);
682 }
683 
684 /// Emit a block literal expression in the current function.
686  // If the block has no captures, we won't have a pre-computed
687  // layout for it.
688  if (!blockExpr->getBlockDecl()->hasCaptures()) {
689  if (llvm::Constant *Block = CGM.getAddrOfGlobalBlockIfEmitted(blockExpr))
690  return Block;
691  CGBlockInfo blockInfo(blockExpr->getBlockDecl(), CurFn->getName());
692  computeBlockInfo(CGM, this, blockInfo);
693  blockInfo.BlockExpression = blockExpr;
694  return EmitBlockLiteral(blockInfo);
695  }
696 
697  // Find the block info for this block and take ownership of it.
698  std::unique_ptr<CGBlockInfo> blockInfo;
699  blockInfo.reset(findAndRemoveBlockInfo(&FirstBlockInfo,
700  blockExpr->getBlockDecl()));
701 
702  blockInfo->BlockExpression = blockExpr;
703  return EmitBlockLiteral(*blockInfo);
704 }
705 
707  // Using the computed layout, generate the actual block function.
708  bool isLambdaConv = blockInfo.getBlockDecl()->isConversionFromLambda();
709  llvm::Constant *blockFn
710  = CodeGenFunction(CGM, true).GenerateBlockFunction(CurGD, blockInfo,
711  LocalDeclMap,
712  isLambdaConv);
713  blockFn = llvm::ConstantExpr::getBitCast(blockFn, VoidPtrTy);
714 
715  // If there is nothing to capture, we can emit this as a global block.
716  if (blockInfo.CanBeGlobal)
717  return buildGlobalBlock(CGM, blockInfo, blockFn);
718 
719  // Otherwise, we have to emit this as a local block.
720 
721  llvm::Constant *isa = CGM.getNSConcreteStackBlock();
722  isa = llvm::ConstantExpr::getBitCast(isa, VoidPtrTy);
723 
724  // Build the block descriptor.
725  llvm::Constant *descriptor = buildBlockDescriptor(CGM, blockInfo);
726 
727  Address blockAddr = blockInfo.LocalAddress;
728  assert(blockAddr.isValid() && "block has no address!");
729 
730  // Compute the initial on-stack block flags.
733  if (blockInfo.NeedsCopyDispose) flags |= BLOCK_HAS_COPY_DISPOSE;
734  if (blockInfo.HasCXXObject) flags |= BLOCK_HAS_CXX_OBJ;
735  if (blockInfo.UsesStret) flags |= BLOCK_USE_STRET;
736 
737  auto projectField =
738  [&](unsigned index, CharUnits offset, const Twine &name) -> Address {
739  return Builder.CreateStructGEP(blockAddr, index, offset, name);
740  };
741  auto storeField =
742  [&](llvm::Value *value, unsigned index, CharUnits offset,
743  const Twine &name) {
744  Builder.CreateStore(value, projectField(index, offset, name));
745  };
746 
747  // Initialize the block header.
748  {
749  // We assume all the header fields are densely packed.
750  unsigned index = 0;
751  CharUnits offset;
752  auto addHeaderField =
753  [&](llvm::Value *value, CharUnits size, const Twine &name) {
754  storeField(value, index, offset, name);
755  offset += size;
756  index++;
757  };
758 
759  addHeaderField(isa, getPointerSize(), "block.isa");
760  addHeaderField(llvm::ConstantInt::get(IntTy, flags.getBitMask()),
761  getIntSize(), "block.flags");
762  addHeaderField(llvm::ConstantInt::get(IntTy, 0),
763  getIntSize(), "block.reserved");
764  addHeaderField(blockFn, getPointerSize(), "block.invoke");
765  addHeaderField(descriptor, getPointerSize(), "block.descriptor");
766  }
767 
768  // Finally, capture all the values into the block.
769  const BlockDecl *blockDecl = blockInfo.getBlockDecl();
770 
771  // First, 'this'.
772  if (blockDecl->capturesCXXThis()) {
773  Address addr = projectField(blockInfo.CXXThisIndex, blockInfo.CXXThisOffset,
774  "block.captured-this.addr");
775  Builder.CreateStore(LoadCXXThis(), addr);
776  }
777 
778  // Next, captured variables.
779  for (const auto &CI : blockDecl->captures()) {
780  const VarDecl *variable = CI.getVariable();
781  const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
782 
783  // Ignore constant captures.
784  if (capture.isConstant()) continue;
785 
786  QualType type = capture.fieldType();
787 
788  // This will be a [[type]]*, except that a byref entry will just be
789  // an i8**.
790  Address blockField =
791  projectField(capture.getIndex(), capture.getOffset(), "block.captured");
792 
793  // Compute the address of the thing we're going to move into the
794  // block literal.
795  Address src = Address::invalid();
796 
797  if (blockDecl->isConversionFromLambda()) {
798  // The lambda capture in a lambda's conversion-to-block-pointer is
799  // special; we'll simply emit it directly.
800  src = Address::invalid();
801  } else if (CI.isByRef()) {
802  if (BlockInfo && CI.isNested()) {
803  // We need to use the capture from the enclosing block.
804  const CGBlockInfo::Capture &enclosingCapture =
805  BlockInfo->getCapture(variable);
806 
807  // This is a [[type]]*, except that a byref entry wil just be an i8**.
808  src = Builder.CreateStructGEP(LoadBlockStruct(),
809  enclosingCapture.getIndex(),
810  enclosingCapture.getOffset(),
811  "block.capture.addr");
812  } else {
813  auto I = LocalDeclMap.find(variable);
814  assert(I != LocalDeclMap.end());
815  src = I->second;
816  }
817  } else {
818  DeclRefExpr declRef(const_cast<VarDecl *>(variable),
819  /*RefersToEnclosingVariableOrCapture*/ CI.isNested(),
821  SourceLocation());
822  src = EmitDeclRefLValue(&declRef).getAddress();
823  };
824 
825  // For byrefs, we just write the pointer to the byref struct into
826  // the block field. There's no need to chase the forwarding
827  // pointer at this point, since we're building something that will
828  // live a shorter life than the stack byref anyway.
829  if (CI.isByRef()) {
830  // Get a void* that points to the byref struct.
831  llvm::Value *byrefPointer;
832  if (CI.isNested())
833  byrefPointer = Builder.CreateLoad(src, "byref.capture");
834  else
835  byrefPointer = Builder.CreateBitCast(src.getPointer(), VoidPtrTy);
836 
837  // Write that void* into the capture field.
838  Builder.CreateStore(byrefPointer, blockField);
839 
840  // If we have a copy constructor, evaluate that into the block field.
841  } else if (const Expr *copyExpr = CI.getCopyExpr()) {
842  if (blockDecl->isConversionFromLambda()) {
843  // If we have a lambda conversion, emit the expression
844  // directly into the block instead.
845  AggValueSlot Slot =
846  AggValueSlot::forAddr(blockField, Qualifiers(),
850  EmitAggExpr(copyExpr, Slot);
851  } else {
852  EmitSynthesizedCXXCopyCtor(blockField, src, copyExpr);
853  }
854 
855  // If it's a reference variable, copy the reference into the block field.
856  } else if (type->isReferenceType()) {
857  Builder.CreateStore(src.getPointer(), blockField);
858 
859  // If this is an ARC __strong block-pointer variable, don't do a
860  // block copy.
861  //
862  // TODO: this can be generalized into the normal initialization logic:
863  // we should never need to do a block-copy when initializing a local
864  // variable, because the local variable's lifetime should be strictly
865  // contained within the stack block's.
866  } else if (type.getObjCLifetime() == Qualifiers::OCL_Strong &&
867  type->isBlockPointerType()) {
868  // Load the block and do a simple retain.
869  llvm::Value *value = Builder.CreateLoad(src, "block.captured_block");
870  value = EmitARCRetainNonBlock(value);
871 
872  // Do a primitive store to the block field.
873  Builder.CreateStore(value, blockField);
874 
875  // Otherwise, fake up a POD copy into the block field.
876  } else {
877  // Fake up a new variable so that EmitScalarInit doesn't think
878  // we're referring to the variable in its own initializer.
879  ImplicitParamDecl blockFieldPseudoVar(getContext(), /*DC*/ nullptr,
880  SourceLocation(), /*name*/ nullptr,
881  type);
882 
883  // We use one of these or the other depending on whether the
884  // reference is nested.
885  DeclRefExpr declRef(const_cast<VarDecl *>(variable),
886  /*RefersToEnclosingVariableOrCapture*/ CI.isNested(),
888 
889  ImplicitCastExpr l2r(ImplicitCastExpr::OnStack, type, CK_LValueToRValue,
890  &declRef, VK_RValue);
891  // FIXME: Pass a specific location for the expr init so that the store is
892  // attributed to a reasonable location - otherwise it may be attributed to
893  // locations of subexpressions in the initialization.
894  EmitExprAsInit(&l2r, &blockFieldPseudoVar,
895  MakeAddrLValue(blockField, type, AlignmentSource::Decl),
896  /*captured by init*/ false);
897  }
898 
899  // Activate the cleanup if layout pushed one.
900  if (!CI.isByRef()) {
902  if (cleanup.isValid())
903  ActivateCleanupBlock(cleanup, blockInfo.DominatingIP);
904  }
905  }
906 
907  // Cast to the converted block-pointer type, which happens (somewhat
908  // unfortunately) to be a pointer to function type.
909  llvm::Value *result =
910  Builder.CreateBitCast(blockAddr.getPointer(),
911  ConvertType(blockInfo.getBlockExpr()->getType()));
912 
913  return result;
914 }
915 
916 
918  if (BlockDescriptorType)
919  return BlockDescriptorType;
920 
921  llvm::Type *UnsignedLongTy =
922  getTypes().ConvertType(getContext().UnsignedLongTy);
923 
924  // struct __block_descriptor {
925  // unsigned long reserved;
926  // unsigned long block_size;
927  //
928  // // later, the following will be added
929  //
930  // struct {
931  // void (*copyHelper)();
932  // void (*copyHelper)();
933  // } helpers; // !!! optional
934  //
935  // const char *signature; // the block signature
936  // const char *layout; // reserved
937  // };
938  BlockDescriptorType =
939  llvm::StructType::create("struct.__block_descriptor",
940  UnsignedLongTy, UnsignedLongTy, nullptr);
941 
942  // Now form a pointer to that.
943  unsigned AddrSpace = 0;
944  if (getLangOpts().OpenCL)
945  AddrSpace = getContext().getTargetAddressSpace(LangAS::opencl_constant);
946  BlockDescriptorType = llvm::PointerType::get(BlockDescriptorType, AddrSpace);
947  return BlockDescriptorType;
948 }
949 
951  if (GenericBlockLiteralType)
952  return GenericBlockLiteralType;
953 
954  llvm::Type *BlockDescPtrTy = getBlockDescriptorType();
955 
956  // struct __block_literal_generic {
957  // void *__isa;
958  // int __flags;
959  // int __reserved;
960  // void (*__invoke)(void *);
961  // struct __block_descriptor *__descriptor;
962  // };
963  GenericBlockLiteralType =
964  llvm::StructType::create("struct.__block_literal_generic",
965  VoidPtrTy, IntTy, IntTy, VoidPtrTy,
966  BlockDescPtrTy, nullptr);
967 
968  return GenericBlockLiteralType;
969 }
970 
972  ReturnValueSlot ReturnValue) {
973  const BlockPointerType *BPT =
975 
976  llvm::Value *BlockPtr = EmitScalarExpr(E->getCallee());
977 
978  // Get a pointer to the generic block literal.
979  llvm::Type *BlockLiteralTy =
980  llvm::PointerType::getUnqual(CGM.getGenericBlockLiteralType());
981 
982  // Bitcast the callee to a block literal.
983  BlockPtr = Builder.CreateBitCast(BlockPtr, BlockLiteralTy, "block.literal");
984 
985  // Get the function pointer from the literal.
986  llvm::Value *FuncPtr =
987  Builder.CreateStructGEP(CGM.getGenericBlockLiteralType(), BlockPtr, 3);
988 
989  BlockPtr = Builder.CreateBitCast(BlockPtr, VoidPtrTy);
990 
991  // Add the block literal.
992  CallArgList Args;
993  Args.add(RValue::get(BlockPtr), getContext().VoidPtrTy);
994 
995  QualType FnType = BPT->getPointeeType();
996 
997  // And the rest of the arguments.
998  EmitCallArgs(Args, FnType->getAs<FunctionProtoType>(), E->arguments());
999 
1000  // Load the function.
1001  llvm::Value *Func = Builder.CreateAlignedLoad(FuncPtr, getPointerAlign());
1002 
1003  const FunctionType *FuncTy = FnType->castAs<FunctionType>();
1004  const CGFunctionInfo &FnInfo =
1005  CGM.getTypes().arrangeBlockFunctionCall(Args, FuncTy);
1006 
1007  // Cast the function pointer to the right type.
1008  llvm::Type *BlockFTy = CGM.getTypes().GetFunctionType(FnInfo);
1009 
1010  llvm::Type *BlockFTyPtr = llvm::PointerType::getUnqual(BlockFTy);
1011  Func = Builder.CreateBitCast(Func, BlockFTyPtr);
1012 
1013  // Prepare the callee.
1014  CGCallee Callee(CGCalleeInfo(), Func);
1015 
1016  // And call the block.
1017  return EmitCall(FnInfo, Callee, ReturnValue, Args);
1018 }
1019 
1021  bool isByRef) {
1022  assert(BlockInfo && "evaluating block ref without block information?");
1023  const CGBlockInfo::Capture &capture = BlockInfo->getCapture(variable);
1024 
1025  // Handle constant captures.
1026  if (capture.isConstant()) return LocalDeclMap.find(variable)->second;
1027 
1028  Address addr =
1029  Builder.CreateStructGEP(LoadBlockStruct(), capture.getIndex(),
1030  capture.getOffset(), "block.capture.addr");
1031 
1032  if (isByRef) {
1033  // addr should be a void** right now. Load, then cast the result
1034  // to byref*.
1035 
1036  auto &byrefInfo = getBlockByrefInfo(variable);
1037  addr = Address(Builder.CreateLoad(addr), byrefInfo.ByrefAlignment);
1038 
1039  auto byrefPointerType = llvm::PointerType::get(byrefInfo.Type, 0);
1040  addr = Builder.CreateBitCast(addr, byrefPointerType, "byref.addr");
1041 
1042  addr = emitBlockByrefAddress(addr, byrefInfo, /*follow*/ true,
1043  variable->getName());
1044  }
1045 
1046  if (auto refType = capture.fieldType()->getAs<ReferenceType>())
1047  addr = EmitLoadOfReference(addr, refType);
1048 
1049  return addr;
1050 }
1051 
1053  llvm::Constant *Addr) {
1054  bool Ok = EmittedGlobalBlocks.insert(std::make_pair(BE, Addr)).second;
1055  (void)Ok;
1056  assert(Ok && "Trying to replace an already-existing global block!");
1057 }
1058 
1059 llvm::Constant *
1061  StringRef Name) {
1062  if (llvm::Constant *Block = getAddrOfGlobalBlockIfEmitted(BE))
1063  return Block;
1064 
1065  CGBlockInfo blockInfo(BE->getBlockDecl(), Name);
1066  blockInfo.BlockExpression = BE;
1067 
1068  // Compute information about the layout, etc., of this block.
1069  computeBlockInfo(*this, nullptr, blockInfo);
1070 
1071  // Using that metadata, generate the actual block function.
1072  llvm::Constant *blockFn;
1073  {
1074  CodeGenFunction::DeclMapTy LocalDeclMap;
1076  blockInfo,
1077  LocalDeclMap,
1078  false);
1079  }
1080  blockFn = llvm::ConstantExpr::getBitCast(blockFn, VoidPtrTy);
1081 
1082  return buildGlobalBlock(*this, blockInfo, blockFn);
1083 }
1084 
1085 static llvm::Constant *buildGlobalBlock(CodeGenModule &CGM,
1086  const CGBlockInfo &blockInfo,
1087  llvm::Constant *blockFn) {
1088  assert(blockInfo.CanBeGlobal);
1089  // Callers should detect this case on their own: calling this function
1090  // generally requires computing layout information, which is a waste of time
1091  // if we've already emitted this block.
1092  assert(!CGM.getAddrOfGlobalBlockIfEmitted(blockInfo.BlockExpression) &&
1093  "Refusing to re-emit a global block.");
1094 
1095  // Generate the constants for the block literal initializer.
1096  ConstantInitBuilder builder(CGM);
1097  auto fields = builder.beginStruct();
1098 
1099  // isa
1100  fields.add(CGM.getNSConcreteGlobalBlock());
1101 
1102  // __flags
1104  if (blockInfo.UsesStret) flags |= BLOCK_USE_STRET;
1105 
1106  fields.addInt(CGM.IntTy, flags.getBitMask());
1107 
1108  // Reserved
1109  fields.addInt(CGM.IntTy, 0);
1110 
1111  // Function
1112  fields.add(blockFn);
1113 
1114  // Descriptor
1115  fields.add(buildBlockDescriptor(CGM, blockInfo));
1116 
1117  llvm::Constant *literal =
1118  fields.finishAndCreateGlobal("__block_literal_global",
1119  blockInfo.BlockAlign,
1120  /*constant*/ true);
1121 
1122  // Return a constant of the appropriately-casted type.
1123  llvm::Type *RequiredType =
1124  CGM.getTypes().ConvertType(blockInfo.getBlockExpr()->getType());
1125  llvm::Constant *Result =
1126  llvm::ConstantExpr::getBitCast(literal, RequiredType);
1127  CGM.setAddrOfGlobalBlock(blockInfo.BlockExpression, Result);
1128  return Result;
1129 }
1130 
1132  unsigned argNum,
1133  llvm::Value *arg) {
1134  assert(BlockInfo && "not emitting prologue of block invocation function?!");
1135 
1136  llvm::Value *localAddr = nullptr;
1137  if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1138  // Allocate a stack slot to let the debug info survive the RA.
1139  Address alloc = CreateMemTemp(D->getType(), D->getName() + ".addr");
1140  Builder.CreateStore(arg, alloc);
1141  localAddr = Builder.CreateLoad(alloc);
1142  }
1143 
1144  if (CGDebugInfo *DI = getDebugInfo()) {
1145  if (CGM.getCodeGenOpts().getDebugInfo() >=
1147  DI->setLocation(D->getLocation());
1148  DI->EmitDeclareOfBlockLiteralArgVariable(*BlockInfo, arg, argNum,
1149  localAddr, Builder);
1150  }
1151  }
1152 
1153  SourceLocation StartLoc = BlockInfo->getBlockExpr()->getBody()->getLocStart();
1154  ApplyDebugLocation Scope(*this, StartLoc);
1155 
1156  // Instead of messing around with LocalDeclMap, just set the value
1157  // directly as BlockPointer.
1158  BlockPointer = Builder.CreateBitCast(arg,
1159  BlockInfo->StructureType->getPointerTo(),
1160  "block");
1161 }
1162 
1164  assert(BlockInfo && "not in a block invocation function!");
1165  assert(BlockPointer && "no block pointer set!");
1166  return Address(BlockPointer, BlockInfo->BlockAlign);
1167 }
1168 
1169 llvm::Function *
1171  const CGBlockInfo &blockInfo,
1172  const DeclMapTy &ldm,
1173  bool IsLambdaConversionToBlock) {
1174  const BlockDecl *blockDecl = blockInfo.getBlockDecl();
1175 
1176  CurGD = GD;
1177 
1178  CurEHLocation = blockInfo.getBlockExpr()->getLocEnd();
1179 
1180  BlockInfo = &blockInfo;
1181 
1182  // Arrange for local static and local extern declarations to appear
1183  // to be local to this function as well, in case they're directly
1184  // referenced in a block.
1185  for (DeclMapTy::const_iterator i = ldm.begin(), e = ldm.end(); i != e; ++i) {
1186  const auto *var = dyn_cast<VarDecl>(i->first);
1187  if (var && !var->hasLocalStorage())
1188  setAddrOfLocalVar(var, i->second);
1189  }
1190 
1191  // Begin building the function declaration.
1192 
1193  // Build the argument list.
1194  FunctionArgList args;
1195 
1196  // The first argument is the block pointer. Just take it as a void*
1197  // and cast it later.
1198  QualType selfTy = getContext().VoidPtrTy;
1199  IdentifierInfo *II = &CGM.getContext().Idents.get(".block_descriptor");
1200 
1201  ImplicitParamDecl selfDecl(getContext(), const_cast<BlockDecl*>(blockDecl),
1202  SourceLocation(), II, selfTy);
1203  args.push_back(&selfDecl);
1204 
1205  // Now add the rest of the parameters.
1206  args.append(blockDecl->param_begin(), blockDecl->param_end());
1207 
1208  // Create the function declaration.
1209  const FunctionProtoType *fnType = blockInfo.getBlockExpr()->getFunctionType();
1210  const CGFunctionInfo &fnInfo =
1211  CGM.getTypes().arrangeBlockFunctionDeclaration(fnType, args);
1212  if (CGM.ReturnSlotInterferesWithArgs(fnInfo))
1213  blockInfo.UsesStret = true;
1214 
1215  llvm::FunctionType *fnLLVMType = CGM.getTypes().GetFunctionType(fnInfo);
1216 
1217  StringRef name = CGM.getBlockMangledName(GD, blockDecl);
1218  llvm::Function *fn = llvm::Function::Create(
1219  fnLLVMType, llvm::GlobalValue::InternalLinkage, name, &CGM.getModule());
1220  CGM.SetInternalFunctionAttributes(blockDecl, fn, fnInfo);
1221 
1222  // Begin generating the function.
1223  StartFunction(blockDecl, fnType->getReturnType(), fn, fnInfo, args,
1224  blockDecl->getLocation(),
1225  blockInfo.getBlockExpr()->getBody()->getLocStart());
1226 
1227  // Okay. Undo some of what StartFunction did.
1228 
1229  // At -O0 we generate an explicit alloca for the BlockPointer, so the RA
1230  // won't delete the dbg.declare intrinsics for captured variables.
1231  llvm::Value *BlockPointerDbgLoc = BlockPointer;
1232  if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1233  // Allocate a stack slot for it, so we can point the debugger to it
1234  Address Alloca = CreateTempAlloca(BlockPointer->getType(),
1235  getPointerAlign(),
1236  "block.addr");
1237  // Set the DebugLocation to empty, so the store is recognized as a
1238  // frame setup instruction by llvm::DwarfDebug::beginFunction().
1239  auto NL = ApplyDebugLocation::CreateEmpty(*this);
1240  Builder.CreateStore(BlockPointer, Alloca);
1241  BlockPointerDbgLoc = Alloca.getPointer();
1242  }
1243 
1244  // If we have a C++ 'this' reference, go ahead and force it into
1245  // existence now.
1246  if (blockDecl->capturesCXXThis()) {
1247  Address addr =
1248  Builder.CreateStructGEP(LoadBlockStruct(), blockInfo.CXXThisIndex,
1249  blockInfo.CXXThisOffset, "block.captured-this");
1250  CXXThisValue = Builder.CreateLoad(addr, "this");
1251  }
1252 
1253  // Also force all the constant captures.
1254  for (const auto &CI : blockDecl->captures()) {
1255  const VarDecl *variable = CI.getVariable();
1256  const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
1257  if (!capture.isConstant()) continue;
1258 
1259  CharUnits align = getContext().getDeclAlign(variable);
1260  Address alloca =
1261  CreateMemTemp(variable->getType(), align, "block.captured-const");
1262 
1263  Builder.CreateStore(capture.getConstant(), alloca);
1264 
1265  setAddrOfLocalVar(variable, alloca);
1266  }
1267 
1268  // Save a spot to insert the debug information for all the DeclRefExprs.
1269  llvm::BasicBlock *entry = Builder.GetInsertBlock();
1270  llvm::BasicBlock::iterator entry_ptr = Builder.GetInsertPoint();
1271  --entry_ptr;
1272 
1273  if (IsLambdaConversionToBlock)
1274  EmitLambdaBlockInvokeBody();
1275  else {
1276  PGO.assignRegionCounters(GlobalDecl(blockDecl), fn);
1277  incrementProfileCounter(blockDecl->getBody());
1278  EmitStmt(blockDecl->getBody());
1279  }
1280 
1281  // Remember where we were...
1282  llvm::BasicBlock *resume = Builder.GetInsertBlock();
1283 
1284  // Go back to the entry.
1285  ++entry_ptr;
1286  Builder.SetInsertPoint(entry, entry_ptr);
1287 
1288  // Emit debug information for all the DeclRefExprs.
1289  // FIXME: also for 'this'
1290  if (CGDebugInfo *DI = getDebugInfo()) {
1291  for (const auto &CI : blockDecl->captures()) {
1292  const VarDecl *variable = CI.getVariable();
1293  DI->EmitLocation(Builder, variable->getLocation());
1294 
1295  if (CGM.getCodeGenOpts().getDebugInfo() >=
1297  const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
1298  if (capture.isConstant()) {
1299  auto addr = LocalDeclMap.find(variable)->second;
1300  DI->EmitDeclareOfAutoVariable(variable, addr.getPointer(),
1301  Builder);
1302  continue;
1303  }
1304 
1305  DI->EmitDeclareOfBlockDeclRefVariable(
1306  variable, BlockPointerDbgLoc, Builder, blockInfo,
1307  entry_ptr == entry->end() ? nullptr : &*entry_ptr);
1308  }
1309  }
1310  // Recover location if it was changed in the above loop.
1311  DI->EmitLocation(Builder,
1312  cast<CompoundStmt>(blockDecl->getBody())->getRBracLoc());
1313  }
1314 
1315  // And resume where we left off.
1316  if (resume == nullptr)
1317  Builder.ClearInsertionPoint();
1318  else
1319  Builder.SetInsertPoint(resume);
1320 
1321  FinishFunction(cast<CompoundStmt>(blockDecl->getBody())->getRBracLoc());
1322 
1323  return fn;
1324 }
1325 
1326 /*
1327  notes.push_back(HelperInfo());
1328  HelperInfo &note = notes.back();
1329  note.index = capture.getIndex();
1330  note.RequiresCopying = (ci->hasCopyExpr() || BlockRequiresCopying(type));
1331  note.cxxbar_import = ci->getCopyExpr();
1332 
1333  if (ci->isByRef()) {
1334  note.flag = BLOCK_FIELD_IS_BYREF;
1335  if (type.isObjCGCWeak())
1336  note.flag |= BLOCK_FIELD_IS_WEAK;
1337  } else if (type->isBlockPointerType()) {
1338  note.flag = BLOCK_FIELD_IS_BLOCK;
1339  } else {
1340  note.flag = BLOCK_FIELD_IS_OBJECT;
1341  }
1342  */
1343 
1344 /// Generate the copy-helper function for a block closure object:
1345 /// static void block_copy_helper(block_t *dst, block_t *src);
1346 /// The runtime will have previously initialized 'dst' by doing a
1347 /// bit-copy of 'src'.
1348 ///
1349 /// Note that this copies an entire block closure object to the heap;
1350 /// it should not be confused with a 'byref copy helper', which moves
1351 /// the contents of an individual __block variable to the heap.
1352 llvm::Constant *
1354  ASTContext &C = getContext();
1355 
1356  FunctionArgList args;
1357  ImplicitParamDecl dstDecl(getContext(), nullptr, SourceLocation(), nullptr,
1358  C.VoidPtrTy);
1359  args.push_back(&dstDecl);
1360  ImplicitParamDecl srcDecl(getContext(), nullptr, SourceLocation(), nullptr,
1361  C.VoidPtrTy);
1362  args.push_back(&srcDecl);
1363 
1364  const CGFunctionInfo &FI =
1366 
1367  // FIXME: it would be nice if these were mergeable with things with
1368  // identical semantics.
1369  llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
1370 
1371  llvm::Function *Fn =
1373  "__copy_helper_block_", &CGM.getModule());
1374 
1375  IdentifierInfo *II
1376  = &CGM.getContext().Idents.get("__copy_helper_block_");
1377 
1380  SourceLocation(),
1381  SourceLocation(), II, C.VoidTy,
1382  nullptr, SC_Static,
1383  false,
1384  false);
1385 
1386  CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
1387 
1388  auto NL = ApplyDebugLocation::CreateEmpty(*this);
1389  StartFunction(FD, C.VoidTy, Fn, FI, args);
1390  // Create a scope with an artificial location for the body of this function.
1391  auto AL = ApplyDebugLocation::CreateArtificial(*this);
1392  llvm::Type *structPtrTy = blockInfo.StructureType->getPointerTo();
1393 
1394  Address src = GetAddrOfLocalVar(&srcDecl);
1395  src = Address(Builder.CreateLoad(src), blockInfo.BlockAlign);
1396  src = Builder.CreateBitCast(src, structPtrTy, "block.source");
1397 
1398  Address dst = GetAddrOfLocalVar(&dstDecl);
1399  dst = Address(Builder.CreateLoad(dst), blockInfo.BlockAlign);
1400  dst = Builder.CreateBitCast(dst, structPtrTy, "block.dest");
1401 
1402  const BlockDecl *blockDecl = blockInfo.getBlockDecl();
1403 
1404  for (const auto &CI : blockDecl->captures()) {
1405  const VarDecl *variable = CI.getVariable();
1406  QualType type = variable->getType();
1407 
1408  const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
1409  if (capture.isConstant()) continue;
1410 
1411  const Expr *copyExpr = CI.getCopyExpr();
1412  BlockFieldFlags flags;
1413 
1414  bool useARCWeakCopy = false;
1415  bool useARCStrongCopy = false;
1416 
1417  if (copyExpr) {
1418  assert(!CI.isByRef());
1419  // don't bother computing flags
1420 
1421  } else if (CI.isByRef()) {
1422  flags = BLOCK_FIELD_IS_BYREF;
1423  if (type.isObjCGCWeak())
1424  flags |= BLOCK_FIELD_IS_WEAK;
1425 
1426  } else if (type->isObjCRetainableType()) {
1427  flags = BLOCK_FIELD_IS_OBJECT;
1428  bool isBlockPointer = type->isBlockPointerType();
1429  if (isBlockPointer)
1430  flags = BLOCK_FIELD_IS_BLOCK;
1431 
1432  // Special rules for ARC captures:
1433  Qualifiers qs = type.getQualifiers();
1434 
1435  // We need to register __weak direct captures with the runtime.
1436  if (qs.getObjCLifetime() == Qualifiers::OCL_Weak) {
1437  useARCWeakCopy = true;
1438 
1439  // We need to retain the copied value for __strong direct captures.
1440  } else if (qs.getObjCLifetime() == Qualifiers::OCL_Strong) {
1441  // If it's a block pointer, we have to copy the block and
1442  // assign that to the destination pointer, so we might as
1443  // well use _Block_object_assign. Otherwise we can avoid that.
1444  if (!isBlockPointer)
1445  useARCStrongCopy = true;
1446 
1447  // Non-ARC captures of retainable pointers are strong and
1448  // therefore require a call to _Block_object_assign.
1449  } else if (!qs.getObjCLifetime() && !getLangOpts().ObjCAutoRefCount) {
1450  // fall through
1451 
1452  // Otherwise the memcpy is fine.
1453  } else {
1454  continue;
1455  }
1456 
1457  // For all other types, the memcpy is fine.
1458  } else {
1459  continue;
1460  }
1461 
1462  unsigned index = capture.getIndex();
1463  Address srcField = Builder.CreateStructGEP(src, index, capture.getOffset());
1464  Address dstField = Builder.CreateStructGEP(dst, index, capture.getOffset());
1465 
1466  // If there's an explicit copy expression, we do that.
1467  if (copyExpr) {
1468  EmitSynthesizedCXXCopyCtor(dstField, srcField, copyExpr);
1469  } else if (useARCWeakCopy) {
1470  EmitARCCopyWeak(dstField, srcField);
1471  } else {
1472  llvm::Value *srcValue = Builder.CreateLoad(srcField, "blockcopy.src");
1473  if (useARCStrongCopy) {
1474  // At -O0, store null into the destination field (so that the
1475  // storeStrong doesn't over-release) and then call storeStrong.
1476  // This is a workaround to not having an initStrong call.
1477  if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
1478  auto *ty = cast<llvm::PointerType>(srcValue->getType());
1479  llvm::Value *null = llvm::ConstantPointerNull::get(ty);
1480  Builder.CreateStore(null, dstField);
1481  EmitARCStoreStrongCall(dstField, srcValue, true);
1482 
1483  // With optimization enabled, take advantage of the fact that
1484  // the blocks runtime guarantees a memcpy of the block data, and
1485  // just emit a retain of the src field.
1486  } else {
1487  EmitARCRetainNonBlock(srcValue);
1488 
1489  // We don't need this anymore, so kill it. It's not quite
1490  // worth the annoyance to avoid creating it in the first place.
1491  cast<llvm::Instruction>(dstField.getPointer())->eraseFromParent();
1492  }
1493  } else {
1494  srcValue = Builder.CreateBitCast(srcValue, VoidPtrTy);
1495  llvm::Value *dstAddr =
1496  Builder.CreateBitCast(dstField.getPointer(), VoidPtrTy);
1497  llvm::Value *args[] = {
1498  dstAddr, srcValue, llvm::ConstantInt::get(Int32Ty, flags.getBitMask())
1499  };
1500 
1501  bool copyCanThrow = false;
1502  if (CI.isByRef() && variable->getType()->getAsCXXRecordDecl()) {
1503  const Expr *copyExpr =
1504  CGM.getContext().getBlockVarCopyInits(variable);
1505  if (copyExpr) {
1506  copyCanThrow = true; // FIXME: reuse the noexcept logic
1507  }
1508  }
1509 
1510  if (copyCanThrow) {
1511  EmitRuntimeCallOrInvoke(CGM.getBlockObjectAssign(), args);
1512  } else {
1513  EmitNounwindRuntimeCall(CGM.getBlockObjectAssign(), args);
1514  }
1515  }
1516  }
1517  }
1518 
1519  FinishFunction();
1520 
1521  return llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
1522 }
1523 
1524 /// Generate the destroy-helper function for a block closure object:
1525 /// static void block_destroy_helper(block_t *theBlock);
1526 ///
1527 /// Note that this destroys a heap-allocated block closure object;
1528 /// it should not be confused with a 'byref destroy helper', which
1529 /// destroys the heap-allocated contents of an individual __block
1530 /// variable.
1531 llvm::Constant *
1533  ASTContext &C = getContext();
1534 
1535  FunctionArgList args;
1536  ImplicitParamDecl srcDecl(getContext(), nullptr, SourceLocation(), nullptr,
1537  C.VoidPtrTy);
1538  args.push_back(&srcDecl);
1539 
1540  const CGFunctionInfo &FI =
1542 
1543  // FIXME: We'd like to put these into a mergable by content, with
1544  // internal linkage.
1545  llvm::FunctionType *LTy = CGM.getTypes().GetFunctionType(FI);
1546 
1547  llvm::Function *Fn =
1549  "__destroy_helper_block_", &CGM.getModule());
1550 
1551  IdentifierInfo *II
1552  = &CGM.getContext().Idents.get("__destroy_helper_block_");
1553 
1555  SourceLocation(),
1556  SourceLocation(), II, C.VoidTy,
1557  nullptr, SC_Static,
1558  false, false);
1559 
1560  CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
1561 
1562  // Create a scope with an artificial location for the body of this function.
1563  auto NL = ApplyDebugLocation::CreateEmpty(*this);
1564  StartFunction(FD, C.VoidTy, Fn, FI, args);
1565  auto AL = ApplyDebugLocation::CreateArtificial(*this);
1566 
1567  llvm::Type *structPtrTy = blockInfo.StructureType->getPointerTo();
1568 
1569  Address src = GetAddrOfLocalVar(&srcDecl);
1570  src = Address(Builder.CreateLoad(src), blockInfo.BlockAlign);
1571  src = Builder.CreateBitCast(src, structPtrTy, "block");
1572 
1573  const BlockDecl *blockDecl = blockInfo.getBlockDecl();
1574 
1575  CodeGenFunction::RunCleanupsScope cleanups(*this);
1576 
1577  for (const auto &CI : blockDecl->captures()) {
1578  const VarDecl *variable = CI.getVariable();
1579  QualType type = variable->getType();
1580 
1581  const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
1582  if (capture.isConstant()) continue;
1583 
1584  BlockFieldFlags flags;
1585  const CXXDestructorDecl *dtor = nullptr;
1586 
1587  bool useARCWeakDestroy = false;
1588  bool useARCStrongDestroy = false;
1589 
1590  if (CI.isByRef()) {
1591  flags = BLOCK_FIELD_IS_BYREF;
1592  if (type.isObjCGCWeak())
1593  flags |= BLOCK_FIELD_IS_WEAK;
1594  } else if (const CXXRecordDecl *record = type->getAsCXXRecordDecl()) {
1595  if (record->hasTrivialDestructor())
1596  continue;
1597  dtor = record->getDestructor();
1598  } else if (type->isObjCRetainableType()) {
1599  flags = BLOCK_FIELD_IS_OBJECT;
1600  if (type->isBlockPointerType())
1601  flags = BLOCK_FIELD_IS_BLOCK;
1602 
1603  // Special rules for ARC captures.
1604  Qualifiers qs = type.getQualifiers();
1605 
1606  // Use objc_storeStrong for __strong direct captures; the
1607  // dynamic tools really like it when we do this.
1609  useARCStrongDestroy = true;
1610 
1611  // Support __weak direct captures.
1612  } else if (qs.getObjCLifetime() == Qualifiers::OCL_Weak) {
1613  useARCWeakDestroy = true;
1614 
1615  // Non-ARC captures are strong, and we need to use _Block_object_dispose.
1616  } else if (!qs.hasObjCLifetime() && !getLangOpts().ObjCAutoRefCount) {
1617  // fall through
1618 
1619  // Otherwise, we have nothing to do.
1620  } else {
1621  continue;
1622  }
1623  } else {
1624  continue;
1625  }
1626 
1627  Address srcField =
1628  Builder.CreateStructGEP(src, capture.getIndex(), capture.getOffset());
1629 
1630  // If there's an explicit copy expression, we do that.
1631  if (dtor) {
1632  PushDestructorCleanup(dtor, srcField);
1633 
1634  // If this is a __weak capture, emit the release directly.
1635  } else if (useARCWeakDestroy) {
1636  EmitARCDestroyWeak(srcField);
1637 
1638  // Destroy strong objects with a call if requested.
1639  } else if (useARCStrongDestroy) {
1640  EmitARCDestroyStrong(srcField, ARCImpreciseLifetime);
1641 
1642  // Otherwise we call _Block_object_dispose. It wouldn't be too
1643  // hard to just emit this as a cleanup if we wanted to make sure
1644  // that things were done in reverse.
1645  } else {
1646  llvm::Value *value = Builder.CreateLoad(srcField);
1647  value = Builder.CreateBitCast(value, VoidPtrTy);
1648  BuildBlockRelease(value, flags);
1649  }
1650  }
1651 
1652  cleanups.ForceCleanup();
1653 
1654  FinishFunction();
1655 
1656  return llvm::ConstantExpr::getBitCast(Fn, VoidPtrTy);
1657 }
1658 
1659 namespace {
1660 
1661 /// Emits the copy/dispose helper functions for a __block object of id type.
1662 class ObjectByrefHelpers final : public BlockByrefHelpers {
1663  BlockFieldFlags Flags;
1664 
1665 public:
1666  ObjectByrefHelpers(CharUnits alignment, BlockFieldFlags flags)
1667  : BlockByrefHelpers(alignment), Flags(flags) {}
1668 
1669  void emitCopy(CodeGenFunction &CGF, Address destField,
1670  Address srcField) override {
1671  destField = CGF.Builder.CreateBitCast(destField, CGF.VoidPtrTy);
1672 
1673  srcField = CGF.Builder.CreateBitCast(srcField, CGF.VoidPtrPtrTy);
1674  llvm::Value *srcValue = CGF.Builder.CreateLoad(srcField);
1675 
1676  unsigned flags = (Flags | BLOCK_BYREF_CALLER).getBitMask();
1677 
1678  llvm::Value *flagsVal = llvm::ConstantInt::get(CGF.Int32Ty, flags);
1679  llvm::Value *fn = CGF.CGM.getBlockObjectAssign();
1680 
1681  llvm::Value *args[] = { destField.getPointer(), srcValue, flagsVal };
1682  CGF.EmitNounwindRuntimeCall(fn, args);
1683  }
1684 
1685  void emitDispose(CodeGenFunction &CGF, Address field) override {
1686  field = CGF.Builder.CreateBitCast(field, CGF.Int8PtrTy->getPointerTo(0));
1687  llvm::Value *value = CGF.Builder.CreateLoad(field);
1688 
1689  CGF.BuildBlockRelease(value, Flags | BLOCK_BYREF_CALLER);
1690  }
1691 
1692  void profileImpl(llvm::FoldingSetNodeID &id) const override {
1693  id.AddInteger(Flags.getBitMask());
1694  }
1695 };
1696 
1697 /// Emits the copy/dispose helpers for an ARC __block __weak variable.
1698 class ARCWeakByrefHelpers final : public BlockByrefHelpers {
1699 public:
1700  ARCWeakByrefHelpers(CharUnits alignment) : BlockByrefHelpers(alignment) {}
1701 
1702  void emitCopy(CodeGenFunction &CGF, Address destField,
1703  Address srcField) override {
1704  CGF.EmitARCMoveWeak(destField, srcField);
1705  }
1706 
1707  void emitDispose(CodeGenFunction &CGF, Address field) override {
1708  CGF.EmitARCDestroyWeak(field);
1709  }
1710 
1711  void profileImpl(llvm::FoldingSetNodeID &id) const override {
1712  // 0 is distinguishable from all pointers and byref flags
1713  id.AddInteger(0);
1714  }
1715 };
1716 
1717 /// Emits the copy/dispose helpers for an ARC __block __strong variable
1718 /// that's not of block-pointer type.
1719 class ARCStrongByrefHelpers final : public BlockByrefHelpers {
1720 public:
1721  ARCStrongByrefHelpers(CharUnits alignment) : BlockByrefHelpers(alignment) {}
1722 
1723  void emitCopy(CodeGenFunction &CGF, Address destField,
1724  Address srcField) override {
1725  // Do a "move" by copying the value and then zeroing out the old
1726  // variable.
1727 
1728  llvm::Value *value = CGF.Builder.CreateLoad(srcField);
1729 
1730  llvm::Value *null =
1731  llvm::ConstantPointerNull::get(cast<llvm::PointerType>(value->getType()));
1732 
1733  if (CGF.CGM.getCodeGenOpts().OptimizationLevel == 0) {
1734  CGF.Builder.CreateStore(null, destField);
1735  CGF.EmitARCStoreStrongCall(destField, value, /*ignored*/ true);
1736  CGF.EmitARCStoreStrongCall(srcField, null, /*ignored*/ true);
1737  return;
1738  }
1739  CGF.Builder.CreateStore(value, destField);
1740  CGF.Builder.CreateStore(null, srcField);
1741  }
1742 
1743  void emitDispose(CodeGenFunction &CGF, Address field) override {
1745  }
1746 
1747  void profileImpl(llvm::FoldingSetNodeID &id) const override {
1748  // 1 is distinguishable from all pointers and byref flags
1749  id.AddInteger(1);
1750  }
1751 };
1752 
1753 /// Emits the copy/dispose helpers for an ARC __block __strong
1754 /// variable that's of block-pointer type.
1755 class ARCStrongBlockByrefHelpers final : public BlockByrefHelpers {
1756 public:
1757  ARCStrongBlockByrefHelpers(CharUnits alignment)
1758  : BlockByrefHelpers(alignment) {}
1759 
1760  void emitCopy(CodeGenFunction &CGF, Address destField,
1761  Address srcField) override {
1762  // Do the copy with objc_retainBlock; that's all that
1763  // _Block_object_assign would do anyway, and we'd have to pass the
1764  // right arguments to make sure it doesn't get no-op'ed.
1765  llvm::Value *oldValue = CGF.Builder.CreateLoad(srcField);
1766  llvm::Value *copy = CGF.EmitARCRetainBlock(oldValue, /*mandatory*/ true);
1767  CGF.Builder.CreateStore(copy, destField);
1768  }
1769 
1770  void emitDispose(CodeGenFunction &CGF, Address field) override {
1772  }
1773 
1774  void profileImpl(llvm::FoldingSetNodeID &id) const override {
1775  // 2 is distinguishable from all pointers and byref flags
1776  id.AddInteger(2);
1777  }
1778 };
1779 
1780 /// Emits the copy/dispose helpers for a __block variable with a
1781 /// nontrivial copy constructor or destructor.
1782 class CXXByrefHelpers final : public BlockByrefHelpers {
1783  QualType VarType;
1784  const Expr *CopyExpr;
1785 
1786 public:
1787  CXXByrefHelpers(CharUnits alignment, QualType type,
1788  const Expr *copyExpr)
1789  : BlockByrefHelpers(alignment), VarType(type), CopyExpr(copyExpr) {}
1790 
1791  bool needsCopy() const override { return CopyExpr != nullptr; }
1792  void emitCopy(CodeGenFunction &CGF, Address destField,
1793  Address srcField) override {
1794  if (!CopyExpr) return;
1795  CGF.EmitSynthesizedCXXCopyCtor(destField, srcField, CopyExpr);
1796  }
1797 
1798  void emitDispose(CodeGenFunction &CGF, Address field) override {
1799  EHScopeStack::stable_iterator cleanupDepth = CGF.EHStack.stable_begin();
1800  CGF.PushDestructorCleanup(VarType, field);
1801  CGF.PopCleanupBlocks(cleanupDepth);
1802  }
1803 
1804  void profileImpl(llvm::FoldingSetNodeID &id) const override {
1805  id.AddPointer(VarType.getCanonicalType().getAsOpaquePtr());
1806  }
1807 };
1808 } // end anonymous namespace
1809 
1810 static llvm::Constant *
1812  BlockByrefHelpers &generator) {
1813  ASTContext &Context = CGF.getContext();
1814 
1815  QualType R = Context.VoidTy;
1816 
1817  FunctionArgList args;
1818  ImplicitParamDecl dst(CGF.getContext(), nullptr, SourceLocation(), nullptr,
1819  Context.VoidPtrTy);
1820  args.push_back(&dst);
1821 
1822  ImplicitParamDecl src(CGF.getContext(), nullptr, SourceLocation(), nullptr,
1823  Context.VoidPtrTy);
1824  args.push_back(&src);
1825 
1826  const CGFunctionInfo &FI =
1828 
1829  llvm::FunctionType *LTy = CGF.CGM.getTypes().GetFunctionType(FI);
1830 
1831  // FIXME: We'd like to put these into a mergable by content, with
1832  // internal linkage.
1833  llvm::Function *Fn =
1835  "__Block_byref_object_copy_", &CGF.CGM.getModule());
1836 
1837  IdentifierInfo *II
1838  = &Context.Idents.get("__Block_byref_object_copy_");
1839 
1840  FunctionDecl *FD = FunctionDecl::Create(Context,
1841  Context.getTranslationUnitDecl(),
1842  SourceLocation(),
1843  SourceLocation(), II, R, nullptr,
1844  SC_Static,
1845  false, false);
1846 
1847  CGF.CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
1848 
1849  CGF.StartFunction(FD, R, Fn, FI, args);
1850 
1851  if (generator.needsCopy()) {
1852  llvm::Type *byrefPtrType = byrefInfo.Type->getPointerTo(0);
1853 
1854  // dst->x
1855  Address destField = CGF.GetAddrOfLocalVar(&dst);
1856  destField = Address(CGF.Builder.CreateLoad(destField),
1857  byrefInfo.ByrefAlignment);
1858  destField = CGF.Builder.CreateBitCast(destField, byrefPtrType);
1859  destField = CGF.emitBlockByrefAddress(destField, byrefInfo, false,
1860  "dest-object");
1861 
1862  // src->x
1863  Address srcField = CGF.GetAddrOfLocalVar(&src);
1864  srcField = Address(CGF.Builder.CreateLoad(srcField),
1865  byrefInfo.ByrefAlignment);
1866  srcField = CGF.Builder.CreateBitCast(srcField, byrefPtrType);
1867  srcField = CGF.emitBlockByrefAddress(srcField, byrefInfo, false,
1868  "src-object");
1869 
1870  generator.emitCopy(CGF, destField, srcField);
1871  }
1872 
1873  CGF.FinishFunction();
1874 
1875  return llvm::ConstantExpr::getBitCast(Fn, CGF.Int8PtrTy);
1876 }
1877 
1878 /// Build the copy helper for a __block variable.
1879 static llvm::Constant *buildByrefCopyHelper(CodeGenModule &CGM,
1880  const BlockByrefInfo &byrefInfo,
1881  BlockByrefHelpers &generator) {
1882  CodeGenFunction CGF(CGM);
1883  return generateByrefCopyHelper(CGF, byrefInfo, generator);
1884 }
1885 
1886 /// Generate code for a __block variable's dispose helper.
1887 static llvm::Constant *
1889  const BlockByrefInfo &byrefInfo,
1890  BlockByrefHelpers &generator) {
1891  ASTContext &Context = CGF.getContext();
1892  QualType R = Context.VoidTy;
1893 
1894  FunctionArgList args;
1895  ImplicitParamDecl src(CGF.getContext(), nullptr, SourceLocation(), nullptr,
1896  Context.VoidPtrTy);
1897  args.push_back(&src);
1898 
1899  const CGFunctionInfo &FI =
1901 
1902  llvm::FunctionType *LTy = CGF.CGM.getTypes().GetFunctionType(FI);
1903 
1904  // FIXME: We'd like to put these into a mergable by content, with
1905  // internal linkage.
1906  llvm::Function *Fn =
1908  "__Block_byref_object_dispose_",
1909  &CGF.CGM.getModule());
1910 
1911  IdentifierInfo *II
1912  = &Context.Idents.get("__Block_byref_object_dispose_");
1913 
1914  FunctionDecl *FD = FunctionDecl::Create(Context,
1915  Context.getTranslationUnitDecl(),
1916  SourceLocation(),
1917  SourceLocation(), II, R, nullptr,
1918  SC_Static,
1919  false, false);
1920 
1921  CGF.CGM.SetInternalFunctionAttributes(nullptr, Fn, FI);
1922 
1923  CGF.StartFunction(FD, R, Fn, FI, args);
1924 
1925  if (generator.needsDispose()) {
1926  Address addr = CGF.GetAddrOfLocalVar(&src);
1927  addr = Address(CGF.Builder.CreateLoad(addr), byrefInfo.ByrefAlignment);
1928  auto byrefPtrType = byrefInfo.Type->getPointerTo(0);
1929  addr = CGF.Builder.CreateBitCast(addr, byrefPtrType);
1930  addr = CGF.emitBlockByrefAddress(addr, byrefInfo, false, "object");
1931 
1932  generator.emitDispose(CGF, addr);
1933  }
1934 
1935  CGF.FinishFunction();
1936 
1937  return llvm::ConstantExpr::getBitCast(Fn, CGF.Int8PtrTy);
1938 }
1939 
1940 /// Build the dispose helper for a __block variable.
1941 static llvm::Constant *buildByrefDisposeHelper(CodeGenModule &CGM,
1942  const BlockByrefInfo &byrefInfo,
1943  BlockByrefHelpers &generator) {
1944  CodeGenFunction CGF(CGM);
1945  return generateByrefDisposeHelper(CGF, byrefInfo, generator);
1946 }
1947 
1948 /// Lazily build the copy and dispose helpers for a __block variable
1949 /// with the given information.
1950 template <class T>
1951 static T *buildByrefHelpers(CodeGenModule &CGM, const BlockByrefInfo &byrefInfo,
1952  T &&generator) {
1953  llvm::FoldingSetNodeID id;
1954  generator.Profile(id);
1955 
1956  void *insertPos;
1957  BlockByrefHelpers *node
1958  = CGM.ByrefHelpersCache.FindNodeOrInsertPos(id, insertPos);
1959  if (node) return static_cast<T*>(node);
1960 
1961  generator.CopyHelper = buildByrefCopyHelper(CGM, byrefInfo, generator);
1962  generator.DisposeHelper = buildByrefDisposeHelper(CGM, byrefInfo, generator);
1963 
1964  T *copy = new (CGM.getContext()) T(std::forward<T>(generator));
1965  CGM.ByrefHelpersCache.InsertNode(copy, insertPos);
1966  return copy;
1967 }
1968 
1969 /// Build the copy and dispose helpers for the given __block variable
1970 /// emission. Places the helpers in the global cache. Returns null
1971 /// if no helpers are required.
1973 CodeGenFunction::buildByrefHelpers(llvm::StructType &byrefType,
1974  const AutoVarEmission &emission) {
1975  const VarDecl &var = *emission.Variable;
1976  QualType type = var.getType();
1977 
1978  auto &byrefInfo = getBlockByrefInfo(&var);
1979 
1980  // The alignment we care about for the purposes of uniquing byref
1981  // helpers is the alignment of the actual byref value field.
1982  CharUnits valueAlignment =
1983  byrefInfo.ByrefAlignment.alignmentAtOffset(byrefInfo.FieldOffset);
1984 
1985  if (const CXXRecordDecl *record = type->getAsCXXRecordDecl()) {
1986  const Expr *copyExpr = CGM.getContext().getBlockVarCopyInits(&var);
1987  if (!copyExpr && record->hasTrivialDestructor()) return nullptr;
1988 
1990  CGM, byrefInfo, CXXByrefHelpers(valueAlignment, type, copyExpr));
1991  }
1992 
1993  // Otherwise, if we don't have a retainable type, there's nothing to do.
1994  // that the runtime does extra copies.
1995  if (!type->isObjCRetainableType()) return nullptr;
1996 
1997  Qualifiers qs = type.getQualifiers();
1998 
1999  // If we have lifetime, that dominates.
2000  if (Qualifiers::ObjCLifetime lifetime = qs.getObjCLifetime()) {
2001  switch (lifetime) {
2002  case Qualifiers::OCL_None: llvm_unreachable("impossible");
2003 
2004  // These are just bits as far as the runtime is concerned.
2007  return nullptr;
2008 
2009  // Tell the runtime that this is ARC __weak, called by the
2010  // byref routines.
2011  case Qualifiers::OCL_Weak:
2012  return ::buildByrefHelpers(CGM, byrefInfo,
2013  ARCWeakByrefHelpers(valueAlignment));
2014 
2015  // ARC __strong __block variables need to be retained.
2017  // Block pointers need to be copied, and there's no direct
2018  // transfer possible.
2019  if (type->isBlockPointerType()) {
2020  return ::buildByrefHelpers(CGM, byrefInfo,
2021  ARCStrongBlockByrefHelpers(valueAlignment));
2022 
2023  // Otherwise, we transfer ownership of the retain from the stack
2024  // to the heap.
2025  } else {
2026  return ::buildByrefHelpers(CGM, byrefInfo,
2027  ARCStrongByrefHelpers(valueAlignment));
2028  }
2029  }
2030  llvm_unreachable("fell out of lifetime switch!");
2031  }
2032 
2033  BlockFieldFlags flags;
2034  if (type->isBlockPointerType()) {
2035  flags |= BLOCK_FIELD_IS_BLOCK;
2036  } else if (CGM.getContext().isObjCNSObjectType(type) ||
2037  type->isObjCObjectPointerType()) {
2038  flags |= BLOCK_FIELD_IS_OBJECT;
2039  } else {
2040  return nullptr;
2041  }
2042 
2043  if (type.isObjCGCWeak())
2044  flags |= BLOCK_FIELD_IS_WEAK;
2045 
2046  return ::buildByrefHelpers(CGM, byrefInfo,
2047  ObjectByrefHelpers(valueAlignment, flags));
2048 }
2049 
2051  const VarDecl *var,
2052  bool followForward) {
2053  auto &info = getBlockByrefInfo(var);
2054  return emitBlockByrefAddress(baseAddr, info, followForward, var->getName());
2055 }
2056 
2058  const BlockByrefInfo &info,
2059  bool followForward,
2060  const llvm::Twine &name) {
2061  // Chase the forwarding address if requested.
2062  if (followForward) {
2063  Address forwardingAddr =
2064  Builder.CreateStructGEP(baseAddr, 1, getPointerSize(), "forwarding");
2065  baseAddr = Address(Builder.CreateLoad(forwardingAddr), info.ByrefAlignment);
2066  }
2067 
2068  return Builder.CreateStructGEP(baseAddr, info.FieldIndex,
2069  info.FieldOffset, name);
2070 }
2071 
2072 /// BuildByrefInfo - This routine changes a __block variable declared as T x
2073 /// into:
2074 ///
2075 /// struct {
2076 /// void *__isa;
2077 /// void *__forwarding;
2078 /// int32_t __flags;
2079 /// int32_t __size;
2080 /// void *__copy_helper; // only if needed
2081 /// void *__destroy_helper; // only if needed
2082 /// void *__byref_variable_layout;// only if needed
2083 /// char padding[X]; // only if needed
2084 /// T x;
2085 /// } x
2086 ///
2088  auto it = BlockByrefInfos.find(D);
2089  if (it != BlockByrefInfos.end())
2090  return it->second;
2091 
2092  llvm::StructType *byrefType =
2093  llvm::StructType::create(getLLVMContext(),
2094  "struct.__block_byref_" + D->getNameAsString());
2095 
2096  QualType Ty = D->getType();
2097 
2098  CharUnits size;
2100 
2101  // void *__isa;
2102  types.push_back(Int8PtrTy);
2103  size += getPointerSize();
2104 
2105  // void *__forwarding;
2106  types.push_back(llvm::PointerType::getUnqual(byrefType));
2107  size += getPointerSize();
2108 
2109  // int32_t __flags;
2110  types.push_back(Int32Ty);
2111  size += CharUnits::fromQuantity(4);
2112 
2113  // int32_t __size;
2114  types.push_back(Int32Ty);
2115  size += CharUnits::fromQuantity(4);
2116 
2117  // Note that this must match *exactly* the logic in buildByrefHelpers.
2118  bool hasCopyAndDispose = getContext().BlockRequiresCopying(Ty, D);
2119  if (hasCopyAndDispose) {
2120  /// void *__copy_helper;
2121  types.push_back(Int8PtrTy);
2122  size += getPointerSize();
2123 
2124  /// void *__destroy_helper;
2125  types.push_back(Int8PtrTy);
2126  size += getPointerSize();
2127  }
2128 
2129  bool HasByrefExtendedLayout = false;
2130  Qualifiers::ObjCLifetime Lifetime;
2131  if (getContext().getByrefLifetime(Ty, Lifetime, HasByrefExtendedLayout) &&
2132  HasByrefExtendedLayout) {
2133  /// void *__byref_variable_layout;
2134  types.push_back(Int8PtrTy);
2135  size += CharUnits::fromQuantity(PointerSizeInBytes);
2136  }
2137 
2138  // T x;
2139  llvm::Type *varTy = ConvertTypeForMem(Ty);
2140 
2141  bool packed = false;
2142  CharUnits varAlign = getContext().getDeclAlign(D);
2143  CharUnits varOffset = size.alignTo(varAlign);
2144 
2145  // We may have to insert padding.
2146  if (varOffset != size) {
2147  llvm::Type *paddingTy =
2148  llvm::ArrayType::get(Int8Ty, (varOffset - size).getQuantity());
2149 
2150  types.push_back(paddingTy);
2151  size = varOffset;
2152 
2153  // Conversely, we might have to prevent LLVM from inserting padding.
2154  } else if (CGM.getDataLayout().getABITypeAlignment(varTy)
2155  > varAlign.getQuantity()) {
2156  packed = true;
2157  }
2158  types.push_back(varTy);
2159 
2160  byrefType->setBody(types, packed);
2161 
2162  BlockByrefInfo info;
2163  info.Type = byrefType;
2164  info.FieldIndex = types.size() - 1;
2165  info.FieldOffset = varOffset;
2166  info.ByrefAlignment = std::max(varAlign, getPointerAlign());
2167 
2168  auto pair = BlockByrefInfos.insert({D, info});
2169  assert(pair.second && "info was inserted recursively?");
2170  return pair.first->second;
2171 }
2172 
2173 /// Initialize the structural components of a __block variable, i.e.
2174 /// everything but the actual object.
2176  // Find the address of the local.
2177  Address addr = emission.Addr;
2178 
2179  // That's an alloca of the byref structure type.
2180  llvm::StructType *byrefType = cast<llvm::StructType>(
2181  cast<llvm::PointerType>(addr.getPointer()->getType())->getElementType());
2182 
2183  unsigned nextHeaderIndex = 0;
2184  CharUnits nextHeaderOffset;
2185  auto storeHeaderField = [&](llvm::Value *value, CharUnits fieldSize,
2186  const Twine &name) {
2187  auto fieldAddr = Builder.CreateStructGEP(addr, nextHeaderIndex,
2188  nextHeaderOffset, name);
2189  Builder.CreateStore(value, fieldAddr);
2190 
2191  nextHeaderIndex++;
2192  nextHeaderOffset += fieldSize;
2193  };
2194 
2195  // Build the byref helpers if necessary. This is null if we don't need any.
2196  BlockByrefHelpers *helpers = buildByrefHelpers(*byrefType, emission);
2197 
2198  const VarDecl &D = *emission.Variable;
2199  QualType type = D.getType();
2200 
2201  bool HasByrefExtendedLayout;
2202  Qualifiers::ObjCLifetime ByrefLifetime;
2203  bool ByRefHasLifetime =
2204  getContext().getByrefLifetime(type, ByrefLifetime, HasByrefExtendedLayout);
2205 
2206  llvm::Value *V;
2207 
2208  // Initialize the 'isa', which is just 0 or 1.
2209  int isa = 0;
2210  if (type.isObjCGCWeak())
2211  isa = 1;
2212  V = Builder.CreateIntToPtr(Builder.getInt32(isa), Int8PtrTy, "isa");
2213  storeHeaderField(V, getPointerSize(), "byref.isa");
2214 
2215  // Store the address of the variable into its own forwarding pointer.
2216  storeHeaderField(addr.getPointer(), getPointerSize(), "byref.forwarding");
2217 
2218  // Blocks ABI:
2219  // c) the flags field is set to either 0 if no helper functions are
2220  // needed or BLOCK_BYREF_HAS_COPY_DISPOSE if they are,
2221  BlockFlags flags;
2222  if (helpers) flags |= BLOCK_BYREF_HAS_COPY_DISPOSE;
2223  if (ByRefHasLifetime) {
2224  if (HasByrefExtendedLayout) flags |= BLOCK_BYREF_LAYOUT_EXTENDED;
2225  else switch (ByrefLifetime) {
2227  flags |= BLOCK_BYREF_LAYOUT_STRONG;
2228  break;
2229  case Qualifiers::OCL_Weak:
2230  flags |= BLOCK_BYREF_LAYOUT_WEAK;
2231  break;
2234  break;
2235  case Qualifiers::OCL_None:
2236  if (!type->isObjCObjectPointerType() && !type->isBlockPointerType())
2238  break;
2239  default:
2240  break;
2241  }
2242  if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2243  printf("\n Inline flag for BYREF variable layout (%d):", flags.getBitMask());
2244  if (flags & BLOCK_BYREF_HAS_COPY_DISPOSE)
2245  printf(" BLOCK_BYREF_HAS_COPY_DISPOSE");
2246  if (flags & BLOCK_BYREF_LAYOUT_MASK) {
2247  BlockFlags ThisFlag(flags.getBitMask() & BLOCK_BYREF_LAYOUT_MASK);
2248  if (ThisFlag == BLOCK_BYREF_LAYOUT_EXTENDED)
2249  printf(" BLOCK_BYREF_LAYOUT_EXTENDED");
2250  if (ThisFlag == BLOCK_BYREF_LAYOUT_STRONG)
2251  printf(" BLOCK_BYREF_LAYOUT_STRONG");
2252  if (ThisFlag == BLOCK_BYREF_LAYOUT_WEAK)
2253  printf(" BLOCK_BYREF_LAYOUT_WEAK");
2254  if (ThisFlag == BLOCK_BYREF_LAYOUT_UNRETAINED)
2255  printf(" BLOCK_BYREF_LAYOUT_UNRETAINED");
2256  if (ThisFlag == BLOCK_BYREF_LAYOUT_NON_OBJECT)
2257  printf(" BLOCK_BYREF_LAYOUT_NON_OBJECT");
2258  }
2259  printf("\n");
2260  }
2261  }
2262  storeHeaderField(llvm::ConstantInt::get(IntTy, flags.getBitMask()),
2263  getIntSize(), "byref.flags");
2264 
2265  CharUnits byrefSize = CGM.GetTargetTypeStoreSize(byrefType);
2266  V = llvm::ConstantInt::get(IntTy, byrefSize.getQuantity());
2267  storeHeaderField(V, getIntSize(), "byref.size");
2268 
2269  if (helpers) {
2270  storeHeaderField(helpers->CopyHelper, getPointerSize(),
2271  "byref.copyHelper");
2272  storeHeaderField(helpers->DisposeHelper, getPointerSize(),
2273  "byref.disposeHelper");
2274  }
2275 
2276  if (ByRefHasLifetime && HasByrefExtendedLayout) {
2277  auto layoutInfo = CGM.getObjCRuntime().BuildByrefLayout(CGM, type);
2278  storeHeaderField(layoutInfo, getPointerSize(), "byref.layout");
2279  }
2280 }
2281 
2284  llvm::Value *args[] = {
2285  Builder.CreateBitCast(V, Int8PtrTy),
2286  llvm::ConstantInt::get(Int32Ty, flags.getBitMask())
2287  };
2288  EmitNounwindRuntimeCall(F, args); // FIXME: throwing destructors?
2289 }
2290 
2291 namespace {
2292  /// Release a __block variable.
2293  struct CallBlockRelease final : EHScopeStack::Cleanup {
2294  llvm::Value *Addr;
2295  CallBlockRelease(llvm::Value *Addr) : Addr(Addr) {}
2296 
2297  void Emit(CodeGenFunction &CGF, Flags flags) override {
2298  // Should we be passing FIELD_IS_WEAK here?
2300  }
2301  };
2302 } // end anonymous namespace
2303 
2304 /// Enter a cleanup to destroy a __block variable. Note that this
2305 /// cleanup should be a no-op if the variable hasn't left the stack
2306 /// yet; if a cleanup is required for the variable itself, that needs
2307 /// to be done externally.
2309  // We don't enter this cleanup if we're in pure-GC mode.
2310  if (CGM.getLangOpts().getGC() == LangOptions::GCOnly)
2311  return;
2312 
2313  EHStack.pushCleanup<CallBlockRelease>(NormalAndEHCleanup,
2314  emission.Addr.getPointer());
2315 }
2316 
2317 /// Adjust the declaration of something from the blocks API.
2319  llvm::Constant *C) {
2320  auto *GV = cast<llvm::GlobalValue>(C->stripPointerCasts());
2321 
2322  if (CGM.getTarget().getTriple().isOSBinFormatCOFF()) {
2323  IdentifierInfo &II = CGM.getContext().Idents.get(C->getName());
2326 
2327  assert((isa<llvm::Function>(C->stripPointerCasts()) ||
2328  isa<llvm::GlobalVariable>(C->stripPointerCasts())) &&
2329  "expected Function or GlobalVariable");
2330 
2331  const NamedDecl *ND = nullptr;
2332  for (const auto &Result : DC->lookup(&II))
2333  if ((ND = dyn_cast<FunctionDecl>(Result)) ||
2334  (ND = dyn_cast<VarDecl>(Result)))
2335  break;
2336 
2337  // TODO: support static blocks runtime
2338  if (GV->isDeclaration() && (!ND || !ND->hasAttr<DLLExportAttr>())) {
2339  GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
2340  GV->setLinkage(llvm::GlobalValue::ExternalLinkage);
2341  } else {
2342  GV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
2343  GV->setLinkage(llvm::GlobalValue::ExternalLinkage);
2344  }
2345  }
2346 
2347  if (!CGM.getLangOpts().BlocksRuntimeOptional)
2348  return;
2349 
2350  if (GV->isDeclaration() && GV->hasExternalLinkage())
2351  GV->setLinkage(llvm::GlobalValue::ExternalWeakLinkage);
2352 }
2353 
2355  if (BlockObjectDispose)
2356  return BlockObjectDispose;
2357 
2358  llvm::Type *args[] = { Int8PtrTy, Int32Ty };
2359  llvm::FunctionType *fty
2360  = llvm::FunctionType::get(VoidTy, args, false);
2361  BlockObjectDispose = CreateRuntimeFunction(fty, "_Block_object_dispose");
2362  configureBlocksRuntimeObject(*this, BlockObjectDispose);
2363  return BlockObjectDispose;
2364 }
2365 
2367  if (BlockObjectAssign)
2368  return BlockObjectAssign;
2369 
2370  llvm::Type *args[] = { Int8PtrTy, Int8PtrTy, Int32Ty };
2371  llvm::FunctionType *fty
2372  = llvm::FunctionType::get(VoidTy, args, false);
2373  BlockObjectAssign = CreateRuntimeFunction(fty, "_Block_object_assign");
2374  configureBlocksRuntimeObject(*this, BlockObjectAssign);
2375  return BlockObjectAssign;
2376 }
2377 
2379  if (NSConcreteGlobalBlock)
2380  return NSConcreteGlobalBlock;
2381 
2382  NSConcreteGlobalBlock = GetOrCreateLLVMGlobal("_NSConcreteGlobalBlock",
2383  Int8PtrTy->getPointerTo(),
2384  nullptr);
2385  configureBlocksRuntimeObject(*this, NSConcreteGlobalBlock);
2386  return NSConcreteGlobalBlock;
2387 }
2388 
2390  if (NSConcreteStackBlock)
2391  return NSConcreteStackBlock;
2392 
2393  NSConcreteStackBlock = GetOrCreateLLVMGlobal("_NSConcreteStackBlock",
2394  Int8PtrTy->getPointerTo(),
2395  nullptr);
2396  configureBlocksRuntimeObject(*this, NSConcreteStackBlock);
2397  return NSConcreteStackBlock;
2398 }
const CGFunctionInfo & arrangeBuiltinFunctionDeclaration(QualType resultType, const FunctionArgList &args)
A builtin function is a freestanding function using the default C conventions.
Definition: CGCall.cpp:602
void enterNonTrivialFullExpression(const ExprWithCleanups *E)
Enter a full-expression with a non-trivial number of objects to clean up.
Definition: CGBlocks.cpp:648
const llvm::DataLayout & getDataLayout() const
ReturnValueSlot - Contains the address where the return value of a function can be stored...
Definition: CGCall.h:282
const BlockDecl * getBlockDecl() const
Definition: Expr.h:4711
Information about the layout of a __block variable.
Definition: CGBlocks.h:140
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:184
const Capture & getCapture(const VarDecl *var) const
Definition: CGBlocks.h:261
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:1353
static llvm::Constant * generateByrefDisposeHelper(CodeGenFunction &CGF, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
Generate code for a __block variable&#39;s dispose helper.
Definition: CGBlocks.cpp:1888
FunctionDecl - An instance of this class is created to represent a function declaration or definition...
Definition: Decl.h:1586
llvm::IntegerType * IntTy
int
llvm::Type * getGenericBlockLiteralType()
The type of a generic block literal.
Definition: CGBlocks.cpp:950
const CGFunctionInfo & arrangeBlockFunctionDeclaration(const FunctionProtoType *type, const FunctionArgList &args)
Block invocation functions are C functions with an implicit parameter.
Definition: CGCall.cpp:576
External linkage, which indicates that the entity can be referred to from other translation units...
Definition: Linkage.h:50
CharUnits BlockHeaderForcedGapOffset
Definition: CGBlocks.h:246
const FunctionProtoType * getFunctionType() const
getFunctionType - Return the underlying function type for this block.
Definition: Expr.cpp:1926
static llvm::Constant * buildByrefDisposeHelper(CodeGenModule &CGM, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
Build the dispose helper for a __block variable.
Definition: CGBlocks.cpp:1941
A class which contains all the information about a particular captured value.
Definition: Decl.h:3484
CanQualType VoidPtrTy
Definition: ASTContext.h:966
Destroyer * getDestroyer(QualType::DestructionKind destructionKind)
Definition: CGDecl.cpp:1411
A (possibly-)qualified type.
Definition: Type.h:599
bool isBlockPointerType() const
Definition: Type.h:5595
const CodeGenOptions & getCodeGenOpts() const
bool hasCaptures() const
hasCaptures - True if this block (or its nested blocks) captures anything of local storage from its e...
Definition: Decl.h:3597
bool HaveInsertPoint() const
HaveInsertPoint - True if an insertion point is defined.
capture_const_iterator capture_begin() const
Definition: Decl.h:3607
llvm::LLVMContext & getLLVMContext()
void EmitARCDestroyWeak(Address addr)
void @objc_destroyWeak(i8** addr) Essentially objc_storeWeak(addr, nil).
Definition: CGObjC.cpp:2264
FunctionType - C99 6.7.5.3 - Function Declarators.
Definition: Type.h:2887
const llvm::Triple & getTriple() const
Returns the target triple of the primary target.
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:1951
llvm::AllocaInst * CreateTempAlloca(llvm::Type *Ty, const Twine &Name="tmp")
CreateTempAlloca - This creates a alloca and inserts it into the entry block.
Definition: CGExpr.cpp:72
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:1839
ArrayRef< CleanupObject > getObjects() const
Definition: ExprCXX.h:2945
param_iterator param_end()
Definition: Decl.h:3579
static llvm::Constant * buildBlockDescriptor(CodeGenModule &CGM, const CGBlockInfo &blockInfo)
buildBlockDescriptor - Build the block descriptor meta-data for a block.
Definition: CGBlocks.cpp:77
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:5539
stable_iterator stable_begin() const
Create a stable reference to the top of the EH stack.
Definition: EHScopeStack.h:379
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:3608
Address GetAddrOfLocalVar(const VarDecl *VD)
GetAddrOfLocalVar - Return the address of a local variable.
VarDecl - An instance of this class is created to represent a variable declaration or definition...
Definition: Decl.h:768
CGBlockInfo(const BlockDecl *blockDecl, StringRef Name)
Definition: CGBlocks.cpp:31
const T * getAs() const
Member-template getAs<specific type>&#39;.
Definition: Type.h:5923
EHScopeStack::stable_iterator getCleanup() const
Definition: CGBlocks.h:179
This class gathers all debug information during compilation and is responsible for emitting to llvm g...
Definition: CGDebugInfo.h:53
virtual llvm::Constant * BuildRCBlockLayout(CodeGen::CodeGenModule &CGM, const CodeGen::CGBlockInfo &blockInfo)=0
llvm::Value * getPointer() const
Definition: Address.h:38
llvm::Type * ConvertTypeForMem(QualType T)
ConvertTypeForMem - Convert type T into a llvm::Type.
Represents an expression – generally a full-expression – that introduces cleanups to be run at the ...
Definition: ExprCXX.h:2917
static void destroyBlockInfos(CGBlockInfo *info)
Destroy a chain of block layouts.
Definition: CGBlocks.cpp:675
The collection of all-type qualifiers we support.
Definition: Type.h:118
const BlockDecl * Block
Definition: CGBlocks.h:237
llvm::DenseMap< const VarDecl *, FieldDecl * > LambdaCaptureFields
One of these records is kept for each identifier that is lexed.
void emitByrefStructureInit(const AutoVarEmission &emission)
Initialize the structural components of a __block variable, i.e.
Definition: CGBlocks.cpp:2175
CGBlockInfo * FirstBlockInfo
FirstBlockInfo - The head of a singly-linked-list of block layouts.
QualType getPointeeType() const
Definition: Type.h:2305
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:126
bool HasCapturedVariableLayout
HasCapturedVariableLayout : True if block has captured variables and their layout meta-data has been ...
Definition: CGBlocks.h:230
bool isReferenceType() const
Definition: Type.h:5598
std::string getObjCEncodingForBlock(const BlockExpr *blockExpr) const
Return the encoded type for this block declaration.
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:1811
Stmt * getBody() const override
Definition: Decl.h:3560
static bool isSafeForCXXConstantCapture(QualType type)
Determines if the given type is safe for constant capture in C++.
Definition: CGBlocks.cpp:242
IdentifierTable & Idents
Definition: ASTContext.h:505
An r-value expression (a pr-value in the C++11 taxonomy) produces a temporary value.
Definition: Specifiers.h:105
CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const
Return the store size, in character units, of the given LLVM type.
static ApplyDebugLocation CreateArtificial(CodeGenFunction &CGF)
Apply TemporaryLocation if it is valid.
Definition: CGDebugInfo.h:602
llvm::Value * EmitARCStoreStrongCall(Address addr, llvm::Value *value, bool resultIgnored)
Store into a strong object.
Definition: CGObjC.cpp:2102
Address GetAddrOfBlockDecl(const VarDecl *var, bool ByRef)
Definition: CGBlocks.cpp:1020
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:2088
const BlockDecl * getBlockDecl() const
Definition: CGBlocks.h:271
bool HasCXXObject
HasCXXObject - True if the block&#39;s custom copy/dispose functions need to be run even in GC mode...
Definition: CGBlocks.h:222
llvm::Value * EmitBlockLiteral(const BlockExpr *)
Emit a block literal expression in the current function.
Definition: CGBlocks.cpp:685
uint32_t getBitMask() const
Definition: CGBlocks.h:117
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...
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:39
static Capture makeConstant(llvm::Value *value)
Definition: CGBlocks.h:206
const Stmt * getBody() const
Definition: Expr.cpp:1935
llvm::Constant * getNSConcreteStackBlock()
Definition: CGBlocks.cpp:2389
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, bool isConstexprSpecified=false)
Definition: Decl.h:1741
This object can be modified without requiring retains or releases.
Definition: Type.h:139
StringRef Name
Name - The name of the block, kindof.
Definition: CGBlocks.h:152
bool NeedsCopyDispose
True if the block needs a custom copy or dispose function.
Definition: CGBlocks.h:218
lookup_result lookup(DeclarationName Name) const
lookup - Find the declarations (if any) with the given Name in this context.
Definition: DeclBase.cpp:1453
const BlockExpr * BlockExpression
Definition: CGBlocks.h:238
static llvm::Constant * buildCopyHelper(CodeGenModule &CGM, const CGBlockInfo &blockInfo)
Build the helper function to copy a block.
Definition: CGBlocks.cpp:52
bool isValid() const
Definition: Address.h:36
CXXRecordDecl * getAsCXXRecordDecl() const
Retrieves the CXXRecordDecl that this type refers to, either because the type is a RecordType or beca...
Definition: Type.cpp:1548
Represents a prototype with parameter type info, e.g.
Definition: Type.h:3081
llvm::CallInst * EmitNounwindRuntimeCall(llvm::Value *callee, const Twine &name="")
uint32_t getBitMask() const
Definition: CGBlocks.h:73
const CodeGen::CGBlockInfo * BlockInfo
llvm::Function * GenerateBlockFunction(GlobalDecl GD, const CGBlockInfo &Info, const DeclMapTy &ldm, bool IsLambdaConversionToBlock)
Definition: CGBlocks.cpp:1170
CGBlockInfo - Information to generate a block literal.
Definition: CGBlocks.h:149
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:215
SourceLocation getLocEnd() const LLVM_READONLY
Definition: Expr.h:4721
StringRef getBlockMangledName(GlobalDecl GD, const BlockDecl *BD)
QuantityType getQuantity() const
getQuantity - Get the raw integer representation of this quantity.
Definition: CharUnits.h:179
static void initializeForBlockHeader(CodeGenModule &CGM, CGBlockInfo &info, SmallVectorImpl< llvm::Type *> &elementTypes)
Definition: CGBlocks.cpp:302
CGBlockInfo * NextBlockInfo
The next block in the block-info chain.
Definition: CGBlocks.h:259
CGObjCRuntime & getObjCRuntime()
Return a reference to the configured Objective-C runtime.
BlockDecl - This represents a block literal declaration, which is like an unnamed FunctionDecl...
Definition: Decl.h:3480
Expr - This represents one expression.
Definition: Expr.h:105
void EmitARCMoveWeak(Address dst, Address src)
void @objc_moveWeak(i8** dest, i8** src) Disregards the current value in dest.
Definition: CGObjC.cpp:2281
Emit only debug info necessary for generating line number tables (-gline-tables-only).
static Address invalid()
Definition: Address.h:35
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:5954
void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F, const CGFunctionInfo &FI)
Set the attributes on the LLVM function for the given decl and function info.
bool isObjCRetainableType() const
Definition: Type.cpp:3788
BlockExpr - Adaptor class for mixing a BlockDecl with expressions.
Definition: Expr.h:4697
Represents a C++ destructor within a class.
Definition: DeclCXX.h:2382
static llvm::Constant * buildGlobalBlock(CodeGenModule &CGM, const CGBlockInfo &blockInfo, llvm::Constant *blockFn)
Build the given block as a global block.
Definition: CGBlocks.cpp:1085
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:1532
const Expr * getCallee() const
Definition: Expr.h:2204
ObjCLifetime getObjCLifetime() const
Definition: Type.h:309
static CharUnits fromQuantity(QuantityType Quantity)
fromQuantity - Construct a CharUnits quantity from a raw integer type.
Definition: CharUnits.h:63
internal::Matcher< T > id(StringRef ID, const internal::BindableMatcher< T > &InnerMatcher)
If the provided matcher matches a node, binds the node to ID.
Definition: ASTMatchers.h:102
void add(RValue rvalue, QualType type, bool needscopy=false)
Definition: CGCall.h:208
void addInt(llvm::IntegerType *intTy, uint64_t value, bool isSigned=false)
Add an integer value of a specific type.
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:1430
static Capture makeIndex(unsigned index, CharUnits offset, QualType FieldType)
Definition: CGBlocks.h:197
QualType getType() const
Definition: Expr.h:126
bool isa(CodeGen::Address addr)
Definition: Address.h:112
bool isObjCInertUnsafeUnretainedType() const
Was this type written with the special inert-in-MRC __unsafe_unretained qualifier?
Definition: Type.cpp:518
static CharUnits getLowBit(CharUnits v)
Get the low bit of a nonzero character count.
Definition: CGBlocks.cpp:298
const Type * getBaseElementTypeUnsafe() const
Get the base element type of this type, potentially discarding type qualifiers.
Definition: Type.h:5881
const TargetInfo & getTarget() const
The result type of a method or function.
const LangOptions & getLangOpts() const
ASTContext & getContext() const
static AggValueSlot forAddr(Address addr, Qualifiers quals, IsDestructed_t isDestructed, NeedsGCBarriers_t needsGC, IsAliased_t isAliased, IsZeroed_t isZeroed=IsNotZeroed)
forAddr - Make a slot for an aggregate value.
Definition: CGValue.h:502
do v
Definition: arm_acle.h:78
GlobalDecl - represents a global declaration.
Definition: GlobalDecl.h:29
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:5425
param_iterator param_begin()
Definition: Decl.h:3578
The l-value was considered opaque, so the alignment was determined from a type.
RecordDecl * getDecl() const
Definition: Type.h:3734
void setBlockContextParameter(const ImplicitParamDecl *D, unsigned argNum, llvm::Value *ptr)
Definition: CGBlocks.cpp:1131
bool UsesStret
UsesStret : True if the block uses an stret return.
Definition: CGBlocks.h:226
void enterByrefCleanup(const AutoVarEmission &emission)
Enter a cleanup to destroy a __block variable.
Definition: CGBlocks.cpp:2308
There is no lifetime qualification on this type.
Definition: Type.h:135
Address CreateBitCast(Address Addr, llvm::Type *Ty, const llvm::Twine &Name="")
Definition: CGBuilder.h:142
#define false
Definition: stdbool.h:33
Assigning into this object requires the old value to be released and the new value to be retained...
Definition: Type.h:146
Expr * getBlockVarCopyInits(const VarDecl *VD)
Get the copy initialization expression of the VarDecl VD, or NULL if none exists. ...
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:2304
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:1436
Encodes a location in the source.
static DeclContext * castToDeclContext(const TranslationUnitDecl *D)
Definition: Decl.h:99
QualType getReturnType() const
Definition: Type.h:3017
IdentifierInfo & get(StringRef Name)
Return the identifier token info for the specified named identifier.
A saved depth on the scope stack.
Definition: EHScopeStack.h:107
llvm::StructType * StructureType
Definition: CGBlocks.h:236
std::string getNameAsString() const
getNameAsString - Get a human-readable name for the declaration, even if it is one of the special kin...
Definition: Decl.h:252
static void configureBlocksRuntimeObject(CodeGenModule &CGM, llvm::Constant *C)
Adjust the declaration of something from the blocks API.
Definition: CGBlocks.cpp:2318
An aggregate value slot.
Definition: CGValue.h:441
const BlockByrefInfo & getBlockByrefInfo(const VarDecl *var)
BuildByrefInfo - This routine changes a __block variable declared as T x into:
Definition: CGBlocks.cpp:2087
A scoped helper to set the current debug location to the specified location or preferred location of ...
Definition: CGDebugInfo.h:571
bool isConversionFromLambda() const
Definition: Decl.h:3614
CanQualType VoidTy
Definition: ASTContext.h:951
llvm::DenseMap< const VarDecl *, Capture > Captures
The mapping of allocated indexes within the block.
Definition: CGBlocks.h:233
arg_range arguments()
Definition: Expr.h:2258
bool isObjCObjectPointerType() const
Definition: Type.h:5661
static bool isBlockPointer(Expr *Arg)
llvm::Constant * getBlockObjectDispose()
Definition: CGBlocks.cpp:2354
An aligned address.
Definition: Address.h:25
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.
ImplicitCastExpr - Allows us to explicitly represent implicit type conversions, which have no direct ...
Definition: Expr.h:2750
DestructionKind isDestructedType() const
Returns a nonzero value if objects of this type require non-trivial work to clean up after...
Definition: Type.h:1034
llvm::Value * getConstant() const
Definition: CGBlocks.h:188
const BlockExpr * getBlockExpr() const
Definition: CGBlocks.h:272
All available information about a concrete callee.
Definition: CGCall.h:67
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:3505
unsigned CXXThisIndex
The field index of &#39;this&#39; within the block, if there is one.
Definition: CGBlocks.h:155
Assigning into this object requires a lifetime extension.
Definition: Type.h:152
static Destroyer destroyARCStrongImprecise
void FinishFunction(SourceLocation EndLoc=SourceLocation())
FinishFunction - Complete IR generation of the current function.
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:569
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...
FunctionArgList - Type for representing both the decl and type of parameters to a function...
Definition: CGCall.h:277
bool isObjCGCWeak() const
true when Type is objc&#39;s weak.
Definition: Type.h:1001
static llvm::Constant * tryCaptureAsConstant(CodeGenModule &CGM, CodeGenFunction *CGF, const VarDecl *var)
It is illegal to modify a const object after initialization.
Definition: CGBlocks.cpp:266
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:190
/file This file defines classes for searching and anlyzing source code clones.
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:323
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:1147
ArrayRef< Capture > captures() const
Definition: Decl.h:3605
const internal::VariadicAllOfMatcher< Type > type
Matches Types in the clang AST.
Definition: ASTMatchers.h:2039
Address CreateStructGEP(Address Addr, unsigned Index, CharUnits Offset, const llvm::Twine &Name="")
Definition: CGBuilder.h:165
static llvm::Constant * buildDisposeHelper(CodeGenModule &CGM, const CGBlockInfo &blockInfo)
Build the helper function to dispose of a block.
Definition: CGBlocks.cpp:58
const Expr * getInit() const
Definition: Decl.h:1144
llvm::Constant * getPointer() const
Definition: Address.h:84
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:70
int printf(__constant const char *st,...)
bool hasObjCLifetime() const
Definition: Type.h:308
llvm::StoreInst * CreateStore(llvm::Value *Val, Address Addr, bool IsVolatile=false)
Definition: CGBuilder.h:108
llvm::Module & getModule() const
llvm::StructType * Type
Definition: CGBlocks.h:142
llvm::DenseMap< const Decl *, Address > DeclMapTy
static void enterBlockScope(CodeGenFunction &CGF, BlockDecl *block)
Enter the scope of a block.
Definition: CGBlocks.cpp:573
Pointer to a block type.
Definition: Type.h:2291
A helper class that allows the use of isa/cast/dyncast to detect TagType objects of structs/unions/cl...
Definition: Type.h:3725
CanQualType UnsignedLongTy
Definition: ASTContext.h:960
unsigned getNumObjects() const
Definition: ExprCXX.h:2950
static llvm::Constant * buildByrefCopyHelper(CodeGenModule &CGM, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
Build the copy helper for a __block variable.
Definition: CGBlocks.cpp:1879
Base for LValueReferenceType and RValueReferenceType.
Definition: Type.h:2324
void EmitSynthesizedCXXCopyCtor(Address Dest, Address Src, const Expr *Exp)
Definition: CGExprCXX.cpp:603
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:658
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:33
llvm::Constant * getBlockObjectAssign()
Definition: CGBlocks.cpp:2366
llvm::Constant * EmitConstantInit(const VarDecl &D, CodeGenFunction *CGF=nullptr)
Try to emit the initializer for the given declaration as a constant; returns 0 if the expression cann...
char __ovld __cnfn max(char x, char y)
Returns y if x < y, otherwise it returns x.
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:3610
Reading or writing from this object requires a barrier call.
Definition: Type.h:149
TranslationUnitDecl * getTranslationUnitDecl() const
Definition: ASTContext.h:944
Represents a C++ struct/union/class.
Definition: DeclCXX.h:262
Qualifiers getQualifiers() const
Retrieve the set of qualifiers applied to this type.
Definition: Type.h:5393
void setAddrOfGlobalBlock(const BlockExpr *BE, llvm::Constant *Addr)
Notes that BE&#39;s global block is available via Addr.
Definition: CGBlocks.cpp:1052
void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize)
Takes the old cleanup stack size and emits the cleanup blocks that have been added.
Definition: CGCleanup.cpp:421
CharUnits BlockHeaderForcedGapSize
Definition: CGBlocks.h:249
llvm::Value * EmitARCRetainBlock(llvm::Value *value, bool mandatory)
Retain the given block, with _Block_copy semantics.
Definition: CGObjC.cpp:1961
void ForceCleanup()
Force the emission of cleanups now, instead of waiting until this object is destroyed.
CallExpr - Represents a function call (C99 6.5.2.2, C++ [expr.call]).
Definition: Expr.h:2164
StringRef getName() const
getName - Get the name of identifier for this declaration as a StringRef.
Definition: Decl.h:237
TranslationUnitDecl - The top declaration context.
Definition: Decl.h:80
ConstantStructBuilder beginStruct(llvm::StructType *structTy=nullptr)
A reference to a declared variable, function, enum, etc.
Definition: Expr.h:948
static RValue get(llvm::Value *V)
Definition: CGValue.h:85
RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue)
Definition: CGBlocks.cpp:971
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:619
llvm::Constant * getNSConcreteGlobalBlock()
Definition: CGBlocks.cpp:2378
llvm::Type * getBlockDescriptorType()
Fetches the type of a generic block descriptor.
Definition: CGBlocks.cpp:917
llvm::Constant * GetAddrOfGlobalBlock(const BlockExpr *BE, StringRef Name)
Gets the address of a block which requires no captures.
Definition: CGBlocks.cpp:1060
QualType getType() const
Definition: Decl.h:599
An l-value expression is a reference to an object with independent storage.
Definition: Specifiers.h:109
Information for lazily generating a cleanup.
Definition: EHScopeStack.h:147
NamedDecl - This represents a decl with a name.
Definition: Decl.h:213
llvm::Instruction * DominatingIP
An instruction which dominates the full-expression that the block is inside.
Definition: CGBlocks.h:253
unsigned long ulong
An unsigned 64-bit integer.
Definition: opencl-c.h:46
unsigned getTargetAddressSpace(QualType T) const
Definition: ASTContext.h:2293
static bool isObjCNSObjectType(QualType Ty)
Return true if this is an NSObject object with its NSObject attribute set.
Definition: ASTContext.h:1881
SourceLocation getLocStart() const LLVM_READONLY
Definition: Stmt.cpp:257
CallArgList - Type for representing both the value and type of arguments in a call.
Definition: CGCall.h:183
const LangOptions & getLangOpts() const
Definition: ASTContext.h:651
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:2050
Abstract information about a function or function prototype.
Definition: CGCall.h:45
void BuildBlockRelease(llvm::Value *DeclPtr, BlockFieldFlags flags)
Definition: CGBlocks.cpp:2282
void setCleanup(EHScopeStack::stable_iterator cleanup)
Definition: CGBlocks.h:183
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:1011
llvm::FunctionType * GetFunctionType(const CGFunctionInfo &Info)
GetFunctionType - Get the LLVM function type for.
Definition: CGCall.cpp:1469