12437cbfaSAnders Carlsson //===--- CGBlocks.cpp - Emit LLVM Code for declarations -------------------===// 22437cbfaSAnders Carlsson // 32437cbfaSAnders Carlsson // The LLVM Compiler Infrastructure 42437cbfaSAnders Carlsson // 52437cbfaSAnders Carlsson // This file is distributed under the University of Illinois Open Source 62437cbfaSAnders Carlsson // License. See LICENSE.TXT for details. 72437cbfaSAnders Carlsson // 82437cbfaSAnders Carlsson //===----------------------------------------------------------------------===// 92437cbfaSAnders Carlsson // 102437cbfaSAnders Carlsson // This contains code to emit blocks. 112437cbfaSAnders Carlsson // 122437cbfaSAnders Carlsson //===----------------------------------------------------------------------===// 132437cbfaSAnders Carlsson 142437cbfaSAnders Carlsson #include "CodeGenFunction.h" 152437cbfaSAnders Carlsson #include "CodeGenModule.h" 162437cbfaSAnders Carlsson #include "llvm/Module.h" 176a60fa24SAnders Carlsson #include "llvm/Target/TargetData.h" 182437cbfaSAnders Carlsson 192437cbfaSAnders Carlsson #include <algorithm> 202437cbfaSAnders Carlsson 212437cbfaSAnders Carlsson using namespace clang; 222437cbfaSAnders Carlsson using namespace CodeGen; 232437cbfaSAnders Carlsson 240874160bSMike Stump // Temporary code to enable testing of __block variables 250874160bSMike Stump // #include "clang/Frontend/CompileOptions.h" 260874160bSMike Stump #include "llvm/Support/CommandLine.h" 270874160bSMike Stump static llvm::cl::opt<bool> 280874160bSMike Stump Enable__block("f__block", 290874160bSMike Stump // See all the FIXMEs for the various work that needs to be done 300874160bSMike Stump llvm::cl::desc("temporary option to turn on __block precessing " 310874160bSMike Stump "even though the code isn't done yet"), 320874160bSMike Stump llvm::cl::ValueDisallowed, llvm::cl::AllowInverse, 330874160bSMike Stump llvm::cl::ZeroOrMore); 340874160bSMike Stump 350874160bSMike Stump 36cb2fbcb0SMike Stump llvm::Constant *CodeGenFunction::BuildDescriptorBlockDecl(uint64_t Size) { 3785284bacSMike Stump const llvm::PointerType *PtrToInt8Ty 3885284bacSMike Stump = llvm::PointerType::getUnqual(llvm::Type::Int8Ty); 39c2c38331SMike Stump const llvm::Type *UnsignedLongTy 40c2c38331SMike Stump = CGM.getTypes().ConvertType(getContext().UnsignedLongTy); 4185284bacSMike Stump llvm::Constant *C; 4285284bacSMike Stump std::vector<llvm::Constant*> Elts; 4385284bacSMike Stump 4485284bacSMike Stump // reserved 45c2c38331SMike Stump C = llvm::ConstantInt::get(UnsignedLongTy, 0); 4685284bacSMike Stump Elts.push_back(C); 4785284bacSMike Stump 4885284bacSMike Stump // Size 492ac40a9fSMike Stump // FIXME: What is the right way to say this doesn't fit? We should give 502ac40a9fSMike Stump // a user diagnostic in that case. Better fix would be to change the 512ac40a9fSMike Stump // API to size_t. 52cb2fbcb0SMike Stump C = llvm::ConstantInt::get(UnsignedLongTy, Size); 5385284bacSMike Stump Elts.push_back(C); 5485284bacSMike Stump 5585284bacSMike Stump if (BlockHasCopyDispose) { 5685284bacSMike Stump // copy_func_helper_decl 57cb2fbcb0SMike Stump // FIXME: implement 58c2c38331SMike Stump C = llvm::ConstantInt::get(UnsignedLongTy, 0); 5985284bacSMike Stump C = llvm::ConstantExpr::getBitCast(C, PtrToInt8Ty); 6085284bacSMike Stump Elts.push_back(C); 6185284bacSMike Stump 6285284bacSMike Stump // destroy_func_decl 63cb2fbcb0SMike Stump // FIXME: implement 64c2c38331SMike Stump C = llvm::ConstantInt::get(UnsignedLongTy, 0); 6585284bacSMike Stump C = llvm::ConstantExpr::getBitCast(C, PtrToInt8Ty); 6685284bacSMike Stump Elts.push_back(C); 6785284bacSMike Stump } 6885284bacSMike Stump 6985284bacSMike Stump C = llvm::ConstantStruct::get(Elts); 7085284bacSMike Stump 7185284bacSMike Stump C = new llvm::GlobalVariable(C->getType(), true, 7285284bacSMike Stump llvm::GlobalValue::InternalLinkage, 73499ae7ecSMike Stump C, "__block_descriptor_tmp", &CGM.getModule()); 7485284bacSMike Stump return C; 7585284bacSMike Stump } 7685284bacSMike Stump 7795435674SMike Stump llvm::Constant *BlockModule::getNSConcreteGlobalBlock() { 78971f9b66SMike Stump if (NSConcreteGlobalBlock) 79971f9b66SMike Stump return NSConcreteGlobalBlock; 80971f9b66SMike Stump 81971f9b66SMike Stump const llvm::PointerType *PtrToInt8Ty 82971f9b66SMike Stump = llvm::PointerType::getUnqual(llvm::Type::Int8Ty); 8352d9c49dSMike Stump // FIXME: We should have a CodeGenModule::AddRuntimeVariable that does the 84*2d33d630SMike Stump // same thing as CreateRuntimeFunction if there's already a variable with the 85*2d33d630SMike Stump // same name. 86971f9b66SMike Stump NSConcreteGlobalBlock 87971f9b66SMike Stump = new llvm::GlobalVariable(PtrToInt8Ty, false, 88971f9b66SMike Stump llvm::GlobalValue::ExternalLinkage, 89971f9b66SMike Stump 0, "_NSConcreteGlobalBlock", 90971f9b66SMike Stump &getModule()); 91971f9b66SMike Stump 92971f9b66SMike Stump return NSConcreteGlobalBlock; 93971f9b66SMike Stump } 94971f9b66SMike Stump 9595435674SMike Stump llvm::Constant *BlockModule::getNSConcreteStackBlock() { 967ab278dbSMike Stump if (NSConcreteStackBlock) 977ab278dbSMike Stump return NSConcreteStackBlock; 987ab278dbSMike Stump 997ab278dbSMike Stump const llvm::PointerType *PtrToInt8Ty 1007ab278dbSMike Stump = llvm::PointerType::getUnqual(llvm::Type::Int8Ty); 10152d9c49dSMike Stump // FIXME: We should have a CodeGenModule::AddRuntimeVariable that does the 102*2d33d630SMike Stump // same thing as CreateRuntimeFunction if there's already a variable with the 103*2d33d630SMike Stump // same name. 1047ab278dbSMike Stump NSConcreteStackBlock 1057ab278dbSMike Stump = new llvm::GlobalVariable(PtrToInt8Ty, false, 1067ab278dbSMike Stump llvm::GlobalValue::ExternalLinkage, 1077ab278dbSMike Stump 0, "_NSConcreteStackBlock", 1087ab278dbSMike Stump &getModule()); 1097ab278dbSMike Stump 1107ab278dbSMike Stump return NSConcreteStackBlock; 1117ab278dbSMike Stump } 1127ab278dbSMike Stump 113ed5e69feSAnders Carlsson static void CollectBlockDeclRefInfo(const Stmt *S, 114ed5e69feSAnders Carlsson CodeGenFunction::BlockInfo &Info) { 115ed5e69feSAnders Carlsson for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 116ed5e69feSAnders Carlsson I != E; ++I) 117dd942713SDaniel Dunbar if (*I) 118ed5e69feSAnders Carlsson CollectBlockDeclRefInfo(*I, Info); 119ed5e69feSAnders Carlsson 120ed5e69feSAnders Carlsson if (const BlockDeclRefExpr *DE = dyn_cast<BlockDeclRefExpr>(S)) { 121ed5e69feSAnders Carlsson // FIXME: Handle enums. 122ed5e69feSAnders Carlsson if (isa<FunctionDecl>(DE->getDecl())) 123ed5e69feSAnders Carlsson return; 124ed5e69feSAnders Carlsson 125ed5e69feSAnders Carlsson if (DE->isByRef()) 126ed5e69feSAnders Carlsson Info.ByRefDeclRefs.push_back(DE); 127ed5e69feSAnders Carlsson else 128ed5e69feSAnders Carlsson Info.ByCopyDeclRefs.push_back(DE); 129ed5e69feSAnders Carlsson } 130ed5e69feSAnders Carlsson } 131ed5e69feSAnders Carlsson 132*2d33d630SMike Stump /// CanBlockBeGlobal - Given a BlockInfo struct, determines if a block can be 133*2d33d630SMike Stump /// declared as a global variable instead of on the stack. 134ed5e69feSAnders Carlsson static bool CanBlockBeGlobal(const CodeGenFunction::BlockInfo &Info) 135ed5e69feSAnders Carlsson { 136ed5e69feSAnders Carlsson return Info.ByRefDeclRefs.empty() && Info.ByCopyDeclRefs.empty(); 137ed5e69feSAnders Carlsson } 138ed5e69feSAnders Carlsson 139*2d33d630SMike Stump // FIXME: Push most into CGM, passing down a few bits, like current function 140*2d33d630SMike Stump // name. 141b750d928SMike Stump llvm::Value *CodeGenFunction::BuildBlockLiteralTmp(const BlockExpr *BE) { 142ed5e69feSAnders Carlsson 143ed5e69feSAnders Carlsson std::string Name = CurFn->getName(); 144ed5e69feSAnders Carlsson CodeGenFunction::BlockInfo Info(0, Name.c_str()); 145ed5e69feSAnders Carlsson CollectBlockDeclRefInfo(BE->getBody(), Info); 146ed5e69feSAnders Carlsson 147ed5e69feSAnders Carlsson // Check if the block can be global. 148*2d33d630SMike Stump // FIXME: This test doesn't work for nested blocks yet. Longer term, I'd like 149*2d33d630SMike Stump // to just have one code path. We should move this function into CGM and pass 150*2d33d630SMike Stump // CGF, then we can just check to see if CGF is 0. 15197d01d50SMike Stump if (0 && CanBlockBeGlobal(Info)) 152ed5e69feSAnders Carlsson return CGM.GetAddrOfGlobalBlock(BE, Name.c_str()); 15385284bacSMike Stump 15485284bacSMike Stump std::vector<llvm::Constant*> Elts; 15585284bacSMike Stump llvm::Constant *C; 156b750d928SMike Stump llvm::Value *V; 15785284bacSMike Stump 15885284bacSMike Stump { 15985284bacSMike Stump // C = BuildBlockStructInitlist(); 16085284bacSMike Stump unsigned int flags = BLOCK_HAS_DESCRIPTOR; 16185284bacSMike Stump 16285284bacSMike Stump if (BlockHasCopyDispose) 16385284bacSMike Stump flags |= BLOCK_HAS_COPY_DISPOSE; 16485284bacSMike Stump 165499ae7ecSMike Stump // __isa 1667ab278dbSMike Stump C = CGM.getNSConcreteStackBlock(); 1677ab278dbSMike Stump const llvm::PointerType *PtrToInt8Ty 1687ab278dbSMike Stump = llvm::PointerType::getUnqual(llvm::Type::Int8Ty); 16985284bacSMike Stump C = llvm::ConstantExpr::getBitCast(C, PtrToInt8Ty); 17085284bacSMike Stump Elts.push_back(C); 17185284bacSMike Stump 17285284bacSMike Stump // __flags 17385284bacSMike Stump const llvm::IntegerType *IntTy = cast<llvm::IntegerType>( 17485284bacSMike Stump CGM.getTypes().ConvertType(CGM.getContext().IntTy)); 17585284bacSMike Stump C = llvm::ConstantInt::get(IntTy, flags); 17685284bacSMike Stump Elts.push_back(C); 17785284bacSMike Stump 17885284bacSMike Stump // __reserved 17985284bacSMike Stump C = llvm::ConstantInt::get(IntTy, 0); 18085284bacSMike Stump Elts.push_back(C); 18185284bacSMike Stump 1825d2534adSMike Stump // __invoke 183b750d928SMike Stump uint64_t subBlockSize, subBlockAlign; 1841db7d04bSMike Stump llvm::SmallVector<const Expr *, 8> subBlockDeclRefDecls; 185cb2fbcb0SMike Stump llvm::Function *Fn 186b750d928SMike Stump = CodeGenFunction(CGM).GenerateBlockFunction(BE, Info, subBlockSize, 187b750d928SMike Stump subBlockAlign, subBlockDeclRefDecls); 1882d5a2878SMike Stump Elts.push_back(Fn); 18985284bacSMike Stump 19085284bacSMike Stump // __descriptor 191cb2fbcb0SMike Stump Elts.push_back(BuildDescriptorBlockDecl(subBlockSize)); 19285284bacSMike Stump 193b750d928SMike Stump if (subBlockDeclRefDecls.size() == 0) { 1943a139f37SMike Stump // Optimize to being a global block. 1953a139f37SMike Stump Elts[0] = CGM.getNSConcreteGlobalBlock(); 1963a139f37SMike Stump Elts[1] = llvm::ConstantInt::get(IntTy, flags|BLOCK_IS_GLOBAL); 1973a139f37SMike Stump 19885284bacSMike Stump C = llvm::ConstantStruct::get(Elts); 19985284bacSMike Stump 20085284bacSMike Stump char Name[32]; 2019319db8aSMike Stump sprintf(Name, "__block_holder_tmp_%d", CGM.getGlobalUniqueCount()); 20285284bacSMike Stump C = new llvm::GlobalVariable(C->getType(), true, 20385284bacSMike Stump llvm::GlobalValue::InternalLinkage, 20485284bacSMike Stump C, Name, &CGM.getModule()); 2055d2534adSMike Stump QualType BPT = BE->getType(); 2065d2534adSMike Stump C = llvm::ConstantExpr::getBitCast(C, ConvertType(BPT)); 20785284bacSMike Stump return C; 20885284bacSMike Stump } 20985284bacSMike Stump 210b750d928SMike Stump std::vector<const llvm::Type *> Types(5+subBlockDeclRefDecls.size()); 211b750d928SMike Stump for (int i=0; i<5; ++i) 212b750d928SMike Stump Types[i] = Elts[i]->getType(); 21385284bacSMike Stump 2141db7d04bSMike Stump for (unsigned i=0; i < subBlockDeclRefDecls.size(); ++i) { 2151db7d04bSMike Stump const Expr *E = subBlockDeclRefDecls[i]; 2161db7d04bSMike Stump const BlockDeclRefExpr *BDRE = dyn_cast<BlockDeclRefExpr>(E); 2171db7d04bSMike Stump QualType Ty = E->getType(); 21897d01d50SMike Stump if (BDRE && BDRE->isByRef()) { 21997d01d50SMike Stump uint64_t Align = getContext().getDeclAlignInBytes(BDRE->getDecl()); 22097d01d50SMike Stump Types[i+5] = llvm::PointerType::get(BuildByRefType(Ty, Align), 0); 22197d01d50SMike Stump } else 2221db7d04bSMike Stump Types[i+5] = ConvertType(Ty); 2231db7d04bSMike Stump } 224b750d928SMike Stump 225b750d928SMike Stump llvm::Type *Ty = llvm::StructType::get(Types, true); 226b750d928SMike Stump 227b750d928SMike Stump llvm::AllocaInst *A = CreateTempAlloca(Ty); 228b750d928SMike Stump A->setAlignment(subBlockAlign); 229b750d928SMike Stump V = A; 230b750d928SMike Stump 231b750d928SMike Stump for (unsigned i=0; i<5; ++i) 232b750d928SMike Stump Builder.CreateStore(Elts[i], Builder.CreateStructGEP(V, i, "block.tmp")); 233b750d928SMike Stump 234b750d928SMike Stump for (unsigned i=0; i < subBlockDeclRefDecls.size(); ++i) 235b750d928SMike Stump { 2361db7d04bSMike Stump // FIXME: Push const down. 2371db7d04bSMike Stump Expr *E = const_cast<Expr*>(subBlockDeclRefDecls[i]); 2381db7d04bSMike Stump DeclRefExpr *DR; 2391db7d04bSMike Stump ValueDecl *VD; 240b750d928SMike Stump 2411db7d04bSMike Stump DR = dyn_cast<DeclRefExpr>(E); 2421db7d04bSMike Stump // Skip padding. 2431db7d04bSMike Stump if (DR) continue; 2441db7d04bSMike Stump 2451db7d04bSMike Stump BlockDeclRefExpr *BDRE = dyn_cast<BlockDeclRefExpr>(E); 2461db7d04bSMike Stump VD = BDRE->getDecl(); 2471db7d04bSMike Stump 24897d01d50SMike Stump llvm::Value* Addr = Builder.CreateStructGEP(V, i+5, "tmp"); 2491db7d04bSMike Stump // FIXME: I want a better way to do this. 2501db7d04bSMike Stump if (LocalDeclMap[VD]) { 25197d01d50SMike Stump if (BDRE->isByRef()) { 25297d01d50SMike Stump const llvm::Type *Ty = Types[i+5]; 25397d01d50SMike Stump llvm::Value *Loc = LocalDeclMap[VD]; 25497d01d50SMike Stump Loc = Builder.CreateStructGEP(Loc, 1, "forwarding"); 25597d01d50SMike Stump Loc = Builder.CreateLoad(Loc, false); 25697d01d50SMike Stump Loc = Builder.CreateBitCast(Loc, Ty); 25797d01d50SMike Stump Builder.CreateStore(Loc, Addr); 25897d01d50SMike Stump continue; 25997d01d50SMike Stump } else 2601db7d04bSMike Stump E = new (getContext()) DeclRefExpr (cast<NamedDecl>(VD), 2611db7d04bSMike Stump VD->getType(), SourceLocation(), 2621db7d04bSMike Stump false, false); 2631db7d04bSMike Stump } 26497d01d50SMike Stump if (BDRE->isByRef()) { 26597d01d50SMike Stump // FIXME: __block in nested literals 2661db7d04bSMike Stump E = new (getContext()) 2671db7d04bSMike Stump UnaryOperator(E, UnaryOperator::AddrOf, 2681db7d04bSMike Stump getContext().getPointerType(E->getType()), 2691db7d04bSMike Stump SourceLocation()); 27097d01d50SMike Stump } 2711db7d04bSMike Stump 2721db7d04bSMike Stump RValue r = EmitAnyExpr(E, Addr, false); 27397d01d50SMike Stump if (r.isScalar()) { 27497d01d50SMike Stump llvm::Value *Loc = r.getScalarVal(); 27597d01d50SMike Stump const llvm::Type *Ty = Types[i+5]; 27697d01d50SMike Stump if (BDRE->isByRef()) { 277*2d33d630SMike Stump // E is now the address of the value field, instead, we want the 278*2d33d630SMike Stump // address of the actual ByRef struct. We optimize this slightly 279*2d33d630SMike Stump // compared to gcc by not grabbing the forwarding slot as this must 280*2d33d630SMike Stump // be done during Block_copy for us, and we can postpone the work 281*2d33d630SMike Stump // until then. 282*2d33d630SMike Stump uint64_t offset = BlockDecls[BDRE->getDecl()]; 283*2d33d630SMike Stump 284*2d33d630SMike Stump llvm::Value *BlockLiteral = LoadBlockStruct(); 285*2d33d630SMike Stump 286*2d33d630SMike Stump Loc = Builder.CreateGEP(BlockLiteral, 287*2d33d630SMike Stump llvm::ConstantInt::get(llvm::Type::Int64Ty, 288*2d33d630SMike Stump offset), 289*2d33d630SMike Stump "block.literal"); 290*2d33d630SMike Stump Ty = llvm::PointerType::get(Ty, 0); 29197d01d50SMike Stump Loc = Builder.CreateBitCast(Loc, Ty); 292*2d33d630SMike Stump Loc = Builder.CreateLoad(Loc, false); 293*2d33d630SMike Stump // Loc = Builder.CreateBitCast(Loc, Ty); 29497d01d50SMike Stump } 29597d01d50SMike Stump Builder.CreateStore(Loc, Addr); 29697d01d50SMike Stump } else if (r.isComplex()) 297b750d928SMike Stump // FIXME: implement 298b750d928SMike Stump ErrorUnsupported(BE, "complex in block literal"); 299b750d928SMike Stump else if (r.isAggregate()) 300b750d928SMike Stump ; // Already created into the destination 301b750d928SMike Stump else 302b750d928SMike Stump assert (0 && "bad block variable"); 303b750d928SMike Stump // FIXME: Ensure that the offset created by the backend for 304b750d928SMike Stump // the struct matches the previously computed offset in BlockDecls. 305b750d928SMike Stump } 306b750d928SMike Stump } 307b750d928SMike Stump 308b750d928SMike Stump QualType BPT = BE->getType(); 309b750d928SMike Stump return Builder.CreateBitCast(V, ConvertType(BPT)); 310b750d928SMike Stump } 31185284bacSMike Stump 31285284bacSMike Stump 31395435674SMike Stump const llvm::Type *BlockModule::getBlockDescriptorType() { 314650c932dSMike Stump if (BlockDescriptorType) 315650c932dSMike Stump return BlockDescriptorType; 3162437cbfaSAnders Carlsson 3172437cbfaSAnders Carlsson const llvm::Type *UnsignedLongTy = 318650c932dSMike Stump getTypes().ConvertType(getContext().UnsignedLongTy); 3192437cbfaSAnders Carlsson 3202437cbfaSAnders Carlsson // struct __block_descriptor { 3212437cbfaSAnders Carlsson // unsigned long reserved; 3222437cbfaSAnders Carlsson // unsigned long block_size; 3232437cbfaSAnders Carlsson // }; 324650c932dSMike Stump BlockDescriptorType = llvm::StructType::get(UnsignedLongTy, 3252437cbfaSAnders Carlsson UnsignedLongTy, 3262437cbfaSAnders Carlsson NULL); 3272437cbfaSAnders Carlsson 328650c932dSMike Stump getModule().addTypeName("struct.__block_descriptor", 329650c932dSMike Stump BlockDescriptorType); 3302437cbfaSAnders Carlsson 331650c932dSMike Stump return BlockDescriptorType; 3322437cbfaSAnders Carlsson } 3332437cbfaSAnders Carlsson 33495435674SMike Stump const llvm::Type *BlockModule::getGenericBlockLiteralType() { 335005c9a62SMike Stump if (GenericBlockLiteralType) 336005c9a62SMike Stump return GenericBlockLiteralType; 3372437cbfaSAnders Carlsson 3382437cbfaSAnders Carlsson const llvm::Type *Int8PtrTy = 3392437cbfaSAnders Carlsson llvm::PointerType::getUnqual(llvm::Type::Int8Ty); 3402437cbfaSAnders Carlsson 3412437cbfaSAnders Carlsson const llvm::Type *BlockDescPtrTy = 342005c9a62SMike Stump llvm::PointerType::getUnqual(getBlockDescriptorType()); 3432437cbfaSAnders Carlsson 34492bbd6d4SMike Stump const llvm::IntegerType *IntTy = cast<llvm::IntegerType>( 34592bbd6d4SMike Stump getTypes().ConvertType(getContext().IntTy)); 34692bbd6d4SMike Stump 3472437cbfaSAnders Carlsson // struct __block_literal_generic { 3485d2534adSMike Stump // void *__isa; 3495d2534adSMike Stump // int __flags; 3505d2534adSMike Stump // int __reserved; 3515d2534adSMike Stump // void (*__invoke)(void *); 3525d2534adSMike Stump // struct __block_descriptor *__descriptor; 3532437cbfaSAnders Carlsson // }; 354005c9a62SMike Stump GenericBlockLiteralType = llvm::StructType::get(Int8PtrTy, 35592bbd6d4SMike Stump IntTy, 35692bbd6d4SMike Stump IntTy, 3572437cbfaSAnders Carlsson Int8PtrTy, 3582437cbfaSAnders Carlsson BlockDescPtrTy, 3592437cbfaSAnders Carlsson NULL); 3602437cbfaSAnders Carlsson 361005c9a62SMike Stump getModule().addTypeName("struct.__block_literal_generic", 362005c9a62SMike Stump GenericBlockLiteralType); 3632437cbfaSAnders Carlsson 364005c9a62SMike Stump return GenericBlockLiteralType; 3652437cbfaSAnders Carlsson } 3662437cbfaSAnders Carlsson 36795435674SMike Stump const llvm::Type *BlockModule::getGenericExtendedBlockLiteralType() { 3685d2534adSMike Stump if (GenericExtendedBlockLiteralType) 3695d2534adSMike Stump return GenericExtendedBlockLiteralType; 3705d2534adSMike Stump 3715d2534adSMike Stump const llvm::Type *Int8PtrTy = 3725d2534adSMike Stump llvm::PointerType::getUnqual(llvm::Type::Int8Ty); 3735d2534adSMike Stump 3745d2534adSMike Stump const llvm::Type *BlockDescPtrTy = 3755d2534adSMike Stump llvm::PointerType::getUnqual(getBlockDescriptorType()); 3765d2534adSMike Stump 3775d2534adSMike Stump const llvm::IntegerType *IntTy = cast<llvm::IntegerType>( 3785d2534adSMike Stump getTypes().ConvertType(getContext().IntTy)); 3795d2534adSMike Stump 3805d2534adSMike Stump // struct __block_literal_generic { 3815d2534adSMike Stump // void *__isa; 3825d2534adSMike Stump // int __flags; 3835d2534adSMike Stump // int __reserved; 3845d2534adSMike Stump // void (*__invoke)(void *); 3855d2534adSMike Stump // struct __block_descriptor *__descriptor; 3865d2534adSMike Stump // void *__copy_func_helper_decl; 3875d2534adSMike Stump // void *__destroy_func_decl; 3885d2534adSMike Stump // }; 3895d2534adSMike Stump GenericExtendedBlockLiteralType = llvm::StructType::get(Int8PtrTy, 3905d2534adSMike Stump IntTy, 3915d2534adSMike Stump IntTy, 3925d2534adSMike Stump Int8PtrTy, 3935d2534adSMike Stump BlockDescPtrTy, 3945d2534adSMike Stump Int8PtrTy, 3955d2534adSMike Stump Int8PtrTy, 3965d2534adSMike Stump NULL); 3975d2534adSMike Stump 3985d2534adSMike Stump getModule().addTypeName("struct.__block_literal_extended_generic", 3995d2534adSMike Stump GenericExtendedBlockLiteralType); 4005d2534adSMike Stump 4015d2534adSMike Stump return GenericExtendedBlockLiteralType; 4025d2534adSMike Stump } 4035d2534adSMike Stump 4042437cbfaSAnders Carlsson /// getBlockFunctionType - Given a BlockPointerType, will return the 4052437cbfaSAnders Carlsson /// function type for the block, including the first block literal argument. 4062437cbfaSAnders Carlsson static QualType getBlockFunctionType(ASTContext &Ctx, 4076a60fa24SAnders Carlsson const BlockPointerType *BPT) { 408deaad8ccSDouglas Gregor const FunctionProtoType *FTy = cast<FunctionProtoType>(BPT->getPointeeType()); 4092437cbfaSAnders Carlsson 4102437cbfaSAnders Carlsson llvm::SmallVector<QualType, 8> Types; 4112437cbfaSAnders Carlsson Types.push_back(Ctx.getPointerType(Ctx.VoidTy)); 4122437cbfaSAnders Carlsson 413deaad8ccSDouglas Gregor for (FunctionProtoType::arg_type_iterator i = FTy->arg_type_begin(), 4142437cbfaSAnders Carlsson e = FTy->arg_type_end(); i != e; ++i) 4152437cbfaSAnders Carlsson Types.push_back(*i); 4162437cbfaSAnders Carlsson 4172437cbfaSAnders Carlsson return Ctx.getFunctionType(FTy->getResultType(), 4182437cbfaSAnders Carlsson &Types[0], Types.size(), 4192437cbfaSAnders Carlsson FTy->isVariadic(), 0); 4202437cbfaSAnders Carlsson } 4212437cbfaSAnders Carlsson 4226a60fa24SAnders Carlsson RValue CodeGenFunction::EmitBlockCallExpr(const CallExpr* E) { 4232437cbfaSAnders Carlsson const BlockPointerType *BPT = 4242437cbfaSAnders Carlsson E->getCallee()->getType()->getAsBlockPointerType(); 4252437cbfaSAnders Carlsson 4262437cbfaSAnders Carlsson llvm::Value *Callee = EmitScalarExpr(E->getCallee()); 4272437cbfaSAnders Carlsson 4282437cbfaSAnders Carlsson // Get a pointer to the generic block literal. 4292437cbfaSAnders Carlsson const llvm::Type *BlockLiteralTy = 430005c9a62SMike Stump llvm::PointerType::getUnqual(CGM.getGenericBlockLiteralType()); 4312437cbfaSAnders Carlsson 4322437cbfaSAnders Carlsson // Bitcast the callee to a block literal. 4332437cbfaSAnders Carlsson llvm::Value *BlockLiteral = 4342437cbfaSAnders Carlsson Builder.CreateBitCast(Callee, BlockLiteralTy, "block.literal"); 4352437cbfaSAnders Carlsson 4362437cbfaSAnders Carlsson // Get the function pointer from the literal. 4372437cbfaSAnders Carlsson llvm::Value *FuncPtr = Builder.CreateStructGEP(BlockLiteral, 3, "tmp"); 438624497c2SMike Stump llvm::Value *Func = Builder.CreateLoad(FuncPtr, false, "tmp"); 4392437cbfaSAnders Carlsson 4402437cbfaSAnders Carlsson // Cast the function pointer to the right type. 4412437cbfaSAnders Carlsson const llvm::Type *BlockFTy = 4422437cbfaSAnders Carlsson ConvertType(getBlockFunctionType(getContext(), BPT)); 4432437cbfaSAnders Carlsson const llvm::Type *BlockFTyPtr = llvm::PointerType::getUnqual(BlockFTy); 4442437cbfaSAnders Carlsson Func = Builder.CreateBitCast(Func, BlockFTyPtr); 4452437cbfaSAnders Carlsson 4462437cbfaSAnders Carlsson BlockLiteral = 4472437cbfaSAnders Carlsson Builder.CreateBitCast(BlockLiteral, 4482437cbfaSAnders Carlsson llvm::PointerType::getUnqual(llvm::Type::Int8Ty), 4492437cbfaSAnders Carlsson "tmp"); 4502437cbfaSAnders Carlsson 4512437cbfaSAnders Carlsson // Add the block literal. 4522437cbfaSAnders Carlsson QualType VoidPtrTy = getContext().getPointerType(getContext().VoidTy); 4532437cbfaSAnders Carlsson CallArgList Args; 4542437cbfaSAnders Carlsson Args.push_back(std::make_pair(RValue::get(BlockLiteral), VoidPtrTy)); 4552437cbfaSAnders Carlsson 4562437cbfaSAnders Carlsson // And the rest of the arguments. 4572437cbfaSAnders Carlsson for (CallExpr::const_arg_iterator i = E->arg_begin(), e = E->arg_end(); 4582437cbfaSAnders Carlsson i != e; ++i) 4592437cbfaSAnders Carlsson Args.push_back(std::make_pair(EmitAnyExprToTemp(*i), 4602437cbfaSAnders Carlsson i->getType())); 4612437cbfaSAnders Carlsson 4622437cbfaSAnders Carlsson // And call the block. 4632437cbfaSAnders Carlsson return EmitCall(CGM.getTypes().getFunctionInfo(E->getType(), Args), 4642437cbfaSAnders Carlsson Func, Args); 4652437cbfaSAnders Carlsson } 4666a60fa24SAnders Carlsson 46797d01d50SMike Stump llvm::Value *CodeGenFunction::GetAddrOfBlockDecl(const BlockDeclRefExpr *E) { 46897d01d50SMike Stump uint64_t &offset = BlockDecls[E->getDecl()]; 46997d01d50SMike Stump 47097d01d50SMike Stump const llvm::Type *Ty; 47197d01d50SMike Stump Ty = CGM.getTypes().ConvertType(E->getDecl()->getType()); 47297d01d50SMike Stump 47397d01d50SMike Stump // FIXME: add support for copy/dispose helpers. 4740874160bSMike Stump if (!Enable__block && E->isByRef()) 47597d01d50SMike Stump ErrorUnsupported(E, "__block variable in block literal"); 47697d01d50SMike Stump else if (E->getType()->isBlockPointerType()) 47797d01d50SMike Stump ErrorUnsupported(E, "block pointer in block literal"); 47897d01d50SMike Stump else if (E->getDecl()->getAttr<ObjCNSObjectAttr>() || 47997d01d50SMike Stump getContext().isObjCNSObjectType(E->getType())) 48097d01d50SMike Stump ErrorUnsupported(E, "__attribute__((NSObject)) variable in block " 48197d01d50SMike Stump "literal"); 48297d01d50SMike Stump else if (getContext().isObjCObjectPointerType(E->getType())) 48397d01d50SMike Stump ErrorUnsupported(E, "Objective-C variable in block literal"); 48497d01d50SMike Stump 48597d01d50SMike Stump // See if we have already allocated an offset for this variable. 48697d01d50SMike Stump if (offset == 0) { 48797d01d50SMike Stump // if not, allocate one now. 48897d01d50SMike Stump offset = getBlockOffset(E); 48997d01d50SMike Stump } 49097d01d50SMike Stump 49197d01d50SMike Stump llvm::Value *BlockLiteral = LoadBlockStruct(); 49297d01d50SMike Stump llvm::Value *V = Builder.CreateGEP(BlockLiteral, 49397d01d50SMike Stump llvm::ConstantInt::get(llvm::Type::Int64Ty, 49497d01d50SMike Stump offset), 495*2d33d630SMike Stump "block.literal"); 49697d01d50SMike Stump if (E->isByRef()) { 49797d01d50SMike Stump bool needsCopyDispose = BlockRequiresCopying(E->getType()); 49897d01d50SMike Stump uint64_t Align = getContext().getDeclAlignInBytes(E->getDecl()); 49997d01d50SMike Stump const llvm::Type *PtrStructTy 50097d01d50SMike Stump = llvm::PointerType::get(BuildByRefType(E->getType(), Align), 0); 50197d01d50SMike Stump Ty = PtrStructTy; 50297d01d50SMike Stump Ty = llvm::PointerType::get(Ty, 0); 50397d01d50SMike Stump V = Builder.CreateBitCast(V, Ty); 50497d01d50SMike Stump V = Builder.CreateLoad(V, false); 50597d01d50SMike Stump V = Builder.CreateStructGEP(V, 1, "forwarding"); 50697d01d50SMike Stump V = Builder.CreateLoad(V, false); 50797d01d50SMike Stump V = Builder.CreateBitCast(V, PtrStructTy); 50897d01d50SMike Stump V = Builder.CreateStructGEP(V, needsCopyDispose*2 + 4, "x"); 50997d01d50SMike Stump } else { 51097d01d50SMike Stump Ty = llvm::PointerType::get(Ty, 0); 51197d01d50SMike Stump V = Builder.CreateBitCast(V, Ty); 51297d01d50SMike Stump } 51397d01d50SMike Stump return V; 51497d01d50SMike Stump } 51597d01d50SMike Stump 5162d5a2878SMike Stump llvm::Constant * 5176c39666aSMike Stump BlockModule::GetAddrOfGlobalBlock(const BlockExpr *BE, const char * n) { 5186a60fa24SAnders Carlsson // Generate the block descriptor. 5196a60fa24SAnders Carlsson const llvm::Type *UnsignedLongTy = Types.ConvertType(Context.UnsignedLongTy); 52092bbd6d4SMike Stump const llvm::IntegerType *IntTy = cast<llvm::IntegerType>( 52192bbd6d4SMike Stump getTypes().ConvertType(getContext().IntTy)); 5226a60fa24SAnders Carlsson 5236a60fa24SAnders Carlsson llvm::Constant *DescriptorFields[2]; 5246a60fa24SAnders Carlsson 5256a60fa24SAnders Carlsson // Reserved 5266a60fa24SAnders Carlsson DescriptorFields[0] = llvm::Constant::getNullValue(UnsignedLongTy); 5276a60fa24SAnders Carlsson 5286a60fa24SAnders Carlsson // Block literal size. For global blocks we just use the size of the generic 5296a60fa24SAnders Carlsson // block literal struct. 5306a60fa24SAnders Carlsson uint64_t BlockLiteralSize = 531005c9a62SMike Stump TheTargetData.getTypeStoreSizeInBits(getGenericBlockLiteralType()) / 8; 5326a60fa24SAnders Carlsson DescriptorFields[1] = llvm::ConstantInt::get(UnsignedLongTy,BlockLiteralSize); 5336a60fa24SAnders Carlsson 5346a60fa24SAnders Carlsson llvm::Constant *DescriptorStruct = 5356a60fa24SAnders Carlsson llvm::ConstantStruct::get(&DescriptorFields[0], 2); 5366a60fa24SAnders Carlsson 5376a60fa24SAnders Carlsson llvm::GlobalVariable *Descriptor = 5386a60fa24SAnders Carlsson new llvm::GlobalVariable(DescriptorStruct->getType(), true, 5396a60fa24SAnders Carlsson llvm::GlobalVariable::InternalLinkage, 5406a60fa24SAnders Carlsson DescriptorStruct, "__block_descriptor_global", 5416a60fa24SAnders Carlsson &getModule()); 5426a60fa24SAnders Carlsson 5436a60fa24SAnders Carlsson // Generate the constants for the block literal. 5446a60fa24SAnders Carlsson llvm::Constant *LiteralFields[5]; 5456a60fa24SAnders Carlsson 5462d5a2878SMike Stump CodeGenFunction::BlockInfo Info(0, n); 547b750d928SMike Stump uint64_t subBlockSize, subBlockAlign; 5481db7d04bSMike Stump llvm::SmallVector<const Expr *, 8> subBlockDeclRefDecls; 549cb2fbcb0SMike Stump llvm::Function *Fn 5506c39666aSMike Stump = CodeGenFunction(CGM).GenerateBlockFunction(BE, Info, subBlockSize, 551b750d928SMike Stump subBlockAlign, 552b750d928SMike Stump subBlockDeclRefDecls); 553cb2fbcb0SMike Stump assert(subBlockSize == BlockLiteralSize 554cb2fbcb0SMike Stump && "no imports allowed for global block"); 5556a60fa24SAnders Carlsson 5566a60fa24SAnders Carlsson // isa 557971f9b66SMike Stump LiteralFields[0] = getNSConcreteGlobalBlock(); 5586a60fa24SAnders Carlsson 5596a60fa24SAnders Carlsson // Flags 5605878c797SAnders Carlsson LiteralFields[1] = 5615878c797SAnders Carlsson llvm::ConstantInt::get(IntTy, BLOCK_IS_GLOBAL | BLOCK_HAS_DESCRIPTOR); 5626a60fa24SAnders Carlsson 5636a60fa24SAnders Carlsson // Reserved 56492bbd6d4SMike Stump LiteralFields[2] = llvm::Constant::getNullValue(IntTy); 5656a60fa24SAnders Carlsson 5666a60fa24SAnders Carlsson // Function 5676a60fa24SAnders Carlsson LiteralFields[3] = Fn; 5686a60fa24SAnders Carlsson 5696a60fa24SAnders Carlsson // Descriptor 5706a60fa24SAnders Carlsson LiteralFields[4] = Descriptor; 5716a60fa24SAnders Carlsson 5726a60fa24SAnders Carlsson llvm::Constant *BlockLiteralStruct = 5736a60fa24SAnders Carlsson llvm::ConstantStruct::get(&LiteralFields[0], 5); 5746a60fa24SAnders Carlsson 5756a60fa24SAnders Carlsson llvm::GlobalVariable *BlockLiteral = 5766a60fa24SAnders Carlsson new llvm::GlobalVariable(BlockLiteralStruct->getType(), true, 5776a60fa24SAnders Carlsson llvm::GlobalVariable::InternalLinkage, 5786a60fa24SAnders Carlsson BlockLiteralStruct, "__block_literal_global", 5796a60fa24SAnders Carlsson &getModule()); 5806a60fa24SAnders Carlsson 5816a60fa24SAnders Carlsson return BlockLiteral; 5826a60fa24SAnders Carlsson } 5836a60fa24SAnders Carlsson 584cb2fbcb0SMike Stump llvm::Value *CodeGenFunction::LoadBlockStruct() { 585cb2fbcb0SMike Stump return Builder.CreateLoad(LocalDeclMap[getBlockStructDecl()], "self"); 586cb2fbcb0SMike Stump } 587cb2fbcb0SMike Stump 5883385fe12SChris Lattner llvm::Function *CodeGenFunction::GenerateBlockFunction(const BlockExpr *BExpr, 589cb2fbcb0SMike Stump const BlockInfo& Info, 590b750d928SMike Stump uint64_t &Size, 591b750d928SMike Stump uint64_t &Align, 5921db7d04bSMike Stump llvm::SmallVector<const Expr *, 8> &subBlockDeclRefDecls) { 593deaad8ccSDouglas Gregor const FunctionProtoType *FTy = 5943385fe12SChris Lattner cast<FunctionProtoType>(BExpr->getFunctionType()); 5956a60fa24SAnders Carlsson 5966a60fa24SAnders Carlsson FunctionArgList Args; 5976a60fa24SAnders Carlsson 5983385fe12SChris Lattner const BlockDecl *BD = BExpr->getBlockDecl(); 5996a60fa24SAnders Carlsson 6006a60fa24SAnders Carlsson // FIXME: This leaks 6016a60fa24SAnders Carlsson ImplicitParamDecl *SelfDecl = 6026a60fa24SAnders Carlsson ImplicitParamDecl::Create(getContext(), 0, 6036a60fa24SAnders Carlsson SourceLocation(), 0, 6046a60fa24SAnders Carlsson getContext().getPointerType(getContext().VoidTy)); 6056a60fa24SAnders Carlsson 6066a60fa24SAnders Carlsson Args.push_back(std::make_pair(SelfDecl, SelfDecl->getType())); 607cb2fbcb0SMike Stump BlockStructDecl = SelfDecl; 6086a60fa24SAnders Carlsson 6096a60fa24SAnders Carlsson for (BlockDecl::param_iterator i = BD->param_begin(), 6106a60fa24SAnders Carlsson e = BD->param_end(); i != e; ++i) 611eecd39f2SMike Stump Args.push_back(std::make_pair(*i, (*i)->getType())); 6126a60fa24SAnders Carlsson 6136a60fa24SAnders Carlsson const CGFunctionInfo &FI = 6146a60fa24SAnders Carlsson CGM.getTypes().getFunctionInfo(FTy->getResultType(), Args); 6156a60fa24SAnders Carlsson 6162d5a2878SMike Stump std::string Name = std::string("__") + Info.Name + "_block_invoke_"; 6176a60fa24SAnders Carlsson CodeGenTypes &Types = CGM.getTypes(); 6186a60fa24SAnders Carlsson const llvm::FunctionType *LTy = Types.GetFunctionType(FI, FTy->isVariadic()); 6196a60fa24SAnders Carlsson 6206a60fa24SAnders Carlsson llvm::Function *Fn = 6216a60fa24SAnders Carlsson llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage, 6226a60fa24SAnders Carlsson Name, 6236a60fa24SAnders Carlsson &CGM.getModule()); 6246a60fa24SAnders Carlsson 6256a60fa24SAnders Carlsson StartFunction(BD, FTy->getResultType(), Fn, Args, 6263385fe12SChris Lattner BExpr->getBody()->getLocEnd()); 6273385fe12SChris Lattner EmitStmt(BExpr->getBody()); 6283385fe12SChris Lattner FinishFunction(cast<CompoundStmt>(BExpr->getBody())->getRBracLoc()); 6296a60fa24SAnders Carlsson 630b750d928SMike Stump // The runtime needs a minimum alignment of a void *. 631b750d928SMike Stump uint64_t MinAlign = getContext().getTypeAlign(getContext().VoidPtrTy) / 8; 632b750d928SMike Stump BlockOffset = llvm::RoundUpToAlignment(BlockOffset, MinAlign); 633b750d928SMike Stump 634cb2fbcb0SMike Stump Size = BlockOffset; 635b750d928SMike Stump Align = BlockAlign; 636b750d928SMike Stump subBlockDeclRefDecls = BlockDeclRefDecls; 637cb2fbcb0SMike Stump 6386a60fa24SAnders Carlsson return Fn; 6396a60fa24SAnders Carlsson } 6401db7d04bSMike Stump 6411db7d04bSMike Stump uint64_t CodeGenFunction::getBlockOffset(const BlockDeclRefExpr *BDRE) { 6421db7d04bSMike Stump const ValueDecl *D = dyn_cast<ValueDecl>(BDRE->getDecl()); 6431db7d04bSMike Stump 6441db7d04bSMike Stump uint64_t Size = getContext().getTypeSize(D->getType()) / 8; 6451db7d04bSMike Stump uint64_t Align = getContext().getDeclAlignInBytes(D); 6461db7d04bSMike Stump 6471db7d04bSMike Stump if (BDRE->isByRef()) { 6481db7d04bSMike Stump Size = getContext().getTypeSize(getContext().VoidPtrTy) / 8; 6491db7d04bSMike Stump Align = getContext().getTypeAlign(getContext().VoidPtrTy) / 8; 6501db7d04bSMike Stump } 6511db7d04bSMike Stump 6521db7d04bSMike Stump assert ((Align > 0) && "alignment must be 1 byte or more"); 6531db7d04bSMike Stump 6541db7d04bSMike Stump uint64_t OldOffset = BlockOffset; 6551db7d04bSMike Stump 6561db7d04bSMike Stump // Ensure proper alignment, even if it means we have to have a gap 6571db7d04bSMike Stump BlockOffset = llvm::RoundUpToAlignment(BlockOffset, Align); 6581db7d04bSMike Stump BlockAlign = std::max(Align, BlockAlign); 6591db7d04bSMike Stump 6601db7d04bSMike Stump uint64_t Pad = BlockOffset - OldOffset; 6611db7d04bSMike Stump if (Pad) { 6621db7d04bSMike Stump llvm::ArrayType::get(llvm::Type::Int8Ty, Pad); 6631db7d04bSMike Stump QualType PadTy = getContext().getConstantArrayType(getContext().CharTy, 6641db7d04bSMike Stump llvm::APInt(32, Pad), 6651db7d04bSMike Stump ArrayType::Normal, 0); 6661db7d04bSMike Stump ValueDecl *PadDecl = VarDecl::Create(getContext(), 0, SourceLocation(), 6671db7d04bSMike Stump 0, QualType(PadTy), VarDecl::None, 6681db7d04bSMike Stump SourceLocation()); 6691db7d04bSMike Stump Expr *E; 6701db7d04bSMike Stump E = new (getContext()) DeclRefExpr(PadDecl, PadDecl->getType(), 6711db7d04bSMike Stump SourceLocation(), false, false); 6721db7d04bSMike Stump BlockDeclRefDecls.push_back(E); 6731db7d04bSMike Stump } 6741db7d04bSMike Stump BlockDeclRefDecls.push_back(BDRE); 6751db7d04bSMike Stump 6761db7d04bSMike Stump BlockOffset += Size; 6771db7d04bSMike Stump return BlockOffset-Size; 6781db7d04bSMike Stump } 67997d01d50SMike Stump 68006acea8aSMike Stump llvm::Value *BlockFunction::BuildCopyHelper(int flag) { 68197d01d50SMike Stump const llvm::PointerType *PtrToInt8Ty 68297d01d50SMike Stump = llvm::PointerType::getUnqual(llvm::Type::Int8Ty); 68397d01d50SMike Stump // FIXME: implement 68497d01d50SMike Stump llvm::Value *V = llvm::ConstantInt::get(llvm::Type::Int32Ty, 43); 68597d01d50SMike Stump V = Builder.CreateIntToPtr(V, PtrToInt8Ty, "tmp"); 68697d01d50SMike Stump V = Builder.CreateBitCast(V, PtrToInt8Ty, "tmp"); 68797d01d50SMike Stump return V; 68897d01d50SMike Stump } 68997d01d50SMike Stump 69006acea8aSMike Stump llvm::Value *BlockFunction::BuildDestroyHelper(int flag) { 69197d01d50SMike Stump const llvm::PointerType *PtrToInt8Ty 69297d01d50SMike Stump = llvm::PointerType::getUnqual(llvm::Type::Int8Ty); 69397d01d50SMike Stump // FIXME: implement 69497d01d50SMike Stump llvm::Value *V = llvm::ConstantInt::get(llvm::Type::Int32Ty, 44); 69597d01d50SMike Stump V = Builder.CreateIntToPtr(V, PtrToInt8Ty, "tmp"); 69697d01d50SMike Stump V = Builder.CreateBitCast(V, PtrToInt8Ty, "tmp"); 69797d01d50SMike Stump return V; 69897d01d50SMike Stump } 699