blob: a9f5ae05c1094c3aa9fcd8d6888cb5afd3aa7cf2 [file] [log] [blame]
Mike Stumpd883d842009-03-04 15:35:22 +00001//===-- CGBlocks.h - state for LLVM CodeGen for blocks ----------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This is the internal state used for llvm translation for block literals.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef CLANG_CODEGEN_CGBLOCKS_H
15#define CLANG_CODEGEN_CGBLOCKS_H
16
Mike Stump2a998142009-03-04 18:17:45 +000017#include "CodeGenTypes.h"
18#include "clang/AST/Type.h"
Owen Andersona1cf15f2009-07-14 23:10:40 +000019#include "llvm/Module.h"
Mike Stump2a998142009-03-04 18:17:45 +000020#include "llvm/ADT/DenseMap.h"
21#include "llvm/ADT/SmallVector.h"
22#include "clang/Basic/TargetInfo.h"
Ken Dyck199c3d62010-01-11 17:06:35 +000023#include "clang/AST/CharUnits.h"
Mike Stump2a998142009-03-04 18:17:45 +000024#include "clang/AST/Expr.h"
25#include "clang/AST/ExprCXX.h"
26#include "clang/AST/ExprObjC.h"
27
28#include <vector>
29#include <map>
30
31#include "CGBuilder.h"
32#include "CGCall.h"
33#include "CGValue.h"
34
35namespace llvm {
36 class Module;
37 class Constant;
38 class Function;
39 class GlobalValue;
40 class TargetData;
41 class FunctionType;
42 class Value;
Benjamin Kramerf21efe92009-08-11 17:46:57 +000043 class LLVMContext;
Mike Stump2a998142009-03-04 18:17:45 +000044}
45
Mike Stumpd883d842009-03-04 15:35:22 +000046namespace clang {
47
48namespace CodeGen {
Mike Stump90a90432009-03-04 18:47:42 +000049class CodeGenModule;
Mike Stumpd883d842009-03-04 15:35:22 +000050
51class BlockBase {
52public:
53 enum {
54 BLOCK_NEEDS_FREE = (1 << 24),
55 BLOCK_HAS_COPY_DISPOSE = (1 << 25),
56 BLOCK_HAS_CXX_OBJ = (1 << 26),
57 BLOCK_IS_GC = (1 << 27),
58 BLOCK_IS_GLOBAL = (1 << 28),
David Chisnall5e530af2009-11-17 19:33:30 +000059 BLOCK_HAS_DESCRIPTOR = (1 << 29),
60 BLOCK_HAS_OBJC_TYPE = (1 << 30)
Mike Stumpd883d842009-03-04 15:35:22 +000061 };
62};
63
64class BlockModule : public BlockBase {
Mike Stump2a998142009-03-04 18:17:45 +000065 ASTContext &Context;
66 llvm::Module &TheModule;
Mike Stump90a90432009-03-04 18:47:42 +000067 const llvm::TargetData &TheTargetData;
Mike Stump2a998142009-03-04 18:17:45 +000068 CodeGenTypes &Types;
Mike Stump90a90432009-03-04 18:47:42 +000069 CodeGenModule &CGM;
Owen Andersona1cf15f2009-07-14 23:10:40 +000070 llvm::LLVMContext &VMContext;
Mike Stump1eb44332009-09-09 15:08:12 +000071
Mike Stump2a998142009-03-04 18:17:45 +000072 ASTContext &getContext() const { return Context; }
73 llvm::Module &getModule() const { return TheModule; }
74 CodeGenTypes &getTypes() { return Types; }
Mike Stump90a90432009-03-04 18:47:42 +000075 const llvm::TargetData &getTargetData() const { return TheTargetData; }
Mike Stump2a998142009-03-04 18:17:45 +000076public:
77 llvm::Constant *getNSConcreteGlobalBlock();
78 llvm::Constant *getNSConcreteStackBlock();
79 int getGlobalUniqueCount() { return ++Block.GlobalUniqueCount; }
80 const llvm::Type *getBlockDescriptorType();
81
82 const llvm::Type *getGenericBlockLiteralType();
83 const llvm::Type *getGenericExtendedBlockLiteralType();
84
Mike Stump90a90432009-03-04 18:47:42 +000085 llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, const char *);
86
Mike Stump2a998142009-03-04 18:17:45 +000087 /// NSConcreteGlobalBlock - Cached reference to the class pointer for global
88 /// blocks.
89 llvm::Constant *NSConcreteGlobalBlock;
90
91 /// NSConcreteStackBlock - Cached reference to the class poinnter for stack
92 /// blocks.
93 llvm::Constant *NSConcreteStackBlock;
Mike Stump1eb44332009-09-09 15:08:12 +000094
Mike Stump2a998142009-03-04 18:17:45 +000095 const llvm::Type *BlockDescriptorType;
96 const llvm::Type *GenericBlockLiteralType;
97 const llvm::Type *GenericExtendedBlockLiteralType;
98 struct {
99 int GlobalUniqueCount;
100 } Block;
101
Mike Stumpee094222009-03-06 06:12:24 +0000102 llvm::Value *BlockObjectAssign;
Mike Stump797b6322009-03-05 01:23:13 +0000103 llvm::Value *BlockObjectDispose;
104 const llvm::Type *PtrToInt8Ty;
105
Mike Stump3899a7f2009-06-05 23:26:36 +0000106 std::map<uint64_t, llvm::Constant *> AssignCache;
107 std::map<uint64_t, llvm::Constant *> DestroyCache;
108
Mike Stump90a90432009-03-04 18:47:42 +0000109 BlockModule(ASTContext &C, llvm::Module &M, const llvm::TargetData &TD,
110 CodeGenTypes &T, CodeGenModule &CodeGen)
111 : Context(C), TheModule(M), TheTargetData(TD), Types(T),
Owen Andersona1cf15f2009-07-14 23:10:40 +0000112 CGM(CodeGen), VMContext(M.getContext()),
Mike Stump90a90432009-03-04 18:47:42 +0000113 NSConcreteGlobalBlock(0), NSConcreteStackBlock(0), BlockDescriptorType(0),
Mike Stump08920992009-03-07 02:35:30 +0000114 GenericBlockLiteralType(0), GenericExtendedBlockLiteralType(0),
115 BlockObjectAssign(0), BlockObjectDispose(0) {
Mike Stump2a998142009-03-04 18:17:45 +0000116 Block.GlobalUniqueCount = 0;
Benjamin Kramer3c0ef8c2009-10-13 10:07:13 +0000117 PtrToInt8Ty = llvm::Type::getInt8PtrTy(M.getContext());
Mike Stump2a998142009-03-04 18:17:45 +0000118 }
Mike Stump39605b42009-09-22 02:12:52 +0000119
Mike Stumpbf5fd782009-10-21 18:23:01 +0000120 bool BlockRequiresCopying(QualType Ty)
121 { return getContext().BlockRequiresCopying(Ty); }
Mike Stumpd883d842009-03-04 15:35:22 +0000122};
123
124class BlockFunction : public BlockBase {
Mike Stump797b6322009-03-05 01:23:13 +0000125 CodeGenModule &CGM;
Mike Stumpa4f668f2009-03-06 01:33:24 +0000126 CodeGenFunction &CGF;
Mike Stump00470a12009-03-05 08:32:30 +0000127 ASTContext &getContext() const;
Mike Stump797b6322009-03-05 01:23:13 +0000128
Owen Andersona1cf15f2009-07-14 23:10:40 +0000129protected:
130 llvm::LLVMContext &VMContext;
131
Mike Stumpd883d842009-03-04 15:35:22 +0000132public:
Mike Stump797b6322009-03-05 01:23:13 +0000133 const llvm::Type *PtrToInt8Ty;
Mike Stump08920992009-03-07 02:35:30 +0000134 struct HelperInfo {
135 int index;
136 int flag;
137 bool RequiresCopying;
138 };
139
Mike Stump797b6322009-03-05 01:23:13 +0000140 enum {
Mike Stumpd883d842009-03-04 15:35:22 +0000141 BLOCK_FIELD_IS_OBJECT = 3, /* id, NSObject, __attribute__((NSObject)),
142 block, ... */
143 BLOCK_FIELD_IS_BLOCK = 7, /* a block variable */
144 BLOCK_FIELD_IS_BYREF = 8, /* the on stack structure holding the __block
145 variable */
146 BLOCK_FIELD_IS_WEAK = 16, /* declared __weak, only used in byref copy
147 helpers */
Mike Stump3899a7f2009-06-05 23:26:36 +0000148 BLOCK_BYREF_CALLER = 128, /* called from __block (byref) copy/dispose
Mike Stumpd883d842009-03-04 15:35:22 +0000149 support routines */
Mike Stump3899a7f2009-06-05 23:26:36 +0000150 BLOCK_BYREF_CURRENT_MAX = 256
Mike Stumpd883d842009-03-04 15:35:22 +0000151 };
Mike Stump3947de52009-03-04 18:57:26 +0000152
Mike Stumpad75ab42009-03-04 19:03:44 +0000153 /// BlockInfo - Information to generate a block literal.
154 struct BlockInfo {
155 /// BlockLiteralTy - The type of the block literal.
156 const llvm::Type *BlockLiteralTy;
157
Daniel Dunbar49f59ec2009-05-14 16:42:16 +0000158 /// Name - the name of the function this block was created for, if any.
Mike Stumpad75ab42009-03-04 19:03:44 +0000159 const char *Name;
160
161 /// ByCopyDeclRefs - Variables from parent scopes that have been imported
162 /// into this block.
Mike Stumpea26cb52009-10-21 03:49:08 +0000163 llvm::SmallVector<const BlockDeclRefExpr *, 8> DeclRefs;
Mike Stump1eb44332009-09-09 15:08:12 +0000164
Mike Stumpad75ab42009-03-04 19:03:44 +0000165 BlockInfo(const llvm::Type *blt, const char *n)
Daniel Dunbar49f59ec2009-05-14 16:42:16 +0000166 : BlockLiteralTy(blt), Name(n) {
167 // Skip asm prefix, if any.
168 if (Name && Name[0] == '\01')
169 ++Name;
170 }
Mike Stumpad75ab42009-03-04 19:03:44 +0000171 };
172
Mike Stump3947de52009-03-04 18:57:26 +0000173 CGBuilderTy &Builder;
174
Mike Stump08920992009-03-07 02:35:30 +0000175 BlockFunction(CodeGenModule &cgm, CodeGenFunction &cgf, CGBuilderTy &B);
176
177 /// BlockOffset - The offset in bytes for the next allocation of an
178 /// imported block variable.
Ken Dyck199c3d62010-01-11 17:06:35 +0000179 CharUnits BlockOffset;
Ken Dyck30a8a272010-01-26 19:13:33 +0000180 /// BlockAlign - Maximal alignment needed for the Block expressed in
181 /// characters.
182 CharUnits BlockAlign;
Mike Stump08920992009-03-07 02:35:30 +0000183
184 /// getBlockOffset - Allocate an offset for the ValueDecl from a
185 /// BlockDeclRefExpr in a block literal (BlockExpr).
Ken Dyck199c3d62010-01-11 17:06:35 +0000186 CharUnits getBlockOffset(const BlockDeclRefExpr *E);
Mike Stump08920992009-03-07 02:35:30 +0000187
188 /// BlockHasCopyDispose - True iff the block uses copy/dispose.
189 bool BlockHasCopyDispose;
190
191 /// BlockDeclRefDecls - Decls from BlockDeclRefExprs in apperance order
192 /// in a block literal. Decls without names are used for padding.
193 llvm::SmallVector<const Expr *, 8> BlockDeclRefDecls;
194
195 /// BlockDecls - Offsets for all Decls in BlockDeclRefExprs.
Ken Dyck199c3d62010-01-11 17:06:35 +0000196 std::map<const Decl*, CharUnits> BlockDecls;
Mike Stump3947de52009-03-04 18:57:26 +0000197
Mike Stumpad75ab42009-03-04 19:03:44 +0000198 ImplicitParamDecl *BlockStructDecl;
199 ImplicitParamDecl *getBlockStructDecl() { return BlockStructDecl; }
200
Mike Stump08920992009-03-07 02:35:30 +0000201 llvm::Constant *GenerateCopyHelperFunction(bool, const llvm::StructType *,
Mike Stumpb7477cf2009-04-10 18:52:28 +0000202 std::vector<HelperInfo> *);
Mike Stump08920992009-03-07 02:35:30 +0000203 llvm::Constant *GenerateDestroyHelperFunction(bool, const llvm::StructType *,
Mike Stumpb7477cf2009-04-10 18:52:28 +0000204 std::vector<HelperInfo> *);
Mike Stumpa4f668f2009-03-06 01:33:24 +0000205
Mike Stump08920992009-03-07 02:35:30 +0000206 llvm::Constant *BuildCopyHelper(const llvm::StructType *,
Mike Stumpb7477cf2009-04-10 18:52:28 +0000207 std::vector<HelperInfo> *);
Mike Stump08920992009-03-07 02:35:30 +0000208 llvm::Constant *BuildDestroyHelper(const llvm::StructType *,
Mike Stumpb7477cf2009-04-10 18:52:28 +0000209 std::vector<HelperInfo> *);
Mike Stump45031c02009-03-06 02:29:21 +0000210
Mike Stumpee094222009-03-06 06:12:24 +0000211 llvm::Constant *GeneratebyrefCopyHelperFunction(const llvm::Type *, int flag);
Mike Stump1851b682009-03-06 04:53:30 +0000212 llvm::Constant *GeneratebyrefDestroyHelperFunction(const llvm::Type *T, int);
Mike Stump45031c02009-03-06 02:29:21 +0000213
Mike Stump3899a7f2009-06-05 23:26:36 +0000214 llvm::Constant *BuildbyrefCopyHelper(const llvm::Type *T, int flag,
215 unsigned Align);
216 llvm::Constant *BuildbyrefDestroyHelper(const llvm::Type *T, int flag,
217 unsigned Align);
Mike Stump3947de52009-03-04 18:57:26 +0000218
Mike Stumpee094222009-03-06 06:12:24 +0000219 llvm::Value *getBlockObjectAssign();
Mike Stump797b6322009-03-05 01:23:13 +0000220 llvm::Value *getBlockObjectDispose();
Mike Stump1851b682009-03-06 04:53:30 +0000221 void BuildBlockRelease(llvm::Value *DeclPtr, int flag = BLOCK_FIELD_IS_BYREF);
Mike Stump00470a12009-03-05 08:32:30 +0000222
Mike Stumpbf5fd782009-10-21 18:23:01 +0000223 bool BlockRequiresCopying(QualType Ty)
224 { return getContext().BlockRequiresCopying(Ty); }
Mike Stumpd883d842009-03-04 15:35:22 +0000225};
226
227} // end namespace CodeGen
228} // end namespace clang
229
230#endif