blob: 09d1cebcefa35da00549261692c6cfbbe1e9de3f [file] [log] [blame]
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001//===------- CGObjCMac.cpp - Interface to Apple Objective-C Runtime -------===//
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//
Chris Lattnerfc8f0e12011-04-15 05:22:18 +000010// This provides Objective-C code generation targeting the Apple runtime.
Daniel Dunbarc17a4d32008-08-11 02:45:11 +000011//
12//===----------------------------------------------------------------------===//
13
14#include "CGObjCRuntime.h"
John McCalld16c2cf2011-02-08 08:22:06 +000015#include "CGBlocks.h"
John McCall36f893c2011-01-28 11:13:47 +000016#include "CGCleanup.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000017#include "CGRecordLayout.h"
18#include "CodeGenFunction.h"
19#include "CodeGenModule.h"
Daniel Dunbarbbce49b2008-08-12 00:12:39 +000020#include "clang/AST/ASTContext.h"
Daniel Dunbare91593e2008-08-11 04:54:23 +000021#include "clang/AST/Decl.h"
Daniel Dunbar6efc0c52008-08-13 03:21:16 +000022#include "clang/AST/DeclObjC.h"
Anders Carlsson19cc4ab2009-07-18 19:43:29 +000023#include "clang/AST/RecordLayout.h"
Chris Lattner16f00492009-04-26 01:32:48 +000024#include "clang/AST/StmtObjC.h"
Daniel Dunbarf77ac862008-08-11 21:35:06 +000025#include "clang/Basic/LangOptions.h"
Mark Lacey8b549992013-10-30 21:53:58 +000026#include "clang/CodeGen/CGFunctionInfo.h"
Chandler Carruth06057ce2010-06-15 23:19:56 +000027#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth55fc8732012-12-04 09:13:33 +000028#include "llvm/ADT/DenseSet.h"
29#include "llvm/ADT/SetVector.h"
30#include "llvm/ADT/SmallPtrSet.h"
31#include "llvm/ADT/SmallString.h"
Stephen Hines651f13c2014-04-23 16:59:28 -070032#include "llvm/IR/CallSite.h"
Chandler Carruth3b844ba2013-01-02 11:45:17 +000033#include "llvm/IR/DataLayout.h"
34#include "llvm/IR/InlineAsm.h"
35#include "llvm/IR/IntrinsicInst.h"
36#include "llvm/IR/LLVMContext.h"
37#include "llvm/IR/Module.h"
Daniel Dunbar33063492009-09-07 00:20:42 +000038#include "llvm/Support/raw_ostream.h"
Torok Edwinf42e4a62009-08-24 13:25:12 +000039#include <cstdio>
Daniel Dunbarc17a4d32008-08-11 02:45:11 +000040
41using namespace clang;
Daniel Dunbar46f45b92008-09-09 01:06:48 +000042using namespace CodeGen;
Daniel Dunbarc17a4d32008-08-11 02:45:11 +000043
44namespace {
Daniel Dunbarbbce49b2008-08-12 00:12:39 +000045
Daniel Dunbar6bff2512009-08-03 17:06:42 +000046// FIXME: We should find a nicer way to make the labels for metadata, string
47// concatenation is lame.
Daniel Dunbar6efc0c52008-08-13 03:21:16 +000048
Fariborz Jahanianee0af742009-01-21 22:04:16 +000049class ObjCCommonTypesHelper {
Owen Andersona1cf15f2009-07-14 23:10:40 +000050protected:
51 llvm::LLVMContext &VMContext;
Daniel Dunbar6bff2512009-08-03 17:06:42 +000052
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +000053private:
John McCall0774cb82011-05-15 01:53:33 +000054 // The types of these functions don't really matter because we
55 // should always bitcast before calling them.
56
57 /// id objc_msgSend (id, SEL, ...)
58 ///
59 /// The default messenger, used for sends whose ABI is unchanged from
60 /// the all-integer/pointer case.
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +000061 llvm::Constant *getMessageSendFn() const {
John McCallf85e1932011-06-15 23:02:42 +000062 // Add the non-lazy-bind attribute, since objc_msgSend is likely to
63 // be called a lot.
Chris Lattner9cbe4f02011-07-09 17:41:47 +000064 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
Bill Wendlingc4c62fd2013-01-31 00:30:05 +000065 return
66 CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
67 params, true),
68 "objc_msgSend",
69 llvm::AttributeSet::get(CGM.getLLVMContext(),
70 llvm::AttributeSet::FunctionIndex,
71 llvm::Attribute::NonLazyBind));
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +000072 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +000073
John McCall0774cb82011-05-15 01:53:33 +000074 /// void objc_msgSend_stret (id, SEL, ...)
75 ///
76 /// The messenger used when the return value is an aggregate returned
77 /// by indirect reference in the first argument, and therefore the
78 /// self and selector parameters are shifted over by one.
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +000079 llvm::Constant *getMessageSendStretFn() const {
Chris Lattner9cbe4f02011-07-09 17:41:47 +000080 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall0774cb82011-05-15 01:53:33 +000081 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy,
82 params, true),
83 "objc_msgSend_stret");
Daniel Dunbar6bff2512009-08-03 17:06:42 +000084
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +000085 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +000086
John McCall0774cb82011-05-15 01:53:33 +000087 /// [double | long double] objc_msgSend_fpret(id self, SEL op, ...)
88 ///
89 /// The messenger used when the return value is returned on the x87
90 /// floating-point stack; without a special entrypoint, the nil case
91 /// would be unbalanced.
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +000092 llvm::Constant *getMessageSendFpretFn() const {
Chris Lattner9cbe4f02011-07-09 17:41:47 +000093 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
Chris Lattner8b418682012-02-07 00:39:47 +000094 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.DoubleTy,
95 params, true),
John McCall0774cb82011-05-15 01:53:33 +000096 "objc_msgSend_fpret");
Daniel Dunbar6bff2512009-08-03 17:06:42 +000097
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +000098 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +000099
Anders Carlssoneea64802011-10-31 16:27:11 +0000100 /// _Complex long double objc_msgSend_fp2ret(id self, SEL op, ...)
101 ///
102 /// The messenger used when the return value is returned in two values on the
103 /// x87 floating point stack; without a special entrypoint, the nil case
104 /// would be unbalanced. Only used on 64-bit X86.
105 llvm::Constant *getMessageSendFp2retFn() const {
106 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
107 llvm::Type *longDoubleType = llvm::Type::getX86_FP80Ty(VMContext);
108 llvm::Type *resultType =
Stephen Hines0e2c34f2015-03-23 12:09:02 -0700109 llvm::StructType::get(longDoubleType, longDoubleType, nullptr);
Anders Carlssoneea64802011-10-31 16:27:11 +0000110
111 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(resultType,
112 params, true),
113 "objc_msgSend_fp2ret");
114 }
115
John McCall0774cb82011-05-15 01:53:33 +0000116 /// id objc_msgSendSuper(struct objc_super *super, SEL op, ...)
117 ///
118 /// The messenger used for super calls, which have different dispatch
119 /// semantics. The class passed is the superclass of the current
120 /// class.
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000121 llvm::Constant *getMessageSendSuperFn() const {
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000122 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson96e0fc72009-07-29 22:16:19 +0000123 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall0774cb82011-05-15 01:53:33 +0000124 params, true),
125 "objc_msgSendSuper");
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000126 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000127
John McCall0774cb82011-05-15 01:53:33 +0000128 /// id objc_msgSendSuper2(struct objc_super *super, SEL op, ...)
129 ///
130 /// A slightly different messenger used for super calls. The class
131 /// passed is the current class.
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000132 llvm::Constant *getMessageSendSuperFn2() const {
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000133 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson96e0fc72009-07-29 22:16:19 +0000134 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall0774cb82011-05-15 01:53:33 +0000135 params, true),
136 "objc_msgSendSuper2");
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000137 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000138
John McCall0774cb82011-05-15 01:53:33 +0000139 /// void objc_msgSendSuper_stret(void *stretAddr, struct objc_super *super,
140 /// SEL op, ...)
141 ///
142 /// The messenger used for super calls which return an aggregate indirectly.
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000143 llvm::Constant *getMessageSendSuperStretFn() const {
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000144 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Andersona1cf15f2009-07-14 23:10:40 +0000145 return CGM.CreateRuntimeFunction(
John McCall0774cb82011-05-15 01:53:33 +0000146 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000147 "objc_msgSendSuper_stret");
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000148 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000149
John McCall0774cb82011-05-15 01:53:33 +0000150 /// void objc_msgSendSuper2_stret(void * stretAddr, struct objc_super *super,
151 /// SEL op, ...)
152 ///
153 /// objc_msgSendSuper_stret with the super2 semantics.
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000154 llvm::Constant *getMessageSendSuperStretFn2() const {
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000155 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Andersona1cf15f2009-07-14 23:10:40 +0000156 return CGM.CreateRuntimeFunction(
John McCall0774cb82011-05-15 01:53:33 +0000157 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000158 "objc_msgSendSuper2_stret");
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000159 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000160
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000161 llvm::Constant *getMessageSendSuperFpretFn() const {
162 // There is no objc_msgSendSuper_fpret? How can that work?
163 return getMessageSendSuperFn();
164 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000165
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000166 llvm::Constant *getMessageSendSuperFpretFn2() const {
167 // There is no objc_msgSendSuper_fpret? How can that work?
168 return getMessageSendSuperFn2();
169 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000170
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000171protected:
172 CodeGen::CodeGenModule &CGM;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000173
Daniel Dunbarbbce49b2008-08-12 00:12:39 +0000174public:
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000175 llvm::Type *ShortTy, *IntTy, *LongTy, *LongLongTy;
Bob Wilsondc8dab62011-11-30 01:57:58 +0000176 llvm::Type *Int8PtrTy, *Int8PtrPtrTy;
Stephen Hines651f13c2014-04-23 16:59:28 -0700177 llvm::Type *IvarOffsetVarTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000178
Daniel Dunbar2bedbf82008-08-12 05:28:47 +0000179 /// ObjectPtrTy - LLVM type for object handles (typeof(id))
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000180 llvm::Type *ObjectPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000181
Fariborz Jahanian6d657c42008-11-18 20:18:11 +0000182 /// PtrObjectPtrTy - LLVM type for id *
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000183 llvm::Type *PtrObjectPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000184
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +0000185 /// SelectorPtrTy - LLVM type for selector handles (typeof(SEL))
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000186 llvm::Type *SelectorPtrTy;
Douglas Gregor4c86fdb2012-01-17 18:36:30 +0000187
188private:
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000189 /// ProtocolPtrTy - LLVM type for external protocol handles
190 /// (typeof(Protocol))
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000191 llvm::Type *ExternalProtocolPtrTy;
Douglas Gregor4c86fdb2012-01-17 18:36:30 +0000192
193public:
194 llvm::Type *getExternalProtocolPtrTy() {
195 if (!ExternalProtocolPtrTy) {
196 // FIXME: It would be nice to unify this with the opaque type, so that the
197 // IR comes out a bit cleaner.
198 CodeGen::CodeGenTypes &Types = CGM.getTypes();
199 ASTContext &Ctx = CGM.getContext();
200 llvm::Type *T = Types.ConvertType(Ctx.getObjCProtoType());
201 ExternalProtocolPtrTy = llvm::PointerType::getUnqual(T);
202 }
203
204 return ExternalProtocolPtrTy;
205 }
206
Daniel Dunbar19cd87e2008-08-30 03:02:31 +0000207 // SuperCTy - clang type for struct objc_super.
208 QualType SuperCTy;
209 // SuperPtrCTy - clang type for struct objc_super *.
210 QualType SuperPtrCTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000211
Daniel Dunbare8b470d2008-08-23 04:28:29 +0000212 /// SuperTy - LLVM type for struct objc_super.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000213 llvm::StructType *SuperTy;
Daniel Dunbar14c80b72008-08-23 09:25:55 +0000214 /// SuperPtrTy - LLVM type for struct objc_super *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000215 llvm::Type *SuperPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000216
Fariborz Jahanian30bc5712009-01-22 23:02:58 +0000217 /// PropertyTy - LLVM type for struct objc_property (struct _prop_t
218 /// in GCC parlance).
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000219 llvm::StructType *PropertyTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000220
Fariborz Jahanian30bc5712009-01-22 23:02:58 +0000221 /// PropertyListTy - LLVM type for struct objc_property_list
222 /// (_prop_list_t in GCC parlance).
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000223 llvm::StructType *PropertyListTy;
Fariborz Jahanian30bc5712009-01-22 23:02:58 +0000224 /// PropertyListPtrTy - LLVM type for struct objc_property_list*.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000225 llvm::Type *PropertyListPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000226
Fariborz Jahanian30bc5712009-01-22 23:02:58 +0000227 // MethodTy - LLVM type for struct objc_method.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000228 llvm::StructType *MethodTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000229
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000230 /// CacheTy - LLVM type for struct objc_cache.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000231 llvm::Type *CacheTy;
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000232 /// CachePtrTy - LLVM type for struct objc_cache *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000233 llvm::Type *CachePtrTy;
Fariborz Jahanian9d96bce2011-06-22 20:21:51 +0000234
Chris Lattner72db6c32009-04-22 02:44:54 +0000235 llvm::Constant *getGetPropertyFn() {
236 CodeGen::CodeGenTypes &Types = CGM.getTypes();
237 ASTContext &Ctx = CGM.getContext();
238 // id objc_getProperty (id, SEL, ptrdiff_t, bool)
John McCallead608a2010-02-26 00:48:12 +0000239 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
240 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700241 CanQualType Params[] = {
242 IdType, SelType,
243 Ctx.getPointerDiffType()->getCanonicalTypeUnqualified(), Ctx.BoolTy};
Chris Lattner2acc6e32011-07-18 04:24:23 +0000244 llvm::FunctionType *FTy =
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700245 Types.GetFunctionType(
246 Types.arrangeBuiltinFunctionDeclaration(IdType, Params));
Chris Lattner72db6c32009-04-22 02:44:54 +0000247 return CGM.CreateRuntimeFunction(FTy, "objc_getProperty");
248 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000249
Chris Lattner72db6c32009-04-22 02:44:54 +0000250 llvm::Constant *getSetPropertyFn() {
251 CodeGen::CodeGenTypes &Types = CGM.getTypes();
252 ASTContext &Ctx = CGM.getContext();
253 // void objc_setProperty (id, SEL, ptrdiff_t, id, bool, bool)
John McCallead608a2010-02-26 00:48:12 +0000254 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
255 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700256 CanQualType Params[] = {
257 IdType,
258 SelType,
259 Ctx.getPointerDiffType()->getCanonicalTypeUnqualified(),
260 IdType,
261 Ctx.BoolTy,
262 Ctx.BoolTy};
Chris Lattner2acc6e32011-07-18 04:24:23 +0000263 llvm::FunctionType *FTy =
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700264 Types.GetFunctionType(
265 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Chris Lattner72db6c32009-04-22 02:44:54 +0000266 return CGM.CreateRuntimeFunction(FTy, "objc_setProperty");
267 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000268
Ted Kremenekebcb57a2012-03-06 20:05:56 +0000269 llvm::Constant *getOptimizedSetPropertyFn(bool atomic, bool copy) {
270 CodeGen::CodeGenTypes &Types = CGM.getTypes();
271 ASTContext &Ctx = CGM.getContext();
272 // void objc_setProperty_atomic(id self, SEL _cmd,
273 // id newValue, ptrdiff_t offset);
274 // void objc_setProperty_nonatomic(id self, SEL _cmd,
275 // id newValue, ptrdiff_t offset);
276 // void objc_setProperty_atomic_copy(id self, SEL _cmd,
277 // id newValue, ptrdiff_t offset);
278 // void objc_setProperty_nonatomic_copy(id self, SEL _cmd,
279 // id newValue, ptrdiff_t offset);
280
281 SmallVector<CanQualType,4> Params;
282 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
283 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
284 Params.push_back(IdType);
285 Params.push_back(SelType);
286 Params.push_back(IdType);
287 Params.push_back(Ctx.getPointerDiffType()->getCanonicalTypeUnqualified());
288 llvm::FunctionType *FTy =
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700289 Types.GetFunctionType(
290 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Ted Kremenekebcb57a2012-03-06 20:05:56 +0000291 const char *name;
292 if (atomic && copy)
293 name = "objc_setProperty_atomic_copy";
294 else if (atomic && !copy)
295 name = "objc_setProperty_atomic";
296 else if (!atomic && copy)
297 name = "objc_setProperty_nonatomic_copy";
298 else
299 name = "objc_setProperty_nonatomic";
300
301 return CGM.CreateRuntimeFunction(FTy, name);
302 }
Fariborz Jahanian6cc59062010-04-12 18:18:10 +0000303
304 llvm::Constant *getCopyStructFn() {
305 CodeGen::CodeGenTypes &Types = CGM.getTypes();
306 ASTContext &Ctx = CGM.getContext();
307 // void objc_copyStruct (void *, const void *, size_t, bool, bool)
Chris Lattner5f9e2722011-07-23 10:55:15 +0000308 SmallVector<CanQualType,5> Params;
Fariborz Jahanian6cc59062010-04-12 18:18:10 +0000309 Params.push_back(Ctx.VoidPtrTy);
310 Params.push_back(Ctx.VoidPtrTy);
311 Params.push_back(Ctx.LongTy);
312 Params.push_back(Ctx.BoolTy);
313 Params.push_back(Ctx.BoolTy);
Chris Lattner2acc6e32011-07-18 04:24:23 +0000314 llvm::FunctionType *FTy =
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700315 Types.GetFunctionType(
316 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahanian6cc59062010-04-12 18:18:10 +0000317 return CGM.CreateRuntimeFunction(FTy, "objc_copyStruct");
318 }
319
Fariborz Jahaniane3173022012-01-06 18:07:23 +0000320 /// This routine declares and returns address of:
321 /// void objc_copyCppObjectAtomic(
322 /// void *dest, const void *src,
323 /// void (*copyHelper) (void *dest, const void *source));
324 llvm::Constant *getCppAtomicObjectFunction() {
325 CodeGen::CodeGenTypes &Types = CGM.getTypes();
326 ASTContext &Ctx = CGM.getContext();
327 /// void objc_copyCppObjectAtomic(void *dest, const void *src, void *helper);
328 SmallVector<CanQualType,3> Params;
329 Params.push_back(Ctx.VoidPtrTy);
330 Params.push_back(Ctx.VoidPtrTy);
331 Params.push_back(Ctx.VoidPtrTy);
332 llvm::FunctionType *FTy =
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700333 Types.GetFunctionType(
334 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahaniane3173022012-01-06 18:07:23 +0000335 return CGM.CreateRuntimeFunction(FTy, "objc_copyCppObjectAtomic");
336 }
337
Chris Lattner72db6c32009-04-22 02:44:54 +0000338 llvm::Constant *getEnumerationMutationFn() {
Daniel Dunbarc1ab9002009-07-11 20:32:50 +0000339 CodeGen::CodeGenTypes &Types = CGM.getTypes();
340 ASTContext &Ctx = CGM.getContext();
Chris Lattner72db6c32009-04-22 02:44:54 +0000341 // void objc_enumerationMutation (id)
Chris Lattner5f9e2722011-07-23 10:55:15 +0000342 SmallVector<CanQualType,1> Params;
John McCallead608a2010-02-26 00:48:12 +0000343 Params.push_back(Ctx.getCanonicalParamType(Ctx.getObjCIdType()));
Chris Lattner2acc6e32011-07-18 04:24:23 +0000344 llvm::FunctionType *FTy =
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700345 Types.GetFunctionType(
346 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Chris Lattner72db6c32009-04-22 02:44:54 +0000347 return CGM.CreateRuntimeFunction(FTy, "objc_enumerationMutation");
348 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000349
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700350 llvm::Constant *getLookUpClassFn() {
351 CodeGen::CodeGenTypes &Types = CGM.getTypes();
352 ASTContext &Ctx = CGM.getContext();
353 // Class objc_lookUpClass (const char *)
354 SmallVector<CanQualType,1> Params;
355 Params.push_back(
356 Ctx.getCanonicalType(Ctx.getPointerType(Ctx.CharTy.withConst())));
357 llvm::FunctionType *FTy =
358 Types.GetFunctionType(Types.arrangeBuiltinFunctionDeclaration(
359 Ctx.getCanonicalType(Ctx.getObjCClassType()),
360 Params));
361 return CGM.CreateRuntimeFunction(FTy, "objc_lookUpClass");
362 }
363
Fariborz Jahaniandb286862009-01-22 00:37:21 +0000364 /// GcReadWeakFn -- LLVM objc_read_weak (id *src) function.
Chris Lattner72db6c32009-04-22 02:44:54 +0000365 llvm::Constant *getGcReadWeakFn() {
366 // id objc_read_weak (id *)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000367 llvm::Type *args[] = { ObjectPtrTy->getPointerTo() };
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000368 llvm::FunctionType *FTy =
John McCall0774cb82011-05-15 01:53:33 +0000369 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner72db6c32009-04-22 02:44:54 +0000370 return CGM.CreateRuntimeFunction(FTy, "objc_read_weak");
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000371 }
372
Fariborz Jahaniandb286862009-01-22 00:37:21 +0000373 /// GcAssignWeakFn -- LLVM objc_assign_weak function.
Chris Lattner96508e12009-04-17 22:12:36 +0000374 llvm::Constant *getGcAssignWeakFn() {
375 // id objc_assign_weak (id, id *)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000376 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Chris Lattner96508e12009-04-17 22:12:36 +0000377 llvm::FunctionType *FTy =
John McCall0774cb82011-05-15 01:53:33 +0000378 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner96508e12009-04-17 22:12:36 +0000379 return CGM.CreateRuntimeFunction(FTy, "objc_assign_weak");
380 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000381
Fariborz Jahaniandb286862009-01-22 00:37:21 +0000382 /// GcAssignGlobalFn -- LLVM objc_assign_global function.
Chris Lattnerbbccd612009-04-22 02:38:11 +0000383 llvm::Constant *getGcAssignGlobalFn() {
384 // id objc_assign_global(id, id *)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000385 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Andersona1cf15f2009-07-14 23:10:40 +0000386 llvm::FunctionType *FTy =
John McCall0774cb82011-05-15 01:53:33 +0000387 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattnerbbccd612009-04-22 02:38:11 +0000388 return CGM.CreateRuntimeFunction(FTy, "objc_assign_global");
389 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000390
Fariborz Jahanian021a7a62010-07-20 20:30:03 +0000391 /// GcAssignThreadLocalFn -- LLVM objc_assign_threadlocal function.
392 llvm::Constant *getGcAssignThreadLocalFn() {
393 // id objc_assign_threadlocal(id src, id * dest)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000394 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Fariborz Jahanian021a7a62010-07-20 20:30:03 +0000395 llvm::FunctionType *FTy =
John McCall0774cb82011-05-15 01:53:33 +0000396 llvm::FunctionType::get(ObjectPtrTy, args, false);
Fariborz Jahanian021a7a62010-07-20 20:30:03 +0000397 return CGM.CreateRuntimeFunction(FTy, "objc_assign_threadlocal");
398 }
399
Fariborz Jahaniandb286862009-01-22 00:37:21 +0000400 /// GcAssignIvarFn -- LLVM objc_assign_ivar function.
Chris Lattnerbbccd612009-04-22 02:38:11 +0000401 llvm::Constant *getGcAssignIvarFn() {
Fariborz Jahanian6c7a1f32009-09-24 22:25:38 +0000402 // id objc_assign_ivar(id, id *, ptrdiff_t)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000403 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo(),
404 CGM.PtrDiffTy };
Owen Andersona1cf15f2009-07-14 23:10:40 +0000405 llvm::FunctionType *FTy =
John McCall0774cb82011-05-15 01:53:33 +0000406 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattnerbbccd612009-04-22 02:38:11 +0000407 return CGM.CreateRuntimeFunction(FTy, "objc_assign_ivar");
408 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000409
Fariborz Jahanian082b02e2009-07-08 01:18:33 +0000410 /// GcMemmoveCollectableFn -- LLVM objc_memmove_collectable function.
411 llvm::Constant *GcMemmoveCollectableFn() {
412 // void *objc_memmove_collectable(void *dst, const void *src, size_t size)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000413 llvm::Type *args[] = { Int8PtrTy, Int8PtrTy, LongTy };
John McCall0774cb82011-05-15 01:53:33 +0000414 llvm::FunctionType *FTy = llvm::FunctionType::get(Int8PtrTy, args, false);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +0000415 return CGM.CreateRuntimeFunction(FTy, "objc_memmove_collectable");
416 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000417
Fariborz Jahaniandb286862009-01-22 00:37:21 +0000418 /// GcAssignStrongCastFn -- LLVM objc_assign_strongCast function.
Chris Lattnerbbccd612009-04-22 02:38:11 +0000419 llvm::Constant *getGcAssignStrongCastFn() {
Fariborz Jahanian021a7a62010-07-20 20:30:03 +0000420 // id objc_assign_strongCast(id, id *)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000421 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Andersona1cf15f2009-07-14 23:10:40 +0000422 llvm::FunctionType *FTy =
John McCall0774cb82011-05-15 01:53:33 +0000423 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattnerbbccd612009-04-22 02:38:11 +0000424 return CGM.CreateRuntimeFunction(FTy, "objc_assign_strongCast");
425 }
Anders Carlssonf57c5b22009-02-16 22:59:18 +0000426
427 /// ExceptionThrowFn - LLVM objc_exception_throw function.
Chris Lattnerbbccd612009-04-22 02:38:11 +0000428 llvm::Constant *getExceptionThrowFn() {
429 // void objc_exception_throw(id)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000430 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattnerbbccd612009-04-22 02:38:11 +0000431 llvm::FunctionType *FTy =
John McCall0774cb82011-05-15 01:53:33 +0000432 llvm::FunctionType::get(CGM.VoidTy, args, false);
Chris Lattnerbbccd612009-04-22 02:38:11 +0000433 return CGM.CreateRuntimeFunction(FTy, "objc_exception_throw");
434 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000435
Fariborz Jahanian69677ea2010-05-28 17:34:43 +0000436 /// ExceptionRethrowFn - LLVM objc_exception_rethrow function.
437 llvm::Constant *getExceptionRethrowFn() {
438 // void objc_exception_rethrow(void)
John McCall0774cb82011-05-15 01:53:33 +0000439 llvm::FunctionType *FTy = llvm::FunctionType::get(CGM.VoidTy, false);
Fariborz Jahanian69677ea2010-05-28 17:34:43 +0000440 return CGM.CreateRuntimeFunction(FTy, "objc_exception_rethrow");
441 }
442
Daniel Dunbar1c566672009-02-24 01:43:46 +0000443 /// SyncEnterFn - LLVM object_sync_enter function.
Chris Lattnerb02e53b2009-04-06 16:53:45 +0000444 llvm::Constant *getSyncEnterFn() {
Aaron Ballman2d234d732012-09-06 16:44:16 +0000445 // int objc_sync_enter (id)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000446 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattnerb02e53b2009-04-06 16:53:45 +0000447 llvm::FunctionType *FTy =
Aaron Ballman2d234d732012-09-06 16:44:16 +0000448 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattnerb02e53b2009-04-06 16:53:45 +0000449 return CGM.CreateRuntimeFunction(FTy, "objc_sync_enter");
450 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000451
Daniel Dunbar1c566672009-02-24 01:43:46 +0000452 /// SyncExitFn - LLVM object_sync_exit function.
Chris Lattnerbbccd612009-04-22 02:38:11 +0000453 llvm::Constant *getSyncExitFn() {
Aaron Ballman2d234d732012-09-06 16:44:16 +0000454 // int objc_sync_exit (id)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000455 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattnerbbccd612009-04-22 02:38:11 +0000456 llvm::FunctionType *FTy =
Aaron Ballman2d234d732012-09-06 16:44:16 +0000457 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattnerbbccd612009-04-22 02:38:11 +0000458 return CGM.CreateRuntimeFunction(FTy, "objc_sync_exit");
459 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000460
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000461 llvm::Constant *getSendFn(bool IsSuper) const {
462 return IsSuper ? getMessageSendSuperFn() : getMessageSendFn();
463 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000464
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000465 llvm::Constant *getSendFn2(bool IsSuper) const {
466 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFn();
467 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000468
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000469 llvm::Constant *getSendStretFn(bool IsSuper) const {
470 return IsSuper ? getMessageSendSuperStretFn() : getMessageSendStretFn();
471 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000472
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000473 llvm::Constant *getSendStretFn2(bool IsSuper) const {
474 return IsSuper ? getMessageSendSuperStretFn2() : getMessageSendStretFn();
475 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000476
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000477 llvm::Constant *getSendFpretFn(bool IsSuper) const {
478 return IsSuper ? getMessageSendSuperFpretFn() : getMessageSendFpretFn();
479 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000480
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +0000481 llvm::Constant *getSendFpretFn2(bool IsSuper) const {
482 return IsSuper ? getMessageSendSuperFpretFn2() : getMessageSendFpretFn();
483 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000484
Anders Carlssoneea64802011-10-31 16:27:11 +0000485 llvm::Constant *getSendFp2retFn(bool IsSuper) const {
486 return IsSuper ? getMessageSendSuperFn() : getMessageSendFp2retFn();
487 }
488
489 llvm::Constant *getSendFp2RetFn2(bool IsSuper) const {
490 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFp2retFn();
491 }
492
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000493 ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000494};
Daniel Dunbare8b470d2008-08-23 04:28:29 +0000495
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000496/// ObjCTypesHelper - Helper class that encapsulates lazy
497/// construction of varies types used during ObjC generation.
498class ObjCTypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000499public:
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +0000500 /// SymtabTy - LLVM type for struct objc_symtab.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000501 llvm::StructType *SymtabTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000502 /// SymtabPtrTy - LLVM type for struct objc_symtab *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000503 llvm::Type *SymtabPtrTy;
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +0000504 /// ModuleTy - LLVM type for struct objc_module.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000505 llvm::StructType *ModuleTy;
Daniel Dunbar259d93d2008-08-12 03:39:23 +0000506
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000507 /// ProtocolTy - LLVM type for struct objc_protocol.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000508 llvm::StructType *ProtocolTy;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000509 /// ProtocolPtrTy - LLVM type for struct objc_protocol *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000510 llvm::Type *ProtocolPtrTy;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000511 /// ProtocolExtensionTy - LLVM type for struct
512 /// objc_protocol_extension.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000513 llvm::StructType *ProtocolExtensionTy;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000514 /// ProtocolExtensionTy - LLVM type for struct
515 /// objc_protocol_extension *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000516 llvm::Type *ProtocolExtensionPtrTy;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000517 /// MethodDescriptionTy - LLVM type for struct
518 /// objc_method_description.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000519 llvm::StructType *MethodDescriptionTy;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000520 /// MethodDescriptionListTy - LLVM type for struct
521 /// objc_method_description_list.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000522 llvm::StructType *MethodDescriptionListTy;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000523 /// MethodDescriptionListPtrTy - LLVM type for struct
524 /// objc_method_description_list *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000525 llvm::Type *MethodDescriptionListPtrTy;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000526 /// ProtocolListTy - LLVM type for struct objc_property_list.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000527 llvm::StructType *ProtocolListTy;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000528 /// ProtocolListPtrTy - LLVM type for struct objc_property_list*.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000529 llvm::Type *ProtocolListPtrTy;
Daniel Dunbar86e253a2008-08-22 20:34:54 +0000530 /// CategoryTy - LLVM type for struct objc_category.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000531 llvm::StructType *CategoryTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000532 /// ClassTy - LLVM type for struct objc_class.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000533 llvm::StructType *ClassTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000534 /// ClassPtrTy - LLVM type for struct objc_class *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000535 llvm::Type *ClassPtrTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000536 /// ClassExtensionTy - LLVM type for struct objc_class_ext.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000537 llvm::StructType *ClassExtensionTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000538 /// ClassExtensionPtrTy - LLVM type for struct objc_class_ext *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000539 llvm::Type *ClassExtensionPtrTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000540 // IvarTy - LLVM type for struct objc_ivar.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000541 llvm::StructType *IvarTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000542 /// IvarListTy - LLVM type for struct objc_ivar_list.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000543 llvm::Type *IvarListTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000544 /// IvarListPtrTy - LLVM type for struct objc_ivar_list *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000545 llvm::Type *IvarListPtrTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000546 /// MethodListTy - LLVM type for struct objc_method_list.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000547 llvm::Type *MethodListTy;
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000548 /// MethodListPtrTy - LLVM type for struct objc_method_list *.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000549 llvm::Type *MethodListPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000550
Anders Carlsson124526b2008-09-09 10:10:21 +0000551 /// ExceptionDataTy - LLVM type for struct _objc_exception_data.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000552 llvm::Type *ExceptionDataTy;
Fariborz Jahanian9d96bce2011-06-22 20:21:51 +0000553
Anders Carlsson124526b2008-09-09 10:10:21 +0000554 /// ExceptionTryEnterFn - LLVM objc_exception_try_enter function.
Chris Lattner34b02a12009-04-22 02:26:14 +0000555 llvm::Constant *getExceptionTryEnterFn() {
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000556 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Andersona1cf15f2009-07-14 23:10:40 +0000557 return CGM.CreateRuntimeFunction(
John McCall0774cb82011-05-15 01:53:33 +0000558 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000559 "objc_exception_try_enter");
Chris Lattner34b02a12009-04-22 02:26:14 +0000560 }
Anders Carlsson124526b2008-09-09 10:10:21 +0000561
562 /// ExceptionTryExitFn - LLVM objc_exception_try_exit function.
Chris Lattner34b02a12009-04-22 02:26:14 +0000563 llvm::Constant *getExceptionTryExitFn() {
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000564 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Andersona1cf15f2009-07-14 23:10:40 +0000565 return CGM.CreateRuntimeFunction(
John McCall0774cb82011-05-15 01:53:33 +0000566 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000567 "objc_exception_try_exit");
Chris Lattner34b02a12009-04-22 02:26:14 +0000568 }
Anders Carlsson124526b2008-09-09 10:10:21 +0000569
570 /// ExceptionExtractFn - LLVM objc_exception_extract function.
Chris Lattner34b02a12009-04-22 02:26:14 +0000571 llvm::Constant *getExceptionExtractFn() {
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000572 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson96e0fc72009-07-29 22:16:19 +0000573 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall0774cb82011-05-15 01:53:33 +0000574 params, false),
Chris Lattner34b02a12009-04-22 02:26:14 +0000575 "objc_exception_extract");
Chris Lattner34b02a12009-04-22 02:26:14 +0000576 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000577
Anders Carlsson124526b2008-09-09 10:10:21 +0000578 /// ExceptionMatchFn - LLVM objc_exception_match function.
Chris Lattner34b02a12009-04-22 02:26:14 +0000579 llvm::Constant *getExceptionMatchFn() {
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000580 llvm::Type *params[] = { ClassPtrTy, ObjectPtrTy };
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000581 return CGM.CreateRuntimeFunction(
John McCall0774cb82011-05-15 01:53:33 +0000582 llvm::FunctionType::get(CGM.Int32Ty, params, false),
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000583 "objc_exception_match");
Chris Lattner34b02a12009-04-22 02:26:14 +0000584 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000585
Anders Carlsson124526b2008-09-09 10:10:21 +0000586 /// SetJmpFn - LLVM _setjmp function.
Chris Lattner34b02a12009-04-22 02:26:14 +0000587 llvm::Constant *getSetJmpFn() {
John McCall0774cb82011-05-15 01:53:33 +0000588 // This is specifically the prototype for x86.
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000589 llvm::Type *params[] = { CGM.Int32Ty->getPointerTo() };
Bill Wendlingc4c62fd2013-01-31 00:30:05 +0000590 return
591 CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty,
592 params, false),
593 "_setjmp",
594 llvm::AttributeSet::get(CGM.getLLVMContext(),
595 llvm::AttributeSet::FunctionIndex,
596 llvm::Attribute::NonLazyBind));
Chris Lattner34b02a12009-04-22 02:26:14 +0000597 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000598
Daniel Dunbarbbce49b2008-08-12 00:12:39 +0000599public:
600 ObjCTypesHelper(CodeGen::CodeGenModule &cgm);
Daniel Dunbarbbce49b2008-08-12 00:12:39 +0000601};
602
Fariborz Jahanian30bc5712009-01-22 23:02:58 +0000603/// ObjCNonFragileABITypesHelper - will have all types needed by objective-c's
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000604/// modern abi
Fariborz Jahanian30bc5712009-01-22 23:02:58 +0000605class ObjCNonFragileABITypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahanian83a8a752009-02-04 20:42:28 +0000606public:
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000607 // MethodListnfABITy - LLVM for struct _method_list_t
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000608 llvm::StructType *MethodListnfABITy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000609
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000610 // MethodListnfABIPtrTy - LLVM for struct _method_list_t*
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000611 llvm::Type *MethodListnfABIPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000612
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000613 // ProtocolnfABITy = LLVM for struct _protocol_t
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000614 llvm::StructType *ProtocolnfABITy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000615
Daniel Dunbar948e2582009-02-15 07:36:20 +0000616 // ProtocolnfABIPtrTy = LLVM for struct _protocol_t*
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000617 llvm::Type *ProtocolnfABIPtrTy;
Daniel Dunbar948e2582009-02-15 07:36:20 +0000618
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000619 // ProtocolListnfABITy - LLVM for struct _objc_protocol_list
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000620 llvm::StructType *ProtocolListnfABITy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000621
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000622 // ProtocolListnfABIPtrTy - LLVM for struct _objc_protocol_list*
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000623 llvm::Type *ProtocolListnfABIPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000624
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000625 // ClassnfABITy - LLVM for struct _class_t
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000626 llvm::StructType *ClassnfABITy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000627
Fariborz Jahanianaa23b572009-01-23 23:53:38 +0000628 // ClassnfABIPtrTy - LLVM for struct _class_t*
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000629 llvm::Type *ClassnfABIPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000630
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000631 // IvarnfABITy - LLVM for struct _ivar_t
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000632 llvm::StructType *IvarnfABITy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000633
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000634 // IvarListnfABITy - LLVM for struct _ivar_list_t
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000635 llvm::StructType *IvarListnfABITy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000636
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000637 // IvarListnfABIPtrTy = LLVM for struct _ivar_list_t*
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000638 llvm::Type *IvarListnfABIPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000639
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000640 // ClassRonfABITy - LLVM for struct _class_ro_t
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000641 llvm::StructType *ClassRonfABITy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000642
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000643 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000644 llvm::Type *ImpnfABITy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000645
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +0000646 // CategorynfABITy - LLVM for struct _category_t
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000647 llvm::StructType *CategorynfABITy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000648
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +0000649 // New types for nonfragile abi messaging.
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000650
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +0000651 // MessageRefTy - LLVM for:
652 // struct _message_ref_t {
653 // IMP messenger;
654 // SEL name;
655 // };
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000656 llvm::StructType *MessageRefTy;
Fariborz Jahanian83a8a752009-02-04 20:42:28 +0000657 // MessageRefCTy - clang type for struct _message_ref_t
658 QualType MessageRefCTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000659
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +0000660 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000661 llvm::Type *MessageRefPtrTy;
Fariborz Jahanian83a8a752009-02-04 20:42:28 +0000662 // MessageRefCPtrTy - clang type for struct _message_ref_t*
663 QualType MessageRefCPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000664
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +0000665 // SuperMessageRefTy - LLVM for:
666 // struct _super_message_ref_t {
667 // SUPER_IMP messenger;
668 // SEL name;
669 // };
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000670 llvm::StructType *SuperMessageRefTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000671
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +0000672 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000673 llvm::Type *SuperMessageRefPtrTy;
Daniel Dunbar8ecbaf22009-02-24 07:47:38 +0000674
Chris Lattner1c02f862009-04-22 02:53:24 +0000675 llvm::Constant *getMessageSendFixupFn() {
676 // id objc_msgSend_fixup(id, struct message_ref_t*, ...)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000677 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson96e0fc72009-07-29 22:16:19 +0000678 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall0774cb82011-05-15 01:53:33 +0000679 params, true),
Chris Lattner1c02f862009-04-22 02:53:24 +0000680 "objc_msgSend_fixup");
681 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000682
Chris Lattner1c02f862009-04-22 02:53:24 +0000683 llvm::Constant *getMessageSendFpretFixupFn() {
684 // id objc_msgSend_fpret_fixup(id, struct message_ref_t*, ...)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000685 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson96e0fc72009-07-29 22:16:19 +0000686 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall0774cb82011-05-15 01:53:33 +0000687 params, true),
Chris Lattner1c02f862009-04-22 02:53:24 +0000688 "objc_msgSend_fpret_fixup");
689 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000690
Chris Lattner1c02f862009-04-22 02:53:24 +0000691 llvm::Constant *getMessageSendStretFixupFn() {
692 // id objc_msgSend_stret_fixup(id, struct message_ref_t*, ...)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000693 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson96e0fc72009-07-29 22:16:19 +0000694 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall0774cb82011-05-15 01:53:33 +0000695 params, true),
Chris Lattner1c02f862009-04-22 02:53:24 +0000696 "objc_msgSend_stret_fixup");
697 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000698
Chris Lattner1c02f862009-04-22 02:53:24 +0000699 llvm::Constant *getMessageSendSuper2FixupFn() {
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000700 // id objc_msgSendSuper2_fixup (struct objc_super *,
Chris Lattner1c02f862009-04-22 02:53:24 +0000701 // struct _super_message_ref_t*, ...)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000702 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson96e0fc72009-07-29 22:16:19 +0000703 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall0774cb82011-05-15 01:53:33 +0000704 params, true),
Chris Lattner1c02f862009-04-22 02:53:24 +0000705 "objc_msgSendSuper2_fixup");
706 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000707
Chris Lattner1c02f862009-04-22 02:53:24 +0000708 llvm::Constant *getMessageSendSuper2StretFixupFn() {
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000709 // id objc_msgSendSuper2_stret_fixup(struct objc_super *,
Chris Lattner1c02f862009-04-22 02:53:24 +0000710 // struct _super_message_ref_t*, ...)
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000711 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson96e0fc72009-07-29 22:16:19 +0000712 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall0774cb82011-05-15 01:53:33 +0000713 params, true),
Chris Lattner1c02f862009-04-22 02:53:24 +0000714 "objc_msgSendSuper2_stret_fixup");
715 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000716
Chris Lattner8a569112009-04-22 02:15:23 +0000717 llvm::Constant *getObjCEndCatchFn() {
John McCall0774cb82011-05-15 01:53:33 +0000718 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy, false),
Chris Lattner8a569112009-04-22 02:15:23 +0000719 "objc_end_catch");
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000720
Chris Lattner8a569112009-04-22 02:15:23 +0000721 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000722
Chris Lattner8a569112009-04-22 02:15:23 +0000723 llvm::Constant *getObjCBeginCatchFn() {
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000724 llvm::Type *params[] = { Int8PtrTy };
Owen Anderson96e0fc72009-07-29 22:16:19 +0000725 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(Int8PtrTy,
John McCall0774cb82011-05-15 01:53:33 +0000726 params, false),
Chris Lattner8a569112009-04-22 02:15:23 +0000727 "objc_begin_catch");
728 }
Daniel Dunbare588b992009-03-01 04:46:24 +0000729
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000730 llvm::StructType *EHTypeTy;
731 llvm::Type *EHTypePtrTy;
Fariborz Jahanian9d96bce2011-06-22 20:21:51 +0000732
Fariborz Jahanian30bc5712009-01-22 23:02:58 +0000733 ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000734};
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000735
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000736class CGObjCCommonMac : public CodeGen::CGObjCRuntime {
Fariborz Jahanian9397e1d2009-03-11 20:59:05 +0000737public:
Fariborz Jahanian9397e1d2009-03-11 20:59:05 +0000738 class SKIP_SCAN {
Daniel Dunbar8b2926c2009-05-03 13:44:42 +0000739 public:
740 unsigned skip;
741 unsigned scan;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000742 SKIP_SCAN(unsigned _skip = 0, unsigned _scan = 0)
Daniel Dunbar8b2926c2009-05-03 13:44:42 +0000743 : skip(_skip), scan(_scan) {}
Fariborz Jahanian9397e1d2009-03-11 20:59:05 +0000744 };
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000745
Fariborz Jahaniane11dba82012-10-25 21:15:04 +0000746 /// opcode for captured block variables layout 'instructions'.
747 /// In the following descriptions, 'I' is the value of the immediate field.
748 /// (field following the opcode).
749 ///
750 enum BLOCK_LAYOUT_OPCODE {
751 /// An operator which affects how the following layout should be
752 /// interpreted.
753 /// I == 0: Halt interpretation and treat everything else as
754 /// a non-pointer. Note that this instruction is equal
755 /// to '\0'.
756 /// I != 0: Currently unused.
757 BLOCK_LAYOUT_OPERATOR = 0,
758
759 /// The next I+1 bytes do not contain a value of object pointer type.
760 /// Note that this can leave the stream unaligned, meaning that
761 /// subsequent word-size instructions do not begin at a multiple of
762 /// the pointer size.
763 BLOCK_LAYOUT_NON_OBJECT_BYTES = 1,
764
765 /// The next I+1 words do not contain a value of object pointer type.
766 /// This is simply an optimized version of BLOCK_LAYOUT_BYTES for
767 /// when the required skip quantity is a multiple of the pointer size.
768 BLOCK_LAYOUT_NON_OBJECT_WORDS = 2,
769
770 /// The next I+1 words are __strong pointers to Objective-C
771 /// objects or blocks.
772 BLOCK_LAYOUT_STRONG = 3,
773
774 /// The next I+1 words are pointers to __block variables.
775 BLOCK_LAYOUT_BYREF = 4,
776
777 /// The next I+1 words are __weak pointers to Objective-C
778 /// objects or blocks.
779 BLOCK_LAYOUT_WEAK = 5,
780
781 /// The next I+1 words are __unsafe_unretained pointers to
782 /// Objective-C objects or blocks.
783 BLOCK_LAYOUT_UNRETAINED = 6
784
785 /// The next I+1 words are block or object pointers with some
786 /// as-yet-unspecified ownership semantics. If we add more
787 /// flavors of ownership semantics, values will be taken from
788 /// this range.
789 ///
790 /// This is included so that older tools can at least continue
791 /// processing the layout past such things.
792 //BLOCK_LAYOUT_OWNERSHIP_UNKNOWN = 7..10,
793
794 /// All other opcodes are reserved. Halt interpretation and
795 /// treat everything else as opaque.
796 };
797
798 class RUN_SKIP {
799 public:
800 enum BLOCK_LAYOUT_OPCODE opcode;
Fariborz Jahanian1da01d62012-11-07 20:00:32 +0000801 CharUnits block_var_bytepos;
802 CharUnits block_var_size;
Fariborz Jahaniane11dba82012-10-25 21:15:04 +0000803 RUN_SKIP(enum BLOCK_LAYOUT_OPCODE Opcode = BLOCK_LAYOUT_OPERATOR,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +0000804 CharUnits BytePos = CharUnits::Zero(),
805 CharUnits Size = CharUnits::Zero())
Fariborz Jahanianc46b4352012-10-27 21:10:38 +0000806 : opcode(Opcode), block_var_bytepos(BytePos), block_var_size(Size) {}
Fariborz Jahaniane11dba82012-10-25 21:15:04 +0000807
808 // Allow sorting based on byte pos.
809 bool operator<(const RUN_SKIP &b) const {
810 return block_var_bytepos < b.block_var_bytepos;
811 }
812 };
813
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000814protected:
Owen Anderson69243822009-07-13 04:10:07 +0000815 llvm::LLVMContext &VMContext;
Fariborz Jahanianee0af742009-01-21 22:04:16 +0000816 // FIXME! May not be needing this after all.
Daniel Dunbarbbce49b2008-08-12 00:12:39 +0000817 unsigned ObjCABI;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000818
Fariborz Jahaniane11dba82012-10-25 21:15:04 +0000819 // arc/mrr layout of captured block literal variables.
820 SmallVector<RUN_SKIP, 16> RunSkipBlockVars;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000821
Daniel Dunbar242d4dc2008-08-25 06:02:07 +0000822 /// LazySymbols - Symbols to generate a lazy reference for. See
823 /// DefinedSymbols and FinishModule().
Daniel Dunbar33063492009-09-07 00:20:42 +0000824 llvm::SetVector<IdentifierInfo*> LazySymbols;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000825
Daniel Dunbar242d4dc2008-08-25 06:02:07 +0000826 /// DefinedSymbols - External symbols which are defined by this
827 /// module. The symbols in this list and LazySymbols are used to add
828 /// special linker symbols which ensure that Objective-C modules are
829 /// linked properly.
Daniel Dunbar33063492009-09-07 00:20:42 +0000830 llvm::SetVector<IdentifierInfo*> DefinedSymbols;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000831
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +0000832 /// ClassNames - uniqued class names.
Stephen Hines176edba2014-12-01 14:53:08 -0800833 llvm::StringMap<llvm::GlobalVariable*> ClassNames;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000834
Daniel Dunbar259d93d2008-08-12 03:39:23 +0000835 /// MethodVarNames - uniqued method variable names.
836 llvm::DenseMap<Selector, llvm::GlobalVariable*> MethodVarNames;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000837
Fariborz Jahanianb9c5b3d2010-06-21 22:05:18 +0000838 /// DefinedCategoryNames - list of category names in form Class_Category.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800839 llvm::SmallSetVector<std::string, 16> DefinedCategoryNames;
Fariborz Jahanianb9c5b3d2010-06-21 22:05:18 +0000840
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000841 /// MethodVarTypes - uniqued method type signatures. We have to use
842 /// a StringMap here because have no other unique reference.
843 llvm::StringMap<llvm::GlobalVariable*> MethodVarTypes;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000844
Daniel Dunbarc45ef602008-08-26 21:51:14 +0000845 /// MethodDefinitions - map of methods which have been defined in
846 /// this translation unit.
847 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*> MethodDefinitions;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000848
Daniel Dunbarc8ef5512008-08-23 00:19:03 +0000849 /// PropertyNames - uniqued method variable names.
850 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> PropertyNames;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000851
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000852 /// ClassReferences - uniqued class references.
853 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> ClassReferences;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000854
Daniel Dunbar259d93d2008-08-12 03:39:23 +0000855 /// SelectorReferences - uniqued selector references.
856 llvm::DenseMap<Selector, llvm::GlobalVariable*> SelectorReferences;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000857
Daniel Dunbar6efc0c52008-08-13 03:21:16 +0000858 /// Protocols - Protocols for which an objc_protocol structure has
859 /// been emitted. Forward declarations are handled by creating an
860 /// empty structure whose initializer is filled in when/if defined.
861 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> Protocols;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000862
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +0000863 /// DefinedProtocols - Protocols which have actually been
864 /// defined. We should not need this, see FIXME in GenerateProtocol.
865 llvm::DenseSet<IdentifierInfo*> DefinedProtocols;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000866
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000867 /// DefinedClasses - List of defined classes.
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000868 SmallVector<llvm::GlobalValue*, 16> DefinedClasses;
Stephen Hines651f13c2014-04-23 16:59:28 -0700869
870 /// ImplementedClasses - List of @implemented classes.
871 SmallVector<const ObjCInterfaceDecl*, 16> ImplementedClasses;
Daniel Dunbar74d4b122009-05-15 22:33:15 +0000872
873 /// DefinedNonLazyClasses - List of defined "non-lazy" classes.
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000874 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyClasses;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000875
Daniel Dunbar27f9d772008-08-21 04:36:09 +0000876 /// DefinedCategories - List of defined categories.
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000877 SmallVector<llvm::GlobalValue*, 16> DefinedCategories;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000878
Daniel Dunbar74d4b122009-05-15 22:33:15 +0000879 /// DefinedNonLazyCategories - List of defined "non-lazy" categories.
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000880 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyCategories;
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000881
Fariborz Jahanian56210f72009-01-21 23:34:32 +0000882 /// GetNameForMethod - Return a name for the given method.
883 /// \param[out] NameOut - The return value.
884 void GetNameForMethod(const ObjCMethodDecl *OMD,
885 const ObjCContainerDecl *CD,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000886 SmallVectorImpl<char> &NameOut);
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000887
Fariborz Jahanian56210f72009-01-21 23:34:32 +0000888 /// GetMethodVarName - Return a unique constant for the given
889 /// selector's name. The return value has type char *.
890 llvm::Constant *GetMethodVarName(Selector Sel);
891 llvm::Constant *GetMethodVarName(IdentifierInfo *Ident);
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000892
Fariborz Jahanian56210f72009-01-21 23:34:32 +0000893 /// GetMethodVarType - Return a unique constant for the given
Bob Wilsondc8dab62011-11-30 01:57:58 +0000894 /// method's type encoding string. The return value has type char *.
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000895
Fariborz Jahanian56210f72009-01-21 23:34:32 +0000896 // FIXME: This is a horrible name.
Bob Wilsondc8dab62011-11-30 01:57:58 +0000897 llvm::Constant *GetMethodVarType(const ObjCMethodDecl *D,
898 bool Extended = false);
Daniel Dunbar3e5f0d82009-04-20 06:54:31 +0000899 llvm::Constant *GetMethodVarType(const FieldDecl *D);
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000900
Fariborz Jahanian56210f72009-01-21 23:34:32 +0000901 /// GetPropertyName - Return a unique constant for the given
902 /// name. The return value has type char *.
903 llvm::Constant *GetPropertyName(IdentifierInfo *Ident);
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000904
Fariborz Jahanian56210f72009-01-21 23:34:32 +0000905 // FIXME: This can be dropped once string functions are unified.
906 llvm::Constant *GetPropertyTypeString(const ObjCPropertyDecl *PD,
907 const Decl *Container);
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000908
Fariborz Jahanian058a1b72009-01-24 20:21:50 +0000909 /// GetClassName - Return a unique constant for the given selector's
Stephen Hines176edba2014-12-01 14:53:08 -0800910 /// runtime name (which may change via use of objc_runtime_name attribute on
911 /// class or protocol definition. The return value has type char *.
912 llvm::Constant *GetClassName(StringRef RuntimeName);
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000913
Argyrios Kyrtzidis9d50c062010-08-09 10:54:20 +0000914 llvm::Function *GetMethodDefinition(const ObjCMethodDecl *MD);
915
Fariborz Jahaniand61a50a2009-03-05 22:39:55 +0000916 /// BuildIvarLayout - Builds ivar layout bitmap for the class
917 /// implementation for the __strong or __weak case.
918 ///
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800919 /// \param hasMRCWeakIvars - Whether we are compiling in MRC and there
920 /// are any weak ivars defined directly in the class. Meaningless unless
921 /// building a weak layout. Does not guarantee that the layout will
922 /// actually have any entries, because the ivar might be under-aligned.
Fariborz Jahanianc8ce9c82009-03-12 22:50:49 +0000923 llvm::Constant *BuildIvarLayout(const ObjCImplementationDecl *OI,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800924 CharUnits beginOffset,
925 CharUnits endOffset,
926 bool forStrongLayout,
927 bool hasMRCWeakIvars);
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000928
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -0800929 llvm::Constant *BuildStrongIvarLayout(const ObjCImplementationDecl *OI,
930 CharUnits beginOffset,
931 CharUnits endOffset) {
932 return BuildIvarLayout(OI, beginOffset, endOffset, true, false);
933 }
934
935 llvm::Constant *BuildWeakIvarLayout(const ObjCImplementationDecl *OI,
936 CharUnits beginOffset,
937 CharUnits endOffset,
938 bool hasMRCWeakIvars) {
939 return BuildIvarLayout(OI, beginOffset, endOffset, false, hasMRCWeakIvars);
940 }
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +0000941
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +0000942 Qualifiers::ObjCLifetime getBlockCaptureLifetime(QualType QT, bool ByrefLayout);
Fariborz Jahanian44fcff92012-11-02 22:51:18 +0000943
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +0000944 void UpdateRunSkipBlockVars(bool IsByref,
945 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +0000946 CharUnits FieldOffset,
947 CharUnits FieldSize);
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +0000948
949 void BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +0000950 CharUnits BytePos, bool &HasUnion,
951 bool ByrefLayout=false);
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +0000952
953 void BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
954 const RecordDecl *RD,
955 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +0000956 CharUnits BytePos, bool &HasUnion,
957 bool ByrefLayout);
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +0000958
Fariborz Jahanianf22ae652012-11-01 18:32:55 +0000959 uint64_t InlineLayoutInstruction(SmallVectorImpl<unsigned char> &Layout);
960
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +0000961 llvm::Constant *getBitmapBlockLayout(bool ComputeByrefLayout);
962
Fariborz Jahaniand80d81b2009-03-05 19:17:31 +0000963 /// GetIvarLayoutName - Returns a unique constant for the given
964 /// ivar layout bitmap.
965 llvm::Constant *GetIvarLayoutName(IdentifierInfo *Ident,
966 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000967
Fariborz Jahanian5de14dc2009-01-28 22:18:42 +0000968 /// EmitPropertyList - Emit the given property list. The return
969 /// value has type PropertyListPtrTy.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000970 llvm::Constant *EmitPropertyList(Twine Name,
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000971 const Decl *Container,
Fariborz Jahanian5de14dc2009-01-28 22:18:42 +0000972 const ObjCContainerDecl *OCD,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700973 const ObjCCommonTypesHelper &ObjCTypes,
974 bool IsClassProperty);
Daniel Dunbar6bff2512009-08-03 17:06:42 +0000975
Bob Wilsondc8dab62011-11-30 01:57:58 +0000976 /// EmitProtocolMethodTypes - Generate the array of extended method type
977 /// strings. The return value has type Int8PtrPtrTy.
978 llvm::Constant *EmitProtocolMethodTypes(Twine Name,
Bill Wendlingbb028552012-02-07 09:25:09 +0000979 ArrayRef<llvm::Constant*> MethodTypes,
Bob Wilsondc8dab62011-11-30 01:57:58 +0000980 const ObjCCommonTypesHelper &ObjCTypes);
981
Fariborz Jahanian191dcd72009-12-12 21:26:21 +0000982 /// PushProtocolProperties - Push protocol's property on the input stack.
Bill Wendling3964e622012-02-09 22:16:49 +0000983 void PushProtocolProperties(
984 llvm::SmallPtrSet<const IdentifierInfo*, 16> &PropertySet,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000985 SmallVectorImpl<llvm::Constant*> &Properties,
Bill Wendling3964e622012-02-09 22:16:49 +0000986 const Decl *Container,
Stephen Hines651f13c2014-04-23 16:59:28 -0700987 const ObjCProtocolDecl *Proto,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700988 const ObjCCommonTypesHelper &ObjCTypes,
989 bool IsClassProperty);
Fariborz Jahanian191dcd72009-12-12 21:26:21 +0000990
Fariborz Jahanianda320092009-01-29 19:24:30 +0000991 /// GetProtocolRef - Return a reference to the internal protocol
992 /// description, creating an empty one if it has not been
993 /// defined. The return value has type ProtocolPtrTy.
994 llvm::Constant *GetProtocolRef(const ObjCProtocolDecl *PD);
Fariborz Jahanianb21f07e2009-03-08 20:18:37 +0000995
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -0700996 /// Return a reference to the given Class using runtime calls rather than
997 /// by a symbol reference.
998 llvm::Value *EmitClassRefViaRuntime(CodeGenFunction &CGF,
999 const ObjCInterfaceDecl *ID,
1000 ObjCCommonTypesHelper &ObjCTypes);
1001
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001002public:
Daniel Dunbarfd65d372009-03-09 20:09:19 +00001003 /// CreateMetadataVar - Create a global variable with internal
1004 /// linkage for use by the Objective-C runtime.
1005 ///
1006 /// This is a convenience wrapper which not only creates the
1007 /// variable, but also sets the section and alignment and adds the
Chris Lattnerad64e022009-07-17 23:57:13 +00001008 /// global to the "llvm.used" list.
Daniel Dunbar35bd7632009-03-09 20:50:13 +00001009 ///
1010 /// \param Name - The variable name.
1011 /// \param Init - The variable initializer; this is also used to
1012 /// define the type of the variable.
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001013 /// \param Section - The section the variable should go into, or empty.
Daniel Dunbar35bd7632009-03-09 20:50:13 +00001014 /// \param Align - The alignment for the variable, or 0.
1015 /// \param AddToUsed - Whether the variable should be added to
Daniel Dunbarc1583062009-04-14 17:42:51 +00001016 /// "llvm.used".
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001017 llvm::GlobalVariable *CreateMetadataVar(Twine Name, llvm::Constant *Init,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001018 StringRef Section, CharUnits Align,
Daniel Dunbar35bd7632009-03-09 20:50:13 +00001019 bool AddToUsed);
Daniel Dunbarfd65d372009-03-09 20:09:19 +00001020
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001021protected:
John McCall944c8432011-05-14 03:10:52 +00001022 CodeGen::RValue EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1023 ReturnValueSlot Return,
1024 QualType ResultType,
1025 llvm::Value *Sel,
1026 llvm::Value *Arg0,
1027 QualType Arg0Ty,
1028 bool IsSuper,
1029 const CallArgList &CallArgs,
1030 const ObjCMethodDecl *OMD,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001031 const ObjCInterfaceDecl *ClassReceiver,
John McCall944c8432011-05-14 03:10:52 +00001032 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar3e5f0d82009-04-20 06:54:31 +00001033
Daniel Dunbarfce176b2010-04-25 20:39:01 +00001034 /// EmitImageInfo - Emit the image info marker used to encode some module
1035 /// level information.
1036 void EmitImageInfo();
1037
Fariborz Jahanianee0af742009-01-21 22:04:16 +00001038public:
Owen Anderson69243822009-07-13 04:10:07 +00001039 CGObjCCommonMac(CodeGen::CodeGenModule &cgm) :
John McCallde5d3c72012-02-17 03:33:10 +00001040 CGObjCRuntime(cgm), VMContext(cgm.getLLVMContext()) { }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001041
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001042 bool isNonFragileABI() const {
1043 return ObjCABI == 2;
1044 }
1045
1046 ConstantAddress GenerateConstantString(const StringLiteral *SL) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001047
Stephen Hines651f13c2014-04-23 16:59:28 -07001048 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001049 const ObjCContainerDecl *CD=nullptr) override;
Stephen Hines651f13c2014-04-23 16:59:28 -07001050
1051 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001052
Fariborz Jahanianda320092009-01-29 19:24:30 +00001053 /// GetOrEmitProtocol - Get the protocol object for the given
1054 /// declaration, emitting it if necessary. The return value has type
1055 /// ProtocolPtrTy.
1056 virtual llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD)=0;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001057
Fariborz Jahanianda320092009-01-29 19:24:30 +00001058 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1059 /// object for the given declaration, emitting it if needed. These
1060 /// forward references will be filled in with empty bodies if no
1061 /// definition is seen. The return value has type ProtocolPtrTy.
1062 virtual llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD)=0;
Stephen Hines651f13c2014-04-23 16:59:28 -07001063 llvm::Constant *BuildGCBlockLayout(CodeGen::CodeGenModule &CGM,
1064 const CGBlockInfo &blockInfo) override;
1065 llvm::Constant *BuildRCBlockLayout(CodeGen::CodeGenModule &CGM,
1066 const CGBlockInfo &blockInfo) override;
1067
1068 llvm::Constant *BuildByrefLayout(CodeGen::CodeGenModule &CGM,
1069 QualType T) override;
Fariborz Jahanianee0af742009-01-21 22:04:16 +00001070};
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001071
Fariborz Jahanianee0af742009-01-21 22:04:16 +00001072class CGObjCMac : public CGObjCCommonMac {
1073private:
1074 ObjCTypesHelper ObjCTypes;
Daniel Dunbarf77ac862008-08-11 21:35:06 +00001075
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00001076 /// EmitModuleInfo - Another marker encoding module level
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001077 /// information.
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00001078 void EmitModuleInfo();
1079
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001080 /// EmitModuleSymols - Emit module symbols, the list of defined
1081 /// classes and categories. The result has type SymtabPtrTy.
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00001082 llvm::Constant *EmitModuleSymbols();
1083
Daniel Dunbarf77ac862008-08-11 21:35:06 +00001084 /// FinishModule - Write out global data structures at the end of
1085 /// processing a translation unit.
1086 void FinishModule();
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00001087
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001088 /// EmitClassExtension - Generate the class extension structure used
1089 /// to store the weak ivar layout and properties. The return value
1090 /// has type ClassExtensionPtrTy.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001091 llvm::Constant *EmitClassExtension(const ObjCImplementationDecl *ID,
1092 CharUnits instanceSize,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001093 bool hasMRCWeakIvars,
1094 bool isClassProperty);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001095
1096 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1097 /// for the given class.
John McCallbd7370a2013-02-28 19:01:20 +00001098 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001099 const ObjCInterfaceDecl *ID);
Fariborz Jahanianb0069ee2009-11-12 20:14:24 +00001100
John McCallbd7370a2013-02-28 19:01:20 +00001101 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCallf85e1932011-06-15 23:02:42 +00001102 IdentifierInfo *II);
Stephen Hines651f13c2014-04-23 16:59:28 -07001103
1104 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
1105
Fariborz Jahanianb0069ee2009-11-12 20:14:24 +00001106 /// EmitSuperClassRef - Emits reference to class's main metadata class.
1107 llvm::Value *EmitSuperClassRef(const ObjCInterfaceDecl *ID);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001108
1109 /// EmitIvarList - Emit the ivar list for the given
1110 /// implementation. If ForClass is true the list of class ivars
1111 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1112 /// interface ivars will be emitted. The return value has type
1113 /// IvarListPtrTy.
1114 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanian46b86c62009-01-28 19:12:34 +00001115 bool ForClass);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001116
Daniel Dunbarf56f1912008-08-25 08:19:24 +00001117 /// EmitMetaClass - Emit a forward reference to the class structure
1118 /// for the metaclass of the given interface. The return value has
1119 /// type ClassPtrTy.
1120 llvm::Constant *EmitMetaClassRef(const ObjCInterfaceDecl *ID);
1121
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001122 /// EmitMetaClass - Emit a class structure for the metaclass of the
Daniel Dunbarf56f1912008-08-25 08:19:24 +00001123 /// given implementation. The return value has type ClassPtrTy.
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001124 llvm::Constant *EmitMetaClass(const ObjCImplementationDecl *ID,
1125 llvm::Constant *Protocols,
Bill Wendlingbb028552012-02-07 09:25:09 +00001126 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001127
Daniel Dunbarae226fa2008-08-27 02:31:56 +00001128 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001129
Daniel Dunbarae226fa2008-08-27 02:31:56 +00001130 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001131
1132 /// EmitMethodList - Emit the method list for the given
Daniel Dunbaraf05bb92008-08-26 08:29:31 +00001133 /// implementation. The return value has type MethodListPtrTy.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001134 llvm::Constant *EmitMethodList(Twine Name, StringRef Section,
1135 ArrayRef<llvm::Constant *> Methods);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001136
1137 /// EmitMethodDescList - Emit a method description list for a list of
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001138 /// method declarations.
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00001139 /// - TypeName: The name for the type containing the methods.
Sylvestre Ledruf3477c12012-09-27 10:16:10 +00001140 /// - IsProtocol: True iff these methods are for a protocol.
1141 /// - ClassMethds: True iff these are class methods.
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00001142 /// - Required: When true, only "required" methods are
1143 /// listed. Similarly, when false only "optional" methods are
1144 /// listed. For classes this should always be true.
1145 /// - begin, end: The method list to output.
1146 ///
1147 /// The return value has type MethodDescriptionListPtrTy.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001148 llvm::Constant *EmitMethodDescList(Twine Name, StringRef Section,
1149 ArrayRef<llvm::Constant *> Methods);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00001150
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00001151 /// GetOrEmitProtocol - Get the protocol object for the given
1152 /// declaration, emitting it if necessary. The return value has type
1153 /// ProtocolPtrTy.
Stephen Hines651f13c2014-04-23 16:59:28 -07001154 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00001155
1156 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1157 /// object for the given declaration, emitting it if needed. These
1158 /// forward references will be filled in with empty bodies if no
1159 /// definition is seen. The return value has type ProtocolPtrTy.
Stephen Hines651f13c2014-04-23 16:59:28 -07001160 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00001161
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00001162 /// EmitProtocolExtension - Generate the protocol extension
1163 /// structure used to store optional instance and class methods, and
1164 /// protocol properties. The return value has type
1165 /// ProtocolExtensionPtrTy.
Daniel Dunbarae226fa2008-08-27 02:31:56 +00001166 llvm::Constant *
1167 EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingbb028552012-02-07 09:25:09 +00001168 ArrayRef<llvm::Constant*> OptInstanceMethods,
1169 ArrayRef<llvm::Constant*> OptClassMethods,
1170 ArrayRef<llvm::Constant*> MethodTypesExt);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00001171
1172 /// EmitProtocolList - Generate the list of referenced
1173 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001174 llvm::Constant *EmitProtocolList(Twine Name,
Daniel Dunbardbc933702008-08-21 21:57:41 +00001175 ObjCProtocolDecl::protocol_iterator begin,
1176 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00001177
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001178 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1179 /// for the given selector.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001180 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1181 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001182
1183public:
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001184 CGObjCMac(CodeGen::CodeGenModule &cgm);
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001185
Stephen Hines651f13c2014-04-23 16:59:28 -07001186 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001187
Stephen Hines651f13c2014-04-23 16:59:28 -07001188 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1189 ReturnValueSlot Return,
1190 QualType ResultType,
1191 Selector Sel, llvm::Value *Receiver,
1192 const CallArgList &CallArgs,
1193 const ObjCInterfaceDecl *Class,
1194 const ObjCMethodDecl *Method) override;
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001195
Stephen Hines651f13c2014-04-23 16:59:28 -07001196 CodeGen::RValue
Daniel Dunbar8f2926b2008-08-23 03:46:30 +00001197 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Stephen Hines651f13c2014-04-23 16:59:28 -07001198 ReturnValueSlot Return, QualType ResultType,
1199 Selector Sel, const ObjCInterfaceDecl *Class,
1200 bool isCategoryImpl, llvm::Value *Receiver,
1201 bool IsClassMessage, const CallArgList &CallArgs,
1202 const ObjCMethodDecl *Method) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001203
Stephen Hines651f13c2014-04-23 16:59:28 -07001204 llvm::Value *GetClass(CodeGenFunction &CGF,
1205 const ObjCInterfaceDecl *ID) override;
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001206
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001207 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
1208 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Fariborz Jahaniandf9ccc62009-05-05 21:36:57 +00001209
1210 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1211 /// untyped one.
Stephen Hines651f13c2014-04-23 16:59:28 -07001212 llvm::Value *GetSelector(CodeGenFunction &CGF,
1213 const ObjCMethodDecl *Method) override;
Fariborz Jahaniandf9ccc62009-05-05 21:36:57 +00001214
Stephen Hines651f13c2014-04-23 16:59:28 -07001215 llvm::Constant *GetEHType(QualType T) override;
John McCall5a180392010-07-24 00:37:23 +00001216
Stephen Hines651f13c2014-04-23 16:59:28 -07001217 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001218
Stephen Hines651f13c2014-04-23 16:59:28 -07001219 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001220
Stephen Hines651f13c2014-04-23 16:59:28 -07001221 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall29254f42012-01-31 18:59:20 +00001222
Stephen Hines651f13c2014-04-23 16:59:28 -07001223 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1224 const ObjCProtocolDecl *PD) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001225
Stephen Hines651f13c2014-04-23 16:59:28 -07001226 llvm::Constant *GetPropertyGetFunction() override;
1227 llvm::Constant *GetPropertySetFunction() override;
1228 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1229 bool copy) override;
1230 llvm::Constant *GetGetStructFunction() override;
1231 llvm::Constant *GetSetStructFunction() override;
1232 llvm::Constant *GetCppAtomicObjectGetFunction() override;
1233 llvm::Constant *GetCppAtomicObjectSetFunction() override;
1234 llvm::Constant *EnumerationMutationFunction() override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001235
Stephen Hines651f13c2014-04-23 16:59:28 -07001236 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1237 const ObjCAtTryStmt &S) override;
1238 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1239 const ObjCAtSynchronizedStmt &S) override;
John McCallf1549f62010-07-06 01:34:17 +00001240 void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, const Stmt &S);
Stephen Hines651f13c2014-04-23 16:59:28 -07001241 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1242 bool ClearInsertionPoint=true) override;
1243 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001244 Address AddrWeakObj) override;
Stephen Hines651f13c2014-04-23 16:59:28 -07001245 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001246 llvm::Value *src, Address dst) override;
Stephen Hines651f13c2014-04-23 16:59:28 -07001247 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001248 llvm::Value *src, Address dest,
Stephen Hines651f13c2014-04-23 16:59:28 -07001249 bool threadlocal = false) override;
1250 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001251 llvm::Value *src, Address dest,
Stephen Hines651f13c2014-04-23 16:59:28 -07001252 llvm::Value *ivarOffset) override;
1253 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001254 llvm::Value *src, Address dest) override;
Stephen Hines651f13c2014-04-23 16:59:28 -07001255 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001256 Address dest, Address src,
Stephen Hines651f13c2014-04-23 16:59:28 -07001257 llvm::Value *size) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001258
Stephen Hines651f13c2014-04-23 16:59:28 -07001259 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1260 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1261 unsigned CVRQualifiers) override;
1262 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1263 const ObjCInterfaceDecl *Interface,
1264 const ObjCIvarDecl *Ivar) override;
1265
Fariborz Jahanian6f40e222011-05-17 22:21:16 +00001266 /// GetClassGlobal - Return the global variable for the Objective-C
1267 /// class of the given name.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001268 llvm::GlobalVariable *GetClassGlobal(StringRef Name,
Stephen Hines651f13c2014-04-23 16:59:28 -07001269 bool Weak = false) override {
David Blaikieb219cfc2011-09-23 05:06:16 +00001270 llvm_unreachable("CGObjCMac::GetClassGlobal");
Fariborz Jahanian6f40e222011-05-17 22:21:16 +00001271 }
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001272};
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001273
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00001274class CGObjCNonFragileABIMac : public CGObjCCommonMac {
Fariborz Jahanianee0af742009-01-21 22:04:16 +00001275private:
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00001276 ObjCNonFragileABITypesHelper ObjCTypes;
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00001277 llvm::GlobalVariable* ObjCEmptyCacheVar;
1278 llvm::GlobalVariable* ObjCEmptyVtableVar;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001279
Daniel Dunbar11394522009-04-18 08:51:00 +00001280 /// SuperClassReferences - uniqued super class references.
1281 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> SuperClassReferences;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001282
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00001283 /// MetaClassReferences - uniqued meta class references.
1284 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> MetaClassReferences;
Daniel Dunbare588b992009-03-01 04:46:24 +00001285
1286 /// EHTypeReferences - uniqued class ehtype references.
1287 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> EHTypeReferences;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001288
John McCall944c8432011-05-14 03:10:52 +00001289 /// VTableDispatchMethods - List of methods for which we generate
1290 /// vtable-based message dispatch.
1291 llvm::DenseSet<Selector> VTableDispatchMethods;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001292
Fariborz Jahaniana03d0dd2009-11-17 21:37:35 +00001293 /// DefinedMetaClasses - List of defined meta-classes.
1294 std::vector<llvm::GlobalValue*> DefinedMetaClasses;
1295
John McCall944c8432011-05-14 03:10:52 +00001296 /// isVTableDispatchedSelector - Returns true if SEL is a
1297 /// vtable-based selector.
1298 bool isVTableDispatchedSelector(Selector Sel);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001299
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00001300 /// FinishNonFragileABIModule - Write out global data structures at the end of
1301 /// processing a translation unit.
1302 void FinishNonFragileABIModule();
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00001303
Daniel Dunbar463b8762009-05-15 21:48:48 +00001304 /// AddModuleClassList - Add the given list of class pointers to the
1305 /// module with the provided symbol and section names.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001306 void AddModuleClassList(ArrayRef<llvm::GlobalValue *> Container,
1307 StringRef SymbolName, StringRef SectionName);
Daniel Dunbar463b8762009-05-15 21:48:48 +00001308
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001309 llvm::GlobalVariable * BuildClassRoTInitializer(unsigned flags,
1310 unsigned InstanceStart,
1311 unsigned InstanceSize,
1312 const ObjCImplementationDecl *ID);
Stephen Hines176edba2014-12-01 14:53:08 -08001313 llvm::GlobalVariable * BuildClassMetaData(const std::string &ClassName,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001314 llvm::Constant *IsAGV,
Fariborz Jahanian84394a52009-01-24 21:21:53 +00001315 llvm::Constant *SuperClassGV,
Fariborz Jahaniancf555162009-01-31 00:59:10 +00001316 llvm::Constant *ClassRoGV,
Stephen Hines651f13c2014-04-23 16:59:28 -07001317 bool HiddenVisibility,
1318 bool Weak);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001319
Fariborz Jahanian493dab72009-01-26 21:38:32 +00001320 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001321
Fariborz Jahanian3819a0b2009-01-30 00:46:37 +00001322 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001323
Fariborz Jahanian493dab72009-01-26 21:38:32 +00001324 /// EmitMethodList - Emit the method list for the given
1325 /// implementation. The return value has type MethodListnfABITy.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001326 llvm::Constant *EmitMethodList(Twine Name, StringRef Section,
1327 ArrayRef<llvm::Constant *> Methods);
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00001328 /// EmitIvarList - Emit the ivar list for the given
1329 /// implementation. If ForClass is true the list of class ivars
1330 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1331 /// interface ivars will be emitted. The return value has type
1332 /// IvarListnfABIPtrTy.
1333 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001334
Fariborz Jahanianed157d32009-02-10 20:21:06 +00001335 llvm::Constant *EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
Fariborz Jahanian2fa5a272009-01-28 01:36:42 +00001336 const ObjCIvarDecl *Ivar,
Eli Friedmane5b46662012-11-06 22:15:52 +00001337 unsigned long int offset);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001338
Fariborz Jahanianda320092009-01-29 19:24:30 +00001339 /// GetOrEmitProtocol - Get the protocol object for the given
1340 /// declaration, emitting it if necessary. The return value has type
1341 /// ProtocolPtrTy.
Stephen Hines651f13c2014-04-23 16:59:28 -07001342 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001343
Fariborz Jahanianda320092009-01-29 19:24:30 +00001344 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1345 /// object for the given declaration, emitting it if needed. These
1346 /// forward references will be filled in with empty bodies if no
1347 /// definition is seen. The return value has type ProtocolPtrTy.
Stephen Hines651f13c2014-04-23 16:59:28 -07001348 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001349
Fariborz Jahanianda320092009-01-29 19:24:30 +00001350 /// EmitProtocolList - Generate the list of referenced
1351 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001352 llvm::Constant *EmitProtocolList(Twine Name,
Fariborz Jahanianda320092009-01-29 19:24:30 +00001353 ObjCProtocolDecl::protocol_iterator begin,
Fariborz Jahanian46551122009-02-04 00:22:57 +00001354 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001355
John McCall944c8432011-05-14 03:10:52 +00001356 CodeGen::RValue EmitVTableMessageSend(CodeGen::CodeGenFunction &CGF,
1357 ReturnValueSlot Return,
1358 QualType ResultType,
1359 Selector Sel,
1360 llvm::Value *Receiver,
1361 QualType Arg0Ty,
1362 bool IsSuper,
1363 const CallArgList &CallArgs,
1364 const ObjCMethodDecl *Method);
Fariborz Jahanian6f40e222011-05-17 22:21:16 +00001365
Daniel Dunbar5a7379a2009-03-01 04:40:10 +00001366 /// GetClassGlobal - Return the global variable for the Objective-C
1367 /// class of the given name.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001368 llvm::GlobalVariable *GetClassGlobal(StringRef Name,
Stephen Hines651f13c2014-04-23 16:59:28 -07001369 bool Weak = false) override;
1370
Fariborz Jahanian0e81f4b2009-02-05 20:41:40 +00001371 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
Daniel Dunbar11394522009-04-18 08:51:00 +00001372 /// for the given class reference.
John McCallbd7370a2013-02-28 19:01:20 +00001373 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar11394522009-04-18 08:51:00 +00001374 const ObjCInterfaceDecl *ID);
John McCallf85e1932011-06-15 23:02:42 +00001375
John McCallbd7370a2013-02-28 19:01:20 +00001376 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
Stephen Hines176edba2014-12-01 14:53:08 -08001377 IdentifierInfo *II, bool Weak,
1378 const ObjCInterfaceDecl *ID);
Stephen Hines651f13c2014-04-23 16:59:28 -07001379
1380 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001381
Daniel Dunbar11394522009-04-18 08:51:00 +00001382 /// EmitSuperClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1383 /// for the given super class reference.
John McCallbd7370a2013-02-28 19:01:20 +00001384 llvm::Value *EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001385 const ObjCInterfaceDecl *ID);
1386
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00001387 /// EmitMetaClassRef - Return a Value * of the address of _class_t
1388 /// meta-data
John McCallbd7370a2013-02-28 19:01:20 +00001389 llvm::Value *EmitMetaClassRef(CodeGenFunction &CGF,
Stephen Hinesc568f1e2014-07-21 00:47:37 -07001390 const ObjCInterfaceDecl *ID, bool Weak);
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00001391
Fariborz Jahanianed157d32009-02-10 20:21:06 +00001392 /// ObjCIvarOffsetVariable - Returns the ivar offset variable for
1393 /// the given ivar.
1394 ///
Daniel Dunbar5e88bea2009-04-19 00:31:15 +00001395 llvm::GlobalVariable * ObjCIvarOffsetVariable(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001396 const ObjCInterfaceDecl *ID,
1397 const ObjCIvarDecl *Ivar);
1398
Fariborz Jahanian26cc89f2009-02-11 20:51:17 +00001399 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1400 /// for the given selector.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001401 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1402 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbare588b992009-03-01 04:46:24 +00001403
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00001404 /// GetInterfaceEHType - Get the cached ehtype for the given Objective-C
Daniel Dunbare588b992009-03-01 04:46:24 +00001405 /// interface. The return value has type EHTypePtrTy.
John McCall5a180392010-07-24 00:37:23 +00001406 llvm::Constant *GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00001407 bool ForDefinition);
Daniel Dunbar6ab187a2009-04-07 05:48:37 +00001408
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001409 StringRef getMetaclassSymbolPrefix() const { return "OBJC_METACLASS_$_"; }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001410
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001411 StringRef getClassSymbolPrefix() const { return "OBJC_CLASS_$_"; }
Daniel Dunbar6ab187a2009-04-07 05:48:37 +00001412
Daniel Dunbar9f89f2b2009-05-03 12:57:56 +00001413 void GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbarb02532a2009-04-19 23:41:48 +00001414 uint32_t &InstanceStart,
1415 uint32_t &InstanceSize);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001416
Fariborz Jahanian4523eb02009-05-12 20:06:41 +00001417 // Shamelessly stolen from Analysis/CFRefCount.cpp
Daniel Dunbar74d4b122009-05-15 22:33:15 +00001418 Selector GetNullarySelector(const char* name) const {
Fariborz Jahanian4523eb02009-05-12 20:06:41 +00001419 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1420 return CGM.getContext().Selectors.getSelector(0, &II);
1421 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001422
Daniel Dunbar74d4b122009-05-15 22:33:15 +00001423 Selector GetUnarySelector(const char* name) const {
Fariborz Jahanian4523eb02009-05-12 20:06:41 +00001424 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1425 return CGM.getContext().Selectors.getSelector(1, &II);
1426 }
Daniel Dunbarb02532a2009-04-19 23:41:48 +00001427
Daniel Dunbar74d4b122009-05-15 22:33:15 +00001428 /// ImplementationIsNonLazy - Check whether the given category or
1429 /// class implementation is "non-lazy".
Fariborz Jahanianecfbdcb2009-05-21 01:03:45 +00001430 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const;
Daniel Dunbar74d4b122009-05-15 22:33:15 +00001431
Saleem Abdulrasool961f5702013-02-17 04:03:34 +00001432 bool IsIvarOffsetKnownIdempotent(const CodeGen::CodeGenFunction &CGF,
Saleem Abdulrasool961f5702013-02-17 04:03:34 +00001433 const ObjCIvarDecl *IV) {
Stephen Hines651f13c2014-04-23 16:59:28 -07001434 // Annotate the load as an invariant load iff inside an instance method
1435 // and ivar belongs to instance method's class and one of its super class.
1436 // This check is needed because the ivar offset is a lazily
Saleem Abdulrasool961f5702013-02-17 04:03:34 +00001437 // initialised value that may depend on objc_msgSend to perform a fixup on
1438 // the first message dispatch.
1439 //
1440 // An additional opportunity to mark the load as invariant arises when the
1441 // base of the ivar access is a parameter to an Objective C method.
1442 // However, because the parameters are not available in the current
1443 // interface, we cannot perform this check.
Stephen Hines651f13c2014-04-23 16:59:28 -07001444 if (const ObjCMethodDecl *MD =
1445 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurFuncDecl))
1446 if (MD->isInstanceMethod())
1447 if (const ObjCInterfaceDecl *ID = MD->getClassInterface())
1448 return IV->getContainingInterface()->isSuperClassOf(ID);
Saleem Abdulrasool961f5702013-02-17 04:03:34 +00001449 return false;
1450 }
1451
Fariborz Jahanianee0af742009-01-21 22:04:16 +00001452public:
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00001453 CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm);
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00001454 // FIXME. All stubs for now!
Stephen Hines651f13c2014-04-23 16:59:28 -07001455 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001456
Stephen Hines651f13c2014-04-23 16:59:28 -07001457 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1458 ReturnValueSlot Return,
1459 QualType ResultType, Selector Sel,
1460 llvm::Value *Receiver,
1461 const CallArgList &CallArgs,
1462 const ObjCInterfaceDecl *Class,
1463 const ObjCMethodDecl *Method) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001464
Stephen Hines651f13c2014-04-23 16:59:28 -07001465 CodeGen::RValue
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00001466 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Stephen Hines651f13c2014-04-23 16:59:28 -07001467 ReturnValueSlot Return, QualType ResultType,
1468 Selector Sel, const ObjCInterfaceDecl *Class,
1469 bool isCategoryImpl, llvm::Value *Receiver,
1470 bool IsClassMessage, const CallArgList &CallArgs,
1471 const ObjCMethodDecl *Method) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001472
Stephen Hines651f13c2014-04-23 16:59:28 -07001473 llvm::Value *GetClass(CodeGenFunction &CGF,
1474 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001475
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001476 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override
1477 { return EmitSelector(CGF, Sel); }
1478 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override
1479 { return EmitSelectorAddr(CGF, Sel); }
Fariborz Jahaniandf9ccc62009-05-05 21:36:57 +00001480
1481 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1482 /// untyped one.
Stephen Hines651f13c2014-04-23 16:59:28 -07001483 llvm::Value *GetSelector(CodeGenFunction &CGF,
1484 const ObjCMethodDecl *Method) override
John McCallbd7370a2013-02-28 19:01:20 +00001485 { return EmitSelector(CGF, Method->getSelector()); }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001486
Stephen Hines651f13c2014-04-23 16:59:28 -07001487 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001488
Stephen Hines651f13c2014-04-23 16:59:28 -07001489 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
David Chisnall29254f42012-01-31 18:59:20 +00001490
Stephen Hines651f13c2014-04-23 16:59:28 -07001491 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall29254f42012-01-31 18:59:20 +00001492
Stephen Hines651f13c2014-04-23 16:59:28 -07001493 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1494 const ObjCProtocolDecl *PD) override;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001495
Stephen Hines651f13c2014-04-23 16:59:28 -07001496 llvm::Constant *GetEHType(QualType T) override;
John McCall5a180392010-07-24 00:37:23 +00001497
Stephen Hines651f13c2014-04-23 16:59:28 -07001498 llvm::Constant *GetPropertyGetFunction() override {
Chris Lattner72db6c32009-04-22 02:44:54 +00001499 return ObjCTypes.getGetPropertyFn();
Fariborz Jahanianf63aa3f2009-02-10 19:02:04 +00001500 }
Stephen Hines651f13c2014-04-23 16:59:28 -07001501 llvm::Constant *GetPropertySetFunction() override {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001502 return ObjCTypes.getSetPropertyFn();
Fariborz Jahanianf63aa3f2009-02-10 19:02:04 +00001503 }
Stephen Hines651f13c2014-04-23 16:59:28 -07001504
1505 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1506 bool copy) override {
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001507 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
1508 }
Stephen Hines651f13c2014-04-23 16:59:28 -07001509
1510 llvm::Constant *GetSetStructFunction() override {
David Chisnall8fac25d2010-12-26 22:13:16 +00001511 return ObjCTypes.getCopyStructFn();
1512 }
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001513
Stephen Hines651f13c2014-04-23 16:59:28 -07001514 llvm::Constant *GetGetStructFunction() override {
Fariborz Jahanian6cc59062010-04-12 18:18:10 +00001515 return ObjCTypes.getCopyStructFn();
1516 }
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001517
Stephen Hines651f13c2014-04-23 16:59:28 -07001518 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnalld397cfe2012-12-17 18:54:24 +00001519 return ObjCTypes.getCppAtomicObjectFunction();
1520 }
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001521
Stephen Hines651f13c2014-04-23 16:59:28 -07001522 llvm::Constant *GetCppAtomicObjectGetFunction() override {
Fariborz Jahaniane3173022012-01-06 18:07:23 +00001523 return ObjCTypes.getCppAtomicObjectFunction();
1524 }
Stephen Hines651f13c2014-04-23 16:59:28 -07001525
1526 llvm::Constant *EnumerationMutationFunction() override {
Chris Lattner72db6c32009-04-22 02:44:54 +00001527 return ObjCTypes.getEnumerationMutationFn();
Daniel Dunbar28ed0842009-02-16 18:48:45 +00001528 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001529
Stephen Hines651f13c2014-04-23 16:59:28 -07001530 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1531 const ObjCAtTryStmt &S) override;
1532 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1533 const ObjCAtSynchronizedStmt &S) override;
1534 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1535 bool ClearInsertionPoint=true) override;
1536 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001537 Address AddrWeakObj) override;
Stephen Hines651f13c2014-04-23 16:59:28 -07001538 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001539 llvm::Value *src, Address edst) override;
Stephen Hines651f13c2014-04-23 16:59:28 -07001540 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001541 llvm::Value *src, Address dest,
Stephen Hines651f13c2014-04-23 16:59:28 -07001542 bool threadlocal = false) override;
1543 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001544 llvm::Value *src, Address dest,
Stephen Hines651f13c2014-04-23 16:59:28 -07001545 llvm::Value *ivarOffset) override;
1546 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001547 llvm::Value *src, Address dest) override;
Stephen Hines651f13c2014-04-23 16:59:28 -07001548 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001549 Address dest, Address src,
Stephen Hines651f13c2014-04-23 16:59:28 -07001550 llvm::Value *size) override;
1551 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1552 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1553 unsigned CVRQualifiers) override;
1554 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1555 const ObjCInterfaceDecl *Interface,
1556 const ObjCIvarDecl *Ivar) override;
Fariborz Jahanianee0af742009-01-21 22:04:16 +00001557};
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001558
1559/// A helper class for performing the null-initialization of a return
1560/// value.
1561struct NullReturnState {
1562 llvm::BasicBlock *NullBB;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001563 NullReturnState() : NullBB(nullptr) {}
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001564
John McCall06098582013-02-12 05:53:35 +00001565 /// Perform a null-check of the given receiver.
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001566 void init(CodeGenFunction &CGF, llvm::Value *receiver) {
John McCall06098582013-02-12 05:53:35 +00001567 // Make blocks for the null-receiver and call edges.
1568 NullBB = CGF.createBasicBlock("msgSend.null-receiver");
1569 llvm::BasicBlock *callBB = CGF.createBasicBlock("msgSend.call");
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001570
1571 // Check for a null receiver and, if there is one, jump to the
John McCall06098582013-02-12 05:53:35 +00001572 // null-receiver block. There's no point in trying to avoid it:
1573 // we're always going to put *something* there, because otherwise
1574 // we shouldn't have done this null-check in the first place.
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001575 llvm::Value *isNull = CGF.Builder.CreateIsNull(receiver);
1576 CGF.Builder.CreateCondBr(isNull, NullBB, callBB);
1577
1578 // Otherwise, start performing the call.
1579 CGF.EmitBlock(callBB);
1580 }
1581
John McCall06098582013-02-12 05:53:35 +00001582 /// Complete the null-return operation. It is valid to call this
1583 /// regardless of whether 'init' has been called.
Fariborz Jahanian3c267e62012-01-30 21:40:37 +00001584 RValue complete(CodeGenFunction &CGF, RValue result, QualType resultType,
1585 const CallArgList &CallArgs,
1586 const ObjCMethodDecl *Method) {
John McCall06098582013-02-12 05:53:35 +00001587 // If we never had to do a null-check, just use the raw result.
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001588 if (!NullBB) return result;
John McCall06098582013-02-12 05:53:35 +00001589
1590 // The continuation block. This will be left null if we don't have an
1591 // IP, which can happen if the method we're calling is marked noreturn.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001592 llvm::BasicBlock *contBB = nullptr;
1593
John McCall06098582013-02-12 05:53:35 +00001594 // Finish the call path.
1595 llvm::BasicBlock *callBB = CGF.Builder.GetInsertBlock();
1596 if (callBB) {
1597 contBB = CGF.createBasicBlock("msgSend.cont");
1598 CGF.Builder.CreateBr(contBB);
Fariborz Jahanian3c267e62012-01-30 21:40:37 +00001599 }
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001600
John McCall06098582013-02-12 05:53:35 +00001601 // Okay, start emitting the null-receiver block.
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001602 CGF.EmitBlock(NullBB);
Fariborz Jahanian3c267e62012-01-30 21:40:37 +00001603
John McCall06098582013-02-12 05:53:35 +00001604 // Release any consumed arguments we've got.
Fariborz Jahanian3c267e62012-01-30 21:40:37 +00001605 if (Method) {
1606 CallArgList::const_iterator I = CallArgs.begin();
1607 for (ObjCMethodDecl::param_const_iterator i = Method->param_begin(),
1608 e = Method->param_end(); i != e; ++i, ++I) {
1609 const ParmVarDecl *ParamDecl = (*i);
1610 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1611 RValue RV = I->RV;
1612 assert(RV.isScalar() &&
1613 "NullReturnState::complete - arg not on object");
John McCall5b07e802013-03-13 03:10:54 +00001614 CGF.EmitARCRelease(RV.getScalarVal(), ARCImpreciseLifetime);
Fariborz Jahanian3c267e62012-01-30 21:40:37 +00001615 }
1616 }
1617 }
John McCall06098582013-02-12 05:53:35 +00001618
1619 // The phi code below assumes that we haven't needed any control flow yet.
1620 assert(CGF.Builder.GetInsertBlock() == NullBB);
1621
1622 // If we've got a void return, just jump to the continuation block.
1623 if (result.isScalar() && resultType->isVoidType()) {
1624 // No jumps required if the message-send was noreturn.
1625 if (contBB) CGF.EmitBlock(contBB);
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001626 return result;
1627 }
1628
John McCall06098582013-02-12 05:53:35 +00001629 // If we've got a scalar return, build a phi.
1630 if (result.isScalar()) {
1631 // Derive the null-initialization value.
1632 llvm::Constant *null = CGF.CGM.EmitNullConstant(resultType);
1633
1634 // If no join is necessary, just flow out.
1635 if (!contBB) return RValue::get(null);
1636
1637 // Otherwise, build a phi.
1638 CGF.EmitBlock(contBB);
1639 llvm::PHINode *phi = CGF.Builder.CreatePHI(null->getType(), 2);
1640 phi->addIncoming(result.getScalarVal(), callBB);
1641 phi->addIncoming(null, NullBB);
1642 return RValue::get(phi);
1643 }
1644
1645 // If we've got an aggregate return, null the buffer out.
1646 // FIXME: maybe we should be doing things differently for all the
1647 // cases where the ABI has us returning (1) non-agg values in
1648 // memory or (2) agg values in registers.
1649 if (result.isAggregate()) {
1650 assert(result.isAggregate() && "null init of non-aggregate result?");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001651 CGF.EmitNullInitialization(result.getAggregateAddress(), resultType);
John McCall06098582013-02-12 05:53:35 +00001652 if (contBB) CGF.EmitBlock(contBB);
1653 return result;
1654 }
1655
1656 // Complex types.
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001657 CGF.EmitBlock(contBB);
John McCall06098582013-02-12 05:53:35 +00001658 CodeGenFunction::ComplexPairTy callResult = result.getComplexVal();
1659
1660 // Find the scalar type and its zero value.
1661 llvm::Type *scalarTy = callResult.first->getType();
1662 llvm::Constant *scalarZero = llvm::Constant::getNullValue(scalarTy);
1663
1664 // Build phis for both coordinates.
1665 llvm::PHINode *real = CGF.Builder.CreatePHI(scalarTy, 2);
1666 real->addIncoming(callResult.first, callBB);
1667 real->addIncoming(scalarZero, NullBB);
1668 llvm::PHINode *imag = CGF.Builder.CreatePHI(scalarTy, 2);
1669 imag->addIncoming(callResult.second, callBB);
1670 imag->addIncoming(scalarZero, NullBB);
1671 return RValue::getComplex(real, imag);
Fariborz Jahanian4e1524b2012-01-29 20:27:13 +00001672 }
1673};
1674
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001675} // end anonymous namespace
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00001676
1677/* *** Helper Functions *** */
1678
1679/// getConstantGEP() - Help routine to construct simple GEPs.
Owen Andersona1cf15f2009-07-14 23:10:40 +00001680static llvm::Constant *getConstantGEP(llvm::LLVMContext &VMContext,
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07001681 llvm::GlobalVariable *C, unsigned idx0,
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00001682 unsigned idx1) {
1683 llvm::Value *Idxs[] = {
Owen Anderson0032b272009-08-13 21:57:51 +00001684 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx0),
1685 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx1)
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00001686 };
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07001687 return llvm::ConstantExpr::getGetElementPtr(C->getValueType(), C, Idxs);
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00001688}
1689
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00001690/// hasObjCExceptionAttribute - Return true if this class or any super
1691/// class has the __objc_exception__ attribute.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001692static bool hasObjCExceptionAttribute(ASTContext &Context,
Douglas Gregor68584ed2009-06-18 16:11:24 +00001693 const ObjCInterfaceDecl *OID) {
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +00001694 if (OID->hasAttr<ObjCExceptionAttr>())
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00001695 return true;
1696 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
Douglas Gregor68584ed2009-06-18 16:11:24 +00001697 return hasObjCExceptionAttribute(Context, Super);
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00001698 return false;
1699}
1700
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00001701/* *** CGObjCMac Public Interface *** */
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001702
Fariborz Jahanianee0af742009-01-21 22:04:16 +00001703CGObjCMac::CGObjCMac(CodeGen::CodeGenModule &cgm) : CGObjCCommonMac(cgm),
Mike Stump1eb44332009-09-09 15:08:12 +00001704 ObjCTypes(cgm) {
Fariborz Jahanianee0af742009-01-21 22:04:16 +00001705 ObjCABI = 1;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001706 EmitImageInfo();
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001707}
1708
Daniel Dunbarddb2a3d2008-08-16 00:25:02 +00001709/// GetClass - Return a reference to the class for the given interface
1710/// decl.
John McCallbd7370a2013-02-28 19:01:20 +00001711llvm::Value *CGObjCMac::GetClass(CodeGenFunction &CGF,
Daniel Dunbar27f9d772008-08-21 04:36:09 +00001712 const ObjCInterfaceDecl *ID) {
John McCallbd7370a2013-02-28 19:01:20 +00001713 return EmitClassRef(CGF, ID);
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001714}
1715
1716/// GetSelector - Return the pointer to the unique'd string for this selector.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001717llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1718 return EmitSelector(CGF, Sel);
1719}
1720Address CGObjCMac::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1721 return EmitSelectorAddr(CGF, Sel);
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001722}
John McCallbd7370a2013-02-28 19:01:20 +00001723llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, const ObjCMethodDecl
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001724 *Method) {
John McCallbd7370a2013-02-28 19:01:20 +00001725 return EmitSelector(CGF, Method->getSelector());
Fariborz Jahaniandf9ccc62009-05-05 21:36:57 +00001726}
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001727
Fariborz Jahaniancf5abc72011-06-23 19:00:08 +00001728llvm::Constant *CGObjCMac::GetEHType(QualType T) {
Fariborz Jahanian9d96bce2011-06-22 20:21:51 +00001729 if (T->isObjCIdType() ||
1730 T->isObjCQualifiedIdType()) {
1731 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor01a4cf12011-08-11 20:58:55 +00001732 CGM.getContext().getObjCIdRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian9d96bce2011-06-22 20:21:51 +00001733 }
Fariborz Jahaniancf5abc72011-06-23 19:00:08 +00001734 if (T->isObjCClassType() ||
1735 T->isObjCQualifiedClassType()) {
1736 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor01a4cf12011-08-11 20:58:55 +00001737 CGM.getContext().getObjCClassRedefinitionType(), /*ForEH=*/true);
Fariborz Jahaniancf5abc72011-06-23 19:00:08 +00001738 }
1739 if (T->isObjCObjectPointerType())
1740 return CGM.GetAddrOfRTTIDescriptor(T, /*ForEH=*/true);
1741
John McCall5a180392010-07-24 00:37:23 +00001742 llvm_unreachable("asking for catch type for ObjC type in fragile runtime");
John McCall5a180392010-07-24 00:37:23 +00001743}
1744
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00001745/// Generate a constant CFString object.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001746/*
1747 struct __builtin_CFString {
1748 const int *isa; // point to __CFConstantStringClassReference
1749 int flags;
1750 const char *str;
1751 long length;
1752 };
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00001753*/
1754
Fariborz Jahanian33e982b2010-04-22 20:26:39 +00001755/// or Generate a constant NSString object.
1756/*
1757 struct __builtin_NSString {
1758 const int *isa; // point to __NSConstantStringClassReference
1759 const char *str;
1760 unsigned int length;
1761 };
1762*/
1763
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001764ConstantAddress CGObjCCommonMac::GenerateConstantString(
David Chisnall0d13f6f2010-01-23 02:40:42 +00001765 const StringLiteral *SL) {
David Blaikie4e4d0842012-03-11 07:00:24 +00001766 return (CGM.getLangOpts().NoConstantCFStrings == 0 ?
Fariborz Jahanian33e982b2010-04-22 20:26:39 +00001767 CGM.GetAddrOfConstantCFString(SL) :
Fariborz Jahanian4c733072010-10-19 17:19:29 +00001768 CGM.GetAddrOfConstantString(SL));
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001769}
1770
Ted Kremenekebcb57a2012-03-06 20:05:56 +00001771enum {
1772 kCFTaggedObjectID_Integer = (1 << 1) + 1
1773};
1774
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001775/// Generates a message send where the super is the receiver. This is
1776/// a message send to self with special delivery semantics indicating
1777/// which class's method should be called.
Daniel Dunbar8f2926b2008-08-23 03:46:30 +00001778CodeGen::RValue
1779CGObjCMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCallef072fd2010-05-22 01:48:05 +00001780 ReturnValueSlot Return,
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +00001781 QualType ResultType,
1782 Selector Sel,
Daniel Dunbarf56f1912008-08-25 08:19:24 +00001783 const ObjCInterfaceDecl *Class,
Fariborz Jahanian7ce77922009-02-28 20:07:56 +00001784 bool isCategoryImpl,
Daniel Dunbarf56f1912008-08-25 08:19:24 +00001785 llvm::Value *Receiver,
Daniel Dunbar19cd87e2008-08-30 03:02:31 +00001786 bool IsClassMessage,
Daniel Dunbard6c93d72009-09-17 04:01:22 +00001787 const CodeGen::CallArgList &CallArgs,
1788 const ObjCMethodDecl *Method) {
Daniel Dunbare8b470d2008-08-23 04:28:29 +00001789 // Create and init a super structure; this is a (receiver, class)
1790 // pair we will pass to objc_msgSendSuper.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001791 Address ObjCSuper =
1792 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
1793 "objc_super");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001794 llvm::Value *ReceiverAsObject =
Daniel Dunbare8b470d2008-08-23 04:28:29 +00001795 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07001796 CGF.Builder.CreateStore(
1797 ReceiverAsObject,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001798 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbare8b470d2008-08-23 04:28:29 +00001799
Daniel Dunbarf56f1912008-08-25 08:19:24 +00001800 // If this is a class message the metaclass is passed as the target.
1801 llvm::Value *Target;
1802 if (IsClassMessage) {
Fariborz Jahanian7ce77922009-02-28 20:07:56 +00001803 if (isCategoryImpl) {
1804 // Message sent to 'super' in a class method defined in a category
1805 // implementation requires an odd treatment.
1806 // If we are in a class method, we must retrieve the
1807 // _metaclass_ for the current class, pointed at by
1808 // the class's "isa" pointer. The following assumes that
1809 // isa" is the first ivar in a class (which it must be).
John McCallbd7370a2013-02-28 19:01:20 +00001810 Target = EmitClassRef(CGF, Class->getSuperClass());
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07001811 Target = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, Target, 0);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001812 Target = CGF.Builder.CreateAlignedLoad(Target, CGF.getPointerAlign());
Mike Stumpb3589f42009-07-30 22:28:39 +00001813 } else {
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07001814 llvm::Constant *MetaClassPtr = EmitMetaClassRef(Class);
1815 llvm::Value *SuperPtr =
1816 CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, MetaClassPtr, 1);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001817 llvm::Value *Super =
1818 CGF.Builder.CreateAlignedLoad(SuperPtr, CGF.getPointerAlign());
Fariborz Jahanian7ce77922009-02-28 20:07:56 +00001819 Target = Super;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001820 }
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07001821 } else if (isCategoryImpl)
John McCallbd7370a2013-02-28 19:01:20 +00001822 Target = EmitClassRef(CGF, Class->getSuperClass());
Fariborz Jahanian182f2682009-11-14 02:18:31 +00001823 else {
Fariborz Jahanianb0069ee2009-11-12 20:14:24 +00001824 llvm::Value *ClassPtr = EmitSuperClassRef(Class);
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07001825 ClassPtr = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, ClassPtr, 1);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001826 Target = CGF.Builder.CreateAlignedLoad(ClassPtr, CGF.getPointerAlign());
Daniel Dunbarf56f1912008-08-25 08:19:24 +00001827 }
Mike Stumpf5408fe2009-05-16 07:57:57 +00001828 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
1829 // ObjCTypes types.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001830 llvm::Type *ClassTy =
Daniel Dunbar19cd87e2008-08-30 03:02:31 +00001831 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00001832 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001833 CGF.Builder.CreateStore(Target,
1834 CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
John McCall944c8432011-05-14 03:10:52 +00001835 return EmitMessageSend(CGF, Return, ResultType,
John McCallbd7370a2013-02-28 19:01:20 +00001836 EmitSelector(CGF, Sel),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001837 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
1838 true, CallArgs, Method, Class, ObjCTypes);
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001839}
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001840
1841/// Generate code for a message send expression.
Daniel Dunbar8f2926b2008-08-23 03:46:30 +00001842CodeGen::RValue CGObjCMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCallef072fd2010-05-22 01:48:05 +00001843 ReturnValueSlot Return,
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +00001844 QualType ResultType,
1845 Selector Sel,
Daniel Dunbarf56f1912008-08-25 08:19:24 +00001846 llvm::Value *Receiver,
Fariborz Jahaniandf9ccc62009-05-05 21:36:57 +00001847 const CallArgList &CallArgs,
David Chisnallc6cd5fd2010-04-28 19:33:36 +00001848 const ObjCInterfaceDecl *Class,
Fariborz Jahaniandf9ccc62009-05-05 21:36:57 +00001849 const ObjCMethodDecl *Method) {
John McCall944c8432011-05-14 03:10:52 +00001850 return EmitMessageSend(CGF, Return, ResultType,
John McCallbd7370a2013-02-28 19:01:20 +00001851 EmitSelector(CGF, Sel),
John McCall944c8432011-05-14 03:10:52 +00001852 Receiver, CGF.getContext().getObjCIdType(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001853 false, CallArgs, Method, Class, ObjCTypes);
1854}
1855
1856static bool isWeakLinkedClass(const ObjCInterfaceDecl *ID) {
1857 do {
1858 if (ID->isWeakImported())
1859 return true;
1860 } while ((ID = ID->getSuperClass()));
1861
1862 return false;
Daniel Dunbar14c80b72008-08-23 09:25:55 +00001863}
1864
Daniel Dunbard6c93d72009-09-17 04:01:22 +00001865CodeGen::RValue
John McCall944c8432011-05-14 03:10:52 +00001866CGObjCCommonMac::EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1867 ReturnValueSlot Return,
1868 QualType ResultType,
1869 llvm::Value *Sel,
1870 llvm::Value *Arg0,
1871 QualType Arg0Ty,
1872 bool IsSuper,
1873 const CallArgList &CallArgs,
1874 const ObjCMethodDecl *Method,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001875 const ObjCInterfaceDecl *ClassReceiver,
John McCall944c8432011-05-14 03:10:52 +00001876 const ObjCCommonTypesHelper &ObjCTypes) {
Daniel Dunbar19cd87e2008-08-30 03:02:31 +00001877 CallArgList ActualArgs;
Fariborz Jahaniand019d962009-04-24 21:07:43 +00001878 if (!IsSuper)
Benjamin Kramer578faa82011-09-27 21:06:10 +00001879 Arg0 = CGF.Builder.CreateBitCast(Arg0, ObjCTypes.ObjectPtrTy);
Eli Friedman04c9a492011-05-02 17:57:46 +00001880 ActualArgs.add(RValue::get(Arg0), Arg0Ty);
1881 ActualArgs.add(RValue::get(Sel), CGF.getContext().getObjCSelType());
John McCallf85e1932011-06-15 23:02:42 +00001882 ActualArgs.addFrom(CallArgs);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001883
John McCallde5d3c72012-02-17 03:33:10 +00001884 // If we're calling a method, use the formal signature.
1885 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001886
Anders Carlsson7e70fb22010-06-21 20:59:55 +00001887 if (Method)
Stephen Hines651f13c2014-04-23 16:59:28 -07001888 assert(CGM.getContext().getCanonicalType(Method->getReturnType()) ==
1889 CGM.getContext().getCanonicalType(ResultType) &&
Anders Carlsson7e70fb22010-06-21 20:59:55 +00001890 "Result type mismatch!");
1891
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001892 bool ReceiverCanBeNull = true;
1893
1894 // Super dispatch assumes that self is non-null; even the messenger
1895 // doesn't have a null check internally.
1896 if (IsSuper) {
1897 ReceiverCanBeNull = false;
1898
1899 // If this is a direct dispatch of a class method, check whether the class,
1900 // or anything in its hierarchy, was weak-linked.
1901 } else if (ClassReceiver && Method && Method->isClassMethod()) {
1902 ReceiverCanBeNull = isWeakLinkedClass(ClassReceiver);
1903
1904 // If we're emitting a method, and self is const (meaning just ARC, for now),
1905 // and the receiver is a load of self, then self is a valid object.
1906 } else if (auto CurMethod =
1907 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl)) {
1908 auto Self = CurMethod->getSelfDecl();
1909 if (Self->getType().isConstQualified()) {
1910 if (auto LI = dyn_cast<llvm::LoadInst>(Arg0->stripPointerCasts())) {
1911 llvm::Value *SelfAddr = CGF.GetAddrOfLocalVar(Self).getPointer();
1912 if (SelfAddr == LI->getPointerOperand()) {
1913 ReceiverCanBeNull = false;
1914 }
1915 }
1916 }
1917 }
1918
John McCallcba681a2011-05-14 21:12:11 +00001919 NullReturnState nullReturn;
1920
Stephen Hines6bcf27b2014-05-29 04:14:42 -07001921 llvm::Constant *Fn = nullptr;
Stephen Hines651f13c2014-04-23 16:59:28 -07001922 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001923 if (ReceiverCanBeNull) nullReturn.init(CGF, Arg0);
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +00001924 Fn = (ObjCABI == 2) ? ObjCTypes.getSendStretFn2(IsSuper)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001925 : ObjCTypes.getSendStretFn(IsSuper);
Daniel Dunbardacf9dd2010-07-14 23:39:36 +00001926 } else if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1927 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFpretFn2(IsSuper)
1928 : ObjCTypes.getSendFpretFn(IsSuper);
Anders Carlssoneea64802011-10-31 16:27:11 +00001929 } else if (CGM.ReturnTypeUsesFP2Ret(ResultType)) {
1930 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFp2RetFn2(IsSuper)
1931 : ObjCTypes.getSendFp2retFn(IsSuper);
Daniel Dunbar5669e572008-10-17 03:24:53 +00001932 } else {
Stephen Hines651f13c2014-04-23 16:59:28 -07001933 // arm64 uses objc_msgSend for stret methods and yet null receiver check
1934 // must be made for it.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001935 if (ReceiverCanBeNull && CGM.ReturnTypeUsesSRet(MSI.CallInfo))
Stephen Hines651f13c2014-04-23 16:59:28 -07001936 nullReturn.init(CGF, Arg0);
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +00001937 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFn2(IsSuper)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00001938 : ObjCTypes.getSendFn(IsSuper);
Daniel Dunbar5669e572008-10-17 03:24:53 +00001939 }
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001940
1941 // Emit a null-check if there's a consumed argument other than the receiver.
1942 bool RequiresNullCheck = false;
1943 if (ReceiverCanBeNull && CGM.getLangOpts().ObjCAutoRefCount && Method) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07001944 for (const auto *ParamDecl : Method->parameters()) {
Fariborz Jahanian3c267e62012-01-30 21:40:37 +00001945 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1946 if (!nullReturn.NullBB)
1947 nullReturn.init(CGF, Arg0);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001948 RequiresNullCheck = true;
Fariborz Jahanian3c267e62012-01-30 21:40:37 +00001949 break;
1950 }
1951 }
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001952 }
Fariborz Jahanian3c267e62012-01-30 21:40:37 +00001953
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001954 llvm::Instruction *CallSite;
John McCallde5d3c72012-02-17 03:33:10 +00001955 Fn = llvm::ConstantExpr::getBitCast(Fn, MSI.MessengerType);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001956 RValue rvalue = CGF.EmitCall(MSI.CallInfo, Fn, Return, ActualArgs,
1957 CGCalleeInfo(), &CallSite);
1958
1959 // Mark the call as noreturn if the method is marked noreturn and the
1960 // receiver cannot be null.
1961 if (Method && Method->hasAttr<NoReturnAttr>() && !ReceiverCanBeNull) {
1962 llvm::CallSite(CallSite).setDoesNotReturn();
1963 }
1964
Fariborz Jahanian3c267e62012-01-30 21:40:37 +00001965 return nullReturn.complete(CGF, rvalue, ResultType, CallArgs,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001966 RequiresNullCheck ? Method : nullptr);
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001967}
1968
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001969static Qualifiers::GC GetGCAttrTypeForType(ASTContext &Ctx, QualType FQT,
1970 bool pointee = false) {
1971 // Note that GC qualification applies recursively to C pointer types
1972 // that aren't otherwise decorated. This is weird, but it's probably
1973 // an intentional workaround to the unreliable placement of GC qualifiers.
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00001974 if (FQT.isObjCGCStrong())
1975 return Qualifiers::Strong;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001976
1977 if (FQT.isObjCGCWeak())
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00001978 return Qualifiers::Weak;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001979
1980 if (auto ownership = FQT.getObjCLifetime()) {
1981 // Ownership does not apply recursively to C pointer types.
1982 if (pointee) return Qualifiers::GCNone;
1983 switch (ownership) {
1984 case Qualifiers::OCL_Weak: return Qualifiers::Weak;
1985 case Qualifiers::OCL_Strong: return Qualifiers::Strong;
1986 case Qualifiers::OCL_ExplicitNone: return Qualifiers::GCNone;
1987 case Qualifiers::OCL_Autoreleasing: llvm_unreachable("autoreleasing ivar?");
1988 case Qualifiers::OCL_None: llvm_unreachable("known nonzero");
1989 }
1990 llvm_unreachable("bad objc ownership");
1991 }
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00001992
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001993 // Treat unqualified retainable pointers as strong.
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00001994 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
1995 return Qualifiers::Strong;
1996
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08001997 // Walk into C pointer types, but only in GC.
1998 if (Ctx.getLangOpts().getGC() != LangOptions::NonGC) {
1999 if (const PointerType *PT = FQT->getAs<PointerType>())
2000 return GetGCAttrTypeForType(Ctx, PT->getPointeeType(), /*pointee*/ true);
2001 }
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00002002
2003 return Qualifiers::GCNone;
2004}
2005
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002006namespace {
2007 struct IvarInfo {
2008 CharUnits Offset;
2009 uint64_t SizeInWords;
2010 IvarInfo(CharUnits offset, uint64_t sizeInWords)
2011 : Offset(offset), SizeInWords(sizeInWords) {}
2012
2013 // Allow sorting based on byte pos.
2014 bool operator<(const IvarInfo &other) const {
2015 return Offset < other.Offset;
2016 }
2017 };
2018
2019 /// A helper class for building GC layout strings.
2020 class IvarLayoutBuilder {
2021 CodeGenModule &CGM;
2022
2023 /// The start of the layout. Offsets will be relative to this value,
2024 /// and entries less than this value will be silently discarded.
2025 CharUnits InstanceBegin;
2026
2027 /// The end of the layout. Offsets will never exceed this value.
2028 CharUnits InstanceEnd;
2029
2030 /// Whether we're generating the strong layout or the weak layout.
2031 bool ForStrongLayout;
2032
2033 /// Whether the offsets in IvarsInfo might be out-of-order.
2034 bool IsDisordered = false;
2035
2036 llvm::SmallVector<IvarInfo, 8> IvarsInfo;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002037
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002038 public:
2039 IvarLayoutBuilder(CodeGenModule &CGM, CharUnits instanceBegin,
2040 CharUnits instanceEnd, bool forStrongLayout)
2041 : CGM(CGM), InstanceBegin(instanceBegin), InstanceEnd(instanceEnd),
2042 ForStrongLayout(forStrongLayout) {
2043 }
2044
2045 void visitRecord(const RecordType *RT, CharUnits offset);
2046
2047 template <class Iterator, class GetOffsetFn>
2048 void visitAggregate(Iterator begin, Iterator end,
2049 CharUnits aggrOffset,
2050 const GetOffsetFn &getOffset);
2051
2052 void visitField(const FieldDecl *field, CharUnits offset);
2053
2054 /// Add the layout of a block implementation.
2055 void visitBlock(const CGBlockInfo &blockInfo);
2056
2057 /// Is there any information for an interesting bitmap?
2058 bool hasBitmapData() const { return !IvarsInfo.empty(); }
2059
2060 llvm::Constant *buildBitmap(CGObjCCommonMac &CGObjC,
2061 llvm::SmallVectorImpl<unsigned char> &buffer);
2062
2063 static void dump(ArrayRef<unsigned char> buffer) {
2064 const unsigned char *s = buffer.data();
2065 for (unsigned i = 0, e = buffer.size(); i < e; i++)
2066 if (!(s[i] & 0xf0))
2067 printf("0x0%x%s", s[i], s[i] != 0 ? ", " : "");
2068 else
2069 printf("0x%x%s", s[i], s[i] != 0 ? ", " : "");
2070 printf("\n");
2071 }
2072 };
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002073} // end anonymous namespace
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002074
John McCall6b5a61b2011-02-07 10:33:21 +00002075llvm::Constant *CGObjCCommonMac::BuildGCBlockLayout(CodeGenModule &CGM,
2076 const CGBlockInfo &blockInfo) {
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002077
Chris Lattner8b418682012-02-07 00:39:47 +00002078 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002079 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
John McCall6b5a61b2011-02-07 10:33:21 +00002080 return nullPtr;
2081
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002082 IvarLayoutBuilder builder(CGM, CharUnits::Zero(), blockInfo.BlockSize,
2083 /*for strong layout*/ true);
2084
2085 builder.visitBlock(blockInfo);
2086
2087 if (!builder.hasBitmapData())
2088 return nullPtr;
2089
2090 llvm::SmallVector<unsigned char, 32> buffer;
2091 llvm::Constant *C = builder.buildBitmap(*this, buffer);
2092 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
2093 printf("\n block variable layout for block: ");
2094 builder.dump(buffer);
2095 }
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00002096
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002097 return C;
2098}
2099
2100void IvarLayoutBuilder::visitBlock(const CGBlockInfo &blockInfo) {
Fariborz Jahanian81979822010-09-09 00:21:45 +00002101 // __isa is the first field in block descriptor and must assume by runtime's
2102 // convention that it is GC'able.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002103 IvarsInfo.push_back(IvarInfo(CharUnits::Zero(), 1));
John McCall6b5a61b2011-02-07 10:33:21 +00002104
2105 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2106
John McCall6b5a61b2011-02-07 10:33:21 +00002107 // Ignore the optional 'this' capture: C++ objects are not assumed
2108 // to be GC'ed.
2109
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002110 CharUnits lastFieldOffset;
2111
John McCall6b5a61b2011-02-07 10:33:21 +00002112 // Walk the captured variables.
Stephen Hines651f13c2014-04-23 16:59:28 -07002113 for (const auto &CI : blockDecl->captures()) {
2114 const VarDecl *variable = CI.getVariable();
John McCall6b5a61b2011-02-07 10:33:21 +00002115 QualType type = variable->getType();
2116
2117 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2118
2119 // Ignore constant captures.
2120 if (capture.isConstant()) continue;
2121
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002122 CharUnits fieldOffset = capture.getOffset();
2123
2124 // Block fields are not necessarily ordered; if we detect that we're
2125 // adding them out-of-order, make sure we sort later.
2126 if (fieldOffset < lastFieldOffset)
2127 IsDisordered = true;
2128 lastFieldOffset = fieldOffset;
John McCall6b5a61b2011-02-07 10:33:21 +00002129
2130 // __block variables are passed by their descriptor address.
Stephen Hines651f13c2014-04-23 16:59:28 -07002131 if (CI.isByRef()) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002132 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
Fariborz Jahanianc5904b42010-09-11 01:27:29 +00002133 continue;
John McCall6b5a61b2011-02-07 10:33:21 +00002134 }
2135
2136 assert(!type->isArrayType() && "array variable should not be caught");
2137 if (const RecordType *record = type->getAs<RecordType>()) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002138 visitRecord(record, fieldOffset);
Fariborz Jahaniane1a48982010-08-05 21:00:25 +00002139 continue;
2140 }
Fariborz Jahaniana1f024c2010-08-06 16:28:55 +00002141
John McCall6b5a61b2011-02-07 10:33:21 +00002142 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), type);
John McCall6b5a61b2011-02-07 10:33:21 +00002143
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002144 if (GCAttr == Qualifiers::Strong) {
2145 assert(CGM.getContext().getTypeSize(type)
2146 == CGM.getTarget().getPointerWidth(0));
2147 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
2148 }
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00002149 }
Fariborz Jahanian89ecd412010-08-04 16:57:49 +00002150}
2151
Fariborz Jahanianc441cd32012-11-04 18:19:40 +00002152/// getBlockCaptureLifetime - This routine returns life time of the captured
2153/// block variable for the purpose of block layout meta-data generation. FQT is
2154/// the type of the variable captured in the block.
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002155Qualifiers::ObjCLifetime CGObjCCommonMac::getBlockCaptureLifetime(QualType FQT,
2156 bool ByrefLayout) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002157 // If it has an ownership qualifier, we're done.
2158 if (auto lifetime = FQT.getObjCLifetime())
2159 return lifetime;
2160
2161 // If it doesn't, and this is ARC, it has no ownership.
Fariborz Jahanian44fcff92012-11-02 22:51:18 +00002162 if (CGM.getLangOpts().ObjCAutoRefCount)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002163 return Qualifiers::OCL_None;
Fariborz Jahanian44fcff92012-11-02 22:51:18 +00002164
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002165 // In MRC, retainable pointers are owned by non-__block variables.
Fariborz Jahanian44fcff92012-11-02 22:51:18 +00002166 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002167 return ByrefLayout ? Qualifiers::OCL_ExplicitNone : Qualifiers::OCL_Strong;
Fariborz Jahanian44fcff92012-11-02 22:51:18 +00002168
2169 return Qualifiers::OCL_None;
2170}
2171
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002172void CGObjCCommonMac::UpdateRunSkipBlockVars(bool IsByref,
2173 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002174 CharUnits FieldOffset,
2175 CharUnits FieldSize) {
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002176 // __block variables are passed by their descriptor address.
2177 if (IsByref)
2178 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_BYREF, FieldOffset,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002179 FieldSize));
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002180 else if (LifeTime == Qualifiers::OCL_Strong)
2181 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_STRONG, FieldOffset,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002182 FieldSize));
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002183 else if (LifeTime == Qualifiers::OCL_Weak)
2184 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_WEAK, FieldOffset,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002185 FieldSize));
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002186 else if (LifeTime == Qualifiers::OCL_ExplicitNone)
2187 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_UNRETAINED, FieldOffset,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002188 FieldSize));
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002189 else
2190 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_NON_OBJECT_BYTES,
2191 FieldOffset,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002192 FieldSize));
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002193}
2194
2195void CGObjCCommonMac::BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
2196 const RecordDecl *RD,
2197 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002198 CharUnits BytePos, bool &HasUnion,
2199 bool ByrefLayout) {
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002200 bool IsUnion = (RD && RD->isUnion());
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002201 CharUnits MaxUnionSize = CharUnits::Zero();
Stephen Hines6bcf27b2014-05-29 04:14:42 -07002202 const FieldDecl *MaxField = nullptr;
2203 const FieldDecl *LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002204 CharUnits MaxFieldOffset = CharUnits::Zero();
2205 CharUnits LastBitfieldOrUnnamedOffset = CharUnits::Zero();
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002206
2207 if (RecFields.empty())
2208 return;
John McCall64aa4b32013-04-16 22:48:15 +00002209 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002210
2211 for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
2212 const FieldDecl *Field = RecFields[i];
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002213 // Note that 'i' here is actually the field index inside RD of Field,
2214 // although this dependency is hidden.
2215 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002216 CharUnits FieldOffset =
2217 CGM.getContext().toCharUnitsFromBits(RL.getFieldOffset(i));
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002218
2219 // Skip over unnamed or bitfields
2220 if (!Field->getIdentifier() || Field->isBitField()) {
2221 LastFieldBitfieldOrUnnamed = Field;
2222 LastBitfieldOrUnnamedOffset = FieldOffset;
2223 continue;
2224 }
Stephen Hines6bcf27b2014-05-29 04:14:42 -07002225
2226 LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002227 QualType FQT = Field->getType();
2228 if (FQT->isRecordType() || FQT->isUnionType()) {
2229 if (FQT->isUnionType())
2230 HasUnion = true;
2231
2232 BuildRCBlockVarRecordLayout(FQT->getAs<RecordType>(),
2233 BytePos + FieldOffset, HasUnion);
2234 continue;
2235 }
2236
2237 if (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2238 const ConstantArrayType *CArray =
2239 dyn_cast_or_null<ConstantArrayType>(Array);
2240 uint64_t ElCount = CArray->getSize().getZExtValue();
2241 assert(CArray && "only array with known element size is supported");
2242 FQT = CArray->getElementType();
2243 while (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2244 const ConstantArrayType *CArray =
2245 dyn_cast_or_null<ConstantArrayType>(Array);
2246 ElCount *= CArray->getSize().getZExtValue();
2247 FQT = CArray->getElementType();
2248 }
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002249 if (FQT->isRecordType() && ElCount) {
2250 int OldIndex = RunSkipBlockVars.size() - 1;
2251 const RecordType *RT = FQT->getAs<RecordType>();
2252 BuildRCBlockVarRecordLayout(RT, BytePos + FieldOffset,
2253 HasUnion);
2254
2255 // Replicate layout information for each array element. Note that
2256 // one element is already done.
2257 uint64_t ElIx = 1;
2258 for (int FirstIndex = RunSkipBlockVars.size() - 1 ;ElIx < ElCount; ElIx++) {
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002259 CharUnits Size = CGM.getContext().getTypeSizeInChars(RT);
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002260 for (int i = OldIndex+1; i <= FirstIndex; ++i)
2261 RunSkipBlockVars.push_back(
2262 RUN_SKIP(RunSkipBlockVars[i].opcode,
2263 RunSkipBlockVars[i].block_var_bytepos + Size*ElIx,
2264 RunSkipBlockVars[i].block_var_size));
2265 }
2266 continue;
2267 }
2268 }
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002269 CharUnits FieldSize = CGM.getContext().getTypeSizeInChars(Field->getType());
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002270 if (IsUnion) {
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002271 CharUnits UnionIvarSize = FieldSize;
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002272 if (UnionIvarSize > MaxUnionSize) {
2273 MaxUnionSize = UnionIvarSize;
2274 MaxField = Field;
2275 MaxFieldOffset = FieldOffset;
2276 }
2277 } else {
2278 UpdateRunSkipBlockVars(false,
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002279 getBlockCaptureLifetime(FQT, ByrefLayout),
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002280 BytePos + FieldOffset,
2281 FieldSize);
2282 }
2283 }
2284
2285 if (LastFieldBitfieldOrUnnamed) {
2286 if (LastFieldBitfieldOrUnnamed->isBitField()) {
2287 // Last field was a bitfield. Must update the info.
2288 uint64_t BitFieldSize
2289 = LastFieldBitfieldOrUnnamed->getBitWidthValue(CGM.getContext());
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002290 unsigned UnsSize = (BitFieldSize / ByteSizeInBits) +
Eli Friedmane5b46662012-11-06 22:15:52 +00002291 ((BitFieldSize % ByteSizeInBits) != 0);
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002292 CharUnits Size = CharUnits::fromQuantity(UnsSize);
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002293 Size += LastBitfieldOrUnnamedOffset;
2294 UpdateRunSkipBlockVars(false,
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002295 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2296 ByrefLayout),
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002297 BytePos + LastBitfieldOrUnnamedOffset,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002298 Size);
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002299 } else {
2300 assert(!LastFieldBitfieldOrUnnamed->getIdentifier() &&"Expected unnamed");
2301 // Last field was unnamed. Must update skip info.
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002302 CharUnits FieldSize
2303 = CGM.getContext().getTypeSizeInChars(LastFieldBitfieldOrUnnamed->getType());
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002304 UpdateRunSkipBlockVars(false,
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002305 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2306 ByrefLayout),
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002307 BytePos + LastBitfieldOrUnnamedOffset,
2308 FieldSize);
2309 }
2310 }
2311
2312 if (MaxField)
2313 UpdateRunSkipBlockVars(false,
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002314 getBlockCaptureLifetime(MaxField->getType(), ByrefLayout),
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002315 BytePos + MaxFieldOffset,
2316 MaxUnionSize);
2317}
2318
2319void CGObjCCommonMac::BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002320 CharUnits BytePos,
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002321 bool &HasUnion,
2322 bool ByrefLayout) {
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002323 const RecordDecl *RD = RT->getDecl();
Stephen Hines651f13c2014-04-23 16:59:28 -07002324 SmallVector<const FieldDecl*, 16> Fields(RD->fields());
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002325 llvm::Type *Ty = CGM.getTypes().ConvertType(QualType(RT, 0));
2326 const llvm::StructLayout *RecLayout =
2327 CGM.getDataLayout().getStructLayout(cast<llvm::StructType>(Ty));
2328
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002329 BuildRCRecordLayout(RecLayout, RD, Fields, BytePos, HasUnion, ByrefLayout);
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002330}
2331
Fariborz Jahanianf22ae652012-11-01 18:32:55 +00002332/// InlineLayoutInstruction - This routine produce an inline instruction for the
2333/// block variable layout if it can. If not, it returns 0. Rules are as follow:
2334/// If ((uintptr_t) layout) < (1 << 12), the layout is inline. In the 64bit world,
2335/// an inline layout of value 0x0000000000000xyz is interpreted as follows:
2336/// x captured object pointers of BLOCK_LAYOUT_STRONG. Followed by
2337/// y captured object of BLOCK_LAYOUT_BYREF. Followed by
2338/// z captured object of BLOCK_LAYOUT_WEAK. If any of the above is missing, zero
2339/// replaces it. For example, 0x00000x00 means x BLOCK_LAYOUT_STRONG and no
2340/// BLOCK_LAYOUT_BYREF and no BLOCK_LAYOUT_WEAK objects are captured.
2341uint64_t CGObjCCommonMac::InlineLayoutInstruction(
2342 SmallVectorImpl<unsigned char> &Layout) {
2343 uint64_t Result = 0;
2344 if (Layout.size() <= 3) {
2345 unsigned size = Layout.size();
2346 unsigned strong_word_count = 0, byref_word_count=0, weak_word_count=0;
2347 unsigned char inst;
2348 enum BLOCK_LAYOUT_OPCODE opcode ;
2349 switch (size) {
2350 case 3:
2351 inst = Layout[0];
2352 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2353 if (opcode == BLOCK_LAYOUT_STRONG)
2354 strong_word_count = (inst & 0xF)+1;
2355 else
2356 return 0;
2357 inst = Layout[1];
2358 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2359 if (opcode == BLOCK_LAYOUT_BYREF)
2360 byref_word_count = (inst & 0xF)+1;
2361 else
2362 return 0;
2363 inst = Layout[2];
2364 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2365 if (opcode == BLOCK_LAYOUT_WEAK)
2366 weak_word_count = (inst & 0xF)+1;
2367 else
2368 return 0;
2369 break;
2370
2371 case 2:
2372 inst = Layout[0];
2373 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2374 if (opcode == BLOCK_LAYOUT_STRONG) {
2375 strong_word_count = (inst & 0xF)+1;
2376 inst = Layout[1];
2377 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2378 if (opcode == BLOCK_LAYOUT_BYREF)
2379 byref_word_count = (inst & 0xF)+1;
2380 else if (opcode == BLOCK_LAYOUT_WEAK)
2381 weak_word_count = (inst & 0xF)+1;
2382 else
2383 return 0;
2384 }
2385 else if (opcode == BLOCK_LAYOUT_BYREF) {
2386 byref_word_count = (inst & 0xF)+1;
2387 inst = Layout[1];
2388 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2389 if (opcode == BLOCK_LAYOUT_WEAK)
2390 weak_word_count = (inst & 0xF)+1;
2391 else
2392 return 0;
2393 }
2394 else
2395 return 0;
2396 break;
2397
2398 case 1:
2399 inst = Layout[0];
2400 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2401 if (opcode == BLOCK_LAYOUT_STRONG)
2402 strong_word_count = (inst & 0xF)+1;
2403 else if (opcode == BLOCK_LAYOUT_BYREF)
2404 byref_word_count = (inst & 0xF)+1;
2405 else if (opcode == BLOCK_LAYOUT_WEAK)
2406 weak_word_count = (inst & 0xF)+1;
2407 else
2408 return 0;
2409 break;
2410
2411 default:
2412 return 0;
2413 }
2414
2415 // Cannot inline when any of the word counts is 15. Because this is one less
2416 // than the actual work count (so 15 means 16 actual word counts),
2417 // and we can only display 0 thru 15 word counts.
2418 if (strong_word_count == 16 || byref_word_count == 16 || weak_word_count == 16)
2419 return 0;
2420
2421 unsigned count =
2422 (strong_word_count != 0) + (byref_word_count != 0) + (weak_word_count != 0);
2423
2424 if (size == count) {
2425 if (strong_word_count)
2426 Result = strong_word_count;
2427 Result <<= 4;
2428 if (byref_word_count)
2429 Result += byref_word_count;
2430 Result <<= 4;
2431 if (weak_word_count)
2432 Result += weak_word_count;
2433 }
2434 }
2435 return Result;
2436}
2437
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002438llvm::Constant *CGObjCCommonMac::getBitmapBlockLayout(bool ComputeByrefLayout) {
2439 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2440 if (RunSkipBlockVars.empty())
2441 return nullPtr;
John McCall64aa4b32013-04-16 22:48:15 +00002442 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2443 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002444 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2445
2446 // Sort on byte position; captures might not be allocated in order,
2447 // and unions can do funny things.
2448 llvm::array_pod_sort(RunSkipBlockVars.begin(), RunSkipBlockVars.end());
2449 SmallVector<unsigned char, 16> Layout;
2450
2451 unsigned size = RunSkipBlockVars.size();
2452 for (unsigned i = 0; i < size; i++) {
2453 enum BLOCK_LAYOUT_OPCODE opcode = RunSkipBlockVars[i].opcode;
2454 CharUnits start_byte_pos = RunSkipBlockVars[i].block_var_bytepos;
2455 CharUnits end_byte_pos = start_byte_pos;
2456 unsigned j = i+1;
2457 while (j < size) {
2458 if (opcode == RunSkipBlockVars[j].opcode) {
2459 end_byte_pos = RunSkipBlockVars[j++].block_var_bytepos;
2460 i++;
2461 }
2462 else
2463 break;
2464 }
2465 CharUnits size_in_bytes =
2466 end_byte_pos - start_byte_pos + RunSkipBlockVars[j-1].block_var_size;
2467 if (j < size) {
2468 CharUnits gap =
2469 RunSkipBlockVars[j].block_var_bytepos -
2470 RunSkipBlockVars[j-1].block_var_bytepos - RunSkipBlockVars[j-1].block_var_size;
2471 size_in_bytes += gap;
2472 }
2473 CharUnits residue_in_bytes = CharUnits::Zero();
2474 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES) {
2475 residue_in_bytes = size_in_bytes % WordSizeInBytes;
2476 size_in_bytes -= residue_in_bytes;
2477 opcode = BLOCK_LAYOUT_NON_OBJECT_WORDS;
2478 }
2479
2480 unsigned size_in_words = size_in_bytes.getQuantity() / WordSizeInBytes;
2481 while (size_in_words >= 16) {
2482 // Note that value in imm. is one less that the actual
2483 // value. So, 0xf means 16 words follow!
2484 unsigned char inst = (opcode << 4) | 0xf;
2485 Layout.push_back(inst);
2486 size_in_words -= 16;
2487 }
2488 if (size_in_words > 0) {
2489 // Note that value in imm. is one less that the actual
2490 // value. So, we subtract 1 away!
2491 unsigned char inst = (opcode << 4) | (size_in_words-1);
2492 Layout.push_back(inst);
2493 }
2494 if (residue_in_bytes > CharUnits::Zero()) {
2495 unsigned char inst =
2496 (BLOCK_LAYOUT_NON_OBJECT_BYTES << 4) | (residue_in_bytes.getQuantity()-1);
2497 Layout.push_back(inst);
2498 }
2499 }
2500
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002501 while (!Layout.empty()) {
2502 unsigned char inst = Layout.back();
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002503 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2504 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES || opcode == BLOCK_LAYOUT_NON_OBJECT_WORDS)
2505 Layout.pop_back();
2506 else
2507 break;
2508 }
2509
2510 uint64_t Result = InlineLayoutInstruction(Layout);
2511 if (Result != 0) {
2512 // Block variable layout instruction has been inlined.
2513 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2514 if (ComputeByrefLayout)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002515 printf("\n Inline BYREF variable layout: ");
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002516 else
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002517 printf("\n Inline block variable layout: ");
2518 printf("0x0%" PRIx64 "", Result);
2519 if (auto numStrong = (Result & 0xF00) >> 8)
2520 printf(", BL_STRONG:%d", (int) numStrong);
2521 if (auto numByref = (Result & 0x0F0) >> 4)
2522 printf(", BL_BYREF:%d", (int) numByref);
2523 if (auto numWeak = (Result & 0x00F) >> 0)
2524 printf(", BL_WEAK:%d", (int) numWeak);
2525 printf(", BL_OPERATOR:0\n");
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002526 }
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002527 return llvm::ConstantInt::get(CGM.IntPtrTy, Result);
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002528 }
2529
2530 unsigned char inst = (BLOCK_LAYOUT_OPERATOR << 4) | 0;
2531 Layout.push_back(inst);
2532 std::string BitMap;
2533 for (unsigned i = 0, e = Layout.size(); i != e; i++)
2534 BitMap += Layout[i];
2535
2536 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2537 if (ComputeByrefLayout)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002538 printf("\n Byref variable layout: ");
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002539 else
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002540 printf("\n Block variable layout: ");
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002541 for (unsigned i = 0, e = BitMap.size(); i != e; i++) {
2542 unsigned char inst = BitMap[i];
2543 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2544 unsigned delta = 1;
2545 switch (opcode) {
2546 case BLOCK_LAYOUT_OPERATOR:
2547 printf("BL_OPERATOR:");
2548 delta = 0;
2549 break;
2550 case BLOCK_LAYOUT_NON_OBJECT_BYTES:
2551 printf("BL_NON_OBJECT_BYTES:");
2552 break;
2553 case BLOCK_LAYOUT_NON_OBJECT_WORDS:
2554 printf("BL_NON_OBJECT_WORD:");
2555 break;
2556 case BLOCK_LAYOUT_STRONG:
2557 printf("BL_STRONG:");
2558 break;
2559 case BLOCK_LAYOUT_BYREF:
2560 printf("BL_BYREF:");
2561 break;
2562 case BLOCK_LAYOUT_WEAK:
2563 printf("BL_WEAK:");
2564 break;
2565 case BLOCK_LAYOUT_UNRETAINED:
2566 printf("BL_UNRETAINED:");
2567 break;
2568 }
2569 // Actual value of word count is one more that what is in the imm.
2570 // field of the instruction
2571 printf("%d", (inst & 0xf) + delta);
2572 if (i < e-1)
2573 printf(", ");
2574 else
2575 printf("\n");
2576 }
2577 }
Stephen Hines176edba2014-12-01 14:53:08 -08002578
2579 llvm::GlobalVariable *Entry = CreateMetadataVar(
2580 "OBJC_CLASS_NAME_",
2581 llvm::ConstantDataArray::getString(VMContext, BitMap, false),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002582 "__TEXT,__objc_classname,cstring_literals", CharUnits::One(), true);
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002583 return getConstantGEP(VMContext, Entry, 0, 0);
2584}
2585
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002586llvm::Constant *CGObjCCommonMac::BuildRCBlockLayout(CodeGenModule &CGM,
2587 const CGBlockInfo &blockInfo) {
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002588 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2589
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002590 RunSkipBlockVars.clear();
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002591 bool hasUnion = false;
2592
John McCall64aa4b32013-04-16 22:48:15 +00002593 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2594 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002595 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2596
2597 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2598
2599 // Calculate the basic layout of the block structure.
2600 const llvm::StructLayout *layout =
2601 CGM.getDataLayout().getStructLayout(blockInfo.StructureType);
2602
2603 // Ignore the optional 'this' capture: C++ objects are not assumed
2604 // to be GC'ed.
Fariborz Jahanianff685c52012-12-04 17:20:57 +00002605 if (blockInfo.BlockHeaderForcedGapSize != CharUnits::Zero())
2606 UpdateRunSkipBlockVars(false, Qualifiers::OCL_None,
2607 blockInfo.BlockHeaderForcedGapOffset,
2608 blockInfo.BlockHeaderForcedGapSize);
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002609 // Walk the captured variables.
Stephen Hines651f13c2014-04-23 16:59:28 -07002610 for (const auto &CI : blockDecl->captures()) {
2611 const VarDecl *variable = CI.getVariable();
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002612 QualType type = variable->getType();
2613
2614 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2615
2616 // Ignore constant captures.
2617 if (capture.isConstant()) continue;
2618
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002619 CharUnits fieldOffset =
2620 CharUnits::fromQuantity(layout->getElementOffset(capture.getIndex()));
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002621
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002622 assert(!type->isArrayType() && "array variable should not be caught");
Stephen Hines651f13c2014-04-23 16:59:28 -07002623 if (!CI.isByRef())
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002624 if (const RecordType *record = type->getAs<RecordType>()) {
2625 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion);
2626 continue;
2627 }
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002628 CharUnits fieldSize;
Stephen Hines651f13c2014-04-23 16:59:28 -07002629 if (CI.isByRef())
Fariborz Jahanian1da01d62012-11-07 20:00:32 +00002630 fieldSize = CharUnits::fromQuantity(WordSizeInBytes);
2631 else
2632 fieldSize = CGM.getContext().getTypeSizeInChars(type);
Stephen Hines651f13c2014-04-23 16:59:28 -07002633 UpdateRunSkipBlockVars(CI.isByRef(), getBlockCaptureLifetime(type, false),
Fariborz Jahanianc6abe9e2012-10-30 20:05:29 +00002634 fieldOffset, fieldSize);
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002635 }
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002636 return getBitmapBlockLayout(false);
2637}
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002638
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002639llvm::Constant *CGObjCCommonMac::BuildByrefLayout(CodeGen::CodeGenModule &CGM,
2640 QualType T) {
2641 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2642 assert(!T->isArrayType() && "__block array variable should not be caught");
2643 CharUnits fieldOffset;
2644 RunSkipBlockVars.clear();
2645 bool hasUnion = false;
2646 if (const RecordType *record = T->getAs<RecordType>()) {
2647 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion, true /*ByrefLayout */);
2648 llvm::Constant *Result = getBitmapBlockLayout(true);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002649 if (isa<llvm::ConstantInt>(Result))
2650 Result = llvm::ConstantExpr::getIntToPtr(Result, CGM.Int8PtrTy);
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002651 return Result;
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002652 }
Fariborz Jahanian3ca23d72012-11-14 17:15:51 +00002653 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2654 return nullPtr;
Fariborz Jahanianc46b4352012-10-27 21:10:38 +00002655}
2656
John McCallbd7370a2013-02-28 19:01:20 +00002657llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbaraf2f62c2008-08-13 00:59:25 +00002658 const ObjCProtocolDecl *PD) {
Daniel Dunbarc67876d2008-09-04 04:33:15 +00002659 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stumpf5408fe2009-05-16 07:57:57 +00002660 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc67876d2008-09-04 04:33:15 +00002661 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2662
Owen Anderson3c4972d2009-07-29 18:54:39 +00002663 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor4c86fdb2012-01-17 18:36:30 +00002664 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00002665}
2666
Fariborz Jahanianda320092009-01-29 19:24:30 +00002667void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stumpf5408fe2009-05-16 07:57:57 +00002668 // FIXME: We shouldn't need this, the protocol decl should contain enough
2669 // information to tell us whether this was a declaration or a definition.
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00002670 DefinedProtocols.insert(PD->getIdentifier());
2671
2672 // If we have generated a forward reference to this protocol, emit
2673 // it now. Otherwise do nothing, the protocol objects are lazily
2674 // emitted.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002675 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00002676 GetOrEmitProtocol(PD);
2677}
2678
Fariborz Jahanianda320092009-01-29 19:24:30 +00002679llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00002680 if (DefinedProtocols.count(PD->getIdentifier()))
2681 return GetOrEmitProtocol(PD);
Douglas Gregorf968d832011-05-27 01:19:52 +00002682
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00002683 return GetOrEmitProtocolRef(PD);
2684}
2685
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002686llvm::Value *CGObjCCommonMac::EmitClassRefViaRuntime(
2687 CodeGenFunction &CGF,
2688 const ObjCInterfaceDecl *ID,
2689 ObjCCommonTypesHelper &ObjCTypes) {
2690 llvm::Constant *lookUpClassFn = ObjCTypes.getLookUpClassFn();
2691
2692 llvm::Value *className =
2693 CGF.CGM.GetAddrOfConstantCString(ID->getObjCRuntimeNameAsString())
2694 .getPointer();
2695 ASTContext &ctx = CGF.CGM.getContext();
2696 className =
2697 CGF.Builder.CreateBitCast(className,
2698 CGF.ConvertType(
2699 ctx.getPointerType(ctx.CharTy.withConst())));
2700 llvm::CallInst *call = CGF.Builder.CreateCall(lookUpClassFn, className);
2701 call->setDoesNotThrow();
2702 return call;
2703}
2704
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002705/*
Stephen Hines651f13c2014-04-23 16:59:28 -07002706// Objective-C 1.0 extensions
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002707struct _objc_protocol {
2708struct _objc_protocol_extension *isa;
2709char *protocol_name;
2710struct _objc_protocol_list *protocol_list;
2711struct _objc__method_prototype_list *instance_methods;
2712struct _objc__method_prototype_list *class_methods
2713};
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002714
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002715See EmitProtocolExtension().
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002716*/
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00002717llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCall50651b92012-03-30 21:29:05 +00002718 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00002719
2720 // Early exit if a defining object has already been generated.
2721 if (Entry && Entry->hasInitializer())
2722 return Entry;
2723
Douglas Gregor1d784b22012-01-01 19:51:50 +00002724 // Use the protocol definition, if there is one.
2725 if (const ObjCProtocolDecl *Def = PD->getDefinition())
2726 PD = Def;
2727
Daniel Dunbar242d4dc2008-08-25 06:02:07 +00002728 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stumpf5408fe2009-05-16 07:57:57 +00002729 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar242d4dc2008-08-25 06:02:07 +00002730 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2731
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002732 // Construct method lists.
2733 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
2734 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilsondc8dab62011-11-30 01:57:58 +00002735 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Stephen Hines651f13c2014-04-23 16:59:28 -07002736 for (const auto *MD : PD->instance_methods()) {
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002737 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregorf968d832011-05-27 01:19:52 +00002738 if (!C)
2739 return GetOrEmitProtocolRef(PD);
2740
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002741 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2742 OptInstanceMethods.push_back(C);
Bob Wilsondc8dab62011-11-30 01:57:58 +00002743 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002744 } else {
2745 InstanceMethods.push_back(C);
Bob Wilsondc8dab62011-11-30 01:57:58 +00002746 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002747 }
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002748 }
2749
Stephen Hines651f13c2014-04-23 16:59:28 -07002750 for (const auto *MD : PD->class_methods()) {
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002751 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregorf968d832011-05-27 01:19:52 +00002752 if (!C)
2753 return GetOrEmitProtocolRef(PD);
2754
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002755 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2756 OptClassMethods.push_back(C);
Bob Wilsondc8dab62011-11-30 01:57:58 +00002757 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002758 } else {
2759 ClassMethods.push_back(C);
Bob Wilsondc8dab62011-11-30 01:57:58 +00002760 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002761 }
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002762 }
2763
Bob Wilsondc8dab62011-11-30 01:57:58 +00002764 MethodTypesExt.insert(MethodTypesExt.end(),
2765 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
2766
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00002767 llvm::Constant *Values[] = {
Stephen Hines176edba2014-12-01 14:53:08 -08002768 EmitProtocolExtension(PD, OptInstanceMethods, OptClassMethods,
2769 MethodTypesExt),
2770 GetClassName(PD->getObjCRuntimeNameAsString()),
2771 EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
2772 PD->protocol_begin(), PD->protocol_end()),
2773 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_" + PD->getName(),
2774 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2775 InstanceMethods),
2776 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_" + PD->getName(),
2777 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2778 ClassMethods)};
Owen Anderson08e25242009-07-27 22:29:56 +00002779 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002780 Values);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002781
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002782 if (Entry) {
Stephen Hines651f13c2014-04-23 16:59:28 -07002783 // Already created, update the initializer.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07002784 assert(Entry->hasPrivateLinkage());
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002785 Entry->setInitializer(Init);
2786 } else {
Stephen Hines176edba2014-12-01 14:53:08 -08002787 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2788 false, llvm::GlobalValue::PrivateLinkage,
2789 Init, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002790 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002791 // FIXME: Is this necessary? Why only for protocol?
2792 Entry->setAlignment(4);
John McCall50651b92012-03-30 21:29:05 +00002793
2794 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002795 }
Stephen Hines651f13c2014-04-23 16:59:28 -07002796 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00002797
2798 return Entry;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002799}
2800
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00002801llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002802 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
2803
2804 if (!Entry) {
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00002805 // We use the initializer as a marker of whether this is a forward
2806 // reference or not. At module finalization we add the empty
2807 // contents for protocols which were referenced but never defined.
Stephen Hines176edba2014-12-01 14:53:08 -08002808 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2809 false, llvm::GlobalValue::PrivateLinkage,
2810 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002811 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002812 // FIXME: Is this necessary? Why only for protocol?
2813 Entry->setAlignment(4);
2814 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002815
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002816 return Entry;
2817}
2818
2819/*
2820 struct _objc_protocol_extension {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002821 uint32_t size;
2822 struct objc_method_description_list *optional_instance_methods;
2823 struct objc_method_description_list *optional_class_methods;
2824 struct objc_property_list *instance_properties;
Bob Wilsondc8dab62011-11-30 01:57:58 +00002825 const char ** extendedMethodTypes;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002826 struct objc_property_list *class_properties;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002827 };
2828*/
Daniel Dunbarae226fa2008-08-27 02:31:56 +00002829llvm::Constant *
2830CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingbb028552012-02-07 09:25:09 +00002831 ArrayRef<llvm::Constant*> OptInstanceMethods,
2832 ArrayRef<llvm::Constant*> OptClassMethods,
2833 ArrayRef<llvm::Constant*> MethodTypesExt) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002834 uint64_t Size =
Micah Villmow25a6a842012-10-08 16:25:52 +00002835 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00002836 llvm::Constant *Values[] = {
Stephen Hines176edba2014-12-01 14:53:08 -08002837 llvm::ConstantInt::get(ObjCTypes.IntTy, Size),
2838 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_OPT_" + PD->getName(),
2839 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2840 OptInstanceMethods),
2841 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_OPT_" + PD->getName(),
2842 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2843 OptClassMethods),
2844 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002845 ObjCTypes, false),
Stephen Hines176edba2014-12-01 14:53:08 -08002846 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002847 MethodTypesExt, ObjCTypes),
2848 EmitPropertyList("OBJC_$_CLASS_PROP_PROTO_LIST_" + PD->getName(), nullptr,
2849 PD, ObjCTypes, true)};
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002850
Daniel Dunbar27f9d772008-08-21 04:36:09 +00002851 // Return null if no extension bits are used.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002852 if (Values[1]->isNullValue() && Values[2]->isNullValue() &&
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002853 Values[3]->isNullValue() && Values[4]->isNullValue() &&
2854 Values[5]->isNullValue())
Owen Andersonc9c88b42009-07-31 20:28:54 +00002855 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002856
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002857 llvm::Constant *Init =
Owen Anderson08e25242009-07-27 22:29:56 +00002858 llvm::ConstantStruct::get(ObjCTypes.ProtocolExtensionTy, Values);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002859
Daniel Dunbar63c5b502009-03-09 21:49:58 +00002860 // No special section, but goes in llvm.used
Stephen Hinesc568f1e2014-07-21 00:47:37 -07002861 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), Init,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002862 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002863}
2864
2865/*
2866 struct objc_protocol_list {
Bill Wendling3964e622012-02-09 22:16:49 +00002867 struct objc_protocol_list *next;
2868 long count;
2869 Protocol *list[];
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002870 };
2871*/
Daniel Dunbardbc933702008-08-21 21:57:41 +00002872llvm::Constant *
Chris Lattner5f9e2722011-07-23 10:55:15 +00002873CGObjCMac::EmitProtocolList(Twine Name,
Daniel Dunbardbc933702008-08-21 21:57:41 +00002874 ObjCProtocolDecl::protocol_iterator begin,
2875 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002876 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002877
Daniel Dunbardbc933702008-08-21 21:57:41 +00002878 for (; begin != end; ++begin)
2879 ProtocolRefs.push_back(GetProtocolRef(*begin));
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002880
2881 // Just return null for empty protocol lists
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002882 if (ProtocolRefs.empty())
Owen Andersonc9c88b42009-07-31 20:28:54 +00002883 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002884
Daniel Dunbar27f9d772008-08-21 04:36:09 +00002885 // This list is null terminated.
Owen Andersonc9c88b42009-07-31 20:28:54 +00002886 ProtocolRefs.push_back(llvm::Constant::getNullValue(ObjCTypes.ProtocolPtrTy));
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002887
Chris Lattnerc5cbb902011-06-20 04:01:35 +00002888 llvm::Constant *Values[3];
Daniel Dunbar27f9d772008-08-21 04:36:09 +00002889 // This field is only used by the runtime.
Owen Andersonc9c88b42009-07-31 20:28:54 +00002890 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Owen Anderson4a28d5d2009-07-24 23:12:58 +00002891 Values[1] = llvm::ConstantInt::get(ObjCTypes.LongTy,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002892 ProtocolRefs.size() - 1);
2893 Values[2] =
2894 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolPtrTy,
2895 ProtocolRefs.size()),
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002896 ProtocolRefs);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002897
Chris Lattnerc5cbb902011-06-20 04:01:35 +00002898 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002899 llvm::GlobalVariable *GV =
Daniel Dunbar63c5b502009-03-09 21:49:58 +00002900 CreateMetadataVar(Name, Init, "__OBJC,__cat_cls_meth,regular,no_dead_strip",
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002901 CGM.getPointerAlign(), false);
Owen Anderson3c4972d2009-07-29 18:54:39 +00002902 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002903}
2904
Bill Wendlingbb028552012-02-07 09:25:09 +00002905void CGObjCCommonMac::
2906PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002907 SmallVectorImpl<llvm::Constant *> &Properties,
Bill Wendlingbb028552012-02-07 09:25:09 +00002908 const Decl *Container,
Stephen Hines651f13c2014-04-23 16:59:28 -07002909 const ObjCProtocolDecl *Proto,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002910 const ObjCCommonTypesHelper &ObjCTypes,
2911 bool IsClassProperty) {
Stephen Hines651f13c2014-04-23 16:59:28 -07002912 for (const auto *P : Proto->protocols())
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002913 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2914 IsClassProperty);
2915
Stephen Hines651f13c2014-04-23 16:59:28 -07002916 for (const auto *PD : Proto->properties()) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002917 if (IsClassProperty != PD->isClassProperty())
2918 continue;
Stephen Hines176edba2014-12-01 14:53:08 -08002919 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian191dcd72009-12-12 21:26:21 +00002920 continue;
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00002921 llvm::Constant *Prop[] = {
2922 GetPropertyName(PD->getIdentifier()),
2923 GetPropertyTypeString(PD, Container)
2924 };
Fariborz Jahanian191dcd72009-12-12 21:26:21 +00002925 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2926 }
2927}
2928
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00002929/*
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00002930 struct _objc_property {
Bill Wendling3964e622012-02-09 22:16:49 +00002931 const char * const name;
2932 const char * const attributes;
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00002933 };
2934
2935 struct _objc_property_list {
Bill Wendling3964e622012-02-09 22:16:49 +00002936 uint32_t entsize; // sizeof (struct _objc_property)
2937 uint32_t prop_count;
2938 struct _objc_property[prop_count];
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00002939 };
2940*/
Chris Lattner5f9e2722011-07-23 10:55:15 +00002941llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002942 const Decl *Container,
2943 const ObjCContainerDecl *OCD,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002944 const ObjCCommonTypesHelper &ObjCTypes,
2945 bool IsClassProperty) {
2946 if (IsClassProperty) {
2947 // Make this entry NULL for OS X with deployment target < 10.11, for iOS
2948 // with deployment target < 9.0.
2949 const llvm::Triple &Triple = CGM.getTarget().getTriple();
2950 if ((Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 11)) ||
2951 (Triple.isiOS() && Triple.isOSVersionLT(9)))
2952 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
2953 }
2954
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00002955 SmallVector<llvm::Constant *, 16> Properties;
Fariborz Jahanian191dcd72009-12-12 21:26:21 +00002956 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002957
2958 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2959 llvm::Constant *Prop[] = {GetPropertyName(PD->getIdentifier()),
2960 GetPropertyTypeString(PD, Container)};
2961 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2962 };
2963 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
2964 for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
2965 for (auto *PD : ClassExt->properties()) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002966 if (IsClassProperty != PD->isClassProperty())
2967 continue;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002968 PropertySet.insert(PD->getIdentifier());
2969 AddProperty(PD);
2970 }
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002971
Stephen Hines651f13c2014-04-23 16:59:28 -07002972 for (const auto *PD : OCD->properties()) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002973 if (IsClassProperty != PD->isClassProperty())
2974 continue;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002975 // Don't emit duplicate metadata for properties that were already in a
2976 // class extension.
2977 if (!PropertySet.insert(PD->getIdentifier()).second)
2978 continue;
2979 AddProperty(PD);
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00002980 }
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08002981
Fariborz Jahanian6afbdf52010-06-22 16:33:55 +00002982 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Stephen Hines651f13c2014-04-23 16:59:28 -07002983 for (const auto *P : OID->all_referenced_protocols())
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002984 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2985 IsClassProperty);
Fariborz Jahanian6afbdf52010-06-22 16:33:55 +00002986 }
2987 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Stephen Hines651f13c2014-04-23 16:59:28 -07002988 for (const auto *P : CD->protocols())
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07002989 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2990 IsClassProperty);
Fariborz Jahanian6afbdf52010-06-22 16:33:55 +00002991 }
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00002992
2993 // Return null for empty list.
2994 if (Properties.empty())
Owen Andersonc9c88b42009-07-31 20:28:54 +00002995 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00002996
Daniel Dunbar6bff2512009-08-03 17:06:42 +00002997 unsigned PropertySize =
Micah Villmow25a6a842012-10-08 16:25:52 +00002998 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00002999 llvm::Constant *Values[3];
Owen Anderson4a28d5d2009-07-24 23:12:58 +00003000 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, PropertySize);
3001 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Properties.size());
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003002 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.PropertyTy,
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00003003 Properties.size());
Owen Anderson7db6d832009-07-28 18:33:04 +00003004 Values[2] = llvm::ConstantArray::get(AT, Properties);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003005 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00003006
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003007 llvm::GlobalVariable *GV =
3008 CreateMetadataVar(Name, Init,
3009 (ObjCABI == 2) ? "__DATA, __objc_const" :
Daniel Dunbar0bf21992009-04-15 02:56:18 +00003010 "__OBJC,__property,regular,no_dead_strip",
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003011 CGM.getPointerAlign(),
Daniel Dunbar0bf21992009-04-15 02:56:18 +00003012 true);
Owen Anderson3c4972d2009-07-29 18:54:39 +00003013 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00003014}
3015
Bill Wendlingbb028552012-02-07 09:25:09 +00003016llvm::Constant *
3017CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
3018 ArrayRef<llvm::Constant*> MethodTypes,
3019 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilsondc8dab62011-11-30 01:57:58 +00003020 // Return null for empty list.
3021 if (MethodTypes.empty())
3022 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
3023
3024 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
3025 MethodTypes.size());
3026 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
3027
Stephen Hinesc568f1e2014-07-21 00:47:37 -07003028 llvm::GlobalVariable *GV = CreateMetadataVar(
3029 Name, Init, (ObjCABI == 2) ? "__DATA, __objc_const" : StringRef(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003030 CGM.getPointerAlign(), true);
Bob Wilsondc8dab62011-11-30 01:57:58 +00003031 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
3032}
3033
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00003034/*
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00003035 struct objc_method_description_list {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003036 int count;
3037 struct objc_method_description list[];
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00003038 };
3039*/
Daniel Dunbarae226fa2008-08-27 02:31:56 +00003040llvm::Constant *
3041CGObjCMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00003042 llvm::Constant *Desc[] = {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003043 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00003044 ObjCTypes.SelectorPtrTy),
3045 GetMethodVarType(MD)
3046 };
Douglas Gregorf968d832011-05-27 01:19:52 +00003047 if (!Desc[1])
Stephen Hines6bcf27b2014-05-29 04:14:42 -07003048 return nullptr;
3049
Owen Anderson08e25242009-07-27 22:29:56 +00003050 return llvm::ConstantStruct::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbarae226fa2008-08-27 02:31:56 +00003051 Desc);
3052}
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00003053
Bill Wendlingbb028552012-02-07 09:25:09 +00003054llvm::Constant *
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003055CGObjCMac::EmitMethodDescList(Twine Name, StringRef Section,
3056 ArrayRef<llvm::Constant *> Methods) {
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00003057 // Return null for empty list.
3058 if (Methods.empty())
Owen Andersonc9c88b42009-07-31 20:28:54 +00003059 return llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00003060
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003061 llvm::Constant *Values[2];
Owen Anderson4a28d5d2009-07-24 23:12:58 +00003062 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003063 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00003064 Methods.size());
Owen Anderson7db6d832009-07-28 18:33:04 +00003065 Values[1] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003066 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00003067
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003068 llvm::GlobalVariable *GV =
3069 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003070 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00003071 ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00003072}
3073
Daniel Dunbar86e253a2008-08-22 20:34:54 +00003074/*
3075 struct _objc_category {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003076 char *category_name;
3077 char *class_name;
3078 struct _objc_method_list *instance_methods;
3079 struct _objc_method_list *class_methods;
3080 struct _objc_protocol_list *protocols;
3081 uint32_t size; // <rdar://4585769>
3082 struct _objc_property_list *instance_properties;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003083 struct _objc_property_list *class_properties;
Daniel Dunbar86e253a2008-08-22 20:34:54 +00003084 };
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003085*/
Daniel Dunbar7ded7f42008-08-15 22:20:32 +00003086void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmow25a6a842012-10-08 16:25:52 +00003087 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar86e253a2008-08-22 20:34:54 +00003088
Mike Stumpf5408fe2009-05-16 07:57:57 +00003089 // FIXME: This is poor design, the OCD should have a pointer to the category
3090 // decl. Additionally, note that Category can be null for the @implementation
3091 // w/o an @interface case. Sema should just create one for us as it does for
3092 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar86e253a2008-08-22 20:34:54 +00003093 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003094 const ObjCCategoryDecl *Category =
Daniel Dunbar86e2f402008-08-26 23:03:11 +00003095 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00003096
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00003097 SmallString<256> ExtName;
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00003098 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3099 << OCD->getName();
Daniel Dunbar86e253a2008-08-22 20:34:54 +00003100
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00003101 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Stephen Hines651f13c2014-04-23 16:59:28 -07003102 for (const auto *I : OCD->instance_methods())
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003103 // Instance methods should always be defined.
Stephen Hines651f13c2014-04-23 16:59:28 -07003104 InstanceMethods.push_back(GetMethodConstant(I));
3105
3106 for (const auto *I : OCD->class_methods())
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003107 // Class methods should always be defined.
Stephen Hines651f13c2014-04-23 16:59:28 -07003108 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003109
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003110 llvm::Constant *Values[8];
Stephen Hines176edba2014-12-01 14:53:08 -08003111 Values[0] = GetClassName(OCD->getName());
3112 Values[1] = GetClassName(Interface->getObjCRuntimeNameAsString());
Fariborz Jahanian679cd7f2009-04-29 20:40:05 +00003113 LazySymbols.insert(Interface->getIdentifier());
Stephen Hines176edba2014-12-01 14:53:08 -08003114 Values[2] = EmitMethodList("OBJC_CATEGORY_INSTANCE_METHODS_" + ExtName.str(),
3115 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
3116 InstanceMethods);
3117 Values[3] = EmitMethodList("OBJC_CATEGORY_CLASS_METHODS_" + ExtName.str(),
3118 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
3119 ClassMethods);
Daniel Dunbarae226fa2008-08-27 02:31:56 +00003120 if (Category) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003121 Values[4] =
Stephen Hines176edba2014-12-01 14:53:08 -08003122 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
3123 Category->protocol_begin(), Category->protocol_end());
Daniel Dunbarae226fa2008-08-27 02:31:56 +00003124 } else {
Owen Andersonc9c88b42009-07-31 20:28:54 +00003125 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarae226fa2008-08-27 02:31:56 +00003126 }
Owen Anderson4a28d5d2009-07-24 23:12:58 +00003127 Values[5] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Daniel Dunbar86e2f402008-08-26 23:03:11 +00003128
3129 // If there is no category @interface then there can be no properties.
3130 if (Category) {
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00003131 Values[6] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003132 OCD, Category, ObjCTypes, false);
3133 Values[7] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
3134 OCD, Category, ObjCTypes, true);
Daniel Dunbar86e2f402008-08-26 23:03:11 +00003135 } else {
Owen Andersonc9c88b42009-07-31 20:28:54 +00003136 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003137 Values[7] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar86e2f402008-08-26 23:03:11 +00003138 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003139
Owen Anderson08e25242009-07-27 22:29:56 +00003140 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.CategoryTy,
Daniel Dunbar86e253a2008-08-22 20:34:54 +00003141 Values);
3142
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003143 llvm::GlobalVariable *GV =
Stephen Hines176edba2014-12-01 14:53:08 -08003144 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Init,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003145 "__OBJC,__category,regular,no_dead_strip",
3146 CGM.getPointerAlign(), true);
Daniel Dunbar86e253a2008-08-22 20:34:54 +00003147 DefinedCategories.push_back(GV);
Fariborz Jahanianb9c5b3d2010-06-21 22:05:18 +00003148 DefinedCategoryNames.insert(ExtName.str());
Fariborz Jahanian64089ce2011-04-22 22:02:28 +00003149 // method definition entries must be clear for next implementation.
3150 MethodDefinitions.clear();
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00003151}
3152
John McCall621915c2012-10-17 04:53:23 +00003153enum FragileClassFlags {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003154 /// Apparently: is not a meta-class.
John McCall621915c2012-10-17 04:53:23 +00003155 FragileABI_Class_Factory = 0x00001,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003156
3157 /// Is a meta-class.
John McCall621915c2012-10-17 04:53:23 +00003158 FragileABI_Class_Meta = 0x00002,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003159
3160 /// Has a non-trivial constructor or destructor.
John McCall621915c2012-10-17 04:53:23 +00003161 FragileABI_Class_HasCXXStructors = 0x02000,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003162
3163 /// Has hidden visibility.
3164 FragileABI_Class_Hidden = 0x20000,
3165
3166 /// Class implementation was compiled under ARC.
3167 FragileABI_Class_CompiledByARC = 0x04000000,
3168
3169 /// Class implementation was compiled under MRC and has MRC weak ivars.
3170 /// Exclusive with CompiledByARC.
3171 FragileABI_Class_HasMRCWeakIvars = 0x08000000,
John McCall621915c2012-10-17 04:53:23 +00003172};
3173
3174enum NonFragileClassFlags {
3175 /// Is a meta-class.
3176 NonFragileABI_Class_Meta = 0x00001,
3177
3178 /// Is a root class.
3179 NonFragileABI_Class_Root = 0x00002,
3180
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003181 /// Has a non-trivial constructor or destructor.
John McCall621915c2012-10-17 04:53:23 +00003182 NonFragileABI_Class_HasCXXStructors = 0x00004,
3183
3184 /// Has hidden visibility.
3185 NonFragileABI_Class_Hidden = 0x00010,
3186
3187 /// Has the exception attribute.
3188 NonFragileABI_Class_Exception = 0x00020,
3189
3190 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3191 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3192
3193 /// Class implementation was compiled under ARC.
John McCallb03527a2012-10-17 04:53:31 +00003194 NonFragileABI_Class_CompiledByARC = 0x00080,
3195
3196 /// Class has non-trivial destructors, but zero-initialization is okay.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003197 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100,
3198
3199 /// Class implementation was compiled under MRC and has MRC weak ivars.
3200 /// Exclusive with CompiledByARC.
3201 NonFragileABI_Class_HasMRCWeakIvars = 0x00200,
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003202};
3203
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003204static bool hasWeakMember(QualType type) {
3205 if (type.getObjCLifetime() == Qualifiers::OCL_Weak) {
3206 return true;
3207 }
3208
3209 if (auto recType = type->getAs<RecordType>()) {
3210 for (auto field : recType->getDecl()->fields()) {
3211 if (hasWeakMember(field->getType()))
3212 return true;
3213 }
3214 }
3215
3216 return false;
3217}
3218
3219/// For compatibility, we only want to set the "HasMRCWeakIvars" flag
3220/// (and actually fill in a layout string) if we really do have any
3221/// __weak ivars.
3222static bool hasMRCWeakIvars(CodeGenModule &CGM,
3223 const ObjCImplementationDecl *ID) {
3224 if (!CGM.getLangOpts().ObjCWeak) return false;
3225 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
3226
3227 for (const ObjCIvarDecl *ivar =
3228 ID->getClassInterface()->all_declared_ivar_begin();
3229 ivar; ivar = ivar->getNextIvar()) {
3230 if (hasWeakMember(ivar->getType()))
3231 return true;
3232 }
3233
3234 return false;
3235}
3236
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003237/*
3238 struct _objc_class {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003239 Class isa;
3240 Class super_class;
3241 const char *name;
3242 long version;
3243 long info;
3244 long instance_size;
3245 struct _objc_ivar_list *ivars;
3246 struct _objc_method_list *methods;
3247 struct _objc_cache *cache;
3248 struct _objc_protocol_list *protocols;
3249 // Objective-C 1.0 extensions (<rdr://4585769>)
3250 const char *ivar_layout;
3251 struct _objc_class_ext *ext;
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003252 };
3253
3254 See EmitClassExtension();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003255*/
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003256void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Daniel Dunbar242d4dc2008-08-25 06:02:07 +00003257 DefinedSymbols.insert(ID->getIdentifier());
3258
Chris Lattner8ec03f52008-11-24 03:54:41 +00003259 std::string ClassName = ID->getNameAsString();
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003260 // FIXME: Gross
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003261 ObjCInterfaceDecl *Interface =
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003262 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003263 llvm::Constant *Protocols =
Stephen Hines176edba2014-12-01 14:53:08 -08003264 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3265 Interface->all_referenced_protocol_begin(),
3266 Interface->all_referenced_protocol_end());
John McCall621915c2012-10-17 04:53:23 +00003267 unsigned Flags = FragileABI_Class_Factory;
John McCallb03527a2012-10-17 04:53:31 +00003268 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCall621915c2012-10-17 04:53:23 +00003269 Flags |= FragileABI_Class_HasCXXStructors;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003270
3271 bool hasMRCWeak = false;
3272
3273 if (CGM.getLangOpts().ObjCAutoRefCount)
3274 Flags |= FragileABI_Class_CompiledByARC;
3275 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
3276 Flags |= FragileABI_Class_HasMRCWeakIvars;
3277
3278 CharUnits Size =
3279 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003280
3281 // FIXME: Set CXX-structors flag.
John McCall1fb0caa2010-10-22 21:05:15 +00003282 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCall621915c2012-10-17 04:53:23 +00003283 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003284
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00003285 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Stephen Hines651f13c2014-04-23 16:59:28 -07003286 for (const auto *I : ID->instance_methods())
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003287 // Instance methods should always be defined.
Stephen Hines651f13c2014-04-23 16:59:28 -07003288 InstanceMethods.push_back(GetMethodConstant(I));
3289
3290 for (const auto *I : ID->class_methods())
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003291 // Class methods should always be defined.
Stephen Hines651f13c2014-04-23 16:59:28 -07003292 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003293
Stephen Hines651f13c2014-04-23 16:59:28 -07003294 for (const auto *PID : ID->property_impls()) {
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003295 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3296 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3297
3298 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
3299 if (llvm::Constant *C = GetMethodConstant(MD))
3300 InstanceMethods.push_back(C);
3301 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
3302 if (llvm::Constant *C = GetMethodConstant(MD))
3303 InstanceMethods.push_back(C);
3304 }
3305 }
3306
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003307 llvm::Constant *Values[12];
Daniel Dunbar5384b092009-05-03 08:56:52 +00003308 Values[ 0] = EmitMetaClass(ID, Protocols, ClassMethods);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003309 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbar242d4dc2008-08-25 06:02:07 +00003310 // Record a reference to the super class.
3311 LazySymbols.insert(Super->getIdentifier());
3312
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003313 Values[ 1] =
Stephen Hines176edba2014-12-01 14:53:08 -08003314 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003315 ObjCTypes.ClassPtrTy);
3316 } else {
Owen Andersonc9c88b42009-07-31 20:28:54 +00003317 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003318 }
Stephen Hines176edba2014-12-01 14:53:08 -08003319 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003320 // Version is always 0.
Owen Anderson4a28d5d2009-07-24 23:12:58 +00003321 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3322 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003323 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size.getQuantity());
Fariborz Jahanian46b86c62009-01-28 19:12:34 +00003324 Values[ 6] = EmitIvarList(ID, false);
Stephen Hines176edba2014-12-01 14:53:08 -08003325 Values[7] = EmitMethodList("OBJC_INSTANCE_METHODS_" + ID->getName(),
3326 "__OBJC,__inst_meth,regular,no_dead_strip",
3327 InstanceMethods);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003328 // cache is always NULL.
Owen Andersonc9c88b42009-07-31 20:28:54 +00003329 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003330 Values[ 9] = Protocols;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003331 Values[10] = BuildStrongIvarLayout(ID, CharUnits::Zero(), Size);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003332 Values[11] = EmitClassExtension(ID, Size, hasMRCWeak,
3333 false/*isClassProperty*/);
Owen Anderson08e25242009-07-27 22:29:56 +00003334 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003335 Values);
Stephen Hines176edba2014-12-01 14:53:08 -08003336 std::string Name("OBJC_CLASS_");
Fariborz Jahanianb0069ee2009-11-12 20:14:24 +00003337 Name += ClassName;
3338 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3339 // Check for a forward reference.
Stephen Hines651f13c2014-04-23 16:59:28 -07003340 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianb0069ee2009-11-12 20:14:24 +00003341 if (GV) {
3342 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3343 "Forward metaclass reference has incorrect type.");
Fariborz Jahanianb0069ee2009-11-12 20:14:24 +00003344 GV->setInitializer(Init);
3345 GV->setSection(Section);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003346 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Stephen Hines651f13c2014-04-23 16:59:28 -07003347 CGM.addCompilerUsedGlobal(GV);
3348 } else
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003349 GV = CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003350 DefinedClasses.push_back(GV);
Stephen Hines651f13c2014-04-23 16:59:28 -07003351 ImplementedClasses.push_back(Interface);
Fariborz Jahanian64089ce2011-04-22 22:02:28 +00003352 // method definition entries must be clear for next implementation.
3353 MethodDefinitions.clear();
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003354}
3355
3356llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3357 llvm::Constant *Protocols,
Bill Wendlingbb028552012-02-07 09:25:09 +00003358 ArrayRef<llvm::Constant*> Methods) {
John McCall621915c2012-10-17 04:53:23 +00003359 unsigned Flags = FragileABI_Class_Meta;
Micah Villmow25a6a842012-10-08 16:25:52 +00003360 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003361
John McCall1fb0caa2010-10-22 21:05:15 +00003362 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCall621915c2012-10-17 04:53:23 +00003363 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003364
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003365 llvm::Constant *Values[12];
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003366 // The isa for the metaclass is the root of the hierarchy.
3367 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3368 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3369 Root = Super;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003370 Values[ 0] =
Stephen Hines176edba2014-12-01 14:53:08 -08003371 llvm::ConstantExpr::getBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003372 ObjCTypes.ClassPtrTy);
Daniel Dunbar86e253a2008-08-22 20:34:54 +00003373 // The super class for the metaclass is emitted as the name of the
3374 // super class. The runtime fixes this up to point to the
3375 // *metaclass* for the super class.
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003376 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003377 Values[ 1] =
Stephen Hines176edba2014-12-01 14:53:08 -08003378 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003379 ObjCTypes.ClassPtrTy);
3380 } else {
Owen Andersonc9c88b42009-07-31 20:28:54 +00003381 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003382 }
Stephen Hines176edba2014-12-01 14:53:08 -08003383 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003384 // Version is always 0.
Owen Anderson4a28d5d2009-07-24 23:12:58 +00003385 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3386 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
3387 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size);
Fariborz Jahanian46b86c62009-01-28 19:12:34 +00003388 Values[ 6] = EmitIvarList(ID, true);
Stephen Hines176edba2014-12-01 14:53:08 -08003389 Values[7] =
3390 EmitMethodList("OBJC_CLASS_METHODS_" + ID->getNameAsString(),
3391 "__OBJC,__cls_meth,regular,no_dead_strip", Methods);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003392 // cache is always NULL.
Owen Andersonc9c88b42009-07-31 20:28:54 +00003393 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003394 Values[ 9] = Protocols;
3395 // ivar_layout for metaclass is always NULL.
Owen Andersonc9c88b42009-07-31 20:28:54 +00003396 Values[10] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003397 // The class extension is used to store class properties for metaclasses.
3398 Values[11] = EmitClassExtension(ID, CharUnits::Zero(), false/*hasMRCWeak*/,
3399 true/*isClassProperty*/);
Owen Anderson08e25242009-07-27 22:29:56 +00003400 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003401 Values);
3402
Stephen Hines176edba2014-12-01 14:53:08 -08003403 std::string Name("OBJC_METACLASS_");
Benjamin Kramer94be8ea2012-07-31 11:45:39 +00003404 Name += ID->getName();
Daniel Dunbarf56f1912008-08-25 08:19:24 +00003405
3406 // Check for a forward reference.
Stephen Hines651f13c2014-04-23 16:59:28 -07003407 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarf56f1912008-08-25 08:19:24 +00003408 if (GV) {
3409 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3410 "Forward metaclass reference has incorrect type.");
Daniel Dunbarf56f1912008-08-25 08:19:24 +00003411 GV->setInitializer(Init);
3412 } else {
Owen Anderson1c431b32009-07-08 19:05:04 +00003413 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Stephen Hines651f13c2014-04-23 16:59:28 -07003414 llvm::GlobalValue::PrivateLinkage,
Owen Anderson1c431b32009-07-08 19:05:04 +00003415 Init, Name);
Daniel Dunbarf56f1912008-08-25 08:19:24 +00003416 }
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003417 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Daniel Dunbar58a29122009-03-09 22:18:41 +00003418 GV->setAlignment(4);
Stephen Hines651f13c2014-04-23 16:59:28 -07003419 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003420
3421 return GV;
3422}
3423
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003424llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Stephen Hines176edba2014-12-01 14:53:08 -08003425 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarf56f1912008-08-25 08:19:24 +00003426
Mike Stumpf5408fe2009-05-16 07:57:57 +00003427 // FIXME: Should we look these up somewhere other than the module. Its a bit
3428 // silly since we only generate these while processing an implementation, so
3429 // exactly one pointer would work if know when we entered/exitted an
3430 // implementation block.
Daniel Dunbarf56f1912008-08-25 08:19:24 +00003431
3432 // Check for an existing forward reference.
Fariborz Jahanianb0d27942009-01-07 20:11:22 +00003433 // Previously, metaclass with internal linkage may have been defined.
3434 // pass 'true' as 2nd argument so it is returned.
Stephen Hines651f13c2014-04-23 16:59:28 -07003435 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3436 if (!GV)
3437 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Stephen Hines6bcf27b2014-05-29 04:14:42 -07003438 llvm::GlobalValue::PrivateLinkage, nullptr,
3439 Name);
Stephen Hines651f13c2014-04-23 16:59:28 -07003440
3441 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3442 "Forward metaclass reference has incorrect type.");
Stephen Hines651f13c2014-04-23 16:59:28 -07003443 return GV;
Daniel Dunbarf56f1912008-08-25 08:19:24 +00003444}
3445
Fariborz Jahanianb0069ee2009-11-12 20:14:24 +00003446llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Stephen Hines176edba2014-12-01 14:53:08 -08003447 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Stephen Hines651f13c2014-04-23 16:59:28 -07003448 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3449
3450 if (!GV)
3451 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Stephen Hines6bcf27b2014-05-29 04:14:42 -07003452 llvm::GlobalValue::PrivateLinkage, nullptr,
3453 Name);
Stephen Hines651f13c2014-04-23 16:59:28 -07003454
3455 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3456 "Forward class metadata reference has incorrect type.");
Stephen Hines651f13c2014-04-23 16:59:28 -07003457 return GV;
Fariborz Jahanianb0069ee2009-11-12 20:14:24 +00003458}
3459
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003460/*
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003461 Emit a "class extension", which in this specific context means extra
3462 data that doesn't fit in the normal fragile-ABI class structure, and
3463 has nothing to do with the language concept of a class extension.
3464
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003465 struct objc_class_ext {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003466 uint32_t size;
3467 const char *weak_ivar_layout;
3468 struct _objc_property_list *properties;
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003469 };
3470*/
3471llvm::Constant *
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003472CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003473 CharUnits InstanceSize, bool hasMRCWeakIvars,
3474 bool isClassProperty) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003475 uint64_t Size =
Micah Villmow25a6a842012-10-08 16:25:52 +00003476 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003477
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003478 llvm::Constant *Values[3];
Owen Anderson4a28d5d2009-07-24 23:12:58 +00003479 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003480 if (isClassProperty) {
3481 llvm::Type *PtrTy = CGM.Int8PtrTy;
3482 Values[1] = llvm::Constant::getNullValue(PtrTy);
3483 } else
3484 Values[1] = BuildWeakIvarLayout(ID, CharUnits::Zero(), InstanceSize,
3485 hasMRCWeakIvars);
3486 if (isClassProperty)
3487 Values[2] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getName(),
3488 ID, ID->getClassInterface(), ObjCTypes, true);
3489 else
3490 Values[2] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getName(),
3491 ID, ID->getClassInterface(), ObjCTypes, false);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003492
3493 // Return null if no extension bits are used.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003494 if ((!Values[1] || Values[1]->isNullValue()) && Values[2]->isNullValue())
Owen Andersonc9c88b42009-07-31 20:28:54 +00003495 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003496
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003497 llvm::Constant *Init =
Owen Anderson08e25242009-07-27 22:29:56 +00003498 llvm::ConstantStruct::get(ObjCTypes.ClassExtensionTy, Values);
Stephen Hines176edba2014-12-01 14:53:08 -08003499 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), Init,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003500 "__OBJC,__class_ext,regular,no_dead_strip",
3501 CGM.getPointerAlign(), true);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003502}
3503
3504/*
3505 struct objc_ivar {
Bill Wendling795b1002012-02-22 09:30:11 +00003506 char *ivar_name;
3507 char *ivar_type;
3508 int ivar_offset;
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003509 };
3510
3511 struct objc_ivar_list {
Bill Wendling795b1002012-02-22 09:30:11 +00003512 int ivar_count;
3513 struct objc_ivar list[count];
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003514 };
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003515*/
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003516llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanian46b86c62009-01-28 19:12:34 +00003517 bool ForClass) {
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00003518 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003519
3520 // When emitting the root class GCC emits ivar entries for the
3521 // actual class structure. It is not clear if we need to follow this
3522 // behavior; for now lets try and get away with not doing it. If so,
3523 // the cleanest solution would be to make up an ObjCInterfaceDecl
3524 // for the class.
3525 if (ForClass)
Owen Andersonc9c88b42009-07-31 20:28:54 +00003526 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003527
Jordy Rosedb8264e2011-07-22 02:08:32 +00003528 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003529
Jordy Rosedb8264e2011-07-22 02:08:32 +00003530 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianbf9eb882011-06-28 18:05:25 +00003531 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian8e6ac1d2009-06-04 01:19:09 +00003532 // Ignore unnamed bit-fields.
3533 if (!IVD->getDeclName())
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003534 continue;
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00003535 llvm::Constant *Ivar[] = {
3536 GetMethodVarName(IVD->getIdentifier()),
3537 GetMethodVarType(IVD),
3538 llvm::ConstantInt::get(ObjCTypes.IntTy,
Eli Friedmane5b46662012-11-06 22:15:52 +00003539 ComputeIvarBaseOffset(CGM, OID, IVD))
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00003540 };
Owen Anderson08e25242009-07-27 22:29:56 +00003541 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarTy, Ivar));
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003542 }
3543
3544 // Return null for empty list.
3545 if (Ivars.empty())
Owen Andersonc9c88b42009-07-31 20:28:54 +00003546 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003547
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003548 llvm::Constant *Values[2];
Owen Anderson4a28d5d2009-07-24 23:12:58 +00003549 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson96e0fc72009-07-29 22:16:19 +00003550 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarTy,
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003551 Ivars.size());
Owen Anderson7db6d832009-07-28 18:33:04 +00003552 Values[1] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003553 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003554
Daniel Dunbar63c5b502009-03-09 21:49:58 +00003555 llvm::GlobalVariable *GV;
3556 if (ForClass)
Stephen Hines176edba2014-12-01 14:53:08 -08003557 GV =
3558 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), Init,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003559 "__OBJC,__class_vars,regular,no_dead_strip",
3560 CGM.getPointerAlign(), true);
Daniel Dunbar63c5b502009-03-09 21:49:58 +00003561 else
Stephen Hines176edba2014-12-01 14:53:08 -08003562 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), Init,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003563 "__OBJC,__instance_vars,regular,no_dead_strip",
3564 CGM.getPointerAlign(), true);
Owen Anderson3c4972d2009-07-29 18:54:39 +00003565 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003566}
3567
3568/*
3569 struct objc_method {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003570 SEL method_name;
3571 char *method_types;
3572 void *method;
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003573 };
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003574
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003575 struct objc_method_list {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003576 struct objc_method_list *obsolete;
3577 int count;
3578 struct objc_method methods_list[count];
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003579 };
3580*/
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003581
3582/// GetMethodConstant - Return a struct objc_method constant for the
3583/// given method if it has been defined. The result is null if the
3584/// method has not been defined. The return value has type MethodPtrTy.
Daniel Dunbarae226fa2008-08-27 02:31:56 +00003585llvm::Constant *CGObjCMac::GetMethodConstant(const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis9d50c062010-08-09 10:54:20 +00003586 llvm::Function *Fn = GetMethodDefinition(MD);
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003587 if (!Fn)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07003588 return nullptr;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003589
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00003590 llvm::Constant *Method[] = {
Owen Anderson3c4972d2009-07-29 18:54:39 +00003591 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00003592 ObjCTypes.SelectorPtrTy),
3593 GetMethodVarType(MD),
3594 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
3595 };
Owen Anderson08e25242009-07-27 22:29:56 +00003596 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003597}
3598
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003599llvm::Constant *CGObjCMac::EmitMethodList(Twine Name, StringRef Section,
3600 ArrayRef<llvm::Constant *> Methods) {
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003601 // Return null for empty list.
3602 if (Methods.empty())
Owen Andersonc9c88b42009-07-31 20:28:54 +00003603 return llvm::Constant::getNullValue(ObjCTypes.MethodListPtrTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003604
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003605 llvm::Constant *Values[3];
Owen Andersonc9c88b42009-07-31 20:28:54 +00003606 Values[0] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Anderson4a28d5d2009-07-24 23:12:58 +00003607 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson96e0fc72009-07-29 22:16:19 +00003608 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003609 Methods.size());
Owen Anderson7db6d832009-07-28 18:33:04 +00003610 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003611 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00003612
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003613 llvm::GlobalVariable *GV =
3614 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00003615 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00003616}
3617
Fariborz Jahanian493dab72009-01-26 21:38:32 +00003618llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003619 const ObjCContainerDecl *CD) {
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00003620 SmallString<256> Name;
Fariborz Jahanian679a5022009-01-10 21:06:09 +00003621 GetNameForMethod(OMD, CD, Name);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00003622
Daniel Dunbar541b63b2009-02-02 23:23:47 +00003623 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2acc6e32011-07-18 04:24:23 +00003624 llvm::FunctionType *MethodTy =
John McCallde5d3c72012-02-17 03:33:10 +00003625 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003626 llvm::Function *Method =
Daniel Dunbar45c25ba2008-09-10 04:01:49 +00003627 llvm::Function::Create(MethodTy,
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00003628 llvm::GlobalValue::InternalLinkage,
Daniel Dunbarc575ce72009-10-19 01:21:19 +00003629 Name.str(),
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00003630 &CGM.getModule());
Daniel Dunbarc45ef602008-08-26 21:51:14 +00003631 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00003632
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00003633 return Method;
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00003634}
3635
Stephen Hinesc568f1e2014-07-21 00:47:37 -07003636llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
3637 llvm::Constant *Init,
3638 StringRef Section,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003639 CharUnits Align,
Stephen Hinesc568f1e2014-07-21 00:47:37 -07003640 bool AddToUsed) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00003641 llvm::Type *Ty = Init->getType();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003642 llvm::GlobalVariable *GV =
Owen Anderson1c431b32009-07-08 19:05:04 +00003643 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Stephen Hines651f13c2014-04-23 16:59:28 -07003644 llvm::GlobalValue::PrivateLinkage, Init, Name);
Stephen Hinesc568f1e2014-07-21 00:47:37 -07003645 if (!Section.empty())
Daniel Dunbarfd65d372009-03-09 20:09:19 +00003646 GV->setSection(Section);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003647 GV->setAlignment(Align.getQuantity());
Daniel Dunbar35bd7632009-03-09 20:50:13 +00003648 if (AddToUsed)
Stephen Hines651f13c2014-04-23 16:59:28 -07003649 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbarfd65d372009-03-09 20:09:19 +00003650 return GV;
3651}
3652
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003653llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbarf77ac862008-08-11 21:35:06 +00003654 // Abuse this interface function as a place to finalize.
3655 FinishModule();
Stephen Hines6bcf27b2014-05-29 04:14:42 -07003656 return nullptr;
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00003657}
3658
Chris Lattner74391b42009-03-22 21:03:39 +00003659llvm::Constant *CGObjCMac::GetPropertyGetFunction() {
Chris Lattner72db6c32009-04-22 02:44:54 +00003660 return ObjCTypes.getGetPropertyFn();
Daniel Dunbar49f66022008-09-24 03:38:44 +00003661}
3662
Chris Lattner74391b42009-03-22 21:03:39 +00003663llvm::Constant *CGObjCMac::GetPropertySetFunction() {
Chris Lattner72db6c32009-04-22 02:44:54 +00003664 return ObjCTypes.getSetPropertyFn();
Daniel Dunbar49f66022008-09-24 03:38:44 +00003665}
3666
Ted Kremenekebcb57a2012-03-06 20:05:56 +00003667llvm::Constant *CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
3668 bool copy) {
3669 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
3670}
3671
David Chisnall8fac25d2010-12-26 22:13:16 +00003672llvm::Constant *CGObjCMac::GetGetStructFunction() {
3673 return ObjCTypes.getCopyStructFn();
3674}
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003675
David Chisnall8fac25d2010-12-26 22:13:16 +00003676llvm::Constant *CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian6cc59062010-04-12 18:18:10 +00003677 return ObjCTypes.getCopyStructFn();
3678}
3679
David Chisnalld397cfe2012-12-17 18:54:24 +00003680llvm::Constant *CGObjCMac::GetCppAtomicObjectGetFunction() {
3681 return ObjCTypes.getCppAtomicObjectFunction();
3682}
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003683
David Chisnalld397cfe2012-12-17 18:54:24 +00003684llvm::Constant *CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahaniane3173022012-01-06 18:07:23 +00003685 return ObjCTypes.getCppAtomicObjectFunction();
3686}
3687
Chris Lattner74391b42009-03-22 21:03:39 +00003688llvm::Constant *CGObjCMac::EnumerationMutationFunction() {
Chris Lattner72db6c32009-04-22 02:44:54 +00003689 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson2abd89c2008-08-31 04:05:03 +00003690}
3691
John McCallf1549f62010-07-06 01:34:17 +00003692void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
3693 return EmitTryOrSynchronizedStmt(CGF, S);
3694}
3695
3696void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
3697 const ObjCAtSynchronizedStmt &S) {
3698 return EmitTryOrSynchronizedStmt(CGF, S);
3699}
3700
John McCallcc505292010-07-21 06:59:36 +00003701namespace {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003702 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCallcc505292010-07-21 06:59:36 +00003703 const Stmt &S;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003704 Address SyncArgSlot;
3705 Address CallTryExitVar;
3706 Address ExceptionData;
John McCallcc505292010-07-21 06:59:36 +00003707 ObjCTypesHelper &ObjCTypes;
3708 PerformFragileFinally(const Stmt *S,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003709 Address SyncArgSlot,
3710 Address CallTryExitVar,
3711 Address ExceptionData,
John McCallcc505292010-07-21 06:59:36 +00003712 ObjCTypesHelper *ObjCTypes)
John McCall0b251722010-08-04 05:59:32 +00003713 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCallcc505292010-07-21 06:59:36 +00003714 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
3715
Stephen Hines651f13c2014-04-23 16:59:28 -07003716 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCallcc505292010-07-21 06:59:36 +00003717 // Check whether we need to call objc_exception_try_exit.
3718 // In optimized code, this branch will always be folded.
3719 llvm::BasicBlock *FinallyCallExit =
3720 CGF.createBasicBlock("finally.call_exit");
3721 llvm::BasicBlock *FinallyNoCallExit =
3722 CGF.createBasicBlock("finally.no_call_exit");
3723 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
3724 FinallyCallExit, FinallyNoCallExit);
3725
3726 CGF.EmitBlock(FinallyCallExit);
John McCallbd7370a2013-02-28 19:01:20 +00003727 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003728 ExceptionData.getPointer());
John McCallcc505292010-07-21 06:59:36 +00003729
3730 CGF.EmitBlock(FinallyNoCallExit);
3731
3732 if (isa<ObjCAtTryStmt>(S)) {
3733 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCalld96a8e72010-08-11 00:16:14 +00003734 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall73c56bb2013-04-03 00:56:07 +00003735 // Don't try to do the @finally if this is an EH cleanup.
3736 if (flags.isForEHCleanup()) return;
3737
John McCalld96a8e72010-08-11 00:16:14 +00003738 // Save the current cleanup destination in case there's
3739 // control flow inside the finally statement.
3740 llvm::Value *CurCleanupDest =
3741 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
3742
John McCallcc505292010-07-21 06:59:36 +00003743 CGF.EmitStmt(FinallyStmt->getFinallyBody());
3744
John McCalld96a8e72010-08-11 00:16:14 +00003745 if (CGF.HaveInsertPoint()) {
3746 CGF.Builder.CreateStore(CurCleanupDest,
3747 CGF.getNormalCleanupDestSlot());
3748 } else {
3749 // Currently, the end of the cleanup must always exist.
3750 CGF.EnsureInsertPoint();
3751 }
3752 }
John McCallcc505292010-07-21 06:59:36 +00003753 } else {
3754 // Emit objc_sync_exit(expr); as finally's sole statement for
3755 // @synchronized.
John McCall0b251722010-08-04 05:59:32 +00003756 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCallbd7370a2013-02-28 19:01:20 +00003757 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCallcc505292010-07-21 06:59:36 +00003758 }
3759 }
3760 };
John McCall87bb5822010-07-31 23:20:56 +00003761
3762 class FragileHazards {
3763 CodeGenFunction &CGF;
Chris Lattner5f9e2722011-07-23 10:55:15 +00003764 SmallVector<llvm::Value*, 20> Locals;
John McCall87bb5822010-07-31 23:20:56 +00003765 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
3766
3767 llvm::InlineAsm *ReadHazard;
3768 llvm::InlineAsm *WriteHazard;
3769
3770 llvm::FunctionType *GetAsmFnType();
3771
3772 void collectLocals();
3773 void emitReadHazard(CGBuilderTy &Builder);
3774
3775 public:
3776 FragileHazards(CodeGenFunction &CGF);
John McCall0b251722010-08-04 05:59:32 +00003777
John McCall87bb5822010-07-31 23:20:56 +00003778 void emitWriteHazard();
John McCall0b251722010-08-04 05:59:32 +00003779 void emitHazardsInNewBlocks();
John McCall87bb5822010-07-31 23:20:56 +00003780 };
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07003781} // end anonymous namespace
John McCall87bb5822010-07-31 23:20:56 +00003782
3783/// Create the fragile-ABI read and write hazards based on the current
3784/// state of the function, which is presumed to be immediately prior
3785/// to a @try block. These hazards are used to maintain correct
3786/// semantics in the face of optimization and the fragile ABI's
3787/// cavalier use of setjmp/longjmp.
3788FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
3789 collectLocals();
3790
3791 if (Locals.empty()) return;
3792
3793 // Collect all the blocks in the function.
3794 for (llvm::Function::iterator
3795 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
3796 BlocksBeforeTry.insert(&*I);
3797
3798 llvm::FunctionType *AsmFnTy = GetAsmFnType();
3799
3800 // Create a read hazard for the allocas. This inhibits dead-store
3801 // optimizations and forces the values to memory. This hazard is
3802 // inserted before any 'throwing' calls in the protected scope to
3803 // reflect the possibility that the variables might be read from the
3804 // catch block if the call throws.
3805 {
3806 std::string Constraint;
3807 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3808 if (I) Constraint += ',';
3809 Constraint += "*m";
3810 }
3811
3812 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3813 }
3814
3815 // Create a write hazard for the allocas. This inhibits folding
3816 // loads across the hazard. This hazard is inserted at the
3817 // beginning of the catch path to reflect the possibility that the
3818 // variables might have been written within the protected scope.
3819 {
3820 std::string Constraint;
3821 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3822 if (I) Constraint += ',';
3823 Constraint += "=*m";
3824 }
3825
3826 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3827 }
3828}
3829
3830/// Emit a write hazard at the current location.
3831void FragileHazards::emitWriteHazard() {
3832 if (Locals.empty()) return;
3833
John McCallbd7370a2013-02-28 19:01:20 +00003834 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall87bb5822010-07-31 23:20:56 +00003835}
3836
John McCall87bb5822010-07-31 23:20:56 +00003837void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
3838 assert(!Locals.empty());
John McCallbd7370a2013-02-28 19:01:20 +00003839 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
3840 call->setDoesNotThrow();
3841 call->setCallingConv(CGF.getRuntimeCC());
John McCall87bb5822010-07-31 23:20:56 +00003842}
3843
3844/// Emit read hazards in all the protected blocks, i.e. all the blocks
3845/// which have been inserted since the beginning of the try.
John McCall0b251722010-08-04 05:59:32 +00003846void FragileHazards::emitHazardsInNewBlocks() {
John McCall87bb5822010-07-31 23:20:56 +00003847 if (Locals.empty()) return;
3848
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003849 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall87bb5822010-07-31 23:20:56 +00003850
3851 // Iterate through all blocks, skipping those prior to the try.
3852 for (llvm::Function::iterator
3853 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
3854 llvm::BasicBlock &BB = *FI;
3855 if (BlocksBeforeTry.count(&BB)) continue;
3856
3857 // Walk through all the calls in the block.
3858 for (llvm::BasicBlock::iterator
3859 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
3860 llvm::Instruction &I = *BI;
3861
3862 // Ignore instructions that aren't non-intrinsic calls.
3863 // These are the only calls that can possibly call longjmp.
3864 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I)) continue;
3865 if (isa<llvm::IntrinsicInst>(I))
3866 continue;
3867
3868 // Ignore call sites marked nounwind. This may be questionable,
3869 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
3870 llvm::CallSite CS(&I);
3871 if (CS.doesNotThrow()) continue;
3872
John McCall0b251722010-08-04 05:59:32 +00003873 // Insert a read hazard before the call. This will ensure that
3874 // any writes to the locals are performed before making the
3875 // call. If the call throws, then this is sufficient to
3876 // guarantee correctness as long as it doesn't also write to any
3877 // locals.
John McCall87bb5822010-07-31 23:20:56 +00003878 Builder.SetInsertPoint(&BB, BI);
3879 emitReadHazard(Builder);
3880 }
3881 }
3882}
3883
3884static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, llvm::Value *V) {
3885 if (V) S.insert(V);
3886}
3887
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08003888static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
3889 if (V.isValid()) S.insert(V.getPointer());
3890}
3891
John McCall87bb5822010-07-31 23:20:56 +00003892void FragileHazards::collectLocals() {
3893 // Compute a set of allocas to ignore.
3894 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
3895 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
3896 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall87bb5822010-07-31 23:20:56 +00003897
3898 // Collect all the allocas currently in the function. This is
3899 // probably way too aggressive.
3900 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
3901 for (llvm::BasicBlock::iterator
3902 I = Entry.begin(), E = Entry.end(); I != E; ++I)
3903 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
3904 Locals.push_back(&*I);
3905}
3906
3907llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner5f9e2722011-07-23 10:55:15 +00003908 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall0774cb82011-05-15 01:53:33 +00003909 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
3910 tys[i] = Locals[i]->getType();
3911 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCallcc505292010-07-21 06:59:36 +00003912}
3913
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003914/*
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003915
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003916 Objective-C setjmp-longjmp (sjlj) Exception Handling
3917 --
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003918
John McCallf1549f62010-07-06 01:34:17 +00003919 A catch buffer is a setjmp buffer plus:
3920 - a pointer to the exception that was caught
3921 - a pointer to the previous exception data buffer
3922 - two pointers of reserved storage
3923 Therefore catch buffers form a stack, with a pointer to the top
3924 of the stack kept in thread-local storage.
3925
3926 objc_exception_try_enter pushes a catch buffer onto the EH stack.
3927 objc_exception_try_exit pops the given catch buffer, which is
3928 required to be the top of the EH stack.
3929 objc_exception_throw pops the top of the EH stack, writes the
3930 thrown exception into the appropriate field, and longjmps
3931 to the setjmp buffer. It crashes the process (with a printf
3932 and an abort()) if there are no catch buffers on the stack.
3933 objc_exception_extract just reads the exception pointer out of the
3934 catch buffer.
3935
3936 There's no reason an implementation couldn't use a light-weight
3937 setjmp here --- something like __builtin_setjmp, but API-compatible
3938 with the heavyweight setjmp. This will be more important if we ever
3939 want to implement correct ObjC/C++ exception interactions for the
3940 fragile ABI.
3941
3942 Note that for this use of setjmp/longjmp to be correct, we may need
3943 to mark some local variables volatile: if a non-volatile local
3944 variable is modified between the setjmp and the longjmp, it has
3945 indeterminate value. For the purposes of LLVM IR, it may be
3946 sufficient to make loads and stores within the @try (to variables
3947 declared outside the @try) volatile. This is necessary for
3948 optimized correctness, but is not currently being done; this is
3949 being tracked as rdar://problem/8160285
3950
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003951 The basic framework for a @try-catch-finally is as follows:
3952 {
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003953 objc_exception_data d;
3954 id _rethrow = null;
Anders Carlsson190d00e2009-02-07 21:26:04 +00003955 bool _call_try_exit = true;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003956
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003957 objc_exception_try_enter(&d);
3958 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003959 ... try body ...
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003960 } else {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003961 // exception path
3962 id _caught = objc_exception_extract(&d);
3963
3964 // enter new try scope for handlers
3965 if (!setjmp(d.jmp_buf)) {
3966 ... match exception and execute catch blocks ...
3967
3968 // fell off end, rethrow.
3969 _rethrow = _caught;
3970 ... jump-through-finally to finally_rethrow ...
3971 } else {
3972 // exception in catch block
3973 _rethrow = objc_exception_extract(&d);
3974 _call_try_exit = false;
3975 ... jump-through-finally to finally_rethrow ...
3976 }
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003977 }
Daniel Dunbar898d5082008-09-30 01:06:03 +00003978 ... jump-through-finally to finally_end ...
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003979
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003980 finally:
Anders Carlsson190d00e2009-02-07 21:26:04 +00003981 if (_call_try_exit)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003982 objc_exception_try_exit(&d);
Anders Carlsson190d00e2009-02-07 21:26:04 +00003983
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003984 ... finally block ....
Daniel Dunbar898d5082008-09-30 01:06:03 +00003985 ... dispatch to finally destination ...
3986
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003987 finally_rethrow:
Daniel Dunbar898d5082008-09-30 01:06:03 +00003988 objc_exception_throw(_rethrow);
3989
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003990 finally_end:
3991 }
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003992
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003993 This framework differs slightly from the one gcc uses, in that gcc
3994 uses _rethrow to determine if objc_exception_try_exit should be called
3995 and if the object should be rethrown. This breaks in the face of
3996 throwing nil and introduces unnecessary branches.
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003997
Daniel Dunbar6bff2512009-08-03 17:06:42 +00003998 We specialize this framework for a few particular circumstances:
Daniel Dunbar18ccc772008-09-28 01:03:14 +00003999
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004000 - If there are no catch blocks, then we avoid emitting the second
4001 exception handling context.
Daniel Dunbar18ccc772008-09-28 01:03:14 +00004002
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004003 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
4004 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbar18ccc772008-09-28 01:03:14 +00004005
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004006 - FIXME: If there is no @finally block we can do a few more
4007 simplifications.
Daniel Dunbar18ccc772008-09-28 01:03:14 +00004008
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004009 Rethrows and Jumps-Through-Finally
4010 --
Daniel Dunbar18ccc772008-09-28 01:03:14 +00004011
John McCallf1549f62010-07-06 01:34:17 +00004012 '@throw;' is supported by pushing the currently-caught exception
4013 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbar18ccc772008-09-28 01:03:14 +00004014
John McCallf1549f62010-07-06 01:34:17 +00004015 Branches through the @finally block are handled with an ordinary
4016 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
4017 exceptions are not compatible with C++ exceptions, and this is
4018 hardly the only place where this will go wrong.
Daniel Dunbar898d5082008-09-30 01:06:03 +00004019
John McCallf1549f62010-07-06 01:34:17 +00004020 @synchronized(expr) { stmt; } is emitted as if it were:
4021 id synch_value = expr;
4022 objc_sync_enter(synch_value);
4023 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbar18ccc772008-09-28 01:03:14 +00004024*/
4025
Fariborz Jahanianbd71be42008-11-21 00:49:24 +00004026void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
4027 const Stmt &S) {
4028 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallf1549f62010-07-06 01:34:17 +00004029
4030 // A destination for the fall-through edges of the catch handlers to
4031 // jump to.
4032 CodeGenFunction::JumpDest FinallyEnd =
4033 CGF.getJumpDestInCurrentScope("finally.end");
4034
4035 // A destination for the rethrow edge of the catch handlers to jump
4036 // to.
4037 CodeGenFunction::JumpDest FinallyRethrow =
4038 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004039
Daniel Dunbar1c566672009-02-24 01:43:46 +00004040 // For @synchronized, call objc_sync_enter(sync.expr). The
4041 // evaluation of the expression must occur before we enter the
John McCall0b251722010-08-04 05:59:32 +00004042 // @synchronized. We can't avoid a temp here because we need the
4043 // value to be preserved. If the backend ever does liveness
4044 // correctly after setjmp, this will be unnecessary.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004045 Address SyncArgSlot = Address::invalid();
Daniel Dunbar1c566672009-02-24 01:43:46 +00004046 if (!isTry) {
John McCall0b251722010-08-04 05:59:32 +00004047 llvm::Value *SyncArg =
Daniel Dunbar1c566672009-02-24 01:43:46 +00004048 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
4049 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCallbd7370a2013-02-28 19:01:20 +00004050 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall0b251722010-08-04 05:59:32 +00004051
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004052 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
4053 CGF.getPointerAlign(), "sync.arg");
John McCall0b251722010-08-04 05:59:32 +00004054 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar1c566672009-02-24 01:43:46 +00004055 }
Daniel Dunbar898d5082008-09-30 01:06:03 +00004056
John McCall0b251722010-08-04 05:59:32 +00004057 // Allocate memory for the setjmp buffer. This needs to be kept
4058 // live throughout the try and catch blocks.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004059 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
4060 CGF.getPointerAlign(),
4061 "exceptiondata.ptr");
John McCall0b251722010-08-04 05:59:32 +00004062
John McCall87bb5822010-07-31 23:20:56 +00004063 // Create the fragile hazards. Note that this will not capture any
4064 // of the allocas required for exception processing, but will
4065 // capture the current basic block (which extends all the way to the
4066 // setjmp call) as "before the @try".
4067 FragileHazards Hazards(CGF);
4068
John McCallf1549f62010-07-06 01:34:17 +00004069 // Create a flag indicating whether the cleanup needs to call
4070 // objc_exception_try_exit. This is true except when
4071 // - no catches match and we're branching through the cleanup
4072 // just to rethrow the exception, or
4073 // - a catch matched and we're falling out of the catch handler.
John McCall0b251722010-08-04 05:59:32 +00004074 // The setjmp-safety rule here is that we should always store to this
4075 // variable in a place that dominates the branch through the cleanup
4076 // without passing through any setjmps.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004077 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
4078 CharUnits::One(),
4079 "_call_try_exit");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004080
John McCall9e2213d2010-10-04 23:42:51 +00004081 // A slot containing the exception to rethrow. Only needed when we
4082 // have both a @catch and a @finally.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004083 Address PropagatingExnVar = Address::invalid();
John McCall9e2213d2010-10-04 23:42:51 +00004084
John McCallf1549f62010-07-06 01:34:17 +00004085 // Push a normal cleanup to leave the try scope.
John McCall73c56bb2013-04-03 00:56:07 +00004086 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall0b251722010-08-04 05:59:32 +00004087 SyncArgSlot,
John McCall1f0fca52010-07-21 07:22:38 +00004088 CallTryExitVar,
4089 ExceptionData,
4090 &ObjCTypes);
John McCallf1549f62010-07-06 01:34:17 +00004091
4092 // Enter a try block:
4093 // - Call objc_exception_try_enter to push ExceptionData on top of
4094 // the EH stack.
Stephen Hines0e2c34f2015-03-23 12:09:02 -07004095 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004096 ExceptionData.getPointer());
John McCallf1549f62010-07-06 01:34:17 +00004097
4098 // - Call setjmp on the exception data buffer.
4099 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
4100 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07004101 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004102 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
4103 "setjmp_buffer");
Stephen Hines0e2c34f2015-03-23 12:09:02 -07004104 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
4105 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendling6446c3e2011-12-19 23:53:28 +00004106 SetJmpResult->setCanReturnTwice();
John McCallf1549f62010-07-06 01:34:17 +00004107
4108 // If setjmp returned 0, enter the protected block; otherwise,
4109 // branch to the handler.
Daniel Dunbar55e87422008-11-11 02:29:29 +00004110 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
4111 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallf1549f62010-07-06 01:34:17 +00004112 llvm::Value *DidCatch =
John McCalld96a8e72010-08-11 00:16:14 +00004113 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4114 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson80f25672008-09-09 17:59:25 +00004115
John McCallf1549f62010-07-06 01:34:17 +00004116 // Emit the protected block.
Anders Carlsson80f25672008-09-09 17:59:25 +00004117 CGF.EmitBlock(TryBlock);
John McCall0b251722010-08-04 05:59:32 +00004118 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004119 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallf1549f62010-07-06 01:34:17 +00004120 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall0b251722010-08-04 05:59:32 +00004121
4122 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004123
John McCallf1549f62010-07-06 01:34:17 +00004124 // Emit the exception handler block.
Daniel Dunbare4b5ee02008-09-27 23:30:04 +00004125 CGF.EmitBlock(TryHandler);
Daniel Dunbar55e40722008-09-27 07:03:52 +00004126
John McCall87bb5822010-07-31 23:20:56 +00004127 // Don't optimize loads of the in-scope locals across this point.
4128 Hazards.emitWriteHazard();
4129
John McCallf1549f62010-07-06 01:34:17 +00004130 // For a @synchronized (or a @try with no catches), just branch
4131 // through the cleanup to the rethrow block.
4132 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
4133 // Tell the cleanup not to re-pop the exit.
John McCall0b251722010-08-04 05:59:32 +00004134 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonf3a79a92009-02-09 20:38:58 +00004135 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallf1549f62010-07-06 01:34:17 +00004136
4137 // Otherwise, we have to match against the caught exceptions.
4138 } else {
John McCall0b251722010-08-04 05:59:32 +00004139 // Retrieve the exception object. We may emit multiple blocks but
4140 // nothing can cross this so the value is already in SSA form.
4141 llvm::CallInst *Caught =
John McCallbd7370a2013-02-28 19:01:20 +00004142 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004143 ExceptionData.getPointer(), "caught");
John McCall0b251722010-08-04 05:59:32 +00004144
John McCallf1549f62010-07-06 01:34:17 +00004145 // Push the exception to rethrow onto the EH value stack for the
4146 // benefit of any @throws in the handlers.
4147 CGF.ObjCEHValueStack.push_back(Caught);
4148
Douglas Gregor8f5e3dd2010-04-23 22:50:49 +00004149 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004150
Stephen Hines6bcf27b2014-05-29 04:14:42 -07004151 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallf1549f62010-07-06 01:34:17 +00004152
Stephen Hines6bcf27b2014-05-29 04:14:42 -07004153 llvm::BasicBlock *CatchBlock = nullptr;
4154 llvm::BasicBlock *CatchHandler = nullptr;
John McCall0b251722010-08-04 05:59:32 +00004155 if (HasFinally) {
John McCall9e2213d2010-10-04 23:42:51 +00004156 // Save the currently-propagating exception before
4157 // objc_exception_try_enter clears the exception slot.
4158 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004159 CGF.getPointerAlign(),
John McCall9e2213d2010-10-04 23:42:51 +00004160 "propagating_exception");
4161 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
4162
John McCall0b251722010-08-04 05:59:32 +00004163 // Enter a new exception try block (in case a @catch block
4164 // throws an exception).
John McCallbd7370a2013-02-28 19:01:20 +00004165 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004166 ExceptionData.getPointer());
Anders Carlsson80f25672008-09-09 17:59:25 +00004167
John McCall0b251722010-08-04 05:59:32 +00004168 llvm::CallInst *SetJmpResult =
John McCallbd7370a2013-02-28 19:01:20 +00004169 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4170 SetJmpBuffer, "setjmp.result");
Bill Wendling6446c3e2011-12-19 23:53:28 +00004171 SetJmpResult->setCanReturnTwice();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004172
John McCall0b251722010-08-04 05:59:32 +00004173 llvm::Value *Threw =
4174 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4175
4176 CatchBlock = CGF.createBasicBlock("catch");
4177 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4178 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4179
4180 CGF.EmitBlock(CatchBlock);
4181 }
4182
4183 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004184
Daniel Dunbar55e40722008-09-27 07:03:52 +00004185 // Handle catch list. As a special case we check if everything is
4186 // matched and avoid generating code for falling off the end if
4187 // so.
4188 bool AllMatched = false;
Douglas Gregor8f5e3dd2010-04-23 22:50:49 +00004189 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4190 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson80f25672008-09-09 17:59:25 +00004191
Douglas Gregorc00d8e12010-04-26 16:46:50 +00004192 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Stephen Hines6bcf27b2014-05-29 04:14:42 -07004193 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar129271a2008-09-27 07:36:24 +00004194
Anders Carlsson80f25672008-09-09 17:59:25 +00004195 // catch(...) always matches.
Daniel Dunbar55e40722008-09-27 07:03:52 +00004196 if (!CatchParam) {
4197 AllMatched = true;
4198 } else {
John McCall183700f2009-09-21 23:43:11 +00004199 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004200
John McCallf1549f62010-07-06 01:34:17 +00004201 // catch(id e) always matches under this ABI, since only
4202 // ObjC exceptions end up here in the first place.
Daniel Dunbar97f61d12008-09-27 22:21:14 +00004203 // FIXME: For the time being we also match id<X>; this should
4204 // be rejected by Sema instead.
Eli Friedman818e96f2009-07-11 00:57:02 +00004205 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbar55e40722008-09-27 07:03:52 +00004206 AllMatched = true;
Anders Carlsson80f25672008-09-09 17:59:25 +00004207 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004208
John McCallf1549f62010-07-06 01:34:17 +00004209 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004210 if (AllMatched) {
John McCallf1549f62010-07-06 01:34:17 +00004211 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4212
Anders Carlssondde0a942008-09-11 09:15:33 +00004213 if (CatchParam) {
John McCallb6bbcc92010-10-15 04:57:14 +00004214 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbara448fb22008-11-11 23:11:34 +00004215 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallf1549f62010-07-06 01:34:17 +00004216
4217 // These types work out because ConvertType(id) == i8*.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004218 EmitInitOfCatchParam(CGF, Caught, CatchParam);
Anders Carlssondde0a942008-09-11 09:15:33 +00004219 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004220
Anders Carlssondde0a942008-09-11 09:15:33 +00004221 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallf1549f62010-07-06 01:34:17 +00004222
4223 // The scope of the catch variable ends right here.
4224 CatchVarCleanups.ForceCleanup();
4225
Anders Carlssonf3a79a92009-02-09 20:38:58 +00004226 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson80f25672008-09-09 17:59:25 +00004227 break;
4228 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004229
Steve Naroff14108da2009-07-10 23:34:53 +00004230 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall506b57e2010-05-17 21:00:27 +00004231 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallf1549f62010-07-06 01:34:17 +00004232
4233 // FIXME: @catch (Class c) ?
John McCall506b57e2010-05-17 21:00:27 +00004234 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4235 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson80f25672008-09-09 17:59:25 +00004236
4237 // Check if the @catch block matches the exception object.
John McCallbd7370a2013-02-28 19:01:20 +00004238 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004239
John McCallbd7370a2013-02-28 19:01:20 +00004240 llvm::Value *matchArgs[] = { Class, Caught };
John McCallf1549f62010-07-06 01:34:17 +00004241 llvm::CallInst *Match =
John McCallbd7370a2013-02-28 19:01:20 +00004242 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4243 matchArgs, "match");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004244
John McCallf1549f62010-07-06 01:34:17 +00004245 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4246 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004247
4248 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbare4b5ee02008-09-27 23:30:04 +00004249 MatchedBlock, NextCatchBlock);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004250
Anders Carlsson80f25672008-09-09 17:59:25 +00004251 // Emit the @catch block.
4252 CGF.EmitBlock(MatchedBlock);
John McCallf1549f62010-07-06 01:34:17 +00004253
4254 // Collect any cleanups for the catch variable. The scope lasts until
4255 // the end of the catch body.
John McCall0b251722010-08-04 05:59:32 +00004256 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallf1549f62010-07-06 01:34:17 +00004257
John McCallb6bbcc92010-10-15 04:57:14 +00004258 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbara448fb22008-11-11 23:11:34 +00004259 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbar18ccc772008-09-28 01:03:14 +00004260
John McCallf1549f62010-07-06 01:34:17 +00004261 // Initialize the catch variable.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004262 llvm::Value *Tmp =
4263 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer578faa82011-09-27 21:06:10 +00004264 CGF.ConvertType(CatchParam->getType()));
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004265 EmitInitOfCatchParam(CGF, Tmp, CatchParam);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004266
Anders Carlssondde0a942008-09-11 09:15:33 +00004267 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallf1549f62010-07-06 01:34:17 +00004268
4269 // We're done with the catch variable.
4270 CatchVarCleanups.ForceCleanup();
4271
Anders Carlssonf3a79a92009-02-09 20:38:58 +00004272 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004273
Anders Carlsson80f25672008-09-09 17:59:25 +00004274 CGF.EmitBlock(NextCatchBlock);
4275 }
4276
John McCallf1549f62010-07-06 01:34:17 +00004277 CGF.ObjCEHValueStack.pop_back();
4278
John McCall0b251722010-08-04 05:59:32 +00004279 // If nothing wanted anything to do with the caught exception,
4280 // kill the extract call.
4281 if (Caught->use_empty())
4282 Caught->eraseFromParent();
4283
4284 if (!AllMatched)
4285 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4286
4287 if (HasFinally) {
4288 // Emit the exception handler for the @catch blocks.
4289 CGF.EmitBlock(CatchHandler);
4290
4291 // In theory we might now need a write hazard, but actually it's
4292 // unnecessary because there's no local-accessing code between
4293 // the try's write hazard and here.
4294 //Hazards.emitWriteHazard();
4295
John McCall9e2213d2010-10-04 23:42:51 +00004296 // Extract the new exception and save it to the
4297 // propagating-exception slot.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004298 assert(PropagatingExnVar.isValid());
John McCall9e2213d2010-10-04 23:42:51 +00004299 llvm::CallInst *NewCaught =
John McCallbd7370a2013-02-28 19:01:20 +00004300 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004301 ExceptionData.getPointer(), "caught");
John McCall9e2213d2010-10-04 23:42:51 +00004302 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4303
John McCall0b251722010-08-04 05:59:32 +00004304 // Don't pop the catch handler; the throw already did.
4305 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonf3a79a92009-02-09 20:38:58 +00004306 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbar55e40722008-09-27 07:03:52 +00004307 }
Anders Carlsson80f25672008-09-09 17:59:25 +00004308 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004309
John McCall87bb5822010-07-31 23:20:56 +00004310 // Insert read hazards as required in the new blocks.
John McCall0b251722010-08-04 05:59:32 +00004311 Hazards.emitHazardsInNewBlocks();
John McCall87bb5822010-07-31 23:20:56 +00004312
John McCallf1549f62010-07-06 01:34:17 +00004313 // Pop the cleanup.
John McCall0b251722010-08-04 05:59:32 +00004314 CGF.Builder.restoreIP(TryFallthroughIP);
4315 if (CGF.HaveInsertPoint())
4316 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallf1549f62010-07-06 01:34:17 +00004317 CGF.PopCleanupBlock();
John McCall0b251722010-08-04 05:59:32 +00004318 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonf3a79a92009-02-09 20:38:58 +00004319
John McCallf1549f62010-07-06 01:34:17 +00004320 // Emit the rethrow block.
John McCall87bb5822010-07-31 23:20:56 +00004321 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallff8e1152010-07-23 21:56:41 +00004322 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallf1549f62010-07-06 01:34:17 +00004323 if (CGF.HaveInsertPoint()) {
John McCall9e2213d2010-10-04 23:42:51 +00004324 // If we have a propagating-exception variable, check it.
4325 llvm::Value *PropagatingExn;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004326 if (PropagatingExnVar.isValid()) {
John McCall9e2213d2010-10-04 23:42:51 +00004327 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall0b251722010-08-04 05:59:32 +00004328
John McCall9e2213d2010-10-04 23:42:51 +00004329 // Otherwise, just look in the buffer for the exception to throw.
4330 } else {
4331 llvm::CallInst *Caught =
John McCallbd7370a2013-02-28 19:01:20 +00004332 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004333 ExceptionData.getPointer());
John McCall9e2213d2010-10-04 23:42:51 +00004334 PropagatingExn = Caught;
4335 }
4336
John McCallbd7370a2013-02-28 19:01:20 +00004337 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4338 PropagatingExn);
John McCallf1549f62010-07-06 01:34:17 +00004339 CGF.Builder.CreateUnreachable();
Fariborz Jahanianf2878e52008-11-21 19:21:53 +00004340 }
Anders Carlsson80f25672008-09-09 17:59:25 +00004341
John McCall87bb5822010-07-31 23:20:56 +00004342 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00004343}
4344
4345void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian6a3c70e2013-01-10 19:02:56 +00004346 const ObjCAtThrowStmt &S,
4347 bool ClearInsertionPoint) {
Anders Carlsson2b1e3112008-09-09 16:16:55 +00004348 llvm::Value *ExceptionAsObject;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004349
Anders Carlsson2b1e3112008-09-09 16:16:55 +00004350 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall2b014d62011-10-01 10:32:24 +00004351 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004352 ExceptionAsObject =
Benjamin Kramer578faa82011-09-27 21:06:10 +00004353 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlsson2b1e3112008-09-09 16:16:55 +00004354 } else {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004355 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbar18ccc772008-09-28 01:03:14 +00004356 "Unexpected rethrow outside @catch block.");
Anders Carlsson273558f2009-02-07 21:37:21 +00004357 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlsson2b1e3112008-09-09 16:16:55 +00004358 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004359
John McCallbd7370a2013-02-28 19:01:20 +00004360 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallf1549f62010-07-06 01:34:17 +00004361 ->setDoesNotReturn();
Anders Carlsson80f25672008-09-09 17:59:25 +00004362 CGF.Builder.CreateUnreachable();
Daniel Dunbara448fb22008-11-11 23:11:34 +00004363
4364 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian6a3c70e2013-01-10 19:02:56 +00004365 if (ClearInsertionPoint)
4366 CGF.Builder.ClearInsertionPoint();
Anders Carlsson64d5d6c2008-09-09 10:04:29 +00004367}
4368
Fariborz Jahanian3e283e32008-11-18 22:37:34 +00004369/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanian6dc23172008-11-18 21:45:40 +00004370/// object: objc_read_weak (id *src)
4371///
Fariborz Jahanian3e283e32008-11-18 22:37:34 +00004372llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004373 Address AddrWeakObj) {
4374 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004375 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4376 ObjCTypes.PtrObjectPtrTy);
John McCallbd7370a2013-02-28 19:01:20 +00004377 llvm::Value *read_weak =
4378 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004379 AddrWeakObj.getPointer(), "weakread");
Eli Friedman8339b352009-03-07 03:57:15 +00004380 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian6dc23172008-11-18 21:45:40 +00004381 return read_weak;
4382}
4383
Fariborz Jahanian3e283e32008-11-18 22:37:34 +00004384/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4385/// objc_assign_weak (id src, id *dst)
4386///
4387void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004388 llvm::Value *src, Address dst) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00004389 llvm::Type * SrcTy = src->getType();
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00004390 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmow25a6a842012-10-08 16:25:52 +00004391 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00004392 assert(Size <= 8 && "does not support size > 8");
4393 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004394 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian3b8a6522009-03-13 00:42:52 +00004395 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4396 }
Fariborz Jahaniandbd32c22008-11-19 17:34:06 +00004397 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4398 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004399 llvm::Value *args[] = { src, dst.getPointer() };
John McCallbd7370a2013-02-28 19:01:20 +00004400 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4401 args, "weakassign");
Fariborz Jahanian3e283e32008-11-18 22:37:34 +00004402}
4403
Fariborz Jahanian58626502008-11-19 00:59:10 +00004404/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4405/// objc_assign_global (id src, id *dst)
4406///
4407void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004408 llvm::Value *src, Address dst,
Fariborz Jahanian021a7a62010-07-20 20:30:03 +00004409 bool threadlocal) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00004410 llvm::Type * SrcTy = src->getType();
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00004411 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmow25a6a842012-10-08 16:25:52 +00004412 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00004413 assert(Size <= 8 && "does not support size > 8");
4414 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004415 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian3b8a6522009-03-13 00:42:52 +00004416 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4417 }
Fariborz Jahaniandbd32c22008-11-19 17:34:06 +00004418 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4419 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004420 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian021a7a62010-07-20 20:30:03 +00004421 if (!threadlocal)
John McCallbd7370a2013-02-28 19:01:20 +00004422 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4423 args, "globalassign");
Fariborz Jahanian021a7a62010-07-20 20:30:03 +00004424 else
John McCallbd7370a2013-02-28 19:01:20 +00004425 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4426 args, "threadlocalassign");
Fariborz Jahanian58626502008-11-19 00:59:10 +00004427}
4428
Fariborz Jahanian7eda8362008-11-20 19:23:36 +00004429/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian6c7a1f32009-09-24 22:25:38 +00004430/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahanian7eda8362008-11-20 19:23:36 +00004431///
4432void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004433 llvm::Value *src, Address dst,
Fariborz Jahanian6c7a1f32009-09-24 22:25:38 +00004434 llvm::Value *ivarOffset) {
4435 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2acc6e32011-07-18 04:24:23 +00004436 llvm::Type * SrcTy = src->getType();
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00004437 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmow25a6a842012-10-08 16:25:52 +00004438 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00004439 assert(Size <= 8 && "does not support size > 8");
4440 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004441 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian3b8a6522009-03-13 00:42:52 +00004442 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4443 }
Fariborz Jahanian7eda8362008-11-20 19:23:36 +00004444 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4445 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004446 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCallbd7370a2013-02-28 19:01:20 +00004447 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian7eda8362008-11-20 19:23:36 +00004448}
4449
Fariborz Jahanian58626502008-11-19 00:59:10 +00004450/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4451/// objc_assign_strongCast (id src, id *dst)
4452///
4453void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004454 llvm::Value *src, Address dst) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00004455 llvm::Type * SrcTy = src->getType();
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00004456 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmow25a6a842012-10-08 16:25:52 +00004457 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00004458 assert(Size <= 8 && "does not support size > 8");
4459 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004460 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian3b8a6522009-03-13 00:42:52 +00004461 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4462 }
Fariborz Jahaniandbd32c22008-11-19 17:34:06 +00004463 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4464 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004465 llvm::Value *args[] = { src, dst.getPointer() };
John McCallbd7370a2013-02-28 19:01:20 +00004466 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004467 args, "strongassign");
Fariborz Jahanian58626502008-11-19 00:59:10 +00004468}
4469
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00004470void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004471 Address DestPtr,
4472 Address SrcPtr,
Fariborz Jahanian55bcace2010-06-15 22:44:06 +00004473 llvm::Value *size) {
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00004474 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4475 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004476 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCallbd7370a2013-02-28 19:01:20 +00004477 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00004478}
4479
Fariborz Jahanian0bb20362009-02-02 20:02:29 +00004480/// EmitObjCValueForIvar - Code Gen for ivar reference.
4481///
Fariborz Jahanian598d3f62009-02-03 19:03:09 +00004482LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4483 QualType ObjectTy,
4484 llvm::Value *BaseValue,
4485 const ObjCIvarDecl *Ivar,
Fariborz Jahanian598d3f62009-02-03 19:03:09 +00004486 unsigned CVRQualifiers) {
John McCallc12c5bb2010-05-15 11:32:37 +00004487 const ObjCInterfaceDecl *ID =
4488 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar97776872009-04-22 07:32:20 +00004489 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4490 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian0bb20362009-02-02 20:02:29 +00004491}
4492
Fariborz Jahanianf63aa3f2009-02-10 19:02:04 +00004493llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar2a031922009-04-22 05:08:15 +00004494 const ObjCInterfaceDecl *Interface,
Fariborz Jahanianf63aa3f2009-02-10 19:02:04 +00004495 const ObjCIvarDecl *Ivar) {
Eli Friedmane5b46662012-11-06 22:15:52 +00004496 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4497 return llvm::ConstantInt::get(
4498 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4499 Offset);
Fariborz Jahanianf63aa3f2009-02-10 19:02:04 +00004500}
4501
Daniel Dunbarf77ac862008-08-11 21:35:06 +00004502/* *** Private Interface *** */
4503
4504/// EmitImageInfo - Emit the image info marker used to encode some module
4505/// level information.
4506///
4507/// See: <rdr://4810609&4810587&4810587>
4508/// struct IMAGE_INFO {
4509/// unsigned version;
4510/// unsigned flags;
4511/// };
4512enum ImageInfoFlags {
Stephen Hines651f13c2014-04-23 16:59:28 -07004513 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004514 eImageInfo_GarbageCollected = (1 << 1),
4515 eImageInfo_GCOnly = (1 << 2),
Stephen Hines651f13c2014-04-23 16:59:28 -07004516 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbarc7c6dc02009-04-20 07:11:47 +00004517
Daniel Dunbarfce176b2010-04-25 20:39:01 +00004518 // A flag indicating that the module has no instances of a @synthesize of a
4519 // superclass variable. <rdar://problem/6803242>
Stephen Hines651f13c2014-04-23 16:59:28 -07004520 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07004521 eImageInfo_ImageIsSimulated = (1 << 5),
4522 eImageInfo_ClassProperties = (1 << 6)
Daniel Dunbarf77ac862008-08-11 21:35:06 +00004523};
4524
Daniel Dunbarfce176b2010-04-25 20:39:01 +00004525void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbarf77ac862008-08-11 21:35:06 +00004526 unsigned version = 0; // Version is unused?
Bill Wendling3973acc2012-02-16 01:13:30 +00004527 const char *Section = (ObjCABI == 1) ?
4528 "__OBJC, __image_info,regular" :
4529 "__DATA, __objc_imageinfo, regular, no_dead_strip";
Daniel Dunbarf77ac862008-08-11 21:35:06 +00004530
Bill Wendling3973acc2012-02-16 01:13:30 +00004531 // Generate module-level named metadata to convey this information to the
4532 // linker and code-gen.
4533 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004534
Bill Wendling3973acc2012-02-16 01:13:30 +00004535 // Add the ObjC ABI version to the module flags.
4536 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4537 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4538 version);
4539 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
4540 llvm::MDString::get(VMContext,Section));
Daniel Dunbarf77ac862008-08-11 21:35:06 +00004541
David Blaikie4e4d0842012-03-11 07:00:24 +00004542 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendling3973acc2012-02-16 01:13:30 +00004543 // Non-GC overrides those files which specify GC.
4544 Mod.addModuleFlag(llvm::Module::Override,
4545 "Objective-C Garbage Collection", (uint32_t)0);
4546 } else {
4547 // Add the ObjC garbage collection value.
4548 Mod.addModuleFlag(llvm::Module::Error,
4549 "Objective-C Garbage Collection",
4550 eImageInfo_GarbageCollected);
Daniel Dunbar63c5b502009-03-09 21:49:58 +00004551
David Blaikie4e4d0842012-03-11 07:00:24 +00004552 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendling3973acc2012-02-16 01:13:30 +00004553 // Add the ObjC GC Only value.
4554 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4555 eImageInfo_GCOnly);
4556
4557 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Stephen Hines0e2c34f2015-03-23 12:09:02 -07004558 llvm::Metadata *Ops[2] = {
4559 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4560 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4561 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendling3973acc2012-02-16 01:13:30 +00004562 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4563 llvm::MDNode::get(VMContext, Ops));
4564 }
4565 }
Bill Wendling09822512012-04-24 11:04:57 +00004566
4567 // Indicate whether we're compiling this to run on a simulator.
4568 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004569 if ((Triple.isiOS() || Triple.isWatchOS()) &&
Bill Wendling09822512012-04-24 11:04:57 +00004570 (Triple.getArch() == llvm::Triple::x86 ||
4571 Triple.getArch() == llvm::Triple::x86_64))
4572 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4573 eImageInfo_ImageIsSimulated);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07004574
4575 // Indicate whether we are generating class properties.
4576 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Class Properties",
4577 eImageInfo_ClassProperties);
Daniel Dunbarf77ac862008-08-11 21:35:06 +00004578}
4579
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00004580// struct objc_module {
4581// unsigned long version;
4582// unsigned long size;
4583// const char *name;
4584// Symtab symtab;
4585// };
4586
4587// FIXME: Get from somewhere
4588static const int ModuleVersion = 7;
4589
4590void CGObjCMac::EmitModuleInfo() {
Micah Villmow25a6a842012-10-08 16:25:52 +00004591 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004592
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00004593 llvm::Constant *Values[] = {
4594 llvm::ConstantInt::get(ObjCTypes.LongTy, ModuleVersion),
4595 llvm::ConstantInt::get(ObjCTypes.LongTy, Size),
4596 // This used to be the filename, now it is unused. <rdr://4327263>
Stephen Hines176edba2014-12-01 14:53:08 -08004597 GetClassName(StringRef("")),
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00004598 EmitModuleSymbols()
4599 };
Stephen Hines176edba2014-12-01 14:53:08 -08004600 CreateMetadataVar("OBJC_MODULES",
Owen Anderson08e25242009-07-27 22:29:56 +00004601 llvm::ConstantStruct::get(ObjCTypes.ModuleTy, Values),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004602 "__OBJC,__module_info,regular,no_dead_strip",
4603 CGM.getPointerAlign(), true);
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00004604}
4605
4606llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar27f9d772008-08-21 04:36:09 +00004607 unsigned NumClasses = DefinedClasses.size();
4608 unsigned NumCategories = DefinedCategories.size();
4609
Daniel Dunbar242d4dc2008-08-25 06:02:07 +00004610 // Return null if no symbols were defined.
4611 if (!NumClasses && !NumCategories)
Owen Andersonc9c88b42009-07-31 20:28:54 +00004612 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbar242d4dc2008-08-25 06:02:07 +00004613
Chris Lattnerc5cbb902011-06-20 04:01:35 +00004614 llvm::Constant *Values[5];
Owen Anderson4a28d5d2009-07-24 23:12:58 +00004615 Values[0] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
Owen Andersonc9c88b42009-07-31 20:28:54 +00004616 Values[1] = llvm::Constant::getNullValue(ObjCTypes.SelectorPtrTy);
Owen Anderson4a28d5d2009-07-24 23:12:58 +00004617 Values[2] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumClasses);
4618 Values[3] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00004619
Daniel Dunbar86e253a2008-08-22 20:34:54 +00004620 // The runtime expects exactly the list of defined classes followed
4621 // by the list of defined categories, in a single array.
Chris Lattner0b239712012-02-06 22:16:34 +00004622 SmallVector<llvm::Constant*, 8> Symbols(NumClasses + NumCategories);
Stephen Hines651f13c2014-04-23 16:59:28 -07004623 for (unsigned i=0; i<NumClasses; i++) {
4624 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
4625 assert(ID);
4626 if (ObjCImplementationDecl *IMP = ID->getImplementation())
4627 // We are implementing a weak imported interface. Give it external linkage
4628 if (ID->isWeakImported() && !IMP->isWeakImported())
4629 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
4630
Owen Anderson3c4972d2009-07-29 18:54:39 +00004631 Symbols[i] = llvm::ConstantExpr::getBitCast(DefinedClasses[i],
Daniel Dunbar86e253a2008-08-22 20:34:54 +00004632 ObjCTypes.Int8PtrTy);
Stephen Hines651f13c2014-04-23 16:59:28 -07004633 }
Daniel Dunbar86e253a2008-08-22 20:34:54 +00004634 for (unsigned i=0; i<NumCategories; i++)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004635 Symbols[NumClasses + i] =
Owen Anderson3c4972d2009-07-29 18:54:39 +00004636 llvm::ConstantExpr::getBitCast(DefinedCategories[i],
Daniel Dunbar86e253a2008-08-22 20:34:54 +00004637 ObjCTypes.Int8PtrTy);
4638
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004639 Values[4] =
Owen Anderson96e0fc72009-07-29 22:16:19 +00004640 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner0b239712012-02-06 22:16:34 +00004641 Symbols.size()),
Daniel Dunbar27f9d772008-08-21 04:36:09 +00004642 Symbols);
4643
Chris Lattnerc5cbb902011-06-20 04:01:35 +00004644 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00004645
Stephen Hines176edba2014-12-01 14:53:08 -08004646 llvm::GlobalVariable *GV = CreateMetadataVar(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004647 "OBJC_SYMBOLS", Init, "__OBJC,__symbols,regular,no_dead_strip",
4648 CGM.getPointerAlign(), true);
Owen Anderson3c4972d2009-07-29 18:54:39 +00004649 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00004650}
4651
John McCallbd7370a2013-02-28 19:01:20 +00004652llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
4653 IdentifierInfo *II) {
John McCallf85e1932011-06-15 23:02:42 +00004654 LazySymbols.insert(II);
4655
4656 llvm::GlobalVariable *&Entry = ClassReferences[II];
4657
Daniel Dunbar27f9d772008-08-21 04:36:09 +00004658 if (!Entry) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004659 llvm::Constant *Casted =
Stephen Hines176edba2014-12-01 14:53:08 -08004660 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCallf85e1932011-06-15 23:02:42 +00004661 ObjCTypes.ClassPtrTy);
Stephen Hines176edba2014-12-01 14:53:08 -08004662 Entry = CreateMetadataVar(
4663 "OBJC_CLASS_REFERENCES_", Casted,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004664 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
4665 CGM.getPointerAlign(), true);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00004666 }
John McCallf85e1932011-06-15 23:02:42 +00004667
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004668 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00004669}
4670
John McCallbd7370a2013-02-28 19:01:20 +00004671llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCallf85e1932011-06-15 23:02:42 +00004672 const ObjCInterfaceDecl *ID) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07004673 // If the class has the objc_runtime_visible attribute, we need to
4674 // use the Objective-C runtime to get the class.
4675 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
4676 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
4677
John McCallbd7370a2013-02-28 19:01:20 +00004678 return EmitClassRefFromId(CGF, ID->getIdentifier());
John McCallf85e1932011-06-15 23:02:42 +00004679}
4680
John McCallbd7370a2013-02-28 19:01:20 +00004681llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCallf85e1932011-06-15 23:02:42 +00004682 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCallbd7370a2013-02-28 19:01:20 +00004683 return EmitClassRefFromId(CGF, II);
John McCallf85e1932011-06-15 23:02:42 +00004684}
4685
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004686llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
4687 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
4688}
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004689
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004690Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
4691 CharUnits Align = CGF.getPointerAlign();
4692
4693 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar259d93d2008-08-12 03:39:23 +00004694 if (!Entry) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004695 llvm::Constant *Casted =
Owen Anderson3c4972d2009-07-29 18:54:39 +00004696 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbar259d93d2008-08-12 03:39:23 +00004697 ObjCTypes.SelectorPtrTy);
Stephen Hines176edba2014-12-01 14:53:08 -08004698 Entry = CreateMetadataVar(
4699 "OBJC_SELECTOR_REFERENCES_", Casted,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004700 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman8f98bf92013-02-05 23:08:45 +00004701 Entry->setExternallyInitialized(true);
Daniel Dunbar259d93d2008-08-12 03:39:23 +00004702 }
4703
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004704 return Address(Entry, Align);
Daniel Dunbar259d93d2008-08-12 03:39:23 +00004705}
4706
Stephen Hines176edba2014-12-01 14:53:08 -08004707llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
4708 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
4709 if (!Entry)
4710 Entry = CreateMetadataVar(
4711 "OBJC_CLASS_NAME_",
4712 llvm::ConstantDataArray::getString(VMContext, RuntimeName),
4713 ((ObjCABI == 2) ? "__TEXT,__objc_classname,cstring_literals"
4714 : "__TEXT,__cstring,cstring_literals"),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004715 CharUnits::One(), true);
Stephen Hines176edba2014-12-01 14:53:08 -08004716 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00004717}
4718
Argyrios Kyrtzidis9d50c062010-08-09 10:54:20 +00004719llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
4720 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
4721 I = MethodDefinitions.find(MD);
4722 if (I != MethodDefinitions.end())
4723 return I->second;
4724
Stephen Hines6bcf27b2014-05-29 04:14:42 -07004725 return nullptr;
Argyrios Kyrtzidis9d50c062010-08-09 10:54:20 +00004726}
4727
Fariborz Jahaniand80d81b2009-03-05 19:17:31 +00004728/// GetIvarLayoutName - Returns a unique constant for the given
4729/// ivar layout bitmap.
4730llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004731 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Andersonc9c88b42009-07-31 20:28:54 +00004732 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahaniand80d81b2009-03-05 19:17:31 +00004733}
4734
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004735void IvarLayoutBuilder::visitRecord(const RecordType *RT,
4736 CharUnits offset) {
Daniel Dunbard58edcb2009-05-03 14:10:34 +00004737 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004738
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004739 // If this is a union, remember that we had one, because it might mess
4740 // up the ordering of layout entries.
4741 if (RD->isUnion())
4742 IsDisordered = true;
4743
4744 const ASTRecordLayout *recLayout = nullptr;
4745 visitAggregate(RD->field_begin(), RD->field_end(), offset,
4746 [&](const FieldDecl *field) -> CharUnits {
4747 if (!recLayout)
4748 recLayout = &CGM.getContext().getASTRecordLayout(RD);
4749 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
4750 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
4751 });
Daniel Dunbard58edcb2009-05-03 14:10:34 +00004752}
4753
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004754template <class Iterator, class GetOffsetFn>
4755void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
4756 CharUnits aggregateOffset,
4757 const GetOffsetFn &getOffset) {
4758 for (; begin != end; ++begin) {
4759 auto field = *begin;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004760
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004761 // Skip over bitfields.
4762 if (field->isBitField()) {
4763 continue;
4764 }
4765
4766 // Compute the offset of the field within the aggregate.
4767 CharUnits fieldOffset = aggregateOffset + getOffset(field);
4768
4769 visitField(field, fieldOffset);
4770 }
4771}
4772
4773/// Collect layout information for the given fields into IvarsInfo.
4774void IvarLayoutBuilder::visitField(const FieldDecl *field,
4775 CharUnits fieldOffset) {
4776 QualType fieldType = field->getType();
4777
4778 // Drill down into arrays.
4779 uint64_t numElts = 1;
4780 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
4781 numElts *= arrayType->getSize().getZExtValue();
4782 fieldType = arrayType->getElementType();
4783 }
4784
4785 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
4786
4787 // If we ended up with a zero-sized array, we've done what we can do within
4788 // the limits of this layout encoding.
4789 if (numElts == 0) return;
4790
4791 // Recurse if the base element type is a record type.
4792 if (auto recType = fieldType->getAs<RecordType>()) {
4793 size_t oldEnd = IvarsInfo.size();
4794
4795 visitRecord(recType, fieldOffset);
4796
4797 // If we have an array, replicate the first entry's layout information.
4798 auto numEltEntries = IvarsInfo.size() - oldEnd;
4799 if (numElts != 1 && numEltEntries != 0) {
4800 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
4801 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
4802 // Copy the last numEltEntries onto the end of the array, adjusting
4803 // each for the element size.
4804 for (size_t i = 0; i != numEltEntries; ++i) {
4805 auto firstEntry = IvarsInfo[oldEnd + i];
4806 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
4807 firstEntry.SizeInWords));
4808 }
4809 }
4810 }
4811
Fariborz Jahaniana5a10c32009-03-10 16:22:08 +00004812 return;
Fariborz Jahanian820e0202009-03-11 00:07:04 +00004813 }
Daniel Dunbard58edcb2009-05-03 14:10:34 +00004814
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004815 // Classify the element type.
4816 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004817
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004818 // If it matches what we're looking for, add an entry.
4819 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
4820 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
4821 assert(CGM.getContext().getTypeSizeInChars(fieldType)
4822 == CGM.getPointerSize());
4823 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
4824 }
Fariborz Jahaniand61a50a2009-03-05 22:39:55 +00004825}
4826
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004827/// buildBitmap - This routine does the horsework of taking the offsets of
4828/// strong/weak references and creating a bitmap. The bitmap is also
4829/// returned in the given buffer, suitable for being passed to \c dump().
4830llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
4831 llvm::SmallVectorImpl<unsigned char> &buffer) {
4832 // The bitmap is a series of skip/scan instructions, aligned to word
4833 // boundaries. The skip is performed first.
4834 const unsigned char MaxNibble = 0xF;
4835 const unsigned char SkipMask = 0xF0, SkipShift = 4;
4836 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Stephen Hines176edba2014-12-01 14:53:08 -08004837
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004838 assert(!IvarsInfo.empty() && "generating bitmap for no data");
4839
4840 // Sort the ivar info on byte position in case we encounterred a
4841 // union nested in the ivar list.
4842 if (IsDisordered) {
4843 // This isn't a stable sort, but our algorithm should handle it fine.
4844 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
4845 } else {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07004846 assert(std::is_sorted(IvarsInfo.begin(), IvarsInfo.end()));
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004847 }
4848 assert(IvarsInfo.back().Offset < InstanceEnd);
4849
4850 assert(buffer.empty());
4851
4852 // Skip the next N words.
4853 auto skip = [&](unsigned numWords) {
4854 assert(numWords > 0);
4855
4856 // Try to merge into the previous byte. Since scans happen second, we
4857 // can't do this if it includes a scan.
4858 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
4859 unsigned lastSkip = buffer.back() >> SkipShift;
4860 if (lastSkip < MaxNibble) {
4861 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
4862 numWords -= claimed;
4863 lastSkip += claimed;
4864 buffer.back() = (lastSkip << SkipShift);
4865 }
4866 }
4867
4868 while (numWords >= MaxNibble) {
4869 buffer.push_back(MaxNibble << SkipShift);
4870 numWords -= MaxNibble;
4871 }
4872 if (numWords) {
4873 buffer.push_back(numWords << SkipShift);
4874 }
4875 };
4876
4877 // Scan the next N words.
4878 auto scan = [&](unsigned numWords) {
4879 assert(numWords > 0);
4880
4881 // Try to merge into the previous byte. Since scans happen second, we can
4882 // do this even if it includes a skip.
4883 if (!buffer.empty()) {
4884 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
4885 if (lastScan < MaxNibble) {
4886 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
4887 numWords -= claimed;
4888 lastScan += claimed;
4889 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
4890 }
4891 }
4892
4893 while (numWords >= MaxNibble) {
4894 buffer.push_back(MaxNibble << ScanShift);
4895 numWords -= MaxNibble;
4896 }
4897 if (numWords) {
4898 buffer.push_back(numWords << ScanShift);
4899 }
4900 };
4901
4902 // One past the end of the last scan.
4903 unsigned endOfLastScanInWords = 0;
4904 const CharUnits WordSize = CGM.getPointerSize();
4905
4906 // Consider all the scan requests.
4907 for (auto &request : IvarsInfo) {
4908 CharUnits beginOfScan = request.Offset - InstanceBegin;
4909
4910 // Ignore scan requests that don't start at an even multiple of the
4911 // word size. We can't encode them.
4912 if ((beginOfScan % WordSize) != 0) continue;
4913
4914 // Ignore scan requests that start before the instance start.
4915 // This assumes that scans never span that boundary. The boundary
4916 // isn't the true start of the ivars, because in the fragile-ARC case
4917 // it's rounded up to word alignment, but the test above should leave
4918 // us ignoring that possibility.
4919 if (beginOfScan.isNegative()) {
4920 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
4921 continue;
4922 }
4923
4924 unsigned beginOfScanInWords = beginOfScan / WordSize;
4925 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
4926
4927 // If the scan starts some number of words after the last one ended,
4928 // skip forward.
4929 if (beginOfScanInWords > endOfLastScanInWords) {
4930 skip(beginOfScanInWords - endOfLastScanInWords);
4931
4932 // Otherwise, start scanning where the last left off.
4933 } else {
4934 beginOfScanInWords = endOfLastScanInWords;
4935
4936 // If that leaves us with nothing to scan, ignore this request.
4937 if (beginOfScanInWords >= endOfScanInWords) continue;
4938 }
4939
4940 // Scan to the end of the request.
4941 assert(beginOfScanInWords < endOfScanInWords);
4942 scan(endOfScanInWords - beginOfScanInWords);
4943 endOfLastScanInWords = endOfScanInWords;
4944 }
4945
4946 if (buffer.empty())
4947 return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
4948
4949 // For GC layouts, emit a skip to the end of the allocation so that we
4950 // have precise information about the entire thing. This isn't useful
4951 // or necessary for the ARC-style layout strings.
4952 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
4953 unsigned lastOffsetInWords =
4954 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
4955 if (lastOffsetInWords > endOfLastScanInWords) {
4956 skip(lastOffsetInWords - endOfLastScanInWords);
4957 }
4958 }
4959
4960 // Null terminate the string.
4961 buffer.push_back(0);
4962
4963 bool isNonFragileABI = CGObjC.isNonFragileABI();
4964
4965 llvm::GlobalVariable *Entry = CGObjC.CreateMetadataVar(
Stephen Hines176edba2014-12-01 14:53:08 -08004966 "OBJC_CLASS_NAME_",
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004967 llvm::ConstantDataArray::get(CGM.getLLVMContext(), buffer),
4968 (isNonFragileABI ? "__TEXT,__objc_classname,cstring_literals"
4969 : "__TEXT,__cstring,cstring_literals"),
4970 CharUnits::One(), true);
4971 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00004972}
Daniel Dunbar6bff2512009-08-03 17:06:42 +00004973
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00004974/// BuildIvarLayout - Builds ivar layout bitmap for the class
4975/// implementation for the __strong or __weak case.
4976/// The layout map displays which words in ivar list must be skipped
4977/// and which must be scanned by GC (see below). String is built of bytes.
4978/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
4979/// of words to skip and right nibble is count of words to scan. So, each
4980/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
4981/// represented by a 0x00 byte which also ends the string.
4982/// 1. when ForStrongLayout is true, following ivars are scanned:
4983/// - id, Class
4984/// - object *
4985/// - __strong anything
4986///
4987/// 2. When ForStrongLayout is false, following ivars are scanned:
4988/// - __weak anything
4989///
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004990llvm::Constant *
4991CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
4992 CharUnits beginOffset, CharUnits endOffset,
4993 bool ForStrongLayout, bool HasMRCWeakIvars) {
4994 // If this is MRC, and we're either building a strong layout or there
4995 // are no weak ivars, bail out early.
Chris Lattner8b418682012-02-07 00:39:47 +00004996 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikie4e4d0842012-03-11 07:00:24 +00004997 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08004998 !CGM.getLangOpts().ObjCAutoRefCount &&
4999 (ForStrongLayout || !HasMRCWeakIvars))
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00005000 return llvm::Constant::getNullValue(PtrTy);
5001
Jordy Rosedb8264e2011-07-22 02:08:32 +00005002 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005003 SmallVector<const ObjCIvarDecl*, 32> ivars;
5004
5005 // GC layout strings include the complete object layout, possibly
5006 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
5007 // up.
5008 //
5009 // ARC layout strings only include the class's ivars. In non-fragile
5010 // runtimes, that means starting at InstanceStart, rounded up to word
5011 // alignment. In fragile runtimes, there's no InstanceStart, so it means
5012 // starting at the offset of the first ivar, rounded up to word alignment.
5013 //
5014 // MRC weak layout strings follow the ARC style.
5015 CharUnits baseOffset;
5016 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Jordy Rosedb8264e2011-07-22 02:08:32 +00005017 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianbf9eb882011-06-28 18:05:25 +00005018 IVD; IVD = IVD->getNextIvar())
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005019 ivars.push_back(IVD);
5020
5021 if (isNonFragileABI()) {
5022 baseOffset = beginOffset; // InstanceStart
5023 } else if (!ivars.empty()) {
5024 baseOffset =
5025 CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivars[0]));
5026 } else {
5027 baseOffset = CharUnits::Zero();
5028 }
5029
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005030 baseOffset = baseOffset.alignTo(CGM.getPointerAlign());
Fariborz Jahanianbf9eb882011-06-28 18:05:25 +00005031 }
5032 else {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005033 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00005034
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005035 baseOffset = CharUnits::Zero();
Fariborz Jahanianbf9eb882011-06-28 18:05:25 +00005036 }
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00005037
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005038 if (ivars.empty())
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00005039 return llvm::Constant::getNullValue(PtrTy);
5040
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005041 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00005042
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005043 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
5044 [&](const ObjCIvarDecl *ivar) -> CharUnits {
5045 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
5046 });
5047
5048 if (!builder.hasBitmapData())
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00005049 return llvm::Constant::getNullValue(PtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005050
5051 llvm::SmallVector<unsigned char, 4> buffer;
5052 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fariborz Jahanianb8fd2eb2010-08-05 00:19:48 +00005053
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005054 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005055 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian3d2ad662009-04-20 22:03:45 +00005056 ForStrongLayout ? "strong" : "weak",
Stephen Hines176edba2014-12-01 14:53:08 -08005057 OMD->getClassInterface()->getName().str().c_str());
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005058 builder.dump(buffer);
Fariborz Jahanian3d2ad662009-04-20 22:03:45 +00005059 }
Fariborz Jahanian93ce50d2010-08-04 23:55:24 +00005060 return C;
Fariborz Jahaniand61a50a2009-03-05 22:39:55 +00005061}
5062
Fariborz Jahanian56210f72009-01-21 23:34:32 +00005063llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbar259d93d2008-08-12 03:39:23 +00005064 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
5065
Chris Lattner0b239712012-02-06 22:16:34 +00005066 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbar63c5b502009-03-09 21:49:58 +00005067 if (!Entry)
Stephen Hines176edba2014-12-01 14:53:08 -08005068 Entry = CreateMetadataVar(
5069 "OBJC_METH_VAR_NAME_",
5070 llvm::ConstantDataArray::getString(VMContext, Sel.getAsString()),
5071 ((ObjCABI == 2) ? "__TEXT,__objc_methname,cstring_literals"
5072 : "__TEXT,__cstring,cstring_literals"),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005073 CharUnits::One(), true);
Daniel Dunbar259d93d2008-08-12 03:39:23 +00005074
Owen Andersona1cf15f2009-07-14 23:10:40 +00005075 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005076}
5077
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005078// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian56210f72009-01-21 23:34:32 +00005079llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005080 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
5081}
5082
Daniel Dunbar3e5f0d82009-04-20 06:54:31 +00005083llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel7794bb82009-03-04 18:21:39 +00005084 std::string TypeStr;
5085 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
5086
5087 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005088
Daniel Dunbar63c5b502009-03-09 21:49:58 +00005089 if (!Entry)
Stephen Hines176edba2014-12-01 14:53:08 -08005090 Entry = CreateMetadataVar(
5091 "OBJC_METH_VAR_TYPE_",
5092 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5093 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5094 : "__TEXT,__cstring,cstring_literals"),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005095 CharUnits::One(), true);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005096
Owen Andersona1cf15f2009-07-14 23:10:40 +00005097 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar259d93d2008-08-12 03:39:23 +00005098}
5099
Bob Wilsondc8dab62011-11-30 01:57:58 +00005100llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
5101 bool Extended) {
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005102 std::string TypeStr;
Bill Wendlinga4dc6932012-02-09 22:45:21 +00005103 if (CGM.getContext().getObjCEncodingForMethodDecl(D, TypeStr, Extended))
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005104 return nullptr;
Devang Patel7794bb82009-03-04 18:21:39 +00005105
5106 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
5107
Daniel Dunbarb90bb002009-04-14 23:14:47 +00005108 if (!Entry)
Stephen Hines176edba2014-12-01 14:53:08 -08005109 Entry = CreateMetadataVar(
5110 "OBJC_METH_VAR_TYPE_",
5111 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5112 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5113 : "__TEXT,__cstring,cstring_literals"),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005114 CharUnits::One(), true);
Devang Patel7794bb82009-03-04 18:21:39 +00005115
Owen Andersona1cf15f2009-07-14 23:10:40 +00005116 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005117}
5118
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00005119// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian56210f72009-01-21 23:34:32 +00005120llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00005121 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005122
Daniel Dunbar63c5b502009-03-09 21:49:58 +00005123 if (!Entry)
Stephen Hinesc568f1e2014-07-21 00:47:37 -07005124 Entry = CreateMetadataVar(
Stephen Hines176edba2014-12-01 14:53:08 -08005125 "OBJC_PROP_NAME_ATTR_",
Stephen Hinesc568f1e2014-07-21 00:47:37 -07005126 llvm::ConstantDataArray::getString(VMContext, Ident->getName()),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005127 "__TEXT,__cstring,cstring_literals", CharUnits::One(), true);
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00005128
Owen Andersona1cf15f2009-07-14 23:10:40 +00005129 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00005130}
5131
5132// FIXME: Merge into a single cstring creation function.
Daniel Dunbarc56f34a2008-08-28 04:38:10 +00005133// FIXME: This Decl should be more precise.
Daniel Dunbar63c5b502009-03-09 21:49:58 +00005134llvm::Constant *
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005135CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
5136 const Decl *Container) {
Daniel Dunbarc56f34a2008-08-28 04:38:10 +00005137 std::string TypeStr;
5138 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container, TypeStr);
Daniel Dunbarc8ef5512008-08-23 00:19:03 +00005139 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
5140}
5141
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005142void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian56210f72009-01-21 23:34:32 +00005143 const ObjCContainerDecl *CD,
Chris Lattner5f9e2722011-07-23 10:55:15 +00005144 SmallVectorImpl<char> &Name) {
Daniel Dunbarc575ce72009-10-19 01:21:19 +00005145 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian679a5022009-01-10 21:06:09 +00005146 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbarc575ce72009-10-19 01:21:19 +00005147 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
5148 << '[' << CD->getName();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005149 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbarc575ce72009-10-19 01:21:19 +00005150 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramerf9780592012-02-07 11:57:45 +00005151 OS << '(' << *CID << ')';
Daniel Dunbarc575ce72009-10-19 01:21:19 +00005152 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbarb7ec2462008-08-16 03:19:19 +00005153}
5154
Daniel Dunbarf77ac862008-08-11 21:35:06 +00005155void CGObjCMac::FinishModule() {
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00005156 EmitModuleInfo();
5157
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00005158 // Emit the dummy bodies for any protocols which were referenced but
5159 // never defined.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005160 for (llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*>::iterator
Chris Lattnerad64e022009-07-17 23:57:13 +00005161 I = Protocols.begin(), e = Protocols.end(); I != e; ++I) {
5162 if (I->second->hasInitializer())
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00005163 continue;
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00005164
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00005165 llvm::Constant *Values[5];
Owen Andersonc9c88b42009-07-31 20:28:54 +00005166 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Stephen Hines176edba2014-12-01 14:53:08 -08005167 Values[1] = GetClassName(I->first->getName());
Owen Andersonc9c88b42009-07-31 20:28:54 +00005168 Values[2] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00005169 Values[3] = Values[4] =
Owen Andersonc9c88b42009-07-31 20:28:54 +00005170 llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Owen Anderson08e25242009-07-27 22:29:56 +00005171 I->second->setInitializer(llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00005172 Values));
Stephen Hines651f13c2014-04-23 16:59:28 -07005173 CGM.addCompilerUsedGlobal(I->second);
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00005174 }
5175
Daniel Dunbar242d4dc2008-08-25 06:02:07 +00005176 // Add assembler directives to add lazy undefined symbol references
5177 // for classes which are referenced but not defined. This is
5178 // important for correct linker interaction.
Daniel Dunbar33063492009-09-07 00:20:42 +00005179 //
5180 // FIXME: It would be nice if we had an LLVM construct for this.
5181 if (!LazySymbols.empty() || !DefinedSymbols.empty()) {
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00005182 SmallString<256> Asm;
Daniel Dunbar33063492009-09-07 00:20:42 +00005183 Asm += CGM.getModule().getModuleInlineAsm();
5184 if (!Asm.empty() && Asm.back() != '\n')
5185 Asm += '\n';
Daniel Dunbar242d4dc2008-08-25 06:02:07 +00005186
Daniel Dunbar33063492009-09-07 00:20:42 +00005187 llvm::raw_svector_ostream OS(Asm);
Daniel Dunbar33063492009-09-07 00:20:42 +00005188 for (llvm::SetVector<IdentifierInfo*>::iterator I = DefinedSymbols.begin(),
5189 e = DefinedSymbols.end(); I != e; ++I)
Daniel Dunbar01eb9b92009-10-18 21:17:35 +00005190 OS << "\t.objc_class_name_" << (*I)->getName() << "=0\n"
5191 << "\t.globl .objc_class_name_" << (*I)->getName() << "\n";
Chris Lattnerafd5eda2010-04-17 18:26:20 +00005192 for (llvm::SetVector<IdentifierInfo*>::iterator I = LazySymbols.begin(),
Fariborz Jahanianb9c5b3d2010-06-21 22:05:18 +00005193 e = LazySymbols.end(); I != e; ++I) {
Chris Lattnerafd5eda2010-04-17 18:26:20 +00005194 OS << "\t.lazy_reference .objc_class_name_" << (*I)->getName() << "\n";
Fariborz Jahanianb9c5b3d2010-06-21 22:05:18 +00005195 }
5196
Bill Wendling13562a12012-02-07 09:06:01 +00005197 for (size_t i = 0, e = DefinedCategoryNames.size(); i < e; ++i) {
Fariborz Jahanianb9c5b3d2010-06-21 22:05:18 +00005198 OS << "\t.objc_category_name_" << DefinedCategoryNames[i] << "=0\n"
5199 << "\t.globl .objc_category_name_" << DefinedCategoryNames[i] << "\n";
5200 }
Chris Lattnerafd5eda2010-04-17 18:26:20 +00005201
Daniel Dunbar33063492009-09-07 00:20:42 +00005202 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbar242d4dc2008-08-25 06:02:07 +00005203 }
Daniel Dunbarf77ac862008-08-11 21:35:06 +00005204}
5205
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005206CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005207 : CGObjCCommonMac(cgm), ObjCTypes(cgm), ObjCEmptyCacheVar(nullptr),
5208 ObjCEmptyVtableVar(nullptr) {
Fariborz Jahanianee0af742009-01-21 22:04:16 +00005209 ObjCABI = 2;
5210}
5211
Daniel Dunbarf77ac862008-08-11 21:35:06 +00005212/* *** */
5213
Fariborz Jahanianee0af742009-01-21 22:04:16 +00005214ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005215 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregor65a1e672012-01-17 23:38:32 +00005216{
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00005217 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5218 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005219
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005220 ShortTy = Types.ConvertType(Ctx.ShortTy);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005221 IntTy = Types.ConvertType(Ctx.IntTy);
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00005222 LongTy = Types.ConvertType(Ctx.LongTy);
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00005223 LongLongTy = Types.ConvertType(Ctx.LongLongTy);
Chris Lattner8b418682012-02-07 00:39:47 +00005224 Int8PtrTy = CGM.Int8PtrTy;
5225 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005226
Stephen Hines651f13c2014-04-23 16:59:28 -07005227 // arm64 targets use "int" ivar offset variables. All others,
5228 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Stephen Hines176edba2014-12-01 14:53:08 -08005229 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Stephen Hines651f13c2014-04-23 16:59:28 -07005230 IvarOffsetVarTy = IntTy;
5231 else
5232 IvarOffsetVarTy = LongTy;
5233
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00005234 ObjectPtrTy = Types.ConvertType(Ctx.getObjCIdType());
Owen Anderson96e0fc72009-07-29 22:16:19 +00005235 PtrObjectPtrTy = llvm::PointerType::getUnqual(ObjectPtrTy);
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00005236 SelectorPtrTy = Types.ConvertType(Ctx.getObjCSelType());
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005237
Fariborz Jahanianee0af742009-01-21 22:04:16 +00005238 // I'm not sure I like this. The implicit coordination is a bit
5239 // gross. We should solve this in a reasonable fashion because this
5240 // is a pretty common task (match some runtime data structure with
5241 // an LLVM data structure).
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005242
Fariborz Jahanianee0af742009-01-21 22:04:16 +00005243 // FIXME: This is leaked.
5244 // FIXME: Merge with rewriter code?
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005245
Fariborz Jahanianee0af742009-01-21 22:04:16 +00005246 // struct _objc_super {
5247 // id self;
5248 // Class cls;
5249 // }
Abramo Bagnara465d41b2010-05-11 21:36:43 +00005250 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbardaa3ac52010-04-29 16:29:11 +00005251 Ctx.getTranslationUnitDecl(),
Abramo Bagnaraba877ad2011-03-09 14:09:51 +00005252 SourceLocation(), SourceLocation(),
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005253 &Ctx.Idents.get("_objc_super"));
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005254 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5255 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5256 false, ICIS_NoInit));
5257 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5258 nullptr, Ctx.getObjCClassType(), nullptr,
5259 nullptr, false, ICIS_NoInit));
Douglas Gregor838db382010-02-11 01:19:42 +00005260 RD->completeDefinition();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005261
Fariborz Jahanianee0af742009-01-21 22:04:16 +00005262 SuperCTy = Ctx.getTagDeclType(RD);
5263 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005264
Fariborz Jahanianee0af742009-01-21 22:04:16 +00005265 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005266 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5267
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005268 // struct _prop_t {
5269 // char *name;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005270 // char *attributes;
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005271 // }
Chris Lattnerc1c20112011-08-12 17:43:31 +00005272 PropertyTy = llvm::StructType::create("struct._prop_t",
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005273 Int8PtrTy, Int8PtrTy, nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005274
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005275 // struct _prop_list_t {
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005276 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005277 // uint32_t count_of_properties;
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005278 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005279 // }
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005280 PropertyListTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005281 llvm::StructType::create("struct._prop_list_t", IntTy, IntTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005282 llvm::ArrayType::get(PropertyTy, 0), nullptr);
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005283 // struct _prop_list_t *
Owen Anderson96e0fc72009-07-29 22:16:19 +00005284 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005285
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005286 // struct _objc_method {
5287 // SEL _cmd;
5288 // char *method_type;
5289 // char *_imp;
5290 // }
Chris Lattnerc1c20112011-08-12 17:43:31 +00005291 MethodTy = llvm::StructType::create("struct._objc_method",
5292 SelectorPtrTy, Int8PtrTy, Int8PtrTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005293 nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005294
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005295 // struct _objc_cache *
Chris Lattnerc1c20112011-08-12 17:43:31 +00005296 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson96e0fc72009-07-29 22:16:19 +00005297 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanianee0af742009-01-21 22:04:16 +00005298}
Daniel Dunbar4e2d7d02008-08-12 06:48:42 +00005299
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005300ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump1eb44332009-09-09 15:08:12 +00005301 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005302 // struct _objc_method_description {
5303 // SEL name;
5304 // char *types;
5305 // }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005306 MethodDescriptionTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005307 llvm::StructType::create("struct._objc_method_description",
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005308 SelectorPtrTy, Int8PtrTy, nullptr);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005309
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005310 // struct _objc_method_description_list {
5311 // int count;
5312 // struct _objc_method_description[1];
5313 // }
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005314 MethodDescriptionListTy = llvm::StructType::create(
5315 "struct._objc_method_description_list", IntTy,
5316 llvm::ArrayType::get(MethodDescriptionTy, 0), nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005317
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005318 // struct _objc_method_description_list *
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005319 MethodDescriptionListPtrTy =
Owen Anderson96e0fc72009-07-29 22:16:19 +00005320 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005321
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005322 // Protocol description structures
5323
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005324 // struct _objc_protocol_extension {
5325 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5326 // struct _objc_method_description_list *optional_instance_methods;
5327 // struct _objc_method_description_list *optional_class_methods;
5328 // struct _objc_property_list *instance_properties;
Bob Wilsondc8dab62011-11-30 01:57:58 +00005329 // const char ** extendedMethodTypes;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005330 // struct _objc_property_list *class_properties;
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005331 // }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005332 ProtocolExtensionTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005333 llvm::StructType::create("struct._objc_protocol_extension",
5334 IntTy, MethodDescriptionListPtrTy,
5335 MethodDescriptionListPtrTy, PropertyListPtrTy,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005336 Int8PtrPtrTy, PropertyListPtrTy, nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005337
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005338 // struct _objc_protocol_extension *
Owen Anderson96e0fc72009-07-29 22:16:19 +00005339 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005340
Daniel Dunbar0c0e7a62008-10-29 22:36:39 +00005341 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005342
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005343 ProtocolTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005344 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005345
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005346 ProtocolListTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005347 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005348 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy),
Fariborz Jahanianee0af742009-01-21 22:04:16 +00005349 LongTy,
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005350 llvm::ArrayType::get(ProtocolTy, 0),
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005351 nullptr);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005352
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005353 // struct _objc_protocol {
5354 // struct _objc_protocol_extension *isa;
5355 // char *protocol_name;
5356 // struct _objc_protocol **_objc_protocol_list;
5357 // struct _objc_method_description_list *instance_methods;
5358 // struct _objc_method_description_list *class_methods;
5359 // }
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005360 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5361 llvm::PointerType::getUnqual(ProtocolListTy),
5362 MethodDescriptionListPtrTy,
5363 MethodDescriptionListPtrTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005364 nullptr);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005365
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005366 // struct _objc_protocol_list *
Owen Anderson96e0fc72009-07-29 22:16:19 +00005367 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00005368
Owen Anderson96e0fc72009-07-29 22:16:19 +00005369 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005370
5371 // Class description structures
5372
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005373 // struct _objc_ivar {
5374 // char *ivar_name;
5375 // char *ivar_type;
5376 // int ivar_offset;
5377 // }
Chris Lattnerc1c20112011-08-12 17:43:31 +00005378 IvarTy = llvm::StructType::create("struct._objc_ivar",
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005379 Int8PtrTy, Int8PtrTy, IntTy, nullptr);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005380
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005381 // struct _objc_ivar_list *
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005382 IvarListTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005383 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson96e0fc72009-07-29 22:16:19 +00005384 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005385
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005386 // struct _objc_method_list *
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005387 MethodListTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005388 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson96e0fc72009-07-29 22:16:19 +00005389 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005390
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005391 // struct _objc_class_extension *
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005392 ClassExtensionTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005393 llvm::StructType::create("struct._objc_class_extension",
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005394 IntTy, Int8PtrTy, PropertyListPtrTy, nullptr);
Owen Anderson96e0fc72009-07-29 22:16:19 +00005395 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005396
Chris Lattnerc1c20112011-08-12 17:43:31 +00005397 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005398
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005399 // struct _objc_class {
5400 // Class isa;
5401 // Class super_class;
5402 // char *name;
5403 // long version;
5404 // long info;
5405 // long instance_size;
5406 // struct _objc_ivar_list *ivars;
5407 // struct _objc_method_list *methods;
5408 // struct _objc_cache *cache;
5409 // struct _objc_protocol_list *protocols;
5410 // char *ivar_layout;
5411 // struct _objc_class_ext *ext;
5412 // };
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005413 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
5414 llvm::PointerType::getUnqual(ClassTy),
5415 Int8PtrTy,
5416 LongTy,
5417 LongTy,
5418 LongTy,
5419 IvarListPtrTy,
5420 MethodListPtrTy,
5421 CachePtrTy,
5422 ProtocolListPtrTy,
5423 Int8PtrTy,
5424 ClassExtensionPtrTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005425 nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005426
Owen Anderson96e0fc72009-07-29 22:16:19 +00005427 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005428
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005429 // struct _objc_category {
5430 // char *category_name;
5431 // char *class_name;
5432 // struct _objc_method_list *instance_method;
5433 // struct _objc_method_list *class_method;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005434 // struct _objc_protocol_list *protocols;
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005435 // uint32_t size; // sizeof(struct _objc_category)
5436 // struct _objc_property_list *instance_properties;// category's @property
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005437 // struct _objc_property_list *class_properties;
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005438 // }
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005439 CategoryTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005440 llvm::StructType::create("struct._objc_category",
5441 Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5442 MethodListPtrTy, ProtocolListPtrTy,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005443 IntTy, PropertyListPtrTy, PropertyListPtrTy,
5444 nullptr);
Daniel Dunbar86e253a2008-08-22 20:34:54 +00005445
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005446 // Global metadata structures
5447
Fariborz Jahanian10a42312009-01-21 00:39:53 +00005448 // struct _objc_symtab {
5449 // long sel_ref_cnt;
5450 // SEL *refs;
5451 // short cls_def_cnt;
5452 // short cat_def_cnt;
5453 // char *defs[cls_def_cnt + cat_def_cnt];
5454 // }
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005455 SymtabTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005456 llvm::StructType::create("struct._objc_symtab",
5457 LongTy, SelectorPtrTy, ShortTy, ShortTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005458 llvm::ArrayType::get(Int8PtrTy, 0), nullptr);
Owen Anderson96e0fc72009-07-29 22:16:19 +00005459 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar27f9d772008-08-21 04:36:09 +00005460
Fariborz Jahaniandb286862009-01-22 00:37:21 +00005461 // struct _objc_module {
5462 // long version;
5463 // long size; // sizeof(struct _objc_module)
5464 // char *name;
5465 // struct _objc_symtab* symtab;
5466 // }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005467 ModuleTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005468 llvm::StructType::create("struct._objc_module",
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005469 LongTy, LongTy, Int8PtrTy, SymtabPtrTy, nullptr);
Daniel Dunbar14c80b72008-08-23 09:25:55 +00005470
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005471
Mike Stumpf5408fe2009-05-16 07:57:57 +00005472 // FIXME: This is the size of the setjmp buffer and should be target
5473 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson124526b2008-09-09 10:10:21 +00005474 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005475
Anders Carlsson124526b2008-09-09 10:10:21 +00005476 // Exceptions
Chris Lattner8b418682012-02-07 00:39:47 +00005477 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005478
5479 ExceptionDataTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005480 llvm::StructType::create("struct._objc_exception_data",
Chris Lattner8b418682012-02-07 00:39:47 +00005481 llvm::ArrayType::get(CGM.Int32Ty,SetJmpBufferSize),
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005482 StackPtrTy, nullptr);
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00005483}
5484
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005485ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump1eb44332009-09-09 15:08:12 +00005486 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005487 // struct _method_list_t {
5488 // uint32_t entsize; // sizeof(struct _objc_method)
5489 // uint32_t method_count;
5490 // struct _objc_method method_list[method_count];
5491 // }
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005492 MethodListnfABITy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005493 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005494 llvm::ArrayType::get(MethodTy, 0), nullptr);
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005495 // struct method_list_t *
Owen Anderson96e0fc72009-07-29 22:16:19 +00005496 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005497
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005498 // struct _protocol_t {
5499 // id isa; // NULL
5500 // const char * const protocol_name;
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005501 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005502 // const struct method_list_t * const instance_methods;
5503 // const struct method_list_t * const class_methods;
5504 // const struct method_list_t *optionalInstanceMethods;
5505 // const struct method_list_t *optionalClassMethods;
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005506 // const struct _prop_list_t * properties;
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005507 // const uint32_t size; // sizeof(struct _protocol_t)
5508 // const uint32_t flags; // = 0
Bob Wilsondc8dab62011-11-30 01:57:58 +00005509 // const char ** extendedMethodTypes;
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07005510 // const char *demangledName;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005511 // const struct _prop_list_t * class_properties;
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005512 // }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005513
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005514 // Holder for struct _protocol_list_t *
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005515 ProtocolListnfABITy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005516 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005517
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005518 ProtocolnfABITy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005519 llvm::StructType::create("struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5520 llvm::PointerType::getUnqual(ProtocolListnfABITy),
5521 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5522 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
Bob Wilsondc8dab62011-11-30 01:57:58 +00005523 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005524 Int8PtrTy, PropertyListPtrTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005525 nullptr);
Daniel Dunbar948e2582009-02-15 07:36:20 +00005526
5527 // struct _protocol_t*
Owen Anderson96e0fc72009-07-29 22:16:19 +00005528 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005529
Fariborz Jahanianda320092009-01-29 19:24:30 +00005530 // struct _protocol_list_t {
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005531 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar948e2582009-02-15 07:36:20 +00005532 // struct _protocol_t *[protocol_count];
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005533 // }
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005534 ProtocolListnfABITy->setBody(LongTy,
5535 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0),
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005536 nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005537
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005538 // struct _objc_protocol_list*
Owen Anderson96e0fc72009-07-29 22:16:19 +00005539 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005540
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005541 // struct _ivar_t {
Stephen Hines651f13c2014-04-23 16:59:28 -07005542 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005543 // char *name;
5544 // char *type;
5545 // uint32_t alignment;
5546 // uint32_t size;
5547 // }
Stephen Hines651f13c2014-04-23 16:59:28 -07005548 IvarnfABITy = llvm::StructType::create(
5549 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005550 Int8PtrTy, Int8PtrTy, IntTy, IntTy, nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005551
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005552 // struct _ivar_list_t {
5553 // uint32 entsize; // sizeof(struct _ivar_t)
5554 // uint32 count;
5555 // struct _iver_t list[count];
5556 // }
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005557 IvarListnfABITy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005558 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005559 llvm::ArrayType::get(IvarnfABITy, 0), nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005560
Owen Anderson96e0fc72009-07-29 22:16:19 +00005561 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005562
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005563 // struct _class_ro_t {
Fariborz Jahanian30bc5712009-01-22 23:02:58 +00005564 // uint32_t const flags;
5565 // uint32_t const instanceStart;
5566 // uint32_t const instanceSize;
5567 // uint32_t const reserved; // only when building for 64bit targets
5568 // const uint8_t * const ivarLayout;
5569 // const char *const name;
5570 // const struct _method_list_t * const baseMethods;
5571 // const struct _objc_protocol_list *const baseProtocols;
5572 // const struct _ivar_list_t *const ivars;
5573 // const uint8_t * const weakIvarLayout;
5574 // const struct _prop_list_t * const properties;
5575 // }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005576
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005577 // FIXME. Add 'reserved' field in 64bit abi mode!
Chris Lattnerc1c20112011-08-12 17:43:31 +00005578 ClassRonfABITy = llvm::StructType::create("struct._class_ro_t",
5579 IntTy, IntTy, IntTy, Int8PtrTy,
5580 Int8PtrTy, MethodListnfABIPtrTy,
5581 ProtocolListnfABIPtrTy,
5582 IvarListnfABIPtrTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005583 Int8PtrTy, PropertyListPtrTy,
5584 nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005585
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005586 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005587 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall0774cb82011-05-15 01:53:33 +00005588 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5589 ->getPointerTo();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005590
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005591 // struct _class_t {
5592 // struct _class_t *isa;
5593 // struct _class_t * const superclass;
5594 // void *cache;
5595 // IMP *vtable;
5596 // struct class_ro_t *ro;
5597 // }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005598
Chris Lattnerc1c20112011-08-12 17:43:31 +00005599 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005600 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
5601 llvm::PointerType::getUnqual(ClassnfABITy),
5602 CachePtrTy,
5603 llvm::PointerType::getUnqual(ImpnfABITy),
5604 llvm::PointerType::getUnqual(ClassRonfABITy),
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005605 nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005606
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00005607 // LLVM for struct _class_t *
Owen Anderson96e0fc72009-07-29 22:16:19 +00005608 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005609
Fariborz Jahaniand55b6fc2009-01-23 01:46:23 +00005610 // struct _category_t {
5611 // const char * const name;
5612 // struct _class_t *const cls;
5613 // const struct _method_list_t * const instance_methods;
5614 // const struct _method_list_t * const class_methods;
5615 // const struct _protocol_list_t * const protocols;
5616 // const struct _prop_list_t * const properties;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005617 // const struct _prop_list_t * const class_properties;
5618 // const uint32_t size;
Fariborz Jahanian45c2ba02009-01-23 17:41:22 +00005619 // }
Chris Lattnerc1c20112011-08-12 17:43:31 +00005620 CategorynfABITy = llvm::StructType::create("struct._category_t",
5621 Int8PtrTy, ClassnfABIPtrTy,
5622 MethodListnfABIPtrTy,
5623 MethodListnfABIPtrTy,
5624 ProtocolListnfABIPtrTy,
5625 PropertyListPtrTy,
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005626 PropertyListPtrTy,
5627 IntTy,
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005628 nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005629
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +00005630 // New types for nonfragile abi messaging.
Fariborz Jahanian83a8a752009-02-04 20:42:28 +00005631 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5632 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005633
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +00005634 // MessageRefTy - LLVM for:
5635 // struct _message_ref_t {
5636 // IMP messenger;
5637 // SEL name;
5638 // };
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005639
Fariborz Jahanian83a8a752009-02-04 20:42:28 +00005640 // First the clang type for struct _message_ref_t
Abramo Bagnara465d41b2010-05-11 21:36:43 +00005641 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbardaa3ac52010-04-29 16:29:11 +00005642 Ctx.getTranslationUnitDecl(),
Abramo Bagnaraba877ad2011-03-09 14:09:51 +00005643 SourceLocation(), SourceLocation(),
Fariborz Jahanian83a8a752009-02-04 20:42:28 +00005644 &Ctx.Idents.get("_message_ref_t"));
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005645 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5646 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smithca523302012-06-10 03:12:00 +00005647 ICIS_NoInit));
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005648 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5649 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5650 false, ICIS_NoInit));
Douglas Gregor838db382010-02-11 01:19:42 +00005651 RD->completeDefinition();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005652
Fariborz Jahanian83a8a752009-02-04 20:42:28 +00005653 MessageRefCTy = Ctx.getTagDeclType(RD);
5654 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5655 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005656
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +00005657 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson96e0fc72009-07-29 22:16:19 +00005658 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005659
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +00005660 // SuperMessageRefTy - LLVM for:
5661 // struct _super_message_ref_t {
5662 // SUPER_IMP messenger;
5663 // SEL name;
5664 // };
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005665 SuperMessageRefTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005666 llvm::StructType::create("struct._super_message_ref_t",
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005667 ImpnfABITy, SelectorPtrTy, nullptr);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005668
Fariborz Jahanian2e4672b2009-02-03 23:49:23 +00005669 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005670 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fariborz Jahanian9d96bce2011-06-22 20:21:51 +00005671
Daniel Dunbare588b992009-03-01 04:46:24 +00005672
5673 // struct objc_typeinfo {
5674 // const void** vtable; // objc_ehtype_vtable + 2
5675 // const char* name; // c++ typeinfo string
5676 // Class cls;
5677 // };
Chris Lattner9cbe4f02011-07-09 17:41:47 +00005678 EHTypeTy =
Chris Lattnerc1c20112011-08-12 17:43:31 +00005679 llvm::StructType::create("struct._objc_typeinfo",
5680 llvm::PointerType::getUnqual(Int8PtrTy),
Stephen Hines0e2c34f2015-03-23 12:09:02 -07005681 Int8PtrTy, ClassnfABIPtrTy, nullptr);
Owen Anderson96e0fc72009-07-29 22:16:19 +00005682 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00005683}
5684
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005685llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00005686 FinishNonFragileABIModule();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005687
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005688 return nullptr;
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00005689}
5690
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005691void CGObjCNonFragileABIMac::AddModuleClassList(
5692 ArrayRef<llvm::GlobalValue *> Container, StringRef SymbolName,
5693 StringRef SectionName) {
Daniel Dunbar463b8762009-05-15 21:48:48 +00005694 unsigned NumClasses = Container.size();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005695
Daniel Dunbar463b8762009-05-15 21:48:48 +00005696 if (!NumClasses)
5697 return;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005698
Chris Lattner0b239712012-02-06 22:16:34 +00005699 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar463b8762009-05-15 21:48:48 +00005700 for (unsigned i=0; i<NumClasses; i++)
Owen Anderson3c4972d2009-07-29 18:54:39 +00005701 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar463b8762009-05-15 21:48:48 +00005702 ObjCTypes.Int8PtrTy);
Chris Lattner0b239712012-02-06 22:16:34 +00005703 llvm::Constant *Init =
Owen Anderson96e0fc72009-07-29 22:16:19 +00005704 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner0b239712012-02-06 22:16:34 +00005705 Symbols.size()),
Daniel Dunbar463b8762009-05-15 21:48:48 +00005706 Symbols);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005707
Daniel Dunbar463b8762009-05-15 21:48:48 +00005708 llvm::GlobalVariable *GV =
Owen Anderson1c431b32009-07-08 19:05:04 +00005709 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Stephen Hines651f13c2014-04-23 16:59:28 -07005710 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar463b8762009-05-15 21:48:48 +00005711 Init,
Owen Anderson1c431b32009-07-08 19:05:04 +00005712 SymbolName);
Micah Villmow25a6a842012-10-08 16:25:52 +00005713 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar463b8762009-05-15 21:48:48 +00005714 GV->setSection(SectionName);
Stephen Hines651f13c2014-04-23 16:59:28 -07005715 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar463b8762009-05-15 21:48:48 +00005716}
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005717
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00005718void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
5719 // nonfragile abi has no module definition.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005720
Daniel Dunbar463b8762009-05-15 21:48:48 +00005721 // Build list of all implemented class addresses in array
Fariborz Jahanianf87a0cc2009-01-30 20:55:31 +00005722 // L_OBJC_LABEL_CLASS_$.
Stephen Hines651f13c2014-04-23 16:59:28 -07005723
5724 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
5725 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5726 assert(ID);
5727 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5728 // We are implementing a weak imported interface. Give it external linkage
Stephen Hines176edba2014-12-01 14:53:08 -08005729 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Stephen Hines651f13c2014-04-23 16:59:28 -07005730 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Stephen Hines176edba2014-12-01 14:53:08 -08005731 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
5732 }
Stephen Hines651f13c2014-04-23 16:59:28 -07005733 }
Stephen Hines176edba2014-12-01 14:53:08 -08005734
5735 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Daniel Dunbar463b8762009-05-15 21:48:48 +00005736 "__DATA, __objc_classlist, regular, no_dead_strip");
Stephen Hines651f13c2014-04-23 16:59:28 -07005737
Stephen Hines176edba2014-12-01 14:53:08 -08005738 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Daniel Dunbar74d4b122009-05-15 22:33:15 +00005739 "__DATA, __objc_nlclslist, regular, no_dead_strip");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005740
Fariborz Jahanianf87a0cc2009-01-30 20:55:31 +00005741 // Build list of all implemented category addresses in array
5742 // L_OBJC_LABEL_CATEGORY_$.
Stephen Hines176edba2014-12-01 14:53:08 -08005743 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Daniel Dunbar463b8762009-05-15 21:48:48 +00005744 "__DATA, __objc_catlist, regular, no_dead_strip");
Stephen Hines176edba2014-12-01 14:53:08 -08005745 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Daniel Dunbar74d4b122009-05-15 22:33:15 +00005746 "__DATA, __objc_nlcatlist, regular, no_dead_strip");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005747
Daniel Dunbarfce176b2010-04-25 20:39:01 +00005748 EmitImageInfo();
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00005749}
5750
John McCall944c8432011-05-14 03:10:52 +00005751/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
5752/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005753/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +00005754/// message dispatch call for all the rest.
John McCall944c8432011-05-14 03:10:52 +00005755bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
5756 // At various points we've experimented with using vtable-based
5757 // dispatch for all methods.
Daniel Dunbarf643b9b2010-04-24 17:56:46 +00005758 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarf643b9b2010-04-24 17:56:46 +00005759 case CodeGenOptions::Legacy:
Fariborz Jahanian776dbf92010-04-19 17:53:30 +00005760 return false;
John McCall944c8432011-05-14 03:10:52 +00005761 case CodeGenOptions::NonLegacy:
5762 return true;
Daniel Dunbarf643b9b2010-04-24 17:56:46 +00005763 case CodeGenOptions::Mixed:
5764 break;
5765 }
5766
5767 // If so, see whether this selector is in the white-list of things which must
5768 // use the new dispatch convention. We lazily build a dense set for this.
John McCall944c8432011-05-14 03:10:52 +00005769 if (VTableDispatchMethods.empty()) {
5770 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
5771 VTableDispatchMethods.insert(GetNullarySelector("class"));
5772 VTableDispatchMethods.insert(GetNullarySelector("self"));
5773 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
5774 VTableDispatchMethods.insert(GetNullarySelector("length"));
5775 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005776
John McCall944c8432011-05-14 03:10:52 +00005777 // These are vtable-based if GC is disabled.
5778 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikie4e4d0842012-03-11 07:00:24 +00005779 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall944c8432011-05-14 03:10:52 +00005780 VTableDispatchMethods.insert(GetNullarySelector("retain"));
5781 VTableDispatchMethods.insert(GetNullarySelector("release"));
5782 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
5783 }
5784
5785 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
5786 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
5787 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
5788 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
5789 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
5790 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
5791 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
5792
5793 // These are vtable-based if GC is enabled.
5794 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikie4e4d0842012-03-11 07:00:24 +00005795 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall944c8432011-05-14 03:10:52 +00005796 VTableDispatchMethods.insert(GetNullarySelector("hash"));
5797 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
5798
5799 // "countByEnumeratingWithState:objects:count"
5800 IdentifierInfo *KeyIdents[] = {
5801 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
5802 &CGM.getContext().Idents.get("objects"),
5803 &CGM.getContext().Idents.get("count")
5804 };
5805 VTableDispatchMethods.insert(
5806 CGM.getContext().Selectors.getSelector(3, KeyIdents));
5807 }
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +00005808 }
Daniel Dunbarf643b9b2010-04-24 17:56:46 +00005809
John McCall944c8432011-05-14 03:10:52 +00005810 return VTableDispatchMethods.count(Sel);
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +00005811}
5812
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00005813/// BuildClassRoTInitializer - generate meta-data for:
5814/// struct _class_ro_t {
5815/// uint32_t const flags;
5816/// uint32_t const instanceStart;
5817/// uint32_t const instanceSize;
5818/// uint32_t const reserved; // only when building for 64bit targets
5819/// const uint8_t * const ivarLayout;
5820/// const char *const name;
5821/// const struct _method_list_t * const baseMethods;
Fariborz Jahanianda320092009-01-29 19:24:30 +00005822/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00005823/// const struct _ivar_list_t *const ivars;
5824/// const uint8_t * const weakIvarLayout;
5825/// const struct _prop_list_t * const properties;
5826/// }
5827///
5828llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005829 unsigned flags,
5830 unsigned InstanceStart,
5831 unsigned InstanceSize,
5832 const ObjCImplementationDecl *ID) {
Stephen Hines176edba2014-12-01 14:53:08 -08005833 std::string ClassName = ID->getObjCRuntimeNameAsString();
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00005834 llvm::Constant *Values[10]; // 11 for 64bit targets!
John McCallf85e1932011-06-15 23:02:42 +00005835
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005836 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
5837 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
5838
5839 bool hasMRCWeak = false;
David Blaikie4e4d0842012-03-11 07:00:24 +00005840 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall621915c2012-10-17 04:53:23 +00005841 flags |= NonFragileABI_Class_CompiledByARC;
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005842 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
5843 flags |= NonFragileABI_Class_HasMRCWeakIvars;
John McCallf85e1932011-06-15 23:02:42 +00005844
Owen Anderson4a28d5d2009-07-24 23:12:58 +00005845 Values[ 0] = llvm::ConstantInt::get(ObjCTypes.IntTy, flags);
5846 Values[ 1] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceStart);
5847 Values[ 2] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceSize);
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00005848 // FIXME. For 64bit targets add 0 here.
John McCall621915c2012-10-17 04:53:23 +00005849 Values[ 3] = (flags & NonFragileABI_Class_Meta)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005850 ? GetIvarLayoutName(nullptr, ObjCTypes)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005851 : BuildStrongIvarLayout(ID, beginInstance, endInstance);
Stephen Hines176edba2014-12-01 14:53:08 -08005852 Values[ 4] = GetClassName(ID->getObjCRuntimeNameAsString());
Fariborz Jahanian493dab72009-01-26 21:38:32 +00005853 // const struct _method_list_t * const baseMethods;
5854 std::vector<llvm::Constant*> Methods;
5855 std::string MethodListName("\01l_OBJC_$_");
John McCall621915c2012-10-17 04:53:23 +00005856 if (flags & NonFragileABI_Class_Meta) {
Stephen Hines176edba2014-12-01 14:53:08 -08005857 MethodListName += "CLASS_METHODS_";
5858 MethodListName += ID->getObjCRuntimeNameAsString();
Stephen Hines651f13c2014-04-23 16:59:28 -07005859 for (const auto *I : ID->class_methods())
Fariborz Jahanian493dab72009-01-26 21:38:32 +00005860 // Class methods should always be defined.
Stephen Hines651f13c2014-04-23 16:59:28 -07005861 Methods.push_back(GetMethodConstant(I));
Fariborz Jahanian493dab72009-01-26 21:38:32 +00005862 } else {
Stephen Hines176edba2014-12-01 14:53:08 -08005863 MethodListName += "INSTANCE_METHODS_";
5864 MethodListName += ID->getObjCRuntimeNameAsString();
Stephen Hines651f13c2014-04-23 16:59:28 -07005865 for (const auto *I : ID->instance_methods())
Fariborz Jahanian493dab72009-01-26 21:38:32 +00005866 // Instance methods should always be defined.
Stephen Hines651f13c2014-04-23 16:59:28 -07005867 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005868
Stephen Hines651f13c2014-04-23 16:59:28 -07005869 for (const auto *PID : ID->property_impls()) {
Fariborz Jahanian939abce2009-01-28 22:46:49 +00005870 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
5871 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005872
Fariborz Jahanian939abce2009-01-28 22:46:49 +00005873 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
5874 if (llvm::Constant *C = GetMethodConstant(MD))
5875 Methods.push_back(C);
5876 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
5877 if (llvm::Constant *C = GetMethodConstant(MD))
5878 Methods.push_back(C);
5879 }
5880 }
Fariborz Jahanian493dab72009-01-26 21:38:32 +00005881 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005882 Values[ 5] = EmitMethodList(MethodListName,
5883 "__DATA, __objc_const", Methods);
5884
Fariborz Jahanianda320092009-01-29 19:24:30 +00005885 const ObjCInterfaceDecl *OID = ID->getClassInterface();
5886 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005887 Values[ 6] = EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Stephen Hines176edba2014-12-01 14:53:08 -08005888 + OID->getObjCRuntimeNameAsString(),
Ted Kremenek53b94412010-09-01 01:21:15 +00005889 OID->all_referenced_protocol_begin(),
5890 OID->all_referenced_protocol_end());
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005891
John McCall621915c2012-10-17 04:53:23 +00005892 if (flags & NonFragileABI_Class_Meta) {
Owen Andersonc9c88b42009-07-31 20:28:54 +00005893 Values[ 7] = llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005894 Values[ 8] = GetIvarLayoutName(nullptr, ObjCTypes);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005895 Values[ 9] = EmitPropertyList(
5896 "\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
5897 ID, ID->getClassInterface(), ObjCTypes, true);
John McCall621915c2012-10-17 04:53:23 +00005898 } else {
5899 Values[ 7] = EmitIvarList(ID);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08005900 Values[ 8] = BuildWeakIvarLayout(ID, beginInstance, endInstance,
5901 hasMRCWeak);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005902 Values[ 9] = EmitPropertyList(
5903 "\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
5904 ID, ID->getClassInterface(), ObjCTypes, false);
John McCall621915c2012-10-17 04:53:23 +00005905 }
Owen Anderson08e25242009-07-27 22:29:56 +00005906 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassRonfABITy,
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00005907 Values);
5908 llvm::GlobalVariable *CLASS_RO_GV =
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005909 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassRonfABITy, false,
Stephen Hines651f13c2014-04-23 16:59:28 -07005910 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005911 Init,
John McCall621915c2012-10-17 04:53:23 +00005912 (flags & NonFragileABI_Class_Meta) ?
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005913 std::string("\01l_OBJC_METACLASS_RO_$_")+ClassName :
5914 std::string("\01l_OBJC_CLASS_RO_$_")+ClassName);
Fariborz Jahanian09796d62009-01-31 02:43:27 +00005915 CLASS_RO_GV->setAlignment(
Micah Villmow25a6a842012-10-08 16:25:52 +00005916 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassRonfABITy));
Fariborz Jahanian1bf0afb2009-01-28 01:05:23 +00005917 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00005918 return CLASS_RO_GV;
Fariborz Jahanianf6317dd2009-01-26 22:58:07 +00005919
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00005920}
5921
5922/// BuildClassMetaData - This routine defines that to-level meta-data
5923/// for the given ClassName for:
5924/// struct _class_t {
5925/// struct _class_t *isa;
5926/// struct _class_t * const superclass;
5927/// void *cache;
5928/// IMP *vtable;
5929/// struct class_ro_t *ro;
5930/// }
5931///
Stephen Hines651f13c2014-04-23 16:59:28 -07005932llvm::GlobalVariable *CGObjCNonFragileABIMac::BuildClassMetaData(
Stephen Hines176edba2014-12-01 14:53:08 -08005933 const std::string &ClassName, llvm::Constant *IsAGV, llvm::Constant *SuperClassGV,
Stephen Hines651f13c2014-04-23 16:59:28 -07005934 llvm::Constant *ClassRoGV, bool HiddenVisibility, bool Weak) {
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00005935 llvm::Constant *Values[] = {
5936 IsAGV,
5937 SuperClassGV,
5938 ObjCEmptyCacheVar, // &ObjCEmptyCacheVar
5939 ObjCEmptyVtableVar, // &ObjCEmptyVtableVar
5940 ClassRoGV // &CLASS_RO_GV
5941 };
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005942 if (!Values[1])
5943 Values[1] = llvm::Constant::getNullValue(ObjCTypes.ClassnfABIPtrTy);
Fariborz Jahanian3da9a8f2013-10-24 17:40:28 +00005944 if (!Values[3])
5945 Values[3] = llvm::Constant::getNullValue(
5946 llvm::PointerType::getUnqual(ObjCTypes.ImpnfABITy));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005947 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassnfABITy,
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00005948 Values);
Stephen Hines651f13c2014-04-23 16:59:28 -07005949 llvm::GlobalVariable *GV = GetClassGlobal(ClassName, Weak);
Daniel Dunbar5a7379a2009-03-01 04:40:10 +00005950 GV->setInitializer(Init);
Fariborz Jahaniandd0db2a2009-01-31 01:07:39 +00005951 GV->setSection("__DATA, __objc_data");
Fariborz Jahanian09796d62009-01-31 02:43:27 +00005952 GV->setAlignment(
Micah Villmow25a6a842012-10-08 16:25:52 +00005953 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Fariborz Jahaniancf555162009-01-31 00:59:10 +00005954 if (HiddenVisibility)
5955 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian84394a52009-01-24 21:21:53 +00005956 return GV;
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00005957}
5958
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005959bool
Fariborz Jahanianecfbdcb2009-05-21 01:03:45 +00005960CGObjCNonFragileABIMac::ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005961 return OD->getClassMethod(GetNullarySelector("load")) != nullptr;
Daniel Dunbar74d4b122009-05-15 22:33:15 +00005962}
5963
Daniel Dunbar9f89f2b2009-05-03 12:57:56 +00005964void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbarb02532a2009-04-19 23:41:48 +00005965 uint32_t &InstanceStart,
5966 uint32_t &InstanceSize) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005967 const ASTRecordLayout &RL =
Daniel Dunbarb4c79e02009-05-04 21:26:30 +00005968 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005969
Daniel Dunbar6e8575b2009-05-04 23:23:09 +00005970 // InstanceSize is really instance end.
Ken Dyckec299032011-02-11 02:20:09 +00005971 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar6e8575b2009-05-04 23:23:09 +00005972
5973 // If there are no fields, the start is the same as the end.
5974 if (!RL.getFieldCount())
5975 InstanceStart = InstanceSize;
5976 else
Ken Dyckfb67ccd2011-04-14 00:43:09 +00005977 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbarb02532a2009-04-19 23:41:48 +00005978}
5979
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00005980void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Stephen Hines176edba2014-12-01 14:53:08 -08005981 std::string ClassName = ID->getObjCRuntimeNameAsString();
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00005982 if (!ObjCEmptyCacheVar) {
5983 ObjCEmptyCacheVar = new llvm::GlobalVariable(
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005984 CGM.getModule(), ObjCTypes.CacheTy, false,
5985 llvm::GlobalValue::ExternalLinkage, nullptr, "_objc_empty_cache");
Stephen Hines6bcf27b2014-05-29 04:14:42 -07005986
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005987 // Only OS X with deployment version <10.9 use the empty vtable symbol
Fariborz Jahanian3da9a8f2013-10-24 17:40:28 +00005988 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005989 if (Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 9))
Fariborz Jahanian3da9a8f2013-10-24 17:40:28 +00005990 ObjCEmptyVtableVar = new llvm::GlobalVariable(
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07005991 CGM.getModule(), ObjCTypes.ImpnfABITy, false,
5992 llvm::GlobalValue::ExternalLinkage, nullptr, "_objc_empty_vtable");
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00005993 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005994 assert(ID->getClassInterface() &&
Fariborz Jahanian493dab72009-01-26 21:38:32 +00005995 "CGObjCNonFragileABIMac::GenerateClass - class is 0");
Daniel Dunbar6c1aac82009-04-20 20:18:54 +00005996 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar6bff2512009-08-03 17:06:42 +00005997 uint32_t InstanceStart =
Micah Villmow25a6a842012-10-08 16:25:52 +00005998 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00005999 uint32_t InstanceSize = InstanceStart;
John McCall621915c2012-10-17 04:53:23 +00006000 uint32_t flags = NonFragileABI_Class_Meta;
Stephen Hines176edba2014-12-01 14:53:08 -08006001 llvm::SmallString<64> ObjCMetaClassName(getMetaclassSymbolPrefix());
6002 llvm::SmallString<64> ObjCClassName(getClassSymbolPrefix());
6003 llvm::SmallString<64> TClassName;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006004
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00006005 llvm::GlobalVariable *SuperClassGV, *IsAGV;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006006
John McCallb03527a2012-10-17 04:53:31 +00006007 // Build the flags for the metaclass.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006008 bool classIsHidden =
John McCall1fb0caa2010-10-22 21:05:15 +00006009 ID->getClassInterface()->getVisibility() == HiddenVisibility;
Fariborz Jahaniancf555162009-01-31 00:59:10 +00006010 if (classIsHidden)
John McCall621915c2012-10-17 04:53:23 +00006011 flags |= NonFragileABI_Class_Hidden;
John McCallb03527a2012-10-17 04:53:31 +00006012
6013 // FIXME: why is this flag set on the metaclass?
6014 // ObjC metaclasses have no fields and don't really get constructed.
6015 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCall621915c2012-10-17 04:53:23 +00006016 flags |= NonFragileABI_Class_HasCXXStructors;
John McCallb03527a2012-10-17 04:53:31 +00006017 if (!ID->hasNonZeroConstructors())
6018 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6019 }
6020
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006021 if (!ID->getClassInterface()->getSuperClass()) {
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00006022 // class is root
John McCall621915c2012-10-17 04:53:23 +00006023 flags |= NonFragileABI_Class_Root;
Stephen Hines176edba2014-12-01 14:53:08 -08006024 TClassName = ObjCClassName;
6025 TClassName += ClassName;
6026 SuperClassGV = GetClassGlobal(TClassName.str(),
Stephen Hines651f13c2014-04-23 16:59:28 -07006027 ID->getClassInterface()->isWeakImported());
Stephen Hines176edba2014-12-01 14:53:08 -08006028 TClassName = ObjCMetaClassName;
6029 TClassName += ClassName;
6030 IsAGV = GetClassGlobal(TClassName.str(),
Stephen Hines651f13c2014-04-23 16:59:28 -07006031 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00006032 } else {
Fariborz Jahanian84394a52009-01-24 21:21:53 +00006033 // Has a root. Current class is not a root.
Fariborz Jahanianfab98c42009-02-26 18:23:47 +00006034 const ObjCInterfaceDecl *Root = ID->getClassInterface();
6035 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
6036 Root = Super;
Stephen Hines176edba2014-12-01 14:53:08 -08006037 TClassName = ObjCMetaClassName ;
6038 TClassName += Root->getObjCRuntimeNameAsString();
6039 IsAGV = GetClassGlobal(TClassName.str(),
Stephen Hines651f13c2014-04-23 16:59:28 -07006040 Root->isWeakImported());
Stephen Hines176edba2014-12-01 14:53:08 -08006041
Fariborz Jahanianfab98c42009-02-26 18:23:47 +00006042 // work on super class metadata symbol.
Stephen Hines176edba2014-12-01 14:53:08 -08006043 TClassName = ObjCMetaClassName;
6044 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Stephen Hines651f13c2014-04-23 16:59:28 -07006045 SuperClassGV = GetClassGlobal(
Stephen Hines176edba2014-12-01 14:53:08 -08006046 TClassName.str(),
6047 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian058a1b72009-01-24 20:21:50 +00006048 }
6049 llvm::GlobalVariable *CLASS_RO_GV = BuildClassRoTInitializer(flags,
6050 InstanceStart,
6051 InstanceSize,ID);
Stephen Hines176edba2014-12-01 14:53:08 -08006052 TClassName = ObjCMetaClassName;
6053 TClassName += ClassName;
Stephen Hines651f13c2014-04-23 16:59:28 -07006054 llvm::GlobalVariable *MetaTClass = BuildClassMetaData(
Stephen Hines176edba2014-12-01 14:53:08 -08006055 TClassName.str(), IsAGV, SuperClassGV, CLASS_RO_GV, classIsHidden,
6056 ID->getClassInterface()->isWeakImported());
Fariborz Jahaniana03d0dd2009-11-17 21:37:35 +00006057 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar6ab187a2009-04-07 05:48:37 +00006058
Fariborz Jahanian84394a52009-01-24 21:21:53 +00006059 // Metadata for the class
John McCall621915c2012-10-17 04:53:23 +00006060 flags = 0;
Fariborz Jahaniancf555162009-01-31 00:59:10 +00006061 if (classIsHidden)
John McCall621915c2012-10-17 04:53:23 +00006062 flags |= NonFragileABI_Class_Hidden;
John McCallb03527a2012-10-17 04:53:31 +00006063
6064 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCall621915c2012-10-17 04:53:23 +00006065 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00006066
John McCallb03527a2012-10-17 04:53:31 +00006067 // Set a flag to enable a runtime optimization when a class has
6068 // fields that require destruction but which don't require
6069 // anything except zero-initialization during construction. This
6070 // is most notably true of __strong and __weak types, but you can
6071 // also imagine there being C++ types with non-trivial default
6072 // constructors that merely set all fields to null.
6073 if (!ID->hasNonZeroConstructors())
6074 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6075 }
6076
Douglas Gregor68584ed2009-06-18 16:11:24 +00006077 if (hasObjCExceptionAttribute(CGM.getContext(), ID->getClassInterface()))
John McCall621915c2012-10-17 04:53:23 +00006078 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00006079
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006080 if (!ID->getClassInterface()->getSuperClass()) {
John McCall621915c2012-10-17 04:53:23 +00006081 flags |= NonFragileABI_Class_Root;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07006082 SuperClassGV = nullptr;
Chris Lattnerb7b58b12009-04-19 06:02:28 +00006083 } else {
Fariborz Jahanian84394a52009-01-24 21:21:53 +00006084 // Has a root. Current class is not a root.
Stephen Hines176edba2014-12-01 14:53:08 -08006085 TClassName = ObjCClassName;
6086 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Stephen Hines651f13c2014-04-23 16:59:28 -07006087 SuperClassGV = GetClassGlobal(
Stephen Hines176edba2014-12-01 14:53:08 -08006088 TClassName.str(),
6089 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian84394a52009-01-24 21:21:53 +00006090 }
Daniel Dunbar9f89f2b2009-05-03 12:57:56 +00006091 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Fariborz Jahanian84394a52009-01-24 21:21:53 +00006092 CLASS_RO_GV = BuildClassRoTInitializer(flags,
Fariborz Jahanianf6a077e2009-01-24 23:43:01 +00006093 InstanceStart,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006094 InstanceSize,
Fariborz Jahanianf6a077e2009-01-24 23:43:01 +00006095 ID);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006096
Stephen Hines176edba2014-12-01 14:53:08 -08006097 TClassName = ObjCClassName;
6098 TClassName += ClassName;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006099 llvm::GlobalVariable *ClassMD =
Stephen Hines176edba2014-12-01 14:53:08 -08006100 BuildClassMetaData(TClassName.str(), MetaTClass, SuperClassGV, CLASS_RO_GV,
Stephen Hines651f13c2014-04-23 16:59:28 -07006101 classIsHidden,
6102 ID->getClassInterface()->isWeakImported());
Fariborz Jahanianf87a0cc2009-01-30 20:55:31 +00006103 DefinedClasses.push_back(ClassMD);
Stephen Hines651f13c2014-04-23 16:59:28 -07006104 ImplementedClasses.push_back(ID->getClassInterface());
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00006105
Daniel Dunbar74d4b122009-05-15 22:33:15 +00006106 // Determine if this class is also "non-lazy".
6107 if (ImplementationIsNonLazy(ID))
6108 DefinedNonLazyClasses.push_back(ClassMD);
6109
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00006110 // Force the definition of the EHType if necessary.
John McCall621915c2012-10-17 04:53:23 +00006111 if (flags & NonFragileABI_Class_Exception)
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00006112 GetInterfaceEHType(ID->getClassInterface(), true);
Fariborz Jahanian64089ce2011-04-22 22:02:28 +00006113 // Make sure method definition entries are all clear for next implementation.
6114 MethodDefinitions.clear();
Fariborz Jahanianaa23b572009-01-23 23:53:38 +00006115}
6116
Fariborz Jahanian8cfd3972009-01-30 18:58:59 +00006117/// GenerateProtocolRef - This routine is called to generate code for
6118/// a protocol reference expression; as in:
6119/// @code
6120/// @protocol(Proto1);
6121/// @endcode
6122/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
6123/// which will hold address of the protocol meta-data.
6124///
John McCallbd7370a2013-02-28 19:01:20 +00006125llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006126 const ObjCProtocolDecl *PD) {
6127
Fariborz Jahanian960cd062009-04-10 18:47:34 +00006128 // This routine is called for @protocol only. So, we must build definition
6129 // of protocol's meta-data (not a reference to it!)
6130 //
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006131 llvm::Constant *Init =
6132 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor4c86fdb2012-01-17 18:36:30 +00006133 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006134
Fariborz Jahanian8cfd3972009-01-30 18:58:59 +00006135 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Stephen Hines176edba2014-12-01 14:53:08 -08006136 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006137
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006138 CharUnits Align = CGF.getPointerAlign();
6139
Fariborz Jahanian8cfd3972009-01-30 18:58:59 +00006140 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
6141 if (PTGV)
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006142 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian8cfd3972009-01-30 18:58:59 +00006143 PTGV = new llvm::GlobalVariable(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006144 CGM.getModule(),
6145 Init->getType(), false,
6146 llvm::GlobalValue::WeakAnyLinkage,
6147 Init,
6148 ProtocolName);
Fariborz Jahanian8cfd3972009-01-30 18:58:59 +00006149 PTGV->setSection("__DATA, __objc_protorefs, coalesced, no_dead_strip");
6150 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006151 PTGV->setAlignment(Align.getQuantity());
Stephen Hines651f13c2014-04-23 16:59:28 -07006152 CGM.addCompilerUsedGlobal(PTGV);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006153 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian8cfd3972009-01-30 18:58:59 +00006154}
6155
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006156/// GenerateCategory - Build metadata for a category implementation.
6157/// struct _category_t {
6158/// const char * const name;
6159/// struct _class_t *const cls;
6160/// const struct _method_list_t * const instance_methods;
6161/// const struct _method_list_t * const class_methods;
6162/// const struct _protocol_list_t * const protocols;
6163/// const struct _prop_list_t * const properties;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006164/// const struct _prop_list_t * const class_properties;
6165/// const uint32_t size;
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006166/// }
6167///
Daniel Dunbar74d4b122009-05-15 22:33:15 +00006168void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006169 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanianf6317dd2009-01-26 22:58:07 +00006170 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Stephen Hines176edba2014-12-01 14:53:08 -08006171
6172 llvm::SmallString<64> ExtCatName(Prefix);
6173 ExtCatName += Interface->getObjCRuntimeNameAsString();
6174 ExtCatName += "_$_";
6175 ExtCatName += OCD->getNameAsString();
6176
6177 llvm::SmallString<64> ExtClassName(getClassSymbolPrefix());
6178 ExtClassName += Interface->getObjCRuntimeNameAsString();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006179
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006180 llvm::Constant *Values[8];
Stephen Hines176edba2014-12-01 14:53:08 -08006181 Values[0] = GetClassName(OCD->getIdentifier()->getName());
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006182 // meta-class entry symbol
Stephen Hines651f13c2014-04-23 16:59:28 -07006183 llvm::GlobalVariable *ClassGV =
Stephen Hines176edba2014-12-01 14:53:08 -08006184 GetClassGlobal(ExtClassName.str(), Interface->isWeakImported());
Stephen Hines651f13c2014-04-23 16:59:28 -07006185
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006186 Values[1] = ClassGV;
Fariborz Jahanianf6317dd2009-01-26 22:58:07 +00006187 std::vector<llvm::Constant*> Methods;
Stephen Hines176edba2014-12-01 14:53:08 -08006188 llvm::SmallString<64> MethodListName(Prefix);
6189
6190 MethodListName += "INSTANCE_METHODS_";
6191 MethodListName += Interface->getObjCRuntimeNameAsString();
6192 MethodListName += "_$_";
6193 MethodListName += OCD->getName();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006194
Stephen Hines651f13c2014-04-23 16:59:28 -07006195 for (const auto *I : OCD->instance_methods())
Fariborz Jahanianf6317dd2009-01-26 22:58:07 +00006196 // Instance methods should always be defined.
Stephen Hines651f13c2014-04-23 16:59:28 -07006197 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006198
Stephen Hines176edba2014-12-01 14:53:08 -08006199 Values[2] = EmitMethodList(MethodListName.str(),
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006200 "__DATA, __objc_const",
Fariborz Jahanianf6317dd2009-01-26 22:58:07 +00006201 Methods);
6202
6203 MethodListName = Prefix;
Stephen Hines176edba2014-12-01 14:53:08 -08006204 MethodListName += "CLASS_METHODS_";
6205 MethodListName += Interface->getObjCRuntimeNameAsString();
6206 MethodListName += "_$_";
6207 MethodListName += OCD->getNameAsString();
6208
Fariborz Jahanianf6317dd2009-01-26 22:58:07 +00006209 Methods.clear();
Stephen Hines651f13c2014-04-23 16:59:28 -07006210 for (const auto *I : OCD->class_methods())
Fariborz Jahanianf6317dd2009-01-26 22:58:07 +00006211 // Class methods should always be defined.
Stephen Hines651f13c2014-04-23 16:59:28 -07006212 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006213
Stephen Hines176edba2014-12-01 14:53:08 -08006214 Values[3] = EmitMethodList(MethodListName.str(),
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006215 "__DATA, __objc_const",
Fariborz Jahanianf6317dd2009-01-26 22:58:07 +00006216 Methods);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006217 const ObjCCategoryDecl *Category =
Fariborz Jahanian5de14dc2009-01-28 22:18:42 +00006218 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahanian943ed6f2009-02-13 17:52:22 +00006219 if (Category) {
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00006220 SmallString<256> ExtName;
Stephen Hines176edba2014-12-01 14:53:08 -08006221 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00006222 << OCD->getName();
Fariborz Jahanian943ed6f2009-02-13 17:52:22 +00006223 Values[4] = EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Stephen Hines176edba2014-12-01 14:53:08 -08006224 + Interface->getObjCRuntimeNameAsString() + "_$_"
6225 + Category->getName(),
6226 Category->protocol_begin(),
6227 Category->protocol_end());
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00006228 Values[5] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006229 OCD, Category, ObjCTypes, false);
6230 Values[6] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
6231 OCD, Category, ObjCTypes, true);
Mike Stumpb3589f42009-07-30 22:28:39 +00006232 } else {
Owen Andersonc9c88b42009-07-31 20:28:54 +00006233 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
6234 Values[5] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006235 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Fariborz Jahanian943ed6f2009-02-13 17:52:22 +00006236 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006237
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006238 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategorynfABITy);
6239 Values[7] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6240
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006241 llvm::Constant *Init =
6242 llvm::ConstantStruct::get(ObjCTypes.CategorynfABITy,
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006243 Values);
6244 llvm::GlobalVariable *GCATV
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006245 = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CategorynfABITy,
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006246 false,
Stephen Hines651f13c2014-04-23 16:59:28 -07006247 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006248 Init,
Stephen Hines176edba2014-12-01 14:53:08 -08006249 ExtCatName.str());
Fariborz Jahanian09796d62009-01-31 02:43:27 +00006250 GCATV->setAlignment(
Micah Villmow25a6a842012-10-08 16:25:52 +00006251 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.CategorynfABITy));
Fariborz Jahanian1bf0afb2009-01-28 01:05:23 +00006252 GCATV->setSection("__DATA, __objc_const");
Stephen Hines651f13c2014-04-23 16:59:28 -07006253 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006254 DefinedCategories.push_back(GCATV);
Daniel Dunbar74d4b122009-05-15 22:33:15 +00006255
6256 // Determine if this category is also "non-lazy".
6257 if (ImplementationIsNonLazy(OCD))
6258 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanian64089ce2011-04-22 22:02:28 +00006259 // method definition entries must be clear for next implementation.
6260 MethodDefinitions.clear();
Fariborz Jahanianeb062d92009-01-26 18:32:24 +00006261}
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006262
6263/// GetMethodConstant - Return a struct objc_method constant for the
6264/// given method if it has been defined. The result is null if the
6265/// method has not been defined. The return value has type MethodPtrTy.
6266llvm::Constant *CGObjCNonFragileABIMac::GetMethodConstant(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006267 const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis9d50c062010-08-09 10:54:20 +00006268 llvm::Function *Fn = GetMethodDefinition(MD);
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006269 if (!Fn)
Stephen Hines6bcf27b2014-05-29 04:14:42 -07006270 return nullptr;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006271
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00006272 llvm::Constant *Method[] = {
Owen Anderson3c4972d2009-07-29 18:54:39 +00006273 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00006274 ObjCTypes.SelectorPtrTy),
6275 GetMethodVarType(MD),
6276 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
6277 };
Owen Anderson08e25242009-07-27 22:29:56 +00006278 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006279}
6280
6281/// EmitMethodList - Build meta-data for method declarations
6282/// struct _method_list_t {
6283/// uint32_t entsize; // sizeof(struct _objc_method)
6284/// uint32_t method_count;
6285/// struct _objc_method method_list[method_count];
6286/// }
6287///
Bill Wendlingbb028552012-02-07 09:25:09 +00006288llvm::Constant *
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006289CGObjCNonFragileABIMac::EmitMethodList(Twine Name, StringRef Section,
6290 ArrayRef<llvm::Constant *> Methods) {
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006291 // Return null for empty list.
6292 if (Methods.empty())
Owen Andersonc9c88b42009-07-31 20:28:54 +00006293 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006294
Chris Lattnerc5cbb902011-06-20 04:01:35 +00006295 llvm::Constant *Values[3];
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006296 // sizeof(struct _objc_method)
Micah Villmow25a6a842012-10-08 16:25:52 +00006297 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
Owen Anderson4a28d5d2009-07-24 23:12:58 +00006298 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006299 // method_count
Owen Anderson4a28d5d2009-07-24 23:12:58 +00006300 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson96e0fc72009-07-29 22:16:19 +00006301 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006302 Methods.size());
Owen Anderson7db6d832009-07-28 18:33:04 +00006303 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00006304 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006305
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006306 llvm::GlobalVariable *GV =
Owen Anderson1c431b32009-07-08 19:05:04 +00006307 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Stephen Hines651f13c2014-04-23 16:59:28 -07006308 llvm::GlobalValue::PrivateLinkage, Init, Name);
Micah Villmow25a6a842012-10-08 16:25:52 +00006309 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006310 GV->setSection(Section);
Stephen Hines651f13c2014-04-23 16:59:28 -07006311 CGM.addCompilerUsedGlobal(GV);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00006312 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian493dab72009-01-26 21:38:32 +00006313}
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006314
Fariborz Jahanianed157d32009-02-10 20:21:06 +00006315/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6316/// the given ivar.
Daniel Dunbare83be122010-04-02 21:14:02 +00006317llvm::GlobalVariable *
6318CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6319 const ObjCIvarDecl *Ivar) {
Stephen Hines176edba2014-12-01 14:53:08 -08006320
Daniel Dunbare83be122010-04-02 21:14:02 +00006321 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Stephen Hines176edba2014-12-01 14:53:08 -08006322 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6323 Name += Container->getObjCRuntimeNameAsString();
6324 Name += ".";
6325 Name += Ivar->getName();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006326 llvm::GlobalVariable *IvarOffsetGV =
Fariborz Jahanianed157d32009-02-10 20:21:06 +00006327 CGM.getModule().getGlobalVariable(Name);
6328 if (!IvarOffsetGV)
Stephen Hines651f13c2014-04-23 16:59:28 -07006329 IvarOffsetGV = new llvm::GlobalVariable(
Stephen Hines176edba2014-12-01 14:53:08 -08006330 CGM.getModule(), ObjCTypes.IvarOffsetVarTy, false,
6331 llvm::GlobalValue::ExternalLinkage, nullptr, Name.str());
Fariborz Jahanianed157d32009-02-10 20:21:06 +00006332 return IvarOffsetGV;
6333}
6334
Daniel Dunbare83be122010-04-02 21:14:02 +00006335llvm::Constant *
6336CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6337 const ObjCIvarDecl *Ivar,
Eli Friedmane5b46662012-11-06 22:15:52 +00006338 unsigned long int Offset) {
Daniel Dunbar737c5022009-04-19 00:44:02 +00006339 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Stephen Hines651f13c2014-04-23 16:59:28 -07006340 IvarOffsetGV->setInitializer(
6341 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanian09796d62009-01-31 02:43:27 +00006342 IvarOffsetGV->setAlignment(
Stephen Hines651f13c2014-04-23 16:59:28 -07006343 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbar737c5022009-04-19 00:44:02 +00006344
Mike Stumpf5408fe2009-05-16 07:57:57 +00006345 // FIXME: This matches gcc, but shouldn't the visibility be set on the use as
6346 // well (i.e., in ObjCIvarOffsetVariable).
Daniel Dunbar737c5022009-04-19 00:44:02 +00006347 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6348 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
John McCall1fb0caa2010-10-22 21:05:15 +00006349 ID->getVisibility() == HiddenVisibility)
Fariborz Jahanian2fa5a272009-01-28 01:36:42 +00006350 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Daniel Dunbar04d40782009-04-14 06:00:08 +00006351 else
Fariborz Jahanian77c9fd22009-04-06 18:30:00 +00006352 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
Bill Wendling1f382512011-05-04 21:37:25 +00006353 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanian45012a72009-02-03 00:09:52 +00006354 return IvarOffsetGV;
Fariborz Jahanian1bf0afb2009-01-28 01:05:23 +00006355}
6356
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006357/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar11394522009-04-18 08:51:00 +00006358/// implementation. The return value has type
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006359/// IvarListnfABIPtrTy.
6360/// struct _ivar_t {
Stephen Hines651f13c2014-04-23 16:59:28 -07006361/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006362/// char *name;
6363/// char *type;
6364/// uint32_t alignment;
6365/// uint32_t size;
6366/// }
6367/// struct _ivar_list_t {
6368/// uint32 entsize; // sizeof(struct _ivar_t)
6369/// uint32 count;
6370/// struct _iver_t list[count];
6371/// }
6372///
Daniel Dunbar3e5f0d82009-04-20 06:54:31 +00006373
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006374llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006375 const ObjCImplementationDecl *ID) {
6376
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00006377 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006378
Jordy Rosedb8264e2011-07-22 02:08:32 +00006379 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006380 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006381
Fariborz Jahanian1bf0afb2009-01-28 01:05:23 +00006382 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006383
Jordy Rosedb8264e2011-07-22 02:08:32 +00006384 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianbf9eb882011-06-28 18:05:25 +00006385 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian8e6ac1d2009-06-04 01:19:09 +00006386 // Ignore unnamed bit-fields.
6387 if (!IVD->getDeclName())
6388 continue;
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00006389 llvm::Constant *Ivar[5];
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006390 Ivar[0] = EmitIvarOffsetVar(ID->getClassInterface(), IVD,
Daniel Dunbar9f89f2b2009-05-03 12:57:56 +00006391 ComputeIvarBaseOffset(CGM, ID, IVD));
Daniel Dunbar3fea0c02009-04-22 08:22:17 +00006392 Ivar[1] = GetMethodVarName(IVD->getIdentifier());
6393 Ivar[2] = GetMethodVarType(IVD);
Chris Lattner2acc6e32011-07-18 04:24:23 +00006394 llvm::Type *FieldTy =
Daniel Dunbar3fea0c02009-04-22 08:22:17 +00006395 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmow25a6a842012-10-08 16:25:52 +00006396 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006397 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006398 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006399 Align = llvm::Log2_32(Align);
Owen Anderson4a28d5d2009-07-24 23:12:58 +00006400 Ivar[3] = llvm::ConstantInt::get(ObjCTypes.IntTy, Align);
Daniel Dunbar91636d62009-04-20 00:33:43 +00006401 // NOTE. Size of a bitfield does not match gcc's, because of the
6402 // way bitfields are treated special in each. But I am told that
6403 // 'size' for bitfield ivars is ignored by the runtime so it does
6404 // not matter. If it matters, there is enough info to get the
6405 // bitfield right!
Owen Anderson4a28d5d2009-07-24 23:12:58 +00006406 Ivar[4] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson08e25242009-07-27 22:29:56 +00006407 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarnfABITy, Ivar));
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006408 }
6409 // Return null for empty list.
6410 if (Ivars.empty())
Owen Andersonc9c88b42009-07-31 20:28:54 +00006411 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00006412
6413 llvm::Constant *Values[3];
Micah Villmow25a6a842012-10-08 16:25:52 +00006414 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy);
Owen Anderson4a28d5d2009-07-24 23:12:58 +00006415 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6416 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson96e0fc72009-07-29 22:16:19 +00006417 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarnfABITy,
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006418 Ivars.size());
Owen Anderson7db6d832009-07-28 18:33:04 +00006419 Values[2] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnerc5cbb902011-06-20 04:01:35 +00006420 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006421 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6422 llvm::GlobalVariable *GV =
Owen Anderson1c431b32009-07-08 19:05:04 +00006423 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Stephen Hines651f13c2014-04-23 16:59:28 -07006424 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian98abf4b2009-01-27 19:38:51 +00006425 Init,
Stephen Hines176edba2014-12-01 14:53:08 -08006426 Prefix + OID->getObjCRuntimeNameAsString());
Fariborz Jahanian09796d62009-01-31 02:43:27 +00006427 GV->setAlignment(
Micah Villmow25a6a842012-10-08 16:25:52 +00006428 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian1bf0afb2009-01-28 01:05:23 +00006429 GV->setSection("__DATA, __objc_const");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006430
Stephen Hines651f13c2014-04-23 16:59:28 -07006431 CGM.addCompilerUsedGlobal(GV);
Owen Anderson3c4972d2009-07-29 18:54:39 +00006432 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanianda320092009-01-29 19:24:30 +00006433}
6434
6435llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006436 const ObjCProtocolDecl *PD) {
Fariborz Jahanianda320092009-01-29 19:24:30 +00006437 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006438
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006439 if (!Entry)
Fariborz Jahanianda320092009-01-29 19:24:30 +00006440 // We use the initializer as a marker of whether this is a forward
6441 // reference or not. At module finalization we add the empty
6442 // contents for protocols which were referenced but never defined.
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006443 Entry =
Stephen Hines651f13c2014-04-23 16:59:28 -07006444 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Stephen Hines176edba2014-12-01 14:53:08 -08006445 false, llvm::GlobalValue::ExternalLinkage,
Stephen Hines6bcf27b2014-05-29 04:14:42 -07006446 nullptr,
Stephen Hines176edba2014-12-01 14:53:08 -08006447 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006448
Fariborz Jahanianda320092009-01-29 19:24:30 +00006449 return Entry;
6450}
6451
6452/// GetOrEmitProtocol - Generate the protocol meta-data:
6453/// @code
6454/// struct _protocol_t {
6455/// id isa; // NULL
6456/// const char * const protocol_name;
6457/// const struct _protocol_list_t * protocol_list; // super protocols
6458/// const struct method_list_t * const instance_methods;
6459/// const struct method_list_t * const class_methods;
6460/// const struct method_list_t *optionalInstanceMethods;
6461/// const struct method_list_t *optionalClassMethods;
6462/// const struct _prop_list_t * properties;
6463/// const uint32_t size; // sizeof(struct _protocol_t)
6464/// const uint32_t flags; // = 0
Bob Wilsondc8dab62011-11-30 01:57:58 +00006465/// const char ** extendedMethodTypes;
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07006466/// const char *demangledName;
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006467/// const struct _prop_list_t * class_properties;
Fariborz Jahanianda320092009-01-29 19:24:30 +00006468/// }
6469/// @endcode
6470///
6471
6472llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006473 const ObjCProtocolDecl *PD) {
John McCall50651b92012-03-30 21:29:05 +00006474 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006475
Fariborz Jahanianda320092009-01-29 19:24:30 +00006476 // Early exit if a defining object has already been generated.
6477 if (Entry && Entry->hasInitializer())
6478 return Entry;
6479
Douglas Gregor1d784b22012-01-01 19:51:50 +00006480 // Use the protocol definition, if there is one.
6481 if (const ObjCProtocolDecl *Def = PD->getDefinition())
6482 PD = Def;
6483
Fariborz Jahanianda320092009-01-29 19:24:30 +00006484 // Construct method lists.
6485 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
6486 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilsondc8dab62011-11-30 01:57:58 +00006487 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Stephen Hines651f13c2014-04-23 16:59:28 -07006488 for (const auto *MD : PD->instance_methods()) {
Fariborz Jahanian3819a0b2009-01-30 00:46:37 +00006489 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregorf968d832011-05-27 01:19:52 +00006490 if (!C)
6491 return GetOrEmitProtocolRef(PD);
6492
Fariborz Jahanianda320092009-01-29 19:24:30 +00006493 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6494 OptInstanceMethods.push_back(C);
Bob Wilsondc8dab62011-11-30 01:57:58 +00006495 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanianda320092009-01-29 19:24:30 +00006496 } else {
6497 InstanceMethods.push_back(C);
Bob Wilsondc8dab62011-11-30 01:57:58 +00006498 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006499 }
Fariborz Jahanianda320092009-01-29 19:24:30 +00006500 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006501
Stephen Hines651f13c2014-04-23 16:59:28 -07006502 for (const auto *MD : PD->class_methods()) {
Fariborz Jahanian3819a0b2009-01-30 00:46:37 +00006503 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregorf968d832011-05-27 01:19:52 +00006504 if (!C)
6505 return GetOrEmitProtocolRef(PD);
6506
Fariborz Jahanianda320092009-01-29 19:24:30 +00006507 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6508 OptClassMethods.push_back(C);
Bob Wilsondc8dab62011-11-30 01:57:58 +00006509 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanianda320092009-01-29 19:24:30 +00006510 } else {
6511 ClassMethods.push_back(C);
Bob Wilsondc8dab62011-11-30 01:57:58 +00006512 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006513 }
Fariborz Jahanianda320092009-01-29 19:24:30 +00006514 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006515
Bob Wilsondc8dab62011-11-30 01:57:58 +00006516 MethodTypesExt.insert(MethodTypesExt.end(),
6517 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
6518
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006519 llvm::Constant *Values[13];
Fariborz Jahanianda320092009-01-29 19:24:30 +00006520 // isa is NULL
Owen Andersonc9c88b42009-07-31 20:28:54 +00006521 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ObjectPtrTy);
Stephen Hines176edba2014-12-01 14:53:08 -08006522 Values[1] = GetClassName(PD->getObjCRuntimeNameAsString());
6523 Values[2] = EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_" + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00006524 PD->protocol_begin(),
6525 PD->protocol_end());
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006526
Fariborz Jahanian3819a0b2009-01-30 00:46:37 +00006527 Values[3] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_"
Stephen Hines176edba2014-12-01 14:53:08 -08006528 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanianda320092009-01-29 19:24:30 +00006529 "__DATA, __objc_const",
6530 InstanceMethods);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006531 Values[4] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_"
Stephen Hines176edba2014-12-01 14:53:08 -08006532 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanianda320092009-01-29 19:24:30 +00006533 "__DATA, __objc_const",
6534 ClassMethods);
Fariborz Jahanian3819a0b2009-01-30 00:46:37 +00006535 Values[5] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_"
Stephen Hines176edba2014-12-01 14:53:08 -08006536 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanianda320092009-01-29 19:24:30 +00006537 "__DATA, __objc_const",
6538 OptInstanceMethods);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006539 Values[6] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_"
Stephen Hines176edba2014-12-01 14:53:08 -08006540 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanianda320092009-01-29 19:24:30 +00006541 "__DATA, __objc_const",
6542 OptClassMethods);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006543 Values[7] = EmitPropertyList(
6544 "\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6545 nullptr, PD, ObjCTypes, false);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006546 uint32_t Size =
Micah Villmow25a6a842012-10-08 16:25:52 +00006547 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
Owen Anderson4a28d5d2009-07-24 23:12:58 +00006548 Values[8] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Andersonc9c88b42009-07-31 20:28:54 +00006549 Values[9] = llvm::Constant::getNullValue(ObjCTypes.IntTy);
Bob Wilsondc8dab62011-11-30 01:57:58 +00006550 Values[10] = EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Stephen Hines176edba2014-12-01 14:53:08 -08006551 + PD->getObjCRuntimeNameAsString(),
Bob Wilsondc8dab62011-11-30 01:57:58 +00006552 MethodTypesExt, ObjCTypes);
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07006553 // const char *demangledName;
6554 Values[11] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006555
6556 Values[12] = EmitPropertyList(
6557 "\01l_OBJC_$_CLASS_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6558 nullptr, PD, ObjCTypes, true);
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07006559
Owen Anderson08e25242009-07-27 22:29:56 +00006560 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolnfABITy,
Fariborz Jahanianda320092009-01-29 19:24:30 +00006561 Values);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006562
Fariborz Jahanianda320092009-01-29 19:24:30 +00006563 if (Entry) {
Stephen Hines176edba2014-12-01 14:53:08 -08006564 // Already created, fix the linkage and update the initializer.
6565 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
Fariborz Jahanianda320092009-01-29 19:24:30 +00006566 Entry->setInitializer(Init);
6567 } else {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006568 Entry =
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00006569 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
6570 false, llvm::GlobalValue::WeakAnyLinkage, Init,
Stephen Hines176edba2014-12-01 14:53:08 -08006571 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanian09796d62009-01-31 02:43:27 +00006572 Entry->setAlignment(
Micah Villmow25a6a842012-10-08 16:25:52 +00006573 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABITy));
John McCall50651b92012-03-30 21:29:05 +00006574
6575 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanianda320092009-01-29 19:24:30 +00006576 }
Fariborz Jahanian8448c2c2009-01-29 20:10:59 +00006577 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Stephen Hines651f13c2014-04-23 16:59:28 -07006578 CGM.addCompilerUsedGlobal(Entry);
Chris Lattnerad64e022009-07-17 23:57:13 +00006579
Fariborz Jahanian8448c2c2009-01-29 20:10:59 +00006580 // Use this protocol meta-data to build protocol list table in section
6581 // __DATA, __objc_protolist
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00006582 llvm::GlobalVariable *PTGV =
6583 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
6584 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Stephen Hines176edba2014-12-01 14:53:08 -08006585 "\01l_OBJC_LABEL_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanian09796d62009-01-31 02:43:27 +00006586 PTGV->setAlignment(
Micah Villmow25a6a842012-10-08 16:25:52 +00006587 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Daniel Dunbar0bf21992009-04-15 02:56:18 +00006588 PTGV->setSection("__DATA, __objc_protolist, coalesced, no_dead_strip");
Fariborz Jahanian8448c2c2009-01-29 20:10:59 +00006589 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Stephen Hines651f13c2014-04-23 16:59:28 -07006590 CGM.addCompilerUsedGlobal(PTGV);
Fariborz Jahanianda320092009-01-29 19:24:30 +00006591 return Entry;
6592}
6593
6594/// EmitProtocolList - Generate protocol list meta-data:
6595/// @code
6596/// struct _protocol_list_t {
6597/// long protocol_count; // Note, this is 32/64 bit
6598/// struct _protocol_t[protocol_count];
6599/// }
6600/// @endcode
6601///
6602llvm::Constant *
Chris Lattner5f9e2722011-07-23 10:55:15 +00006603CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00006604 ObjCProtocolDecl::protocol_iterator begin,
6605 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +00006606 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006607
Fariborz Jahanianda320092009-01-29 19:24:30 +00006608 // Just return null for empty protocol lists
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006609 if (begin == end)
Owen Andersonc9c88b42009-07-31 20:28:54 +00006610 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006611
Daniel Dunbar948e2582009-02-15 07:36:20 +00006612 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00006613 SmallString<256> TmpName;
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00006614 Name.toVector(TmpName);
6615 llvm::GlobalVariable *GV =
6616 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanianda320092009-01-29 19:24:30 +00006617 if (GV)
Daniel Dunbar9c29bf52009-10-18 20:48:59 +00006618 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006619
Daniel Dunbar948e2582009-02-15 07:36:20 +00006620 for (; begin != end; ++begin)
6621 ProtocolRefs.push_back(GetProtocolRef(*begin)); // Implemented???
6622
Fariborz Jahanianda320092009-01-29 19:24:30 +00006623 // This list is null terminated.
Owen Andersonc9c88b42009-07-31 20:28:54 +00006624 ProtocolRefs.push_back(llvm::Constant::getNullValue(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006625 ObjCTypes.ProtocolnfABIPtrTy));
6626
Chris Lattnerc5cbb902011-06-20 04:01:35 +00006627 llvm::Constant *Values[2];
Owen Andersona1cf15f2009-07-14 23:10:40 +00006628 Values[0] =
Owen Anderson4a28d5d2009-07-24 23:12:58 +00006629 llvm::ConstantInt::get(ObjCTypes.LongTy, ProtocolRefs.size() - 1);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006630 Values[1] =
Bill Wendling3964e622012-02-09 22:16:49 +00006631 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolnfABIPtrTy,
6632 ProtocolRefs.size()),
6633 ProtocolRefs);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006634
Chris Lattnerc5cbb902011-06-20 04:01:35 +00006635 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Owen Anderson1c431b32009-07-08 19:05:04 +00006636 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Stephen Hines651f13c2014-04-23 16:59:28 -07006637 llvm::GlobalValue::PrivateLinkage,
Chris Lattnerc5cbb902011-06-20 04:01:35 +00006638 Init, Name);
Fariborz Jahanianda320092009-01-29 19:24:30 +00006639 GV->setSection("__DATA, __objc_const");
Fariborz Jahanian09796d62009-01-31 02:43:27 +00006640 GV->setAlignment(
Micah Villmow25a6a842012-10-08 16:25:52 +00006641 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Stephen Hines651f13c2014-04-23 16:59:28 -07006642 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006643 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar948e2582009-02-15 07:36:20 +00006644 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanianda320092009-01-29 19:24:30 +00006645}
6646
Fariborz Jahanian3819a0b2009-01-30 00:46:37 +00006647/// GetMethodDescriptionConstant - This routine build following meta-data:
6648/// struct _objc_method {
6649/// SEL _cmd;
6650/// char *method_type;
6651/// char *_imp;
6652/// }
6653
6654llvm::Constant *
6655CGObjCNonFragileABIMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00006656 llvm::Constant *Desc[3];
Owen Andersona1cf15f2009-07-14 23:10:40 +00006657 Desc[0] =
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006658 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
6659 ObjCTypes.SelectorPtrTy);
Fariborz Jahanian3819a0b2009-01-30 00:46:37 +00006660 Desc[1] = GetMethodVarType(MD);
Douglas Gregorf968d832011-05-27 01:19:52 +00006661 if (!Desc[1])
Stephen Hines6bcf27b2014-05-29 04:14:42 -07006662 return nullptr;
6663
Fariborz Jahanian8cfd3972009-01-30 18:58:59 +00006664 // Protocol methods have no implementation. So, this entry is always NULL.
Owen Andersonc9c88b42009-07-31 20:28:54 +00006665 Desc[2] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Anderson08e25242009-07-27 22:29:56 +00006666 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Desc);
Fariborz Jahanian3819a0b2009-01-30 00:46:37 +00006667}
Fariborz Jahanian45012a72009-02-03 00:09:52 +00006668
6669/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6670/// This code gen. amounts to generating code for:
6671/// @code
6672/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6673/// @encode
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006674///
Fariborz Jahanian598d3f62009-02-03 19:03:09 +00006675LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall506b57e2010-05-17 21:00:27 +00006676 CodeGen::CodeGenFunction &CGF,
6677 QualType ObjectTy,
6678 llvm::Value *BaseValue,
6679 const ObjCIvarDecl *Ivar,
6680 unsigned CVRQualifiers) {
6681 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancd285d02012-02-20 22:42:22 +00006682 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar97776872009-04-22 07:32:20 +00006683 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancd285d02012-02-20 22:42:22 +00006684 Offset);
Fariborz Jahanian45012a72009-02-03 00:09:52 +00006685}
6686
Fariborz Jahanianf63aa3f2009-02-10 19:02:04 +00006687llvm::Value *CGObjCNonFragileABIMac::EmitIvarOffset(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006688 CodeGen::CodeGenFunction &CGF,
6689 const ObjCInterfaceDecl *Interface,
6690 const ObjCIvarDecl *Ivar) {
Stephen Hines651f13c2014-04-23 16:59:28 -07006691 llvm::Value *IvarOffsetValue = ObjCIvarOffsetVariable(Interface, Ivar);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006692 IvarOffsetValue = CGF.Builder.CreateAlignedLoad(IvarOffsetValue,
6693 CGF.getSizeAlign(), "ivar");
Stephen Hines651f13c2014-04-23 16:59:28 -07006694 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
6695 cast<llvm::LoadInst>(IvarOffsetValue)
6696 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
Stephen Hines176edba2014-12-01 14:53:08 -08006697 llvm::MDNode::get(VMContext, None));
Stephen Hines651f13c2014-04-23 16:59:28 -07006698
6699 // This could be 32bit int or 64bit integer depending on the architecture.
6700 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
6701 // as this is what caller always expectes.
6702 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
6703 IvarOffsetValue = CGF.Builder.CreateIntCast(
6704 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
6705 return IvarOffsetValue;
Fariborz Jahanianf63aa3f2009-02-10 19:02:04 +00006706}
6707
John McCallb1e81442011-05-13 23:16:18 +00006708static void appendSelectorForMessageRefTable(std::string &buffer,
6709 Selector selector) {
6710 if (selector.isUnarySelector()) {
6711 buffer += selector.getNameForSlot(0);
6712 return;
6713 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006714
John McCallb1e81442011-05-13 23:16:18 +00006715 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
6716 buffer += selector.getNameForSlot(i);
6717 buffer += '_';
6718 }
6719}
6720
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006721/// Emit a "vtable" message send. We emit a weak hidden-visibility
John McCall944c8432011-05-14 03:10:52 +00006722/// struct, initially containing the selector pointer and a pointer to
6723/// a "fixup" variant of the appropriate objc_msgSend. To call, we
6724/// load and call the function pointer, passing the address of the
6725/// struct as the second parameter. The runtime determines whether
6726/// the selector is currently emitted using vtable dispatch; if so, it
6727/// substitutes a stub function which simply tail-calls through the
6728/// appropriate vtable slot, and if not, it substitues a stub function
6729/// which tail-calls objc_msgSend. Both stubs adjust the selector
6730/// argument to correctly point to the selector.
6731RValue
6732CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
6733 ReturnValueSlot returnSlot,
6734 QualType resultType,
6735 Selector selector,
6736 llvm::Value *arg0,
6737 QualType arg0Type,
6738 bool isSuper,
6739 const CallArgList &formalArgs,
6740 const ObjCMethodDecl *method) {
John McCallb1e81442011-05-13 23:16:18 +00006741 // Compute the actual arguments.
6742 CallArgList args;
6743
John McCall944c8432011-05-14 03:10:52 +00006744 // First argument: the receiver / super-call structure.
John McCallb1e81442011-05-13 23:16:18 +00006745 if (!isSuper)
John McCall944c8432011-05-14 03:10:52 +00006746 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
6747 args.add(RValue::get(arg0), arg0Type);
John McCallb1e81442011-05-13 23:16:18 +00006748
John McCall944c8432011-05-14 03:10:52 +00006749 // Second argument: a pointer to the message ref structure. Leave
6750 // the actual argument value blank for now.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07006751 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCallb1e81442011-05-13 23:16:18 +00006752
6753 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
6754
John McCallde5d3c72012-02-17 03:33:10 +00006755 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCallb1e81442011-05-13 23:16:18 +00006756
John McCallcba681a2011-05-14 21:12:11 +00006757 NullReturnState nullReturn;
6758
John McCall944c8432011-05-14 03:10:52 +00006759 // Find the function to call and the mangled name for the message
6760 // ref structure. Using a different mangled name wouldn't actually
6761 // be a problem; it would just be a waste.
6762 //
6763 // The runtime currently never uses vtable dispatch for anything
6764 // except normal, non-super message-sends.
6765 // FIXME: don't use this for that.
Stephen Hines6bcf27b2014-05-29 04:14:42 -07006766 llvm::Constant *fn = nullptr;
John McCallb1e81442011-05-13 23:16:18 +00006767 std::string messageRefName("\01l_");
Stephen Hines651f13c2014-04-23 16:59:28 -07006768 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCallb1e81442011-05-13 23:16:18 +00006769 if (isSuper) {
6770 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
6771 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner9b7d6702010-08-18 16:09:06 +00006772 } else {
John McCallcba681a2011-05-14 21:12:11 +00006773 nullReturn.init(CGF, arg0);
John McCallb1e81442011-05-13 23:16:18 +00006774 fn = ObjCTypes.getMessageSendStretFixupFn();
6775 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner9b7d6702010-08-18 16:09:06 +00006776 }
John McCallb1e81442011-05-13 23:16:18 +00006777 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
6778 fn = ObjCTypes.getMessageSendFpretFixupFn();
6779 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stumpb3589f42009-07-30 22:28:39 +00006780 } else {
John McCallb1e81442011-05-13 23:16:18 +00006781 if (isSuper) {
6782 fn = ObjCTypes.getMessageSendSuper2FixupFn();
6783 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner9b7d6702010-08-18 16:09:06 +00006784 } else {
John McCallb1e81442011-05-13 23:16:18 +00006785 fn = ObjCTypes.getMessageSendFixupFn();
6786 messageRefName += "objc_msgSend_fixup";
Chris Lattner9b7d6702010-08-18 16:09:06 +00006787 }
Fariborz Jahanian83a8a752009-02-04 20:42:28 +00006788 }
John McCallb1e81442011-05-13 23:16:18 +00006789 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
6790 messageRefName += '_';
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006791
John McCallb1e81442011-05-13 23:16:18 +00006792 // Append the selector name, except use underscores anywhere we
6793 // would have used colons.
6794 appendSelectorForMessageRefTable(messageRefName, selector);
6795
6796 llvm::GlobalVariable *messageRef
6797 = CGM.getModule().getGlobalVariable(messageRefName);
6798 if (!messageRef) {
John McCall944c8432011-05-14 03:10:52 +00006799 // Build the message ref structure.
John McCallb1e81442011-05-13 23:16:18 +00006800 llvm::Constant *values[] = { fn, GetMethodVarName(selector) };
Chris Lattnerc5cbb902011-06-20 04:01:35 +00006801 llvm::Constant *init = llvm::ConstantStruct::getAnon(values);
John McCallb1e81442011-05-13 23:16:18 +00006802 messageRef = new llvm::GlobalVariable(CGM.getModule(),
6803 init->getType(),
6804 /*constant*/ false,
6805 llvm::GlobalValue::WeakAnyLinkage,
6806 init,
6807 messageRefName);
6808 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
6809 messageRef->setAlignment(16);
6810 messageRef->setSection("__DATA, __objc_msgrefs, coalesced");
6811 }
Fariborz Jahanian3c52d362012-01-30 23:39:30 +00006812
6813 bool requiresnullCheck = false;
David Blaikie4e4d0842012-03-11 07:00:24 +00006814 if (CGM.getLangOpts().ObjCAutoRefCount && method)
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006815 for (const auto *ParamDecl : method->parameters()) {
Fariborz Jahanian3c52d362012-01-30 23:39:30 +00006816 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
6817 if (!nullReturn.NullBB)
6818 nullReturn.init(CGF, arg0);
6819 requiresnullCheck = true;
6820 break;
6821 }
6822 }
6823
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006824 Address mref =
6825 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
6826 CGF.getPointerAlign());
John McCallb1e81442011-05-13 23:16:18 +00006827
John McCall944c8432011-05-14 03:10:52 +00006828 // Update the message ref argument.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006829 args[1].RV = RValue::get(mref.getPointer());
John McCallb1e81442011-05-13 23:16:18 +00006830
6831 // Load the function to call from the message ref table.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006832 Address calleeAddr =
6833 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
6834 llvm::Value *callee = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCallb1e81442011-05-13 23:16:18 +00006835
John McCallde5d3c72012-02-17 03:33:10 +00006836 callee = CGF.Builder.CreateBitCast(callee, MSI.MessengerType);
John McCallb1e81442011-05-13 23:16:18 +00006837
John McCallde5d3c72012-02-17 03:33:10 +00006838 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Stephen Hines6bcf27b2014-05-29 04:14:42 -07006839 return nullReturn.complete(CGF, result, resultType, formalArgs,
6840 requiresnullCheck ? method : nullptr);
Fariborz Jahanian46551122009-02-04 00:22:57 +00006841}
6842
6843/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbard6c93d72009-09-17 04:01:22 +00006844CodeGen::RValue
6845CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCallef072fd2010-05-22 01:48:05 +00006846 ReturnValueSlot Return,
Daniel Dunbard6c93d72009-09-17 04:01:22 +00006847 QualType ResultType,
6848 Selector Sel,
6849 llvm::Value *Receiver,
Daniel Dunbard6c93d72009-09-17 04:01:22 +00006850 const CallArgList &CallArgs,
David Chisnallc6cd5fd2010-04-28 19:33:36 +00006851 const ObjCInterfaceDecl *Class,
Daniel Dunbard6c93d72009-09-17 04:01:22 +00006852 const ObjCMethodDecl *Method) {
John McCall944c8432011-05-14 03:10:52 +00006853 return isVTableDispatchedSelector(Sel)
6854 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006855 Receiver, CGF.getContext().getObjCIdType(),
John McCall944c8432011-05-14 03:10:52 +00006856 false, CallArgs, Method)
6857 : EmitMessageSend(CGF, Return, ResultType,
John McCallbd7370a2013-02-28 19:01:20 +00006858 EmitSelector(CGF, Sel),
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006859 Receiver, CGF.getContext().getObjCIdType(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006860 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian46551122009-02-04 00:22:57 +00006861}
6862
Daniel Dunbar5a7379a2009-03-01 04:40:10 +00006863llvm::GlobalVariable *
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006864CGObjCNonFragileABIMac::GetClassGlobal(StringRef Name, bool Weak) {
Stephen Hines651f13c2014-04-23 16:59:28 -07006865 llvm::GlobalValue::LinkageTypes L =
6866 Weak ? llvm::GlobalValue::ExternalWeakLinkage
6867 : llvm::GlobalValue::ExternalLinkage;
6868
Daniel Dunbar5a7379a2009-03-01 04:40:10 +00006869 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
6870
Stephen Hines651f13c2014-04-23 16:59:28 -07006871 if (!GV)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006872 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABITy,
Stephen Hines6bcf27b2014-05-29 04:14:42 -07006873 false, L, nullptr, Name);
Daniel Dunbar5a7379a2009-03-01 04:40:10 +00006874
Stephen Hines651f13c2014-04-23 16:59:28 -07006875 assert(GV->getLinkage() == L);
Daniel Dunbar5a7379a2009-03-01 04:40:10 +00006876 return GV;
6877}
6878
John McCallbd7370a2013-02-28 19:01:20 +00006879llvm::Value *CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
Stephen Hines651f13c2014-04-23 16:59:28 -07006880 IdentifierInfo *II,
Stephen Hines176edba2014-12-01 14:53:08 -08006881 bool Weak,
6882 const ObjCInterfaceDecl *ID) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006883 CharUnits Align = CGF.getPointerAlign();
John McCallf85e1932011-06-15 23:02:42 +00006884 llvm::GlobalVariable *&Entry = ClassReferences[II];
6885
Fariborz Jahanian0e81f4b2009-02-05 20:41:40 +00006886 if (!Entry) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006887 StringRef Name = ID ? ID->getObjCRuntimeNameAsString() : II->getName();
6888 std::string ClassName = (getClassSymbolPrefix() + Name).str();
Stephen Hines651f13c2014-04-23 16:59:28 -07006889 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName, Weak);
Stephen Hines176edba2014-12-01 14:53:08 -08006890 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6891 false, llvm::GlobalValue::PrivateLinkage,
6892 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006893 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar11394522009-04-18 08:51:00 +00006894 Entry->setSection("__DATA, __objc_classrefs, regular, no_dead_strip");
Stephen Hines651f13c2014-04-23 16:59:28 -07006895 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar11394522009-04-18 08:51:00 +00006896 }
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006897 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar11394522009-04-18 08:51:00 +00006898}
Fariborz Jahanian0e81f4b2009-02-05 20:41:40 +00006899
John McCallbd7370a2013-02-28 19:01:20 +00006900llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCallf85e1932011-06-15 23:02:42 +00006901 const ObjCInterfaceDecl *ID) {
Pirama Arumuga Nainar4967a712016-09-19 22:19:55 -07006902 // If the class has the objc_runtime_visible attribute, we need to
6903 // use the Objective-C runtime to get the class.
6904 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
6905 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
6906
Stephen Hines176edba2014-12-01 14:53:08 -08006907 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID->isWeakImported(), ID);
John McCallf85e1932011-06-15 23:02:42 +00006908}
6909
6910llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCallbd7370a2013-02-28 19:01:20 +00006911 CodeGenFunction &CGF) {
John McCallf85e1932011-06-15 23:02:42 +00006912 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006913 return EmitClassRefFromId(CGF, II, false, nullptr);
John McCallf85e1932011-06-15 23:02:42 +00006914}
6915
Daniel Dunbar11394522009-04-18 08:51:00 +00006916llvm::Value *
John McCallbd7370a2013-02-28 19:01:20 +00006917CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar11394522009-04-18 08:51:00 +00006918 const ObjCInterfaceDecl *ID) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006919 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar11394522009-04-18 08:51:00 +00006920 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006921
Daniel Dunbar11394522009-04-18 08:51:00 +00006922 if (!Entry) {
Stephen Hines176edba2014-12-01 14:53:08 -08006923 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6924 ClassName += ID->getObjCRuntimeNameAsString();
6925 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(),
Stephen Hines651f13c2014-04-23 16:59:28 -07006926 ID->isWeakImported());
Stephen Hines176edba2014-12-01 14:53:08 -08006927 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6928 false, llvm::GlobalValue::PrivateLinkage,
6929 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006930 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar11394522009-04-18 08:51:00 +00006931 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Stephen Hines651f13c2014-04-23 16:59:28 -07006932 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian0e81f4b2009-02-05 20:41:40 +00006933 }
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006934 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian0e81f4b2009-02-05 20:41:40 +00006935}
6936
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00006937/// EmitMetaClassRef - Return a Value * of the address of _class_t
6938/// meta-data
6939///
John McCallbd7370a2013-02-28 19:01:20 +00006940llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Stephen Hinesc568f1e2014-07-21 00:47:37 -07006941 const ObjCInterfaceDecl *ID,
6942 bool Weak) {
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006943 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00006944 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Stephen Hines651f13c2014-04-23 16:59:28 -07006945 if (!Entry) {
Stephen Hines176edba2014-12-01 14:53:08 -08006946 llvm::SmallString<64> MetaClassName(getMetaclassSymbolPrefix());
6947 MetaClassName += ID->getObjCRuntimeNameAsString();
Stephen Hinesc568f1e2014-07-21 00:47:37 -07006948 llvm::GlobalVariable *MetaClassGV =
Stephen Hines176edba2014-12-01 14:53:08 -08006949 GetClassGlobal(MetaClassName.str(), Weak);
6950
Stephen Hines651f13c2014-04-23 16:59:28 -07006951 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6952 false, llvm::GlobalValue::PrivateLinkage,
Stephen Hines176edba2014-12-01 14:53:08 -08006953 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006954 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006955
Stephen Hines651f13c2014-04-23 16:59:28 -07006956 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
6957 CGM.addCompilerUsedGlobal(Entry);
6958 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006959
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006960 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00006961}
6962
Fariborz Jahanian0e81f4b2009-02-05 20:41:40 +00006963/// GetClass - Return a reference to the class for the given interface
6964/// decl.
John McCallbd7370a2013-02-28 19:01:20 +00006965llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian0e81f4b2009-02-05 20:41:40 +00006966 const ObjCInterfaceDecl *ID) {
Douglas Gregor0a0d2b12011-03-23 00:50:03 +00006967 if (ID->isWeakImported()) {
Stephen Hines176edba2014-12-01 14:53:08 -08006968 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6969 ClassName += ID->getObjCRuntimeNameAsString();
6970 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(), true);
Stephen Hines651f13c2014-04-23 16:59:28 -07006971 (void)ClassGV;
Stephen Hines6bcf27b2014-05-29 04:14:42 -07006972 assert(ClassGV->hasExternalWeakLinkage());
Fariborz Jahanian269f8bc2009-11-17 22:42:00 +00006973 }
6974
John McCallbd7370a2013-02-28 19:01:20 +00006975 return EmitClassRef(CGF, ID);
Fariborz Jahanian0e81f4b2009-02-05 20:41:40 +00006976}
6977
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00006978/// Generates a message send where the super is the receiver. This is
6979/// a message send to self with special delivery semantics indicating
6980/// which class's method should be called.
6981CodeGen::RValue
6982CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCallef072fd2010-05-22 01:48:05 +00006983 ReturnValueSlot Return,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006984 QualType ResultType,
6985 Selector Sel,
6986 const ObjCInterfaceDecl *Class,
6987 bool isCategoryImpl,
6988 llvm::Value *Receiver,
6989 bool IsClassMessage,
Daniel Dunbard6c93d72009-09-17 04:01:22 +00006990 const CodeGen::CallArgList &CallArgs,
6991 const ObjCMethodDecl *Method) {
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00006992 // ...
6993 // Create and init a super structure; this is a (receiver, class)
6994 // pair we will pass to objc_msgSendSuper.
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08006995 Address ObjCSuper =
6996 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
6997 "objc_super");
Daniel Dunbar6bff2512009-08-03 17:06:42 +00006998
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00006999 llvm::Value *ReceiverAsObject =
7000 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07007001 CGF.Builder.CreateStore(
7002 ReceiverAsObject,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007003 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007004
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00007005 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanian7ce77922009-02-28 20:07:56 +00007006 llvm::Value *Target;
Fariborz Jahanianb9966bd2012-10-10 23:11:18 +00007007 if (IsClassMessage)
Stephen Hines176edba2014-12-01 14:53:08 -08007008 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanianb9966bd2012-10-10 23:11:18 +00007009 else
John McCallbd7370a2013-02-28 19:01:20 +00007010 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007011
Mike Stumpf5408fe2009-05-16 07:57:57 +00007012 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
7013 // ObjCTypes types.
Chris Lattner2acc6e32011-07-18 04:24:23 +00007014 llvm::Type *ClassTy =
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00007015 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
7016 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07007017 CGF.Builder.CreateStore(
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007018 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007019
John McCall944c8432011-05-14 03:10:52 +00007020 return (isVTableDispatchedSelector(Sel))
7021 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007022 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall944c8432011-05-14 03:10:52 +00007023 true, CallArgs, Method)
7024 : EmitMessageSend(CGF, Return, ResultType,
John McCallbd7370a2013-02-28 19:01:20 +00007025 EmitSelector(CGF, Sel),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007026 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
7027 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian7a06aae2009-02-06 20:09:23 +00007028}
Fariborz Jahanian26cc89f2009-02-11 20:51:17 +00007029
John McCallbd7370a2013-02-28 19:01:20 +00007030llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007031 Selector Sel) {
7032 Address Addr = EmitSelectorAddr(CGF, Sel);
7033
7034 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
7035 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
7036 llvm::MDNode::get(VMContext, None));
7037 return LI;
7038}
7039
7040Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
7041 Selector Sel) {
Fariborz Jahanian26cc89f2009-02-11 20:51:17 +00007042 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007043
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007044 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian26cc89f2009-02-11 20:51:17 +00007045 if (!Entry) {
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007046 llvm::Constant *Casted =
7047 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
7048 ObjCTypes.SelectorPtrTy);
Stephen Hines176edba2014-12-01 14:53:08 -08007049 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
7050 false, llvm::GlobalValue::PrivateLinkage,
7051 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman8f98bf92013-02-05 23:08:45 +00007052 Entry->setExternallyInitialized(true);
Fariborz Jahaniand0f8a8d2009-05-11 19:25:47 +00007053 Entry->setSection("__DATA, __objc_selrefs, literal_pointers, no_dead_strip");
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007054 Entry->setAlignment(Align.getQuantity());
Stephen Hines651f13c2014-04-23 16:59:28 -07007055 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian26cc89f2009-02-11 20:51:17 +00007056 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007057
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007058 return Address(Entry, Align);
Fariborz Jahanian26cc89f2009-02-11 20:51:17 +00007059}
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007060
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007061/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian6c7a1f32009-09-24 22:25:38 +00007062/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007063///
7064void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump1eb44332009-09-09 15:08:12 +00007065 llvm::Value *src,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007066 Address dst,
Fariborz Jahanian6c7a1f32009-09-24 22:25:38 +00007067 llvm::Value *ivarOffset) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00007068 llvm::Type * SrcTy = src->getType();
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00007069 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmow25a6a842012-10-08 16:25:52 +00007070 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00007071 assert(Size <= 8 && "does not support size > 8");
7072 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7073 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian3b8a6522009-03-13 00:42:52 +00007074 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7075 }
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007076 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7077 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007078 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCallbd7370a2013-02-28 19:01:20 +00007079 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007080}
7081
7082/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
7083/// objc_assign_strongCast (id src, id *dst)
7084///
7085void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007086 CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007087 llvm::Value *src, Address dst) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00007088 llvm::Type * SrcTy = src->getType();
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00007089 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmow25a6a842012-10-08 16:25:52 +00007090 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00007091 assert(Size <= 8 && "does not support size > 8");
7092 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007093 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian3b8a6522009-03-13 00:42:52 +00007094 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7095 }
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007096 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7097 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007098 llvm::Value *args[] = { src, dst.getPointer() };
John McCallbd7370a2013-02-28 19:01:20 +00007099 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
7100 args, "weakassign");
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007101}
7102
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00007103void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007104 CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007105 Address DestPtr,
7106 Address SrcPtr,
Fariborz Jahanian55bcace2010-06-15 22:44:06 +00007107 llvm::Value *Size) {
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00007108 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
7109 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007110 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCallbd7370a2013-02-28 19:01:20 +00007111 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian082b02e2009-07-08 01:18:33 +00007112}
7113
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007114/// EmitObjCWeakRead - Code gen for loading value of a __weak
7115/// object: objc_read_weak (id *src)
7116///
7117llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007118 CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007119 Address AddrWeakObj) {
7120 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007121 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCallbd7370a2013-02-28 19:01:20 +00007122 llvm::Value *read_weak =
7123 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007124 AddrWeakObj.getPointer(), "weakread");
Eli Friedman8339b352009-03-07 03:57:15 +00007125 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007126 return read_weak;
7127}
7128
7129/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
7130/// objc_assign_weak (id src, id *dst)
7131///
7132void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007133 llvm::Value *src, Address dst) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00007134 llvm::Type * SrcTy = src->getType();
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00007135 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmow25a6a842012-10-08 16:25:52 +00007136 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00007137 assert(Size <= 8 && "does not support size > 8");
7138 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7139 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian3b8a6522009-03-13 00:42:52 +00007140 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7141 }
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007142 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7143 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007144 llvm::Value *args[] = { src, dst.getPointer() };
John McCallbd7370a2013-02-28 19:01:20 +00007145 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
7146 args, "weakassign");
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007147}
7148
7149/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
7150/// objc_assign_global (id src, id *dst)
7151///
7152void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007153 llvm::Value *src, Address dst,
Fariborz Jahanian021a7a62010-07-20 20:30:03 +00007154 bool threadlocal) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00007155 llvm::Type * SrcTy = src->getType();
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00007156 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmow25a6a842012-10-08 16:25:52 +00007157 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanian0a855d02009-03-23 19:10:40 +00007158 assert(Size <= 8 && "does not support size > 8");
7159 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7160 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian3b8a6522009-03-13 00:42:52 +00007161 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7162 }
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007163 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7164 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007165 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian021a7a62010-07-20 20:30:03 +00007166 if (!threadlocal)
John McCallbd7370a2013-02-28 19:01:20 +00007167 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
7168 args, "globalassign");
Fariborz Jahanian021a7a62010-07-20 20:30:03 +00007169 else
John McCallbd7370a2013-02-28 19:01:20 +00007170 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
7171 args, "threadlocalassign");
Fariborz Jahanian6948aea2009-02-16 22:52:32 +00007172}
Fariborz Jahanian26cc89f2009-02-11 20:51:17 +00007173
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007174void
John McCallf1549f62010-07-06 01:34:17 +00007175CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
7176 const ObjCAtSynchronizedStmt &S) {
David Chisnall05dc91b2011-03-25 17:46:35 +00007177 EmitAtSynchronizedStmt(CGF, S,
7178 cast<llvm::Function>(ObjCTypes.getSyncEnterFn()),
7179 cast<llvm::Function>(ObjCTypes.getSyncExitFn()));
John McCallf1549f62010-07-06 01:34:17 +00007180}
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007181
John McCall5a180392010-07-24 00:37:23 +00007182llvm::Constant *
Fariborz Jahaniancf5abc72011-06-23 19:00:08 +00007183CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall5a180392010-07-24 00:37:23 +00007184 // There's a particular fixed type info for 'id'.
7185 if (T->isObjCIdType() ||
7186 T->isObjCQualifiedIdType()) {
7187 llvm::Constant *IDEHType =
7188 CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
7189 if (!IDEHType)
7190 IDEHType =
7191 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7192 false,
7193 llvm::GlobalValue::ExternalLinkage,
Stephen Hines6bcf27b2014-05-29 04:14:42 -07007194 nullptr, "OBJC_EHTYPE_id");
John McCall5a180392010-07-24 00:37:23 +00007195 return IDEHType;
7196 }
7197
7198 // All other types should be Objective-C interface pointer types.
7199 const ObjCObjectPointerType *PT =
7200 T->getAs<ObjCObjectPointerType>();
7201 assert(PT && "Invalid @catch type.");
7202 const ObjCInterfaceType *IT = PT->getInterfaceType();
7203 assert(IT && "Invalid @catch type.");
7204 return GetInterfaceEHType(IT->getDecl(), false);
7205}
7206
John McCallf1549f62010-07-06 01:34:17 +00007207void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7208 const ObjCAtTryStmt &S) {
David Chisnall05dc91b2011-03-25 17:46:35 +00007209 EmitTryCatchStmt(CGF, S,
7210 cast<llvm::Function>(ObjCTypes.getObjCBeginCatchFn()),
7211 cast<llvm::Function>(ObjCTypes.getObjCEndCatchFn()),
7212 cast<llvm::Function>(ObjCTypes.getExceptionRethrowFn()));
Daniel Dunbar8ecbaf22009-02-24 07:47:38 +00007213}
7214
Anders Carlssonf57c5b22009-02-16 22:59:18 +00007215/// EmitThrowStmt - Generate code for a throw statement.
7216void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian6a3c70e2013-01-10 19:02:56 +00007217 const ObjCAtThrowStmt &S,
7218 bool ClearInsertionPoint) {
Anders Carlssonf57c5b22009-02-16 22:59:18 +00007219 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall2b014d62011-10-01 10:32:24 +00007220 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer578faa82011-09-27 21:06:10 +00007221 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
John McCallbd7370a2013-02-28 19:01:20 +00007222 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception)
John McCall7ec404c2010-10-16 08:21:07 +00007223 .setDoesNotReturn();
Anders Carlssonf57c5b22009-02-16 22:59:18 +00007224 } else {
John McCallbd7370a2013-02-28 19:01:20 +00007225 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn())
John McCall7ec404c2010-10-16 08:21:07 +00007226 .setDoesNotReturn();
Anders Carlssonf57c5b22009-02-16 22:59:18 +00007227 }
7228
John McCall7ec404c2010-10-16 08:21:07 +00007229 CGF.Builder.CreateUnreachable();
Fariborz Jahanian6a3c70e2013-01-10 19:02:56 +00007230 if (ClearInsertionPoint)
7231 CGF.Builder.ClearInsertionPoint();
Anders Carlssonf57c5b22009-02-16 22:59:18 +00007232}
Daniel Dunbare588b992009-03-01 04:46:24 +00007233
John McCall5a180392010-07-24 00:37:23 +00007234llvm::Constant *
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007235CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007236 bool ForDefinition) {
Daniel Dunbare588b992009-03-01 04:46:24 +00007237 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Daniel Dunbare588b992009-03-01 04:46:24 +00007238
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007239 // If we don't need a definition, return the entry if found or check
7240 // if we use an external reference.
7241 if (!ForDefinition) {
7242 if (Entry)
7243 return Entry;
Daniel Dunbar7e075cb2009-04-07 06:43:45 +00007244
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007245 // If this type (or a super class) has the __objc_exception__
7246 // attribute, emit an external reference.
Douglas Gregor68584ed2009-06-18 16:11:24 +00007247 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007248 return Entry =
Stephen Hines176edba2014-12-01 14:53:08 -08007249 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7250 llvm::GlobalValue::ExternalLinkage,
7251 nullptr,
7252 ("OBJC_EHTYPE_$_" +
7253 ID->getObjCRuntimeNameAsString()));
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007254 }
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007255
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007256 // Otherwise we need to either make a new entry or fill in the
7257 // initializer.
7258 assert((!Entry || !Entry->hasInitializer()) && "Duplicate EHType definition");
Stephen Hines176edba2014-12-01 14:53:08 -08007259 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
7260 ClassName += ID->getObjCRuntimeNameAsString();
Daniel Dunbare588b992009-03-01 04:46:24 +00007261 std::string VTableName = "objc_ehtype_vtable";
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007262 llvm::GlobalVariable *VTableGV =
Daniel Dunbare588b992009-03-01 04:46:24 +00007263 CGM.getModule().getGlobalVariable(VTableName);
7264 if (!VTableGV)
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007265 VTableGV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.Int8PtrTy,
7266 false,
Daniel Dunbare588b992009-03-01 04:46:24 +00007267 llvm::GlobalValue::ExternalLinkage,
Stephen Hines6bcf27b2014-05-29 04:14:42 -07007268 nullptr, VTableName);
Daniel Dunbare588b992009-03-01 04:46:24 +00007269
Chris Lattner8b418682012-02-07 00:39:47 +00007270 llvm::Value *VTableIdx = llvm::ConstantInt::get(CGM.Int32Ty, 2);
Daniel Dunbare588b992009-03-01 04:46:24 +00007271
Benjamin Kramer1d236ab2011-10-15 12:20:02 +00007272 llvm::Constant *Values[] = {
Pirama Arumuga Nainar58878f82015-05-06 11:48:57 -07007273 llvm::ConstantExpr::getGetElementPtr(VTableGV->getValueType(), VTableGV,
7274 VTableIdx),
7275 GetClassName(ID->getObjCRuntimeNameAsString()),
7276 GetClassGlobal(ClassName.str())};
Owen Andersona1cf15f2009-07-14 23:10:40 +00007277 llvm::Constant *Init =
Owen Anderson08e25242009-07-27 22:29:56 +00007278 llvm::ConstantStruct::get(ObjCTypes.EHTypeTy, Values);
Daniel Dunbare588b992009-03-01 04:46:24 +00007279
Stephen Hines651f13c2014-04-23 16:59:28 -07007280 llvm::GlobalValue::LinkageTypes L = ForDefinition
7281 ? llvm::GlobalValue::ExternalLinkage
7282 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007283 if (Entry) {
7284 Entry->setInitializer(Init);
7285 } else {
Stephen Hines176edba2014-12-01 14:53:08 -08007286 llvm::SmallString<64> EHTYPEName("OBJC_EHTYPE_$_");
7287 EHTYPEName += ID->getObjCRuntimeNameAsString();
Owen Anderson1c431b32009-07-08 19:05:04 +00007288 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
Stephen Hines651f13c2014-04-23 16:59:28 -07007289 L,
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007290 Init,
Stephen Hines176edba2014-12-01 14:53:08 -08007291 EHTYPEName.str());
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007292 }
Stephen Hines651f13c2014-04-23 16:59:28 -07007293 assert(Entry->getLinkage() == L);
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007294
John McCall0b5a4832013-02-19 01:57:29 +00007295 if (ID->getVisibility() == HiddenVisibility)
Daniel Dunbar6ab187a2009-04-07 05:48:37 +00007296 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Micah Villmow25a6a842012-10-08 16:25:52 +00007297 Entry->setAlignment(CGM.getDataLayout().getABITypeAlignment(
Daniel Dunbar4b429ae2010-04-25 20:39:32 +00007298 ObjCTypes.EHTypeTy));
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007299
Stephen Hines651f13c2014-04-23 16:59:28 -07007300 if (ForDefinition)
Daniel Dunbar8158a2f2009-04-08 04:21:03 +00007301 Entry->setSection("__DATA,__objc_const");
Daniel Dunbare588b992009-03-01 04:46:24 +00007302
7303 return Entry;
7304}
Daniel Dunbar6bff2512009-08-03 17:06:42 +00007305
Daniel Dunbarbbce49b2008-08-12 00:12:39 +00007306/* *** */
7307
Daniel Dunbar6efc0c52008-08-13 03:21:16 +00007308CodeGen::CGObjCRuntime *
7309CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall260611a2012-06-20 06:18:46 +00007310 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7311 case ObjCRuntime::FragileMacOSX:
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00007312 return new CGObjCMac(CGM);
John McCall260611a2012-06-20 06:18:46 +00007313
7314 case ObjCRuntime::MacOSX:
7315 case ObjCRuntime::iOS:
Pirama Arumuga Nainar87d948e2016-03-03 15:49:35 -08007316 case ObjCRuntime::WatchOS:
John McCall260611a2012-06-20 06:18:46 +00007317 return new CGObjCNonFragileABIMac(CGM);
7318
David Chisnall11d3f4c2012-07-03 20:49:52 +00007319 case ObjCRuntime::GNUstep:
7320 case ObjCRuntime::GCC:
John McCallf7226fb2012-07-12 02:07:58 +00007321 case ObjCRuntime::ObjFW:
John McCall260611a2012-06-20 06:18:46 +00007322 llvm_unreachable("these runtimes are not Mac runtimes");
7323 }
7324 llvm_unreachable("bad runtime");
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00007325}