#include "CGBlocks.h"
#include "CGDebugInfo.h"
#include "CGObjCRuntime.h"
#include "CGOpenCLRuntime.h"
#include "CodeGenFunction.h"
#include "CodeGenModule.h"
#include "ConstantEmitter.h"
#include "TargetInfo.h"
#include "clang/AST/DeclObjC.h"
#include "clang/CodeGen/ConstantInitBuilder.h"
#include "llvm/ADT/SmallSet.h"
#include "llvm/IR/CallSite.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/IR/Module.h"
#include <algorithm>
#include <cstdio>

Include dependency graph for CGBlocks.cpp:

Enumerations
enum	BlockCaptureEntityKind
	Represents a type of copy/destroy operation that should be performed for an entity that's captured by a block. More...

Functions
static llvm::Constant *	buildGlobalBlock (CodeGenModule &CGM, const CGBlockInfo &blockInfo, llvm::Constant *blockFn)
	Build the given block as a global block. More...

static llvm::Constant *	buildCopyHelper (CodeGenModule &CGM, const CGBlockInfo &blockInfo)
	Build the helper function to copy a block. More...

static llvm::Constant *	buildDisposeHelper (CodeGenModule &CGM, const CGBlockInfo &blockInfo)
	Build the helper function to dispose of a block. More...

static llvm::Constant *	buildBlockDescriptor (CodeGenModule &CGM, const CGBlockInfo &blockInfo)
	buildBlockDescriptor - Build the block descriptor meta-data for a block. More...

static bool	isSafeForCXXConstantCapture (QualType type)
	Determines if the given type is safe for constant capture in C++. More...

static llvm::Constant *	tryCaptureAsConstant (CodeGenModule &CGM, CodeGenFunction CGF, const VarDecl var)
	It is illegal to modify a const object after initialization. More...

static CharUnits	getLowBit (CharUnits v)
	Get the low bit of a nonzero character count. More...

static void	initializeForBlockHeader (CodeGenModule &CGM, CGBlockInfo &info, SmallVectorImpl< llvm::Type *> &elementTypes)

static QualType	getCaptureFieldType (const CodeGenFunction &CGF, const BlockDecl::Capture &CI)

static void	computeBlockInfo (CodeGenModule &CGM, CodeGenFunction *CGF, CGBlockInfo &info)
	Compute the layout of the given block. More...

static void	enterBlockScope (CodeGenFunction &CGF, BlockDecl *block)
	Enter the scope of a block. More...

static CGBlockInfo *	findAndRemoveBlockInfo (CGBlockInfo *head, const BlockDecl block)
	Find the layout for the given block in a linked list and remove it. More...

static std::pair< BlockCaptureEntityKind, BlockFieldFlags >	computeCopyInfoForBlockCapture (const BlockDecl::Capture &CI, QualType T, const LangOptions &LangOpts)

static void	findBlockCapturedManagedEntities (const CGBlockInfo &BlockInfo, const LangOptions &LangOpts, SmallVectorImpl< BlockCaptureManagedEntity > &ManagedCaptures, llvm::function_ref< std::pair< BlockCaptureEntityKind, BlockFieldFlags >(const BlockDecl::Capture &, QualType, const LangOptions &)> Predicate)
	Find the set of block captures that need to be explicitly copied or destroy. More...

static BlockFieldFlags	getBlockFieldFlagsForObjCObjectPointer (const BlockDecl::Capture &CI, QualType T)

static std::pair< BlockCaptureEntityKind, BlockFieldFlags >	computeDestroyInfoForBlockCapture (const BlockDecl::Capture &CI, QualType T, const LangOptions &LangOpts)

static llvm::Constant *	generateByrefCopyHelper (CodeGenFunction &CGF, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)

