blob: 9e3750e3e6cf50001ad362ea84915dd0e90c78be [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/SmallVector.h"
21#include "clang/Basic/TargetInfo.h"
Ken Dyck199c3d62010-01-11 17:06:35 +000022#include "clang/AST/CharUnits.h"
Mike Stump2a998142009-03-04 18:17:45 +000023#include "clang/AST/Expr.h"
24#include "clang/AST/ExprCXX.h"
25#include "clang/AST/ExprObjC.h"
26
27#include <vector>
28#include <map>
29
30#include "CGBuilder.h"
31#include "CGCall.h"
32#include "CGValue.h"
33
34namespace llvm {
35 class Module;
36 class Constant;
37 class Function;
38 class GlobalValue;
39 class TargetData;
40 class FunctionType;
John McCall3d3ec1c2010-04-21 10:05:39 +000041 class PointerType;
Mike Stump2a998142009-03-04 18:17:45 +000042 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 {
Mike Stumpd883d842009-03-04 15:35:22 +000054 BLOCK_HAS_COPY_DISPOSE = (1 << 25),
55 BLOCK_HAS_CXX_OBJ = (1 << 26),
Mike Stumpd883d842009-03-04 15:35:22 +000056 BLOCK_IS_GLOBAL = (1 << 28),
Blaine Garsta36e2232010-03-05 01:29:59 +000057 BLOCK_USE_STRET = (1 << 29),
58 BLOCK_HAS_SIGNATURE = (1 << 30)
Mike Stumpd883d842009-03-04 15:35:22 +000059 };
60};
61
Blaine Garsta36e2232010-03-05 01:29:59 +000062
Mike Stumpd883d842009-03-04 15:35:22 +000063class BlockModule : public BlockBase {
Mike Stump2a998142009-03-04 18:17:45 +000064 ASTContext &Context;
65 llvm::Module &TheModule;
Mike Stump90a90432009-03-04 18:47:42 +000066 const llvm::TargetData &TheTargetData;
Mike Stump2a998142009-03-04 18:17:45 +000067 CodeGenTypes &Types;
Mike Stump90a90432009-03-04 18:47:42 +000068 CodeGenModule &CGM;
Owen Andersona1cf15f2009-07-14 23:10:40 +000069 llvm::LLVMContext &VMContext;
Mike Stump1eb44332009-09-09 15:08:12 +000070
Mike Stump2a998142009-03-04 18:17:45 +000071 ASTContext &getContext() const { return Context; }
72 llvm::Module &getModule() const { return TheModule; }
73 CodeGenTypes &getTypes() { return Types; }
Mike Stump90a90432009-03-04 18:47:42 +000074 const llvm::TargetData &getTargetData() const { return TheTargetData; }
Mike Stump2a998142009-03-04 18:17:45 +000075public:
76 llvm::Constant *getNSConcreteGlobalBlock();
77 llvm::Constant *getNSConcreteStackBlock();
78 int getGlobalUniqueCount() { return ++Block.GlobalUniqueCount; }
79 const llvm::Type *getBlockDescriptorType();
80
81 const llvm::Type *getGenericBlockLiteralType();
Mike Stump2a998142009-03-04 18:17:45 +000082
Mike Stump90a90432009-03-04 18:47:42 +000083 llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, const char *);
84
Mike Stump2a998142009-03-04 18:17:45 +000085 /// NSConcreteGlobalBlock - Cached reference to the class pointer for global
86 /// blocks.
87 llvm::Constant *NSConcreteGlobalBlock;
88
89 /// NSConcreteStackBlock - Cached reference to the class poinnter for stack
90 /// blocks.
91 llvm::Constant *NSConcreteStackBlock;
Mike Stump1eb44332009-09-09 15:08:12 +000092
Mike Stump2a998142009-03-04 18:17:45 +000093 const llvm::Type *BlockDescriptorType;
94 const llvm::Type *GenericBlockLiteralType;
Blaine Garstc0ea8852010-02-19 00:24:37 +000095
Mike Stump2a998142009-03-04 18:17:45 +000096 struct {
97 int GlobalUniqueCount;
98 } Block;
99
Mike Stumpee094222009-03-06 06:12:24 +0000100 llvm::Value *BlockObjectAssign;
Mike Stump797b6322009-03-05 01:23:13 +0000101 llvm::Value *BlockObjectDispose;
102 const llvm::Type *PtrToInt8Ty;
103
Mike Stump3899a7f2009-06-05 23:26:36 +0000104 std::map<uint64_t, llvm::Constant *> AssignCache;
105 std::map<uint64_t, llvm::Constant *> DestroyCache;
106
Mike Stump90a90432009-03-04 18:47:42 +0000107 BlockModule(ASTContext &C, llvm::Module &M, const llvm::TargetData &TD,
108 CodeGenTypes &T, CodeGenModule &CodeGen)
109 : Context(C), TheModule(M), TheTargetData(TD), Types(T),
Owen Andersona1cf15f2009-07-14 23:10:40 +0000110 CGM(CodeGen), VMContext(M.getContext()),
Mike Stump90a90432009-03-04 18:47:42 +0000111 NSConcreteGlobalBlock(0), NSConcreteStackBlock(0), BlockDescriptorType(0),
Blaine Garstc0ea8852010-02-19 00:24:37 +0000112 GenericBlockLiteralType(0),
Mike Stump08920992009-03-07 02:35:30 +0000113 BlockObjectAssign(0), BlockObjectDispose(0) {
Mike Stump2a998142009-03-04 18:17:45 +0000114 Block.GlobalUniqueCount = 0;
Benjamin Kramer3c0ef8c2009-10-13 10:07:13 +0000115 PtrToInt8Ty = llvm::Type::getInt8PtrTy(M.getContext());
Mike Stump2a998142009-03-04 18:17:45 +0000116 }
Mike Stump39605b42009-09-22 02:12:52 +0000117
Mike Stumpbf5fd782009-10-21 18:23:01 +0000118 bool BlockRequiresCopying(QualType Ty)
119 { return getContext().BlockRequiresCopying(Ty); }
Mike Stumpd883d842009-03-04 15:35:22 +0000120};
121
122class BlockFunction : public BlockBase {
Mike Stump797b6322009-03-05 01:23:13 +0000123 CodeGenModule &CGM;
Mike Stump00470a12009-03-05 08:32:30 +0000124 ASTContext &getContext() const;
Mike Stump797b6322009-03-05 01:23:13 +0000125
Owen Andersona1cf15f2009-07-14 23:10:40 +0000126protected:
127 llvm::LLVMContext &VMContext;
128
Mike Stumpd883d842009-03-04 15:35:22 +0000129public:
Chris Lattner77b89b82010-06-27 07:15:29 +0000130 CodeGenFunction &CGF;
131
John McCall3d3ec1c2010-04-21 10:05:39 +0000132 const llvm::PointerType *PtrToInt8Ty;
Mike Stump08920992009-03-07 02:35:30 +0000133 struct HelperInfo {
134 int index;
135 int flag;
136 bool RequiresCopying;
137 };
138
Mike Stump797b6322009-03-05 01:23:13 +0000139 enum {
Mike Stumpd883d842009-03-04 15:35:22 +0000140 BLOCK_FIELD_IS_OBJECT = 3, /* id, NSObject, __attribute__((NSObject)),
141 block, ... */
142 BLOCK_FIELD_IS_BLOCK = 7, /* a block variable */
143 BLOCK_FIELD_IS_BYREF = 8, /* the on stack structure holding the __block
144 variable */
145 BLOCK_FIELD_IS_WEAK = 16, /* declared __weak, only used in byref copy
146 helpers */
Mike Stump3899a7f2009-06-05 23:26:36 +0000147 BLOCK_BYREF_CALLER = 128, /* called from __block (byref) copy/dispose
Mike Stumpd883d842009-03-04 15:35:22 +0000148 support routines */
Mike Stump3899a7f2009-06-05 23:26:36 +0000149 BLOCK_BYREF_CURRENT_MAX = 256
Mike Stumpd883d842009-03-04 15:35:22 +0000150 };
Mike Stump3947de52009-03-04 18:57:26 +0000151
152 CGBuilderTy &Builder;
153
Mike Stump08920992009-03-07 02:35:30 +0000154 BlockFunction(CodeGenModule &cgm, CodeGenFunction &cgf, CGBuilderTy &B);
155
156 /// BlockOffset - The offset in bytes for the next allocation of an
157 /// imported block variable.
Ken Dyck199c3d62010-01-11 17:06:35 +0000158 CharUnits BlockOffset;
Ken Dyck30a8a272010-01-26 19:13:33 +0000159 /// BlockAlign - Maximal alignment needed for the Block expressed in
160 /// characters.
161 CharUnits BlockAlign;
Mike Stump08920992009-03-07 02:35:30 +0000162
John McCallea1471e2010-05-20 01:18:31 +0000163 /// getBlockOffset - Allocate a location within the block's storage
164 /// for a value with the given size and alignment requirements.
165 CharUnits getBlockOffset(CharUnits Size, CharUnits Align);
Mike Stump08920992009-03-07 02:35:30 +0000166
167 /// BlockHasCopyDispose - True iff the block uses copy/dispose.
168 bool BlockHasCopyDispose;
169
John McCallea1471e2010-05-20 01:18:31 +0000170 /// BlockLayout - The layout of the block's storage, represented as
171 /// a sequence of expressions which require such storage. The
172 /// expressions can be:
173 /// - a BlockDeclRefExpr, indicating that the given declaration
174 /// from an enclosing scope is needed by the block;
175 /// - a DeclRefExpr, which always wraps an anonymous VarDecl with
176 /// array type, used to insert padding into the block; or
177 /// - a CXXThisExpr, indicating that the C++ 'this' value should
178 /// propagate from the parent to the block.
179 /// This is a really silly representation.
180 llvm::SmallVector<const Expr *, 8> BlockLayout;
Mike Stump08920992009-03-07 02:35:30 +0000181
182 /// BlockDecls - Offsets for all Decls in BlockDeclRefExprs.
John McCallea1471e2010-05-20 01:18:31 +0000183 llvm::DenseMap<const Decl*, CharUnits> BlockDecls;
Fariborz Jahaniandf8b8ea2010-06-04 16:10:00 +0000184
John McCallea1471e2010-05-20 01:18:31 +0000185 /// BlockCXXThisOffset - The offset of the C++ 'this' value within
186 /// the block structure.
187 CharUnits BlockCXXThisOffset;
Mike Stump3947de52009-03-04 18:57:26 +0000188
Mike Stumpad75ab42009-03-04 19:03:44 +0000189 ImplicitParamDecl *BlockStructDecl;
190 ImplicitParamDecl *getBlockStructDecl() { return BlockStructDecl; }
191
Mike Stump08920992009-03-07 02:35:30 +0000192 llvm::Constant *GenerateCopyHelperFunction(bool, const llvm::StructType *,
Mike Stumpb7477cf2009-04-10 18:52:28 +0000193 std::vector<HelperInfo> *);
Mike Stump08920992009-03-07 02:35:30 +0000194 llvm::Constant *GenerateDestroyHelperFunction(bool, const llvm::StructType *,
Mike Stumpb7477cf2009-04-10 18:52:28 +0000195 std::vector<HelperInfo> *);
Mike Stumpa4f668f2009-03-06 01:33:24 +0000196
Mike Stump08920992009-03-07 02:35:30 +0000197 llvm::Constant *BuildCopyHelper(const llvm::StructType *,
Mike Stumpb7477cf2009-04-10 18:52:28 +0000198 std::vector<HelperInfo> *);
Mike Stump08920992009-03-07 02:35:30 +0000199 llvm::Constant *BuildDestroyHelper(const llvm::StructType *,
Mike Stumpb7477cf2009-04-10 18:52:28 +0000200 std::vector<HelperInfo> *);
Mike Stump45031c02009-03-06 02:29:21 +0000201
Mike Stumpee094222009-03-06 06:12:24 +0000202 llvm::Constant *GeneratebyrefCopyHelperFunction(const llvm::Type *, int flag);
Mike Stump1851b682009-03-06 04:53:30 +0000203 llvm::Constant *GeneratebyrefDestroyHelperFunction(const llvm::Type *T, int);
Mike Stump45031c02009-03-06 02:29:21 +0000204
Mike Stump3899a7f2009-06-05 23:26:36 +0000205 llvm::Constant *BuildbyrefCopyHelper(const llvm::Type *T, int flag,
206 unsigned Align);
207 llvm::Constant *BuildbyrefDestroyHelper(const llvm::Type *T, int flag,
208 unsigned Align);
Mike Stump3947de52009-03-04 18:57:26 +0000209
Mike Stumpee094222009-03-06 06:12:24 +0000210 llvm::Value *getBlockObjectAssign();
Mike Stump797b6322009-03-05 01:23:13 +0000211 llvm::Value *getBlockObjectDispose();
Mike Stump1851b682009-03-06 04:53:30 +0000212 void BuildBlockRelease(llvm::Value *DeclPtr, int flag = BLOCK_FIELD_IS_BYREF);
Mike Stump00470a12009-03-05 08:32:30 +0000213
Mike Stumpbf5fd782009-10-21 18:23:01 +0000214 bool BlockRequiresCopying(QualType Ty)
215 { return getContext().BlockRequiresCopying(Ty); }
Mike Stumpd883d842009-03-04 15:35:22 +0000216};
217
218} // end namespace CodeGen
219} // end namespace clang
220
221#endif