blob: ca78781ec65d23e7292e8e901792f06dd6630334 [file] [log] [blame]
Anders Carlssonacfde802009-02-12 00:39:25 +00001//===--- CGBlocks.cpp - Emit LLVM Code for declarations -------------------===//
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
Mike Stumpb1a6e682009-09-30 02:43:10 +000014#include "CGDebugInfo.h"
Anders Carlssonacfde802009-02-12 00:39:25 +000015#include "CodeGenFunction.h"
Fariborz Jahanian263c4de2010-02-10 23:34:57 +000016#include "CGObjCRuntime.h"
Anders Carlssonacfde802009-02-12 00:39:25 +000017#include "CodeGenModule.h"
Mike Stump6cc88f72009-03-20 21:53:12 +000018#include "clang/AST/DeclObjC.h"
Anders Carlssonacfde802009-02-12 00:39:25 +000019#include "llvm/Module.h"
Benjamin Kramer6876fe62010-03-31 15:04:05 +000020#include "llvm/ADT/SmallSet.h"
Anders Carlssond5cab542009-02-12 17:55:02 +000021#include "llvm/Target/TargetData.h"
Anders Carlssonacfde802009-02-12 00:39:25 +000022#include <algorithm>
Torok Edwinf42e4a62009-08-24 13:25:12 +000023
Anders Carlssonacfde802009-02-12 00:39:25 +000024using namespace clang;
25using namespace CodeGen;
26
John McCallee504292010-05-21 04:11:14 +000027CGBlockInfo::CGBlockInfo(const char *N)
28 : Name(N), CXXThisRef(0), NeedsObjCSelf(false) {
29
30 // Skip asm prefix, if any.
31 if (Name && Name[0] == '\01')
32 ++Name;
33}
34
35
Mike Stumpcf62d392009-03-06 18:42:23 +000036llvm::Constant *CodeGenFunction::
Fariborz Jahanian89ecd412010-08-04 16:57:49 +000037BuildDescriptorBlockDecl(const BlockExpr *BE, const CGBlockInfo &Info,
Mike Stumpa803b0e2009-03-25 17:58:24 +000038 const llvm::StructType* Ty,
Fariborz Jahanian44034db2010-08-04 18:44:59 +000039 llvm::Constant *BlockVarLayout,
Mike Stump08920992009-03-07 02:35:30 +000040 std::vector<HelperInfo> *NoteForHelper) {
Fariborz Jahanian89ecd412010-08-04 16:57:49 +000041 bool BlockHasCopyDispose = Info.BlockHasCopyDispose;
42 CharUnits Size = Info.BlockSize;
Mike Stump56129b12009-02-13 16:55:51 +000043 const llvm::Type *UnsignedLongTy
44 = CGM.getTypes().ConvertType(getContext().UnsignedLongTy);
Mike Stumpe5fee252009-02-13 16:19:19 +000045 llvm::Constant *C;
46 std::vector<llvm::Constant*> Elts;
47
48 // reserved
Owen Anderson4a28d5d2009-07-24 23:12:58 +000049 C = llvm::ConstantInt::get(UnsignedLongTy, 0);
Mike Stumpe5fee252009-02-13 16:19:19 +000050 Elts.push_back(C);
51
52 // Size
Mike Stumpd6840002009-02-21 20:07:44 +000053 // FIXME: What is the right way to say this doesn't fit? We should give
54 // a user diagnostic in that case. Better fix would be to change the
55 // API to size_t.
Ken Dyck199c3d62010-01-11 17:06:35 +000056 C = llvm::ConstantInt::get(UnsignedLongTy, Size.getQuantity());
Mike Stumpe5fee252009-02-13 16:19:19 +000057 Elts.push_back(C);
58
Blaine Garst2a7eb282010-02-23 21:51:17 +000059 // optional copy/dispose helpers
Mike Stumpe5fee252009-02-13 16:19:19 +000060 if (BlockHasCopyDispose) {
61 // copy_func_helper_decl
Mike Stumpb7477cf2009-04-10 18:52:28 +000062 Elts.push_back(BuildCopyHelper(Ty, NoteForHelper));
Mike Stumpe5fee252009-02-13 16:19:19 +000063
64 // destroy_func_decl
Mike Stumpb7477cf2009-04-10 18:52:28 +000065 Elts.push_back(BuildDestroyHelper(Ty, NoteForHelper));
Mike Stumpe5fee252009-02-13 16:19:19 +000066 }
67
Blaine Garst2a7eb282010-02-23 21:51:17 +000068 // Signature. non-optional ObjC-style method descriptor @encode sequence
69 std::string BlockTypeEncoding;
70 CGM.getContext().getObjCEncodingForBlock(BE, BlockTypeEncoding);
71
72 Elts.push_back(llvm::ConstantExpr::getBitCast(
73 CGM.GetAddrOfConstantCString(BlockTypeEncoding), PtrToInt8Ty));
74
75 // Layout.
Fariborz Jahanian44034db2010-08-04 18:44:59 +000076 C = BlockVarLayout;
77
Blaine Garst2a7eb282010-02-23 21:51:17 +000078 Elts.push_back(C);
79
Nick Lewycky0d36dd22009-09-19 20:00:52 +000080 C = llvm::ConstantStruct::get(VMContext, Elts, false);
Mike Stumpe5fee252009-02-13 16:19:19 +000081
Owen Anderson1c431b32009-07-08 19:05:04 +000082 C = new llvm::GlobalVariable(CGM.getModule(), C->getType(), true,
Mike Stumpe5fee252009-02-13 16:19:19 +000083 llvm::GlobalValue::InternalLinkage,
Owen Anderson1c431b32009-07-08 19:05:04 +000084 C, "__block_descriptor_tmp");
Mike Stumpe5fee252009-02-13 16:19:19 +000085 return C;
86}
87
John McCallee504292010-05-21 04:11:14 +000088static void CollectBlockDeclRefInfo(const Stmt *S, CGBlockInfo &Info) {
Anders Carlsson4de9fce2009-03-01 01:09:12 +000089 for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end();
90 I != E; ++I)
Daniel Dunbar82573ee2009-03-02 07:00:57 +000091 if (*I)
John McCallee504292010-05-21 04:11:14 +000092 CollectBlockDeclRefInfo(*I, Info);
Mike Stump00470a12009-03-05 08:32:30 +000093
Mike Stumpea26cb52009-10-21 03:49:08 +000094 // We want to ensure we walk down into block literals so we can find
95 // all nested BlockDeclRefExprs.
Mike Stump38e16272009-10-21 22:01:24 +000096 if (const BlockExpr *BE = dyn_cast<BlockExpr>(S)) {
John McCallee504292010-05-21 04:11:14 +000097 Info.InnerBlocks.insert(BE->getBlockDecl());
98 CollectBlockDeclRefInfo(BE->getBody(), Info);
Mike Stump38e16272009-10-21 22:01:24 +000099 }
Mike Stumpea26cb52009-10-21 03:49:08 +0000100
John McCallee504292010-05-21 04:11:14 +0000101 else if (const BlockDeclRefExpr *BDRE = dyn_cast<BlockDeclRefExpr>(S)) {
102 const ValueDecl *D = BDRE->getDecl();
Anders Carlsson4de9fce2009-03-01 01:09:12 +0000103 // FIXME: Handle enums.
John McCallee504292010-05-21 04:11:14 +0000104 if (isa<FunctionDecl>(D))
Anders Carlsson4de9fce2009-03-01 01:09:12 +0000105 return;
Mike Stump00470a12009-03-05 08:32:30 +0000106
John McCallee504292010-05-21 04:11:14 +0000107 if (isa<ImplicitParamDecl>(D) &&
108 isa<ObjCMethodDecl>(D->getDeclContext()) &&
109 cast<ObjCMethodDecl>(D->getDeclContext())->getSelfDecl() == D) {
110 Info.NeedsObjCSelf = true;
111 return;
112 }
113
Mike Stump38e16272009-10-21 22:01:24 +0000114 // Only Decls that escape are added.
John McCallee504292010-05-21 04:11:14 +0000115 if (!Info.InnerBlocks.count(D->getDeclContext()))
Mike Stump38e16272009-10-21 22:01:24 +0000116 Info.DeclRefs.push_back(BDRE);
Anders Carlsson4de9fce2009-03-01 01:09:12 +0000117 }
John McCallea1471e2010-05-20 01:18:31 +0000118
John McCallee504292010-05-21 04:11:14 +0000119 // Make sure to capture implicit 'self' references due to super calls.
Chandler Carruthf54b80f2010-05-21 10:29:28 +0000120 else if (const ObjCMessageExpr *E = dyn_cast<ObjCMessageExpr>(S)) {
John McCallee504292010-05-21 04:11:14 +0000121 if (E->getReceiverKind() == ObjCMessageExpr::SuperClass ||
122 E->getReceiverKind() == ObjCMessageExpr::SuperInstance)
123 Info.NeedsObjCSelf = true;
Chandler Carruthf54b80f2010-05-21 10:29:28 +0000124 }
Fariborz Jahanian8ac2d442010-10-14 16:04:05 +0000125 else if (const ObjCPropertyRefExpr *PE = dyn_cast<ObjCPropertyRefExpr>(S)) {
126 // Getter/setter uses may also cause implicit super references,
127 // which we can check for with:
128 if (PE->isSuperReceiver())
129 Info.NeedsObjCSelf = true;
130 }
131 else if (const ObjCImplicitSetterGetterRefExpr *IE =
132 dyn_cast<ObjCImplicitSetterGetterRefExpr>(S)) {
133 // Getter/setter uses may also cause implicit super references,
134 // which we can check for with:
135 if (IE->isSuperReceiver())
136 Info.NeedsObjCSelf = true;
137 }
John McCallee504292010-05-21 04:11:14 +0000138 else if (isa<CXXThisExpr>(S))
John McCallea1471e2010-05-20 01:18:31 +0000139 Info.CXXThisRef = cast<CXXThisExpr>(S);
Anders Carlsson4de9fce2009-03-01 01:09:12 +0000140}
141
John McCallee504292010-05-21 04:11:14 +0000142/// CanBlockBeGlobal - Given a CGBlockInfo struct, determines if a block can be
Mike Stump58a85142009-03-04 22:48:06 +0000143/// declared as a global variable instead of on the stack.
John McCallee504292010-05-21 04:11:14 +0000144static bool CanBlockBeGlobal(const CGBlockInfo &Info) {
Mike Stumpea26cb52009-10-21 03:49:08 +0000145 return Info.DeclRefs.empty();
146}
147
148/// AllocateAllBlockDeclRefs - Preallocate all nested BlockDeclRefExprs to
149/// ensure we can generate the debug information for the parameter for the block
150/// invoke function.
John McCallee504292010-05-21 04:11:14 +0000151static void AllocateAllBlockDeclRefs(CodeGenFunction &CGF, CGBlockInfo &Info) {
John McCallea1471e2010-05-20 01:18:31 +0000152 if (Info.CXXThisRef)
John McCallee504292010-05-21 04:11:14 +0000153 CGF.AllocateBlockCXXThisPointer(Info.CXXThisRef);
Mike Stumpea26cb52009-10-21 03:49:08 +0000154
155 for (size_t i = 0; i < Info.DeclRefs.size(); ++i)
John McCallee504292010-05-21 04:11:14 +0000156 CGF.AllocateBlockDecl(Info.DeclRefs[i]);
157
158 if (Info.NeedsObjCSelf) {
159 ValueDecl *Self = cast<ObjCMethodDecl>(CGF.CurFuncDecl)->getSelfDecl();
160 BlockDeclRefExpr *BDRE =
161 new (CGF.getContext()) BlockDeclRefExpr(Self, Self->getType(),
162 SourceLocation(), false);
163 Info.DeclRefs.push_back(BDRE);
164 CGF.AllocateBlockDecl(BDRE);
165 }
Anders Carlsson4de9fce2009-03-01 01:09:12 +0000166}
167
Fariborz Jahanian7edddb82010-07-28 19:07:18 +0000168static unsigned computeBlockFlag(CodeGenModule &CGM,
169 const BlockExpr *BE, unsigned flags) {
170 QualType BPT = BE->getType();
171 const FunctionType *ftype = BPT->getPointeeType()->getAs<FunctionType>();
172 QualType ResultType = ftype->getResultType();
173
174 CallArgList Args;
175 CodeGenTypes &Types = CGM.getTypes();
176 const CGFunctionInfo &FnInfo = Types.getFunctionInfo(ResultType, Args,
177 FunctionType::ExtInfo());
178 if (CGM.ReturnTypeUsesSRet(FnInfo))
179 flags |= CodeGenFunction::BLOCK_USE_STRET;
180 return flags;
181}
182
Mike Stump58a85142009-03-04 22:48:06 +0000183// FIXME: Push most into CGM, passing down a few bits, like current function
184// name.
Mike Stump8a2b4b12009-02-25 23:33:13 +0000185llvm::Value *CodeGenFunction::BuildBlockLiteralTmp(const BlockExpr *BE) {
Anders Carlsson4de9fce2009-03-01 01:09:12 +0000186 std::string Name = CurFn->getName();
John McCallee504292010-05-21 04:11:14 +0000187 CGBlockInfo Info(Name.c_str());
188 Info.InnerBlocks.insert(BE->getBlockDecl());
189 CollectBlockDeclRefInfo(BE->getBody(), Info);
Anders Carlsson4de9fce2009-03-01 01:09:12 +0000190
191 // Check if the block can be global.
Mike Stump58a85142009-03-04 22:48:06 +0000192 // FIXME: This test doesn't work for nested blocks yet. Longer term, I'd like
193 // to just have one code path. We should move this function into CGM and pass
194 // CGF, then we can just check to see if CGF is 0.
Mike Stumpdab514f2009-03-04 03:23:46 +0000195 if (0 && CanBlockBeGlobal(Info))
Anders Carlsson4de9fce2009-03-01 01:09:12 +0000196 return CGM.GetAddrOfGlobalBlock(BE, Name.c_str());
Mike Stump00470a12009-03-05 08:32:30 +0000197
David Chisnall5e530af2009-11-17 19:33:30 +0000198 size_t BlockFields = 5;
199
David Chisnall5e530af2009-11-17 19:33:30 +0000200 std::vector<llvm::Constant*> Elts(BlockFields);
201
Mike Stumpe5fee252009-02-13 16:19:19 +0000202 llvm::Constant *C;
Mike Stump8a2b4b12009-02-25 23:33:13 +0000203 llvm::Value *V;
Mike Stumpe5fee252009-02-13 16:19:19 +0000204
Mike Stumpe5fee252009-02-13 16:19:19 +0000205 {
Fariborz Jahanian44034db2010-08-04 18:44:59 +0000206 llvm::Constant *BlockVarLayout;
Mike Stumpe5fee252009-02-13 16:19:19 +0000207 // C = BuildBlockStructInitlist();
Blaine Garsta36e2232010-03-05 01:29:59 +0000208 unsigned int flags = BLOCK_HAS_SIGNATURE;
David Chisnall5e530af2009-11-17 19:33:30 +0000209
Mike Stump00470a12009-03-05 08:32:30 +0000210 // We run this first so that we set BlockHasCopyDispose from the entire
211 // block literal.
212 // __invoke
Mike Stump00470a12009-03-05 08:32:30 +0000213 llvm::Function *Fn
Fariborz Jahanian564360b2010-06-24 00:08:06 +0000214 = CodeGenFunction(CGM).GenerateBlockFunction(CurGD, BE, Info, CurFuncDecl,
Fariborz Jahanian44034db2010-08-04 18:44:59 +0000215 BlockVarLayout,
John McCallee504292010-05-21 04:11:14 +0000216 LocalDeclMap);
217 BlockHasCopyDispose |= Info.BlockHasCopyDispose;
Mike Stump00470a12009-03-05 08:32:30 +0000218 Elts[3] = Fn;
219
Mike Stumpf5408fe2009-05-16 07:57:57 +0000220 // FIXME: Don't use BlockHasCopyDispose, it is set more often then
221 // necessary, for example: { ^{ __block int i; ^{ i = 1; }(); }(); }
John McCallee504292010-05-21 04:11:14 +0000222 if (Info.BlockHasCopyDispose)
Mike Stumpe5fee252009-02-13 16:19:19 +0000223 flags |= BLOCK_HAS_COPY_DISPOSE;
224
Mike Stump7d6dc4f2009-02-13 20:17:16 +0000225 // __isa
Mike Stump59c5b112009-02-13 19:29:27 +0000226 C = CGM.getNSConcreteStackBlock();
Owen Anderson3c4972d2009-07-29 18:54:39 +0000227 C = llvm::ConstantExpr::getBitCast(C, PtrToInt8Ty);
Mike Stump00470a12009-03-05 08:32:30 +0000228 Elts[0] = C;
Mike Stumpe5fee252009-02-13 16:19:19 +0000229
230 // __flags
Fariborz Jahanian7edddb82010-07-28 19:07:18 +0000231 flags = computeBlockFlag(CGM, BE, flags);
Mike Stumpe5fee252009-02-13 16:19:19 +0000232 const llvm::IntegerType *IntTy = cast<llvm::IntegerType>(
233 CGM.getTypes().ConvertType(CGM.getContext().IntTy));
Owen Anderson4a28d5d2009-07-24 23:12:58 +0000234 C = llvm::ConstantInt::get(IntTy, flags);
Mike Stump00470a12009-03-05 08:32:30 +0000235 Elts[1] = C;
Mike Stumpe5fee252009-02-13 16:19:19 +0000236
237 // __reserved
Owen Anderson4a28d5d2009-07-24 23:12:58 +0000238 C = llvm::ConstantInt::get(IntTy, 0);
Mike Stump00470a12009-03-05 08:32:30 +0000239 Elts[2] = C;
Mike Stumpe5fee252009-02-13 16:19:19 +0000240
John McCallee504292010-05-21 04:11:14 +0000241 if (Info.BlockLayout.empty()) {
Mike Stumpcf62d392009-03-06 18:42:23 +0000242 // __descriptor
Fariborz Jahanian44034db2010-08-04 18:44:59 +0000243 C = llvm::Constant::getNullValue(PtrToInt8Ty);
244 Elts[4] = BuildDescriptorBlockDecl(BE, Info, 0, C, 0);
Mike Stumpcf62d392009-03-06 18:42:23 +0000245
Mike Stump5570cfe2009-03-01 20:07:53 +0000246 // Optimize to being a global block.
247 Elts[0] = CGM.getNSConcreteGlobalBlock();
Blaine Garsta36e2232010-03-05 01:29:59 +0000248
Owen Anderson4a28d5d2009-07-24 23:12:58 +0000249 Elts[1] = llvm::ConstantInt::get(IntTy, flags|BLOCK_IS_GLOBAL);
Mike Stump5570cfe2009-03-01 20:07:53 +0000250
Nick Lewycky0d36dd22009-09-19 20:00:52 +0000251 C = llvm::ConstantStruct::get(VMContext, Elts, false);
Mike Stump8a2b4b12009-02-25 23:33:13 +0000252
Owen Anderson1c431b32009-07-08 19:05:04 +0000253 C = new llvm::GlobalVariable(CGM.getModule(), C->getType(), true,
Benjamin Kramer3cf7c5d2010-01-22 13:59:13 +0000254 llvm::GlobalValue::InternalLinkage, C,
255 "__block_holder_tmp_" +
256 llvm::Twine(CGM.getGlobalUniqueCount()));
Mike Stump8a2b4b12009-02-25 23:33:13 +0000257 QualType BPT = BE->getType();
Owen Anderson3c4972d2009-07-29 18:54:39 +0000258 C = llvm::ConstantExpr::getBitCast(C, ConvertType(BPT));
Mike Stump8a2b4b12009-02-25 23:33:13 +0000259 return C;
260 }
Mike Stump00470a12009-03-05 08:32:30 +0000261
John McCallee504292010-05-21 04:11:14 +0000262 std::vector<const llvm::Type *> Types(BlockFields+Info.BlockLayout.size());
Mike Stump08920992009-03-07 02:35:30 +0000263 for (int i=0; i<4; ++i)
Mike Stump8a2b4b12009-02-25 23:33:13 +0000264 Types[i] = Elts[i]->getType();
Mike Stump08920992009-03-07 02:35:30 +0000265 Types[4] = PtrToInt8Ty;
Mike Stump8a2b4b12009-02-25 23:33:13 +0000266
John McCallee504292010-05-21 04:11:14 +0000267 for (unsigned i = 0, n = Info.BlockLayout.size(); i != n; ++i) {
268 const Expr *E = Info.BlockLayout[i];
Mike Stumpa99038c2009-02-28 09:07:16 +0000269 const BlockDeclRefExpr *BDRE = dyn_cast<BlockDeclRefExpr>(E);
270 QualType Ty = E->getType();
Mike Stumpdab514f2009-03-04 03:23:46 +0000271 if (BDRE && BDRE->isByRef()) {
Fariborz Jahanian79651722010-06-02 21:35:17 +0000272 Types[i+BlockFields] =
273 llvm::PointerType::get(BuildByRefType(BDRE->getDecl()), 0);
274 } else if (BDRE && BDRE->getDecl()->getType()->isReferenceType()) {
275 Types[i+BlockFields] = llvm::PointerType::get(ConvertType(Ty), 0);
276 } else
David Chisnall5e530af2009-11-17 19:33:30 +0000277 Types[i+BlockFields] = ConvertType(Ty);
Mike Stumpa99038c2009-02-28 09:07:16 +0000278 }
Mike Stump8a2b4b12009-02-25 23:33:13 +0000279
Owen Anderson47a434f2009-08-05 23:18:46 +0000280 llvm::StructType *Ty = llvm::StructType::get(VMContext, Types, true);
Mike Stump8a2b4b12009-02-25 23:33:13 +0000281
282 llvm::AllocaInst *A = CreateTempAlloca(Ty);
John McCallee504292010-05-21 04:11:14 +0000283 A->setAlignment(Info.BlockAlign.getQuantity());
Mike Stump8a2b4b12009-02-25 23:33:13 +0000284 V = A;
285
John McCallea1471e2010-05-20 01:18:31 +0000286 // Build layout / cleanup information for all the data entries in the
287 // layout, and write the enclosing fields into the type.
John McCallee504292010-05-21 04:11:14 +0000288 std::vector<HelperInfo> NoteForHelper(Info.BlockLayout.size());
John McCallea1471e2010-05-20 01:18:31 +0000289 unsigned NumHelpers = 0;
Mike Stump08920992009-03-07 02:35:30 +0000290
291 for (unsigned i=0; i<4; ++i)
Mike Stump8a2b4b12009-02-25 23:33:13 +0000292 Builder.CreateStore(Elts[i], Builder.CreateStructGEP(V, i, "block.tmp"));
Mike Stump00470a12009-03-05 08:32:30 +0000293
John McCallee504292010-05-21 04:11:14 +0000294 for (unsigned i=0; i < Info.BlockLayout.size(); ++i) {
295 const Expr *E = Info.BlockLayout[i];
Mike Stump8a2b4b12009-02-25 23:33:13 +0000296
John McCallea1471e2010-05-20 01:18:31 +0000297 // Skip padding.
298 if (isa<DeclRefExpr>(E)) continue;
Mike Stumpa99038c2009-02-28 09:07:16 +0000299
John McCallea1471e2010-05-20 01:18:31 +0000300 llvm::Value* Addr = Builder.CreateStructGEP(V, i+BlockFields, "tmp");
301 HelperInfo &Note = NoteForHelper[NumHelpers++];
Mike Stumpa99038c2009-02-28 09:07:16 +0000302
John McCallea1471e2010-05-20 01:18:31 +0000303 Note.index = i+5;
Mike Stump08920992009-03-07 02:35:30 +0000304
John McCallea1471e2010-05-20 01:18:31 +0000305 if (isa<CXXThisExpr>(E)) {
306 Note.RequiresCopying = false;
307 Note.flag = BLOCK_FIELD_IS_OBJECT;
Mike Stumpa99038c2009-02-28 09:07:16 +0000308
John McCallea1471e2010-05-20 01:18:31 +0000309 Builder.CreateStore(LoadCXXThis(), Addr);
310 continue;
Mike Stump8a2b4b12009-02-25 23:33:13 +0000311 }
John McCallea1471e2010-05-20 01:18:31 +0000312
313 const BlockDeclRefExpr *BDRE = cast<BlockDeclRefExpr>(E);
314 const ValueDecl *VD = BDRE->getDecl();
315 QualType T = VD->getType();
316
317 Note.RequiresCopying = BlockRequiresCopying(T);
318
319 if (BDRE->isByRef()) {
320 Note.flag = BLOCK_FIELD_IS_BYREF;
321 if (T.isObjCGCWeak())
322 Note.flag |= BLOCK_FIELD_IS_WEAK;
323 } else if (T->isBlockPointerType()) {
324 Note.flag = BLOCK_FIELD_IS_BLOCK;
325 } else {
326 Note.flag = BLOCK_FIELD_IS_OBJECT;
327 }
328
329 if (LocalDeclMap[VD]) {
330 if (BDRE->isByRef()) {
331 llvm::Value *Loc = LocalDeclMap[VD];
332 Loc = Builder.CreateStructGEP(Loc, 1, "forwarding");
333 Loc = Builder.CreateLoad(Loc);
334 Builder.CreateStore(Loc, Addr);
335 continue;
336 } else {
Fariborz Jahanianac7362d2010-06-08 20:57:22 +0000337 if (BDRE->getCopyConstructorExpr()) {
338 E = BDRE->getCopyConstructorExpr();
John McCallf1549f62010-07-06 01:34:17 +0000339 PushDestructorCleanup(E->getType(), Addr);
Fariborz Jahanianac7362d2010-06-08 20:57:22 +0000340 }
Fariborz Jahanian59da45a2010-06-04 21:35:44 +0000341 else {
342 E = new (getContext()) DeclRefExpr(const_cast<ValueDecl*>(VD),
Fariborz Jahanian79651722010-06-02 21:35:17 +0000343 VD->getType().getNonReferenceType(),
344 SourceLocation());
Fariborz Jahanian59da45a2010-06-04 21:35:44 +0000345 if (VD->getType()->isReferenceType()) {
346 E = new (getContext())
John McCall2de56d12010-08-25 11:45:40 +0000347 UnaryOperator(const_cast<Expr*>(E), UO_AddrOf,
Fariborz Jahanian59da45a2010-06-04 21:35:44 +0000348 getContext().getPointerType(E->getType()),
349 SourceLocation());
350 }
Fariborz Jahaniandf8b8ea2010-06-04 16:10:00 +0000351 }
352 }
John McCallea1471e2010-05-20 01:18:31 +0000353 }
John McCallea1471e2010-05-20 01:18:31 +0000354
355 if (BDRE->isByRef()) {
356 E = new (getContext())
John McCall2de56d12010-08-25 11:45:40 +0000357 UnaryOperator(const_cast<Expr*>(E), UO_AddrOf,
John McCallea1471e2010-05-20 01:18:31 +0000358 getContext().getPointerType(E->getType()),
359 SourceLocation());
360 }
361
John McCall558d2ab2010-09-15 10:14:12 +0000362 RValue r = EmitAnyExpr(E, AggValueSlot::forAddr(Addr, false, true));
John McCallea1471e2010-05-20 01:18:31 +0000363 if (r.isScalar()) {
364 llvm::Value *Loc = r.getScalarVal();
365 const llvm::Type *Ty = Types[i+BlockFields];
366 if (BDRE->isByRef()) {
367 // E is now the address of the value field, instead, we want the
368 // address of the actual ByRef struct. We optimize this slightly
369 // compared to gcc by not grabbing the forwarding slot as this must
370 // be done during Block_copy for us, and we can postpone the work
371 // until then.
372 CharUnits offset = BlockDecls[BDRE->getDecl()];
373
374 llvm::Value *BlockLiteral = LoadBlockStruct();
375
376 Loc = Builder.CreateGEP(BlockLiteral,
Chris Lattner77b89b82010-06-27 07:15:29 +0000377 llvm::ConstantInt::get(Int64Ty, offset.getQuantity()),
John McCallea1471e2010-05-20 01:18:31 +0000378 "block.literal");
379 Ty = llvm::PointerType::get(Ty, 0);
380 Loc = Builder.CreateBitCast(Loc, Ty);
381 Loc = Builder.CreateLoad(Loc);
382 // Loc = Builder.CreateBitCast(Loc, Ty);
383 }
384 Builder.CreateStore(Loc, Addr);
385 } else if (r.isComplex())
386 // FIXME: implement
387 ErrorUnsupported(BE, "complex in block literal");
388 else if (r.isAggregate())
389 ; // Already created into the destination
390 else
391 assert (0 && "bad block variable");
392 // FIXME: Ensure that the offset created by the backend for
393 // the struct matches the previously computed offset in BlockDecls.
394 }
395 NoteForHelper.resize(NumHelpers);
Mike Stumpcf62d392009-03-06 18:42:23 +0000396
397 // __descriptor
Fariborz Jahanian89ecd412010-08-04 16:57:49 +0000398 llvm::Value *Descriptor = BuildDescriptorBlockDecl(BE, Info, Ty,
Fariborz Jahanian44034db2010-08-04 18:44:59 +0000399 BlockVarLayout,
Mike Stump08920992009-03-07 02:35:30 +0000400 &NoteForHelper);
401 Descriptor = Builder.CreateBitCast(Descriptor, PtrToInt8Ty);
402 Builder.CreateStore(Descriptor, Builder.CreateStructGEP(V, 4, "block.tmp"));
Mike Stumpe5fee252009-02-13 16:19:19 +0000403 }
Mike Stump00470a12009-03-05 08:32:30 +0000404
Mike Stumpbd65cac2009-02-19 01:01:04 +0000405 QualType BPT = BE->getType();
Fariborz Jahanian263c4de2010-02-10 23:34:57 +0000406 V = Builder.CreateBitCast(V, ConvertType(BPT));
407 // See if this is a __weak block variable and the must call objc_read_weak
408 // on it.
409 const FunctionType *ftype = BPT->getPointeeType()->getAs<FunctionType>();
410 QualType RES = ftype->getResultType();
411 if (RES.isObjCGCWeak()) {
412 // Must cast argument to id*
413 const llvm::Type *ObjectPtrTy =
414 ConvertType(CGM.getContext().getObjCIdType());
415 const llvm::Type *PtrObjectPtrTy =
416 llvm::PointerType::getUnqual(ObjectPtrTy);
417 V = Builder.CreateBitCast(V, PtrObjectPtrTy);
418 V = CGM.getObjCRuntime().EmitObjCWeakRead(*this, V);
419 }
420 return V;
Mike Stumpe5fee252009-02-13 16:19:19 +0000421}
422
423
Mike Stump2a998142009-03-04 18:17:45 +0000424const llvm::Type *BlockModule::getBlockDescriptorType() {
Mike Stumpab695142009-02-13 15:16:56 +0000425 if (BlockDescriptorType)
426 return BlockDescriptorType;
427
Mike Stumpa5448542009-02-13 15:32:32 +0000428 const llvm::Type *UnsignedLongTy =
Mike Stumpab695142009-02-13 15:16:56 +0000429 getTypes().ConvertType(getContext().UnsignedLongTy);
Mike Stumpa5448542009-02-13 15:32:32 +0000430
Mike Stumpab695142009-02-13 15:16:56 +0000431 // struct __block_descriptor {
432 // unsigned long reserved;
433 // unsigned long block_size;
Blaine Garst2a7eb282010-02-23 21:51:17 +0000434 //
435 // // later, the following will be added
436 //
437 // struct {
438 // void (*copyHelper)();
439 // void (*copyHelper)();
440 // } helpers; // !!! optional
441 //
442 // const char *signature; // the block signature
443 // const char *layout; // reserved
Mike Stumpab695142009-02-13 15:16:56 +0000444 // };
Owen Anderson47a434f2009-08-05 23:18:46 +0000445 BlockDescriptorType = llvm::StructType::get(UnsignedLongTy->getContext(),
446 UnsignedLongTy,
Mike Stumpa5448542009-02-13 15:32:32 +0000447 UnsignedLongTy,
Mike Stumpab695142009-02-13 15:16:56 +0000448 NULL);
449
450 getModule().addTypeName("struct.__block_descriptor",
451 BlockDescriptorType);
452
453 return BlockDescriptorType;
Anders Carlssonacfde802009-02-12 00:39:25 +0000454}
455
Mike Stump2a998142009-03-04 18:17:45 +0000456const llvm::Type *BlockModule::getGenericBlockLiteralType() {
Mike Stump9b8a7972009-02-13 15:25:34 +0000457 if (GenericBlockLiteralType)
458 return GenericBlockLiteralType;
459
Mike Stumpa5448542009-02-13 15:32:32 +0000460 const llvm::Type *BlockDescPtrTy =
Owen Anderson96e0fc72009-07-29 22:16:19 +0000461 llvm::PointerType::getUnqual(getBlockDescriptorType());
Mike Stumpa5448542009-02-13 15:32:32 +0000462
Mike Stump7cbb3602009-02-13 16:01:35 +0000463 const llvm::IntegerType *IntTy = cast<llvm::IntegerType>(
464 getTypes().ConvertType(getContext().IntTy));
465
Mike Stump9b8a7972009-02-13 15:25:34 +0000466 // struct __block_literal_generic {
Mike Stumpbd65cac2009-02-19 01:01:04 +0000467 // void *__isa;
468 // int __flags;
469 // int __reserved;
470 // void (*__invoke)(void *);
471 // struct __block_descriptor *__descriptor;
Mike Stump9b8a7972009-02-13 15:25:34 +0000472 // };
Blaine Garst2a7eb282010-02-23 21:51:17 +0000473 GenericBlockLiteralType = llvm::StructType::get(IntTy->getContext(),
Owen Anderson47a434f2009-08-05 23:18:46 +0000474 PtrToInt8Ty,
Mike Stump7cbb3602009-02-13 16:01:35 +0000475 IntTy,
476 IntTy,
Mike Stump797b6322009-03-05 01:23:13 +0000477 PtrToInt8Ty,
Mike Stump9b8a7972009-02-13 15:25:34 +0000478 BlockDescPtrTy,
479 NULL);
Mike Stumpa5448542009-02-13 15:32:32 +0000480
Mike Stump9b8a7972009-02-13 15:25:34 +0000481 getModule().addTypeName("struct.__block_literal_generic",
482 GenericBlockLiteralType);
Mike Stumpa5448542009-02-13 15:32:32 +0000483
Mike Stump9b8a7972009-02-13 15:25:34 +0000484 return GenericBlockLiteralType;
Anders Carlssonacfde802009-02-12 00:39:25 +0000485}
486
Mike Stumpbd65cac2009-02-19 01:01:04 +0000487
Anders Carlssona1736c02009-12-24 21:13:40 +0000488RValue CodeGenFunction::EmitBlockCallExpr(const CallExpr* E,
489 ReturnValueSlot ReturnValue) {
Mike Stumpa5448542009-02-13 15:32:32 +0000490 const BlockPointerType *BPT =
Ted Kremenek6217b802009-07-29 21:53:49 +0000491 E->getCallee()->getType()->getAs<BlockPointerType>();
Mike Stumpa5448542009-02-13 15:32:32 +0000492
Anders Carlssonacfde802009-02-12 00:39:25 +0000493 llvm::Value *Callee = EmitScalarExpr(E->getCallee());
494
495 // Get a pointer to the generic block literal.
496 const llvm::Type *BlockLiteralTy =
Owen Anderson96e0fc72009-07-29 22:16:19 +0000497 llvm::PointerType::getUnqual(CGM.getGenericBlockLiteralType());
Anders Carlssonacfde802009-02-12 00:39:25 +0000498
499 // Bitcast the callee to a block literal.
Mike Stumpa5448542009-02-13 15:32:32 +0000500 llvm::Value *BlockLiteral =
Anders Carlssonacfde802009-02-12 00:39:25 +0000501 Builder.CreateBitCast(Callee, BlockLiteralTy, "block.literal");
502
503 // Get the function pointer from the literal.
504 llvm::Value *FuncPtr = Builder.CreateStructGEP(BlockLiteral, 3, "tmp");
Anders Carlssonacfde802009-02-12 00:39:25 +0000505
Mike Stumpa5448542009-02-13 15:32:32 +0000506 BlockLiteral =
507 Builder.CreateBitCast(BlockLiteral,
Benjamin Kramer3c0ef8c2009-10-13 10:07:13 +0000508 llvm::Type::getInt8PtrTy(VMContext),
Anders Carlssonacfde802009-02-12 00:39:25 +0000509 "tmp");
Mike Stumpa5448542009-02-13 15:32:32 +0000510
Anders Carlssonacfde802009-02-12 00:39:25 +0000511 // Add the block literal.
512 QualType VoidPtrTy = getContext().getPointerType(getContext().VoidTy);
513 CallArgList Args;
514 Args.push_back(std::make_pair(RValue::get(BlockLiteral), VoidPtrTy));
Mike Stumpa5448542009-02-13 15:32:32 +0000515
Anders Carlsson782f3972009-04-08 23:13:16 +0000516 QualType FnType = BPT->getPointeeType();
517
Anders Carlssonacfde802009-02-12 00:39:25 +0000518 // And the rest of the arguments.
John McCall183700f2009-09-21 23:43:11 +0000519 EmitCallArgs(Args, FnType->getAs<FunctionProtoType>(),
Anders Carlsson782f3972009-04-08 23:13:16 +0000520 E->arg_begin(), E->arg_end());
Mike Stumpa5448542009-02-13 15:32:32 +0000521
Anders Carlsson6e460ff2009-04-07 22:10:22 +0000522 // Load the function.
Daniel Dunbar2da84ff2009-11-29 21:23:36 +0000523 llvm::Value *Func = Builder.CreateLoad(FuncPtr, "tmp");
Anders Carlsson6e460ff2009-04-07 22:10:22 +0000524
John McCall04a67a62010-02-05 21:31:56 +0000525 const FunctionType *FuncTy = FnType->getAs<FunctionType>();
526 QualType ResultType = FuncTy->getResultType();
Anders Carlssona17d7cc2009-04-08 02:55:55 +0000527
Mike Stump1eb44332009-09-09 15:08:12 +0000528 const CGFunctionInfo &FnInfo =
Rafael Espindola264ba482010-03-30 20:24:48 +0000529 CGM.getTypes().getFunctionInfo(ResultType, Args,
530 FuncTy->getExtInfo());
Mike Stump1eb44332009-09-09 15:08:12 +0000531
Anders Carlsson6e460ff2009-04-07 22:10:22 +0000532 // Cast the function pointer to the right type.
Mike Stump1eb44332009-09-09 15:08:12 +0000533 const llvm::Type *BlockFTy =
Anders Carlssona17d7cc2009-04-08 02:55:55 +0000534 CGM.getTypes().GetFunctionType(FnInfo, false);
Mike Stump1eb44332009-09-09 15:08:12 +0000535
Owen Anderson96e0fc72009-07-29 22:16:19 +0000536 const llvm::Type *BlockFTyPtr = llvm::PointerType::getUnqual(BlockFTy);
Anders Carlsson6e460ff2009-04-07 22:10:22 +0000537 Func = Builder.CreateBitCast(Func, BlockFTyPtr);
Mike Stump1eb44332009-09-09 15:08:12 +0000538
Anders Carlssonacfde802009-02-12 00:39:25 +0000539 // And call the block.
Anders Carlssona1736c02009-12-24 21:13:40 +0000540 return EmitCall(FnInfo, Func, ReturnValue, Args);
Anders Carlssonacfde802009-02-12 00:39:25 +0000541}
Anders Carlssond5cab542009-02-12 17:55:02 +0000542
John McCallea1471e2010-05-20 01:18:31 +0000543void CodeGenFunction::AllocateBlockCXXThisPointer(const CXXThisExpr *E) {
544 assert(BlockCXXThisOffset.isZero() && "already computed 'this' pointer");
545
546 // Figure out what the offset is.
547 QualType T = E->getType();
548 std::pair<CharUnits,CharUnits> TypeInfo = getContext().getTypeInfoInChars(T);
549 CharUnits Offset = getBlockOffset(TypeInfo.first, TypeInfo.second);
550
551 BlockCXXThisOffset = Offset;
552 BlockLayout.push_back(E);
553}
554
555void CodeGenFunction::AllocateBlockDecl(const BlockDeclRefExpr *E) {
Anders Carlsson7dfa4072009-09-12 02:14:24 +0000556 const ValueDecl *VD = E->getDecl();
John McCallea1471e2010-05-20 01:18:31 +0000557 CharUnits &Offset = BlockDecls[VD];
Mike Stumpdab514f2009-03-04 03:23:46 +0000558
Mike Stumpdab514f2009-03-04 03:23:46 +0000559 // See if we have already allocated an offset for this variable.
John McCallea1471e2010-05-20 01:18:31 +0000560 if (!Offset.isZero())
561 return;
Mike Stumpea26cb52009-10-21 03:49:08 +0000562
563 // Don't run the expensive check, unless we have to.
Mike Stump083c25e2009-10-22 00:49:09 +0000564 if (!BlockHasCopyDispose)
565 if (E->isByRef()
566 || BlockRequiresCopying(E->getType()))
567 BlockHasCopyDispose = true;
Mike Stumpea26cb52009-10-21 03:49:08 +0000568
John McCallea1471e2010-05-20 01:18:31 +0000569 const ValueDecl *D = cast<ValueDecl>(E->getDecl());
Mike Stumpea26cb52009-10-21 03:49:08 +0000570
John McCallea1471e2010-05-20 01:18:31 +0000571 CharUnits Size;
572 CharUnits Align;
573
574 if (E->isByRef()) {
575 llvm::tie(Size,Align) =
576 getContext().getTypeInfoInChars(getContext().VoidPtrTy);
577 } else {
578 Size = getContext().getTypeSizeInChars(D->getType());
579 Align = getContext().getDeclAlign(D);
580 }
581
582 Offset = getBlockOffset(Size, Align);
583 BlockLayout.push_back(E);
Mike Stumpea26cb52009-10-21 03:49:08 +0000584}
585
John McCallee504292010-05-21 04:11:14 +0000586llvm::Value *CodeGenFunction::GetAddrOfBlockDecl(const ValueDecl *VD,
587 bool IsByRef) {
Fariborz Jahaniandf8b8ea2010-06-04 16:10:00 +0000588
John McCallea1471e2010-05-20 01:18:31 +0000589 CharUnits offset = BlockDecls[VD];
590 assert(!offset.isZero() && "getting address of unallocated decl");
Mike Stumpdab514f2009-03-04 03:23:46 +0000591
592 llvm::Value *BlockLiteral = LoadBlockStruct();
593 llvm::Value *V = Builder.CreateGEP(BlockLiteral,
Chris Lattner77b89b82010-06-27 07:15:29 +0000594 llvm::ConstantInt::get(Int64Ty, offset.getQuantity()),
Mike Stump58a85142009-03-04 22:48:06 +0000595 "block.literal");
John McCallee504292010-05-21 04:11:14 +0000596 if (IsByRef) {
Mike Stumpdab514f2009-03-04 03:23:46 +0000597 const llvm::Type *PtrStructTy
Anders Carlsson7dfa4072009-09-12 02:14:24 +0000598 = llvm::PointerType::get(BuildByRefType(VD), 0);
Mike Stumpa8b60c92009-03-21 21:00:35 +0000599 // The block literal will need a copy/destroy helper.
600 BlockHasCopyDispose = true;
Anders Carlsson7dfa4072009-09-12 02:14:24 +0000601
602 const llvm::Type *Ty = PtrStructTy;
Owen Anderson96e0fc72009-07-29 22:16:19 +0000603 Ty = llvm::PointerType::get(Ty, 0);
Mike Stumpdab514f2009-03-04 03:23:46 +0000604 V = Builder.CreateBitCast(V, Ty);
Daniel Dunbar2da84ff2009-11-29 21:23:36 +0000605 V = Builder.CreateLoad(V);
Mike Stumpdab514f2009-03-04 03:23:46 +0000606 V = Builder.CreateStructGEP(V, 1, "forwarding");
Daniel Dunbar2da84ff2009-11-29 21:23:36 +0000607 V = Builder.CreateLoad(V);
Mike Stumpdab514f2009-03-04 03:23:46 +0000608 V = Builder.CreateBitCast(V, PtrStructTy);
Anders Carlsson7dfa4072009-09-12 02:14:24 +0000609 V = Builder.CreateStructGEP(V, getByRefValueLLVMField(VD),
610 VD->getNameAsString());
Fariborz Jahaniand33ded52010-05-04 17:59:32 +0000611 if (VD->getType()->isReferenceType())
612 V = Builder.CreateLoad(V);
Mike Stumpdab514f2009-03-04 03:23:46 +0000613 } else {
Anders Carlsson7dfa4072009-09-12 02:14:24 +0000614 const llvm::Type *Ty = CGM.getTypes().ConvertType(VD->getType());
Owen Anderson96e0fc72009-07-29 22:16:19 +0000615 Ty = llvm::PointerType::get(Ty, 0);
Mike Stumpdab514f2009-03-04 03:23:46 +0000616 V = Builder.CreateBitCast(V, Ty);
Fariborz Jahanian79651722010-06-02 21:35:17 +0000617 if (VD->getType()->isReferenceType())
Fariborz Jahaniandf8b8ea2010-06-04 16:10:00 +0000618 V = Builder.CreateLoad(V, "ref.tmp");
Mike Stumpdab514f2009-03-04 03:23:46 +0000619 }
620 return V;
621}
622
Mike Stump67a64482009-02-14 22:16:35 +0000623llvm::Constant *
Mike Stump90a90432009-03-04 18:47:42 +0000624BlockModule::GetAddrOfGlobalBlock(const BlockExpr *BE, const char * n) {
Anders Carlssond5cab542009-02-12 17:55:02 +0000625 // Generate the block descriptor.
626 const llvm::Type *UnsignedLongTy = Types.ConvertType(Context.UnsignedLongTy);
Mike Stump7cbb3602009-02-13 16:01:35 +0000627 const llvm::IntegerType *IntTy = cast<llvm::IntegerType>(
628 getTypes().ConvertType(getContext().IntTy));
Mike Stumpa5448542009-02-13 15:32:32 +0000629
Blaine Garst2a7eb282010-02-23 21:51:17 +0000630 llvm::Constant *DescriptorFields[4];
Mike Stumpa5448542009-02-13 15:32:32 +0000631
Anders Carlssond5cab542009-02-12 17:55:02 +0000632 // Reserved
Owen Andersonc9c88b42009-07-31 20:28:54 +0000633 DescriptorFields[0] = llvm::Constant::getNullValue(UnsignedLongTy);
Mike Stumpa5448542009-02-13 15:32:32 +0000634
Anders Carlssond5cab542009-02-12 17:55:02 +0000635 // Block literal size. For global blocks we just use the size of the generic
636 // block literal struct.
Ken Dyck687cc4a2010-01-26 13:48:07 +0000637 CharUnits BlockLiteralSize =
638 CGM.GetTargetTypeStoreSize(getGenericBlockLiteralType());
Owen Andersona1cf15f2009-07-14 23:10:40 +0000639 DescriptorFields[1] =
Ken Dyck199c3d62010-01-11 17:06:35 +0000640 llvm::ConstantInt::get(UnsignedLongTy,BlockLiteralSize.getQuantity());
Blaine Garst2a7eb282010-02-23 21:51:17 +0000641
642 // signature. non-optional ObjC-style method descriptor @encode sequence
643 std::string BlockTypeEncoding;
644 CGM.getContext().getObjCEncodingForBlock(BE, BlockTypeEncoding);
Mike Stumpa5448542009-02-13 15:32:32 +0000645
Blaine Garst2a7eb282010-02-23 21:51:17 +0000646 DescriptorFields[2] = llvm::ConstantExpr::getBitCast(
647 CGM.GetAddrOfConstantCString(BlockTypeEncoding), PtrToInt8Ty);
648
649 // layout
650 DescriptorFields[3] =
651 llvm::ConstantInt::get(UnsignedLongTy,0);
652
653 // build the structure from the 4 elements
Mike Stumpa5448542009-02-13 15:32:32 +0000654 llvm::Constant *DescriptorStruct =
Blaine Garst2a7eb282010-02-23 21:51:17 +0000655 llvm::ConstantStruct::get(VMContext, &DescriptorFields[0], 4, false);
Mike Stumpa5448542009-02-13 15:32:32 +0000656
Anders Carlssond5cab542009-02-12 17:55:02 +0000657 llvm::GlobalVariable *Descriptor =
Owen Anderson1c431b32009-07-08 19:05:04 +0000658 new llvm::GlobalVariable(getModule(), DescriptorStruct->getType(), true,
Mike Stumpa5448542009-02-13 15:32:32 +0000659 llvm::GlobalVariable::InternalLinkage,
Owen Anderson1c431b32009-07-08 19:05:04 +0000660 DescriptorStruct, "__block_descriptor_global");
Mike Stumpa5448542009-02-13 15:32:32 +0000661
David Chisnall5e530af2009-11-17 19:33:30 +0000662 int FieldCount = 5;
Anders Carlssond5cab542009-02-12 17:55:02 +0000663 // Generate the constants for the block literal.
David Chisnall5e530af2009-11-17 19:33:30 +0000664
665 std::vector<llvm::Constant*> LiteralFields(FieldCount);
Mike Stumpa5448542009-02-13 15:32:32 +0000666
John McCallee504292010-05-21 04:11:14 +0000667 CGBlockInfo Info(n);
Fariborz Jahanian44034db2010-08-04 18:44:59 +0000668 llvm::Constant *BlockVarLayout;
Mike Stump7f28a9c2009-03-13 23:34:28 +0000669 llvm::DenseMap<const Decl*, llvm::Value*> LocalDeclMap;
Mike Stump4e7a1f72009-02-21 20:00:35 +0000670 llvm::Function *Fn
Fariborz Jahanian7edddb82010-07-28 19:07:18 +0000671 = CodeGenFunction(CGM).GenerateBlockFunction(GlobalDecl(), BE,
Fariborz Jahanian44034db2010-08-04 18:44:59 +0000672 Info, 0, BlockVarLayout,
673 LocalDeclMap);
John McCallee504292010-05-21 04:11:14 +0000674 assert(Info.BlockSize == BlockLiteralSize
Mike Stump4e7a1f72009-02-21 20:00:35 +0000675 && "no imports allowed for global block");
Mike Stumpa5448542009-02-13 15:32:32 +0000676
Anders Carlssond5cab542009-02-12 17:55:02 +0000677 // isa
Daniel Dunbar673431a2010-07-16 00:00:15 +0000678 LiteralFields[0] = CGM.getNSConcreteGlobalBlock();
Mike Stumpa5448542009-02-13 15:32:32 +0000679
Fariborz Jahanian7edddb82010-07-28 19:07:18 +0000680 // __flags
681 unsigned flags = computeBlockFlag(CGM, BE,
682 (BLOCK_IS_GLOBAL | BLOCK_HAS_SIGNATURE));
Blaine Garst2a7eb282010-02-23 21:51:17 +0000683 LiteralFields[1] =
Fariborz Jahanian7edddb82010-07-28 19:07:18 +0000684 llvm::ConstantInt::get(IntTy, flags);
Mike Stumpa5448542009-02-13 15:32:32 +0000685
Anders Carlssond5cab542009-02-12 17:55:02 +0000686 // Reserved
Owen Andersonc9c88b42009-07-31 20:28:54 +0000687 LiteralFields[2] = llvm::Constant::getNullValue(IntTy);
Mike Stumpa5448542009-02-13 15:32:32 +0000688
Anders Carlssond5cab542009-02-12 17:55:02 +0000689 // Function
690 LiteralFields[3] = Fn;
Mike Stumpa5448542009-02-13 15:32:32 +0000691
Anders Carlssond5cab542009-02-12 17:55:02 +0000692 // Descriptor
693 LiteralFields[4] = Descriptor;
David Chisnall5e530af2009-11-17 19:33:30 +0000694
Mike Stumpa5448542009-02-13 15:32:32 +0000695 llvm::Constant *BlockLiteralStruct =
David Chisnall5e530af2009-11-17 19:33:30 +0000696 llvm::ConstantStruct::get(VMContext, LiteralFields, false);
Mike Stumpa5448542009-02-13 15:32:32 +0000697
698 llvm::GlobalVariable *BlockLiteral =
Owen Anderson1c431b32009-07-08 19:05:04 +0000699 new llvm::GlobalVariable(getModule(), BlockLiteralStruct->getType(), true,
Mike Stumpa5448542009-02-13 15:32:32 +0000700 llvm::GlobalVariable::InternalLinkage,
Owen Anderson1c431b32009-07-08 19:05:04 +0000701 BlockLiteralStruct, "__block_literal_global");
Mike Stumpa5448542009-02-13 15:32:32 +0000702
Anders Carlssond5cab542009-02-12 17:55:02 +0000703 return BlockLiteral;
704}
705
Mike Stump4e7a1f72009-02-21 20:00:35 +0000706llvm::Value *CodeGenFunction::LoadBlockStruct() {
Mike Stumpbf1914b2009-10-20 20:30:01 +0000707 llvm::Value *V = Builder.CreateLoad(LocalDeclMap[getBlockStructDecl()],
708 "self");
709 // For now, we codegen based upon byte offsets.
710 return Builder.CreateBitCast(V, PtrToInt8Ty);
Mike Stump4e7a1f72009-02-21 20:00:35 +0000711}
712
Mike Stump00470a12009-03-05 08:32:30 +0000713llvm::Function *
Fariborz Jahanian564360b2010-06-24 00:08:06 +0000714CodeGenFunction::GenerateBlockFunction(GlobalDecl GD, const BlockExpr *BExpr,
John McCallee504292010-05-21 04:11:14 +0000715 CGBlockInfo &Info,
Mike Stump6cc88f72009-03-20 21:53:12 +0000716 const Decl *OuterFuncDecl,
Fariborz Jahanian44034db2010-08-04 18:44:59 +0000717 llvm::Constant *& BlockVarLayout,
John McCallee504292010-05-21 04:11:14 +0000718 llvm::DenseMap<const Decl*, llvm::Value*> ldm) {
Devang Patel963dfbd2009-04-15 21:51:44 +0000719
720 // Check if we should generate debug info for this block.
721 if (CGM.getDebugInfo())
722 DebugInfo = CGM.getDebugInfo();
Mike Stump1eb44332009-09-09 15:08:12 +0000723
Mike Stump7f28a9c2009-03-13 23:34:28 +0000724 // Arrange for local static and local extern declarations to appear
725 // to be local to this function as well, as they are directly referenced
726 // in a block.
727 for (llvm::DenseMap<const Decl *, llvm::Value*>::iterator i = ldm.begin();
728 i != ldm.end();
729 ++i) {
730 const VarDecl *VD = dyn_cast<VarDecl>(i->first);
Mike Stump1eb44332009-09-09 15:08:12 +0000731
John McCalld931b082010-08-26 03:08:43 +0000732 if (VD->getStorageClass() == SC_Static || VD->hasExternalStorage())
Mike Stump7f28a9c2009-03-13 23:34:28 +0000733 LocalDeclMap[VD] = i->second;
734 }
735
Ken Dyck687cc4a2010-01-26 13:48:07 +0000736 BlockOffset =
737 CGM.GetTargetTypeStoreSize(CGM.getGenericBlockLiteralType());
Ken Dyck30a8a272010-01-26 19:13:33 +0000738 BlockAlign = getContext().getTypeAlignInChars(getContext().VoidPtrTy);
Eli Friedman48f91222009-03-28 03:24:54 +0000739
Fariborz Jahanian140fb262009-04-11 17:55:15 +0000740 const FunctionType *BlockFunctionType = BExpr->getFunctionType();
741 QualType ResultType;
Rafael Espindola264ba482010-03-30 20:24:48 +0000742 FunctionType::ExtInfo EInfo = getFunctionExtInfo(*BlockFunctionType);
Fariborz Jahanian140fb262009-04-11 17:55:15 +0000743 bool IsVariadic;
Mike Stump1eb44332009-09-09 15:08:12 +0000744 if (const FunctionProtoType *FTy =
Fariborz Jahanianda0895d2009-04-11 18:54:57 +0000745 dyn_cast<FunctionProtoType>(BlockFunctionType)) {
Fariborz Jahanian140fb262009-04-11 17:55:15 +0000746 ResultType = FTy->getResultType();
747 IsVariadic = FTy->isVariadic();
Mike Stumpb3589f42009-07-30 22:28:39 +0000748 } else {
Fariborz Jahanian140fb262009-04-11 17:55:15 +0000749 // K&R style block.
750 ResultType = BlockFunctionType->getResultType();
751 IsVariadic = false;
752 }
Mike Stumpa5448542009-02-13 15:32:32 +0000753
Anders Carlssond5cab542009-02-12 17:55:02 +0000754 FunctionArgList Args;
Mike Stumpa5448542009-02-13 15:32:32 +0000755
Mike Stumpea26cb52009-10-21 03:49:08 +0000756 CurFuncDecl = OuterFuncDecl;
757
Chris Lattner161d36d2009-02-28 19:01:03 +0000758 const BlockDecl *BD = BExpr->getBlockDecl();
Anders Carlssond5cab542009-02-12 17:55:02 +0000759
Mike Stumpea26cb52009-10-21 03:49:08 +0000760 IdentifierInfo *II = &CGM.getContext().Idents.get(".block_descriptor");
Mike Stumpadaaad32009-10-20 02:12:22 +0000761
John McCallea1471e2010-05-20 01:18:31 +0000762 // Build the block struct now.
John McCallee504292010-05-21 04:11:14 +0000763 AllocateAllBlockDeclRefs(*this, Info);
Mike Stumpea26cb52009-10-21 03:49:08 +0000764
Fariborz Jahanian44034db2010-08-04 18:44:59 +0000765 // Capture block layout info. here.
766 if (CGM.getContext().getLangOptions().ObjC1)
Fariborz Jahanianc5904b42010-09-11 01:27:29 +0000767 BlockVarLayout = CGM.getObjCRuntime().GCBlockLayout(*this, BlockLayout);
Fariborz Jahanian44034db2010-08-04 18:44:59 +0000768 else
769 BlockVarLayout = llvm::Constant::getNullValue(PtrToInt8Ty);
770
Mike Stump083c25e2009-10-22 00:49:09 +0000771 QualType ParmTy = getContext().getBlockParmType(BlockHasCopyDispose,
John McCallea1471e2010-05-20 01:18:31 +0000772 BlockLayout);
773
Anders Carlssond5cab542009-02-12 17:55:02 +0000774 // FIXME: This leaks
Mike Stumpa5448542009-02-13 15:32:32 +0000775 ImplicitParamDecl *SelfDecl =
John McCall2888b652010-04-30 21:35:41 +0000776 ImplicitParamDecl::Create(getContext(), const_cast<BlockDecl*>(BD),
Mike Stumpadaaad32009-10-20 02:12:22 +0000777 SourceLocation(), II,
778 ParmTy);
Mike Stumpa5448542009-02-13 15:32:32 +0000779
Anders Carlssond5cab542009-02-12 17:55:02 +0000780 Args.push_back(std::make_pair(SelfDecl, SelfDecl->getType()));
Mike Stump4e7a1f72009-02-21 20:00:35 +0000781 BlockStructDecl = SelfDecl;
Mike Stumpa5448542009-02-13 15:32:32 +0000782
Steve Naroffe78b8092009-03-13 16:56:44 +0000783 for (BlockDecl::param_const_iterator i = BD->param_begin(),
Anders Carlssond5cab542009-02-12 17:55:02 +0000784 e = BD->param_end(); i != e; ++i)
Mike Stump19050612009-02-17 23:25:52 +0000785 Args.push_back(std::make_pair(*i, (*i)->getType()));
Mike Stumpa5448542009-02-13 15:32:32 +0000786
787 const CGFunctionInfo &FI =
Rafael Espindola264ba482010-03-30 20:24:48 +0000788 CGM.getTypes().getFunctionInfo(ResultType, Args, EInfo);
Anders Carlssond5cab542009-02-12 17:55:02 +0000789
Anders Carlssond5cab542009-02-12 17:55:02 +0000790 CodeGenTypes &Types = CGM.getTypes();
Fariborz Jahanian140fb262009-04-11 17:55:15 +0000791 const llvm::FunctionType *LTy = Types.GetFunctionType(FI, IsVariadic);
Mike Stumpa5448542009-02-13 15:32:32 +0000792
Douglas Gregor35415f52010-05-25 17:04:15 +0000793 MangleBuffer Name;
Fariborz Jahanian564360b2010-06-24 00:08:06 +0000794 CGM.getMangledName(GD, Name, BD);
Mike Stumpa5448542009-02-13 15:32:32 +0000795 llvm::Function *Fn =
Douglas Gregor6e5d9b02010-05-25 17:12:30 +0000796 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
797 Name.getString(), &CGM.getModule());
Mike Stumpa5448542009-02-13 15:32:32 +0000798
Daniel Dunbar0e4f40e2009-04-17 00:48:04 +0000799 CGM.SetInternalFunctionAttributes(BD, Fn, FI);
Fariborz Jahanian8404f672010-08-13 00:19:55 +0000800 StartFunction(BD, ResultType, Fn, Args,
801 BExpr->getBody()->getLocEnd());
802
803 CurFuncDecl = OuterFuncDecl;
804
Fariborz Jahanian16ac5ce2010-06-28 18:58:34 +0000805 QualType FnType(BlockFunctionType, 0);
Fariborz Jahanianef160b42010-06-28 19:42:10 +0000806 bool HasPrototype = isa<FunctionProtoType>(BlockFunctionType);
Fariborz Jahanian16ac5ce2010-06-28 18:58:34 +0000807
808 IdentifierInfo *ID = &getContext().Idents.get(Name.getString());
809 CurCodeDecl = FunctionDecl::Create(getContext(),
810 getContext().getTranslationUnitDecl(),
811 SourceLocation(), ID, FnType,
812 0,
John McCalld931b082010-08-26 03:08:43 +0000813 SC_Static,
814 SC_None,
Fariborz Jahanian16ac5ce2010-06-28 18:58:34 +0000815 false, HasPrototype);
Fariborz Jahanian8404f672010-08-13 00:19:55 +0000816 if (FunctionProtoType *FT = dyn_cast<FunctionProtoType>(FnType)) {
817 const FunctionDecl *CFD = dyn_cast<FunctionDecl>(CurCodeDecl);
818 FunctionDecl *FD = const_cast<FunctionDecl *>(CFD);
819 llvm::SmallVector<ParmVarDecl*, 16> Params;
820 for (unsigned i = 0, e = FT->getNumArgs(); i != e; ++i)
821 Params.push_back(ParmVarDecl::Create(getContext(), FD,
822 SourceLocation(), 0,
823 FT->getArgType(i), /*TInfo=*/0,
John McCalld931b082010-08-26 03:08:43 +0000824 SC_None, SC_None, 0));
Fariborz Jahanian8404f672010-08-13 00:19:55 +0000825 FD->setParams(Params.data(), Params.size());
826 }
Fariborz Jahanian16ac5ce2010-06-28 18:58:34 +0000827
Fariborz Jahanian8404f672010-08-13 00:19:55 +0000828
John McCallea1471e2010-05-20 01:18:31 +0000829 // If we have a C++ 'this' reference, go ahead and force it into
830 // existence now.
831 if (Info.CXXThisRef) {
832 assert(!BlockCXXThisOffset.isZero() &&
833 "haven't yet allocated 'this' reference");
834
835 // TODO: I have a dream that one day this will be typed.
836 llvm::Value *BlockLiteral = LoadBlockStruct();
837 llvm::Value *ThisPtrRaw =
838 Builder.CreateConstInBoundsGEP1_64(BlockLiteral,
839 BlockCXXThisOffset.getQuantity(),
840 "this.ptr.raw");
841
842 const llvm::Type *Ty =
843 CGM.getTypes().ConvertType(Info.CXXThisRef->getType());
844 Ty = llvm::PointerType::get(Ty, 0);
845 llvm::Value *ThisPtr = Builder.CreateBitCast(ThisPtrRaw, Ty, "this.ptr");
846
847 CXXThisValue = Builder.CreateLoad(ThisPtr, "this");
848 }
849
John McCallee504292010-05-21 04:11:14 +0000850 // If we have an Objective C 'self' reference, go ahead and force it
851 // into existence now.
852 if (Info.NeedsObjCSelf) {
853 ValueDecl *Self = cast<ObjCMethodDecl>(CurFuncDecl)->getSelfDecl();
854 LocalDeclMap[Self] = GetAddrOfBlockDecl(Self, false);
855 }
856
Mike Stumpb289b3f2009-10-01 22:29:41 +0000857 // Save a spot to insert the debug information for all the BlockDeclRefDecls.
858 llvm::BasicBlock *entry = Builder.GetInsertBlock();
859 llvm::BasicBlock::iterator entry_ptr = Builder.GetInsertPoint();
860 --entry_ptr;
861
Chris Lattner161d36d2009-02-28 19:01:03 +0000862 EmitStmt(BExpr->getBody());
Mike Stumpb289b3f2009-10-01 22:29:41 +0000863
Mike Stumpde8c5c72009-10-01 00:27:30 +0000864 // Remember where we were...
865 llvm::BasicBlock *resume = Builder.GetInsertBlock();
Mike Stumpb289b3f2009-10-01 22:29:41 +0000866
Mike Stumpde8c5c72009-10-01 00:27:30 +0000867 // Go back to the entry.
Mike Stumpb289b3f2009-10-01 22:29:41 +0000868 ++entry_ptr;
869 Builder.SetInsertPoint(entry, entry_ptr);
870
Mike Stumpb1a6e682009-09-30 02:43:10 +0000871 if (CGDebugInfo *DI = getDebugInfo()) {
Mike Stumpb1a6e682009-09-30 02:43:10 +0000872 // Emit debug information for all the BlockDeclRefDecls.
John McCallea1471e2010-05-20 01:18:31 +0000873 // FIXME: also for 'this'
874 for (unsigned i = 0, e = BlockLayout.size(); i != e; ++i) {
875 if (const BlockDeclRefExpr *BDRE =
876 dyn_cast<BlockDeclRefExpr>(BlockLayout[i])) {
Mike Stumpb1a6e682009-09-30 02:43:10 +0000877 const ValueDecl *D = BDRE->getDecl();
878 DI->setLocation(D->getLocation());
879 DI->EmitDeclareOfBlockDeclRefVariable(BDRE,
880 LocalDeclMap[getBlockStructDecl()],
881 Builder, this);
882 }
883 }
Mike Stumpb1a6e682009-09-30 02:43:10 +0000884 }
Mike Stumpde8c5c72009-10-01 00:27:30 +0000885 // And resume where we left off.
886 if (resume == 0)
887 Builder.ClearInsertionPoint();
888 else
889 Builder.SetInsertPoint(resume);
Mike Stumpb1a6e682009-09-30 02:43:10 +0000890
Chris Lattner161d36d2009-02-28 19:01:03 +0000891 FinishFunction(cast<CompoundStmt>(BExpr->getBody())->getRBracLoc());
Anders Carlssond5cab542009-02-12 17:55:02 +0000892
Mike Stump8a2b4b12009-02-25 23:33:13 +0000893 // The runtime needs a minimum alignment of a void *.
Ken Dyck30a8a272010-01-26 19:13:33 +0000894 CharUnits MinAlign = getContext().getTypeAlignInChars(getContext().VoidPtrTy);
Ken Dyck199c3d62010-01-11 17:06:35 +0000895 BlockOffset = CharUnits::fromQuantity(
Ken Dyck30a8a272010-01-26 19:13:33 +0000896 llvm::RoundUpToAlignment(BlockOffset.getQuantity(),
897 MinAlign.getQuantity()));
Mike Stump8a2b4b12009-02-25 23:33:13 +0000898
John McCallee504292010-05-21 04:11:14 +0000899 Info.BlockSize = BlockOffset;
900 Info.BlockAlign = BlockAlign;
901 Info.BlockLayout = BlockLayout;
902 Info.BlockHasCopyDispose = BlockHasCopyDispose;
Anders Carlssond5cab542009-02-12 17:55:02 +0000903 return Fn;
904}
Mike Stumpa99038c2009-02-28 09:07:16 +0000905
John McCallea1471e2010-05-20 01:18:31 +0000906CharUnits BlockFunction::getBlockOffset(CharUnits Size, CharUnits Align) {
907 assert((Align.isPositive()) && "alignment must be 1 byte or more");
Mike Stumpa99038c2009-02-28 09:07:16 +0000908
Ken Dyck199c3d62010-01-11 17:06:35 +0000909 CharUnits OldOffset = BlockOffset;
Mike Stumpa99038c2009-02-28 09:07:16 +0000910
911 // Ensure proper alignment, even if it means we have to have a gap
Ken Dyck199c3d62010-01-11 17:06:35 +0000912 BlockOffset = CharUnits::fromQuantity(
Ken Dyck30a8a272010-01-26 19:13:33 +0000913 llvm::RoundUpToAlignment(BlockOffset.getQuantity(), Align.getQuantity()));
Mike Stumpa99038c2009-02-28 09:07:16 +0000914 BlockAlign = std::max(Align, BlockAlign);
Mike Stump00470a12009-03-05 08:32:30 +0000915
Ken Dyck199c3d62010-01-11 17:06:35 +0000916 CharUnits Pad = BlockOffset - OldOffset;
917 if (Pad.isPositive()) {
Mike Stumpa99038c2009-02-28 09:07:16 +0000918 QualType PadTy = getContext().getConstantArrayType(getContext().CharTy,
Ken Dyck199c3d62010-01-11 17:06:35 +0000919 llvm::APInt(32,
920 Pad.getQuantity()),
Mike Stumpa99038c2009-02-28 09:07:16 +0000921 ArrayType::Normal, 0);
Douglas Gregorba55ec22010-05-11 18:17:16 +0000922 ValueDecl *PadDecl = VarDecl::Create(getContext(),
923 getContext().getTranslationUnitDecl(),
924 SourceLocation(),
Douglas Gregor16573fa2010-04-19 22:54:31 +0000925 0, QualType(PadTy), 0,
John McCalld931b082010-08-26 03:08:43 +0000926 SC_None, SC_None);
John McCallea1471e2010-05-20 01:18:31 +0000927 Expr *E = new (getContext()) DeclRefExpr(PadDecl, PadDecl->getType(),
928 SourceLocation());
929 BlockLayout.push_back(E);
Mike Stumpa99038c2009-02-28 09:07:16 +0000930 }
Mike Stumpa99038c2009-02-28 09:07:16 +0000931
932 BlockOffset += Size;
John McCallea1471e2010-05-20 01:18:31 +0000933 return BlockOffset - Size;
Mike Stumpa99038c2009-02-28 09:07:16 +0000934}
Mike Stumpdab514f2009-03-04 03:23:46 +0000935
Mike Stump08920992009-03-07 02:35:30 +0000936llvm::Constant *BlockFunction::
937GenerateCopyHelperFunction(bool BlockHasCopyDispose, const llvm::StructType *T,
Mike Stumpb7477cf2009-04-10 18:52:28 +0000938 std::vector<HelperInfo> *NoteForHelperp) {
Mike Stumpa4f668f2009-03-06 01:33:24 +0000939 QualType R = getContext().VoidTy;
940
941 FunctionArgList Args;
942 // FIXME: This leaks
Mike Stump08920992009-03-07 02:35:30 +0000943 ImplicitParamDecl *Dst =
Mike Stumpea26cb52009-10-21 03:49:08 +0000944 ImplicitParamDecl::Create(getContext(), 0,
945 SourceLocation(), 0,
Mike Stump08920992009-03-07 02:35:30 +0000946 getContext().getPointerType(getContext().VoidTy));
947 Args.push_back(std::make_pair(Dst, Dst->getType()));
Mike Stumpa4f668f2009-03-06 01:33:24 +0000948 ImplicitParamDecl *Src =
Mike Stumpea26cb52009-10-21 03:49:08 +0000949 ImplicitParamDecl::Create(getContext(), 0,
950 SourceLocation(), 0,
Mike Stumpa4f668f2009-03-06 01:33:24 +0000951 getContext().getPointerType(getContext().VoidTy));
Mike Stumpa4f668f2009-03-06 01:33:24 +0000952 Args.push_back(std::make_pair(Src, Src->getType()));
Mike Stump1eb44332009-09-09 15:08:12 +0000953
Mike Stumpa4f668f2009-03-06 01:33:24 +0000954 const CGFunctionInfo &FI =
Rafael Espindola264ba482010-03-30 20:24:48 +0000955 CGM.getTypes().getFunctionInfo(R, Args, FunctionType::ExtInfo());
Mike Stumpa4f668f2009-03-06 01:33:24 +0000956
Mike Stump3899a7f2009-06-05 23:26:36 +0000957 // FIXME: We'd like to put these into a mergable by content, with
958 // internal linkage.
Mike Stumpa4f668f2009-03-06 01:33:24 +0000959 CodeGenTypes &Types = CGM.getTypes();
960 const llvm::FunctionType *LTy = Types.GetFunctionType(FI, false);
961
962 llvm::Function *Fn =
963 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Benjamin Kramer3cf7c5d2010-01-22 13:59:13 +0000964 "__copy_helper_block_", &CGM.getModule());
Mike Stumpa4f668f2009-03-06 01:33:24 +0000965
966 IdentifierInfo *II
967 = &CGM.getContext().Idents.get("__copy_helper_block_");
968
969 FunctionDecl *FD = FunctionDecl::Create(getContext(),
970 getContext().getTranslationUnitDecl(),
Argyrios Kyrtzidisa1d56622009-08-19 01:27:57 +0000971 SourceLocation(), II, R, 0,
John McCalld931b082010-08-26 03:08:43 +0000972 SC_Static,
973 SC_None,
Douglas Gregor16573fa2010-04-19 22:54:31 +0000974 false,
Mike Stumpa4f668f2009-03-06 01:33:24 +0000975 true);
976 CGF.StartFunction(FD, R, Fn, Args, SourceLocation());
Mike Stump08920992009-03-07 02:35:30 +0000977
978 llvm::Value *SrcObj = CGF.GetAddrOfLocalVar(Src);
979 llvm::Type *PtrPtrT;
Mike Stump08920992009-03-07 02:35:30 +0000980
Mike Stumpb7477cf2009-04-10 18:52:28 +0000981 if (NoteForHelperp) {
982 std::vector<HelperInfo> &NoteForHelper = *NoteForHelperp;
Mike Stump08920992009-03-07 02:35:30 +0000983
Owen Anderson96e0fc72009-07-29 22:16:19 +0000984 PtrPtrT = llvm::PointerType::get(llvm::PointerType::get(T, 0), 0);
Mike Stumpb7477cf2009-04-10 18:52:28 +0000985 SrcObj = Builder.CreateBitCast(SrcObj, PtrPtrT);
986 SrcObj = Builder.CreateLoad(SrcObj);
Mike Stump08920992009-03-07 02:35:30 +0000987
Mike Stumpb7477cf2009-04-10 18:52:28 +0000988 llvm::Value *DstObj = CGF.GetAddrOfLocalVar(Dst);
Mike Stumpc2f4c342009-04-15 22:11:36 +0000989 llvm::Type *PtrPtrT;
Owen Anderson96e0fc72009-07-29 22:16:19 +0000990 PtrPtrT = llvm::PointerType::get(llvm::PointerType::get(T, 0), 0);
Mike Stumpc2f4c342009-04-15 22:11:36 +0000991 DstObj = Builder.CreateBitCast(DstObj, PtrPtrT);
992 DstObj = Builder.CreateLoad(DstObj);
Mike Stump08920992009-03-07 02:35:30 +0000993
Mike Stumpb7477cf2009-04-10 18:52:28 +0000994 for (unsigned i=0; i < NoteForHelper.size(); ++i) {
995 int flag = NoteForHelper[i].flag;
996 int index = NoteForHelper[i].index;
Mike Stump08920992009-03-07 02:35:30 +0000997
Mike Stumpb7477cf2009-04-10 18:52:28 +0000998 if ((NoteForHelper[i].flag & BLOCK_FIELD_IS_BYREF)
999 || NoteForHelper[i].RequiresCopying) {
1000 llvm::Value *Srcv = SrcObj;
1001 Srcv = Builder.CreateStructGEP(Srcv, index);
1002 Srcv = Builder.CreateBitCast(Srcv,
Owen Anderson96e0fc72009-07-29 22:16:19 +00001003 llvm::PointerType::get(PtrToInt8Ty, 0));
Mike Stumpb7477cf2009-04-10 18:52:28 +00001004 Srcv = Builder.CreateLoad(Srcv);
1005
1006 llvm::Value *Dstv = Builder.CreateStructGEP(DstObj, index);
1007 Dstv = Builder.CreateBitCast(Dstv, PtrToInt8Ty);
1008
Chris Lattner77b89b82010-06-27 07:15:29 +00001009 llvm::Value *N = llvm::ConstantInt::get(CGF.Int32Ty, flag);
Daniel Dunbar673431a2010-07-16 00:00:15 +00001010 llvm::Value *F = CGM.getBlockObjectAssign();
Mike Stumpb7477cf2009-04-10 18:52:28 +00001011 Builder.CreateCall3(F, Dstv, Srcv, N);
1012 }
Mike Stump08920992009-03-07 02:35:30 +00001013 }
1014 }
1015
Mike Stumpa4f668f2009-03-06 01:33:24 +00001016 CGF.FinishFunction();
1017
Owen Anderson3c4972d2009-07-29 18:54:39 +00001018 return llvm::ConstantExpr::getBitCast(Fn, PtrToInt8Ty);
Mike Stumpdab514f2009-03-04 03:23:46 +00001019}
1020
Mike Stumpcf62d392009-03-06 18:42:23 +00001021llvm::Constant *BlockFunction::
Mike Stump08920992009-03-07 02:35:30 +00001022GenerateDestroyHelperFunction(bool BlockHasCopyDispose,
1023 const llvm::StructType* T,
Mike Stumpb7477cf2009-04-10 18:52:28 +00001024 std::vector<HelperInfo> *NoteForHelperp) {
Mike Stumpa4f668f2009-03-06 01:33:24 +00001025 QualType R = getContext().VoidTy;
1026
1027 FunctionArgList Args;
1028 // FIXME: This leaks
1029 ImplicitParamDecl *Src =
Mike Stumpea26cb52009-10-21 03:49:08 +00001030 ImplicitParamDecl::Create(getContext(), 0,
1031 SourceLocation(), 0,
Mike Stumpa4f668f2009-03-06 01:33:24 +00001032 getContext().getPointerType(getContext().VoidTy));
1033
1034 Args.push_back(std::make_pair(Src, Src->getType()));
Mike Stump1eb44332009-09-09 15:08:12 +00001035
Mike Stumpa4f668f2009-03-06 01:33:24 +00001036 const CGFunctionInfo &FI =
Rafael Espindola264ba482010-03-30 20:24:48 +00001037 CGM.getTypes().getFunctionInfo(R, Args, FunctionType::ExtInfo());
Mike Stumpa4f668f2009-03-06 01:33:24 +00001038
Mike Stump3899a7f2009-06-05 23:26:36 +00001039 // FIXME: We'd like to put these into a mergable by content, with
1040 // internal linkage.
Mike Stumpa4f668f2009-03-06 01:33:24 +00001041 CodeGenTypes &Types = CGM.getTypes();
1042 const llvm::FunctionType *LTy = Types.GetFunctionType(FI, false);
1043
1044 llvm::Function *Fn =
1045 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Benjamin Kramer3cf7c5d2010-01-22 13:59:13 +00001046 "__destroy_helper_block_", &CGM.getModule());
Mike Stumpa4f668f2009-03-06 01:33:24 +00001047
1048 IdentifierInfo *II
1049 = &CGM.getContext().Idents.get("__destroy_helper_block_");
1050
1051 FunctionDecl *FD = FunctionDecl::Create(getContext(),
1052 getContext().getTranslationUnitDecl(),
Argyrios Kyrtzidisa1d56622009-08-19 01:27:57 +00001053 SourceLocation(), II, R, 0,
John McCalld931b082010-08-26 03:08:43 +00001054 SC_Static,
1055 SC_None,
Douglas Gregor16573fa2010-04-19 22:54:31 +00001056 false, true);
Mike Stumpa4f668f2009-03-06 01:33:24 +00001057 CGF.StartFunction(FD, R, Fn, Args, SourceLocation());
Mike Stump1edf6b62009-03-07 02:53:18 +00001058
Mike Stumpb7477cf2009-04-10 18:52:28 +00001059 if (NoteForHelperp) {
1060 std::vector<HelperInfo> &NoteForHelper = *NoteForHelperp;
Mike Stump1edf6b62009-03-07 02:53:18 +00001061
Mike Stumpb7477cf2009-04-10 18:52:28 +00001062 llvm::Value *SrcObj = CGF.GetAddrOfLocalVar(Src);
1063 llvm::Type *PtrPtrT;
Owen Anderson96e0fc72009-07-29 22:16:19 +00001064 PtrPtrT = llvm::PointerType::get(llvm::PointerType::get(T, 0), 0);
Mike Stumpb7477cf2009-04-10 18:52:28 +00001065 SrcObj = Builder.CreateBitCast(SrcObj, PtrPtrT);
1066 SrcObj = Builder.CreateLoad(SrcObj);
Mike Stump1edf6b62009-03-07 02:53:18 +00001067
Mike Stumpb7477cf2009-04-10 18:52:28 +00001068 for (unsigned i=0; i < NoteForHelper.size(); ++i) {
1069 int flag = NoteForHelper[i].flag;
1070 int index = NoteForHelper[i].index;
Mike Stump1edf6b62009-03-07 02:53:18 +00001071
Mike Stumpb7477cf2009-04-10 18:52:28 +00001072 if ((NoteForHelper[i].flag & BLOCK_FIELD_IS_BYREF)
1073 || NoteForHelper[i].RequiresCopying) {
1074 llvm::Value *Srcv = SrcObj;
1075 Srcv = Builder.CreateStructGEP(Srcv, index);
1076 Srcv = Builder.CreateBitCast(Srcv,
Owen Anderson96e0fc72009-07-29 22:16:19 +00001077 llvm::PointerType::get(PtrToInt8Ty, 0));
Mike Stumpb7477cf2009-04-10 18:52:28 +00001078 Srcv = Builder.CreateLoad(Srcv);
1079
1080 BuildBlockRelease(Srcv, flag);
1081 }
Mike Stump1edf6b62009-03-07 02:53:18 +00001082 }
1083 }
1084
Mike Stumpa4f668f2009-03-06 01:33:24 +00001085 CGF.FinishFunction();
1086
Owen Anderson3c4972d2009-07-29 18:54:39 +00001087 return llvm::ConstantExpr::getBitCast(Fn, PtrToInt8Ty);
Mike Stumpa4f668f2009-03-06 01:33:24 +00001088}
1089
Mike Stump08920992009-03-07 02:35:30 +00001090llvm::Constant *BlockFunction::BuildCopyHelper(const llvm::StructType *T,
Mike Stumpb7477cf2009-04-10 18:52:28 +00001091 std::vector<HelperInfo> *NoteForHelper) {
Mike Stump08920992009-03-07 02:35:30 +00001092 return CodeGenFunction(CGM).GenerateCopyHelperFunction(BlockHasCopyDispose,
1093 T, NoteForHelper);
Mike Stumpa4f668f2009-03-06 01:33:24 +00001094}
1095
Mike Stump08920992009-03-07 02:35:30 +00001096llvm::Constant *BlockFunction::BuildDestroyHelper(const llvm::StructType *T,
Mike Stumpb7477cf2009-04-10 18:52:28 +00001097 std::vector<HelperInfo> *NoteForHelperp) {
Mike Stump08920992009-03-07 02:35:30 +00001098 return CodeGenFunction(CGM).GenerateDestroyHelperFunction(BlockHasCopyDispose,
Mike Stumpb7477cf2009-04-10 18:52:28 +00001099 T, NoteForHelperp);
Mike Stumpdab514f2009-03-04 03:23:46 +00001100}
Mike Stump797b6322009-03-05 01:23:13 +00001101
Mike Stumpee094222009-03-06 06:12:24 +00001102llvm::Constant *BlockFunction::
1103GeneratebyrefCopyHelperFunction(const llvm::Type *T, int flag) {
Mike Stump45031c02009-03-06 02:29:21 +00001104 QualType R = getContext().VoidTy;
1105
1106 FunctionArgList Args;
1107 // FIXME: This leaks
Mike Stumpee094222009-03-06 06:12:24 +00001108 ImplicitParamDecl *Dst =
Mike Stumpea26cb52009-10-21 03:49:08 +00001109 ImplicitParamDecl::Create(getContext(), 0,
1110 SourceLocation(), 0,
Mike Stumpee094222009-03-06 06:12:24 +00001111 getContext().getPointerType(getContext().VoidTy));
1112 Args.push_back(std::make_pair(Dst, Dst->getType()));
1113
1114 // FIXME: This leaks
Mike Stump45031c02009-03-06 02:29:21 +00001115 ImplicitParamDecl *Src =
Mike Stumpea26cb52009-10-21 03:49:08 +00001116 ImplicitParamDecl::Create(getContext(), 0,
1117 SourceLocation(), 0,
Mike Stump45031c02009-03-06 02:29:21 +00001118 getContext().getPointerType(getContext().VoidTy));
Mike Stump45031c02009-03-06 02:29:21 +00001119 Args.push_back(std::make_pair(Src, Src->getType()));
Mike Stump1eb44332009-09-09 15:08:12 +00001120
Mike Stump45031c02009-03-06 02:29:21 +00001121 const CGFunctionInfo &FI =
Rafael Espindola264ba482010-03-30 20:24:48 +00001122 CGM.getTypes().getFunctionInfo(R, Args, FunctionType::ExtInfo());
Mike Stump45031c02009-03-06 02:29:21 +00001123
Mike Stump45031c02009-03-06 02:29:21 +00001124 CodeGenTypes &Types = CGM.getTypes();
1125 const llvm::FunctionType *LTy = Types.GetFunctionType(FI, false);
1126
Mike Stump3899a7f2009-06-05 23:26:36 +00001127 // FIXME: We'd like to put these into a mergable by content, with
1128 // internal linkage.
Mike Stump45031c02009-03-06 02:29:21 +00001129 llvm::Function *Fn =
1130 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Benjamin Kramer3cf7c5d2010-01-22 13:59:13 +00001131 "__Block_byref_id_object_copy_", &CGM.getModule());
Mike Stump45031c02009-03-06 02:29:21 +00001132
1133 IdentifierInfo *II
1134 = &CGM.getContext().Idents.get("__Block_byref_id_object_copy_");
1135
1136 FunctionDecl *FD = FunctionDecl::Create(getContext(),
1137 getContext().getTranslationUnitDecl(),
Argyrios Kyrtzidisa1d56622009-08-19 01:27:57 +00001138 SourceLocation(), II, R, 0,
John McCalld931b082010-08-26 03:08:43 +00001139 SC_Static,
1140 SC_None,
Douglas Gregor16573fa2010-04-19 22:54:31 +00001141 false, true);
Mike Stump45031c02009-03-06 02:29:21 +00001142 CGF.StartFunction(FD, R, Fn, Args, SourceLocation());
Mike Stumpee094222009-03-06 06:12:24 +00001143
1144 // dst->x
1145 llvm::Value *V = CGF.GetAddrOfLocalVar(Dst);
Owen Anderson96e0fc72009-07-29 22:16:19 +00001146 V = Builder.CreateBitCast(V, llvm::PointerType::get(T, 0));
Mike Stumpc2f4c342009-04-15 22:11:36 +00001147 V = Builder.CreateLoad(V);
Mike Stumpee094222009-03-06 06:12:24 +00001148 V = Builder.CreateStructGEP(V, 6, "x");
1149 llvm::Value *DstObj = Builder.CreateBitCast(V, PtrToInt8Ty);
1150
1151 // src->x
1152 V = CGF.GetAddrOfLocalVar(Src);
1153 V = Builder.CreateLoad(V);
1154 V = Builder.CreateBitCast(V, T);
1155 V = Builder.CreateStructGEP(V, 6, "x");
Owen Anderson96e0fc72009-07-29 22:16:19 +00001156 V = Builder.CreateBitCast(V, llvm::PointerType::get(PtrToInt8Ty, 0));
Mike Stumpee094222009-03-06 06:12:24 +00001157 llvm::Value *SrcObj = Builder.CreateLoad(V);
Mike Stump1eb44332009-09-09 15:08:12 +00001158
Mike Stumpee094222009-03-06 06:12:24 +00001159 flag |= BLOCK_BYREF_CALLER;
1160
Chris Lattner77b89b82010-06-27 07:15:29 +00001161 llvm::Value *N = llvm::ConstantInt::get(CGF.Int32Ty, flag);
Daniel Dunbar673431a2010-07-16 00:00:15 +00001162 llvm::Value *F = CGM.getBlockObjectAssign();
Mike Stumpee094222009-03-06 06:12:24 +00001163 Builder.CreateCall3(F, DstObj, SrcObj, N);
1164
Mike Stump45031c02009-03-06 02:29:21 +00001165 CGF.FinishFunction();
1166
Owen Anderson3c4972d2009-07-29 18:54:39 +00001167 return llvm::ConstantExpr::getBitCast(Fn, PtrToInt8Ty);
Mike Stump45031c02009-03-06 02:29:21 +00001168}
1169
Mike Stump1851b682009-03-06 04:53:30 +00001170llvm::Constant *
1171BlockFunction::GeneratebyrefDestroyHelperFunction(const llvm::Type *T,
1172 int flag) {
Mike Stump45031c02009-03-06 02:29:21 +00001173 QualType R = getContext().VoidTy;
1174
1175 FunctionArgList Args;
1176 // FIXME: This leaks
1177 ImplicitParamDecl *Src =
Mike Stumpea26cb52009-10-21 03:49:08 +00001178 ImplicitParamDecl::Create(getContext(), 0,
1179 SourceLocation(), 0,
Mike Stump45031c02009-03-06 02:29:21 +00001180 getContext().getPointerType(getContext().VoidTy));
1181
1182 Args.push_back(std::make_pair(Src, Src->getType()));
Mike Stump1eb44332009-09-09 15:08:12 +00001183
Mike Stump45031c02009-03-06 02:29:21 +00001184 const CGFunctionInfo &FI =
Rafael Espindola264ba482010-03-30 20:24:48 +00001185 CGM.getTypes().getFunctionInfo(R, Args, FunctionType::ExtInfo());
Mike Stump45031c02009-03-06 02:29:21 +00001186
Mike Stump45031c02009-03-06 02:29:21 +00001187 CodeGenTypes &Types = CGM.getTypes();
1188 const llvm::FunctionType *LTy = Types.GetFunctionType(FI, false);
1189
Mike Stump3899a7f2009-06-05 23:26:36 +00001190 // FIXME: We'd like to put these into a mergable by content, with
1191 // internal linkage.
Mike Stump45031c02009-03-06 02:29:21 +00001192 llvm::Function *Fn =
1193 llvm::Function::Create(LTy, llvm::GlobalValue::InternalLinkage,
Benjamin Kramer3cf7c5d2010-01-22 13:59:13 +00001194 "__Block_byref_id_object_dispose_",
Mike Stump45031c02009-03-06 02:29:21 +00001195 &CGM.getModule());
1196
1197 IdentifierInfo *II
1198 = &CGM.getContext().Idents.get("__Block_byref_id_object_dispose_");
1199
1200 FunctionDecl *FD = FunctionDecl::Create(getContext(),
1201 getContext().getTranslationUnitDecl(),
Argyrios Kyrtzidisa1d56622009-08-19 01:27:57 +00001202 SourceLocation(), II, R, 0,
John McCalld931b082010-08-26 03:08:43 +00001203 SC_Static,
1204 SC_None,
Douglas Gregor16573fa2010-04-19 22:54:31 +00001205 false, true);
Mike Stump45031c02009-03-06 02:29:21 +00001206 CGF.StartFunction(FD, R, Fn, Args, SourceLocation());
Mike Stump1851b682009-03-06 04:53:30 +00001207
1208 llvm::Value *V = CGF.GetAddrOfLocalVar(Src);
Owen Anderson96e0fc72009-07-29 22:16:19 +00001209 V = Builder.CreateBitCast(V, llvm::PointerType::get(T, 0));
Mike Stumpc2f4c342009-04-15 22:11:36 +00001210 V = Builder.CreateLoad(V);
Mike Stump1851b682009-03-06 04:53:30 +00001211 V = Builder.CreateStructGEP(V, 6, "x");
Owen Anderson96e0fc72009-07-29 22:16:19 +00001212 V = Builder.CreateBitCast(V, llvm::PointerType::get(PtrToInt8Ty, 0));
Mike Stumpc2f4c342009-04-15 22:11:36 +00001213 V = Builder.CreateLoad(V);
Mike Stump1851b682009-03-06 04:53:30 +00001214
Mike Stump1851b682009-03-06 04:53:30 +00001215 flag |= BLOCK_BYREF_CALLER;
1216 BuildBlockRelease(V, flag);
Mike Stump45031c02009-03-06 02:29:21 +00001217 CGF.FinishFunction();
1218
Owen Anderson3c4972d2009-07-29 18:54:39 +00001219 return llvm::ConstantExpr::getBitCast(Fn, PtrToInt8Ty);
Mike Stump45031c02009-03-06 02:29:21 +00001220}
1221
Mike Stumpee094222009-03-06 06:12:24 +00001222llvm::Constant *BlockFunction::BuildbyrefCopyHelper(const llvm::Type *T,
Chris Lattner10976d92009-12-05 08:21:30 +00001223 int Flag, unsigned Align) {
1224 // All alignments below that of pointer alignment collapse down to just
Mike Stump3899a7f2009-06-05 23:26:36 +00001225 // pointer alignment, as we always have at least that much alignment to begin
1226 // with.
1227 Align /= unsigned(CGF.Target.getPointerAlign(0)/8);
Chris Lattner10976d92009-12-05 08:21:30 +00001228
Mike Stump3899a7f2009-06-05 23:26:36 +00001229 // As an optimization, we only generate a single function of each kind we
1230 // might need. We need a different one for each alignment and for each
1231 // setting of flags. We mix Align and flag to get the kind.
Chris Lattner10976d92009-12-05 08:21:30 +00001232 uint64_t Kind = (uint64_t)Align*BLOCK_BYREF_CURRENT_MAX + Flag;
1233 llvm::Constant *&Entry = CGM.AssignCache[Kind];
Mike Stump3899a7f2009-06-05 23:26:36 +00001234 if (Entry)
1235 return Entry;
Chris Lattner10976d92009-12-05 08:21:30 +00001236 return Entry = CodeGenFunction(CGM).GeneratebyrefCopyHelperFunction(T, Flag);
Mike Stump45031c02009-03-06 02:29:21 +00001237}
1238
Mike Stump1851b682009-03-06 04:53:30 +00001239llvm::Constant *BlockFunction::BuildbyrefDestroyHelper(const llvm::Type *T,
Chris Lattner10976d92009-12-05 08:21:30 +00001240 int Flag,
Mike Stump3899a7f2009-06-05 23:26:36 +00001241 unsigned Align) {
1242 // All alignments below that of pointer alignment collpase down to just
1243 // pointer alignment, as we always have at least that much alignment to begin
1244 // with.
1245 Align /= unsigned(CGF.Target.getPointerAlign(0)/8);
Chris Lattner10976d92009-12-05 08:21:30 +00001246
Mike Stump3899a7f2009-06-05 23:26:36 +00001247 // As an optimization, we only generate a single function of each kind we
1248 // might need. We need a different one for each alignment and for each
1249 // setting of flags. We mix Align and flag to get the kind.
Chris Lattner10976d92009-12-05 08:21:30 +00001250 uint64_t Kind = (uint64_t)Align*BLOCK_BYREF_CURRENT_MAX + Flag;
1251 llvm::Constant *&Entry = CGM.DestroyCache[Kind];
Mike Stump3899a7f2009-06-05 23:26:36 +00001252 if (Entry)
1253 return Entry;
Chris Lattner10976d92009-12-05 08:21:30 +00001254 return Entry=CodeGenFunction(CGM).GeneratebyrefDestroyHelperFunction(T, Flag);
Mike Stump45031c02009-03-06 02:29:21 +00001255}
1256
Mike Stump1851b682009-03-06 04:53:30 +00001257void BlockFunction::BuildBlockRelease(llvm::Value *V, int flag) {
Daniel Dunbar673431a2010-07-16 00:00:15 +00001258 llvm::Value *F = CGM.getBlockObjectDispose();
Mike Stump1851b682009-03-06 04:53:30 +00001259 llvm::Value *N;
Mike Stump797b6322009-03-05 01:23:13 +00001260 V = Builder.CreateBitCast(V, PtrToInt8Ty);
Chris Lattner77b89b82010-06-27 07:15:29 +00001261 N = llvm::ConstantInt::get(CGF.Int32Ty, flag);
Mike Stump797b6322009-03-05 01:23:13 +00001262 Builder.CreateCall2(F, V, N);
1263}
Mike Stump00470a12009-03-05 08:32:30 +00001264
1265ASTContext &BlockFunction::getContext() const { return CGM.getContext(); }
Mike Stump08920992009-03-07 02:35:30 +00001266
1267BlockFunction::BlockFunction(CodeGenModule &cgm, CodeGenFunction &cgf,
1268 CGBuilderTy &B)
Chris Lattner77b89b82010-06-27 07:15:29 +00001269 : CGM(cgm), VMContext(cgm.getLLVMContext()), CGF(cgf), Builder(B) {
Owen Anderson0032b272009-08-13 21:57:51 +00001270 PtrToInt8Ty = llvm::PointerType::getUnqual(
1271 llvm::Type::getInt8Ty(VMContext));
Mike Stump08920992009-03-07 02:35:30 +00001272
1273 BlockHasCopyDispose = false;
1274}