static llvm::Constant *	buildByrefCopyHelper (CodeGenModule &CGM, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
	Build the copy helper for a __block variable. More...

static llvm::Constant *	generateByrefDisposeHelper (CodeGenFunction &CGF, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
	Generate code for a __block variable's dispose helper. More...

static llvm::Constant *	buildByrefDisposeHelper (CodeGenModule &CGM, const BlockByrefInfo &byrefInfo, BlockByrefHelpers &generator)
	Build the dispose helper for a __block variable. More...

template<class T >
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. More...

static void	configureBlocksRuntimeObject (CodeGenModule &CGM, llvm::Constant *C)
	Adjust the declaration of something from the blocks API. More...

Enumeration Type Documentation

◆ BlockCaptureEntityKind

enum BlockCaptureEntityKind

strong

Represents a type of copy/destroy operation that should be performed for an entity that's captured by a block.

Definition at line 1479 of file CGBlocks.cpp.

Function Documentation

◆ buildBlockDescriptor()

static llvm::Constant* buildBlockDescriptor	(	CodeGenModule &	CGM,
		const CGBlockInfo &	blockInfo
	)

static

buildBlockDescriptor - Build the block descriptor meta-data for a block.

buildBlockDescriptor is accessed from 5th field of the Block_literal meta-data and contains stationary information about the block literal. Its definition will have 4 (or optionally 6) words.

struct Block_descriptor {
  unsigned long reserved;
  unsigned long size;  // size of Block_literal metadata in bytes.
  void *copy_func_helper_decl;  // optional copy helper.
  void *destroy_func_decl; // optioanl destructor helper.
  void *block_method_encoding_address; // @encode for block literal signature.
  void *block_layout_info; // encoding of captured block variables.
};

Definition at line 80 of file CGBlocks.cpp.

Referenced by buildGlobalBlock(), and clang::CodeGen::CodeGenFunction::EmitBlockLiteral().

◆ buildByrefCopyHelper()

static llvm::Constant* buildByrefCopyHelper	(	CodeGenModule &	CGM,
		const BlockByrefInfo &	byrefInfo,
		BlockByrefHelpers &	generator
	)

static

Build the copy helper for a __block variable.

Definition at line 2114 of file CGBlocks.cpp.

References generateByrefCopyHelper().

Referenced by buildByrefHelpers().

◆ buildByrefDisposeHelper()

static llvm::Constant* buildByrefDisposeHelper	(	CodeGenModule &	CGM,
		const BlockByrefInfo &	byrefInfo,
		BlockByrefHelpers &	generator
	)

static

Build the dispose helper for a __block variable.

Definition at line 2176 of file CGBlocks.cpp.

References generateByrefDisposeHelper().

Referenced by buildByrefHelpers().

◆ buildByrefHelpers()

template<class T >

static T* buildByrefHelpers	(	CodeGenModule &	CGM,
		const BlockByrefInfo &	byrefInfo,
		T &&	generator
	)

static

Lazily build the copy and dispose helpers for a __block variable with the given information.

Definition at line 2186 of file CGBlocks.cpp.

References clang::CharUnits::alignmentAtOffset(), clang::CodeGen::BLOCK_FIELD_IS_BLOCK, clang::CodeGen::BLOCK_FIELD_IS_OBJECT, clang::CodeGen::BLOCK_FIELD_IS_WEAK, buildByrefCopyHelper(), buildByrefDisposeHelper(), clang::CodeGen::CodeGenModule::ByrefHelpersCache, clang::QualType::DK_nontrivial_c_struct, clang::Type::getAsCXXRecordDecl(), clang::ASTContext::getBlockVarCopyInits(), clang::CodeGen::CodeGenModule::getContext(), clang::Qualifiers::getObjCLifetime(), clang::QualType::getQualifiers(), clang::ValueDecl::getType(), clang::ast_matchers::id(), clang::Type::isBlockPointerType(), clang::QualType::isDestructedType(), clang::QualType::isNonTrivialToPrimitiveDestructiveMove(), clang::QualType::isObjCGCWeak(), clang::ASTContext::isObjCNSObjectType(), clang::Type::isObjCObjectPointerType(), clang::Type::isObjCRetainableType(), clang::Qualifiers::OCL_Autoreleasing, clang::Qualifiers::OCL_ExplicitNone, clang::Qualifiers::OCL_None, clang::Qualifiers::OCL_Strong, clang::Qualifiers::OCL_Weak, clang::QualType::PCK_Struct, and clang::T.

◆ buildCopyHelper()

static llvm::Constant* buildCopyHelper	(	CodeGenModule &	CGM,
		const CGBlockInfo &	blockInfo
	)

static

Build the helper function to copy a block.

Definition at line 55 of file CGBlocks.cpp.

References clang::CodeGen::CodeGenFunction::GenerateCopyHelperFunction().

Referenced by buildBlockDescriptor().

◆ buildDisposeHelper()

static llvm::Constant* buildDisposeHelper	(	CodeGenModule &	CGM,
		const CGBlockInfo &	blockInfo
	)

static

Build the helper function to dispose of a block.

Definition at line 61 of file CGBlocks.cpp.

References clang::CodeGen::CodeGenFunction::GenerateDestroyHelperFunction().

Referenced by buildBlockDescriptor().

◆ buildGlobalBlock()

static llvm::Constant * buildGlobalBlock	(	CodeGenModule &	CGM,
		const CGBlockInfo &	blockInfo,
		llvm::Constant *	blockFn
	)

static

Build the given block as a global block.

Definition at line 1193 of file CGBlocks.cpp.

References clang::CodeGen::BLOCK_HAS_SIGNATURE, clang::CodeGen::BLOCK_IS_GLOBAL, clang::CodeGen::BLOCK_USE_STRET, clang::CodeGen::CGBlockInfo::BlockAlign, clang::CodeGen::CGBlockInfo::BlockExpression, clang::CodeGen::CGBlockInfo::BlockSize, buildBlockDescriptor(), clang::CodeGen::CGBlockInfo::CanBeGlobal, clang::CodeGen::CodeGenModule::getAddrOfGlobalBlockIfEmitted(), clang::CodeGen::BlockFlags::getBitMask(), clang::CodeGen::CodeGenModule::getLangOpts(), clang::CodeGen::CodeGenModule::getNSConcreteGlobalBlock(), clang::CharUnits::getQuantity(), clang::CodeGen::CodeGenModule::getTargetCodeGenInfo(), clang::CodeGen::TargetCodeGenInfo::getTargetOpenCLBlockHelper(), clang::CodeGen::CodeGenTypeCache::IntTy, and clang::CodeGen::CGBlockInfo::UsesStret.

Referenced by clang::CodeGen::CodeGenFunction::GenerateBlockFunction(), and clang::CodeGen::BlockByrefHelpers::~BlockByrefHelpers().

◆ computeBlockInfo()

static void computeBlockInfo	(	CodeGenModule &	CGM,
		CodeGenFunction *	CGF,
		CGBlockInfo &	info
	)

static

Compute the layout of the given block.

Attempts to lay the block out with minimal space requirements.

Definition at line 362 of file CGBlocks.cpp.

Referenced by clang::CodeGen::CodeGenFunction::EmitBlockLiteral(), enterBlockScope(), and clang::CodeGen::CodeGenModule::GetAddrOfGlobalBlock().

◆ computeCopyInfoForBlockCapture()

static std::pair<BlockCaptureEntityKind, BlockFieldFlags> computeCopyInfoForBlockCapture	(	const BlockDecl::Capture &	CI,
		QualType	T,
		const LangOptions &	LangOpts
	)

static

◆ computeDestroyInfoForBlockCapture()

static std::pair<BlockCaptureEntityKind, BlockFieldFlags> computeDestroyInfoForBlockCapture	(	const BlockDecl::Capture &	CI,
		QualType	T,
		const LangOptions &	LangOpts
	)

static

Definition at line 1727 of file CGBlocks.cpp.

References clang::CodeGen::BLOCK_FIELD_IS_BYREF, clang::CodeGen::BLOCK_FIELD_IS_WEAK, clang::QualType::DK_cxx_destructor, clang::QualType::DK_none, clang::QualType::DK_nontrivial_c_struct, clang::QualType::DK_objc_strong_lifetime, clang::QualType::DK_objc_weak_lifetime, getBlockFieldFlagsForObjCObjectPointer(), clang::QualType::getQualifiers(), clang::Qualifiers::hasObjCLifetime(), clang::BlockDecl::Capture::isByRef(), clang::QualType::isDestructedType(), clang::QualType::isObjCGCWeak(), clang::Type::isObjCRetainableType(), and clang::None.

◆ configureBlocksRuntimeObject()

static void configureBlocksRuntimeObject	(	CodeGenModule &	CGM,
		llvm::Constant *	C
	)

static

Adjust the declaration of something from the blocks API.

Definition at line 2560 of file CGBlocks.cpp.

References clang::TranslationUnitDecl::castToDeclContext(), clang::ExternalLinkage, clang::IdentifierTable::get(), clang::CodeGen::CodeGenModule::getContext(), clang::CodeGen::CodeGenModule::getLangOpts(), clang::CodeGen::CodeGenModule::getTarget(), clang::ASTContext::getTranslationUnitDecl(), clang::TargetInfo::getTriple(), clang::ASTContext::Idents, clang::DeclContext::lookup(), and clang::CodeGen::CodeGenModule::setDSOLocal().

Referenced by clang::CodeGen::CodeGenModule::getBlockObjectAssign(), clang::CodeGen::CodeGenModule::getBlockObjectDispose(), clang::CodeGen::CodeGenModule::getNSConcreteGlobalBlock(), and clang::CodeGen::CodeGenModule::getNSConcreteStackBlock().

◆ enterBlockScope()

static void enterBlockScope	(	CodeGenFunction &	CGF,
		BlockDecl *	block
	)

static

Enter the scope of a block.

This should be run at the entrance to a full-expression so that the block's cleanups are pushed at the right place in the stack.

Definition at line 616 of file CGBlocks.cpp.

◆ findAndRemoveBlockInfo()

static CGBlockInfo* findAndRemoveBlockInfo	(	CGBlockInfo **	head,
		const BlockDecl *	block
	)

static

Find the layout for the given block in a linked list and remove it.

Definition at line 708 of file CGBlocks.cpp.

References clang::CodeGen::CGBlockInfo::getBlockDecl(), and clang::CodeGen::CGBlockInfo::NextBlockInfo.

Referenced by clang::CodeGen::CodeGenFunction::EmitBlockLiteral().

◆ findBlockCapturedManagedEntities()

static void findBlockCapturedManagedEntities	(	const CGBlockInfo &	BlockInfo,
		const LangOptions &	LangOpts,
		SmallVectorImpl< BlockCaptureManagedEntity > &	ManagedCaptures,
		llvm::function_ref< std::pair< BlockCaptureEntityKind, BlockFieldFlags >(const BlockDecl::Capture &, QualType, const LangOptions &)>	Predicate
	)

static

Find the set of block captures that need to be explicitly copied or destroy.

Definition at line 1562 of file CGBlocks.cpp.

References clang::BlockDecl::captures(), clang::CodeGen::CGBlockInfo::getBlockDecl(), clang::CodeGen::CGBlockInfo::getCapture(), clang::ValueDecl::getType(), clang::CodeGen::CGBlockInfo::Capture::isConstant(), and clang::None.

◆ generateByrefCopyHelper()

static llvm::Constant* generateByrefCopyHelper	(	CodeGenFunction &	CGF,
		const BlockByrefInfo &	byrefInfo,
		BlockByrefHelpers &	generator
	)

static

Definition at line 2046 of file CGBlocks.cpp.

Referenced by buildByrefCopyHelper().

◆ generateByrefDisposeHelper()

static llvm::Constant* generateByrefDisposeHelper	(	CodeGenFunction &	CGF,
		const BlockByrefInfo &	byrefInfo,
		BlockByrefHelpers &	generator
	)

static

Generate code for a __block variable's dispose helper.

Definition at line 2123 of file CGBlocks.cpp.

Referenced by buildByrefDisposeHelper().

◆ getBlockFieldFlagsForObjCObjectPointer()

static BlockFieldFlags getBlockFieldFlagsForObjCObjectPointer	(	const BlockDecl::Capture &	CI,
		QualType	T
	)

static

Definition at line 1718 of file CGBlocks.cpp.

References clang::CodeGen::BLOCK_FIELD_IS_BLOCK, clang::CodeGen::BLOCK_FIELD_IS_OBJECT, and clang::Type::isBlockPointerType().

Referenced by computeDestroyInfoForBlockCapture().

◆ getCaptureFieldType()

static QualType getCaptureFieldType	(	const CodeGenFunction &	CGF,
		const BlockDecl::Capture &	CI
	)

static

Definition at line 347 of file CGBlocks.cpp.

References clang::CodeGen::CodeGenFunction::BlockInfo, clang::CodeGen::CGBlockInfo::Capture::fieldType(), clang::CodeGen::CGBlockInfo::getCapture(), clang::ValueDecl::getType(), clang::BlockDecl::Capture::getVariable(), clang::BlockDecl::Capture::isNested(), and clang::CodeGen::CodeGenFunction::LambdaCaptureFields.

Referenced by computeBlockInfo(), and enterBlockScope().

◆ getLowBit()

static CharUnits getLowBit ( CharUnits v )

static

Get the low bit of a nonzero character count.

This is the alignment of the nth byte if the 0th byte is universally aligned.

Definition at line 301 of file CGBlocks.cpp.

References clang::CharUnits::fromQuantity(), and clang::CharUnits::getQuantity().

Referenced by computeBlockInfo().

◆ initializeForBlockHeader()

static void initializeForBlockHeader	(	CodeGenModule &	CGM,
		CGBlockInfo &	info,
		SmallVectorImpl< llvm::Type *> &	elementTypes
	)

static

Definition at line 305 of file CGBlocks.cpp.

References clang::CodeGen::CGBlockInfo::BlockAlign, clang::CodeGen::CodeGenTypeCache::getIntAlign(), clang::CodeGen::CodeGenTypeCache::getIntSize(), clang::CodeGen::CodeGenModule::getLangOpts(), clang::CharUnits::getQuantity(), clang::CodeGen::CodeGenModule::getTargetCodeGenInfo(), clang::CodeGen::TargetCodeGenInfo::getTargetOpenCLBlockHelper(), and clang::CodeGen::CodeGenTypeCache::IntTy.

Referenced by computeBlockInfo().

◆ isSafeForCXXConstantCapture()

static bool isSafeForCXXConstantCapture ( QualType type )

static

Determines if the given type is safe for constant capture in C++.

Definition at line 245 of file CGBlocks.cpp.

References clang::Type::getAs(), clang::Type::getBaseElementTypeUnsafe(), clang::RecordType::getDecl(), and clang::ast_matchers::recordType.

Referenced by tryCaptureAsConstant().

◆ tryCaptureAsConstant()

static llvm::Constant* tryCaptureAsConstant	(	CodeGenModule &	CGM,
		CodeGenFunction *	CGF,
		const VarDecl *	var
	)

static

It is illegal to modify a const object after initialization.

Therefore, if a const object has a constant initializer, we don't actually need to keep storage for it in the block; we'll just rematerialize it at the start of the block function. This is acceptable because we make no promises about address stability of captured variables.

Definition at line 269 of file CGBlocks.cpp.

References clang::VarDecl::getInit(), clang::CodeGen::CodeGenModule::getLangOpts(), clang::ValueDecl::getType(), clang::QualType::isConstQualified(), isSafeForCXXConstantCapture(), and clang::CodeGen::ConstantEmitter::tryEmitAbstractForInitializer().

Referenced by computeBlockInfo().

Enumerations

Functions

Enumeration Type Documentation

◆ BlockCaptureEntityKind

Function Documentation

◆ buildBlockDescriptor()

◆ buildByrefCopyHelper()

◆ buildByrefDisposeHelper()

◆ buildByrefHelpers()

◆ buildCopyHelper()

◆ buildDisposeHelper()

◆ buildGlobalBlock()

◆ computeBlockInfo()

◆ computeCopyInfoForBlockCapture()

◆ computeDestroyInfoForBlockCapture()

◆ configureBlocksRuntimeObject()

◆ enterBlockScope()

◆ findAndRemoveBlockInfo()

◆ findBlockCapturedManagedEntities()

◆ generateByrefCopyHelper()

◆ generateByrefDisposeHelper()

◆ getBlockFieldFlagsForObjCObjectPointer()

◆ getCaptureFieldType()

◆ getLowBit()

◆ initializeForBlockHeader()

◆ isSafeForCXXConstantCapture()

◆ tryCaptureAsConstant()