blob: 91baafa050c2924535beb1f13aabb017f0c3e342 [file] [log] [blame]
Daniel Dunbar303e2c22008-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 Lattner57540c52011-04-15 05:22:18 +000010// This provides Objective-C code generation targeting the Apple runtime.
Daniel Dunbar303e2c22008-08-11 02:45:11 +000011//
12//===----------------------------------------------------------------------===//
13
14#include "CGObjCRuntime.h"
John McCallad7c5c12011-02-08 08:22:06 +000015#include "CGBlocks.h"
John McCalled1ae862011-01-28 11:13:47 +000016#include "CGCleanup.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CGRecordLayout.h"
18#include "CodeGenFunction.h"
19#include "CodeGenModule.h"
Daniel Dunbar8b8683f2008-08-12 00:12:39 +000020#include "clang/AST/ASTContext.h"
Daniel Dunbar221fa942008-08-11 04:54:23 +000021#include "clang/AST/Decl.h"
Daniel Dunbarb036db82008-08-13 03:21:16 +000022#include "clang/AST/DeclObjC.h"
Anders Carlsson15b73de2009-07-18 19:43:29 +000023#include "clang/AST/RecordLayout.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000024#include "clang/AST/StmtObjC.h"
Daniel Dunbar3ad53482008-08-11 21:35:06 +000025#include "clang/Basic/LangOptions.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000026#include "clang/CodeGen/CGFunctionInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000027#include "clang/Frontend/CodeGenOptions.h"
Chandler Carruth3a022472012-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"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000032#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-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 Dunbard027a922009-09-07 00:20:42 +000038#include "llvm/Support/raw_ostream.h"
Torok Edwindb714922009-08-24 13:25:12 +000039#include <cstdio>
Daniel Dunbar303e2c22008-08-11 02:45:11 +000040
41using namespace clang;
Daniel Dunbar41cf9de2008-09-09 01:06:48 +000042using namespace CodeGen;
Daniel Dunbar303e2c22008-08-11 02:45:11 +000043
44namespace {
Daniel Dunbar8b8683f2008-08-12 00:12:39 +000045
Daniel Dunbar59e476b2009-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 Dunbarb036db82008-08-13 03:21:16 +000048
Fariborz Jahanian279eda62009-01-21 22:04:16 +000049class ObjCCommonTypesHelper {
Owen Anderson170229f2009-07-14 23:10:40 +000050protected:
51 llvm::LLVMContext &VMContext;
Daniel Dunbar59e476b2009-08-03 17:06:42 +000052
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000053private:
John McCall9dc0db22011-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 Jahanian5d5ed2d2009-05-11 19:25:47 +000061 llvm::Constant *getMessageSendFn() const {
John McCall31168b02011-06-15 23:02:42 +000062 // Add the non-lazy-bind attribute, since objc_msgSend is likely to
63 // be called a lot.
Chris Lattnera5f58b02011-07-09 17:41:47 +000064 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
Bill Wendling8594fcb2013-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 Jahanian5d5ed2d2009-05-11 19:25:47 +000072 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +000073
John McCall9dc0db22011-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 Jahanian5d5ed2d2009-05-11 19:25:47 +000079 llvm::Constant *getMessageSendStretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +000080 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +000081 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy,
82 params, true),
83 "objc_msgSend_stret");
Daniel Dunbar59e476b2009-08-03 17:06:42 +000084
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000085 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +000086
John McCall9dc0db22011-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 Jahanian5d5ed2d2009-05-11 19:25:47 +000092 llvm::Constant *getMessageSendFpretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +000093 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
Chris Lattnerece04092012-02-07 00:39:47 +000094 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.DoubleTy,
95 params, true),
John McCall9dc0db22011-05-15 01:53:33 +000096 "objc_msgSend_fpret");
Daniel Dunbar59e476b2009-08-03 17:06:42 +000097
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000098 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +000099
Anders Carlsson2f1a6c32011-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 =
Reid Kleckneree7cf842014-12-01 22:02:27 +0000109 llvm::StructType::get(longDoubleType, longDoubleType, nullptr);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000110
111 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(resultType,
112 params, true),
113 "objc_msgSend_fp2ret");
114 }
115
John McCall9dc0db22011-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 Jahanian5d5ed2d2009-05-11 19:25:47 +0000121 llvm::Constant *getMessageSendSuperFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000122 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000123 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000124 params, true),
125 "objc_msgSendSuper");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000126 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000127
John McCall9dc0db22011-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 Jahanian5d5ed2d2009-05-11 19:25:47 +0000132 llvm::Constant *getMessageSendSuperFn2() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000133 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000134 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000135 params, true),
136 "objc_msgSendSuper2");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000137 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000138
John McCall9dc0db22011-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 Jahanian5d5ed2d2009-05-11 19:25:47 +0000143 llvm::Constant *getMessageSendSuperStretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000144 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000145 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000146 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000147 "objc_msgSendSuper_stret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000148 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000149
John McCall9dc0db22011-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 Jahanian5d5ed2d2009-05-11 19:25:47 +0000154 llvm::Constant *getMessageSendSuperStretFn2() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000155 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000156 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000157 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000158 "objc_msgSendSuper2_stret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000159 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000160
Fariborz Jahanian5d5ed2d2009-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 Dunbar59e476b2009-08-03 17:06:42 +0000165
Fariborz Jahanian5d5ed2d2009-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 Dunbar59e476b2009-08-03 17:06:42 +0000170
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000171protected:
172 CodeGen::CodeGenModule &CGM;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000173
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000174public:
Chris Lattnera5f58b02011-07-09 17:41:47 +0000175 llvm::Type *ShortTy, *IntTy, *LongTy, *LongLongTy;
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000176 llvm::Type *Int8PtrTy, *Int8PtrPtrTy;
Tim Northover238b5082014-03-29 13:42:40 +0000177 llvm::Type *IvarOffsetVarTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000178
Daniel Dunbar5d715592008-08-12 05:28:47 +0000179 /// ObjectPtrTy - LLVM type for object handles (typeof(id))
Chris Lattnera5f58b02011-07-09 17:41:47 +0000180 llvm::Type *ObjectPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000181
Fariborz Jahanian406b1172008-11-18 20:18:11 +0000182 /// PtrObjectPtrTy - LLVM type for id *
Chris Lattnera5f58b02011-07-09 17:41:47 +0000183 llvm::Type *PtrObjectPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000184
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000185 /// SelectorPtrTy - LLVM type for selector handles (typeof(SEL))
Chris Lattnera5f58b02011-07-09 17:41:47 +0000186 llvm::Type *SelectorPtrTy;
Douglas Gregor020de322012-01-17 18:36:30 +0000187
188private:
Daniel Dunbarb036db82008-08-13 03:21:16 +0000189 /// ProtocolPtrTy - LLVM type for external protocol handles
190 /// (typeof(Protocol))
Chris Lattnera5f58b02011-07-09 17:41:47 +0000191 llvm::Type *ExternalProtocolPtrTy;
Douglas Gregor020de322012-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 Dunbarc722b852008-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 Dunbar59e476b2009-08-03 17:06:42 +0000211
Daniel Dunbarf6397fe2008-08-23 04:28:29 +0000212 /// SuperTy - LLVM type for struct objc_super.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000213 llvm::StructType *SuperTy;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +0000214 /// SuperPtrTy - LLVM type for struct objc_super *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000215 llvm::Type *SuperPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000216
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000217 /// PropertyTy - LLVM type for struct objc_property (struct _prop_t
218 /// in GCC parlance).
Chris Lattnera5f58b02011-07-09 17:41:47 +0000219 llvm::StructType *PropertyTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000220
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000221 /// PropertyListTy - LLVM type for struct objc_property_list
222 /// (_prop_list_t in GCC parlance).
Chris Lattnera5f58b02011-07-09 17:41:47 +0000223 llvm::StructType *PropertyListTy;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000224 /// PropertyListPtrTy - LLVM type for struct objc_property_list*.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000225 llvm::Type *PropertyListPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000226
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000227 // MethodTy - LLVM type for struct objc_method.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000228 llvm::StructType *MethodTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000229
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000230 /// CacheTy - LLVM type for struct objc_cache.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000231 llvm::Type *CacheTy;
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000232 /// CachePtrTy - LLVM type for struct objc_cache *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000233 llvm::Type *CachePtrTy;
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +0000234
Chris Lattnerce8754e2009-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)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000239 SmallVector<CanQualType,4> Params;
John McCall2da83a32010-02-26 00:48:12 +0000240 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
241 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Chris Lattnerce8754e2009-04-22 02:44:54 +0000242 Params.push_back(IdType);
243 Params.push_back(SelType);
David Chisnall08a45252011-03-22 20:03:13 +0000244 Params.push_back(Ctx.getPointerDiffType()->getCanonicalTypeUnqualified());
Chris Lattnerce8754e2009-04-22 02:44:54 +0000245 Params.push_back(Ctx.BoolTy);
Chris Lattner2192fe52011-07-18 04:24:23 +0000246 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000247 Types.GetFunctionType(
248 Types.arrangeBuiltinFunctionDeclaration(IdType, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000249 return CGM.CreateRuntimeFunction(FTy, "objc_getProperty");
250 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000251
Chris Lattnerce8754e2009-04-22 02:44:54 +0000252 llvm::Constant *getSetPropertyFn() {
253 CodeGen::CodeGenTypes &Types = CGM.getTypes();
254 ASTContext &Ctx = CGM.getContext();
255 // void objc_setProperty (id, SEL, ptrdiff_t, id, bool, bool)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000256 SmallVector<CanQualType,6> Params;
John McCall2da83a32010-02-26 00:48:12 +0000257 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
258 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Chris Lattnerce8754e2009-04-22 02:44:54 +0000259 Params.push_back(IdType);
260 Params.push_back(SelType);
David Chisnall08a45252011-03-22 20:03:13 +0000261 Params.push_back(Ctx.getPointerDiffType()->getCanonicalTypeUnqualified());
Chris Lattnerce8754e2009-04-22 02:44:54 +0000262 Params.push_back(IdType);
263 Params.push_back(Ctx.BoolTy);
264 Params.push_back(Ctx.BoolTy);
Chris Lattner2192fe52011-07-18 04:24:23 +0000265 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000266 Types.GetFunctionType(
267 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000268 return CGM.CreateRuntimeFunction(FTy, "objc_setProperty");
269 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000270
Ted Kremeneke65b0862012-03-06 20:05:56 +0000271 llvm::Constant *getOptimizedSetPropertyFn(bool atomic, bool copy) {
272 CodeGen::CodeGenTypes &Types = CGM.getTypes();
273 ASTContext &Ctx = CGM.getContext();
274 // void objc_setProperty_atomic(id self, SEL _cmd,
275 // id newValue, ptrdiff_t offset);
276 // void objc_setProperty_nonatomic(id self, SEL _cmd,
277 // id newValue, ptrdiff_t offset);
278 // void objc_setProperty_atomic_copy(id self, SEL _cmd,
279 // id newValue, ptrdiff_t offset);
280 // void objc_setProperty_nonatomic_copy(id self, SEL _cmd,
281 // id newValue, ptrdiff_t offset);
282
283 SmallVector<CanQualType,4> Params;
284 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
285 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
286 Params.push_back(IdType);
287 Params.push_back(SelType);
288 Params.push_back(IdType);
289 Params.push_back(Ctx.getPointerDiffType()->getCanonicalTypeUnqualified());
290 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000291 Types.GetFunctionType(
292 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Ted Kremeneke65b0862012-03-06 20:05:56 +0000293 const char *name;
294 if (atomic && copy)
295 name = "objc_setProperty_atomic_copy";
296 else if (atomic && !copy)
297 name = "objc_setProperty_atomic";
298 else if (!atomic && copy)
299 name = "objc_setProperty_nonatomic_copy";
300 else
301 name = "objc_setProperty_nonatomic";
302
303 return CGM.CreateRuntimeFunction(FTy, name);
304 }
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000305
306 llvm::Constant *getCopyStructFn() {
307 CodeGen::CodeGenTypes &Types = CGM.getTypes();
308 ASTContext &Ctx = CGM.getContext();
309 // void objc_copyStruct (void *, const void *, size_t, bool, bool)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000310 SmallVector<CanQualType,5> Params;
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000311 Params.push_back(Ctx.VoidPtrTy);
312 Params.push_back(Ctx.VoidPtrTy);
313 Params.push_back(Ctx.LongTy);
314 Params.push_back(Ctx.BoolTy);
315 Params.push_back(Ctx.BoolTy);
Chris Lattner2192fe52011-07-18 04:24:23 +0000316 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000317 Types.GetFunctionType(
318 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000319 return CGM.CreateRuntimeFunction(FTy, "objc_copyStruct");
320 }
321
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000322 /// This routine declares and returns address of:
323 /// void objc_copyCppObjectAtomic(
324 /// void *dest, const void *src,
325 /// void (*copyHelper) (void *dest, const void *source));
326 llvm::Constant *getCppAtomicObjectFunction() {
327 CodeGen::CodeGenTypes &Types = CGM.getTypes();
328 ASTContext &Ctx = CGM.getContext();
329 /// void objc_copyCppObjectAtomic(void *dest, const void *src, void *helper);
330 SmallVector<CanQualType,3> Params;
331 Params.push_back(Ctx.VoidPtrTy);
332 Params.push_back(Ctx.VoidPtrTy);
333 Params.push_back(Ctx.VoidPtrTy);
334 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000335 Types.GetFunctionType(
336 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000337 return CGM.CreateRuntimeFunction(FTy, "objc_copyCppObjectAtomic");
338 }
339
Chris Lattnerce8754e2009-04-22 02:44:54 +0000340 llvm::Constant *getEnumerationMutationFn() {
Daniel Dunbar9d82da42009-07-11 20:32:50 +0000341 CodeGen::CodeGenTypes &Types = CGM.getTypes();
342 ASTContext &Ctx = CGM.getContext();
Chris Lattnerce8754e2009-04-22 02:44:54 +0000343 // void objc_enumerationMutation (id)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000344 SmallVector<CanQualType,1> Params;
John McCall2da83a32010-02-26 00:48:12 +0000345 Params.push_back(Ctx.getCanonicalParamType(Ctx.getObjCIdType()));
Chris Lattner2192fe52011-07-18 04:24:23 +0000346 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000347 Types.GetFunctionType(
348 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000349 return CGM.CreateRuntimeFunction(FTy, "objc_enumerationMutation");
350 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000351
Douglas Gregor24ae22c2016-04-01 23:23:52 +0000352 llvm::Constant *getLookUpClassFn() {
353 CodeGen::CodeGenTypes &Types = CGM.getTypes();
354 ASTContext &Ctx = CGM.getContext();
355 // Class objc_lookUpClass (const char *)
356 SmallVector<CanQualType,1> Params;
357 Params.push_back(
358 Ctx.getCanonicalType(Ctx.getPointerType(Ctx.CharTy.withConst())));
359 llvm::FunctionType *FTy =
360 Types.GetFunctionType(Types.arrangeBuiltinFunctionDeclaration(
361 Ctx.getCanonicalType(Ctx.getObjCClassType()),
362 Params));
363 return CGM.CreateRuntimeFunction(FTy, "objc_lookUpClass");
364 }
365
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000366 /// GcReadWeakFn -- LLVM objc_read_weak (id *src) function.
Chris Lattnerce8754e2009-04-22 02:44:54 +0000367 llvm::Constant *getGcReadWeakFn() {
368 // id objc_read_weak (id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000369 llvm::Type *args[] = { ObjectPtrTy->getPointerTo() };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000370 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000371 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattnerce8754e2009-04-22 02:44:54 +0000372 return CGM.CreateRuntimeFunction(FTy, "objc_read_weak");
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000373 }
374
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000375 /// GcAssignWeakFn -- LLVM objc_assign_weak function.
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000376 llvm::Constant *getGcAssignWeakFn() {
377 // id objc_assign_weak (id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000378 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000379 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000380 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000381 return CGM.CreateRuntimeFunction(FTy, "objc_assign_weak");
382 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000383
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000384 /// GcAssignGlobalFn -- LLVM objc_assign_global function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000385 llvm::Constant *getGcAssignGlobalFn() {
386 // id objc_assign_global(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000387 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000388 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000389 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000390 return CGM.CreateRuntimeFunction(FTy, "objc_assign_global");
391 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000392
Fariborz Jahanian217af242010-07-20 20:30:03 +0000393 /// GcAssignThreadLocalFn -- LLVM objc_assign_threadlocal function.
394 llvm::Constant *getGcAssignThreadLocalFn() {
395 // id objc_assign_threadlocal(id src, id * dest)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000396 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Fariborz Jahanian217af242010-07-20 20:30:03 +0000397 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000398 llvm::FunctionType::get(ObjectPtrTy, args, false);
Fariborz Jahanian217af242010-07-20 20:30:03 +0000399 return CGM.CreateRuntimeFunction(FTy, "objc_assign_threadlocal");
400 }
401
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000402 /// GcAssignIvarFn -- LLVM objc_assign_ivar function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000403 llvm::Constant *getGcAssignIvarFn() {
Fariborz Jahanian7a95d722009-09-24 22:25:38 +0000404 // id objc_assign_ivar(id, id *, ptrdiff_t)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000405 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo(),
406 CGM.PtrDiffTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000407 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000408 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000409 return CGM.CreateRuntimeFunction(FTy, "objc_assign_ivar");
410 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000411
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000412 /// GcMemmoveCollectableFn -- LLVM objc_memmove_collectable function.
413 llvm::Constant *GcMemmoveCollectableFn() {
414 // void *objc_memmove_collectable(void *dst, const void *src, size_t size)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000415 llvm::Type *args[] = { Int8PtrTy, Int8PtrTy, LongTy };
John McCall9dc0db22011-05-15 01:53:33 +0000416 llvm::FunctionType *FTy = llvm::FunctionType::get(Int8PtrTy, args, false);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000417 return CGM.CreateRuntimeFunction(FTy, "objc_memmove_collectable");
418 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000419
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000420 /// GcAssignStrongCastFn -- LLVM objc_assign_strongCast function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000421 llvm::Constant *getGcAssignStrongCastFn() {
Fariborz Jahanian217af242010-07-20 20:30:03 +0000422 // id objc_assign_strongCast(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000423 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000424 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000425 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000426 return CGM.CreateRuntimeFunction(FTy, "objc_assign_strongCast");
427 }
Anders Carlsson9ab53d12009-02-16 22:59:18 +0000428
429 /// ExceptionThrowFn - LLVM objc_exception_throw function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000430 llvm::Constant *getExceptionThrowFn() {
431 // void objc_exception_throw(id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000432 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000433 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000434 llvm::FunctionType::get(CGM.VoidTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000435 return CGM.CreateRuntimeFunction(FTy, "objc_exception_throw");
436 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000437
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000438 /// ExceptionRethrowFn - LLVM objc_exception_rethrow function.
439 llvm::Constant *getExceptionRethrowFn() {
440 // void objc_exception_rethrow(void)
John McCall9dc0db22011-05-15 01:53:33 +0000441 llvm::FunctionType *FTy = llvm::FunctionType::get(CGM.VoidTy, false);
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000442 return CGM.CreateRuntimeFunction(FTy, "objc_exception_rethrow");
443 }
444
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000445 /// SyncEnterFn - LLVM object_sync_enter function.
Chris Lattnerdcceee72009-04-06 16:53:45 +0000446 llvm::Constant *getSyncEnterFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000447 // int objc_sync_enter (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000448 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattnerdcceee72009-04-06 16:53:45 +0000449 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000450 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattnerdcceee72009-04-06 16:53:45 +0000451 return CGM.CreateRuntimeFunction(FTy, "objc_sync_enter");
452 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000453
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000454 /// SyncExitFn - LLVM object_sync_exit function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000455 llvm::Constant *getSyncExitFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000456 // int objc_sync_exit (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000457 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000458 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000459 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000460 return CGM.CreateRuntimeFunction(FTy, "objc_sync_exit");
461 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000462
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000463 llvm::Constant *getSendFn(bool IsSuper) const {
464 return IsSuper ? getMessageSendSuperFn() : getMessageSendFn();
465 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000466
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000467 llvm::Constant *getSendFn2(bool IsSuper) const {
468 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFn();
469 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000470
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000471 llvm::Constant *getSendStretFn(bool IsSuper) const {
472 return IsSuper ? getMessageSendSuperStretFn() : getMessageSendStretFn();
473 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000474
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000475 llvm::Constant *getSendStretFn2(bool IsSuper) const {
476 return IsSuper ? getMessageSendSuperStretFn2() : getMessageSendStretFn();
477 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000478
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000479 llvm::Constant *getSendFpretFn(bool IsSuper) const {
480 return IsSuper ? getMessageSendSuperFpretFn() : getMessageSendFpretFn();
481 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000482
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000483 llvm::Constant *getSendFpretFn2(bool IsSuper) const {
484 return IsSuper ? getMessageSendSuperFpretFn2() : getMessageSendFpretFn();
485 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000486
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000487 llvm::Constant *getSendFp2retFn(bool IsSuper) const {
488 return IsSuper ? getMessageSendSuperFn() : getMessageSendFp2retFn();
489 }
490
491 llvm::Constant *getSendFp2RetFn2(bool IsSuper) const {
492 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFp2retFn();
493 }
494
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000495 ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000496};
Daniel Dunbarf6397fe2008-08-23 04:28:29 +0000497
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000498/// ObjCTypesHelper - Helper class that encapsulates lazy
499/// construction of varies types used during ObjC generation.
500class ObjCTypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000501public:
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000502 /// SymtabTy - LLVM type for struct objc_symtab.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000503 llvm::StructType *SymtabTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000504 /// SymtabPtrTy - LLVM type for struct objc_symtab *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000505 llvm::Type *SymtabPtrTy;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000506 /// ModuleTy - LLVM type for struct objc_module.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000507 llvm::StructType *ModuleTy;
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000508
Daniel Dunbarb036db82008-08-13 03:21:16 +0000509 /// ProtocolTy - LLVM type for struct objc_protocol.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000510 llvm::StructType *ProtocolTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000511 /// ProtocolPtrTy - LLVM type for struct objc_protocol *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000512 llvm::Type *ProtocolPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000513 /// ProtocolExtensionTy - LLVM type for struct
514 /// objc_protocol_extension.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000515 llvm::StructType *ProtocolExtensionTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000516 /// ProtocolExtensionTy - LLVM type for struct
517 /// objc_protocol_extension *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000518 llvm::Type *ProtocolExtensionPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000519 /// MethodDescriptionTy - LLVM type for struct
520 /// objc_method_description.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000521 llvm::StructType *MethodDescriptionTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000522 /// MethodDescriptionListTy - LLVM type for struct
523 /// objc_method_description_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000524 llvm::StructType *MethodDescriptionListTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000525 /// MethodDescriptionListPtrTy - LLVM type for struct
526 /// objc_method_description_list *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000527 llvm::Type *MethodDescriptionListPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000528 /// ProtocolListTy - LLVM type for struct objc_property_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000529 llvm::StructType *ProtocolListTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000530 /// ProtocolListPtrTy - LLVM type for struct objc_property_list*.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000531 llvm::Type *ProtocolListPtrTy;
Daniel Dunbar938a77f2008-08-22 20:34:54 +0000532 /// CategoryTy - LLVM type for struct objc_category.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000533 llvm::StructType *CategoryTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000534 /// ClassTy - LLVM type for struct objc_class.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000535 llvm::StructType *ClassTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000536 /// ClassPtrTy - LLVM type for struct objc_class *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000537 llvm::Type *ClassPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000538 /// ClassExtensionTy - LLVM type for struct objc_class_ext.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000539 llvm::StructType *ClassExtensionTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000540 /// ClassExtensionPtrTy - LLVM type for struct objc_class_ext *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000541 llvm::Type *ClassExtensionPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000542 // IvarTy - LLVM type for struct objc_ivar.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000543 llvm::StructType *IvarTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000544 /// IvarListTy - LLVM type for struct objc_ivar_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000545 llvm::Type *IvarListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000546 /// IvarListPtrTy - LLVM type for struct objc_ivar_list *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000547 llvm::Type *IvarListPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000548 /// MethodListTy - LLVM type for struct objc_method_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000549 llvm::Type *MethodListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000550 /// MethodListPtrTy - LLVM type for struct objc_method_list *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000551 llvm::Type *MethodListPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000552
Anders Carlsson9ff22482008-09-09 10:10:21 +0000553 /// ExceptionDataTy - LLVM type for struct _objc_exception_data.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000554 llvm::Type *ExceptionDataTy;
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +0000555
Anders Carlsson9ff22482008-09-09 10:10:21 +0000556 /// ExceptionTryEnterFn - LLVM objc_exception_try_enter function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000557 llvm::Constant *getExceptionTryEnterFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000558 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000559 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000560 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000561 "objc_exception_try_enter");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000562 }
Anders Carlsson9ff22482008-09-09 10:10:21 +0000563
564 /// ExceptionTryExitFn - LLVM objc_exception_try_exit function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000565 llvm::Constant *getExceptionTryExitFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000566 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000567 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000568 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000569 "objc_exception_try_exit");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000570 }
Anders Carlsson9ff22482008-09-09 10:10:21 +0000571
572 /// ExceptionExtractFn - LLVM objc_exception_extract function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000573 llvm::Constant *getExceptionExtractFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000574 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000575 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000576 params, false),
Chris Lattnerc6406db2009-04-22 02:26:14 +0000577 "objc_exception_extract");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000578 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000579
Anders Carlsson9ff22482008-09-09 10:10:21 +0000580 /// ExceptionMatchFn - LLVM objc_exception_match function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000581 llvm::Constant *getExceptionMatchFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000582 llvm::Type *params[] = { ClassPtrTy, ObjectPtrTy };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000583 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000584 llvm::FunctionType::get(CGM.Int32Ty, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000585 "objc_exception_match");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000586 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000587
Anders Carlsson9ff22482008-09-09 10:10:21 +0000588 /// SetJmpFn - LLVM _setjmp function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000589 llvm::Constant *getSetJmpFn() {
John McCall9dc0db22011-05-15 01:53:33 +0000590 // This is specifically the prototype for x86.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000591 llvm::Type *params[] = { CGM.Int32Ty->getPointerTo() };
Bill Wendling8594fcb2013-01-31 00:30:05 +0000592 return
593 CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty,
594 params, false),
595 "_setjmp",
596 llvm::AttributeSet::get(CGM.getLLVMContext(),
597 llvm::AttributeSet::FunctionIndex,
598 llvm::Attribute::NonLazyBind));
Chris Lattnerc6406db2009-04-22 02:26:14 +0000599 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000600
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000601public:
602 ObjCTypesHelper(CodeGen::CodeGenModule &cgm);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000603};
604
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000605/// ObjCNonFragileABITypesHelper - will have all types needed by objective-c's
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000606/// modern abi
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000607class ObjCNonFragileABITypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000608public:
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000609 // MethodListnfABITy - LLVM for struct _method_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000610 llvm::StructType *MethodListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000611
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000612 // MethodListnfABIPtrTy - LLVM for struct _method_list_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000613 llvm::Type *MethodListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000614
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000615 // ProtocolnfABITy = LLVM for struct _protocol_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000616 llvm::StructType *ProtocolnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000617
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000618 // ProtocolnfABIPtrTy = LLVM for struct _protocol_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000619 llvm::Type *ProtocolnfABIPtrTy;
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000620
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000621 // ProtocolListnfABITy - LLVM for struct _objc_protocol_list
Chris Lattnera5f58b02011-07-09 17:41:47 +0000622 llvm::StructType *ProtocolListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000623
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000624 // ProtocolListnfABIPtrTy - LLVM for struct _objc_protocol_list*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000625 llvm::Type *ProtocolListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000626
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000627 // ClassnfABITy - LLVM for struct _class_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000628 llvm::StructType *ClassnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000629
Fariborz Jahanian71394042009-01-23 23:53:38 +0000630 // ClassnfABIPtrTy - LLVM for struct _class_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000631 llvm::Type *ClassnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000632
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000633 // IvarnfABITy - LLVM for struct _ivar_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000634 llvm::StructType *IvarnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000635
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000636 // IvarListnfABITy - LLVM for struct _ivar_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000637 llvm::StructType *IvarListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000638
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000639 // IvarListnfABIPtrTy = LLVM for struct _ivar_list_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000640 llvm::Type *IvarListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000641
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000642 // ClassRonfABITy - LLVM for struct _class_ro_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000643 llvm::StructType *ClassRonfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000644
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000645 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000646 llvm::Type *ImpnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000647
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000648 // CategorynfABITy - LLVM for struct _category_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000649 llvm::StructType *CategorynfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000650
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000651 // New types for nonfragile abi messaging.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000652
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000653 // MessageRefTy - LLVM for:
654 // struct _message_ref_t {
655 // IMP messenger;
656 // SEL name;
657 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000658 llvm::StructType *MessageRefTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000659 // MessageRefCTy - clang type for struct _message_ref_t
660 QualType MessageRefCTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000661
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000662 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000663 llvm::Type *MessageRefPtrTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000664 // MessageRefCPtrTy - clang type for struct _message_ref_t*
665 QualType MessageRefCPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000666
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000667 // SuperMessageRefTy - LLVM for:
668 // struct _super_message_ref_t {
669 // SUPER_IMP messenger;
670 // SEL name;
671 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000672 llvm::StructType *SuperMessageRefTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000673
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000674 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000675 llvm::Type *SuperMessageRefPtrTy;
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +0000676
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000677 llvm::Constant *getMessageSendFixupFn() {
678 // id objc_msgSend_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000679 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000680 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000681 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000682 "objc_msgSend_fixup");
683 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000684
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000685 llvm::Constant *getMessageSendFpretFixupFn() {
686 // id objc_msgSend_fpret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000687 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000688 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000689 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000690 "objc_msgSend_fpret_fixup");
691 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000692
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000693 llvm::Constant *getMessageSendStretFixupFn() {
694 // id objc_msgSend_stret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000695 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000696 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000697 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000698 "objc_msgSend_stret_fixup");
699 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000700
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000701 llvm::Constant *getMessageSendSuper2FixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000702 // id objc_msgSendSuper2_fixup (struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000703 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000704 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000705 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000706 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000707 "objc_msgSendSuper2_fixup");
708 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000709
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000710 llvm::Constant *getMessageSendSuper2StretFixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000711 // id objc_msgSendSuper2_stret_fixup(struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000712 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000713 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000714 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000715 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000716 "objc_msgSendSuper2_stret_fixup");
717 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000718
Chris Lattnera7c00b42009-04-22 02:15:23 +0000719 llvm::Constant *getObjCEndCatchFn() {
John McCall9dc0db22011-05-15 01:53:33 +0000720 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000721 "objc_end_catch");
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000722
Chris Lattnera7c00b42009-04-22 02:15:23 +0000723 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000724
Chris Lattnera7c00b42009-04-22 02:15:23 +0000725 llvm::Constant *getObjCBeginCatchFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000726 llvm::Type *params[] = { Int8PtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000727 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(Int8PtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000728 params, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000729 "objc_begin_catch");
730 }
Daniel Dunbarb1559a42009-03-01 04:46:24 +0000731
Chris Lattnera5f58b02011-07-09 17:41:47 +0000732 llvm::StructType *EHTypeTy;
733 llvm::Type *EHTypePtrTy;
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +0000734
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000735 ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000736};
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000737
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000738class CGObjCCommonMac : public CodeGen::CGObjCRuntime {
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000739public:
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000740 class SKIP_SCAN {
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000741 public:
742 unsigned skip;
743 unsigned scan;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000744 SKIP_SCAN(unsigned _skip = 0, unsigned _scan = 0)
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000745 : skip(_skip), scan(_scan) {}
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000746 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000747
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000748 /// opcode for captured block variables layout 'instructions'.
749 /// In the following descriptions, 'I' is the value of the immediate field.
750 /// (field following the opcode).
751 ///
752 enum BLOCK_LAYOUT_OPCODE {
753 /// An operator which affects how the following layout should be
754 /// interpreted.
755 /// I == 0: Halt interpretation and treat everything else as
756 /// a non-pointer. Note that this instruction is equal
757 /// to '\0'.
758 /// I != 0: Currently unused.
759 BLOCK_LAYOUT_OPERATOR = 0,
760
761 /// The next I+1 bytes do not contain a value of object pointer type.
762 /// Note that this can leave the stream unaligned, meaning that
763 /// subsequent word-size instructions do not begin at a multiple of
764 /// the pointer size.
765 BLOCK_LAYOUT_NON_OBJECT_BYTES = 1,
766
767 /// The next I+1 words do not contain a value of object pointer type.
768 /// This is simply an optimized version of BLOCK_LAYOUT_BYTES for
769 /// when the required skip quantity is a multiple of the pointer size.
770 BLOCK_LAYOUT_NON_OBJECT_WORDS = 2,
771
772 /// The next I+1 words are __strong pointers to Objective-C
773 /// objects or blocks.
774 BLOCK_LAYOUT_STRONG = 3,
775
776 /// The next I+1 words are pointers to __block variables.
777 BLOCK_LAYOUT_BYREF = 4,
778
779 /// The next I+1 words are __weak pointers to Objective-C
780 /// objects or blocks.
781 BLOCK_LAYOUT_WEAK = 5,
782
783 /// The next I+1 words are __unsafe_unretained pointers to
784 /// Objective-C objects or blocks.
785 BLOCK_LAYOUT_UNRETAINED = 6
786
787 /// The next I+1 words are block or object pointers with some
788 /// as-yet-unspecified ownership semantics. If we add more
789 /// flavors of ownership semantics, values will be taken from
790 /// this range.
791 ///
792 /// This is included so that older tools can at least continue
793 /// processing the layout past such things.
794 //BLOCK_LAYOUT_OWNERSHIP_UNKNOWN = 7..10,
795
796 /// All other opcodes are reserved. Halt interpretation and
797 /// treat everything else as opaque.
798 };
799
800 class RUN_SKIP {
801 public:
802 enum BLOCK_LAYOUT_OPCODE opcode;
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000803 CharUnits block_var_bytepos;
804 CharUnits block_var_size;
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000805 RUN_SKIP(enum BLOCK_LAYOUT_OPCODE Opcode = BLOCK_LAYOUT_OPERATOR,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000806 CharUnits BytePos = CharUnits::Zero(),
807 CharUnits Size = CharUnits::Zero())
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +0000808 : opcode(Opcode), block_var_bytepos(BytePos), block_var_size(Size) {}
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000809
810 // Allow sorting based on byte pos.
811 bool operator<(const RUN_SKIP &b) const {
812 return block_var_bytepos < b.block_var_bytepos;
813 }
814 };
815
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000816protected:
Owen Andersonae86c192009-07-13 04:10:07 +0000817 llvm::LLVMContext &VMContext;
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000818 // FIXME! May not be needing this after all.
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000819 unsigned ObjCABI;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000820
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000821 // arc/mrr layout of captured block literal variables.
822 SmallVector<RUN_SKIP, 16> RunSkipBlockVars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000823
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000824 /// LazySymbols - Symbols to generate a lazy reference for. See
825 /// DefinedSymbols and FinishModule().
Daniel Dunbard027a922009-09-07 00:20:42 +0000826 llvm::SetVector<IdentifierInfo*> LazySymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000827
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000828 /// DefinedSymbols - External symbols which are defined by this
829 /// module. The symbols in this list and LazySymbols are used to add
830 /// special linker symbols which ensure that Objective-C modules are
831 /// linked properly.
Daniel Dunbard027a922009-09-07 00:20:42 +0000832 llvm::SetVector<IdentifierInfo*> DefinedSymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000833
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000834 /// ClassNames - uniqued class names.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000835 llvm::StringMap<llvm::GlobalVariable*> ClassNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000836
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000837 /// MethodVarNames - uniqued method variable names.
838 llvm::DenseMap<Selector, llvm::GlobalVariable*> MethodVarNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000839
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000840 /// DefinedCategoryNames - list of category names in form Class_Category.
Rafael Espindolacd676622015-11-18 06:54:13 +0000841 llvm::SmallSetVector<std::string, 16> DefinedCategoryNames;
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000842
Daniel Dunbarb036db82008-08-13 03:21:16 +0000843 /// MethodVarTypes - uniqued method type signatures. We have to use
844 /// a StringMap here because have no other unique reference.
845 llvm::StringMap<llvm::GlobalVariable*> MethodVarTypes;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000846
Daniel Dunbar3c76cb52008-08-26 21:51:14 +0000847 /// MethodDefinitions - map of methods which have been defined in
848 /// this translation unit.
849 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*> MethodDefinitions;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000850
Daniel Dunbar80a840b2008-08-23 00:19:03 +0000851 /// PropertyNames - uniqued method variable names.
852 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> PropertyNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000853
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000854 /// ClassReferences - uniqued class references.
855 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> ClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000856
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000857 /// SelectorReferences - uniqued selector references.
858 llvm::DenseMap<Selector, llvm::GlobalVariable*> SelectorReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000859
Daniel Dunbarb036db82008-08-13 03:21:16 +0000860 /// Protocols - Protocols for which an objc_protocol structure has
861 /// been emitted. Forward declarations are handled by creating an
862 /// empty structure whose initializer is filled in when/if defined.
863 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> Protocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000864
Daniel Dunbarc475d422008-10-29 22:36:39 +0000865 /// DefinedProtocols - Protocols which have actually been
866 /// defined. We should not need this, see FIXME in GenerateProtocol.
867 llvm::DenseSet<IdentifierInfo*> DefinedProtocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000868
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000869 /// DefinedClasses - List of defined classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000870 SmallVector<llvm::GlobalValue*, 16> DefinedClasses;
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +0000871
872 /// ImplementedClasses - List of @implemented classes.
873 SmallVector<const ObjCInterfaceDecl*, 16> ImplementedClasses;
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000874
875 /// DefinedNonLazyClasses - List of defined "non-lazy" classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000876 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyClasses;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000877
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000878 /// DefinedCategories - List of defined categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000879 SmallVector<llvm::GlobalValue*, 16> DefinedCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000880
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000881 /// DefinedNonLazyCategories - List of defined "non-lazy" categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000882 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000883
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000884 /// GetNameForMethod - Return a name for the given method.
885 /// \param[out] NameOut - The return value.
886 void GetNameForMethod(const ObjCMethodDecl *OMD,
887 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000888 SmallVectorImpl<char> &NameOut);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000889
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000890 /// GetMethodVarName - Return a unique constant for the given
891 /// selector's name. The return value has type char *.
892 llvm::Constant *GetMethodVarName(Selector Sel);
893 llvm::Constant *GetMethodVarName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000894
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000895 /// GetMethodVarType - Return a unique constant for the given
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000896 /// method's type encoding string. The return value has type char *.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000897
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000898 // FIXME: This is a horrible name.
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000899 llvm::Constant *GetMethodVarType(const ObjCMethodDecl *D,
900 bool Extended = false);
Daniel Dunbarf5c18462009-04-20 06:54:31 +0000901 llvm::Constant *GetMethodVarType(const FieldDecl *D);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000902
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000903 /// GetPropertyName - Return a unique constant for the given
904 /// name. The return value has type char *.
905 llvm::Constant *GetPropertyName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000906
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000907 // FIXME: This can be dropped once string functions are unified.
908 llvm::Constant *GetPropertyTypeString(const ObjCPropertyDecl *PD,
909 const Decl *Container);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000910
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +0000911 /// GetClassName - Return a unique constant for the given selector's
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000912 /// runtime name (which may change via use of objc_runtime_name attribute on
913 /// class or protocol definition. The return value has type char *.
914 llvm::Constant *GetClassName(StringRef RuntimeName);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000915
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +0000916 llvm::Function *GetMethodDefinition(const ObjCMethodDecl *MD);
917
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +0000918 /// BuildIvarLayout - Builds ivar layout bitmap for the class
919 /// implementation for the __strong or __weak case.
920 ///
John McCall460ce582015-10-22 18:38:17 +0000921 /// \param hasMRCWeakIvars - Whether we are compiling in MRC and there
922 /// are any weak ivars defined directly in the class. Meaningless unless
923 /// building a weak layout. Does not guarantee that the layout will
924 /// actually have any entries, because the ivar might be under-aligned.
Fariborz Jahanian1bf72882009-03-12 22:50:49 +0000925 llvm::Constant *BuildIvarLayout(const ObjCImplementationDecl *OI,
John McCall3fd13f062015-10-21 18:06:47 +0000926 CharUnits beginOffset,
927 CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +0000928 bool forStrongLayout,
929 bool hasMRCWeakIvars);
930
931 llvm::Constant *BuildStrongIvarLayout(const ObjCImplementationDecl *OI,
932 CharUnits beginOffset,
933 CharUnits endOffset) {
934 return BuildIvarLayout(OI, beginOffset, endOffset, true, false);
935 }
936
937 llvm::Constant *BuildWeakIvarLayout(const ObjCImplementationDecl *OI,
938 CharUnits beginOffset,
939 CharUnits endOffset,
940 bool hasMRCWeakIvars) {
941 return BuildIvarLayout(OI, beginOffset, endOffset, false, hasMRCWeakIvars);
942 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +0000943
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000944 Qualifiers::ObjCLifetime getBlockCaptureLifetime(QualType QT, bool ByrefLayout);
Fariborz Jahanian2dd78192012-11-02 22:51:18 +0000945
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000946 void UpdateRunSkipBlockVars(bool IsByref,
947 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000948 CharUnits FieldOffset,
949 CharUnits FieldSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000950
951 void BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000952 CharUnits BytePos, bool &HasUnion,
953 bool ByrefLayout=false);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000954
955 void BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
956 const RecordDecl *RD,
957 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000958 CharUnits BytePos, bool &HasUnion,
959 bool ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000960
Fariborz Jahanian23290b02012-11-01 18:32:55 +0000961 uint64_t InlineLayoutInstruction(SmallVectorImpl<unsigned char> &Layout);
962
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000963 llvm::Constant *getBitmapBlockLayout(bool ComputeByrefLayout);
964
Fariborz Jahanian01dff422009-03-05 19:17:31 +0000965 /// GetIvarLayoutName - Returns a unique constant for the given
966 /// ivar layout bitmap.
967 llvm::Constant *GetIvarLayoutName(IdentifierInfo *Ident,
968 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000969
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000970 /// EmitPropertyList - Emit the given property list. The return
971 /// value has type PropertyListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000972 llvm::Constant *EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000973 const Decl *Container,
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000974 const ObjCContainerDecl *OCD,
Manman Renad0e7912016-01-29 19:22:54 +0000975 const ObjCCommonTypesHelper &ObjCTypes,
976 bool IsClassProperty);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000977
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000978 /// EmitProtocolMethodTypes - Generate the array of extended method type
979 /// strings. The return value has type Int8PtrPtrTy.
980 llvm::Constant *EmitProtocolMethodTypes(Twine Name,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +0000981 ArrayRef<llvm::Constant*> MethodTypes,
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000982 const ObjCCommonTypesHelper &ObjCTypes);
983
Fariborz Jahanian751c1e72009-12-12 21:26:21 +0000984 /// PushProtocolProperties - Push protocol's property on the input stack.
Bill Wendlinga515b582012-02-09 22:16:49 +0000985 void PushProtocolProperties(
986 llvm::SmallPtrSet<const IdentifierInfo*, 16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000987 SmallVectorImpl<llvm::Constant*> &Properties,
Bill Wendlinga515b582012-02-09 22:16:49 +0000988 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +0000989 const ObjCProtocolDecl *Proto,
Manman Renad0e7912016-01-29 19:22:54 +0000990 const ObjCCommonTypesHelper &ObjCTypes,
991 bool IsClassProperty);
Fariborz Jahanian751c1e72009-12-12 21:26:21 +0000992
Fariborz Jahanian56b3b772009-01-29 19:24:30 +0000993 /// GetProtocolRef - Return a reference to the internal protocol
994 /// description, creating an empty one if it has not been
995 /// defined. The return value has type ProtocolPtrTy.
996 llvm::Constant *GetProtocolRef(const ObjCProtocolDecl *PD);
Fariborz Jahanian67726212009-03-08 20:18:37 +0000997
Douglas Gregor24ae22c2016-04-01 23:23:52 +0000998 /// Return a reference to the given Class using runtime calls rather than
999 /// by a symbol reference.
1000 llvm::Value *EmitClassRefViaRuntime(CodeGenFunction &CGF,
1001 const ObjCInterfaceDecl *ID,
1002 ObjCCommonTypesHelper &ObjCTypes);
1003
John McCall3fd13f062015-10-21 18:06:47 +00001004public:
Daniel Dunbar30c65362009-03-09 20:09:19 +00001005 /// CreateMetadataVar - Create a global variable with internal
1006 /// linkage for use by the Objective-C runtime.
1007 ///
1008 /// This is a convenience wrapper which not only creates the
1009 /// variable, but also sets the section and alignment and adds the
Chris Lattnerf56501c2009-07-17 23:57:13 +00001010 /// global to the "llvm.used" list.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001011 ///
1012 /// \param Name - The variable name.
1013 /// \param Init - The variable initializer; this is also used to
1014 /// define the type of the variable.
Alp Toker541d5072014-06-07 23:30:53 +00001015 /// \param Section - The section the variable should go into, or empty.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001016 /// \param Align - The alignment for the variable, or 0.
1017 /// \param AddToUsed - Whether the variable should be added to
Daniel Dunbar4527d302009-04-14 17:42:51 +00001018 /// "llvm.used".
Alp Toker541d5072014-06-07 23:30:53 +00001019 llvm::GlobalVariable *CreateMetadataVar(Twine Name, llvm::Constant *Init,
John McCall7f416cc2015-09-08 08:05:57 +00001020 StringRef Section, CharUnits Align,
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001021 bool AddToUsed);
Daniel Dunbar30c65362009-03-09 20:09:19 +00001022
John McCall3fd13f062015-10-21 18:06:47 +00001023protected:
John McCall9e8bb002011-05-14 03:10:52 +00001024 CodeGen::RValue EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1025 ReturnValueSlot Return,
1026 QualType ResultType,
1027 llvm::Value *Sel,
1028 llvm::Value *Arg0,
1029 QualType Arg0Ty,
1030 bool IsSuper,
1031 const CallArgList &CallArgs,
1032 const ObjCMethodDecl *OMD,
John McCall1e3157b2015-09-10 22:27:50 +00001033 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001034 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbarf5c18462009-04-20 06:54:31 +00001035
Daniel Dunbar5e639272010-04-25 20:39:01 +00001036 /// EmitImageInfo - Emit the image info marker used to encode some module
1037 /// level information.
1038 void EmitImageInfo();
1039
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001040public:
Owen Andersonae86c192009-07-13 04:10:07 +00001041 CGObjCCommonMac(CodeGen::CodeGenModule &cgm) :
John McCalla729c622012-02-17 03:33:10 +00001042 CGObjCRuntime(cgm), VMContext(cgm.getLLVMContext()) { }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001043
John McCall3fd13f062015-10-21 18:06:47 +00001044 bool isNonFragileABI() const {
1045 return ObjCABI == 2;
1046 }
1047
John McCall7f416cc2015-09-08 08:05:57 +00001048 ConstantAddress GenerateConstantString(const StringLiteral *SL) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001049
Craig Topper4f12f102014-03-12 06:41:41 +00001050 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
Craig Topper8a13c412014-05-21 05:09:00 +00001051 const ObjCContainerDecl *CD=nullptr) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001052
1053 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001054
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001055 /// GetOrEmitProtocol - Get the protocol object for the given
1056 /// declaration, emitting it if necessary. The return value has type
1057 /// ProtocolPtrTy.
1058 virtual llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD)=0;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001059
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001060 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1061 /// object for the given declaration, emitting it if needed. These
1062 /// forward references will be filled in with empty bodies if no
1063 /// definition is seen. The return value has type ProtocolPtrTy.
1064 virtual llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD)=0;
Craig Topper4f12f102014-03-12 06:41:41 +00001065 llvm::Constant *BuildGCBlockLayout(CodeGen::CodeGenModule &CGM,
1066 const CGBlockInfo &blockInfo) override;
1067 llvm::Constant *BuildRCBlockLayout(CodeGen::CodeGenModule &CGM,
1068 const CGBlockInfo &blockInfo) override;
1069
1070 llvm::Constant *BuildByrefLayout(CodeGen::CodeGenModule &CGM,
1071 QualType T) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001072};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001073
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001074class CGObjCMac : public CGObjCCommonMac {
1075private:
1076 ObjCTypesHelper ObjCTypes;
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001077
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001078 /// EmitModuleInfo - Another marker encoding module level
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001079 /// information.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001080 void EmitModuleInfo();
1081
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001082 /// EmitModuleSymols - Emit module symbols, the list of defined
1083 /// classes and categories. The result has type SymtabPtrTy.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001084 llvm::Constant *EmitModuleSymbols();
1085
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001086 /// FinishModule - Write out global data structures at the end of
1087 /// processing a translation unit.
1088 void FinishModule();
Daniel Dunbarb036db82008-08-13 03:21:16 +00001089
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001090 /// EmitClassExtension - Generate the class extension structure used
1091 /// to store the weak ivar layout and properties. The return value
1092 /// has type ClassExtensionPtrTy.
John McCall3fd13f062015-10-21 18:06:47 +00001093 llvm::Constant *EmitClassExtension(const ObjCImplementationDecl *ID,
John McCall460ce582015-10-22 18:38:17 +00001094 CharUnits instanceSize,
Manman Renad0e7912016-01-29 19:22:54 +00001095 bool hasMRCWeakIvars,
1096 bool isClassProperty);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001097
1098 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1099 /// for the given class.
John McCall882987f2013-02-28 19:01:20 +00001100 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001101 const ObjCInterfaceDecl *ID);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001102
John McCall882987f2013-02-28 19:01:20 +00001103 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00001104 IdentifierInfo *II);
Craig Topper4f12f102014-03-12 06:41:41 +00001105
1106 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
1107
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001108 /// EmitSuperClassRef - Emits reference to class's main metadata class.
1109 llvm::Value *EmitSuperClassRef(const ObjCInterfaceDecl *ID);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001110
1111 /// EmitIvarList - Emit the ivar list for the given
1112 /// implementation. If ForClass is true the list of class ivars
1113 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1114 /// interface ivars will be emitted. The return value has type
1115 /// IvarListPtrTy.
1116 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00001117 bool ForClass);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001118
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001119 /// EmitMetaClass - Emit a forward reference to the class structure
1120 /// for the metaclass of the given interface. The return value has
1121 /// type ClassPtrTy.
1122 llvm::Constant *EmitMetaClassRef(const ObjCInterfaceDecl *ID);
1123
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001124 /// EmitMetaClass - Emit a class structure for the metaclass of the
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001125 /// given implementation. The return value has type ClassPtrTy.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001126 llvm::Constant *EmitMetaClass(const ObjCImplementationDecl *ID,
1127 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001128 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001129
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001130 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001131
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001132 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001133
1134 /// EmitMethodList - Emit the method list for the given
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001135 /// implementation. The return value has type MethodListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001136 llvm::Constant *EmitMethodList(Twine Name,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00001137 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001138 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001139
1140 /// EmitMethodDescList - Emit a method description list for a list of
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001141 /// method declarations.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001142 /// - TypeName: The name for the type containing the methods.
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001143 /// - IsProtocol: True iff these methods are for a protocol.
1144 /// - ClassMethds: True iff these are class methods.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001145 /// - Required: When true, only "required" methods are
1146 /// listed. Similarly, when false only "optional" methods are
1147 /// listed. For classes this should always be true.
1148 /// - begin, end: The method list to output.
1149 ///
1150 /// The return value has type MethodDescriptionListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001151 llvm::Constant *EmitMethodDescList(Twine Name,
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001152 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001153 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001154
Daniel Dunbarc475d422008-10-29 22:36:39 +00001155 /// GetOrEmitProtocol - Get the protocol object for the given
1156 /// declaration, emitting it if necessary. The return value has type
1157 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001158 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001159
1160 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1161 /// object for the given declaration, emitting it if needed. These
1162 /// forward references will be filled in with empty bodies if no
1163 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001164 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001165
Daniel Dunbarb036db82008-08-13 03:21:16 +00001166 /// EmitProtocolExtension - Generate the protocol extension
1167 /// structure used to store optional instance and class methods, and
1168 /// protocol properties. The return value has type
1169 /// ProtocolExtensionPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001170 llvm::Constant *
1171 EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001172 ArrayRef<llvm::Constant*> OptInstanceMethods,
1173 ArrayRef<llvm::Constant*> OptClassMethods,
1174 ArrayRef<llvm::Constant*> MethodTypesExt);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001175
1176 /// EmitProtocolList - Generate the list of referenced
1177 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001178 llvm::Constant *EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00001179 ObjCProtocolDecl::protocol_iterator begin,
1180 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001181
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001182 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1183 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001184 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1185 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001186
1187public:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001188 CGObjCMac(CodeGen::CodeGenModule &cgm);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001189
Craig Topper4f12f102014-03-12 06:41:41 +00001190 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001191
Craig Topper4f12f102014-03-12 06:41:41 +00001192 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1193 ReturnValueSlot Return,
1194 QualType ResultType,
1195 Selector Sel, llvm::Value *Receiver,
1196 const CallArgList &CallArgs,
1197 const ObjCInterfaceDecl *Class,
1198 const ObjCMethodDecl *Method) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001199
Craig Topper4f12f102014-03-12 06:41:41 +00001200 CodeGen::RValue
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001201 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001202 ReturnValueSlot Return, QualType ResultType,
1203 Selector Sel, const ObjCInterfaceDecl *Class,
1204 bool isCategoryImpl, llvm::Value *Receiver,
1205 bool IsClassMessage, const CallArgList &CallArgs,
1206 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001207
Craig Topper4f12f102014-03-12 06:41:41 +00001208 llvm::Value *GetClass(CodeGenFunction &CGF,
1209 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001210
John McCall7f416cc2015-09-08 08:05:57 +00001211 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
1212 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001213
1214 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1215 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001216 llvm::Value *GetSelector(CodeGenFunction &CGF,
1217 const ObjCMethodDecl *Method) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001218
Craig Topper4f12f102014-03-12 06:41:41 +00001219 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001220
Craig Topper4f12f102014-03-12 06:41:41 +00001221 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001222
Craig Topper4f12f102014-03-12 06:41:41 +00001223 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001224
Craig Topper4f12f102014-03-12 06:41:41 +00001225 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001226
Craig Topper4f12f102014-03-12 06:41:41 +00001227 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1228 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001229
Craig Topper4f12f102014-03-12 06:41:41 +00001230 llvm::Constant *GetPropertyGetFunction() override;
1231 llvm::Constant *GetPropertySetFunction() override;
1232 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1233 bool copy) override;
1234 llvm::Constant *GetGetStructFunction() override;
1235 llvm::Constant *GetSetStructFunction() override;
1236 llvm::Constant *GetCppAtomicObjectGetFunction() override;
1237 llvm::Constant *GetCppAtomicObjectSetFunction() override;
1238 llvm::Constant *EnumerationMutationFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001239
Craig Topper4f12f102014-03-12 06:41:41 +00001240 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1241 const ObjCAtTryStmt &S) override;
1242 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1243 const ObjCAtSynchronizedStmt &S) override;
John McCallbd309292010-07-06 01:34:17 +00001244 void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, const Stmt &S);
Craig Topper4f12f102014-03-12 06:41:41 +00001245 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1246 bool ClearInsertionPoint=true) override;
1247 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001248 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001249 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001250 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001251 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001252 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001253 bool threadlocal = false) override;
1254 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001255 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001256 llvm::Value *ivarOffset) override;
1257 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001258 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001259 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001260 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001261 llvm::Value *size) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001262
Craig Topper4f12f102014-03-12 06:41:41 +00001263 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1264 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1265 unsigned CVRQualifiers) override;
1266 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1267 const ObjCInterfaceDecl *Interface,
1268 const ObjCIvarDecl *Ivar) override;
1269
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001270 /// GetClassGlobal - Return the global variable for the Objective-C
1271 /// class of the given name.
Benjamin Kramer0772c422016-02-13 13:42:54 +00001272 llvm::GlobalVariable *GetClassGlobal(StringRef Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001273 bool Weak = false) override {
David Blaikie83d382b2011-09-23 05:06:16 +00001274 llvm_unreachable("CGObjCMac::GetClassGlobal");
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001275 }
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001276};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001277
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001278class CGObjCNonFragileABIMac : public CGObjCCommonMac {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001279private:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001280 ObjCNonFragileABITypesHelper ObjCTypes;
Fariborz Jahanian71394042009-01-23 23:53:38 +00001281 llvm::GlobalVariable* ObjCEmptyCacheVar;
1282 llvm::GlobalVariable* ObjCEmptyVtableVar;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001283
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001284 /// SuperClassReferences - uniqued super class references.
1285 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> SuperClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001286
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001287 /// MetaClassReferences - uniqued meta class references.
1288 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> MetaClassReferences;
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001289
1290 /// EHTypeReferences - uniqued class ehtype references.
1291 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> EHTypeReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001292
John McCall9e8bb002011-05-14 03:10:52 +00001293 /// VTableDispatchMethods - List of methods for which we generate
1294 /// vtable-based message dispatch.
1295 llvm::DenseSet<Selector> VTableDispatchMethods;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001296
Fariborz Jahanian67260552009-11-17 21:37:35 +00001297 /// DefinedMetaClasses - List of defined meta-classes.
1298 std::vector<llvm::GlobalValue*> DefinedMetaClasses;
1299
John McCall9e8bb002011-05-14 03:10:52 +00001300 /// isVTableDispatchedSelector - Returns true if SEL is a
1301 /// vtable-based selector.
1302 bool isVTableDispatchedSelector(Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001303
Fariborz Jahanian71394042009-01-23 23:53:38 +00001304 /// FinishNonFragileABIModule - Write out global data structures at the end of
1305 /// processing a translation unit.
1306 void FinishNonFragileABIModule();
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001307
Daniel Dunbar19573e72009-05-15 21:48:48 +00001308 /// AddModuleClassList - Add the given list of class pointers to the
1309 /// module with the provided symbol and section names.
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001310 void AddModuleClassList(ArrayRef<llvm::GlobalValue*> Container,
Daniel Dunbar19573e72009-05-15 21:48:48 +00001311 const char *SymbolName,
1312 const char *SectionName);
1313
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001314 llvm::GlobalVariable * BuildClassRoTInitializer(unsigned flags,
1315 unsigned InstanceStart,
1316 unsigned InstanceSize,
1317 const ObjCImplementationDecl *ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001318 llvm::GlobalVariable * BuildClassMetaData(const std::string &ClassName,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001319 llvm::Constant *IsAGV,
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00001320 llvm::Constant *SuperClassGV,
Fariborz Jahanian82208252009-01-31 00:59:10 +00001321 llvm::Constant *ClassRoGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00001322 bool HiddenVisibility,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00001323 bool Weak);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001324
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001325 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001326
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00001327 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001328
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001329 /// EmitMethodList - Emit the method list for the given
1330 /// implementation. The return value has type MethodListnfABITy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001331 llvm::Constant *EmitMethodList(Twine Name,
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001332 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001333 ArrayRef<llvm::Constant*> Methods);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00001334 /// EmitIvarList - Emit the ivar list for the given
1335 /// implementation. If ForClass is true the list of class ivars
1336 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1337 /// interface ivars will be emitted. The return value has type
1338 /// IvarListnfABIPtrTy.
1339 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001340
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001341 llvm::Constant *EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00001342 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00001343 unsigned long int offset);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001344
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001345 /// GetOrEmitProtocol - Get the protocol object for the given
1346 /// declaration, emitting it if necessary. The return value has type
1347 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001348 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001349
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001350 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1351 /// object for the given declaration, emitting it if needed. These
1352 /// forward references will be filled in with empty bodies if no
1353 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001354 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001355
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001356 /// EmitProtocolList - Generate the list of referenced
1357 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001358 llvm::Constant *EmitProtocolList(Twine Name,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001359 ObjCProtocolDecl::protocol_iterator begin,
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00001360 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001361
John McCall9e8bb002011-05-14 03:10:52 +00001362 CodeGen::RValue EmitVTableMessageSend(CodeGen::CodeGenFunction &CGF,
1363 ReturnValueSlot Return,
1364 QualType ResultType,
1365 Selector Sel,
1366 llvm::Value *Receiver,
1367 QualType Arg0Ty,
1368 bool IsSuper,
1369 const CallArgList &CallArgs,
1370 const ObjCMethodDecl *Method);
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001371
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00001372 /// GetClassGlobal - Return the global variable for the Objective-C
1373 /// class of the given name.
Benjamin Kramer0772c422016-02-13 13:42:54 +00001374 llvm::GlobalVariable *GetClassGlobal(StringRef Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001375 bool Weak = false) override;
Rafael Espindola554256c2014-02-26 22:25:45 +00001376
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00001377 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001378 /// for the given class reference.
John McCall882987f2013-02-28 19:01:20 +00001379 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001380 const ObjCInterfaceDecl *ID);
John McCall31168b02011-06-15 23:02:42 +00001381
John McCall882987f2013-02-28 19:01:20 +00001382 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001383 IdentifierInfo *II, bool Weak,
1384 const ObjCInterfaceDecl *ID);
Craig Topper4f12f102014-03-12 06:41:41 +00001385
1386 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001387
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001388 /// EmitSuperClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1389 /// for the given super class reference.
John McCall882987f2013-02-28 19:01:20 +00001390 llvm::Value *EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001391 const ObjCInterfaceDecl *ID);
1392
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001393 /// EmitMetaClassRef - Return a Value * of the address of _class_t
1394 /// meta-data
John McCall882987f2013-02-28 19:01:20 +00001395 llvm::Value *EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00001396 const ObjCInterfaceDecl *ID, bool Weak);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001397
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001398 /// ObjCIvarOffsetVariable - Returns the ivar offset variable for
1399 /// the given ivar.
1400 ///
Daniel Dunbara1060522009-04-19 00:31:15 +00001401 llvm::GlobalVariable * ObjCIvarOffsetVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001402 const ObjCInterfaceDecl *ID,
1403 const ObjCIvarDecl *Ivar);
1404
Fariborz Jahanian74b77222009-02-11 20:51:17 +00001405 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1406 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001407 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1408 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001409
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001410 /// GetInterfaceEHType - Get the cached ehtype for the given Objective-C
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001411 /// interface. The return value has type EHTypePtrTy.
John McCall2ca705e2010-07-24 00:37:23 +00001412 llvm::Constant *GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001413 bool ForDefinition);
Daniel Dunbar15894b72009-04-07 05:48:37 +00001414
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001415 const char *getMetaclassSymbolPrefix() const {
Daniel Dunbar15894b72009-04-07 05:48:37 +00001416 return "OBJC_METACLASS_$_";
1417 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001418
Daniel Dunbar15894b72009-04-07 05:48:37 +00001419 const char *getClassSymbolPrefix() const {
1420 return "OBJC_CLASS_$_";
1421 }
1422
Daniel Dunbar961202372009-05-03 12:57:56 +00001423 void GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00001424 uint32_t &InstanceStart,
1425 uint32_t &InstanceSize);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001426
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001427 // Shamelessly stolen from Analysis/CFRefCount.cpp
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001428 Selector GetNullarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001429 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1430 return CGM.getContext().Selectors.getSelector(0, &II);
1431 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001432
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001433 Selector GetUnarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001434 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1435 return CGM.getContext().Selectors.getSelector(1, &II);
1436 }
Daniel Dunbar554fd792009-04-19 23:41:48 +00001437
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001438 /// ImplementationIsNonLazy - Check whether the given category or
1439 /// class implementation is "non-lazy".
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00001440 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001441
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001442 bool IsIvarOffsetKnownIdempotent(const CodeGen::CodeGenFunction &CGF,
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001443 const ObjCIvarDecl *IV) {
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001444 // Annotate the load as an invariant load iff inside an instance method
1445 // and ivar belongs to instance method's class and one of its super class.
1446 // This check is needed because the ivar offset is a lazily
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001447 // initialised value that may depend on objc_msgSend to perform a fixup on
1448 // the first message dispatch.
1449 //
1450 // An additional opportunity to mark the load as invariant arises when the
1451 // base of the ivar access is a parameter to an Objective C method.
1452 // However, because the parameters are not available in the current
1453 // interface, we cannot perform this check.
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001454 if (const ObjCMethodDecl *MD =
1455 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurFuncDecl))
Fariborz Jahanian7a583022014-03-04 22:57:32 +00001456 if (MD->isInstanceMethod())
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001457 if (const ObjCInterfaceDecl *ID = MD->getClassInterface())
1458 return IV->getContainingInterface()->isSuperClassOf(ID);
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001459 return false;
1460 }
1461
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001462public:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001463 CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian71394042009-01-23 23:53:38 +00001464 // FIXME. All stubs for now!
Craig Topper4f12f102014-03-12 06:41:41 +00001465 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001466
Craig Topper4f12f102014-03-12 06:41:41 +00001467 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1468 ReturnValueSlot Return,
1469 QualType ResultType, Selector Sel,
1470 llvm::Value *Receiver,
1471 const CallArgList &CallArgs,
1472 const ObjCInterfaceDecl *Class,
1473 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001474
Craig Topper4f12f102014-03-12 06:41:41 +00001475 CodeGen::RValue
Fariborz Jahanian71394042009-01-23 23:53:38 +00001476 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001477 ReturnValueSlot Return, QualType ResultType,
1478 Selector Sel, const ObjCInterfaceDecl *Class,
1479 bool isCategoryImpl, llvm::Value *Receiver,
1480 bool IsClassMessage, const CallArgList &CallArgs,
1481 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001482
Craig Topper4f12f102014-03-12 06:41:41 +00001483 llvm::Value *GetClass(CodeGenFunction &CGF,
1484 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001485
John McCall7f416cc2015-09-08 08:05:57 +00001486 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override
1487 { return EmitSelector(CGF, Sel); }
1488 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override
1489 { return EmitSelectorAddr(CGF, Sel); }
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001490
1491 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1492 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001493 llvm::Value *GetSelector(CodeGenFunction &CGF,
1494 const ObjCMethodDecl *Method) override
John McCall882987f2013-02-28 19:01:20 +00001495 { return EmitSelector(CGF, Method->getSelector()); }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001496
Craig Topper4f12f102014-03-12 06:41:41 +00001497 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001498
Craig Topper4f12f102014-03-12 06:41:41 +00001499 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
David Chisnall92d436b2012-01-31 18:59:20 +00001500
Craig Topper4f12f102014-03-12 06:41:41 +00001501 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001502
Craig Topper4f12f102014-03-12 06:41:41 +00001503 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1504 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001505
Craig Topper4f12f102014-03-12 06:41:41 +00001506 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001507
Craig Topper4f12f102014-03-12 06:41:41 +00001508 llvm::Constant *GetPropertyGetFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001509 return ObjCTypes.getGetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001510 }
Craig Topper4f12f102014-03-12 06:41:41 +00001511 llvm::Constant *GetPropertySetFunction() override {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001512 return ObjCTypes.getSetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001513 }
Craig Topper4f12f102014-03-12 06:41:41 +00001514
1515 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1516 bool copy) override {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001517 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
1518 }
Craig Topper4f12f102014-03-12 06:41:41 +00001519
1520 llvm::Constant *GetSetStructFunction() override {
David Chisnall168b80f2010-12-26 22:13:16 +00001521 return ObjCTypes.getCopyStructFn();
1522 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001523
Craig Topper4f12f102014-03-12 06:41:41 +00001524 llvm::Constant *GetGetStructFunction() override {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00001525 return ObjCTypes.getCopyStructFn();
1526 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001527
Craig Topper4f12f102014-03-12 06:41:41 +00001528 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +00001529 return ObjCTypes.getCppAtomicObjectFunction();
1530 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001531
Craig Topper4f12f102014-03-12 06:41:41 +00001532 llvm::Constant *GetCppAtomicObjectGetFunction() override {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00001533 return ObjCTypes.getCppAtomicObjectFunction();
1534 }
Craig Topper4f12f102014-03-12 06:41:41 +00001535
1536 llvm::Constant *EnumerationMutationFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001537 return ObjCTypes.getEnumerationMutationFn();
Daniel Dunbard73ea8162009-02-16 18:48:45 +00001538 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001539
Craig Topper4f12f102014-03-12 06:41:41 +00001540 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1541 const ObjCAtTryStmt &S) override;
1542 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1543 const ObjCAtSynchronizedStmt &S) override;
1544 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1545 bool ClearInsertionPoint=true) override;
1546 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001547 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001548 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001549 llvm::Value *src, Address edst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001550 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001551 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001552 bool threadlocal = false) override;
1553 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001554 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001555 llvm::Value *ivarOffset) override;
1556 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001557 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001558 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001559 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001560 llvm::Value *size) override;
1561 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1562 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1563 unsigned CVRQualifiers) override;
1564 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1565 const ObjCInterfaceDecl *Interface,
1566 const ObjCIvarDecl *Ivar) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001567};
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001568
1569/// A helper class for performing the null-initialization of a return
1570/// value.
1571struct NullReturnState {
1572 llvm::BasicBlock *NullBB;
Craig Topper8a13c412014-05-21 05:09:00 +00001573 NullReturnState() : NullBB(nullptr) {}
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001574
John McCall3d1e2c92013-02-12 05:53:35 +00001575 /// Perform a null-check of the given receiver.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001576 void init(CodeGenFunction &CGF, llvm::Value *receiver) {
John McCall3d1e2c92013-02-12 05:53:35 +00001577 // Make blocks for the null-receiver and call edges.
1578 NullBB = CGF.createBasicBlock("msgSend.null-receiver");
1579 llvm::BasicBlock *callBB = CGF.createBasicBlock("msgSend.call");
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001580
1581 // Check for a null receiver and, if there is one, jump to the
John McCall3d1e2c92013-02-12 05:53:35 +00001582 // null-receiver block. There's no point in trying to avoid it:
1583 // we're always going to put *something* there, because otherwise
1584 // we shouldn't have done this null-check in the first place.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001585 llvm::Value *isNull = CGF.Builder.CreateIsNull(receiver);
1586 CGF.Builder.CreateCondBr(isNull, NullBB, callBB);
1587
1588 // Otherwise, start performing the call.
1589 CGF.EmitBlock(callBB);
1590 }
1591
John McCall3d1e2c92013-02-12 05:53:35 +00001592 /// Complete the null-return operation. It is valid to call this
1593 /// regardless of whether 'init' has been called.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001594 RValue complete(CodeGenFunction &CGF, RValue result, QualType resultType,
1595 const CallArgList &CallArgs,
1596 const ObjCMethodDecl *Method) {
John McCall3d1e2c92013-02-12 05:53:35 +00001597 // If we never had to do a null-check, just use the raw result.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001598 if (!NullBB) return result;
John McCall3d1e2c92013-02-12 05:53:35 +00001599
1600 // The continuation block. This will be left null if we don't have an
1601 // IP, which can happen if the method we're calling is marked noreturn.
Craig Topper8a13c412014-05-21 05:09:00 +00001602 llvm::BasicBlock *contBB = nullptr;
1603
John McCall3d1e2c92013-02-12 05:53:35 +00001604 // Finish the call path.
1605 llvm::BasicBlock *callBB = CGF.Builder.GetInsertBlock();
1606 if (callBB) {
1607 contBB = CGF.createBasicBlock("msgSend.cont");
1608 CGF.Builder.CreateBr(contBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001609 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001610
John McCall3d1e2c92013-02-12 05:53:35 +00001611 // Okay, start emitting the null-receiver block.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001612 CGF.EmitBlock(NullBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001613
John McCall3d1e2c92013-02-12 05:53:35 +00001614 // Release any consumed arguments we've got.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001615 if (Method) {
1616 CallArgList::const_iterator I = CallArgs.begin();
1617 for (ObjCMethodDecl::param_const_iterator i = Method->param_begin(),
1618 e = Method->param_end(); i != e; ++i, ++I) {
1619 const ParmVarDecl *ParamDecl = (*i);
1620 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1621 RValue RV = I->RV;
1622 assert(RV.isScalar() &&
1623 "NullReturnState::complete - arg not on object");
John McCallcdda29c2013-03-13 03:10:54 +00001624 CGF.EmitARCRelease(RV.getScalarVal(), ARCImpreciseLifetime);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001625 }
1626 }
1627 }
John McCall3d1e2c92013-02-12 05:53:35 +00001628
1629 // The phi code below assumes that we haven't needed any control flow yet.
1630 assert(CGF.Builder.GetInsertBlock() == NullBB);
1631
1632 // If we've got a void return, just jump to the continuation block.
1633 if (result.isScalar() && resultType->isVoidType()) {
1634 // No jumps required if the message-send was noreturn.
1635 if (contBB) CGF.EmitBlock(contBB);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001636 return result;
1637 }
1638
John McCall3d1e2c92013-02-12 05:53:35 +00001639 // If we've got a scalar return, build a phi.
1640 if (result.isScalar()) {
1641 // Derive the null-initialization value.
1642 llvm::Constant *null = CGF.CGM.EmitNullConstant(resultType);
1643
1644 // If no join is necessary, just flow out.
1645 if (!contBB) return RValue::get(null);
1646
1647 // Otherwise, build a phi.
1648 CGF.EmitBlock(contBB);
1649 llvm::PHINode *phi = CGF.Builder.CreatePHI(null->getType(), 2);
1650 phi->addIncoming(result.getScalarVal(), callBB);
1651 phi->addIncoming(null, NullBB);
1652 return RValue::get(phi);
1653 }
1654
1655 // If we've got an aggregate return, null the buffer out.
1656 // FIXME: maybe we should be doing things differently for all the
1657 // cases where the ABI has us returning (1) non-agg values in
1658 // memory or (2) agg values in registers.
1659 if (result.isAggregate()) {
1660 assert(result.isAggregate() && "null init of non-aggregate result?");
John McCall7f416cc2015-09-08 08:05:57 +00001661 CGF.EmitNullInitialization(result.getAggregateAddress(), resultType);
John McCall3d1e2c92013-02-12 05:53:35 +00001662 if (contBB) CGF.EmitBlock(contBB);
1663 return result;
1664 }
1665
1666 // Complex types.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001667 CGF.EmitBlock(contBB);
John McCall3d1e2c92013-02-12 05:53:35 +00001668 CodeGenFunction::ComplexPairTy callResult = result.getComplexVal();
1669
1670 // Find the scalar type and its zero value.
1671 llvm::Type *scalarTy = callResult.first->getType();
1672 llvm::Constant *scalarZero = llvm::Constant::getNullValue(scalarTy);
1673
1674 // Build phis for both coordinates.
1675 llvm::PHINode *real = CGF.Builder.CreatePHI(scalarTy, 2);
1676 real->addIncoming(callResult.first, callBB);
1677 real->addIncoming(scalarZero, NullBB);
1678 llvm::PHINode *imag = CGF.Builder.CreatePHI(scalarTy, 2);
1679 imag->addIncoming(callResult.second, callBB);
1680 imag->addIncoming(scalarZero, NullBB);
1681 return RValue::getComplex(real, imag);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001682 }
1683};
1684
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001685} // end anonymous namespace
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001686
1687/* *** Helper Functions *** */
1688
1689/// getConstantGEP() - Help routine to construct simple GEPs.
Owen Anderson170229f2009-07-14 23:10:40 +00001690static llvm::Constant *getConstantGEP(llvm::LLVMContext &VMContext,
David Blaikiee3b172a2015-04-02 18:55:21 +00001691 llvm::GlobalVariable *C, unsigned idx0,
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001692 unsigned idx1) {
1693 llvm::Value *Idxs[] = {
Owen Anderson41a75022009-08-13 21:57:51 +00001694 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx0),
1695 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx1)
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001696 };
David Blaikiee3b172a2015-04-02 18:55:21 +00001697 return llvm::ConstantExpr::getGetElementPtr(C->getValueType(), C, Idxs);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001698}
1699
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001700/// hasObjCExceptionAttribute - Return true if this class or any super
1701/// class has the __objc_exception__ attribute.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001702static bool hasObjCExceptionAttribute(ASTContext &Context,
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001703 const ObjCInterfaceDecl *OID) {
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001704 if (OID->hasAttr<ObjCExceptionAttr>())
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001705 return true;
1706 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001707 return hasObjCExceptionAttribute(Context, Super);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001708 return false;
1709}
1710
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001711/* *** CGObjCMac Public Interface *** */
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001712
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001713CGObjCMac::CGObjCMac(CodeGen::CodeGenModule &cgm) : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00001714 ObjCTypes(cgm) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001715 ObjCABI = 1;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001716 EmitImageInfo();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001717}
1718
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001719/// GetClass - Return a reference to the class for the given interface
1720/// decl.
John McCall882987f2013-02-28 19:01:20 +00001721llvm::Value *CGObjCMac::GetClass(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001722 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00001723 return EmitClassRef(CGF, ID);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001724}
1725
1726/// GetSelector - Return the pointer to the unique'd string for this selector.
John McCall7f416cc2015-09-08 08:05:57 +00001727llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1728 return EmitSelector(CGF, Sel);
1729}
1730Address CGObjCMac::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1731 return EmitSelectorAddr(CGF, Sel);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001732}
John McCall882987f2013-02-28 19:01:20 +00001733llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, const ObjCMethodDecl
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001734 *Method) {
John McCall882987f2013-02-28 19:01:20 +00001735 return EmitSelector(CGF, Method->getSelector());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001736}
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001737
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001738llvm::Constant *CGObjCMac::GetEHType(QualType T) {
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001739 if (T->isObjCIdType() ||
1740 T->isObjCQualifiedIdType()) {
1741 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001742 CGM.getContext().getObjCIdRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001743 }
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001744 if (T->isObjCClassType() ||
1745 T->isObjCQualifiedClassType()) {
1746 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001747 CGM.getContext().getObjCClassRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001748 }
1749 if (T->isObjCObjectPointerType())
1750 return CGM.GetAddrOfRTTIDescriptor(T, /*ForEH=*/true);
1751
John McCall2ca705e2010-07-24 00:37:23 +00001752 llvm_unreachable("asking for catch type for ObjC type in fragile runtime");
John McCall2ca705e2010-07-24 00:37:23 +00001753}
1754
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001755/// Generate a constant CFString object.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001756/*
1757 struct __builtin_CFString {
1758 const int *isa; // point to __CFConstantStringClassReference
1759 int flags;
1760 const char *str;
1761 long length;
1762 };
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001763*/
1764
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001765/// or Generate a constant NSString object.
1766/*
1767 struct __builtin_NSString {
1768 const int *isa; // point to __NSConstantStringClassReference
1769 const char *str;
1770 unsigned int length;
1771 };
1772*/
1773
John McCall7f416cc2015-09-08 08:05:57 +00001774ConstantAddress CGObjCCommonMac::GenerateConstantString(
David Chisnall481e3a82010-01-23 02:40:42 +00001775 const StringLiteral *SL) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001776 return (CGM.getLangOpts().NoConstantCFStrings == 0 ?
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001777 CGM.GetAddrOfConstantCFString(SL) :
Fariborz Jahanian50c925f2010-10-19 17:19:29 +00001778 CGM.GetAddrOfConstantString(SL));
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001779}
1780
Ted Kremeneke65b0862012-03-06 20:05:56 +00001781enum {
1782 kCFTaggedObjectID_Integer = (1 << 1) + 1
1783};
1784
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001785/// Generates a message send where the super is the receiver. This is
1786/// a message send to self with special delivery semantics indicating
1787/// which class's method should be called.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001788CodeGen::RValue
1789CGObjCMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001790 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001791 QualType ResultType,
1792 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001793 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001794 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001795 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001796 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001797 const CodeGen::CallArgList &CallArgs,
1798 const ObjCMethodDecl *Method) {
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001799 // Create and init a super structure; this is a (receiver, class)
1800 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00001801 Address ObjCSuper =
1802 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
1803 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001804 llvm::Value *ReceiverAsObject =
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001805 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00001806 CGF.Builder.CreateStore(
1807 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00001808 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001809
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001810 // If this is a class message the metaclass is passed as the target.
1811 llvm::Value *Target;
1812 if (IsClassMessage) {
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001813 if (isCategoryImpl) {
1814 // Message sent to 'super' in a class method defined in a category
1815 // implementation requires an odd treatment.
1816 // If we are in a class method, we must retrieve the
1817 // _metaclass_ for the current class, pointed at by
1818 // the class's "isa" pointer. The following assumes that
1819 // isa" is the first ivar in a class (which it must be).
John McCall882987f2013-02-28 19:01:20 +00001820 Target = EmitClassRef(CGF, Class->getSuperClass());
David Blaikie1ed728c2015-04-05 22:45:47 +00001821 Target = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, Target, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001822 Target = CGF.Builder.CreateAlignedLoad(Target, CGF.getPointerAlign());
Mike Stump658fe022009-07-30 22:28:39 +00001823 } else {
David Blaikie1ed728c2015-04-05 22:45:47 +00001824 llvm::Constant *MetaClassPtr = EmitMetaClassRef(Class);
1825 llvm::Value *SuperPtr =
1826 CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, MetaClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001827 llvm::Value *Super =
1828 CGF.Builder.CreateAlignedLoad(SuperPtr, CGF.getPointerAlign());
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001829 Target = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001830 }
David Blaikie1ed728c2015-04-05 22:45:47 +00001831 } else if (isCategoryImpl)
John McCall882987f2013-02-28 19:01:20 +00001832 Target = EmitClassRef(CGF, Class->getSuperClass());
Fariborz Jahanianda2efb02009-11-14 02:18:31 +00001833 else {
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001834 llvm::Value *ClassPtr = EmitSuperClassRef(Class);
David Blaikie1ed728c2015-04-05 22:45:47 +00001835 ClassPtr = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, ClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001836 Target = CGF.Builder.CreateAlignedLoad(ClassPtr, CGF.getPointerAlign());
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001837 }
Mike Stump18bb9282009-05-16 07:57:57 +00001838 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
1839 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00001840 llvm::Type *ClassTy =
Daniel Dunbarc722b852008-08-30 03:02:31 +00001841 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
Daniel Dunbarc475d422008-10-29 22:36:39 +00001842 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
John McCall7f416cc2015-09-08 08:05:57 +00001843 CGF.Builder.CreateStore(Target,
1844 CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
John McCall9e8bb002011-05-14 03:10:52 +00001845 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001846 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00001847 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00001848 true, CallArgs, Method, Class, ObjCTypes);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001849}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001850
1851/// Generate code for a message send expression.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001852CodeGen::RValue CGObjCMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001853 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001854 QualType ResultType,
1855 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001856 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001857 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00001858 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001859 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00001860 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001861 EmitSelector(CGF, Sel),
John McCall9e8bb002011-05-14 03:10:52 +00001862 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00001863 false, CallArgs, Method, Class, ObjCTypes);
1864}
1865
1866static bool isWeakLinkedClass(const ObjCInterfaceDecl *ID) {
1867 do {
1868 if (ID->isWeakImported())
1869 return true;
1870 } while ((ID = ID->getSuperClass()));
1871
1872 return false;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00001873}
1874
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001875CodeGen::RValue
John McCall9e8bb002011-05-14 03:10:52 +00001876CGObjCCommonMac::EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1877 ReturnValueSlot Return,
1878 QualType ResultType,
1879 llvm::Value *Sel,
1880 llvm::Value *Arg0,
1881 QualType Arg0Ty,
1882 bool IsSuper,
1883 const CallArgList &CallArgs,
1884 const ObjCMethodDecl *Method,
John McCall1e3157b2015-09-10 22:27:50 +00001885 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001886 const ObjCCommonTypesHelper &ObjCTypes) {
Daniel Dunbarc722b852008-08-30 03:02:31 +00001887 CallArgList ActualArgs;
Fariborz Jahanian969bc682009-04-24 21:07:43 +00001888 if (!IsSuper)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001889 Arg0 = CGF.Builder.CreateBitCast(Arg0, ObjCTypes.ObjectPtrTy);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001890 ActualArgs.add(RValue::get(Arg0), Arg0Ty);
1891 ActualArgs.add(RValue::get(Sel), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001892 ActualArgs.addFrom(CallArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001893
John McCalla729c622012-02-17 03:33:10 +00001894 // If we're calling a method, use the formal signature.
1895 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001896
Anders Carlsson280e61f12010-06-21 20:59:55 +00001897 if (Method)
Alp Toker314cc812014-01-25 16:55:45 +00001898 assert(CGM.getContext().getCanonicalType(Method->getReturnType()) ==
1899 CGM.getContext().getCanonicalType(ResultType) &&
Anders Carlsson280e61f12010-06-21 20:59:55 +00001900 "Result type mismatch!");
1901
John McCall1e3157b2015-09-10 22:27:50 +00001902 bool ReceiverCanBeNull = true;
1903
1904 // Super dispatch assumes that self is non-null; even the messenger
1905 // doesn't have a null check internally.
1906 if (IsSuper) {
1907 ReceiverCanBeNull = false;
1908
1909 // If this is a direct dispatch of a class method, check whether the class,
1910 // or anything in its hierarchy, was weak-linked.
1911 } else if (ClassReceiver && Method && Method->isClassMethod()) {
1912 ReceiverCanBeNull = isWeakLinkedClass(ClassReceiver);
1913
1914 // If we're emitting a method, and self is const (meaning just ARC, for now),
1915 // and the receiver is a load of self, then self is a valid object.
1916 } else if (auto CurMethod =
1917 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl)) {
1918 auto Self = CurMethod->getSelfDecl();
1919 if (Self->getType().isConstQualified()) {
1920 if (auto LI = dyn_cast<llvm::LoadInst>(Arg0->stripPointerCasts())) {
1921 llvm::Value *SelfAddr = CGF.GetAddrOfLocalVar(Self).getPointer();
1922 if (SelfAddr == LI->getPointerOperand()) {
1923 ReceiverCanBeNull = false;
1924 }
1925 }
1926 }
1927 }
1928
John McCall5880fb82011-05-14 21:12:11 +00001929 NullReturnState nullReturn;
1930
Craig Topper8a13c412014-05-21 05:09:00 +00001931 llvm::Constant *Fn = nullptr;
Tim Northovere77cc392014-03-29 13:28:05 +00001932 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall1e3157b2015-09-10 22:27:50 +00001933 if (ReceiverCanBeNull) nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001934 Fn = (ObjCABI == 2) ? ObjCTypes.getSendStretFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001935 : ObjCTypes.getSendStretFn(IsSuper);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001936 } else if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1937 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFpretFn2(IsSuper)
1938 : ObjCTypes.getSendFpretFn(IsSuper);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001939 } else if (CGM.ReturnTypeUsesFP2Ret(ResultType)) {
1940 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFp2RetFn2(IsSuper)
1941 : ObjCTypes.getSendFp2retFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001942 } else {
Tim Northovere77cc392014-03-29 13:28:05 +00001943 // arm64 uses objc_msgSend for stret methods and yet null receiver check
1944 // must be made for it.
Ahmed Bougachaa3df87b2015-10-02 22:41:59 +00001945 if (ReceiverCanBeNull && CGM.ReturnTypeUsesSRet(MSI.CallInfo))
Tim Northovere77cc392014-03-29 13:28:05 +00001946 nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001947 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001948 : ObjCTypes.getSendFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001949 }
John McCall1e3157b2015-09-10 22:27:50 +00001950
1951 // Emit a null-check if there's a consumed argument other than the receiver.
1952 bool RequiresNullCheck = false;
1953 if (ReceiverCanBeNull && CGM.getLangOpts().ObjCAutoRefCount && Method) {
Aaron Ballman43b68be2014-03-07 17:50:17 +00001954 for (const auto *ParamDecl : Method->params()) {
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001955 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1956 if (!nullReturn.NullBB)
1957 nullReturn.init(CGF, Arg0);
John McCall1e3157b2015-09-10 22:27:50 +00001958 RequiresNullCheck = true;
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001959 break;
1960 }
1961 }
John McCall1e3157b2015-09-10 22:27:50 +00001962 }
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001963
John McCall1e3157b2015-09-10 22:27:50 +00001964 llvm::Instruction *CallSite;
John McCalla729c622012-02-17 03:33:10 +00001965 Fn = llvm::ConstantExpr::getBitCast(Fn, MSI.MessengerType);
John McCall1e3157b2015-09-10 22:27:50 +00001966 RValue rvalue = CGF.EmitCall(MSI.CallInfo, Fn, Return, ActualArgs,
Samuel Antao798f11c2015-11-23 22:04:44 +00001967 CGCalleeInfo(), &CallSite);
John McCall1e3157b2015-09-10 22:27:50 +00001968
1969 // Mark the call as noreturn if the method is marked noreturn and the
1970 // receiver cannot be null.
1971 if (Method && Method->hasAttr<NoReturnAttr>() && !ReceiverCanBeNull) {
1972 llvm::CallSite(CallSite).setDoesNotReturn();
1973 }
1974
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001975 return nullReturn.complete(CGF, rvalue, ResultType, CallArgs,
John McCall1e3157b2015-09-10 22:27:50 +00001976 RequiresNullCheck ? Method : nullptr);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001977}
1978
John McCall3fd13f062015-10-21 18:06:47 +00001979static Qualifiers::GC GetGCAttrTypeForType(ASTContext &Ctx, QualType FQT,
1980 bool pointee = false) {
1981 // Note that GC qualification applies recursively to C pointer types
1982 // that aren't otherwise decorated. This is weird, but it's probably
1983 // an intentional workaround to the unreliable placement of GC qualifiers.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001984 if (FQT.isObjCGCStrong())
1985 return Qualifiers::Strong;
John McCall3fd13f062015-10-21 18:06:47 +00001986
1987 if (FQT.isObjCGCWeak())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001988 return Qualifiers::Weak;
John McCall3fd13f062015-10-21 18:06:47 +00001989
1990 if (auto ownership = FQT.getObjCLifetime()) {
1991 // Ownership does not apply recursively to C pointer types.
1992 if (pointee) return Qualifiers::GCNone;
1993 switch (ownership) {
1994 case Qualifiers::OCL_Weak: return Qualifiers::Weak;
1995 case Qualifiers::OCL_Strong: return Qualifiers::Strong;
1996 case Qualifiers::OCL_ExplicitNone: return Qualifiers::GCNone;
1997 case Qualifiers::OCL_Autoreleasing: llvm_unreachable("autoreleasing ivar?");
1998 case Qualifiers::OCL_None: llvm_unreachable("known nonzero");
1999 }
2000 llvm_unreachable("bad objc ownership");
2001 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002002
John McCall3fd13f062015-10-21 18:06:47 +00002003 // Treat unqualified retainable pointers as strong.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002004 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
2005 return Qualifiers::Strong;
2006
John McCall3fd13f062015-10-21 18:06:47 +00002007 // Walk into C pointer types, but only in GC.
2008 if (Ctx.getLangOpts().getGC() != LangOptions::NonGC) {
2009 if (const PointerType *PT = FQT->getAs<PointerType>())
2010 return GetGCAttrTypeForType(Ctx, PT->getPointeeType(), /*pointee*/ true);
2011 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002012
2013 return Qualifiers::GCNone;
2014}
2015
John McCall3fd13f062015-10-21 18:06:47 +00002016namespace {
2017 struct IvarInfo {
2018 CharUnits Offset;
2019 uint64_t SizeInWords;
2020 IvarInfo(CharUnits offset, uint64_t sizeInWords)
2021 : Offset(offset), SizeInWords(sizeInWords) {}
2022
2023 // Allow sorting based on byte pos.
2024 bool operator<(const IvarInfo &other) const {
2025 return Offset < other.Offset;
2026 }
2027 };
2028
2029 /// A helper class for building GC layout strings.
2030 class IvarLayoutBuilder {
2031 CodeGenModule &CGM;
2032
2033 /// The start of the layout. Offsets will be relative to this value,
2034 /// and entries less than this value will be silently discarded.
2035 CharUnits InstanceBegin;
2036
2037 /// The end of the layout. Offsets will never exceed this value.
2038 CharUnits InstanceEnd;
2039
2040 /// Whether we're generating the strong layout or the weak layout.
2041 bool ForStrongLayout;
2042
2043 /// Whether the offsets in IvarsInfo might be out-of-order.
2044 bool IsDisordered = false;
2045
2046 llvm::SmallVector<IvarInfo, 8> IvarsInfo;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002047
John McCall3fd13f062015-10-21 18:06:47 +00002048 public:
2049 IvarLayoutBuilder(CodeGenModule &CGM, CharUnits instanceBegin,
2050 CharUnits instanceEnd, bool forStrongLayout)
2051 : CGM(CGM), InstanceBegin(instanceBegin), InstanceEnd(instanceEnd),
2052 ForStrongLayout(forStrongLayout) {
2053 }
2054
2055 void visitRecord(const RecordType *RT, CharUnits offset);
2056
2057 template <class Iterator, class GetOffsetFn>
2058 void visitAggregate(Iterator begin, Iterator end,
2059 CharUnits aggrOffset,
2060 const GetOffsetFn &getOffset);
2061
2062 void visitField(const FieldDecl *field, CharUnits offset);
2063
2064 /// Add the layout of a block implementation.
2065 void visitBlock(const CGBlockInfo &blockInfo);
2066
2067 /// Is there any information for an interesting bitmap?
2068 bool hasBitmapData() const { return !IvarsInfo.empty(); }
2069
2070 llvm::Constant *buildBitmap(CGObjCCommonMac &CGObjC,
2071 llvm::SmallVectorImpl<unsigned char> &buffer);
2072
2073 static void dump(ArrayRef<unsigned char> buffer) {
2074 const unsigned char *s = buffer.data();
2075 for (unsigned i = 0, e = buffer.size(); i < e; i++)
2076 if (!(s[i] & 0xf0))
2077 printf("0x0%x%s", s[i], s[i] != 0 ? ", " : "");
2078 else
2079 printf("0x%x%s", s[i], s[i] != 0 ? ", " : "");
2080 printf("\n");
2081 }
2082 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002083} // end anonymous namespace
John McCall3fd13f062015-10-21 18:06:47 +00002084
John McCall351762c2011-02-07 10:33:21 +00002085llvm::Constant *CGObjCCommonMac::BuildGCBlockLayout(CodeGenModule &CGM,
2086 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002087
Chris Lattnerece04092012-02-07 00:39:47 +00002088 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
John McCall460ce582015-10-22 18:38:17 +00002089 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
John McCall351762c2011-02-07 10:33:21 +00002090 return nullPtr;
2091
John McCall3fd13f062015-10-21 18:06:47 +00002092 IvarLayoutBuilder builder(CGM, CharUnits::Zero(), blockInfo.BlockSize,
2093 /*for strong layout*/ true);
2094
2095 builder.visitBlock(blockInfo);
2096
2097 if (!builder.hasBitmapData())
2098 return nullPtr;
2099
2100 llvm::SmallVector<unsigned char, 32> buffer;
2101 llvm::Constant *C = builder.buildBitmap(*this, buffer);
John McCallf5ea0722015-10-29 23:36:14 +00002102 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
John McCall3fd13f062015-10-21 18:06:47 +00002103 printf("\n block variable layout for block: ");
2104 builder.dump(buffer);
2105 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002106
John McCall3fd13f062015-10-21 18:06:47 +00002107 return C;
2108}
2109
2110void IvarLayoutBuilder::visitBlock(const CGBlockInfo &blockInfo) {
Fariborz Jahaniancfddabf2010-09-09 00:21:45 +00002111 // __isa is the first field in block descriptor and must assume by runtime's
2112 // convention that it is GC'able.
John McCall3fd13f062015-10-21 18:06:47 +00002113 IvarsInfo.push_back(IvarInfo(CharUnits::Zero(), 1));
John McCall351762c2011-02-07 10:33:21 +00002114
2115 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2116
John McCall351762c2011-02-07 10:33:21 +00002117 // Ignore the optional 'this' capture: C++ objects are not assumed
2118 // to be GC'ed.
2119
John McCall3fd13f062015-10-21 18:06:47 +00002120 CharUnits lastFieldOffset;
2121
John McCall351762c2011-02-07 10:33:21 +00002122 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002123 for (const auto &CI : blockDecl->captures()) {
2124 const VarDecl *variable = CI.getVariable();
John McCall351762c2011-02-07 10:33:21 +00002125 QualType type = variable->getType();
2126
2127 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2128
2129 // Ignore constant captures.
2130 if (capture.isConstant()) continue;
2131
John McCall3fd13f062015-10-21 18:06:47 +00002132 CharUnits fieldOffset = capture.getOffset();
2133
2134 // Block fields are not necessarily ordered; if we detect that we're
2135 // adding them out-of-order, make sure we sort later.
2136 if (fieldOffset < lastFieldOffset)
2137 IsDisordered = true;
2138 lastFieldOffset = fieldOffset;
John McCall351762c2011-02-07 10:33:21 +00002139
2140 // __block variables are passed by their descriptor address.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002141 if (CI.isByRef()) {
John McCall3fd13f062015-10-21 18:06:47 +00002142 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
Fariborz Jahanian933c6722010-09-11 01:27:29 +00002143 continue;
John McCall351762c2011-02-07 10:33:21 +00002144 }
2145
2146 assert(!type->isArrayType() && "array variable should not be caught");
2147 if (const RecordType *record = type->getAs<RecordType>()) {
John McCall3fd13f062015-10-21 18:06:47 +00002148 visitRecord(record, fieldOffset);
Fariborz Jahanian903aba32010-08-05 21:00:25 +00002149 continue;
2150 }
Fariborz Jahanianf95e3582010-08-06 16:28:55 +00002151
John McCall351762c2011-02-07 10:33:21 +00002152 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), type);
John McCall351762c2011-02-07 10:33:21 +00002153
John McCall3fd13f062015-10-21 18:06:47 +00002154 if (GCAttr == Qualifiers::Strong) {
2155 assert(CGM.getContext().getTypeSize(type)
2156 == CGM.getTarget().getPointerWidth(0));
2157 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
2158 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002159 }
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00002160}
2161
Fariborz Jahanian2c96d302012-11-04 18:19:40 +00002162/// getBlockCaptureLifetime - This routine returns life time of the captured
2163/// block variable for the purpose of block layout meta-data generation. FQT is
2164/// the type of the variable captured in the block.
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002165Qualifiers::ObjCLifetime CGObjCCommonMac::getBlockCaptureLifetime(QualType FQT,
2166 bool ByrefLayout) {
John McCall460ce582015-10-22 18:38:17 +00002167 // If it has an ownership qualifier, we're done.
2168 if (auto lifetime = FQT.getObjCLifetime())
2169 return lifetime;
2170
2171 // If it doesn't, and this is ARC, it has no ownership.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002172 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall460ce582015-10-22 18:38:17 +00002173 return Qualifiers::OCL_None;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002174
John McCall460ce582015-10-22 18:38:17 +00002175 // In MRC, retainable pointers are owned by non-__block variables.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002176 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002177 return ByrefLayout ? Qualifiers::OCL_ExplicitNone : Qualifiers::OCL_Strong;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002178
2179 return Qualifiers::OCL_None;
2180}
2181
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002182void CGObjCCommonMac::UpdateRunSkipBlockVars(bool IsByref,
2183 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002184 CharUnits FieldOffset,
2185 CharUnits FieldSize) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002186 // __block variables are passed by their descriptor address.
2187 if (IsByref)
2188 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_BYREF, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002189 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002190 else if (LifeTime == Qualifiers::OCL_Strong)
2191 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_STRONG, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002192 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002193 else if (LifeTime == Qualifiers::OCL_Weak)
2194 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_WEAK, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002195 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002196 else if (LifeTime == Qualifiers::OCL_ExplicitNone)
2197 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_UNRETAINED, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002198 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002199 else
2200 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_NON_OBJECT_BYTES,
2201 FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002202 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002203}
2204
2205void CGObjCCommonMac::BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
2206 const RecordDecl *RD,
2207 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002208 CharUnits BytePos, bool &HasUnion,
2209 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002210 bool IsUnion = (RD && RD->isUnion());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002211 CharUnits MaxUnionSize = CharUnits::Zero();
Craig Topper8a13c412014-05-21 05:09:00 +00002212 const FieldDecl *MaxField = nullptr;
2213 const FieldDecl *LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002214 CharUnits MaxFieldOffset = CharUnits::Zero();
2215 CharUnits LastBitfieldOrUnnamedOffset = CharUnits::Zero();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002216
2217 if (RecFields.empty())
2218 return;
John McCallc8e01702013-04-16 22:48:15 +00002219 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002220
2221 for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
2222 const FieldDecl *Field = RecFields[i];
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002223 // Note that 'i' here is actually the field index inside RD of Field,
2224 // although this dependency is hidden.
2225 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002226 CharUnits FieldOffset =
2227 CGM.getContext().toCharUnitsFromBits(RL.getFieldOffset(i));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002228
2229 // Skip over unnamed or bitfields
2230 if (!Field->getIdentifier() || Field->isBitField()) {
2231 LastFieldBitfieldOrUnnamed = Field;
2232 LastBitfieldOrUnnamedOffset = FieldOffset;
2233 continue;
2234 }
Craig Topper8a13c412014-05-21 05:09:00 +00002235
2236 LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002237 QualType FQT = Field->getType();
2238 if (FQT->isRecordType() || FQT->isUnionType()) {
2239 if (FQT->isUnionType())
2240 HasUnion = true;
2241
2242 BuildRCBlockVarRecordLayout(FQT->getAs<RecordType>(),
2243 BytePos + FieldOffset, HasUnion);
2244 continue;
2245 }
2246
2247 if (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2248 const ConstantArrayType *CArray =
2249 dyn_cast_or_null<ConstantArrayType>(Array);
2250 uint64_t ElCount = CArray->getSize().getZExtValue();
2251 assert(CArray && "only array with known element size is supported");
2252 FQT = CArray->getElementType();
2253 while (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2254 const ConstantArrayType *CArray =
2255 dyn_cast_or_null<ConstantArrayType>(Array);
2256 ElCount *= CArray->getSize().getZExtValue();
2257 FQT = CArray->getElementType();
2258 }
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002259 if (FQT->isRecordType() && ElCount) {
2260 int OldIndex = RunSkipBlockVars.size() - 1;
2261 const RecordType *RT = FQT->getAs<RecordType>();
2262 BuildRCBlockVarRecordLayout(RT, BytePos + FieldOffset,
2263 HasUnion);
2264
2265 // Replicate layout information for each array element. Note that
2266 // one element is already done.
2267 uint64_t ElIx = 1;
2268 for (int FirstIndex = RunSkipBlockVars.size() - 1 ;ElIx < ElCount; ElIx++) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002269 CharUnits Size = CGM.getContext().getTypeSizeInChars(RT);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002270 for (int i = OldIndex+1; i <= FirstIndex; ++i)
2271 RunSkipBlockVars.push_back(
2272 RUN_SKIP(RunSkipBlockVars[i].opcode,
2273 RunSkipBlockVars[i].block_var_bytepos + Size*ElIx,
2274 RunSkipBlockVars[i].block_var_size));
2275 }
2276 continue;
2277 }
2278 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002279 CharUnits FieldSize = CGM.getContext().getTypeSizeInChars(Field->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002280 if (IsUnion) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002281 CharUnits UnionIvarSize = FieldSize;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002282 if (UnionIvarSize > MaxUnionSize) {
2283 MaxUnionSize = UnionIvarSize;
2284 MaxField = Field;
2285 MaxFieldOffset = FieldOffset;
2286 }
2287 } else {
2288 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002289 getBlockCaptureLifetime(FQT, ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002290 BytePos + FieldOffset,
2291 FieldSize);
2292 }
2293 }
2294
2295 if (LastFieldBitfieldOrUnnamed) {
2296 if (LastFieldBitfieldOrUnnamed->isBitField()) {
2297 // Last field was a bitfield. Must update the info.
2298 uint64_t BitFieldSize
2299 = LastFieldBitfieldOrUnnamed->getBitWidthValue(CGM.getContext());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002300 unsigned UnsSize = (BitFieldSize / ByteSizeInBits) +
Eli Friedman8cbca202012-11-06 22:15:52 +00002301 ((BitFieldSize % ByteSizeInBits) != 0);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002302 CharUnits Size = CharUnits::fromQuantity(UnsSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002303 Size += LastBitfieldOrUnnamedOffset;
2304 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002305 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2306 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002307 BytePos + LastBitfieldOrUnnamedOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002308 Size);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002309 } else {
2310 assert(!LastFieldBitfieldOrUnnamed->getIdentifier() &&"Expected unnamed");
2311 // Last field was unnamed. Must update skip info.
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002312 CharUnits FieldSize
2313 = CGM.getContext().getTypeSizeInChars(LastFieldBitfieldOrUnnamed->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002314 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002315 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2316 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002317 BytePos + LastBitfieldOrUnnamedOffset,
2318 FieldSize);
2319 }
2320 }
2321
2322 if (MaxField)
2323 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002324 getBlockCaptureLifetime(MaxField->getType(), ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002325 BytePos + MaxFieldOffset,
2326 MaxUnionSize);
2327}
2328
2329void CGObjCCommonMac::BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002330 CharUnits BytePos,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002331 bool &HasUnion,
2332 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002333 const RecordDecl *RD = RT->getDecl();
Aaron Ballman62e47c42014-03-10 13:43:55 +00002334 SmallVector<const FieldDecl*, 16> Fields(RD->fields());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002335 llvm::Type *Ty = CGM.getTypes().ConvertType(QualType(RT, 0));
2336 const llvm::StructLayout *RecLayout =
2337 CGM.getDataLayout().getStructLayout(cast<llvm::StructType>(Ty));
2338
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002339 BuildRCRecordLayout(RecLayout, RD, Fields, BytePos, HasUnion, ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002340}
2341
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002342/// InlineLayoutInstruction - This routine produce an inline instruction for the
2343/// block variable layout if it can. If not, it returns 0. Rules are as follow:
2344/// If ((uintptr_t) layout) < (1 << 12), the layout is inline. In the 64bit world,
2345/// an inline layout of value 0x0000000000000xyz is interpreted as follows:
2346/// x captured object pointers of BLOCK_LAYOUT_STRONG. Followed by
2347/// y captured object of BLOCK_LAYOUT_BYREF. Followed by
2348/// z captured object of BLOCK_LAYOUT_WEAK. If any of the above is missing, zero
2349/// replaces it. For example, 0x00000x00 means x BLOCK_LAYOUT_STRONG and no
2350/// BLOCK_LAYOUT_BYREF and no BLOCK_LAYOUT_WEAK objects are captured.
2351uint64_t CGObjCCommonMac::InlineLayoutInstruction(
2352 SmallVectorImpl<unsigned char> &Layout) {
2353 uint64_t Result = 0;
2354 if (Layout.size() <= 3) {
2355 unsigned size = Layout.size();
2356 unsigned strong_word_count = 0, byref_word_count=0, weak_word_count=0;
2357 unsigned char inst;
2358 enum BLOCK_LAYOUT_OPCODE opcode ;
2359 switch (size) {
2360 case 3:
2361 inst = Layout[0];
2362 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2363 if (opcode == BLOCK_LAYOUT_STRONG)
2364 strong_word_count = (inst & 0xF)+1;
2365 else
2366 return 0;
2367 inst = Layout[1];
2368 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2369 if (opcode == BLOCK_LAYOUT_BYREF)
2370 byref_word_count = (inst & 0xF)+1;
2371 else
2372 return 0;
2373 inst = Layout[2];
2374 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2375 if (opcode == BLOCK_LAYOUT_WEAK)
2376 weak_word_count = (inst & 0xF)+1;
2377 else
2378 return 0;
2379 break;
2380
2381 case 2:
2382 inst = Layout[0];
2383 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2384 if (opcode == BLOCK_LAYOUT_STRONG) {
2385 strong_word_count = (inst & 0xF)+1;
2386 inst = Layout[1];
2387 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2388 if (opcode == BLOCK_LAYOUT_BYREF)
2389 byref_word_count = (inst & 0xF)+1;
2390 else if (opcode == BLOCK_LAYOUT_WEAK)
2391 weak_word_count = (inst & 0xF)+1;
2392 else
2393 return 0;
2394 }
2395 else if (opcode == BLOCK_LAYOUT_BYREF) {
2396 byref_word_count = (inst & 0xF)+1;
2397 inst = Layout[1];
2398 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2399 if (opcode == BLOCK_LAYOUT_WEAK)
2400 weak_word_count = (inst & 0xF)+1;
2401 else
2402 return 0;
2403 }
2404 else
2405 return 0;
2406 break;
2407
2408 case 1:
2409 inst = Layout[0];
2410 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2411 if (opcode == BLOCK_LAYOUT_STRONG)
2412 strong_word_count = (inst & 0xF)+1;
2413 else if (opcode == BLOCK_LAYOUT_BYREF)
2414 byref_word_count = (inst & 0xF)+1;
2415 else if (opcode == BLOCK_LAYOUT_WEAK)
2416 weak_word_count = (inst & 0xF)+1;
2417 else
2418 return 0;
2419 break;
2420
2421 default:
2422 return 0;
2423 }
2424
2425 // Cannot inline when any of the word counts is 15. Because this is one less
2426 // than the actual work count (so 15 means 16 actual word counts),
2427 // and we can only display 0 thru 15 word counts.
2428 if (strong_word_count == 16 || byref_word_count == 16 || weak_word_count == 16)
2429 return 0;
2430
2431 unsigned count =
2432 (strong_word_count != 0) + (byref_word_count != 0) + (weak_word_count != 0);
2433
2434 if (size == count) {
2435 if (strong_word_count)
2436 Result = strong_word_count;
2437 Result <<= 4;
2438 if (byref_word_count)
2439 Result += byref_word_count;
2440 Result <<= 4;
2441 if (weak_word_count)
2442 Result += weak_word_count;
2443 }
2444 }
2445 return Result;
2446}
2447
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002448llvm::Constant *CGObjCCommonMac::getBitmapBlockLayout(bool ComputeByrefLayout) {
2449 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2450 if (RunSkipBlockVars.empty())
2451 return nullPtr;
John McCallc8e01702013-04-16 22:48:15 +00002452 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2453 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002454 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2455
2456 // Sort on byte position; captures might not be allocated in order,
2457 // and unions can do funny things.
2458 llvm::array_pod_sort(RunSkipBlockVars.begin(), RunSkipBlockVars.end());
2459 SmallVector<unsigned char, 16> Layout;
2460
2461 unsigned size = RunSkipBlockVars.size();
2462 for (unsigned i = 0; i < size; i++) {
2463 enum BLOCK_LAYOUT_OPCODE opcode = RunSkipBlockVars[i].opcode;
2464 CharUnits start_byte_pos = RunSkipBlockVars[i].block_var_bytepos;
2465 CharUnits end_byte_pos = start_byte_pos;
2466 unsigned j = i+1;
2467 while (j < size) {
2468 if (opcode == RunSkipBlockVars[j].opcode) {
2469 end_byte_pos = RunSkipBlockVars[j++].block_var_bytepos;
2470 i++;
2471 }
2472 else
2473 break;
2474 }
2475 CharUnits size_in_bytes =
2476 end_byte_pos - start_byte_pos + RunSkipBlockVars[j-1].block_var_size;
2477 if (j < size) {
2478 CharUnits gap =
2479 RunSkipBlockVars[j].block_var_bytepos -
2480 RunSkipBlockVars[j-1].block_var_bytepos - RunSkipBlockVars[j-1].block_var_size;
2481 size_in_bytes += gap;
2482 }
2483 CharUnits residue_in_bytes = CharUnits::Zero();
2484 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES) {
2485 residue_in_bytes = size_in_bytes % WordSizeInBytes;
2486 size_in_bytes -= residue_in_bytes;
2487 opcode = BLOCK_LAYOUT_NON_OBJECT_WORDS;
2488 }
2489
2490 unsigned size_in_words = size_in_bytes.getQuantity() / WordSizeInBytes;
2491 while (size_in_words >= 16) {
2492 // Note that value in imm. is one less that the actual
2493 // value. So, 0xf means 16 words follow!
2494 unsigned char inst = (opcode << 4) | 0xf;
2495 Layout.push_back(inst);
2496 size_in_words -= 16;
2497 }
2498 if (size_in_words > 0) {
2499 // Note that value in imm. is one less that the actual
2500 // value. So, we subtract 1 away!
2501 unsigned char inst = (opcode << 4) | (size_in_words-1);
2502 Layout.push_back(inst);
2503 }
2504 if (residue_in_bytes > CharUnits::Zero()) {
2505 unsigned char inst =
2506 (BLOCK_LAYOUT_NON_OBJECT_BYTES << 4) | (residue_in_bytes.getQuantity()-1);
2507 Layout.push_back(inst);
2508 }
2509 }
2510
John McCall7f416cc2015-09-08 08:05:57 +00002511 while (!Layout.empty()) {
2512 unsigned char inst = Layout.back();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002513 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2514 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES || opcode == BLOCK_LAYOUT_NON_OBJECT_WORDS)
2515 Layout.pop_back();
2516 else
2517 break;
2518 }
2519
2520 uint64_t Result = InlineLayoutInstruction(Layout);
2521 if (Result != 0) {
2522 // Block variable layout instruction has been inlined.
2523 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2524 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002525 printf("\n Inline BYREF variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002526 else
John McCall7f416cc2015-09-08 08:05:57 +00002527 printf("\n Inline block variable layout: ");
2528 printf("0x0%" PRIx64 "", Result);
2529 if (auto numStrong = (Result & 0xF00) >> 8)
2530 printf(", BL_STRONG:%d", (int) numStrong);
2531 if (auto numByref = (Result & 0x0F0) >> 4)
2532 printf(", BL_BYREF:%d", (int) numByref);
2533 if (auto numWeak = (Result & 0x00F) >> 0)
2534 printf(", BL_WEAK:%d", (int) numWeak);
2535 printf(", BL_OPERATOR:0\n");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002536 }
Vedant Kumar3ed0df02015-12-21 19:43:25 +00002537 return llvm::ConstantInt::get(CGM.IntPtrTy, Result);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002538 }
2539
2540 unsigned char inst = (BLOCK_LAYOUT_OPERATOR << 4) | 0;
2541 Layout.push_back(inst);
2542 std::string BitMap;
2543 for (unsigned i = 0, e = Layout.size(); i != e; i++)
2544 BitMap += Layout[i];
2545
2546 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2547 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002548 printf("\n Byref variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002549 else
John McCall7f416cc2015-09-08 08:05:57 +00002550 printf("\n Block variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002551 for (unsigned i = 0, e = BitMap.size(); i != e; i++) {
2552 unsigned char inst = BitMap[i];
2553 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2554 unsigned delta = 1;
2555 switch (opcode) {
2556 case BLOCK_LAYOUT_OPERATOR:
2557 printf("BL_OPERATOR:");
2558 delta = 0;
2559 break;
2560 case BLOCK_LAYOUT_NON_OBJECT_BYTES:
2561 printf("BL_NON_OBJECT_BYTES:");
2562 break;
2563 case BLOCK_LAYOUT_NON_OBJECT_WORDS:
2564 printf("BL_NON_OBJECT_WORD:");
2565 break;
2566 case BLOCK_LAYOUT_STRONG:
2567 printf("BL_STRONG:");
2568 break;
2569 case BLOCK_LAYOUT_BYREF:
2570 printf("BL_BYREF:");
2571 break;
2572 case BLOCK_LAYOUT_WEAK:
2573 printf("BL_WEAK:");
2574 break;
2575 case BLOCK_LAYOUT_UNRETAINED:
2576 printf("BL_UNRETAINED:");
2577 break;
2578 }
2579 // Actual value of word count is one more that what is in the imm.
2580 // field of the instruction
2581 printf("%d", (inst & 0xf) + delta);
2582 if (i < e-1)
2583 printf(", ");
2584 else
2585 printf("\n");
2586 }
2587 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002588
2589 llvm::GlobalVariable *Entry = CreateMetadataVar(
2590 "OBJC_CLASS_NAME_",
2591 llvm::ConstantDataArray::getString(VMContext, BitMap, false),
John McCall7f416cc2015-09-08 08:05:57 +00002592 "__TEXT,__objc_classname,cstring_literals", CharUnits::One(), true);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002593 return getConstantGEP(VMContext, Entry, 0, 0);
2594}
2595
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002596llvm::Constant *CGObjCCommonMac::BuildRCBlockLayout(CodeGenModule &CGM,
2597 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002598 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2599
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002600 RunSkipBlockVars.clear();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002601 bool hasUnion = false;
2602
John McCallc8e01702013-04-16 22:48:15 +00002603 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2604 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002605 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2606
2607 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2608
2609 // Calculate the basic layout of the block structure.
2610 const llvm::StructLayout *layout =
2611 CGM.getDataLayout().getStructLayout(blockInfo.StructureType);
2612
2613 // Ignore the optional 'this' capture: C++ objects are not assumed
2614 // to be GC'ed.
Fariborz Jahanian4cf177e2012-12-04 17:20:57 +00002615 if (blockInfo.BlockHeaderForcedGapSize != CharUnits::Zero())
2616 UpdateRunSkipBlockVars(false, Qualifiers::OCL_None,
2617 blockInfo.BlockHeaderForcedGapOffset,
2618 blockInfo.BlockHeaderForcedGapSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002619 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002620 for (const auto &CI : blockDecl->captures()) {
2621 const VarDecl *variable = CI.getVariable();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002622 QualType type = variable->getType();
2623
2624 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2625
2626 // Ignore constant captures.
2627 if (capture.isConstant()) continue;
2628
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002629 CharUnits fieldOffset =
2630 CharUnits::fromQuantity(layout->getElementOffset(capture.getIndex()));
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002631
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002632 assert(!type->isArrayType() && "array variable should not be caught");
Aaron Ballman9371dd22014-03-14 18:34:04 +00002633 if (!CI.isByRef())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002634 if (const RecordType *record = type->getAs<RecordType>()) {
2635 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion);
2636 continue;
2637 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002638 CharUnits fieldSize;
Aaron Ballman9371dd22014-03-14 18:34:04 +00002639 if (CI.isByRef())
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002640 fieldSize = CharUnits::fromQuantity(WordSizeInBytes);
2641 else
2642 fieldSize = CGM.getContext().getTypeSizeInChars(type);
Aaron Ballman9371dd22014-03-14 18:34:04 +00002643 UpdateRunSkipBlockVars(CI.isByRef(), getBlockCaptureLifetime(type, false),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002644 fieldOffset, fieldSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002645 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002646 return getBitmapBlockLayout(false);
2647}
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002648
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002649llvm::Constant *CGObjCCommonMac::BuildByrefLayout(CodeGen::CodeGenModule &CGM,
2650 QualType T) {
2651 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2652 assert(!T->isArrayType() && "__block array variable should not be caught");
2653 CharUnits fieldOffset;
2654 RunSkipBlockVars.clear();
2655 bool hasUnion = false;
2656 if (const RecordType *record = T->getAs<RecordType>()) {
2657 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion, true /*ByrefLayout */);
2658 llvm::Constant *Result = getBitmapBlockLayout(true);
Vedant Kumar2f5bb1152015-12-21 20:21:15 +00002659 if (isa<llvm::ConstantInt>(Result))
2660 Result = llvm::ConstantExpr::getIntToPtr(Result, CGM.Int8PtrTy);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002661 return Result;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002662 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002663 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2664 return nullPtr;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002665}
2666
John McCall882987f2013-02-28 19:01:20 +00002667llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00002668 const ObjCProtocolDecl *PD) {
Daniel Dunbar7050c552008-09-04 04:33:15 +00002669 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002670 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar7050c552008-09-04 04:33:15 +00002671 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2672
Owen Andersonade90fd2009-07-29 18:54:39 +00002673 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00002674 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002675}
2676
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002677void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stump18bb9282009-05-16 07:57:57 +00002678 // FIXME: We shouldn't need this, the protocol decl should contain enough
2679 // information to tell us whether this was a declaration or a definition.
Daniel Dunbarc475d422008-10-29 22:36:39 +00002680 DefinedProtocols.insert(PD->getIdentifier());
2681
2682 // If we have generated a forward reference to this protocol, emit
2683 // it now. Otherwise do nothing, the protocol objects are lazily
2684 // emitted.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002685 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbarc475d422008-10-29 22:36:39 +00002686 GetOrEmitProtocol(PD);
2687}
2688
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002689llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002690 if (DefinedProtocols.count(PD->getIdentifier()))
2691 return GetOrEmitProtocol(PD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002692
Daniel Dunbarc475d422008-10-29 22:36:39 +00002693 return GetOrEmitProtocolRef(PD);
2694}
2695
Douglas Gregor24ae22c2016-04-01 23:23:52 +00002696llvm::Value *CGObjCCommonMac::EmitClassRefViaRuntime(
2697 CodeGenFunction &CGF,
2698 const ObjCInterfaceDecl *ID,
2699 ObjCCommonTypesHelper &ObjCTypes) {
2700 llvm::Constant *lookUpClassFn = ObjCTypes.getLookUpClassFn();
2701
2702 llvm::Value *className =
2703 CGF.CGM.GetAddrOfConstantCString(ID->getObjCRuntimeNameAsString())
2704 .getPointer();
2705 ASTContext &ctx = CGF.CGM.getContext();
2706 className =
2707 CGF.Builder.CreateBitCast(className,
2708 CGF.ConvertType(
2709 ctx.getPointerType(ctx.CharTy.withConst())));
2710 llvm::CallInst *call = CGF.Builder.CreateCall(lookUpClassFn, className);
2711 call->setDoesNotThrow();
2712 return call;
2713}
2714
Daniel Dunbarb036db82008-08-13 03:21:16 +00002715/*
Rafael Espindolaf9e1e5e2014-02-20 14:09:04 +00002716// Objective-C 1.0 extensions
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002717struct _objc_protocol {
2718struct _objc_protocol_extension *isa;
2719char *protocol_name;
2720struct _objc_protocol_list *protocol_list;
2721struct _objc__method_prototype_list *instance_methods;
2722struct _objc__method_prototype_list *class_methods
2723};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002724
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002725See EmitProtocolExtension().
Daniel Dunbarb036db82008-08-13 03:21:16 +00002726*/
Daniel Dunbarc475d422008-10-29 22:36:39 +00002727llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00002728 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbarc475d422008-10-29 22:36:39 +00002729
2730 // Early exit if a defining object has already been generated.
2731 if (Entry && Entry->hasInitializer())
2732 return Entry;
2733
Douglas Gregora715bff2012-01-01 19:51:50 +00002734 // Use the protocol definition, if there is one.
2735 if (const ObjCProtocolDecl *Def = PD->getDefinition())
2736 PD = Def;
2737
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002738 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002739 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002740 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2741
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002742 // Construct method lists.
2743 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
2744 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002745 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002746 for (const auto *MD : PD->instance_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002747 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002748 if (!C)
2749 return GetOrEmitProtocolRef(PD);
2750
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002751 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2752 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002753 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002754 } else {
2755 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002756 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002757 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002758 }
2759
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002760 for (const auto *MD : PD->class_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002761 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002762 if (!C)
2763 return GetOrEmitProtocolRef(PD);
2764
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002765 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2766 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002767 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002768 } else {
2769 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002770 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002771 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002772 }
2773
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002774 MethodTypesExt.insert(MethodTypesExt.end(),
2775 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
2776
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002777 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002778 EmitProtocolExtension(PD, OptInstanceMethods, OptClassMethods,
2779 MethodTypesExt),
2780 GetClassName(PD->getObjCRuntimeNameAsString()),
2781 EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
2782 PD->protocol_begin(), PD->protocol_end()),
2783 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_" + PD->getName(),
2784 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2785 InstanceMethods),
2786 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_" + PD->getName(),
2787 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2788 ClassMethods)};
Owen Anderson0e0189d2009-07-27 22:29:56 +00002789 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00002790 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002791
Daniel Dunbarb036db82008-08-13 03:21:16 +00002792 if (Entry) {
Rafael Espindola5d117f32014-03-06 01:10:46 +00002793 // Already created, update the initializer.
Rafael Espindolab3262952014-05-09 00:43:37 +00002794 assert(Entry->hasPrivateLinkage());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002795 Entry->setInitializer(Init);
2796 } else {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002797 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2798 false, llvm::GlobalValue::PrivateLinkage,
2799 Init, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002800 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002801 // FIXME: Is this necessary? Why only for protocol?
2802 Entry->setAlignment(4);
John McCallf9582a72012-03-30 21:29:05 +00002803
2804 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002805 }
Rafael Espindola060062a2014-03-06 22:15:10 +00002806 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbarc475d422008-10-29 22:36:39 +00002807
2808 return Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002809}
2810
Daniel Dunbarc475d422008-10-29 22:36:39 +00002811llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002812 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
2813
2814 if (!Entry) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002815 // We use the initializer as a marker of whether this is a forward
2816 // reference or not. At module finalization we add the empty
2817 // contents for protocols which were referenced but never defined.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002818 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2819 false, llvm::GlobalValue::PrivateLinkage,
2820 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002821 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002822 // FIXME: Is this necessary? Why only for protocol?
2823 Entry->setAlignment(4);
2824 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002825
Daniel Dunbarb036db82008-08-13 03:21:16 +00002826 return Entry;
2827}
2828
2829/*
2830 struct _objc_protocol_extension {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002831 uint32_t size;
2832 struct objc_method_description_list *optional_instance_methods;
2833 struct objc_method_description_list *optional_class_methods;
2834 struct objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002835 const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00002836 struct objc_property_list *class_properties;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002837 };
2838*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002839llvm::Constant *
2840CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002841 ArrayRef<llvm::Constant*> OptInstanceMethods,
2842 ArrayRef<llvm::Constant*> OptClassMethods,
2843 ArrayRef<llvm::Constant*> MethodTypesExt) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002844 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00002845 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002846 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002847 llvm::ConstantInt::get(ObjCTypes.IntTy, Size),
2848 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_OPT_" + PD->getName(),
2849 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2850 OptInstanceMethods),
2851 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_OPT_" + PD->getName(),
2852 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2853 OptClassMethods),
2854 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
Manman Renad0e7912016-01-29 19:22:54 +00002855 ObjCTypes, false),
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002856 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
Manman Rence7bff52016-01-29 23:46:55 +00002857 MethodTypesExt, ObjCTypes),
2858 EmitPropertyList("OBJC_$_CLASS_PROP_PROTO_LIST_" + PD->getName(), nullptr,
2859 PD, ObjCTypes, true)};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002860
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002861 // Return null if no extension bits are used.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002862 if (Values[1]->isNullValue() && Values[2]->isNullValue() &&
Manman Rence7bff52016-01-29 23:46:55 +00002863 Values[3]->isNullValue() && Values[4]->isNullValue() &&
2864 Values[5]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00002865 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002866
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002867 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00002868 llvm::ConstantStruct::get(ObjCTypes.ProtocolExtensionTy, Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002869
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002870 // No special section, but goes in llvm.used
Alp Toker541d5072014-06-07 23:30:53 +00002871 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00002872 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002873}
2874
2875/*
2876 struct objc_protocol_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002877 struct objc_protocol_list *next;
2878 long count;
2879 Protocol *list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00002880 };
2881*/
Daniel Dunbardec75f82008-08-21 21:57:41 +00002882llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002883CGObjCMac::EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00002884 ObjCProtocolDecl::protocol_iterator begin,
2885 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002886 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002887
Daniel Dunbardec75f82008-08-21 21:57:41 +00002888 for (; begin != end; ++begin)
2889 ProtocolRefs.push_back(GetProtocolRef(*begin));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002890
2891 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002892 if (ProtocolRefs.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002893 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002894
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002895 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00002896 ProtocolRefs.push_back(llvm::Constant::getNullValue(ObjCTypes.ProtocolPtrTy));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002897
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002898 llvm::Constant *Values[3];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002899 // This field is only used by the runtime.
Owen Anderson0b75f232009-07-31 20:28:54 +00002900 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002901 Values[1] = llvm::ConstantInt::get(ObjCTypes.LongTy,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002902 ProtocolRefs.size() - 1);
2903 Values[2] =
2904 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolPtrTy,
2905 ProtocolRefs.size()),
Daniel Dunbarb036db82008-08-13 03:21:16 +00002906 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002907
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002908 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002909 llvm::GlobalVariable *GV =
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002910 CreateMetadataVar(Name, Init, "__OBJC,__cat_cls_meth,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00002911 CGM.getPointerAlign(), false);
Owen Andersonade90fd2009-07-29 18:54:39 +00002912 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002913}
2914
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002915void CGObjCCommonMac::
2916PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002917 SmallVectorImpl<llvm::Constant *> &Properties,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002918 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +00002919 const ObjCProtocolDecl *Proto,
Manman Renad0e7912016-01-29 19:22:54 +00002920 const ObjCCommonTypesHelper &ObjCTypes,
2921 bool IsClassProperty) {
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00002922 for (const auto *P : Proto->protocols())
Manman Renad0e7912016-01-29 19:22:54 +00002923 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2924 IsClassProperty);
2925
2926 for (const auto *PD : Proto->properties()) {
2927 if (IsClassProperty != PD->isClassProperty())
2928 continue;
David Blaikie82e95a32014-11-19 07:49:47 +00002929 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002930 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002931 llvm::Constant *Prop[] = {
2932 GetPropertyName(PD->getIdentifier()),
2933 GetPropertyTypeString(PD, Container)
2934 };
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002935 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2936 }
2937}
2938
Daniel Dunbarb036db82008-08-13 03:21:16 +00002939/*
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002940 struct _objc_property {
Bill Wendlinga515b582012-02-09 22:16:49 +00002941 const char * const name;
2942 const char * const attributes;
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002943 };
2944
2945 struct _objc_property_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002946 uint32_t entsize; // sizeof (struct _objc_property)
2947 uint32_t prop_count;
2948 struct _objc_property[prop_count];
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002949 };
2950*/
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002951llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002952 const Decl *Container,
2953 const ObjCContainerDecl *OCD,
Manman Renad0e7912016-01-29 19:22:54 +00002954 const ObjCCommonTypesHelper &ObjCTypes,
2955 bool IsClassProperty) {
Manman Ren01b705e2016-04-19 19:05:03 +00002956 if (IsClassProperty) {
2957 // Make this entry NULL for OS X with deployment target < 10.11, for iOS
2958 // with deployment target < 9.0.
2959 const llvm::Triple &Triple = CGM.getTarget().getTriple();
2960 if ((Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 11)) ||
2961 (Triple.isiOS() && Triple.isOSVersionLT(9)))
2962 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
2963 }
2964
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002965 SmallVector<llvm::Constant *, 16> Properties;
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002966 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weber08c93332015-12-03 17:44:51 +00002967
2968 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2969 llvm::Constant *Prop[] = {GetPropertyName(PD->getIdentifier()),
2970 GetPropertyTypeString(PD, Container)};
2971 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2972 };
2973 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
2974 for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
Manman Renad0e7912016-01-29 19:22:54 +00002975 for (auto *PD : ClassExt->properties()) {
2976 if (IsClassProperty != PD->isClassProperty())
2977 continue;
Nico Weber08c93332015-12-03 17:44:51 +00002978 PropertySet.insert(PD->getIdentifier());
2979 AddProperty(PD);
2980 }
Manman Renad0e7912016-01-29 19:22:54 +00002981
2982 for (const auto *PD : OCD->properties()) {
2983 if (IsClassProperty != PD->isClassProperty())
2984 continue;
Nico Weber08c93332015-12-03 17:44:51 +00002985 // Don't emit duplicate metadata for properties that were already in a
2986 // class extension.
2987 if (!PropertySet.insert(PD->getIdentifier()).second)
2988 continue;
2989 AddProperty(PD);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002990 }
Nico Weber08c93332015-12-03 17:44:51 +00002991
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002992 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Aaron Ballmana9f49e32014-03-13 20:55:22 +00002993 for (const auto *P : OID->all_referenced_protocols())
Manman Renad0e7912016-01-29 19:22:54 +00002994 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2995 IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002996 }
2997 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Aaron Ballman19a41762014-03-14 12:55:57 +00002998 for (const auto *P : CD->protocols())
Manman Renad0e7912016-01-29 19:22:54 +00002999 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
3000 IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003001 }
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003002
3003 // Return null for empty list.
3004 if (Properties.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003005 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003006
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003007 unsigned PropertySize =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003008 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003009 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003010 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, PropertySize);
3011 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Properties.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003012 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.PropertyTy,
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003013 Properties.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003014 Values[2] = llvm::ConstantArray::get(AT, Properties);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003015 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003016
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003017 llvm::GlobalVariable *GV =
3018 CreateMetadataVar(Name, Init,
3019 (ObjCABI == 2) ? "__DATA, __objc_const" :
Daniel Dunbarb25452a2009-04-15 02:56:18 +00003020 "__OBJC,__property,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00003021 CGM.getPointerAlign(),
Daniel Dunbarb25452a2009-04-15 02:56:18 +00003022 true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003023 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003024}
3025
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003026llvm::Constant *
3027CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
3028 ArrayRef<llvm::Constant*> MethodTypes,
3029 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003030 // Return null for empty list.
3031 if (MethodTypes.empty())
3032 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
3033
3034 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
3035 MethodTypes.size());
3036 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
3037
Alp Toker541d5072014-06-07 23:30:53 +00003038 llvm::GlobalVariable *GV = CreateMetadataVar(
3039 Name, Init, (ObjCABI == 2) ? "__DATA, __objc_const" : StringRef(),
John McCall7f416cc2015-09-08 08:05:57 +00003040 CGM.getPointerAlign(), true);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003041 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
3042}
3043
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003044/*
Daniel Dunbarb036db82008-08-13 03:21:16 +00003045 struct objc_method_description_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003046 int count;
3047 struct objc_method_description list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00003048 };
3049*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003050llvm::Constant *
3051CGObjCMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003052 llvm::Constant *Desc[] = {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003053 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003054 ObjCTypes.SelectorPtrTy),
3055 GetMethodVarType(MD)
3056 };
Douglas Gregora9d84932011-05-27 01:19:52 +00003057 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00003058 return nullptr;
3059
Owen Anderson0e0189d2009-07-27 22:29:56 +00003060 return llvm::ConstantStruct::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003061 Desc);
3062}
Daniel Dunbarb036db82008-08-13 03:21:16 +00003063
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003064llvm::Constant *
3065CGObjCMac::EmitMethodDescList(Twine Name, const char *Section,
3066 ArrayRef<llvm::Constant*> Methods) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00003067 // Return null for empty list.
3068 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003069 return llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003070
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003071 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003072 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003073 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003074 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003075 Values[1] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003076 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003077
John McCall7f416cc2015-09-08 08:05:57 +00003078 llvm::GlobalVariable *GV =
3079 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003080 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003081 ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003082}
3083
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003084/*
3085 struct _objc_category {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003086 char *category_name;
3087 char *class_name;
3088 struct _objc_method_list *instance_methods;
3089 struct _objc_method_list *class_methods;
3090 struct _objc_protocol_list *protocols;
3091 uint32_t size; // <rdar://4585769>
3092 struct _objc_property_list *instance_properties;
Manman Ren96df0b32016-01-29 23:45:01 +00003093 struct _objc_property_list *class_properties;
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003094 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003095*/
Daniel Dunbar92992502008-08-15 22:20:32 +00003096void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00003097 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003098
Mike Stump18bb9282009-05-16 07:57:57 +00003099 // FIXME: This is poor design, the OCD should have a pointer to the category
3100 // decl. Additionally, note that Category can be null for the @implementation
3101 // w/o an @interface case. Sema should just create one for us as it does for
3102 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003103 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003104 const ObjCCategoryDecl *Category =
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003105 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003106
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003107 SmallString<256> ExtName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003108 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3109 << OCD->getName();
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003110
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003111 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003112 for (const auto *I : OCD->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003113 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003114 InstanceMethods.push_back(GetMethodConstant(I));
3115
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003116 for (const auto *I : OCD->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003117 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003118 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003119
Manman Ren96df0b32016-01-29 23:45:01 +00003120 llvm::Constant *Values[8];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003121 Values[0] = GetClassName(OCD->getName());
3122 Values[1] = GetClassName(Interface->getObjCRuntimeNameAsString());
Fariborz Jahaniane55f8662009-04-29 20:40:05 +00003123 LazySymbols.insert(Interface->getIdentifier());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003124 Values[2] = EmitMethodList("OBJC_CATEGORY_INSTANCE_METHODS_" + ExtName.str(),
3125 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
3126 InstanceMethods);
3127 Values[3] = EmitMethodList("OBJC_CATEGORY_CLASS_METHODS_" + ExtName.str(),
3128 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
3129 ClassMethods);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003130 if (Category) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003131 Values[4] =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003132 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
3133 Category->protocol_begin(), Category->protocol_end());
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003134 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003135 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003136 }
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003137 Values[5] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003138
3139 // If there is no category @interface then there can be no properties.
3140 if (Category) {
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003141 Values[6] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Manman Renad0e7912016-01-29 19:22:54 +00003142 OCD, Category, ObjCTypes, false);
Manman Ren96df0b32016-01-29 23:45:01 +00003143 Values[7] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
3144 OCD, Category, ObjCTypes, true);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003145 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003146 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Manman Ren96df0b32016-01-29 23:45:01 +00003147 Values[7] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003148 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003149
Owen Anderson0e0189d2009-07-27 22:29:56 +00003150 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.CategoryTy,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003151 Values);
3152
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003153 llvm::GlobalVariable *GV =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003154 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003155 "__OBJC,__category,regular,no_dead_strip",
3156 CGM.getPointerAlign(), true);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003157 DefinedCategories.push_back(GV);
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00003158 DefinedCategoryNames.insert(ExtName.str());
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003159 // method definition entries must be clear for next implementation.
3160 MethodDefinitions.clear();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003161}
3162
John McCallef19dbb2012-10-17 04:53:23 +00003163enum FragileClassFlags {
John McCall460ce582015-10-22 18:38:17 +00003164 /// Apparently: is not a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003165 FragileABI_Class_Factory = 0x00001,
John McCall460ce582015-10-22 18:38:17 +00003166
3167 /// Is a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003168 FragileABI_Class_Meta = 0x00002,
John McCall460ce582015-10-22 18:38:17 +00003169
3170 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003171 FragileABI_Class_HasCXXStructors = 0x02000,
John McCall460ce582015-10-22 18:38:17 +00003172
3173 /// Has hidden visibility.
John McCall09ec1ec2015-10-21 22:06:03 +00003174 FragileABI_Class_Hidden = 0x20000,
John McCall460ce582015-10-22 18:38:17 +00003175
3176 /// Class implementation was compiled under ARC.
3177 FragileABI_Class_CompiledByARC = 0x04000000,
3178
3179 /// Class implementation was compiled under MRC and has MRC weak ivars.
3180 /// Exclusive with CompiledByARC.
3181 FragileABI_Class_HasMRCWeakIvars = 0x08000000,
John McCallef19dbb2012-10-17 04:53:23 +00003182};
3183
3184enum NonFragileClassFlags {
3185 /// Is a meta-class.
3186 NonFragileABI_Class_Meta = 0x00001,
3187
3188 /// Is a root class.
3189 NonFragileABI_Class_Root = 0x00002,
3190
John McCall460ce582015-10-22 18:38:17 +00003191 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003192 NonFragileABI_Class_HasCXXStructors = 0x00004,
3193
3194 /// Has hidden visibility.
3195 NonFragileABI_Class_Hidden = 0x00010,
3196
3197 /// Has the exception attribute.
3198 NonFragileABI_Class_Exception = 0x00020,
3199
3200 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3201 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3202
3203 /// Class implementation was compiled under ARC.
John McCall0d54a172012-10-17 04:53:31 +00003204 NonFragileABI_Class_CompiledByARC = 0x00080,
3205
3206 /// Class has non-trivial destructors, but zero-initialization is okay.
John McCall460ce582015-10-22 18:38:17 +00003207 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100,
3208
3209 /// Class implementation was compiled under MRC and has MRC weak ivars.
3210 /// Exclusive with CompiledByARC.
3211 NonFragileABI_Class_HasMRCWeakIvars = 0x00200,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003212};
3213
John McCall460ce582015-10-22 18:38:17 +00003214static bool hasWeakMember(QualType type) {
3215 if (type.getObjCLifetime() == Qualifiers::OCL_Weak) {
3216 return true;
3217 }
3218
3219 if (auto recType = type->getAs<RecordType>()) {
3220 for (auto field : recType->getDecl()->fields()) {
3221 if (hasWeakMember(field->getType()))
3222 return true;
3223 }
3224 }
3225
3226 return false;
3227}
3228
3229/// For compatibility, we only want to set the "HasMRCWeakIvars" flag
3230/// (and actually fill in a layout string) if we really do have any
3231/// __weak ivars.
3232static bool hasMRCWeakIvars(CodeGenModule &CGM,
3233 const ObjCImplementationDecl *ID) {
3234 if (!CGM.getLangOpts().ObjCWeak) return false;
3235 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
3236
3237 for (const ObjCIvarDecl *ivar =
3238 ID->getClassInterface()->all_declared_ivar_begin();
3239 ivar; ivar = ivar->getNextIvar()) {
3240 if (hasWeakMember(ivar->getType()))
3241 return true;
3242 }
3243
3244 return false;
3245}
3246
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003247/*
3248 struct _objc_class {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003249 Class isa;
3250 Class super_class;
3251 const char *name;
3252 long version;
3253 long info;
3254 long instance_size;
3255 struct _objc_ivar_list *ivars;
3256 struct _objc_method_list *methods;
3257 struct _objc_cache *cache;
3258 struct _objc_protocol_list *protocols;
3259 // Objective-C 1.0 extensions (<rdr://4585769>)
3260 const char *ivar_layout;
3261 struct _objc_class_ext *ext;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003262 };
3263
3264 See EmitClassExtension();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003265*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003266void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003267 DefinedSymbols.insert(ID->getIdentifier());
3268
Chris Lattner86d7d912008-11-24 03:54:41 +00003269 std::string ClassName = ID->getNameAsString();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003270 // FIXME: Gross
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003271 ObjCInterfaceDecl *Interface =
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003272 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003273 llvm::Constant *Protocols =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003274 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3275 Interface->all_referenced_protocol_begin(),
3276 Interface->all_referenced_protocol_end());
John McCallef19dbb2012-10-17 04:53:23 +00003277 unsigned Flags = FragileABI_Class_Factory;
John McCall0d54a172012-10-17 04:53:31 +00003278 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCallef19dbb2012-10-17 04:53:23 +00003279 Flags |= FragileABI_Class_HasCXXStructors;
John McCall09ec1ec2015-10-21 22:06:03 +00003280
John McCall460ce582015-10-22 18:38:17 +00003281 bool hasMRCWeak = false;
3282
John McCall09ec1ec2015-10-21 22:06:03 +00003283 if (CGM.getLangOpts().ObjCAutoRefCount)
3284 Flags |= FragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00003285 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
3286 Flags |= FragileABI_Class_HasMRCWeakIvars;
John McCall09ec1ec2015-10-21 22:06:03 +00003287
John McCall3fd13f062015-10-21 18:06:47 +00003288 CharUnits Size =
3289 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003290
3291 // FIXME: Set CXX-structors flag.
John McCall457a04e2010-10-22 21:05:15 +00003292 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003293 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003294
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003295 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003296 for (const auto *I : ID->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003297 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003298 InstanceMethods.push_back(GetMethodConstant(I));
3299
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003300 for (const auto *I : ID->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003301 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003302 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003303
Aaron Ballmand85eff42014-03-14 15:02:45 +00003304 for (const auto *PID : ID->property_impls()) {
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003305 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3306 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3307
3308 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
3309 if (llvm::Constant *C = GetMethodConstant(MD))
3310 InstanceMethods.push_back(C);
3311 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
3312 if (llvm::Constant *C = GetMethodConstant(MD))
3313 InstanceMethods.push_back(C);
3314 }
3315 }
3316
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003317 llvm::Constant *Values[12];
Daniel Dunbarccf61832009-05-03 08:56:52 +00003318 Values[ 0] = EmitMetaClass(ID, Protocols, ClassMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003319 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003320 // Record a reference to the super class.
3321 LazySymbols.insert(Super->getIdentifier());
3322
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003323 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003324 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003325 ObjCTypes.ClassPtrTy);
3326 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003327 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003328 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003329 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003330 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003331 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3332 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
John McCall3fd13f062015-10-21 18:06:47 +00003333 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size.getQuantity());
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003334 Values[ 6] = EmitIvarList(ID, false);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003335 Values[7] = EmitMethodList("OBJC_INSTANCE_METHODS_" + ID->getName(),
3336 "__OBJC,__inst_meth,regular,no_dead_strip",
3337 InstanceMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003338 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003339 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003340 Values[ 9] = Protocols;
John McCall460ce582015-10-22 18:38:17 +00003341 Values[10] = BuildStrongIvarLayout(ID, CharUnits::Zero(), Size);
Manman Renad0e7912016-01-29 19:22:54 +00003342 Values[11] = EmitClassExtension(ID, Size, hasMRCWeak,
3343 false/*isClassProperty*/);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003344 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003345 Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003346 std::string Name("OBJC_CLASS_");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003347 Name += ClassName;
3348 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3349 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003350 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003351 if (GV) {
3352 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3353 "Forward metaclass reference has incorrect type.");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003354 GV->setInitializer(Init);
3355 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003356 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00003357 CGM.addCompilerUsedGlobal(GV);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003358 } else
John McCall7f416cc2015-09-08 08:05:57 +00003359 GV = CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003360 DefinedClasses.push_back(GV);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00003361 ImplementedClasses.push_back(Interface);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003362 // method definition entries must be clear for next implementation.
3363 MethodDefinitions.clear();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003364}
3365
3366llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3367 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003368 ArrayRef<llvm::Constant*> Methods) {
John McCallef19dbb2012-10-17 04:53:23 +00003369 unsigned Flags = FragileABI_Class_Meta;
Micah Villmowdd31ca12012-10-08 16:25:52 +00003370 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003371
John McCall457a04e2010-10-22 21:05:15 +00003372 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003373 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003374
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003375 llvm::Constant *Values[12];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003376 // The isa for the metaclass is the root of the hierarchy.
3377 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3378 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3379 Root = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003380 Values[ 0] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003381 llvm::ConstantExpr::getBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003382 ObjCTypes.ClassPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003383 // The super class for the metaclass is emitted as the name of the
3384 // super class. The runtime fixes this up to point to the
3385 // *metaclass* for the super class.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003386 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003387 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003388 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003389 ObjCTypes.ClassPtrTy);
3390 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003391 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003392 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003393 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003394 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003395 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3396 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
3397 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size);
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003398 Values[ 6] = EmitIvarList(ID, true);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003399 Values[7] =
3400 EmitMethodList("OBJC_CLASS_METHODS_" + ID->getNameAsString(),
3401 "__OBJC,__cls_meth,regular,no_dead_strip", Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003402 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003403 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003404 Values[ 9] = Protocols;
3405 // ivar_layout for metaclass is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003406 Values[10] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Manman Renad0e7912016-01-29 19:22:54 +00003407 // The class extension is used to store class properties for metaclasses.
3408 Values[11] = EmitClassExtension(ID, CharUnits::Zero(), false/*hasMRCWeak*/,
3409 true/*isClassProperty*/);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003410 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003411 Values);
3412
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003413 std::string Name("OBJC_METACLASS_");
Benjamin Kramer1bbcbd02012-07-31 11:45:39 +00003414 Name += ID->getName();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003415
3416 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003417 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003418 if (GV) {
3419 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3420 "Forward metaclass reference has incorrect type.");
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003421 GV->setInitializer(Init);
3422 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00003423 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003424 llvm::GlobalValue::PrivateLinkage,
Owen Andersonc10c8d32009-07-08 19:05:04 +00003425 Init, Name);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003426 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003427 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Daniel Dunbarae333842009-03-09 22:18:41 +00003428 GV->setAlignment(4);
Rafael Espindola060062a2014-03-06 22:15:10 +00003429 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003430
3431 return GV;
3432}
3433
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003434llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003435 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003436
Mike Stump18bb9282009-05-16 07:57:57 +00003437 // FIXME: Should we look these up somewhere other than the module. Its a bit
3438 // silly since we only generate these while processing an implementation, so
3439 // exactly one pointer would work if know when we entered/exitted an
3440 // implementation block.
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003441
3442 // Check for an existing forward reference.
Fariborz Jahanian475831b2009-01-07 20:11:22 +00003443 // Previously, metaclass with internal linkage may have been defined.
3444 // pass 'true' as 2nd argument so it is returned.
Rafael Espindola21039aa2014-02-27 16:26:32 +00003445 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3446 if (!GV)
3447 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003448 llvm::GlobalValue::PrivateLinkage, nullptr,
3449 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003450
3451 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3452 "Forward metaclass reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003453 return GV;
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003454}
3455
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003456llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003457 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Rafael Espindola21039aa2014-02-27 16:26:32 +00003458 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3459
3460 if (!GV)
3461 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003462 llvm::GlobalValue::PrivateLinkage, nullptr,
3463 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003464
3465 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3466 "Forward class metadata reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003467 return GV;
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003468}
3469
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003470/*
John McCall3fd13f062015-10-21 18:06:47 +00003471 Emit a "class extension", which in this specific context means extra
3472 data that doesn't fit in the normal fragile-ABI class structure, and
3473 has nothing to do with the language concept of a class extension.
3474
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003475 struct objc_class_ext {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003476 uint32_t size;
3477 const char *weak_ivar_layout;
3478 struct _objc_property_list *properties;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003479 };
3480*/
3481llvm::Constant *
John McCall3fd13f062015-10-21 18:06:47 +00003482CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
Manman Renad0e7912016-01-29 19:22:54 +00003483 CharUnits InstanceSize, bool hasMRCWeakIvars,
3484 bool isClassProperty) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003485 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003486 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003487
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003488 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003489 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Manman Ren92e0a712016-02-21 05:31:05 +00003490 if (isClassProperty) {
3491 llvm::Type *PtrTy = CGM.Int8PtrTy;
3492 Values[1] = llvm::Constant::getNullValue(PtrTy);
3493 } else
Manman Renad0e7912016-01-29 19:22:54 +00003494 Values[1] = BuildWeakIvarLayout(ID, CharUnits::Zero(), InstanceSize,
3495 hasMRCWeakIvars);
3496 if (isClassProperty)
3497 Values[2] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getName(),
3498 ID, ID->getClassInterface(), ObjCTypes, true);
3499 else
3500 Values[2] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getName(),
3501 ID, ID->getClassInterface(), ObjCTypes, false);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003502
3503 // Return null if no extension bits are used.
Manman Renad0e7912016-01-29 19:22:54 +00003504 if ((!Values[1] || Values[1]->isNullValue()) && Values[2]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00003505 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003506
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003507 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00003508 llvm::ConstantStruct::get(ObjCTypes.ClassExtensionTy, Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003509 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003510 "__OBJC,__class_ext,regular,no_dead_strip",
3511 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003512}
3513
3514/*
3515 struct objc_ivar {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003516 char *ivar_name;
3517 char *ivar_type;
3518 int ivar_offset;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003519 };
3520
3521 struct objc_ivar_list {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003522 int ivar_count;
3523 struct objc_ivar list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003524 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003525*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003526llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003527 bool ForClass) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003528 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003529
3530 // When emitting the root class GCC emits ivar entries for the
3531 // actual class structure. It is not clear if we need to follow this
3532 // behavior; for now lets try and get away with not doing it. If so,
3533 // the cleanest solution would be to make up an ObjCInterfaceDecl
3534 // for the class.
3535 if (ForClass)
Owen Anderson0b75f232009-07-31 20:28:54 +00003536 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003537
Jordy Rosea91768e2011-07-22 02:08:32 +00003538 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003539
Jordy Rosea91768e2011-07-22 02:08:32 +00003540 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00003541 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00003542 // Ignore unnamed bit-fields.
3543 if (!IVD->getDeclName())
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003544 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003545 llvm::Constant *Ivar[] = {
3546 GetMethodVarName(IVD->getIdentifier()),
3547 GetMethodVarType(IVD),
3548 llvm::ConstantInt::get(ObjCTypes.IntTy,
Eli Friedman8cbca202012-11-06 22:15:52 +00003549 ComputeIvarBaseOffset(CGM, OID, IVD))
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003550 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003551 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarTy, Ivar));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003552 }
3553
3554 // Return null for empty list.
3555 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003556 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003557
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003558 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003559 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003560 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003561 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003562 Values[1] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003563 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003564
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003565 llvm::GlobalVariable *GV;
3566 if (ForClass)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003567 GV =
3568 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003569 "__OBJC,__class_vars,regular,no_dead_strip",
3570 CGM.getPointerAlign(), true);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003571 else
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003572 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003573 "__OBJC,__instance_vars,regular,no_dead_strip",
3574 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003575 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003576}
3577
3578/*
3579 struct objc_method {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003580 SEL method_name;
3581 char *method_types;
3582 void *method;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003583 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003584
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003585 struct objc_method_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003586 struct objc_method_list *obsolete;
3587 int count;
3588 struct objc_method methods_list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003589 };
3590*/
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003591
3592/// GetMethodConstant - Return a struct objc_method constant for the
3593/// given method if it has been defined. The result is null if the
3594/// method has not been defined. The return value has type MethodPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003595llvm::Constant *CGObjCMac::GetMethodConstant(const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00003596 llvm::Function *Fn = GetMethodDefinition(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003597 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00003598 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003599
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003600 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00003601 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003602 ObjCTypes.SelectorPtrTy),
3603 GetMethodVarType(MD),
3604 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
3605 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003606 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003607}
3608
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003609llvm::Constant *CGObjCMac::EmitMethodList(Twine Name,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003610 const char *Section,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003611 ArrayRef<llvm::Constant*> Methods) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003612 // Return null for empty list.
3613 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003614 return llvm::Constant::getNullValue(ObjCTypes.MethodListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003615
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003616 llvm::Constant *Values[3];
Owen Anderson0b75f232009-07-31 20:28:54 +00003617 Values[0] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003618 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003619 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003620 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003621 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003622 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003623
John McCall7f416cc2015-09-08 08:05:57 +00003624 llvm::GlobalVariable *GV =
3625 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003626 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003627}
3628
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00003629llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003630 const ObjCContainerDecl *CD) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003631 SmallString<256> Name;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003632 GetNameForMethod(OMD, CD, Name);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003633
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003634 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003635 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003636 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003637 llvm::Function *Method =
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00003638 llvm::Function::Create(MethodTy,
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003639 llvm::GlobalValue::InternalLinkage,
Daniel Dunbard2386812009-10-19 01:21:19 +00003640 Name.str(),
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003641 &CGM.getModule());
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003642 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003643
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003644 return Method;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003645}
3646
Alp Toker541d5072014-06-07 23:30:53 +00003647llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
3648 llvm::Constant *Init,
3649 StringRef Section,
John McCall7f416cc2015-09-08 08:05:57 +00003650 CharUnits Align,
Alp Toker541d5072014-06-07 23:30:53 +00003651 bool AddToUsed) {
Chris Lattner2192fe52011-07-18 04:24:23 +00003652 llvm::Type *Ty = Init->getType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003653 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00003654 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003655 llvm::GlobalValue::PrivateLinkage, Init, Name);
Alp Toker541d5072014-06-07 23:30:53 +00003656 if (!Section.empty())
Daniel Dunbar30c65362009-03-09 20:09:19 +00003657 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003658 GV->setAlignment(Align.getQuantity());
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00003659 if (AddToUsed)
Rafael Espindola060062a2014-03-06 22:15:10 +00003660 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar30c65362009-03-09 20:09:19 +00003661 return GV;
3662}
3663
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003664llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00003665 // Abuse this interface function as a place to finalize.
3666 FinishModule();
Craig Topper8a13c412014-05-21 05:09:00 +00003667 return nullptr;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003668}
3669
Chris Lattnerd4808922009-03-22 21:03:39 +00003670llvm::Constant *CGObjCMac::GetPropertyGetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003671 return ObjCTypes.getGetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003672}
3673
Chris Lattnerd4808922009-03-22 21:03:39 +00003674llvm::Constant *CGObjCMac::GetPropertySetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003675 return ObjCTypes.getSetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003676}
3677
Ted Kremeneke65b0862012-03-06 20:05:56 +00003678llvm::Constant *CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
3679 bool copy) {
3680 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
3681}
3682
David Chisnall168b80f2010-12-26 22:13:16 +00003683llvm::Constant *CGObjCMac::GetGetStructFunction() {
3684 return ObjCTypes.getCopyStructFn();
3685}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003686
David Chisnall168b80f2010-12-26 22:13:16 +00003687llvm::Constant *CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003688 return ObjCTypes.getCopyStructFn();
3689}
3690
David Chisnall0d75e062012-12-17 18:54:24 +00003691llvm::Constant *CGObjCMac::GetCppAtomicObjectGetFunction() {
3692 return ObjCTypes.getCppAtomicObjectFunction();
3693}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003694
David Chisnall0d75e062012-12-17 18:54:24 +00003695llvm::Constant *CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00003696 return ObjCTypes.getCppAtomicObjectFunction();
3697}
3698
Chris Lattnerd4808922009-03-22 21:03:39 +00003699llvm::Constant *CGObjCMac::EnumerationMutationFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003700 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson3f35a262008-08-31 04:05:03 +00003701}
3702
John McCallbd309292010-07-06 01:34:17 +00003703void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
3704 return EmitTryOrSynchronizedStmt(CGF, S);
3705}
3706
3707void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
3708 const ObjCAtSynchronizedStmt &S) {
3709 return EmitTryOrSynchronizedStmt(CGF, S);
3710}
3711
John McCall65bea082010-07-21 06:59:36 +00003712namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00003713 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCall65bea082010-07-21 06:59:36 +00003714 const Stmt &S;
John McCall7f416cc2015-09-08 08:05:57 +00003715 Address SyncArgSlot;
3716 Address CallTryExitVar;
3717 Address ExceptionData;
John McCall65bea082010-07-21 06:59:36 +00003718 ObjCTypesHelper &ObjCTypes;
3719 PerformFragileFinally(const Stmt *S,
John McCall7f416cc2015-09-08 08:05:57 +00003720 Address SyncArgSlot,
3721 Address CallTryExitVar,
3722 Address ExceptionData,
John McCall65bea082010-07-21 06:59:36 +00003723 ObjCTypesHelper *ObjCTypes)
John McCall2dd7d442010-08-04 05:59:32 +00003724 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCall65bea082010-07-21 06:59:36 +00003725 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
3726
Craig Topper4f12f102014-03-12 06:41:41 +00003727 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall65bea082010-07-21 06:59:36 +00003728 // Check whether we need to call objc_exception_try_exit.
3729 // In optimized code, this branch will always be folded.
3730 llvm::BasicBlock *FinallyCallExit =
3731 CGF.createBasicBlock("finally.call_exit");
3732 llvm::BasicBlock *FinallyNoCallExit =
3733 CGF.createBasicBlock("finally.no_call_exit");
3734 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
3735 FinallyCallExit, FinallyNoCallExit);
3736
3737 CGF.EmitBlock(FinallyCallExit);
John McCall882987f2013-02-28 19:01:20 +00003738 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
John McCall7f416cc2015-09-08 08:05:57 +00003739 ExceptionData.getPointer());
John McCall65bea082010-07-21 06:59:36 +00003740
3741 CGF.EmitBlock(FinallyNoCallExit);
3742
3743 if (isa<ObjCAtTryStmt>(S)) {
3744 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCallcebe0ca2010-08-11 00:16:14 +00003745 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall638d4f52013-04-03 00:56:07 +00003746 // Don't try to do the @finally if this is an EH cleanup.
3747 if (flags.isForEHCleanup()) return;
3748
John McCallcebe0ca2010-08-11 00:16:14 +00003749 // Save the current cleanup destination in case there's
3750 // control flow inside the finally statement.
3751 llvm::Value *CurCleanupDest =
3752 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
3753
John McCall65bea082010-07-21 06:59:36 +00003754 CGF.EmitStmt(FinallyStmt->getFinallyBody());
3755
John McCallcebe0ca2010-08-11 00:16:14 +00003756 if (CGF.HaveInsertPoint()) {
3757 CGF.Builder.CreateStore(CurCleanupDest,
3758 CGF.getNormalCleanupDestSlot());
3759 } else {
3760 // Currently, the end of the cleanup must always exist.
3761 CGF.EnsureInsertPoint();
3762 }
3763 }
John McCall65bea082010-07-21 06:59:36 +00003764 } else {
3765 // Emit objc_sync_exit(expr); as finally's sole statement for
3766 // @synchronized.
John McCall2dd7d442010-08-04 05:59:32 +00003767 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCall882987f2013-02-28 19:01:20 +00003768 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCall65bea082010-07-21 06:59:36 +00003769 }
3770 }
3771 };
John McCall42227ed2010-07-31 23:20:56 +00003772
3773 class FragileHazards {
3774 CodeGenFunction &CGF;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003775 SmallVector<llvm::Value*, 20> Locals;
John McCall42227ed2010-07-31 23:20:56 +00003776 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
3777
3778 llvm::InlineAsm *ReadHazard;
3779 llvm::InlineAsm *WriteHazard;
3780
3781 llvm::FunctionType *GetAsmFnType();
3782
3783 void collectLocals();
3784 void emitReadHazard(CGBuilderTy &Builder);
3785
3786 public:
3787 FragileHazards(CodeGenFunction &CGF);
John McCall2dd7d442010-08-04 05:59:32 +00003788
John McCall42227ed2010-07-31 23:20:56 +00003789 void emitWriteHazard();
John McCall2dd7d442010-08-04 05:59:32 +00003790 void emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00003791 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003792} // end anonymous namespace
John McCall42227ed2010-07-31 23:20:56 +00003793
3794/// Create the fragile-ABI read and write hazards based on the current
3795/// state of the function, which is presumed to be immediately prior
3796/// to a @try block. These hazards are used to maintain correct
3797/// semantics in the face of optimization and the fragile ABI's
3798/// cavalier use of setjmp/longjmp.
3799FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
3800 collectLocals();
3801
3802 if (Locals.empty()) return;
3803
3804 // Collect all the blocks in the function.
3805 for (llvm::Function::iterator
3806 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
3807 BlocksBeforeTry.insert(&*I);
3808
3809 llvm::FunctionType *AsmFnTy = GetAsmFnType();
3810
3811 // Create a read hazard for the allocas. This inhibits dead-store
3812 // optimizations and forces the values to memory. This hazard is
3813 // inserted before any 'throwing' calls in the protected scope to
3814 // reflect the possibility that the variables might be read from the
3815 // catch block if the call throws.
3816 {
3817 std::string Constraint;
3818 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3819 if (I) Constraint += ',';
3820 Constraint += "*m";
3821 }
3822
3823 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3824 }
3825
3826 // Create a write hazard for the allocas. This inhibits folding
3827 // loads across the hazard. This hazard is inserted at the
3828 // beginning of the catch path to reflect the possibility that the
3829 // variables might have been written within the protected scope.
3830 {
3831 std::string Constraint;
3832 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3833 if (I) Constraint += ',';
3834 Constraint += "=*m";
3835 }
3836
3837 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3838 }
3839}
3840
3841/// Emit a write hazard at the current location.
3842void FragileHazards::emitWriteHazard() {
3843 if (Locals.empty()) return;
3844
John McCall882987f2013-02-28 19:01:20 +00003845 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall42227ed2010-07-31 23:20:56 +00003846}
3847
John McCall42227ed2010-07-31 23:20:56 +00003848void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
3849 assert(!Locals.empty());
John McCall882987f2013-02-28 19:01:20 +00003850 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
3851 call->setDoesNotThrow();
3852 call->setCallingConv(CGF.getRuntimeCC());
John McCall42227ed2010-07-31 23:20:56 +00003853}
3854
3855/// Emit read hazards in all the protected blocks, i.e. all the blocks
3856/// which have been inserted since the beginning of the try.
John McCall2dd7d442010-08-04 05:59:32 +00003857void FragileHazards::emitHazardsInNewBlocks() {
John McCall42227ed2010-07-31 23:20:56 +00003858 if (Locals.empty()) return;
3859
John McCall7f416cc2015-09-08 08:05:57 +00003860 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall42227ed2010-07-31 23:20:56 +00003861
3862 // Iterate through all blocks, skipping those prior to the try.
3863 for (llvm::Function::iterator
3864 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
3865 llvm::BasicBlock &BB = *FI;
3866 if (BlocksBeforeTry.count(&BB)) continue;
3867
3868 // Walk through all the calls in the block.
3869 for (llvm::BasicBlock::iterator
3870 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
3871 llvm::Instruction &I = *BI;
3872
3873 // Ignore instructions that aren't non-intrinsic calls.
3874 // These are the only calls that can possibly call longjmp.
3875 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I)) continue;
3876 if (isa<llvm::IntrinsicInst>(I))
3877 continue;
3878
3879 // Ignore call sites marked nounwind. This may be questionable,
3880 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
3881 llvm::CallSite CS(&I);
3882 if (CS.doesNotThrow()) continue;
3883
John McCall2dd7d442010-08-04 05:59:32 +00003884 // Insert a read hazard before the call. This will ensure that
3885 // any writes to the locals are performed before making the
3886 // call. If the call throws, then this is sufficient to
3887 // guarantee correctness as long as it doesn't also write to any
3888 // locals.
John McCall42227ed2010-07-31 23:20:56 +00003889 Builder.SetInsertPoint(&BB, BI);
3890 emitReadHazard(Builder);
3891 }
3892 }
3893}
3894
3895static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, llvm::Value *V) {
3896 if (V) S.insert(V);
3897}
3898
John McCall7f416cc2015-09-08 08:05:57 +00003899static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
3900 if (V.isValid()) S.insert(V.getPointer());
3901}
3902
John McCall42227ed2010-07-31 23:20:56 +00003903void FragileHazards::collectLocals() {
3904 // Compute a set of allocas to ignore.
3905 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
3906 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
3907 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall42227ed2010-07-31 23:20:56 +00003908
3909 // Collect all the allocas currently in the function. This is
3910 // probably way too aggressive.
3911 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
3912 for (llvm::BasicBlock::iterator
3913 I = Entry.begin(), E = Entry.end(); I != E; ++I)
3914 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
3915 Locals.push_back(&*I);
3916}
3917
3918llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003919 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall9dc0db22011-05-15 01:53:33 +00003920 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
3921 tys[i] = Locals[i]->getType();
3922 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCall65bea082010-07-21 06:59:36 +00003923}
3924
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003925/*
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003926
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003927 Objective-C setjmp-longjmp (sjlj) Exception Handling
3928 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003929
John McCallbd309292010-07-06 01:34:17 +00003930 A catch buffer is a setjmp buffer plus:
3931 - a pointer to the exception that was caught
3932 - a pointer to the previous exception data buffer
3933 - two pointers of reserved storage
3934 Therefore catch buffers form a stack, with a pointer to the top
3935 of the stack kept in thread-local storage.
3936
3937 objc_exception_try_enter pushes a catch buffer onto the EH stack.
3938 objc_exception_try_exit pops the given catch buffer, which is
3939 required to be the top of the EH stack.
3940 objc_exception_throw pops the top of the EH stack, writes the
3941 thrown exception into the appropriate field, and longjmps
3942 to the setjmp buffer. It crashes the process (with a printf
3943 and an abort()) if there are no catch buffers on the stack.
3944 objc_exception_extract just reads the exception pointer out of the
3945 catch buffer.
3946
3947 There's no reason an implementation couldn't use a light-weight
3948 setjmp here --- something like __builtin_setjmp, but API-compatible
3949 with the heavyweight setjmp. This will be more important if we ever
3950 want to implement correct ObjC/C++ exception interactions for the
3951 fragile ABI.
3952
3953 Note that for this use of setjmp/longjmp to be correct, we may need
3954 to mark some local variables volatile: if a non-volatile local
3955 variable is modified between the setjmp and the longjmp, it has
3956 indeterminate value. For the purposes of LLVM IR, it may be
3957 sufficient to make loads and stores within the @try (to variables
3958 declared outside the @try) volatile. This is necessary for
3959 optimized correctness, but is not currently being done; this is
3960 being tracked as rdar://problem/8160285
3961
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003962 The basic framework for a @try-catch-finally is as follows:
3963 {
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003964 objc_exception_data d;
3965 id _rethrow = null;
Anders Carlssonda0e4562009-02-07 21:26:04 +00003966 bool _call_try_exit = true;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003967
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003968 objc_exception_try_enter(&d);
3969 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003970 ... try body ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003971 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003972 // exception path
3973 id _caught = objc_exception_extract(&d);
3974
3975 // enter new try scope for handlers
3976 if (!setjmp(d.jmp_buf)) {
3977 ... match exception and execute catch blocks ...
3978
3979 // fell off end, rethrow.
3980 _rethrow = _caught;
3981 ... jump-through-finally to finally_rethrow ...
3982 } else {
3983 // exception in catch block
3984 _rethrow = objc_exception_extract(&d);
3985 _call_try_exit = false;
3986 ... jump-through-finally to finally_rethrow ...
3987 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003988 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003989 ... jump-through-finally to finally_end ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003990
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003991 finally:
Anders Carlssonda0e4562009-02-07 21:26:04 +00003992 if (_call_try_exit)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003993 objc_exception_try_exit(&d);
Anders Carlssonda0e4562009-02-07 21:26:04 +00003994
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003995 ... finally block ....
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003996 ... dispatch to finally destination ...
3997
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003998 finally_rethrow:
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003999 objc_exception_throw(_rethrow);
4000
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004001 finally_end:
4002 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004003
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004004 This framework differs slightly from the one gcc uses, in that gcc
4005 uses _rethrow to determine if objc_exception_try_exit should be called
4006 and if the object should be rethrown. This breaks in the face of
4007 throwing nil and introduces unnecessary branches.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004008
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004009 We specialize this framework for a few particular circumstances:
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004010
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004011 - If there are no catch blocks, then we avoid emitting the second
4012 exception handling context.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004013
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004014 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
4015 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004016
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004017 - FIXME: If there is no @finally block we can do a few more
4018 simplifications.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004019
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004020 Rethrows and Jumps-Through-Finally
4021 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004022
John McCallbd309292010-07-06 01:34:17 +00004023 '@throw;' is supported by pushing the currently-caught exception
4024 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004025
John McCallbd309292010-07-06 01:34:17 +00004026 Branches through the @finally block are handled with an ordinary
4027 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
4028 exceptions are not compatible with C++ exceptions, and this is
4029 hardly the only place where this will go wrong.
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004030
John McCallbd309292010-07-06 01:34:17 +00004031 @synchronized(expr) { stmt; } is emitted as if it were:
4032 id synch_value = expr;
4033 objc_sync_enter(synch_value);
4034 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004035*/
4036
Fariborz Jahanianc2ad6dc2008-11-21 00:49:24 +00004037void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
4038 const Stmt &S) {
4039 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallbd309292010-07-06 01:34:17 +00004040
4041 // A destination for the fall-through edges of the catch handlers to
4042 // jump to.
4043 CodeGenFunction::JumpDest FinallyEnd =
4044 CGF.getJumpDestInCurrentScope("finally.end");
4045
4046 // A destination for the rethrow edge of the catch handlers to jump
4047 // to.
4048 CodeGenFunction::JumpDest FinallyRethrow =
4049 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004050
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004051 // For @synchronized, call objc_sync_enter(sync.expr). The
4052 // evaluation of the expression must occur before we enter the
John McCall2dd7d442010-08-04 05:59:32 +00004053 // @synchronized. We can't avoid a temp here because we need the
4054 // value to be preserved. If the backend ever does liveness
4055 // correctly after setjmp, this will be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00004056 Address SyncArgSlot = Address::invalid();
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004057 if (!isTry) {
John McCall2dd7d442010-08-04 05:59:32 +00004058 llvm::Value *SyncArg =
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004059 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
4060 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004061 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall2dd7d442010-08-04 05:59:32 +00004062
John McCall7f416cc2015-09-08 08:05:57 +00004063 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
4064 CGF.getPointerAlign(), "sync.arg");
John McCall2dd7d442010-08-04 05:59:32 +00004065 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004066 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004067
John McCall2dd7d442010-08-04 05:59:32 +00004068 // Allocate memory for the setjmp buffer. This needs to be kept
4069 // live throughout the try and catch blocks.
John McCall7f416cc2015-09-08 08:05:57 +00004070 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
4071 CGF.getPointerAlign(),
4072 "exceptiondata.ptr");
John McCall2dd7d442010-08-04 05:59:32 +00004073
John McCall42227ed2010-07-31 23:20:56 +00004074 // Create the fragile hazards. Note that this will not capture any
4075 // of the allocas required for exception processing, but will
4076 // capture the current basic block (which extends all the way to the
4077 // setjmp call) as "before the @try".
4078 FragileHazards Hazards(CGF);
4079
John McCallbd309292010-07-06 01:34:17 +00004080 // Create a flag indicating whether the cleanup needs to call
4081 // objc_exception_try_exit. This is true except when
4082 // - no catches match and we're branching through the cleanup
4083 // just to rethrow the exception, or
4084 // - a catch matched and we're falling out of the catch handler.
John McCall2dd7d442010-08-04 05:59:32 +00004085 // The setjmp-safety rule here is that we should always store to this
4086 // variable in a place that dominates the branch through the cleanup
4087 // without passing through any setjmps.
John McCall7f416cc2015-09-08 08:05:57 +00004088 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
4089 CharUnits::One(),
4090 "_call_try_exit");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004091
John McCall9916e3f2010-10-04 23:42:51 +00004092 // A slot containing the exception to rethrow. Only needed when we
4093 // have both a @catch and a @finally.
John McCall7f416cc2015-09-08 08:05:57 +00004094 Address PropagatingExnVar = Address::invalid();
John McCall9916e3f2010-10-04 23:42:51 +00004095
John McCallbd309292010-07-06 01:34:17 +00004096 // Push a normal cleanup to leave the try scope.
John McCall638d4f52013-04-03 00:56:07 +00004097 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall2dd7d442010-08-04 05:59:32 +00004098 SyncArgSlot,
John McCallcda666c2010-07-21 07:22:38 +00004099 CallTryExitVar,
4100 ExceptionData,
4101 &ObjCTypes);
John McCallbd309292010-07-06 01:34:17 +00004102
4103 // Enter a try block:
4104 // - Call objc_exception_try_enter to push ExceptionData on top of
4105 // the EH stack.
Nico Weber6307cf02015-02-26 20:43:00 +00004106 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004107 ExceptionData.getPointer());
John McCallbd309292010-07-06 01:34:17 +00004108
4109 // - Call setjmp on the exception data buffer.
4110 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
4111 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
David Blaikie6b2a8302015-04-03 17:47:16 +00004112 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
John McCall7f416cc2015-09-08 08:05:57 +00004113 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
4114 "setjmp_buffer");
Nico Weber6307cf02015-02-26 20:43:00 +00004115 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
4116 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004117 SetJmpResult->setCanReturnTwice();
John McCallbd309292010-07-06 01:34:17 +00004118
4119 // If setjmp returned 0, enter the protected block; otherwise,
4120 // branch to the handler.
Daniel Dunbar75283ff2008-11-11 02:29:29 +00004121 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
4122 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallbd309292010-07-06 01:34:17 +00004123 llvm::Value *DidCatch =
John McCallcebe0ca2010-08-11 00:16:14 +00004124 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4125 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004126
John McCallbd309292010-07-06 01:34:17 +00004127 // Emit the protected block.
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004128 CGF.EmitBlock(TryBlock);
John McCall2dd7d442010-08-04 05:59:32 +00004129 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004130 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallbd309292010-07-06 01:34:17 +00004131 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall2dd7d442010-08-04 05:59:32 +00004132
4133 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004134
John McCallbd309292010-07-06 01:34:17 +00004135 // Emit the exception handler block.
Daniel Dunbar7f086782008-09-27 23:30:04 +00004136 CGF.EmitBlock(TryHandler);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004137
John McCall42227ed2010-07-31 23:20:56 +00004138 // Don't optimize loads of the in-scope locals across this point.
4139 Hazards.emitWriteHazard();
4140
John McCallbd309292010-07-06 01:34:17 +00004141 // For a @synchronized (or a @try with no catches), just branch
4142 // through the cleanup to the rethrow block.
4143 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
4144 // Tell the cleanup not to re-pop the exit.
John McCall2dd7d442010-08-04 05:59:32 +00004145 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004146 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallbd309292010-07-06 01:34:17 +00004147
4148 // Otherwise, we have to match against the caught exceptions.
4149 } else {
John McCall2dd7d442010-08-04 05:59:32 +00004150 // Retrieve the exception object. We may emit multiple blocks but
4151 // nothing can cross this so the value is already in SSA form.
4152 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004153 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004154 ExceptionData.getPointer(), "caught");
John McCall2dd7d442010-08-04 05:59:32 +00004155
John McCallbd309292010-07-06 01:34:17 +00004156 // Push the exception to rethrow onto the EH value stack for the
4157 // benefit of any @throws in the handlers.
4158 CGF.ObjCEHValueStack.push_back(Caught);
4159
Douglas Gregor96c79492010-04-23 22:50:49 +00004160 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004161
Craig Topper8a13c412014-05-21 05:09:00 +00004162 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallbd309292010-07-06 01:34:17 +00004163
Craig Topper8a13c412014-05-21 05:09:00 +00004164 llvm::BasicBlock *CatchBlock = nullptr;
4165 llvm::BasicBlock *CatchHandler = nullptr;
John McCall2dd7d442010-08-04 05:59:32 +00004166 if (HasFinally) {
John McCall9916e3f2010-10-04 23:42:51 +00004167 // Save the currently-propagating exception before
4168 // objc_exception_try_enter clears the exception slot.
4169 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
John McCall7f416cc2015-09-08 08:05:57 +00004170 CGF.getPointerAlign(),
John McCall9916e3f2010-10-04 23:42:51 +00004171 "propagating_exception");
4172 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
4173
John McCall2dd7d442010-08-04 05:59:32 +00004174 // Enter a new exception try block (in case a @catch block
4175 // throws an exception).
John McCall882987f2013-02-28 19:01:20 +00004176 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004177 ExceptionData.getPointer());
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004178
John McCall2dd7d442010-08-04 05:59:32 +00004179 llvm::CallInst *SetJmpResult =
John McCall882987f2013-02-28 19:01:20 +00004180 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4181 SetJmpBuffer, "setjmp.result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004182 SetJmpResult->setCanReturnTwice();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004183
John McCall2dd7d442010-08-04 05:59:32 +00004184 llvm::Value *Threw =
4185 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4186
4187 CatchBlock = CGF.createBasicBlock("catch");
4188 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4189 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4190
4191 CGF.EmitBlock(CatchBlock);
4192 }
4193
4194 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004195
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004196 // Handle catch list. As a special case we check if everything is
4197 // matched and avoid generating code for falling off the end if
4198 // so.
4199 bool AllMatched = false;
Douglas Gregor96c79492010-04-23 22:50:49 +00004200 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4201 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004202
Douglas Gregor46a572b2010-04-26 16:46:50 +00004203 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00004204 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar523208f2008-09-27 07:36:24 +00004205
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004206 // catch(...) always matches.
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004207 if (!CatchParam) {
4208 AllMatched = true;
4209 } else {
John McCall9dd450b2009-09-21 23:43:11 +00004210 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004211
John McCallbd309292010-07-06 01:34:17 +00004212 // catch(id e) always matches under this ABI, since only
4213 // ObjC exceptions end up here in the first place.
Daniel Dunbar86919f42008-09-27 22:21:14 +00004214 // FIXME: For the time being we also match id<X>; this should
4215 // be rejected by Sema instead.
Eli Friedman55179ca2009-07-11 00:57:02 +00004216 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004217 AllMatched = true;
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004218 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004219
John McCallbd309292010-07-06 01:34:17 +00004220 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004221 if (AllMatched) {
John McCallbd309292010-07-06 01:34:17 +00004222 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4223
Anders Carlsson9396a892008-09-11 09:15:33 +00004224 if (CatchParam) {
John McCall1c9c3fd2010-10-15 04:57:14 +00004225 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004226 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallbd309292010-07-06 01:34:17 +00004227
4228 // These types work out because ConvertType(id) == i8*.
John McCall17f02752015-10-30 00:56:02 +00004229 EmitInitOfCatchParam(CGF, Caught, CatchParam);
Anders Carlsson9396a892008-09-11 09:15:33 +00004230 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004231
Anders Carlsson9396a892008-09-11 09:15:33 +00004232 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004233
4234 // The scope of the catch variable ends right here.
4235 CatchVarCleanups.ForceCleanup();
4236
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004237 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004238 break;
4239 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004240
Steve Naroff7cae42b2009-07-10 23:34:53 +00004241 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall96fa4842010-05-17 21:00:27 +00004242 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallbd309292010-07-06 01:34:17 +00004243
4244 // FIXME: @catch (Class c) ?
John McCall96fa4842010-05-17 21:00:27 +00004245 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4246 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004247
4248 // Check if the @catch block matches the exception object.
John McCall882987f2013-02-28 19:01:20 +00004249 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004250
John McCall882987f2013-02-28 19:01:20 +00004251 llvm::Value *matchArgs[] = { Class, Caught };
John McCallbd309292010-07-06 01:34:17 +00004252 llvm::CallInst *Match =
John McCall882987f2013-02-28 19:01:20 +00004253 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4254 matchArgs, "match");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004255
John McCallbd309292010-07-06 01:34:17 +00004256 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4257 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004258
4259 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbar7f086782008-09-27 23:30:04 +00004260 MatchedBlock, NextCatchBlock);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004261
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004262 // Emit the @catch block.
4263 CGF.EmitBlock(MatchedBlock);
John McCallbd309292010-07-06 01:34:17 +00004264
4265 // Collect any cleanups for the catch variable. The scope lasts until
4266 // the end of the catch body.
John McCall2dd7d442010-08-04 05:59:32 +00004267 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallbd309292010-07-06 01:34:17 +00004268
John McCall1c9c3fd2010-10-15 04:57:14 +00004269 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004270 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004271
John McCallbd309292010-07-06 01:34:17 +00004272 // Initialize the catch variable.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004273 llvm::Value *Tmp =
4274 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004275 CGF.ConvertType(CatchParam->getType()));
John McCall17f02752015-10-30 00:56:02 +00004276 EmitInitOfCatchParam(CGF, Tmp, CatchParam);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004277
Anders Carlsson9396a892008-09-11 09:15:33 +00004278 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004279
4280 // We're done with the catch variable.
4281 CatchVarCleanups.ForceCleanup();
4282
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004283 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004284
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004285 CGF.EmitBlock(NextCatchBlock);
4286 }
4287
John McCallbd309292010-07-06 01:34:17 +00004288 CGF.ObjCEHValueStack.pop_back();
4289
John McCall2dd7d442010-08-04 05:59:32 +00004290 // If nothing wanted anything to do with the caught exception,
4291 // kill the extract call.
4292 if (Caught->use_empty())
4293 Caught->eraseFromParent();
4294
4295 if (!AllMatched)
4296 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4297
4298 if (HasFinally) {
4299 // Emit the exception handler for the @catch blocks.
4300 CGF.EmitBlock(CatchHandler);
4301
4302 // In theory we might now need a write hazard, but actually it's
4303 // unnecessary because there's no local-accessing code between
4304 // the try's write hazard and here.
4305 //Hazards.emitWriteHazard();
4306
John McCall9916e3f2010-10-04 23:42:51 +00004307 // Extract the new exception and save it to the
4308 // propagating-exception slot.
John McCall7f416cc2015-09-08 08:05:57 +00004309 assert(PropagatingExnVar.isValid());
John McCall9916e3f2010-10-04 23:42:51 +00004310 llvm::CallInst *NewCaught =
John McCall882987f2013-02-28 19:01:20 +00004311 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004312 ExceptionData.getPointer(), "caught");
John McCall9916e3f2010-10-04 23:42:51 +00004313 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4314
John McCall2dd7d442010-08-04 05:59:32 +00004315 // Don't pop the catch handler; the throw already did.
4316 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004317 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004318 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004319 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004320
John McCall42227ed2010-07-31 23:20:56 +00004321 // Insert read hazards as required in the new blocks.
John McCall2dd7d442010-08-04 05:59:32 +00004322 Hazards.emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004323
John McCallbd309292010-07-06 01:34:17 +00004324 // Pop the cleanup.
John McCall2dd7d442010-08-04 05:59:32 +00004325 CGF.Builder.restoreIP(TryFallthroughIP);
4326 if (CGF.HaveInsertPoint())
4327 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallbd309292010-07-06 01:34:17 +00004328 CGF.PopCleanupBlock();
John McCall2dd7d442010-08-04 05:59:32 +00004329 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004330
John McCallbd309292010-07-06 01:34:17 +00004331 // Emit the rethrow block.
John McCall42227ed2010-07-31 23:20:56 +00004332 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallad5d61e2010-07-23 21:56:41 +00004333 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallbd309292010-07-06 01:34:17 +00004334 if (CGF.HaveInsertPoint()) {
John McCall9916e3f2010-10-04 23:42:51 +00004335 // If we have a propagating-exception variable, check it.
4336 llvm::Value *PropagatingExn;
John McCall7f416cc2015-09-08 08:05:57 +00004337 if (PropagatingExnVar.isValid()) {
John McCall9916e3f2010-10-04 23:42:51 +00004338 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall2dd7d442010-08-04 05:59:32 +00004339
John McCall9916e3f2010-10-04 23:42:51 +00004340 // Otherwise, just look in the buffer for the exception to throw.
4341 } else {
4342 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004343 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004344 ExceptionData.getPointer());
John McCall9916e3f2010-10-04 23:42:51 +00004345 PropagatingExn = Caught;
4346 }
4347
John McCall882987f2013-02-28 19:01:20 +00004348 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4349 PropagatingExn);
John McCallbd309292010-07-06 01:34:17 +00004350 CGF.Builder.CreateUnreachable();
Fariborz Jahaniane2caaaa2008-11-21 19:21:53 +00004351 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004352
John McCall42227ed2010-07-31 23:20:56 +00004353 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004354}
4355
4356void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004357 const ObjCAtThrowStmt &S,
4358 bool ClearInsertionPoint) {
Anders Carlssone005aa12008-09-09 16:16:55 +00004359 llvm::Value *ExceptionAsObject;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004360
Anders Carlssone005aa12008-09-09 16:16:55 +00004361 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00004362 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004363 ExceptionAsObject =
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004364 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlssone005aa12008-09-09 16:16:55 +00004365 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004366 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004367 "Unexpected rethrow outside @catch block.");
Anders Carlssonbf8a1be2009-02-07 21:37:21 +00004368 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlssone005aa12008-09-09 16:16:55 +00004369 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004370
John McCall882987f2013-02-28 19:01:20 +00004371 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallbd309292010-07-06 01:34:17 +00004372 ->setDoesNotReturn();
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004373 CGF.Builder.CreateUnreachable();
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004374
4375 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004376 if (ClearInsertionPoint)
4377 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004378}
4379
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004380/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004381/// object: objc_read_weak (id *src)
4382///
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004383llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004384 Address AddrWeakObj) {
4385 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004386 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4387 ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004388 llvm::Value *read_weak =
4389 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004390 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00004391 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004392 return read_weak;
4393}
4394
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004395/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4396/// objc_assign_weak (id src, id *dst)
4397///
4398void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004399 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004400 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004401 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004402 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004403 assert(Size <= 8 && "does not support size > 8");
4404 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004405 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004406 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4407 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004408 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4409 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004410 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004411 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4412 args, "weakassign");
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004413}
4414
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004415/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4416/// objc_assign_global (id src, id *dst)
4417///
4418void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004419 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00004420 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004421 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004422 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004423 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004424 assert(Size <= 8 && "does not support size > 8");
4425 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004426 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004427 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4428 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004429 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4430 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004431 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00004432 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00004433 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4434 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00004435 else
John McCall882987f2013-02-28 19:01:20 +00004436 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4437 args, "threadlocalassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004438}
4439
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004440/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004441/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004442///
4443void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004444 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004445 llvm::Value *ivarOffset) {
4446 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2192fe52011-07-18 04:24:23 +00004447 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004448 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004449 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004450 assert(Size <= 8 && "does not support size > 8");
4451 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004452 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004453 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4454 }
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004455 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4456 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004457 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00004458 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004459}
4460
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004461/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4462/// objc_assign_strongCast (id src, id *dst)
4463///
4464void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004465 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004466 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004467 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004468 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004469 assert(Size <= 8 && "does not support size > 8");
4470 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004471 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004472 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4473 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004474 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4475 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004476 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004477 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004478 args, "strongassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004479}
4480
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004481void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004482 Address DestPtr,
4483 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004484 llvm::Value *size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004485 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4486 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004487 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCall882987f2013-02-28 19:01:20 +00004488 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004489}
4490
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004491/// EmitObjCValueForIvar - Code Gen for ivar reference.
4492///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004493LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4494 QualType ObjectTy,
4495 llvm::Value *BaseValue,
4496 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004497 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004498 const ObjCInterfaceDecl *ID =
4499 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004500 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4501 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004502}
4503
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004504llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004505 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004506 const ObjCIvarDecl *Ivar) {
Eli Friedman8cbca202012-11-06 22:15:52 +00004507 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4508 return llvm::ConstantInt::get(
4509 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4510 Offset);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004511}
4512
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004513/* *** Private Interface *** */
4514
4515/// EmitImageInfo - Emit the image info marker used to encode some module
4516/// level information.
4517///
4518/// See: <rdr://4810609&4810587&4810587>
4519/// struct IMAGE_INFO {
4520/// unsigned version;
4521/// unsigned flags;
4522/// };
4523enum ImageInfoFlags {
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004524 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004525 eImageInfo_GarbageCollected = (1 << 1),
4526 eImageInfo_GCOnly = (1 << 2),
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004527 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbar75e909f2009-04-20 07:11:47 +00004528
Daniel Dunbar5e639272010-04-25 20:39:01 +00004529 // A flag indicating that the module has no instances of a @synthesize of a
4530 // superclass variable. <rdar://problem/6803242>
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004531 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Manman Ren96df0b32016-01-29 23:45:01 +00004532 eImageInfo_ImageIsSimulated = (1 << 5),
4533 eImageInfo_ClassProperties = (1 << 6)
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004534};
4535
Daniel Dunbar5e639272010-04-25 20:39:01 +00004536void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004537 unsigned version = 0; // Version is unused?
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004538 const char *Section = (ObjCABI == 1) ?
4539 "__OBJC, __image_info,regular" :
4540 "__DATA, __objc_imageinfo, regular, no_dead_strip";
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004541
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004542 // Generate module-level named metadata to convey this information to the
4543 // linker and code-gen.
4544 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004545
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004546 // Add the ObjC ABI version to the module flags.
4547 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4548 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4549 version);
4550 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
4551 llvm::MDString::get(VMContext,Section));
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004552
David Blaikiebbafb8a2012-03-11 07:00:24 +00004553 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004554 // Non-GC overrides those files which specify GC.
4555 Mod.addModuleFlag(llvm::Module::Override,
4556 "Objective-C Garbage Collection", (uint32_t)0);
4557 } else {
4558 // Add the ObjC garbage collection value.
4559 Mod.addModuleFlag(llvm::Module::Error,
4560 "Objective-C Garbage Collection",
4561 eImageInfo_GarbageCollected);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004562
David Blaikiebbafb8a2012-03-11 07:00:24 +00004563 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004564 // Add the ObjC GC Only value.
4565 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4566 eImageInfo_GCOnly);
4567
4568 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004569 llvm::Metadata *Ops[2] = {
4570 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4571 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4572 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004573 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4574 llvm::MDNode::get(VMContext, Ops));
4575 }
4576 }
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004577
4578 // Indicate whether we're compiling this to run on a simulator.
4579 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00004580 if ((Triple.isiOS() || Triple.isWatchOS()) &&
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004581 (Triple.getArch() == llvm::Triple::x86 ||
4582 Triple.getArch() == llvm::Triple::x86_64))
4583 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4584 eImageInfo_ImageIsSimulated);
Manman Ren96df0b32016-01-29 23:45:01 +00004585
4586 // Indicate whether we are generating class properties.
4587 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Class Properties",
4588 eImageInfo_ClassProperties);
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004589}
4590
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004591// struct objc_module {
4592// unsigned long version;
4593// unsigned long size;
4594// const char *name;
4595// Symtab symtab;
4596// };
4597
4598// FIXME: Get from somewhere
4599static const int ModuleVersion = 7;
4600
4601void CGObjCMac::EmitModuleInfo() {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004602 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004603
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004604 llvm::Constant *Values[] = {
4605 llvm::ConstantInt::get(ObjCTypes.LongTy, ModuleVersion),
4606 llvm::ConstantInt::get(ObjCTypes.LongTy, Size),
4607 // This used to be the filename, now it is unused. <rdr://4327263>
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004608 GetClassName(StringRef("")),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004609 EmitModuleSymbols()
4610 };
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004611 CreateMetadataVar("OBJC_MODULES",
Owen Anderson0e0189d2009-07-27 22:29:56 +00004612 llvm::ConstantStruct::get(ObjCTypes.ModuleTy, Values),
John McCall7f416cc2015-09-08 08:05:57 +00004613 "__OBJC,__module_info,regular,no_dead_strip",
4614 CGM.getPointerAlign(), true);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004615}
4616
4617llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004618 unsigned NumClasses = DefinedClasses.size();
4619 unsigned NumCategories = DefinedCategories.size();
4620
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004621 // Return null if no symbols were defined.
4622 if (!NumClasses && !NumCategories)
Owen Anderson0b75f232009-07-31 20:28:54 +00004623 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004624
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004625 llvm::Constant *Values[5];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004626 Values[0] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
Owen Anderson0b75f232009-07-31 20:28:54 +00004627 Values[1] = llvm::Constant::getNullValue(ObjCTypes.SelectorPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004628 Values[2] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumClasses);
4629 Values[3] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004630
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004631 // The runtime expects exactly the list of defined classes followed
4632 // by the list of defined categories, in a single array.
Chris Lattner3def9ae2012-02-06 22:16:34 +00004633 SmallVector<llvm::Constant*, 8> Symbols(NumClasses + NumCategories);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004634 for (unsigned i=0; i<NumClasses; i++) {
4635 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
4636 assert(ID);
4637 if (ObjCImplementationDecl *IMP = ID->getImplementation())
4638 // We are implementing a weak imported interface. Give it external linkage
4639 if (ID->isWeakImported() && !IMP->isWeakImported())
4640 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
4641
Owen Andersonade90fd2009-07-29 18:54:39 +00004642 Symbols[i] = llvm::ConstantExpr::getBitCast(DefinedClasses[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004643 ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004644 }
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004645 for (unsigned i=0; i<NumCategories; i++)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004646 Symbols[NumClasses + i] =
Owen Andersonade90fd2009-07-29 18:54:39 +00004647 llvm::ConstantExpr::getBitCast(DefinedCategories[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004648 ObjCTypes.Int8PtrTy);
4649
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004650 Values[4] =
Owen Anderson9793f0e2009-07-29 22:16:19 +00004651 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00004652 Symbols.size()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004653 Symbols);
4654
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004655 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004656
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004657 llvm::GlobalVariable *GV = CreateMetadataVar(
John McCall7f416cc2015-09-08 08:05:57 +00004658 "OBJC_SYMBOLS", Init, "__OBJC,__symbols,regular,no_dead_strip",
4659 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00004660 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004661}
4662
John McCall882987f2013-02-28 19:01:20 +00004663llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
4664 IdentifierInfo *II) {
John McCall31168b02011-06-15 23:02:42 +00004665 LazySymbols.insert(II);
4666
4667 llvm::GlobalVariable *&Entry = ClassReferences[II];
4668
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004669 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004670 llvm::Constant *Casted =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004671 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCall31168b02011-06-15 23:02:42 +00004672 ObjCTypes.ClassPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004673 Entry = CreateMetadataVar(
4674 "OBJC_CLASS_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004675 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
4676 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004677 }
John McCall31168b02011-06-15 23:02:42 +00004678
John McCall7f416cc2015-09-08 08:05:57 +00004679 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004680}
4681
John McCall882987f2013-02-28 19:01:20 +00004682llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00004683 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00004684 // If the class has the objc_runtime_visible attribute, we need to
4685 // use the Objective-C runtime to get the class.
4686 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
4687 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
4688
John McCall882987f2013-02-28 19:01:20 +00004689 return EmitClassRefFromId(CGF, ID->getIdentifier());
John McCall31168b02011-06-15 23:02:42 +00004690}
4691
John McCall882987f2013-02-28 19:01:20 +00004692llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00004693 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCall882987f2013-02-28 19:01:20 +00004694 return EmitClassRefFromId(CGF, II);
John McCall31168b02011-06-15 23:02:42 +00004695}
4696
John McCall7f416cc2015-09-08 08:05:57 +00004697llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
4698 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
4699}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004700
John McCall7f416cc2015-09-08 08:05:57 +00004701Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
4702 CharUnits Align = CGF.getPointerAlign();
4703
4704 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004705 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004706 llvm::Constant *Casted =
Owen Andersonade90fd2009-07-29 18:54:39 +00004707 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004708 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004709 Entry = CreateMetadataVar(
4710 "OBJC_SELECTOR_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004711 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman5c205962013-02-05 23:08:45 +00004712 Entry->setExternallyInitialized(true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004713 }
4714
John McCall7f416cc2015-09-08 08:05:57 +00004715 return Address(Entry, Align);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004716}
4717
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004718llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
4719 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
4720 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004721 Entry = CreateMetadataVar(
4722 "OBJC_CLASS_NAME_",
4723 llvm::ConstantDataArray::getString(VMContext, RuntimeName),
4724 ((ObjCABI == 2) ? "__TEXT,__objc_classname,cstring_literals"
4725 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004726 CharUnits::One(), true);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004727 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004728}
4729
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004730llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
4731 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
4732 I = MethodDefinitions.find(MD);
4733 if (I != MethodDefinitions.end())
4734 return I->second;
4735
Craig Topper8a13c412014-05-21 05:09:00 +00004736 return nullptr;
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004737}
4738
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004739/// GetIvarLayoutName - Returns a unique constant for the given
4740/// ivar layout bitmap.
4741llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004742 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Anderson0b75f232009-07-31 20:28:54 +00004743 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004744}
4745
John McCall3fd13f062015-10-21 18:06:47 +00004746void IvarLayoutBuilder::visitRecord(const RecordType *RT,
4747 CharUnits offset) {
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004748 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004749
John McCall3fd13f062015-10-21 18:06:47 +00004750 // If this is a union, remember that we had one, because it might mess
4751 // up the ordering of layout entries.
4752 if (RD->isUnion())
4753 IsDisordered = true;
4754
4755 const ASTRecordLayout *recLayout = nullptr;
4756 visitAggregate(RD->field_begin(), RD->field_end(), offset,
4757 [&](const FieldDecl *field) -> CharUnits {
4758 if (!recLayout)
4759 recLayout = &CGM.getContext().getASTRecordLayout(RD);
4760 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
4761 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
4762 });
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004763}
4764
John McCall3fd13f062015-10-21 18:06:47 +00004765template <class Iterator, class GetOffsetFn>
4766void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
4767 CharUnits aggregateOffset,
4768 const GetOffsetFn &getOffset) {
4769 for (; begin != end; ++begin) {
4770 auto field = *begin;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004771
John McCall3fd13f062015-10-21 18:06:47 +00004772 // Skip over bitfields.
4773 if (field->isBitField()) {
4774 continue;
4775 }
4776
4777 // Compute the offset of the field within the aggregate.
4778 CharUnits fieldOffset = aggregateOffset + getOffset(field);
4779
4780 visitField(field, fieldOffset);
4781 }
4782}
4783
4784/// Collect layout information for the given fields into IvarsInfo.
4785void IvarLayoutBuilder::visitField(const FieldDecl *field,
4786 CharUnits fieldOffset) {
4787 QualType fieldType = field->getType();
4788
4789 // Drill down into arrays.
4790 uint64_t numElts = 1;
4791 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
4792 numElts *= arrayType->getSize().getZExtValue();
4793 fieldType = arrayType->getElementType();
4794 }
4795
4796 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
4797
4798 // If we ended up with a zero-sized array, we've done what we can do within
4799 // the limits of this layout encoding.
4800 if (numElts == 0) return;
4801
4802 // Recurse if the base element type is a record type.
4803 if (auto recType = fieldType->getAs<RecordType>()) {
4804 size_t oldEnd = IvarsInfo.size();
4805
4806 visitRecord(recType, fieldOffset);
4807
4808 // If we have an array, replicate the first entry's layout information.
4809 auto numEltEntries = IvarsInfo.size() - oldEnd;
4810 if (numElts != 1 && numEltEntries != 0) {
4811 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
4812 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
4813 // Copy the last numEltEntries onto the end of the array, adjusting
4814 // each for the element size.
4815 for (size_t i = 0; i != numEltEntries; ++i) {
4816 auto firstEntry = IvarsInfo[oldEnd + i];
4817 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
4818 firstEntry.SizeInWords));
4819 }
4820 }
4821 }
4822
Fariborz Jahanian524bb202009-03-10 16:22:08 +00004823 return;
Fariborz Jahanian3b0f8862009-03-11 00:07:04 +00004824 }
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004825
John McCall3fd13f062015-10-21 18:06:47 +00004826 // Classify the element type.
4827 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004828
John McCall3fd13f062015-10-21 18:06:47 +00004829 // If it matches what we're looking for, add an entry.
4830 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
4831 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
4832 assert(CGM.getContext().getTypeSizeInChars(fieldType)
4833 == CGM.getPointerSize());
4834 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
4835 }
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00004836}
4837
John McCall3fd13f062015-10-21 18:06:47 +00004838/// buildBitmap - This routine does the horsework of taking the offsets of
4839/// strong/weak references and creating a bitmap. The bitmap is also
4840/// returned in the given buffer, suitable for being passed to \c dump().
4841llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
4842 llvm::SmallVectorImpl<unsigned char> &buffer) {
4843 // The bitmap is a series of skip/scan instructions, aligned to word
4844 // boundaries. The skip is performed first.
4845 const unsigned char MaxNibble = 0xF;
4846 const unsigned char SkipMask = 0xF0, SkipShift = 4;
4847 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004848
John McCall3fd13f062015-10-21 18:06:47 +00004849 assert(!IvarsInfo.empty() && "generating bitmap for no data");
4850
4851 // Sort the ivar info on byte position in case we encounterred a
4852 // union nested in the ivar list.
4853 if (IsDisordered) {
4854 // This isn't a stable sort, but our algorithm should handle it fine.
4855 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
4856 } else {
Craig Toppera3467052016-01-03 19:43:20 +00004857 assert(std::is_sorted(IvarsInfo.begin(), IvarsInfo.end()));
John McCall3fd13f062015-10-21 18:06:47 +00004858 }
4859 assert(IvarsInfo.back().Offset < InstanceEnd);
4860
4861 assert(buffer.empty());
4862
4863 // Skip the next N words.
4864 auto skip = [&](unsigned numWords) {
4865 assert(numWords > 0);
4866
4867 // Try to merge into the previous byte. Since scans happen second, we
4868 // can't do this if it includes a scan.
4869 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
4870 unsigned lastSkip = buffer.back() >> SkipShift;
4871 if (lastSkip < MaxNibble) {
4872 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
4873 numWords -= claimed;
4874 lastSkip += claimed;
4875 buffer.back() = (lastSkip << SkipShift);
4876 }
4877 }
4878
4879 while (numWords >= MaxNibble) {
4880 buffer.push_back(MaxNibble << SkipShift);
4881 numWords -= MaxNibble;
4882 }
4883 if (numWords) {
4884 buffer.push_back(numWords << SkipShift);
4885 }
4886 };
4887
4888 // Scan the next N words.
4889 auto scan = [&](unsigned numWords) {
4890 assert(numWords > 0);
4891
4892 // Try to merge into the previous byte. Since scans happen second, we can
4893 // do this even if it includes a skip.
4894 if (!buffer.empty()) {
4895 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
4896 if (lastScan < MaxNibble) {
4897 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
4898 numWords -= claimed;
4899 lastScan += claimed;
4900 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
4901 }
4902 }
4903
4904 while (numWords >= MaxNibble) {
4905 buffer.push_back(MaxNibble << ScanShift);
4906 numWords -= MaxNibble;
4907 }
4908 if (numWords) {
4909 buffer.push_back(numWords << ScanShift);
4910 }
4911 };
4912
4913 // One past the end of the last scan.
4914 unsigned endOfLastScanInWords = 0;
4915 const CharUnits WordSize = CGM.getPointerSize();
4916
4917 // Consider all the scan requests.
4918 for (auto &request : IvarsInfo) {
4919 CharUnits beginOfScan = request.Offset - InstanceBegin;
4920
4921 // Ignore scan requests that don't start at an even multiple of the
4922 // word size. We can't encode them.
4923 if ((beginOfScan % WordSize) != 0) continue;
4924
4925 // Ignore scan requests that start before the instance start.
4926 // This assumes that scans never span that boundary. The boundary
4927 // isn't the true start of the ivars, because in the fragile-ARC case
4928 // it's rounded up to word alignment, but the test above should leave
4929 // us ignoring that possibility.
4930 if (beginOfScan.isNegative()) {
4931 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
4932 continue;
4933 }
4934
4935 unsigned beginOfScanInWords = beginOfScan / WordSize;
4936 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
4937
4938 // If the scan starts some number of words after the last one ended,
4939 // skip forward.
4940 if (beginOfScanInWords > endOfLastScanInWords) {
4941 skip(beginOfScanInWords - endOfLastScanInWords);
4942
4943 // Otherwise, start scanning where the last left off.
4944 } else {
4945 beginOfScanInWords = endOfLastScanInWords;
4946
4947 // If that leaves us with nothing to scan, ignore this request.
4948 if (beginOfScanInWords >= endOfScanInWords) continue;
4949 }
4950
4951 // Scan to the end of the request.
4952 assert(beginOfScanInWords < endOfScanInWords);
4953 scan(endOfScanInWords - beginOfScanInWords);
4954 endOfLastScanInWords = endOfScanInWords;
4955 }
4956
John McCallf5ea0722015-10-29 23:36:14 +00004957 if (buffer.empty())
4958 return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
4959
John McCall3fd13f062015-10-21 18:06:47 +00004960 // For GC layouts, emit a skip to the end of the allocation so that we
4961 // have precise information about the entire thing. This isn't useful
4962 // or necessary for the ARC-style layout strings.
4963 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
4964 unsigned lastOffsetInWords =
4965 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
4966 if (lastOffsetInWords > endOfLastScanInWords) {
4967 skip(lastOffsetInWords - endOfLastScanInWords);
4968 }
4969 }
4970
4971 // Null terminate the string.
4972 buffer.push_back(0);
4973
4974 bool isNonFragileABI = CGObjC.isNonFragileABI();
4975
4976 llvm::GlobalVariable *Entry = CGObjC.CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004977 "OBJC_CLASS_NAME_",
John McCall3fd13f062015-10-21 18:06:47 +00004978 llvm::ConstantDataArray::get(CGM.getLLVMContext(), buffer),
4979 (isNonFragileABI ? "__TEXT,__objc_classname,cstring_literals"
4980 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004981 CharUnits::One(), true);
John McCall3fd13f062015-10-21 18:06:47 +00004982 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004983}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004984
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004985/// BuildIvarLayout - Builds ivar layout bitmap for the class
4986/// implementation for the __strong or __weak case.
4987/// The layout map displays which words in ivar list must be skipped
4988/// and which must be scanned by GC (see below). String is built of bytes.
4989/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
4990/// of words to skip and right nibble is count of words to scan. So, each
4991/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
4992/// represented by a 0x00 byte which also ends the string.
4993/// 1. when ForStrongLayout is true, following ivars are scanned:
4994/// - id, Class
4995/// - object *
4996/// - __strong anything
4997///
4998/// 2. When ForStrongLayout is false, following ivars are scanned:
4999/// - __weak anything
5000///
John McCall3fd13f062015-10-21 18:06:47 +00005001llvm::Constant *
5002CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
5003 CharUnits beginOffset, CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +00005004 bool ForStrongLayout, bool HasMRCWeakIvars) {
5005 // If this is MRC, and we're either building a strong layout or there
5006 // are no weak ivars, bail out early.
Chris Lattnerece04092012-02-07 00:39:47 +00005007 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005008 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
John McCall460ce582015-10-22 18:38:17 +00005009 !CGM.getLangOpts().ObjCAutoRefCount &&
5010 (ForStrongLayout || !HasMRCWeakIvars))
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005011 return llvm::Constant::getNullValue(PtrTy);
5012
Jordy Rosea91768e2011-07-22 02:08:32 +00005013 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
John McCall3fd13f062015-10-21 18:06:47 +00005014 SmallVector<const ObjCIvarDecl*, 32> ivars;
5015
5016 // GC layout strings include the complete object layout, possibly
5017 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
5018 // up.
5019 //
5020 // ARC layout strings only include the class's ivars. In non-fragile
John McCallf5ea0722015-10-29 23:36:14 +00005021 // runtimes, that means starting at InstanceStart, rounded up to word
5022 // alignment. In fragile runtimes, there's no InstanceStart, so it means
John McCalld80218f2015-11-19 02:27:55 +00005023 // starting at the offset of the first ivar, rounded up to word alignment.
John McCall460ce582015-10-22 18:38:17 +00005024 //
5025 // MRC weak layout strings follow the ARC style.
John McCall3fd13f062015-10-21 18:06:47 +00005026 CharUnits baseOffset;
John McCall460ce582015-10-22 18:38:17 +00005027 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Jordy Rosea91768e2011-07-22 02:08:32 +00005028 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005029 IVD; IVD = IVD->getNextIvar())
John McCall3fd13f062015-10-21 18:06:47 +00005030 ivars.push_back(IVD);
5031
5032 if (isNonFragileABI()) {
5033 baseOffset = beginOffset; // InstanceStart
John McCalld80218f2015-11-19 02:27:55 +00005034 } else if (!ivars.empty()) {
5035 baseOffset =
5036 CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivars[0]));
John McCall3fd13f062015-10-21 18:06:47 +00005037 } else {
5038 baseOffset = CharUnits::Zero();
5039 }
John McCallf5ea0722015-10-29 23:36:14 +00005040
Rui Ueyama83aa9792016-01-14 21:00:27 +00005041 baseOffset = baseOffset.alignTo(CGM.getPointerAlign());
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005042 }
5043 else {
John McCall3fd13f062015-10-21 18:06:47 +00005044 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005045
John McCall3fd13f062015-10-21 18:06:47 +00005046 baseOffset = CharUnits::Zero();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005047 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005048
John McCall3fd13f062015-10-21 18:06:47 +00005049 if (ivars.empty())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005050 return llvm::Constant::getNullValue(PtrTy);
5051
John McCall3fd13f062015-10-21 18:06:47 +00005052 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005053
John McCall3fd13f062015-10-21 18:06:47 +00005054 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
5055 [&](const ObjCIvarDecl *ivar) -> CharUnits {
5056 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
5057 });
5058
5059 if (!builder.hasBitmapData())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005060 return llvm::Constant::getNullValue(PtrTy);
John McCall3fd13f062015-10-21 18:06:47 +00005061
5062 llvm::SmallVector<unsigned char, 4> buffer;
5063 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005064
John McCallf5ea0722015-10-29 23:36:14 +00005065 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005066 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005067 ForStrongLayout ? "strong" : "weak",
Ben Langmuire013bdc2014-07-11 00:43:47 +00005068 OMD->getClassInterface()->getName().str().c_str());
John McCall3fd13f062015-10-21 18:06:47 +00005069 builder.dump(buffer);
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005070 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005071 return C;
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00005072}
5073
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005074llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005075 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
5076
Chris Lattner3def9ae2012-02-06 22:16:34 +00005077 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005078 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005079 Entry = CreateMetadataVar(
5080 "OBJC_METH_VAR_NAME_",
5081 llvm::ConstantDataArray::getString(VMContext, Sel.getAsString()),
5082 ((ObjCABI == 2) ? "__TEXT,__objc_methname,cstring_literals"
5083 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005084 CharUnits::One(), true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005085
Owen Anderson170229f2009-07-14 23:10:40 +00005086 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005087}
5088
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005089// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005090llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005091 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
5092}
5093
Daniel Dunbarf5c18462009-04-20 06:54:31 +00005094llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005095 std::string TypeStr;
5096 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
5097
5098 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbarb036db82008-08-13 03:21:16 +00005099
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005100 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005101 Entry = CreateMetadataVar(
5102 "OBJC_METH_VAR_TYPE_",
5103 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5104 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5105 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005106 CharUnits::One(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005107
Owen Anderson170229f2009-07-14 23:10:40 +00005108 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005109}
5110
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005111llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
5112 bool Extended) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005113 std::string TypeStr;
Bill Wendlinge22bef72012-02-09 22:45:21 +00005114 if (CGM.getContext().getObjCEncodingForMethodDecl(D, TypeStr, Extended))
Craig Topper8a13c412014-05-21 05:09:00 +00005115 return nullptr;
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005116
5117 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
5118
Daniel Dunbar3241fae2009-04-14 23:14:47 +00005119 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005120 Entry = CreateMetadataVar(
5121 "OBJC_METH_VAR_TYPE_",
5122 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5123 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5124 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005125 CharUnits::One(), true);
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005126
Owen Anderson170229f2009-07-14 23:10:40 +00005127 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005128}
5129
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005130// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005131llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005132 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005133
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005134 if (!Entry)
Alp Toker541d5072014-06-07 23:30:53 +00005135 Entry = CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005136 "OBJC_PROP_NAME_ATTR_",
Alp Toker541d5072014-06-07 23:30:53 +00005137 llvm::ConstantDataArray::getString(VMContext, Ident->getName()),
John McCall7f416cc2015-09-08 08:05:57 +00005138 "__TEXT,__cstring,cstring_literals", CharUnits::One(), true);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005139
Owen Anderson170229f2009-07-14 23:10:40 +00005140 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005141}
5142
5143// FIXME: Merge into a single cstring creation function.
Daniel Dunbar4932b362008-08-28 04:38:10 +00005144// FIXME: This Decl should be more precise.
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005145llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005146CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
5147 const Decl *Container) {
Daniel Dunbar4932b362008-08-28 04:38:10 +00005148 std::string TypeStr;
5149 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container, TypeStr);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005150 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
5151}
5152
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005153void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005154 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005155 SmallVectorImpl<char> &Name) {
Daniel Dunbard2386812009-10-19 01:21:19 +00005156 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00005157 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbard2386812009-10-19 01:21:19 +00005158 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
5159 << '[' << CD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005160 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbard2386812009-10-19 01:21:19 +00005161 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramer2f569922012-02-07 11:57:45 +00005162 OS << '(' << *CID << ')';
Daniel Dunbard2386812009-10-19 01:21:19 +00005163 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbara94ecd22008-08-16 03:19:19 +00005164}
5165
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005166void CGObjCMac::FinishModule() {
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005167 EmitModuleInfo();
5168
Daniel Dunbarc475d422008-10-29 22:36:39 +00005169 // Emit the dummy bodies for any protocols which were referenced but
5170 // never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005171 for (llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*>::iterator
Chris Lattnerf56501c2009-07-17 23:57:13 +00005172 I = Protocols.begin(), e = Protocols.end(); I != e; ++I) {
5173 if (I->second->hasInitializer())
Daniel Dunbarc475d422008-10-29 22:36:39 +00005174 continue;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005175
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005176 llvm::Constant *Values[5];
Owen Anderson0b75f232009-07-31 20:28:54 +00005177 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005178 Values[1] = GetClassName(I->first->getName());
Owen Anderson0b75f232009-07-31 20:28:54 +00005179 Values[2] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005180 Values[3] = Values[4] =
Owen Anderson0b75f232009-07-31 20:28:54 +00005181 llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00005182 I->second->setInitializer(llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarc475d422008-10-29 22:36:39 +00005183 Values));
Rafael Espindola060062a2014-03-06 22:15:10 +00005184 CGM.addCompilerUsedGlobal(I->second);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005185 }
5186
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005187 // Add assembler directives to add lazy undefined symbol references
5188 // for classes which are referenced but not defined. This is
5189 // important for correct linker interaction.
Daniel Dunbard027a922009-09-07 00:20:42 +00005190 //
5191 // FIXME: It would be nice if we had an LLVM construct for this.
5192 if (!LazySymbols.empty() || !DefinedSymbols.empty()) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005193 SmallString<256> Asm;
Daniel Dunbard027a922009-09-07 00:20:42 +00005194 Asm += CGM.getModule().getModuleInlineAsm();
5195 if (!Asm.empty() && Asm.back() != '\n')
5196 Asm += '\n';
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005197
Daniel Dunbard027a922009-09-07 00:20:42 +00005198 llvm::raw_svector_ostream OS(Asm);
Daniel Dunbard027a922009-09-07 00:20:42 +00005199 for (llvm::SetVector<IdentifierInfo*>::iterator I = DefinedSymbols.begin(),
5200 e = DefinedSymbols.end(); I != e; ++I)
Daniel Dunbar07d07852009-10-18 21:17:35 +00005201 OS << "\t.objc_class_name_" << (*I)->getName() << "=0\n"
5202 << "\t.globl .objc_class_name_" << (*I)->getName() << "\n";
Chris Lattnera299f2c2010-04-17 18:26:20 +00005203 for (llvm::SetVector<IdentifierInfo*>::iterator I = LazySymbols.begin(),
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005204 e = LazySymbols.end(); I != e; ++I) {
Chris Lattnera299f2c2010-04-17 18:26:20 +00005205 OS << "\t.lazy_reference .objc_class_name_" << (*I)->getName() << "\n";
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005206 }
5207
Bill Wendling53136852012-02-07 09:06:01 +00005208 for (size_t i = 0, e = DefinedCategoryNames.size(); i < e; ++i) {
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005209 OS << "\t.objc_category_name_" << DefinedCategoryNames[i] << "=0\n"
5210 << "\t.globl .objc_category_name_" << DefinedCategoryNames[i] << "\n";
5211 }
Chris Lattnera299f2c2010-04-17 18:26:20 +00005212
Daniel Dunbard027a922009-09-07 00:20:42 +00005213 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005214 }
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005215}
5216
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005217CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005218 : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00005219 ObjCTypes(cgm) {
Craig Topper8a13c412014-05-21 05:09:00 +00005220 ObjCEmptyCacheVar = ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005221 ObjCABI = 2;
5222}
5223
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005224/* *** */
5225
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005226ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Craig Topper8a13c412014-05-21 05:09:00 +00005227 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregora95f9aa2012-01-17 23:38:32 +00005228{
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005229 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5230 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005231
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005232 ShortTy = Types.ConvertType(Ctx.ShortTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005233 IntTy = Types.ConvertType(Ctx.IntTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005234 LongTy = Types.ConvertType(Ctx.LongTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00005235 LongLongTy = Types.ConvertType(Ctx.LongLongTy);
Chris Lattnerece04092012-02-07 00:39:47 +00005236 Int8PtrTy = CGM.Int8PtrTy;
5237 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005238
Tim Northover238b5082014-03-29 13:42:40 +00005239 // arm64 targets use "int" ivar offset variables. All others,
5240 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Tim Northover40956e62014-07-23 12:32:58 +00005241 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Tim Northover238b5082014-03-29 13:42:40 +00005242 IvarOffsetVarTy = IntTy;
5243 else
5244 IvarOffsetVarTy = LongTy;
5245
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005246 ObjectPtrTy = Types.ConvertType(Ctx.getObjCIdType());
Owen Anderson9793f0e2009-07-29 22:16:19 +00005247 PtrObjectPtrTy = llvm::PointerType::getUnqual(ObjectPtrTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005248 SelectorPtrTy = Types.ConvertType(Ctx.getObjCSelType());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005249
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005250 // I'm not sure I like this. The implicit coordination is a bit
5251 // gross. We should solve this in a reasonable fashion because this
5252 // is a pretty common task (match some runtime data structure with
5253 // an LLVM data structure).
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005254
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005255 // FIXME: This is leaked.
5256 // FIXME: Merge with rewriter code?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005257
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005258 // struct _objc_super {
5259 // id self;
5260 // Class cls;
5261 // }
Abramo Bagnara6150c882010-05-11 21:36:43 +00005262 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005263 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005264 SourceLocation(), SourceLocation(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005265 &Ctx.Idents.get("_objc_super"));
Craig Topper8a13c412014-05-21 05:09:00 +00005266 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5267 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5268 false, ICIS_NoInit));
5269 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5270 nullptr, Ctx.getObjCClassType(), nullptr,
5271 nullptr, false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005272 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005273
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005274 SuperCTy = Ctx.getTagDeclType(RD);
5275 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005276
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005277 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005278 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5279
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005280 // struct _prop_t {
5281 // char *name;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005282 // char *attributes;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005283 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005284 PropertyTy = llvm::StructType::create("struct._prop_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005285 Int8PtrTy, Int8PtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005286
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005287 // struct _prop_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005288 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005289 // uint32_t count_of_properties;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005290 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005291 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005292 PropertyListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005293 llvm::StructType::create("struct._prop_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005294 llvm::ArrayType::get(PropertyTy, 0), nullptr);
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005295 // struct _prop_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005296 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005297
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005298 // struct _objc_method {
5299 // SEL _cmd;
5300 // char *method_type;
5301 // char *_imp;
5302 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005303 MethodTy = llvm::StructType::create("struct._objc_method",
5304 SelectorPtrTy, Int8PtrTy, Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005305 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005306
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005307 // struct _objc_cache *
Chris Lattner5ec04a52011-08-12 17:43:31 +00005308 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005309 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005310}
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005311
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005312ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005313 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005314 // struct _objc_method_description {
5315 // SEL name;
5316 // char *types;
5317 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005318 MethodDescriptionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005319 llvm::StructType::create("struct._objc_method_description",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005320 SelectorPtrTy, Int8PtrTy, nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005321
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005322 // struct _objc_method_description_list {
5323 // int count;
5324 // struct _objc_method_description[1];
5325 // }
Reid Kleckneree7cf842014-12-01 22:02:27 +00005326 MethodDescriptionListTy = llvm::StructType::create(
5327 "struct._objc_method_description_list", IntTy,
5328 llvm::ArrayType::get(MethodDescriptionTy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005329
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005330 // struct _objc_method_description_list *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005331 MethodDescriptionListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005332 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005333
Daniel Dunbarb036db82008-08-13 03:21:16 +00005334 // Protocol description structures
5335
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005336 // struct _objc_protocol_extension {
5337 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5338 // struct _objc_method_description_list *optional_instance_methods;
5339 // struct _objc_method_description_list *optional_class_methods;
5340 // struct _objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005341 // const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00005342 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005343 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005344 ProtocolExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005345 llvm::StructType::create("struct._objc_protocol_extension",
5346 IntTy, MethodDescriptionListPtrTy,
5347 MethodDescriptionListPtrTy, PropertyListPtrTy,
Manman Rence7bff52016-01-29 23:46:55 +00005348 Int8PtrPtrTy, PropertyListPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005349
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005350 // struct _objc_protocol_extension *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005351 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005352
Daniel Dunbarc475d422008-10-29 22:36:39 +00005353 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbarb036db82008-08-13 03:21:16 +00005354
Chris Lattnera5f58b02011-07-09 17:41:47 +00005355 ProtocolTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005356 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbarb036db82008-08-13 03:21:16 +00005357
Chris Lattnera5f58b02011-07-09 17:41:47 +00005358 ProtocolListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005359 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005360 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy),
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005361 LongTy,
Chris Lattnera5f58b02011-07-09 17:41:47 +00005362 llvm::ArrayType::get(ProtocolTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005363 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005364
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005365 // struct _objc_protocol {
5366 // struct _objc_protocol_extension *isa;
5367 // char *protocol_name;
5368 // struct _objc_protocol **_objc_protocol_list;
5369 // struct _objc_method_description_list *instance_methods;
5370 // struct _objc_method_description_list *class_methods;
5371 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005372 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5373 llvm::PointerType::getUnqual(ProtocolListTy),
5374 MethodDescriptionListPtrTy,
5375 MethodDescriptionListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005376 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005377
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005378 // struct _objc_protocol_list *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005379 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005380
Owen Anderson9793f0e2009-07-29 22:16:19 +00005381 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005382
5383 // Class description structures
5384
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005385 // struct _objc_ivar {
5386 // char *ivar_name;
5387 // char *ivar_type;
5388 // int ivar_offset;
5389 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005390 IvarTy = llvm::StructType::create("struct._objc_ivar",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005391 Int8PtrTy, Int8PtrTy, IntTy, nullptr);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005392
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005393 // struct _objc_ivar_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005394 IvarListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005395 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005396 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005397
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005398 // struct _objc_method_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005399 MethodListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005400 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005401 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005402
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005403 // struct _objc_class_extension *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005404 ClassExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005405 llvm::StructType::create("struct._objc_class_extension",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005406 IntTy, Int8PtrTy, PropertyListPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005407 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005408
Chris Lattner5ec04a52011-08-12 17:43:31 +00005409 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005410
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005411 // struct _objc_class {
5412 // Class isa;
5413 // Class super_class;
5414 // char *name;
5415 // long version;
5416 // long info;
5417 // long instance_size;
5418 // struct _objc_ivar_list *ivars;
5419 // struct _objc_method_list *methods;
5420 // struct _objc_cache *cache;
5421 // struct _objc_protocol_list *protocols;
5422 // char *ivar_layout;
5423 // struct _objc_class_ext *ext;
5424 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005425 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
5426 llvm::PointerType::getUnqual(ClassTy),
5427 Int8PtrTy,
5428 LongTy,
5429 LongTy,
5430 LongTy,
5431 IvarListPtrTy,
5432 MethodListPtrTy,
5433 CachePtrTy,
5434 ProtocolListPtrTy,
5435 Int8PtrTy,
5436 ClassExtensionPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005437 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005438
Owen Anderson9793f0e2009-07-29 22:16:19 +00005439 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005440
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005441 // struct _objc_category {
5442 // char *category_name;
5443 // char *class_name;
5444 // struct _objc_method_list *instance_method;
5445 // struct _objc_method_list *class_method;
Manman Renb3736772016-01-25 22:37:47 +00005446 // struct _objc_protocol_list *protocols;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005447 // uint32_t size; // sizeof(struct _objc_category)
5448 // struct _objc_property_list *instance_properties;// category's @property
Manman Ren96df0b32016-01-29 23:45:01 +00005449 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005450 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005451 CategoryTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005452 llvm::StructType::create("struct._objc_category",
5453 Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5454 MethodListPtrTy, ProtocolListPtrTy,
Manman Ren96df0b32016-01-29 23:45:01 +00005455 IntTy, PropertyListPtrTy, PropertyListPtrTy,
5456 nullptr);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005457
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005458 // Global metadata structures
5459
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005460 // struct _objc_symtab {
5461 // long sel_ref_cnt;
5462 // SEL *refs;
5463 // short cls_def_cnt;
5464 // short cat_def_cnt;
5465 // char *defs[cls_def_cnt + cat_def_cnt];
5466 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005467 SymtabTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005468 llvm::StructType::create("struct._objc_symtab",
5469 LongTy, SelectorPtrTy, ShortTy, ShortTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005470 llvm::ArrayType::get(Int8PtrTy, 0), nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005471 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005472
Fariborz Jahanianeee54df2009-01-22 00:37:21 +00005473 // struct _objc_module {
5474 // long version;
5475 // long size; // sizeof(struct _objc_module)
5476 // char *name;
5477 // struct _objc_symtab* symtab;
5478 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005479 ModuleTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005480 llvm::StructType::create("struct._objc_module",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005481 LongTy, LongTy, Int8PtrTy, SymtabPtrTy, nullptr);
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00005482
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005483
Mike Stump18bb9282009-05-16 07:57:57 +00005484 // FIXME: This is the size of the setjmp buffer and should be target
5485 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson9ff22482008-09-09 10:10:21 +00005486 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005487
Anders Carlsson9ff22482008-09-09 10:10:21 +00005488 // Exceptions
Chris Lattnerece04092012-02-07 00:39:47 +00005489 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005490
5491 ExceptionDataTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005492 llvm::StructType::create("struct._objc_exception_data",
Chris Lattnerece04092012-02-07 00:39:47 +00005493 llvm::ArrayType::get(CGM.Int32Ty,SetJmpBufferSize),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005494 StackPtrTy, nullptr);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005495}
5496
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005497ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005498 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005499 // struct _method_list_t {
5500 // uint32_t entsize; // sizeof(struct _objc_method)
5501 // uint32_t method_count;
5502 // struct _objc_method method_list[method_count];
5503 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005504 MethodListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005505 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005506 llvm::ArrayType::get(MethodTy, 0), nullptr);
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005507 // struct method_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005508 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005509
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005510 // struct _protocol_t {
5511 // id isa; // NULL
5512 // const char * const protocol_name;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005513 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005514 // const struct method_list_t * const instance_methods;
5515 // const struct method_list_t * const class_methods;
5516 // const struct method_list_t *optionalInstanceMethods;
5517 // const struct method_list_t *optionalClassMethods;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005518 // const struct _prop_list_t * properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005519 // const uint32_t size; // sizeof(struct _protocol_t)
5520 // const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005521 // const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005522 // const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00005523 // const struct _prop_list_t * class_properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005524 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005525
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005526 // Holder for struct _protocol_list_t *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005527 ProtocolListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005528 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005529
Chris Lattnera5f58b02011-07-09 17:41:47 +00005530 ProtocolnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005531 llvm::StructType::create("struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5532 llvm::PointerType::getUnqual(ProtocolListnfABITy),
5533 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5534 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005535 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy,
Manman Rence7bff52016-01-29 23:46:55 +00005536 Int8PtrTy, PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005537 nullptr);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005538
5539 // struct _protocol_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005540 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005541
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005542 // struct _protocol_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005543 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005544 // struct _protocol_t *[protocol_count];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005545 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005546 ProtocolListnfABITy->setBody(LongTy,
5547 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005548 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005549
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005550 // struct _objc_protocol_list*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005551 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005552
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005553 // struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00005554 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005555 // char *name;
5556 // char *type;
5557 // uint32_t alignment;
5558 // uint32_t size;
5559 // }
Tim Northover238b5082014-03-29 13:42:40 +00005560 IvarnfABITy = llvm::StructType::create(
5561 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005562 Int8PtrTy, Int8PtrTy, IntTy, IntTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005563
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005564 // struct _ivar_list_t {
5565 // uint32 entsize; // sizeof(struct _ivar_t)
5566 // uint32 count;
5567 // struct _iver_t list[count];
5568 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005569 IvarListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005570 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005571 llvm::ArrayType::get(IvarnfABITy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005572
Owen Anderson9793f0e2009-07-29 22:16:19 +00005573 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005574
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005575 // struct _class_ro_t {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005576 // uint32_t const flags;
5577 // uint32_t const instanceStart;
5578 // uint32_t const instanceSize;
5579 // uint32_t const reserved; // only when building for 64bit targets
5580 // const uint8_t * const ivarLayout;
5581 // const char *const name;
5582 // const struct _method_list_t * const baseMethods;
5583 // const struct _objc_protocol_list *const baseProtocols;
5584 // const struct _ivar_list_t *const ivars;
5585 // const uint8_t * const weakIvarLayout;
5586 // const struct _prop_list_t * const properties;
5587 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005588
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005589 // FIXME. Add 'reserved' field in 64bit abi mode!
Chris Lattner5ec04a52011-08-12 17:43:31 +00005590 ClassRonfABITy = llvm::StructType::create("struct._class_ro_t",
5591 IntTy, IntTy, IntTy, Int8PtrTy,
5592 Int8PtrTy, MethodListnfABIPtrTy,
5593 ProtocolListnfABIPtrTy,
5594 IvarListnfABIPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005595 Int8PtrTy, PropertyListPtrTy,
5596 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005597
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005598 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +00005599 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +00005600 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5601 ->getPointerTo();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005602
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005603 // struct _class_t {
5604 // struct _class_t *isa;
5605 // struct _class_t * const superclass;
5606 // void *cache;
5607 // IMP *vtable;
5608 // struct class_ro_t *ro;
5609 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005610
Chris Lattner5ec04a52011-08-12 17:43:31 +00005611 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005612 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
5613 llvm::PointerType::getUnqual(ClassnfABITy),
5614 CachePtrTy,
5615 llvm::PointerType::getUnqual(ImpnfABITy),
5616 llvm::PointerType::getUnqual(ClassRonfABITy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005617 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005618
Fariborz Jahanian71394042009-01-23 23:53:38 +00005619 // LLVM for struct _class_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005620 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005621
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005622 // struct _category_t {
5623 // const char * const name;
5624 // struct _class_t *const cls;
5625 // const struct _method_list_t * const instance_methods;
5626 // const struct _method_list_t * const class_methods;
5627 // const struct _protocol_list_t * const protocols;
5628 // const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00005629 // const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00005630 // const uint32_t size;
Fariborz Jahanian5a63e4c2009-01-23 17:41:22 +00005631 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005632 CategorynfABITy = llvm::StructType::create("struct._category_t",
5633 Int8PtrTy, ClassnfABIPtrTy,
5634 MethodListnfABIPtrTy,
5635 MethodListnfABIPtrTy,
5636 ProtocolListnfABIPtrTy,
5637 PropertyListPtrTy,
Manman Ren96df0b32016-01-29 23:45:01 +00005638 PropertyListPtrTy,
Manman Ren42ff3902016-02-24 17:49:50 +00005639 IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005640 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005641
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005642 // New types for nonfragile abi messaging.
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005643 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5644 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005645
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005646 // MessageRefTy - LLVM for:
5647 // struct _message_ref_t {
5648 // IMP messenger;
5649 // SEL name;
5650 // };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005651
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005652 // First the clang type for struct _message_ref_t
Abramo Bagnara6150c882010-05-11 21:36:43 +00005653 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005654 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005655 SourceLocation(), SourceLocation(),
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005656 &Ctx.Idents.get("_message_ref_t"));
Craig Topper8a13c412014-05-21 05:09:00 +00005657 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5658 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smith2b013182012-06-10 03:12:00 +00005659 ICIS_NoInit));
Craig Topper8a13c412014-05-21 05:09:00 +00005660 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5661 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5662 false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005663 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005664
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005665 MessageRefCTy = Ctx.getTagDeclType(RD);
5666 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5667 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005668
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005669 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005670 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005671
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005672 // SuperMessageRefTy - LLVM for:
5673 // struct _super_message_ref_t {
5674 // SUPER_IMP messenger;
5675 // SEL name;
5676 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005677 SuperMessageRefTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005678 llvm::StructType::create("struct._super_message_ref_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005679 ImpnfABITy, SelectorPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005680
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005681 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005682 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005683
Daniel Dunbarb1559a42009-03-01 04:46:24 +00005684
5685 // struct objc_typeinfo {
5686 // const void** vtable; // objc_ehtype_vtable + 2
5687 // const char* name; // c++ typeinfo string
5688 // Class cls;
5689 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005690 EHTypeTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005691 llvm::StructType::create("struct._objc_typeinfo",
5692 llvm::PointerType::getUnqual(Int8PtrTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005693 Int8PtrTy, ClassnfABIPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005694 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005695}
5696
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005697llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanian71394042009-01-23 23:53:38 +00005698 FinishNonFragileABIModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005699
Craig Topper8a13c412014-05-21 05:09:00 +00005700 return nullptr;
Fariborz Jahanian71394042009-01-23 23:53:38 +00005701}
5702
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00005703void CGObjCNonFragileABIMac::
5704AddModuleClassList(ArrayRef<llvm::GlobalValue*> Container,
5705 const char *SymbolName,
5706 const char *SectionName) {
Daniel Dunbar19573e72009-05-15 21:48:48 +00005707 unsigned NumClasses = Container.size();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005708
Daniel Dunbar19573e72009-05-15 21:48:48 +00005709 if (!NumClasses)
5710 return;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005711
Chris Lattner3def9ae2012-02-06 22:16:34 +00005712 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005713 for (unsigned i=0; i<NumClasses; i++)
Owen Andersonade90fd2009-07-29 18:54:39 +00005714 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar19573e72009-05-15 21:48:48 +00005715 ObjCTypes.Int8PtrTy);
Chris Lattner3def9ae2012-02-06 22:16:34 +00005716 llvm::Constant *Init =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005717 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00005718 Symbols.size()),
Daniel Dunbar19573e72009-05-15 21:48:48 +00005719 Symbols);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005720
Daniel Dunbar19573e72009-05-15 21:48:48 +00005721 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00005722 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005723 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar19573e72009-05-15 21:48:48 +00005724 Init,
Owen Andersonc10c8d32009-07-08 19:05:04 +00005725 SymbolName);
Micah Villmowdd31ca12012-10-08 16:25:52 +00005726 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar19573e72009-05-15 21:48:48 +00005727 GV->setSection(SectionName);
Rafael Espindola060062a2014-03-06 22:15:10 +00005728 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005729}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005730
Fariborz Jahanian71394042009-01-23 23:53:38 +00005731void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
5732 // nonfragile abi has no module definition.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005733
Daniel Dunbar19573e72009-05-15 21:48:48 +00005734 // Build list of all implemented class addresses in array
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005735 // L_OBJC_LABEL_CLASS_$.
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005736
5737 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
5738 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5739 assert(ID);
5740 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5741 // We are implementing a weak imported interface. Give it external linkage
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005742 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005743 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005744 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
5745 }
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005746 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005747
5748 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005749 "__DATA, __objc_classlist, regular, no_dead_strip");
Rafael Espindola554256c2014-02-26 22:25:45 +00005750
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005751 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005752 "__DATA, __objc_nlclslist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005753
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005754 // Build list of all implemented category addresses in array
5755 // L_OBJC_LABEL_CATEGORY_$.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005756 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005757 "__DATA, __objc_catlist, regular, no_dead_strip");
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005758 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005759 "__DATA, __objc_nlcatlist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005760
Daniel Dunbar5e639272010-04-25 20:39:01 +00005761 EmitImageInfo();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005762}
5763
John McCall9e8bb002011-05-14 03:10:52 +00005764/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
5765/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005766/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005767/// message dispatch call for all the rest.
John McCall9e8bb002011-05-14 03:10:52 +00005768bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
5769 // At various points we've experimented with using vtable-based
5770 // dispatch for all methods.
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005771 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005772 case CodeGenOptions::Legacy:
Fariborz Jahaniandfb39832010-04-19 17:53:30 +00005773 return false;
John McCall9e8bb002011-05-14 03:10:52 +00005774 case CodeGenOptions::NonLegacy:
5775 return true;
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005776 case CodeGenOptions::Mixed:
5777 break;
5778 }
5779
5780 // If so, see whether this selector is in the white-list of things which must
5781 // use the new dispatch convention. We lazily build a dense set for this.
John McCall9e8bb002011-05-14 03:10:52 +00005782 if (VTableDispatchMethods.empty()) {
5783 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
5784 VTableDispatchMethods.insert(GetNullarySelector("class"));
5785 VTableDispatchMethods.insert(GetNullarySelector("self"));
5786 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
5787 VTableDispatchMethods.insert(GetNullarySelector("length"));
5788 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005789
John McCall9e8bb002011-05-14 03:10:52 +00005790 // These are vtable-based if GC is disabled.
5791 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005792 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall9e8bb002011-05-14 03:10:52 +00005793 VTableDispatchMethods.insert(GetNullarySelector("retain"));
5794 VTableDispatchMethods.insert(GetNullarySelector("release"));
5795 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
5796 }
5797
5798 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
5799 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
5800 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
5801 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
5802 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
5803 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
5804 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
5805
5806 // These are vtable-based if GC is enabled.
5807 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005808 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall9e8bb002011-05-14 03:10:52 +00005809 VTableDispatchMethods.insert(GetNullarySelector("hash"));
5810 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
5811
5812 // "countByEnumeratingWithState:objects:count"
5813 IdentifierInfo *KeyIdents[] = {
5814 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
5815 &CGM.getContext().Idents.get("objects"),
5816 &CGM.getContext().Idents.get("count")
5817 };
5818 VTableDispatchMethods.insert(
5819 CGM.getContext().Selectors.getSelector(3, KeyIdents));
5820 }
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005821 }
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005822
John McCall9e8bb002011-05-14 03:10:52 +00005823 return VTableDispatchMethods.count(Sel);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005824}
5825
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005826/// BuildClassRoTInitializer - generate meta-data for:
5827/// struct _class_ro_t {
5828/// uint32_t const flags;
5829/// uint32_t const instanceStart;
5830/// uint32_t const instanceSize;
5831/// uint32_t const reserved; // only when building for 64bit targets
5832/// const uint8_t * const ivarLayout;
5833/// const char *const name;
5834/// const struct _method_list_t * const baseMethods;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005835/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005836/// const struct _ivar_list_t *const ivars;
5837/// const uint8_t * const weakIvarLayout;
5838/// const struct _prop_list_t * const properties;
5839/// }
5840///
5841llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005842 unsigned flags,
5843 unsigned InstanceStart,
5844 unsigned InstanceSize,
5845 const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005846 std::string ClassName = ID->getObjCRuntimeNameAsString();
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005847 llvm::Constant *Values[10]; // 11 for 64bit targets!
John McCall31168b02011-06-15 23:02:42 +00005848
John McCall3fd13f062015-10-21 18:06:47 +00005849 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
5850 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
5851
John McCall460ce582015-10-22 18:38:17 +00005852 bool hasMRCWeak = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005853 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallef19dbb2012-10-17 04:53:23 +00005854 flags |= NonFragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00005855 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
5856 flags |= NonFragileABI_Class_HasMRCWeakIvars;
John McCall31168b02011-06-15 23:02:42 +00005857
Owen Andersonb7a2fe62009-07-24 23:12:58 +00005858 Values[ 0] = llvm::ConstantInt::get(ObjCTypes.IntTy, flags);
5859 Values[ 1] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceStart);
5860 Values[ 2] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceSize);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005861 // FIXME. For 64bit targets add 0 here.
John McCallef19dbb2012-10-17 04:53:23 +00005862 Values[ 3] = (flags & NonFragileABI_Class_Meta)
Craig Topper8a13c412014-05-21 05:09:00 +00005863 ? GetIvarLayoutName(nullptr, ObjCTypes)
John McCall460ce582015-10-22 18:38:17 +00005864 : BuildStrongIvarLayout(ID, beginInstance, endInstance);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005865 Values[ 4] = GetClassName(ID->getObjCRuntimeNameAsString());
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005866 // const struct _method_list_t * const baseMethods;
5867 std::vector<llvm::Constant*> Methods;
5868 std::string MethodListName("\01l_OBJC_$_");
John McCallef19dbb2012-10-17 04:53:23 +00005869 if (flags & NonFragileABI_Class_Meta) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005870 MethodListName += "CLASS_METHODS_";
5871 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005872 for (const auto *I : ID->class_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005873 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005874 Methods.push_back(GetMethodConstant(I));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005875 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005876 MethodListName += "INSTANCE_METHODS_";
5877 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005878 for (const auto *I : ID->instance_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005879 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005880 Methods.push_back(GetMethodConstant(I));
5881
Aaron Ballmand85eff42014-03-14 15:02:45 +00005882 for (const auto *PID : ID->property_impls()) {
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005883 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
5884 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005885
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005886 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
5887 if (llvm::Constant *C = GetMethodConstant(MD))
5888 Methods.push_back(C);
5889 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
5890 if (llvm::Constant *C = GetMethodConstant(MD))
5891 Methods.push_back(C);
5892 }
5893 }
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005894 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005895 Values[ 5] = EmitMethodList(MethodListName,
5896 "__DATA, __objc_const", Methods);
5897
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005898 const ObjCInterfaceDecl *OID = ID->getClassInterface();
5899 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005900 Values[ 6] = EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005901 + OID->getObjCRuntimeNameAsString(),
Ted Kremenek0ef508d2010-09-01 01:21:15 +00005902 OID->all_referenced_protocol_begin(),
5903 OID->all_referenced_protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005904
John McCallef19dbb2012-10-17 04:53:23 +00005905 if (flags & NonFragileABI_Class_Meta) {
Owen Anderson0b75f232009-07-31 20:28:54 +00005906 Values[ 7] = llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00005907 Values[ 8] = GetIvarLayoutName(nullptr, ObjCTypes);
Manman Renad0e7912016-01-29 19:22:54 +00005908 Values[ 9] = EmitPropertyList(
5909 "\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
5910 ID, ID->getClassInterface(), ObjCTypes, true);
John McCallef19dbb2012-10-17 04:53:23 +00005911 } else {
5912 Values[ 7] = EmitIvarList(ID);
John McCall460ce582015-10-22 18:38:17 +00005913 Values[ 8] = BuildWeakIvarLayout(ID, beginInstance, endInstance,
5914 hasMRCWeak);
Manman Renad0e7912016-01-29 19:22:54 +00005915 Values[ 9] = EmitPropertyList(
5916 "\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
5917 ID, ID->getClassInterface(), ObjCTypes, false);
John McCallef19dbb2012-10-17 04:53:23 +00005918 }
Owen Anderson0e0189d2009-07-27 22:29:56 +00005919 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassRonfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005920 Values);
5921 llvm::GlobalVariable *CLASS_RO_GV =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005922 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassRonfABITy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005923 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005924 Init,
John McCallef19dbb2012-10-17 04:53:23 +00005925 (flags & NonFragileABI_Class_Meta) ?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005926 std::string("\01l_OBJC_METACLASS_RO_$_")+ClassName :
5927 std::string("\01l_OBJC_CLASS_RO_$_")+ClassName);
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005928 CLASS_RO_GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005929 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassRonfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00005930 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005931 return CLASS_RO_GV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00005932
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005933}
5934
5935/// BuildClassMetaData - This routine defines that to-level meta-data
5936/// for the given ClassName for:
5937/// struct _class_t {
5938/// struct _class_t *isa;
5939/// struct _class_t * const superclass;
5940/// void *cache;
5941/// IMP *vtable;
5942/// struct class_ro_t *ro;
5943/// }
5944///
Rafael Espindola554256c2014-02-26 22:25:45 +00005945llvm::GlobalVariable *CGObjCNonFragileABIMac::BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005946 const std::string &ClassName, llvm::Constant *IsAGV, llvm::Constant *SuperClassGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00005947 llvm::Constant *ClassRoGV, bool HiddenVisibility, bool Weak) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005948 llvm::Constant *Values[] = {
5949 IsAGV,
5950 SuperClassGV,
5951 ObjCEmptyCacheVar, // &ObjCEmptyCacheVar
5952 ObjCEmptyVtableVar, // &ObjCEmptyVtableVar
5953 ClassRoGV // &CLASS_RO_GV
5954 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005955 if (!Values[1])
5956 Values[1] = llvm::Constant::getNullValue(ObjCTypes.ClassnfABIPtrTy);
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005957 if (!Values[3])
5958 Values[3] = llvm::Constant::getNullValue(
5959 llvm::PointerType::getUnqual(ObjCTypes.ImpnfABITy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005960 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassnfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005961 Values);
Rafael Espindola554256c2014-02-26 22:25:45 +00005962 llvm::GlobalVariable *GV = GetClassGlobal(ClassName, Weak);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00005963 GV->setInitializer(Init);
Fariborz Jahanian04087232009-01-31 01:07:39 +00005964 GV->setSection("__DATA, __objc_data");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005965 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005966 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Fariborz Jahanian82208252009-01-31 00:59:10 +00005967 if (HiddenVisibility)
5968 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005969 return GV;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005970}
5971
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005972bool
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00005973CGObjCNonFragileABIMac::ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
Craig Topper8a13c412014-05-21 05:09:00 +00005974 return OD->getClassMethod(GetNullarySelector("load")) != nullptr;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005975}
5976
Daniel Dunbar961202372009-05-03 12:57:56 +00005977void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00005978 uint32_t &InstanceStart,
5979 uint32_t &InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005980 const ASTRecordLayout &RL =
Daniel Dunbar9252ee12009-05-04 21:26:30 +00005981 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005982
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005983 // InstanceSize is really instance end.
Ken Dyckd5090c12011-02-11 02:20:09 +00005984 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005985
5986 // If there are no fields, the start is the same as the end.
5987 if (!RL.getFieldCount())
5988 InstanceStart = InstanceSize;
5989 else
Ken Dyckc5ca8762011-04-14 00:43:09 +00005990 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbar554fd792009-04-19 23:41:48 +00005991}
5992
Fariborz Jahanian71394042009-01-23 23:53:38 +00005993void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005994 std::string ClassName = ID->getObjCRuntimeNameAsString();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005995 if (!ObjCEmptyCacheVar) {
5996 ObjCEmptyCacheVar = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005997 CGM.getModule(),
5998 ObjCTypes.CacheTy,
5999 false,
6000 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00006001 nullptr,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006002 "_objc_empty_cache");
Craig Topper8a13c412014-05-21 05:09:00 +00006003
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006004 // Make this entry NULL for any iOS device target, any iOS simulator target,
6005 // OS X with deployment target 10.9 or later.
6006 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00006007 if (Triple.isiOS() || Triple.isWatchOS() ||
6008 (Triple.isMacOSX() && !Triple.isMacOSXVersionLT(10, 9)))
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006009 // This entry will be null.
Craig Topper8a13c412014-05-21 05:09:00 +00006010 ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006011 else
6012 ObjCEmptyVtableVar = new llvm::GlobalVariable(
6013 CGM.getModule(),
6014 ObjCTypes.ImpnfABITy,
6015 false,
6016 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00006017 nullptr,
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006018 "_objc_empty_vtable");
Fariborz Jahanian71394042009-01-23 23:53:38 +00006019 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006020 assert(ID->getClassInterface() &&
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006021 "CGObjCNonFragileABIMac::GenerateClass - class is 0");
Daniel Dunbare3f5cfc2009-04-20 20:18:54 +00006022 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006023 uint32_t InstanceStart =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006024 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006025 uint32_t InstanceSize = InstanceStart;
John McCallef19dbb2012-10-17 04:53:23 +00006026 uint32_t flags = NonFragileABI_Class_Meta;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006027 llvm::SmallString<64> ObjCMetaClassName(getMetaclassSymbolPrefix());
6028 llvm::SmallString<64> ObjCClassName(getClassSymbolPrefix());
6029 llvm::SmallString<64> TClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006030
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006031 llvm::GlobalVariable *SuperClassGV, *IsAGV;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006032
John McCall0d54a172012-10-17 04:53:31 +00006033 // Build the flags for the metaclass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006034 bool classIsHidden =
John McCall457a04e2010-10-22 21:05:15 +00006035 ID->getClassInterface()->getVisibility() == HiddenVisibility;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006036 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006037 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006038
6039 // FIXME: why is this flag set on the metaclass?
6040 // ObjC metaclasses have no fields and don't really get constructed.
6041 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006042 flags |= NonFragileABI_Class_HasCXXStructors;
John McCall0d54a172012-10-17 04:53:31 +00006043 if (!ID->hasNonZeroConstructors())
6044 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6045 }
6046
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006047 if (!ID->getClassInterface()->getSuperClass()) {
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006048 // class is root
John McCallef19dbb2012-10-17 04:53:23 +00006049 flags |= NonFragileABI_Class_Root;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006050 TClassName = ObjCClassName;
6051 TClassName += ClassName;
6052 SuperClassGV = GetClassGlobal(TClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006053 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006054 TClassName = ObjCMetaClassName;
6055 TClassName += ClassName;
6056 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00006057 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006058 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006059 // Has a root. Current class is not a root.
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00006060 const ObjCInterfaceDecl *Root = ID->getClassInterface();
6061 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
6062 Root = Super;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006063 TClassName = ObjCMetaClassName ;
6064 TClassName += Root->getObjCRuntimeNameAsString();
6065 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00006066 Root->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006067
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00006068 // work on super class metadata symbol.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006069 TClassName = ObjCMetaClassName;
6070 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00006071 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006072 TClassName.str(),
6073 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006074 }
6075 llvm::GlobalVariable *CLASS_RO_GV = BuildClassRoTInitializer(flags,
6076 InstanceStart,
6077 InstanceSize,ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006078 TClassName = ObjCMetaClassName;
6079 TClassName += ClassName;
Rafael Espindola554256c2014-02-26 22:25:45 +00006080 llvm::GlobalVariable *MetaTClass = BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006081 TClassName.str(), IsAGV, SuperClassGV, CLASS_RO_GV, classIsHidden,
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00006082 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian67260552009-11-17 21:37:35 +00006083 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar15894b72009-04-07 05:48:37 +00006084
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006085 // Metadata for the class
John McCallef19dbb2012-10-17 04:53:23 +00006086 flags = 0;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006087 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006088 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006089
6090 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006091 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006092
John McCall0d54a172012-10-17 04:53:31 +00006093 // Set a flag to enable a runtime optimization when a class has
6094 // fields that require destruction but which don't require
6095 // anything except zero-initialization during construction. This
6096 // is most notably true of __strong and __weak types, but you can
6097 // also imagine there being C++ types with non-trivial default
6098 // constructors that merely set all fields to null.
6099 if (!ID->hasNonZeroConstructors())
6100 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6101 }
6102
Douglas Gregor78bd61f2009-06-18 16:11:24 +00006103 if (hasObjCExceptionAttribute(CGM.getContext(), ID->getClassInterface()))
John McCallef19dbb2012-10-17 04:53:23 +00006104 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006105
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006106 if (!ID->getClassInterface()->getSuperClass()) {
John McCallef19dbb2012-10-17 04:53:23 +00006107 flags |= NonFragileABI_Class_Root;
Craig Topper8a13c412014-05-21 05:09:00 +00006108 SuperClassGV = nullptr;
Chris Lattnerb433b272009-04-19 06:02:28 +00006109 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006110 // Has a root. Current class is not a root.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006111 TClassName = ObjCClassName;
6112 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00006113 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006114 TClassName.str(),
6115 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006116 }
Daniel Dunbar961202372009-05-03 12:57:56 +00006117 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006118 CLASS_RO_GV = BuildClassRoTInitializer(flags,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00006119 InstanceStart,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006120 InstanceSize,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00006121 ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006122
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006123 TClassName = ObjCClassName;
6124 TClassName += ClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006125 llvm::GlobalVariable *ClassMD =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006126 BuildClassMetaData(TClassName.str(), MetaTClass, SuperClassGV, CLASS_RO_GV,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006127 classIsHidden,
6128 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006129 DefinedClasses.push_back(ClassMD);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006130 ImplementedClasses.push_back(ID->getClassInterface());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006131
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006132 // Determine if this class is also "non-lazy".
6133 if (ImplementationIsNonLazy(ID))
6134 DefinedNonLazyClasses.push_back(ClassMD);
6135
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006136 // Force the definition of the EHType if necessary.
John McCallef19dbb2012-10-17 04:53:23 +00006137 if (flags & NonFragileABI_Class_Exception)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006138 GetInterfaceEHType(ID->getClassInterface(), true);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006139 // Make sure method definition entries are all clear for next implementation.
6140 MethodDefinitions.clear();
Fariborz Jahanian71394042009-01-23 23:53:38 +00006141}
6142
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006143/// GenerateProtocolRef - This routine is called to generate code for
6144/// a protocol reference expression; as in:
6145/// @code
6146/// @protocol(Proto1);
6147/// @endcode
6148/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
6149/// which will hold address of the protocol meta-data.
6150///
John McCall882987f2013-02-28 19:01:20 +00006151llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006152 const ObjCProtocolDecl *PD) {
6153
Fariborz Jahanian464423d2009-04-10 18:47:34 +00006154 // This routine is called for @protocol only. So, we must build definition
6155 // of protocol's meta-data (not a reference to it!)
6156 //
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006157 llvm::Constant *Init =
6158 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00006159 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006160
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006161 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006162 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006163
John McCall7f416cc2015-09-08 08:05:57 +00006164 CharUnits Align = CGF.getPointerAlign();
6165
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006166 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
6167 if (PTGV)
John McCall7f416cc2015-09-08 08:05:57 +00006168 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006169 PTGV = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006170 CGM.getModule(),
6171 Init->getType(), false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006172 llvm::GlobalValue::WeakAnyLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006173 Init,
6174 ProtocolName);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006175 PTGV->setSection("__DATA, __objc_protorefs, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006176 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall7f416cc2015-09-08 08:05:57 +00006177 PTGV->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00006178 CGM.addCompilerUsedGlobal(PTGV);
John McCall7f416cc2015-09-08 08:05:57 +00006179 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006180}
6181
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006182/// GenerateCategory - Build metadata for a category implementation.
6183/// struct _category_t {
6184/// const char * const name;
6185/// struct _class_t *const cls;
6186/// const struct _method_list_t * const instance_methods;
6187/// const struct _method_list_t * const class_methods;
6188/// const struct _protocol_list_t * const protocols;
6189/// const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00006190/// const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00006191/// const uint32_t size;
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006192/// }
6193///
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006194void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006195 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006196 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006197
6198 llvm::SmallString<64> ExtCatName(Prefix);
6199 ExtCatName += Interface->getObjCRuntimeNameAsString();
6200 ExtCatName += "_$_";
6201 ExtCatName += OCD->getNameAsString();
6202
6203 llvm::SmallString<64> ExtClassName(getClassSymbolPrefix());
6204 ExtClassName += Interface->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006205
Manman Ren42ff3902016-02-24 17:49:50 +00006206 llvm::Constant *Values[8];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006207 Values[0] = GetClassName(OCD->getIdentifier()->getName());
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006208 // meta-class entry symbol
Rafael Espindola554256c2014-02-26 22:25:45 +00006209 llvm::GlobalVariable *ClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006210 GetClassGlobal(ExtClassName.str(), Interface->isWeakImported());
Rafael Espindola554256c2014-02-26 22:25:45 +00006211
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006212 Values[1] = ClassGV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006213 std::vector<llvm::Constant*> Methods;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006214 llvm::SmallString<64> MethodListName(Prefix);
6215
6216 MethodListName += "INSTANCE_METHODS_";
6217 MethodListName += Interface->getObjCRuntimeNameAsString();
6218 MethodListName += "_$_";
6219 MethodListName += OCD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006220
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006221 for (const auto *I : OCD->instance_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006222 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006223 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006224
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006225 Values[2] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006226 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006227 Methods);
6228
6229 MethodListName = Prefix;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006230 MethodListName += "CLASS_METHODS_";
6231 MethodListName += Interface->getObjCRuntimeNameAsString();
6232 MethodListName += "_$_";
6233 MethodListName += OCD->getNameAsString();
6234
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006235 Methods.clear();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006236 for (const auto *I : OCD->class_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006237 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006238 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006239
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006240 Values[3] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006241 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006242 Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006243 const ObjCCategoryDecl *Category =
Fariborz Jahanian066347e2009-01-28 22:18:42 +00006244 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006245 if (Category) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006246 SmallString<256> ExtName;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006247 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006248 << OCD->getName();
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006249 Values[4] = EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006250 + Interface->getObjCRuntimeNameAsString() + "_$_"
6251 + Category->getName(),
6252 Category->protocol_begin(),
6253 Category->protocol_end());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006254 Values[5] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Manman Renad0e7912016-01-29 19:22:54 +00006255 OCD, Category, ObjCTypes, false);
Manman Ren96df0b32016-01-29 23:45:01 +00006256 Values[6] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
6257 OCD, Category, ObjCTypes, true);
Mike Stump658fe022009-07-30 22:28:39 +00006258 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00006259 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
6260 Values[5] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Manman Ren96df0b32016-01-29 23:45:01 +00006261 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006262 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006263
Manman Ren42ff3902016-02-24 17:49:50 +00006264 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategorynfABITy);
6265 Values[7] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6266
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006267 llvm::Constant *Init =
6268 llvm::ConstantStruct::get(ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006269 Values);
6270 llvm::GlobalVariable *GCATV
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006271 = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006272 false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006273 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006274 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006275 ExtCatName.str());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006276 GCATV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006277 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.CategorynfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006278 GCATV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006279 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006280 DefinedCategories.push_back(GCATV);
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006281
6282 // Determine if this category is also "non-lazy".
6283 if (ImplementationIsNonLazy(OCD))
6284 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006285 // method definition entries must be clear for next implementation.
6286 MethodDefinitions.clear();
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006287}
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006288
6289/// GetMethodConstant - Return a struct objc_method constant for the
6290/// given method if it has been defined. The result is null if the
6291/// method has not been defined. The return value has type MethodPtrTy.
6292llvm::Constant *CGObjCNonFragileABIMac::GetMethodConstant(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006293 const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00006294 llvm::Function *Fn = GetMethodDefinition(MD);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006295 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00006296 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006297
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006298 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00006299 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006300 ObjCTypes.SelectorPtrTy),
6301 GetMethodVarType(MD),
6302 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
6303 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00006304 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006305}
6306
6307/// EmitMethodList - Build meta-data for method declarations
6308/// struct _method_list_t {
6309/// uint32_t entsize; // sizeof(struct _objc_method)
6310/// uint32_t method_count;
6311/// struct _objc_method method_list[method_count];
6312/// }
6313///
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00006314llvm::Constant *
6315CGObjCNonFragileABIMac::EmitMethodList(Twine Name,
6316 const char *Section,
6317 ArrayRef<llvm::Constant*> Methods) {
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006318 // Return null for empty list.
6319 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006320 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006321
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006322 llvm::Constant *Values[3];
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006323 // sizeof(struct _objc_method)
Micah Villmowdd31ca12012-10-08 16:25:52 +00006324 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006325 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006326 // method_count
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006327 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006328 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006329 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006330 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006331 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006332
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006333 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006334 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006335 llvm::GlobalValue::PrivateLinkage, Init, Name);
Micah Villmowdd31ca12012-10-08 16:25:52 +00006336 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006337 GV->setSection(Section);
Rafael Espindola060062a2014-03-06 22:15:10 +00006338 CGM.addCompilerUsedGlobal(GV);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006339 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006340}
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006341
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006342/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6343/// the given ivar.
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006344llvm::GlobalVariable *
6345CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6346 const ObjCIvarDecl *Ivar) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006347
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006348 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006349 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6350 Name += Container->getObjCRuntimeNameAsString();
6351 Name += ".";
6352 Name += Ivar->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006353 llvm::GlobalVariable *IvarOffsetGV =
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006354 CGM.getModule().getGlobalVariable(Name);
6355 if (!IvarOffsetGV)
Tim Northover238b5082014-03-29 13:42:40 +00006356 IvarOffsetGV = new llvm::GlobalVariable(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006357 CGM.getModule(), ObjCTypes.IvarOffsetVarTy, false,
6358 llvm::GlobalValue::ExternalLinkage, nullptr, Name.str());
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006359 return IvarOffsetGV;
6360}
6361
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006362llvm::Constant *
6363CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6364 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00006365 unsigned long int Offset) {
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006366 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Tim Northover238b5082014-03-29 13:42:40 +00006367 IvarOffsetGV->setInitializer(
6368 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006369 IvarOffsetGV->setAlignment(
Tim Northover238b5082014-03-29 13:42:40 +00006370 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006371
Mike Stump18bb9282009-05-16 07:57:57 +00006372 // FIXME: This matches gcc, but shouldn't the visibility be set on the use as
6373 // well (i.e., in ObjCIvarOffsetVariable).
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006374 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6375 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
John McCall457a04e2010-10-22 21:05:15 +00006376 ID->getVisibility() == HiddenVisibility)
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00006377 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Daniel Dunbarf5f359f2009-04-14 06:00:08 +00006378 else
Fariborz Jahanianbc3c77b2009-04-06 18:30:00 +00006379 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
Bill Wendlingf7d45982011-05-04 21:37:25 +00006380 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006381 return IvarOffsetGV;
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006382}
6383
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006384/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006385/// implementation. The return value has type
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006386/// IvarListnfABIPtrTy.
6387/// struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00006388/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006389/// char *name;
6390/// char *type;
6391/// uint32_t alignment;
6392/// uint32_t size;
6393/// }
6394/// struct _ivar_list_t {
6395/// uint32 entsize; // sizeof(struct _ivar_t)
6396/// uint32 count;
6397/// struct _iver_t list[count];
6398/// }
6399///
Daniel Dunbarf5c18462009-04-20 06:54:31 +00006400
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006401llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006402 const ObjCImplementationDecl *ID) {
6403
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006404 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006405
Jordy Rosea91768e2011-07-22 02:08:32 +00006406 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006407 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006408
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006409 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006410
Jordy Rosea91768e2011-07-22 02:08:32 +00006411 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00006412 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00006413 // Ignore unnamed bit-fields.
6414 if (!IVD->getDeclName())
6415 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006416 llvm::Constant *Ivar[5];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006417 Ivar[0] = EmitIvarOffsetVar(ID->getClassInterface(), IVD,
Daniel Dunbar961202372009-05-03 12:57:56 +00006418 ComputeIvarBaseOffset(CGM, ID, IVD));
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006419 Ivar[1] = GetMethodVarName(IVD->getIdentifier());
6420 Ivar[2] = GetMethodVarType(IVD);
Chris Lattner2192fe52011-07-18 04:24:23 +00006421 llvm::Type *FieldTy =
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006422 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmowdd31ca12012-10-08 16:25:52 +00006423 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006424 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006425 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006426 Align = llvm::Log2_32(Align);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006427 Ivar[3] = llvm::ConstantInt::get(ObjCTypes.IntTy, Align);
Daniel Dunbarae032262009-04-20 00:33:43 +00006428 // NOTE. Size of a bitfield does not match gcc's, because of the
6429 // way bitfields are treated special in each. But I am told that
6430 // 'size' for bitfield ivars is ignored by the runtime so it does
6431 // not matter. If it matters, there is enough info to get the
6432 // bitfield right!
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006433 Ivar[4] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006434 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarnfABITy, Ivar));
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006435 }
6436 // Return null for empty list.
6437 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006438 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006439
6440 llvm::Constant *Values[3];
Micah Villmowdd31ca12012-10-08 16:25:52 +00006441 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006442 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6443 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006444 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarnfABITy,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006445 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006446 Values[2] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006447 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006448 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6449 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006450 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006451 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006452 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006453 Prefix + OID->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006454 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006455 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006456 GV->setSection("__DATA, __objc_const");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006457
Rafael Espindola060062a2014-03-06 22:15:10 +00006458 CGM.addCompilerUsedGlobal(GV);
Owen Andersonade90fd2009-07-29 18:54:39 +00006459 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006460}
6461
6462llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006463 const ObjCProtocolDecl *PD) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006464 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006465
Akira Hatanaka7f550f32016-02-11 06:36:35 +00006466 if (!Entry)
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006467 // We use the initializer as a marker of whether this is a forward
6468 // reference or not. At module finalization we add the empty
6469 // contents for protocols which were referenced but never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006470 Entry =
Rafael Espindola5d117f32014-03-06 01:10:46 +00006471 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola24615092014-09-12 20:14:20 +00006472 false, llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00006473 nullptr,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006474 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006475
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006476 return Entry;
6477}
6478
6479/// GetOrEmitProtocol - Generate the protocol meta-data:
6480/// @code
6481/// struct _protocol_t {
6482/// id isa; // NULL
6483/// const char * const protocol_name;
6484/// const struct _protocol_list_t * protocol_list; // super protocols
6485/// const struct method_list_t * const instance_methods;
6486/// const struct method_list_t * const class_methods;
6487/// const struct method_list_t *optionalInstanceMethods;
6488/// const struct method_list_t *optionalClassMethods;
6489/// const struct _prop_list_t * properties;
6490/// const uint32_t size; // sizeof(struct _protocol_t)
6491/// const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006492/// const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006493/// const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00006494/// const struct _prop_list_t * class_properties;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006495/// }
6496/// @endcode
6497///
6498
6499llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006500 const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00006501 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006502
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006503 // Early exit if a defining object has already been generated.
6504 if (Entry && Entry->hasInitializer())
6505 return Entry;
6506
Douglas Gregora715bff2012-01-01 19:51:50 +00006507 // Use the protocol definition, if there is one.
6508 if (const ObjCProtocolDecl *Def = PD->getDefinition())
6509 PD = Def;
6510
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006511 // Construct method lists.
6512 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
6513 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006514 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006515 for (const auto *MD : PD->instance_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006516 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006517 if (!C)
6518 return GetOrEmitProtocolRef(PD);
6519
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006520 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6521 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006522 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006523 } else {
6524 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006525 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006526 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006527 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006528
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006529 for (const auto *MD : PD->class_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006530 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006531 if (!C)
6532 return GetOrEmitProtocolRef(PD);
6533
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006534 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6535 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006536 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006537 } else {
6538 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006539 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006540 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006541 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006542
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006543 MethodTypesExt.insert(MethodTypesExt.end(),
6544 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
6545
Manman Rence7bff52016-01-29 23:46:55 +00006546 llvm::Constant *Values[13];
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006547 // isa is NULL
Owen Anderson0b75f232009-07-31 20:28:54 +00006548 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ObjectPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006549 Values[1] = GetClassName(PD->getObjCRuntimeNameAsString());
6550 Values[2] = EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_" + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006551 PD->protocol_begin(),
6552 PD->protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006553
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006554 Values[3] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006555 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006556 "__DATA, __objc_const",
6557 InstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006558 Values[4] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006559 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006560 "__DATA, __objc_const",
6561 ClassMethods);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006562 Values[5] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006563 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006564 "__DATA, __objc_const",
6565 OptInstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006566 Values[6] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006567 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006568 "__DATA, __objc_const",
6569 OptClassMethods);
Manman Renad0e7912016-01-29 19:22:54 +00006570 Values[7] = EmitPropertyList(
6571 "\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6572 nullptr, PD, ObjCTypes, false);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006573 uint32_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006574 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006575 Values[8] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0b75f232009-07-31 20:28:54 +00006576 Values[9] = llvm::Constant::getNullValue(ObjCTypes.IntTy);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006577 Values[10] = EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006578 + PD->getObjCRuntimeNameAsString(),
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006579 MethodTypesExt, ObjCTypes);
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006580 // const char *demangledName;
6581 Values[11] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Manman Rence7bff52016-01-29 23:46:55 +00006582
6583 Values[12] = EmitPropertyList(
6584 "\01l_OBJC_$_CLASS_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6585 nullptr, PD, ObjCTypes, true);
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006586
Owen Anderson0e0189d2009-07-27 22:29:56 +00006587 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolnfABITy,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006588 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006589
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006590 if (Entry) {
Rafael Espindola24615092014-09-12 20:14:20 +00006591 // Already created, fix the linkage and update the initializer.
6592 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006593 Entry->setInitializer(Init);
6594 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006595 Entry =
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006596 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006597 false, llvm::GlobalValue::WeakAnyLinkage, Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006598 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006599 Entry->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006600 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABITy));
John McCallf9582a72012-03-30 21:29:05 +00006601
6602 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006603 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006604 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006605 CGM.addCompilerUsedGlobal(Entry);
Chris Lattnerf56501c2009-07-17 23:57:13 +00006606
Fariborz Jahanian61cd4b52009-01-29 20:10:59 +00006607 // Use this protocol meta-data to build protocol list table in section
6608 // __DATA, __objc_protolist
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006609 llvm::GlobalVariable *PTGV =
6610 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006611 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006612 "\01l_OBJC_LABEL_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006613 PTGV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006614 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Daniel Dunbarb25452a2009-04-15 02:56:18 +00006615 PTGV->setSection("__DATA, __objc_protolist, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006616 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006617 CGM.addCompilerUsedGlobal(PTGV);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006618 return Entry;
6619}
6620
6621/// EmitProtocolList - Generate protocol list meta-data:
6622/// @code
6623/// struct _protocol_list_t {
6624/// long protocol_count; // Note, this is 32/64 bit
6625/// struct _protocol_t[protocol_count];
6626/// }
6627/// @endcode
6628///
6629llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00006630CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006631 ObjCProtocolDecl::protocol_iterator begin,
6632 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006633 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006634
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006635 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006636 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00006637 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006638
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006639 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006640 SmallString<256> TmpName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006641 Name.toVector(TmpName);
6642 llvm::GlobalVariable *GV =
6643 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006644 if (GV)
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006645 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006646
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006647 for (; begin != end; ++begin)
6648 ProtocolRefs.push_back(GetProtocolRef(*begin)); // Implemented???
6649
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006650 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00006651 ProtocolRefs.push_back(llvm::Constant::getNullValue(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006652 ObjCTypes.ProtocolnfABIPtrTy));
6653
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006654 llvm::Constant *Values[2];
Owen Anderson170229f2009-07-14 23:10:40 +00006655 Values[0] =
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006656 llvm::ConstantInt::get(ObjCTypes.LongTy, ProtocolRefs.size() - 1);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006657 Values[1] =
Bill Wendlinga515b582012-02-09 22:16:49 +00006658 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolnfABIPtrTy,
6659 ProtocolRefs.size()),
6660 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006661
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006662 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Owen Andersonc10c8d32009-07-08 19:05:04 +00006663 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006664 llvm::GlobalValue::PrivateLinkage,
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006665 Init, Name);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006666 GV->setSection("__DATA, __objc_const");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006667 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006668 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Rafael Espindola060062a2014-03-06 22:15:10 +00006669 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006670 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006671 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006672}
6673
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006674/// GetMethodDescriptionConstant - This routine build following meta-data:
6675/// struct _objc_method {
6676/// SEL _cmd;
6677/// char *method_type;
6678/// char *_imp;
6679/// }
6680
6681llvm::Constant *
6682CGObjCNonFragileABIMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006683 llvm::Constant *Desc[3];
Owen Anderson170229f2009-07-14 23:10:40 +00006684 Desc[0] =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006685 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
6686 ObjCTypes.SelectorPtrTy);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006687 Desc[1] = GetMethodVarType(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006688 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00006689 return nullptr;
6690
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006691 // Protocol methods have no implementation. So, this entry is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00006692 Desc[2] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006693 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Desc);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006694}
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006695
6696/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6697/// This code gen. amounts to generating code for:
6698/// @code
6699/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6700/// @encode
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006701///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00006702LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall96fa4842010-05-17 21:00:27 +00006703 CodeGen::CodeGenFunction &CGF,
6704 QualType ObjectTy,
6705 llvm::Value *BaseValue,
6706 const ObjCIvarDecl *Ivar,
6707 unsigned CVRQualifiers) {
6708 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006709 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00006710 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006711 Offset);
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006712}
6713
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006714llvm::Value *CGObjCNonFragileABIMac::EmitIvarOffset(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006715 CodeGen::CodeGenFunction &CGF,
6716 const ObjCInterfaceDecl *Interface,
6717 const ObjCIvarDecl *Ivar) {
Tim Northover238b5082014-03-29 13:42:40 +00006718 llvm::Value *IvarOffsetValue = ObjCIvarOffsetVariable(Interface, Ivar);
John McCall7f416cc2015-09-08 08:05:57 +00006719 IvarOffsetValue = CGF.Builder.CreateAlignedLoad(IvarOffsetValue,
6720 CGF.getSizeAlign(), "ivar");
Tim Northover238b5082014-03-29 13:42:40 +00006721 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
6722 cast<llvm::LoadInst>(IvarOffsetValue)
6723 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
Craig Topper5fc8fc22014-08-27 06:28:36 +00006724 llvm::MDNode::get(VMContext, None));
Tim Northover238b5082014-03-29 13:42:40 +00006725
6726 // This could be 32bit int or 64bit integer depending on the architecture.
6727 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
6728 // as this is what caller always expectes.
6729 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
6730 IvarOffsetValue = CGF.Builder.CreateIntCast(
6731 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
6732 return IvarOffsetValue;
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006733}
6734
John McCall234eac82011-05-13 23:16:18 +00006735static void appendSelectorForMessageRefTable(std::string &buffer,
6736 Selector selector) {
6737 if (selector.isUnarySelector()) {
6738 buffer += selector.getNameForSlot(0);
6739 return;
6740 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006741
John McCall234eac82011-05-13 23:16:18 +00006742 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
6743 buffer += selector.getNameForSlot(i);
6744 buffer += '_';
6745 }
6746}
6747
Eric Christopherd160c502016-01-29 01:35:53 +00006748/// Emit a "vtable" message send. We emit a weak hidden-visibility
John McCall9e8bb002011-05-14 03:10:52 +00006749/// struct, initially containing the selector pointer and a pointer to
6750/// a "fixup" variant of the appropriate objc_msgSend. To call, we
6751/// load and call the function pointer, passing the address of the
6752/// struct as the second parameter. The runtime determines whether
6753/// the selector is currently emitted using vtable dispatch; if so, it
6754/// substitutes a stub function which simply tail-calls through the
6755/// appropriate vtable slot, and if not, it substitues a stub function
6756/// which tail-calls objc_msgSend. Both stubs adjust the selector
6757/// argument to correctly point to the selector.
6758RValue
6759CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
6760 ReturnValueSlot returnSlot,
6761 QualType resultType,
6762 Selector selector,
6763 llvm::Value *arg0,
6764 QualType arg0Type,
6765 bool isSuper,
6766 const CallArgList &formalArgs,
6767 const ObjCMethodDecl *method) {
John McCall234eac82011-05-13 23:16:18 +00006768 // Compute the actual arguments.
6769 CallArgList args;
6770
John McCall9e8bb002011-05-14 03:10:52 +00006771 // First argument: the receiver / super-call structure.
John McCall234eac82011-05-13 23:16:18 +00006772 if (!isSuper)
John McCall9e8bb002011-05-14 03:10:52 +00006773 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
6774 args.add(RValue::get(arg0), arg0Type);
John McCall234eac82011-05-13 23:16:18 +00006775
John McCall9e8bb002011-05-14 03:10:52 +00006776 // Second argument: a pointer to the message ref structure. Leave
6777 // the actual argument value blank for now.
Craig Topper8a13c412014-05-21 05:09:00 +00006778 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCall234eac82011-05-13 23:16:18 +00006779
6780 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
6781
John McCalla729c622012-02-17 03:33:10 +00006782 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCall234eac82011-05-13 23:16:18 +00006783
John McCall5880fb82011-05-14 21:12:11 +00006784 NullReturnState nullReturn;
6785
John McCall9e8bb002011-05-14 03:10:52 +00006786 // Find the function to call and the mangled name for the message
6787 // ref structure. Using a different mangled name wouldn't actually
6788 // be a problem; it would just be a waste.
6789 //
6790 // The runtime currently never uses vtable dispatch for anything
6791 // except normal, non-super message-sends.
6792 // FIXME: don't use this for that.
Craig Topper8a13c412014-05-21 05:09:00 +00006793 llvm::Constant *fn = nullptr;
John McCall234eac82011-05-13 23:16:18 +00006794 std::string messageRefName("\01l_");
Tim Northovere77cc392014-03-29 13:28:05 +00006795 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall234eac82011-05-13 23:16:18 +00006796 if (isSuper) {
6797 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
6798 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006799 } else {
John McCall5880fb82011-05-14 21:12:11 +00006800 nullReturn.init(CGF, arg0);
John McCall234eac82011-05-13 23:16:18 +00006801 fn = ObjCTypes.getMessageSendStretFixupFn();
6802 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006803 }
John McCall234eac82011-05-13 23:16:18 +00006804 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
6805 fn = ObjCTypes.getMessageSendFpretFixupFn();
6806 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stump658fe022009-07-30 22:28:39 +00006807 } else {
John McCall234eac82011-05-13 23:16:18 +00006808 if (isSuper) {
6809 fn = ObjCTypes.getMessageSendSuper2FixupFn();
6810 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006811 } else {
John McCall234eac82011-05-13 23:16:18 +00006812 fn = ObjCTypes.getMessageSendFixupFn();
6813 messageRefName += "objc_msgSend_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006814 }
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00006815 }
John McCall234eac82011-05-13 23:16:18 +00006816 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
6817 messageRefName += '_';
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006818
John McCall234eac82011-05-13 23:16:18 +00006819 // Append the selector name, except use underscores anywhere we
6820 // would have used colons.
6821 appendSelectorForMessageRefTable(messageRefName, selector);
6822
6823 llvm::GlobalVariable *messageRef
6824 = CGM.getModule().getGlobalVariable(messageRefName);
6825 if (!messageRef) {
John McCall9e8bb002011-05-14 03:10:52 +00006826 // Build the message ref structure.
John McCall234eac82011-05-13 23:16:18 +00006827 llvm::Constant *values[] = { fn, GetMethodVarName(selector) };
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006828 llvm::Constant *init = llvm::ConstantStruct::getAnon(values);
John McCall234eac82011-05-13 23:16:18 +00006829 messageRef = new llvm::GlobalVariable(CGM.getModule(),
6830 init->getType(),
6831 /*constant*/ false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006832 llvm::GlobalValue::WeakAnyLinkage,
John McCall234eac82011-05-13 23:16:18 +00006833 init,
6834 messageRefName);
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006835 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall234eac82011-05-13 23:16:18 +00006836 messageRef->setAlignment(16);
6837 messageRef->setSection("__DATA, __objc_msgrefs, coalesced");
6838 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006839
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006840 bool requiresnullCheck = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00006841 if (CGM.getLangOpts().ObjCAutoRefCount && method)
Aaron Ballman43b68be2014-03-07 17:50:17 +00006842 for (const auto *ParamDecl : method->params()) {
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006843 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
6844 if (!nullReturn.NullBB)
6845 nullReturn.init(CGF, arg0);
6846 requiresnullCheck = true;
6847 break;
6848 }
6849 }
6850
John McCall7f416cc2015-09-08 08:05:57 +00006851 Address mref =
6852 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
6853 CGF.getPointerAlign());
John McCall234eac82011-05-13 23:16:18 +00006854
John McCall9e8bb002011-05-14 03:10:52 +00006855 // Update the message ref argument.
John McCall7f416cc2015-09-08 08:05:57 +00006856 args[1].RV = RValue::get(mref.getPointer());
John McCall234eac82011-05-13 23:16:18 +00006857
6858 // Load the function to call from the message ref table.
John McCall7f416cc2015-09-08 08:05:57 +00006859 Address calleeAddr =
6860 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
6861 llvm::Value *callee = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCall234eac82011-05-13 23:16:18 +00006862
John McCalla729c622012-02-17 03:33:10 +00006863 callee = CGF.Builder.CreateBitCast(callee, MSI.MessengerType);
John McCall234eac82011-05-13 23:16:18 +00006864
John McCalla729c622012-02-17 03:33:10 +00006865 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Craig Topper8a13c412014-05-21 05:09:00 +00006866 return nullReturn.complete(CGF, result, resultType, formalArgs,
6867 requiresnullCheck ? method : nullptr);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006868}
6869
6870/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006871CodeGen::RValue
6872CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006873 ReturnValueSlot Return,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006874 QualType ResultType,
6875 Selector Sel,
6876 llvm::Value *Receiver,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006877 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00006878 const ObjCInterfaceDecl *Class,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006879 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00006880 return isVTableDispatchedSelector(Sel)
6881 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006882 Receiver, CGF.getContext().getObjCIdType(),
John McCall9e8bb002011-05-14 03:10:52 +00006883 false, CallArgs, Method)
6884 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00006885 EmitSelector(CGF, Sel),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006886 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00006887 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006888}
6889
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006890llvm::GlobalVariable *
Benjamin Kramer0772c422016-02-13 13:42:54 +00006891CGObjCNonFragileABIMac::GetClassGlobal(StringRef Name, bool Weak) {
Rafael Espindola554256c2014-02-26 22:25:45 +00006892 llvm::GlobalValue::LinkageTypes L =
6893 Weak ? llvm::GlobalValue::ExternalWeakLinkage
6894 : llvm::GlobalValue::ExternalLinkage;
6895
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006896 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
6897
Rafael Espindola554256c2014-02-26 22:25:45 +00006898 if (!GV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006899 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABITy,
Craig Topper8a13c412014-05-21 05:09:00 +00006900 false, L, nullptr, Name);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006901
Rafael Espindola554256c2014-02-26 22:25:45 +00006902 assert(GV->getLinkage() == L);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006903 return GV;
6904}
6905
John McCall882987f2013-02-28 19:01:20 +00006906llvm::Value *CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
Rafael Espindola554256c2014-02-26 22:25:45 +00006907 IdentifierInfo *II,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006908 bool Weak,
6909 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006910 CharUnits Align = CGF.getPointerAlign();
John McCall31168b02011-06-15 23:02:42 +00006911 llvm::GlobalVariable *&Entry = ClassReferences[II];
6912
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006913 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006914 std::string ClassName(
6915 getClassSymbolPrefix() +
6916 (ID ? ID->getObjCRuntimeNameAsString() : II->getName()).str());
Rafael Espindola554256c2014-02-26 22:25:45 +00006917 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName, Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006918 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6919 false, llvm::GlobalValue::PrivateLinkage,
6920 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006921 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006922 Entry->setSection("__DATA, __objc_classrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006923 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006924 }
John McCall7f416cc2015-09-08 08:05:57 +00006925 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006926}
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006927
John McCall882987f2013-02-28 19:01:20 +00006928llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00006929 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00006930 // If the class has the objc_runtime_visible attribute, we need to
6931 // use the Objective-C runtime to get the class.
6932 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
6933 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
6934
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006935 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID->isWeakImported(), ID);
John McCall31168b02011-06-15 23:02:42 +00006936}
6937
6938llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCall882987f2013-02-28 19:01:20 +00006939 CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00006940 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
Hans Wennborgdcfba332015-10-06 23:40:43 +00006941 return EmitClassRefFromId(CGF, II, false, nullptr);
John McCall31168b02011-06-15 23:02:42 +00006942}
6943
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006944llvm::Value *
John McCall882987f2013-02-28 19:01:20 +00006945CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006946 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006947 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006948 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006949
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006950 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006951 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6952 ClassName += ID->getObjCRuntimeNameAsString();
6953 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006954 ID->isWeakImported());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006955 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6956 false, llvm::GlobalValue::PrivateLinkage,
6957 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006958 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006959 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006960 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006961 }
John McCall7f416cc2015-09-08 08:05:57 +00006962 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006963}
6964
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006965/// EmitMetaClassRef - Return a Value * of the address of _class_t
6966/// meta-data
6967///
John McCall882987f2013-02-28 19:01:20 +00006968llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006969 const ObjCInterfaceDecl *ID,
6970 bool Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00006971 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006972 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Rafael Espindola21039aa2014-02-27 16:26:32 +00006973 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006974 llvm::SmallString<64> MetaClassName(getMetaclassSymbolPrefix());
6975 MetaClassName += ID->getObjCRuntimeNameAsString();
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006976 llvm::GlobalVariable *MetaClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006977 GetClassGlobal(MetaClassName.str(), Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006978
Rafael Espindola21039aa2014-02-27 16:26:32 +00006979 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006980 false, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006981 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006982 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006983
Rafael Espindola21039aa2014-02-27 16:26:32 +00006984 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006985 CGM.addCompilerUsedGlobal(Entry);
Rafael Espindola21039aa2014-02-27 16:26:32 +00006986 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006987
John McCall7f416cc2015-09-08 08:05:57 +00006988 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006989}
6990
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006991/// GetClass - Return a reference to the class for the given interface
6992/// decl.
John McCall882987f2013-02-28 19:01:20 +00006993llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006994 const ObjCInterfaceDecl *ID) {
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00006995 if (ID->isWeakImported()) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006996 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6997 ClassName += ID->getObjCRuntimeNameAsString();
6998 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(), true);
Nick Lewycky9a441642014-02-27 00:36:00 +00006999 (void)ClassGV;
Rafael Espindolab3262952014-05-09 00:43:37 +00007000 assert(ClassGV->hasExternalWeakLinkage());
Fariborz Jahanian95ace552009-11-17 22:42:00 +00007001 }
7002
John McCall882987f2013-02-28 19:01:20 +00007003 return EmitClassRef(CGF, ID);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007004}
7005
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007006/// Generates a message send where the super is the receiver. This is
7007/// a message send to self with special delivery semantics indicating
7008/// which class's method should be called.
7009CodeGen::RValue
7010CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00007011 ReturnValueSlot Return,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007012 QualType ResultType,
7013 Selector Sel,
7014 const ObjCInterfaceDecl *Class,
7015 bool isCategoryImpl,
7016 llvm::Value *Receiver,
7017 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007018 const CodeGen::CallArgList &CallArgs,
7019 const ObjCMethodDecl *Method) {
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007020 // ...
7021 // Create and init a super structure; this is a (receiver, class)
7022 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00007023 Address ObjCSuper =
7024 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
7025 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007026
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007027 llvm::Value *ReceiverAsObject =
7028 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007029 CGF.Builder.CreateStore(
7030 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00007031 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007032
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007033 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00007034 llvm::Value *Target;
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007035 if (IsClassMessage)
Fariborz Jahanian85b99da2014-08-28 17:05:17 +00007036 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007037 else
John McCall882987f2013-02-28 19:01:20 +00007038 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007039
Mike Stump18bb9282009-05-16 07:57:57 +00007040 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
7041 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00007042 llvm::Type *ClassTy =
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007043 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
7044 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007045 CGF.Builder.CreateStore(
John McCall7f416cc2015-09-08 08:05:57 +00007046 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007047
John McCall9e8bb002011-05-14 03:10:52 +00007048 return (isVTableDispatchedSelector(Sel))
7049 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
John McCall7f416cc2015-09-08 08:05:57 +00007050 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall9e8bb002011-05-14 03:10:52 +00007051 true, CallArgs, Method)
7052 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00007053 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00007054 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00007055 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007056}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007057
John McCall882987f2013-02-28 19:01:20 +00007058llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007059 Selector Sel) {
7060 Address Addr = EmitSelectorAddr(CGF, Sel);
7061
7062 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
7063 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
7064 llvm::MDNode::get(VMContext, None));
7065 return LI;
7066}
7067
7068Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
7069 Selector Sel) {
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007070 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007071
John McCall7f416cc2015-09-08 08:05:57 +00007072 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007073 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007074 llvm::Constant *Casted =
7075 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
7076 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007077 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
7078 false, llvm::GlobalValue::PrivateLinkage,
7079 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman5c205962013-02-05 23:08:45 +00007080 Entry->setExternallyInitialized(true);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00007081 Entry->setSection("__DATA, __objc_selrefs, literal_pointers, no_dead_strip");
John McCall7f416cc2015-09-08 08:05:57 +00007082 Entry->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00007083 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007084 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007085
John McCall7f416cc2015-09-08 08:05:57 +00007086 return Address(Entry, Align);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007087}
John McCall7f416cc2015-09-08 08:05:57 +00007088
Fariborz Jahanian06292952009-02-16 22:52:32 +00007089/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007090/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian06292952009-02-16 22:52:32 +00007091///
7092void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00007093 llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +00007094 Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007095 llvm::Value *ivarOffset) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007096 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007097 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007098 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007099 assert(Size <= 8 && "does not support size > 8");
7100 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7101 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007102 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7103 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007104 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7105 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007106 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00007107 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007108}
7109
7110/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
7111/// objc_assign_strongCast (id src, id *dst)
7112///
7113void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007114 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007115 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007116 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007117 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007118 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007119 assert(Size <= 8 && "does not support size > 8");
7120 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007121 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007122 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7123 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007124 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7125 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007126 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007127 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
7128 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007129}
7130
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007131void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007132 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007133 Address DestPtr,
7134 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00007135 llvm::Value *Size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007136 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
7137 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007138 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCall882987f2013-02-28 19:01:20 +00007139 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007140}
7141
Fariborz Jahanian06292952009-02-16 22:52:32 +00007142/// EmitObjCWeakRead - Code gen for loading value of a __weak
7143/// object: objc_read_weak (id *src)
7144///
7145llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007146 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007147 Address AddrWeakObj) {
7148 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007149 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007150 llvm::Value *read_weak =
7151 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00007152 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00007153 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007154 return read_weak;
7155}
7156
7157/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
7158/// objc_assign_weak (id src, id *dst)
7159///
7160void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007161 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007162 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007163 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007164 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007165 assert(Size <= 8 && "does not support size > 8");
7166 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7167 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007168 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7169 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007170 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7171 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007172 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007173 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
7174 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007175}
7176
7177/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
7178/// objc_assign_global (id src, id *dst)
7179///
7180void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007181 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00007182 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007183 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007184 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007185 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007186 assert(Size <= 8 && "does not support size > 8");
7187 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7188 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007189 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7190 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007191 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7192 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007193 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00007194 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00007195 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
7196 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00007197 else
John McCall882987f2013-02-28 19:01:20 +00007198 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
7199 args, "threadlocalassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007200}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007201
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007202void
John McCallbd309292010-07-06 01:34:17 +00007203CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
7204 const ObjCAtSynchronizedStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007205 EmitAtSynchronizedStmt(CGF, S,
7206 cast<llvm::Function>(ObjCTypes.getSyncEnterFn()),
7207 cast<llvm::Function>(ObjCTypes.getSyncExitFn()));
John McCallbd309292010-07-06 01:34:17 +00007208}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007209
John McCall2ca705e2010-07-24 00:37:23 +00007210llvm::Constant *
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00007211CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall2ca705e2010-07-24 00:37:23 +00007212 // There's a particular fixed type info for 'id'.
7213 if (T->isObjCIdType() ||
7214 T->isObjCQualifiedIdType()) {
7215 llvm::Constant *IDEHType =
7216 CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
7217 if (!IDEHType)
7218 IDEHType =
7219 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7220 false,
7221 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007222 nullptr, "OBJC_EHTYPE_id");
John McCall2ca705e2010-07-24 00:37:23 +00007223 return IDEHType;
7224 }
7225
7226 // All other types should be Objective-C interface pointer types.
7227 const ObjCObjectPointerType *PT =
7228 T->getAs<ObjCObjectPointerType>();
7229 assert(PT && "Invalid @catch type.");
7230 const ObjCInterfaceType *IT = PT->getInterfaceType();
7231 assert(IT && "Invalid @catch type.");
7232 return GetInterfaceEHType(IT->getDecl(), false);
7233}
7234
John McCallbd309292010-07-06 01:34:17 +00007235void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7236 const ObjCAtTryStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007237 EmitTryCatchStmt(CGF, S,
7238 cast<llvm::Function>(ObjCTypes.getObjCBeginCatchFn()),
7239 cast<llvm::Function>(ObjCTypes.getObjCEndCatchFn()),
7240 cast<llvm::Function>(ObjCTypes.getExceptionRethrowFn()));
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +00007241}
7242
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007243/// EmitThrowStmt - Generate code for a throw statement.
7244void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007245 const ObjCAtThrowStmt &S,
7246 bool ClearInsertionPoint) {
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007247 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00007248 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer76399eb2011-09-27 21:06:10 +00007249 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007250 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception)
John McCall17afe452010-10-16 08:21:07 +00007251 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007252 } else {
John McCall882987f2013-02-28 19:01:20 +00007253 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn())
John McCall17afe452010-10-16 08:21:07 +00007254 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007255 }
7256
John McCall17afe452010-10-16 08:21:07 +00007257 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007258 if (ClearInsertionPoint)
7259 CGF.Builder.ClearInsertionPoint();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007260}
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007261
John McCall2ca705e2010-07-24 00:37:23 +00007262llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007263CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007264 bool ForDefinition) {
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007265 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007266
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007267 // If we don't need a definition, return the entry if found or check
7268 // if we use an external reference.
7269 if (!ForDefinition) {
7270 if (Entry)
7271 return Entry;
Daniel Dunbard7beeea2009-04-07 06:43:45 +00007272
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007273 // If this type (or a super class) has the __objc_exception__
7274 // attribute, emit an external reference.
Douglas Gregor78bd61f2009-06-18 16:11:24 +00007275 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007276 return Entry =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007277 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7278 llvm::GlobalValue::ExternalLinkage,
7279 nullptr,
7280 ("OBJC_EHTYPE_$_" +
7281 ID->getObjCRuntimeNameAsString()));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007282 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007283
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007284 // Otherwise we need to either make a new entry or fill in the
7285 // initializer.
7286 assert((!Entry || !Entry->hasInitializer()) && "Duplicate EHType definition");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007287 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
7288 ClassName += ID->getObjCRuntimeNameAsString();
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007289 std::string VTableName = "objc_ehtype_vtable";
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007290 llvm::GlobalVariable *VTableGV =
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007291 CGM.getModule().getGlobalVariable(VTableName);
7292 if (!VTableGV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007293 VTableGV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.Int8PtrTy,
7294 false,
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007295 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007296 nullptr, VTableName);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007297
Chris Lattnerece04092012-02-07 00:39:47 +00007298 llvm::Value *VTableIdx = llvm::ConstantInt::get(CGM.Int32Ty, 2);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007299
Benjamin Kramer22d24c22011-10-15 12:20:02 +00007300 llvm::Constant *Values[] = {
David Blaikiee3b172a2015-04-02 18:55:21 +00007301 llvm::ConstantExpr::getGetElementPtr(VTableGV->getValueType(), VTableGV,
7302 VTableIdx),
7303 GetClassName(ID->getObjCRuntimeNameAsString()),
7304 GetClassGlobal(ClassName.str())};
Owen Anderson170229f2009-07-14 23:10:40 +00007305 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00007306 llvm::ConstantStruct::get(ObjCTypes.EHTypeTy, Values);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007307
Rafael Espindola554256c2014-02-26 22:25:45 +00007308 llvm::GlobalValue::LinkageTypes L = ForDefinition
7309 ? llvm::GlobalValue::ExternalLinkage
7310 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007311 if (Entry) {
7312 Entry->setInitializer(Init);
7313 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007314 llvm::SmallString<64> EHTYPEName("OBJC_EHTYPE_$_");
7315 EHTYPEName += ID->getObjCRuntimeNameAsString();
Owen Andersonc10c8d32009-07-08 19:05:04 +00007316 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
Rafael Espindola554256c2014-02-26 22:25:45 +00007317 L,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007318 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007319 EHTYPEName.str());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007320 }
Rafael Espindola554256c2014-02-26 22:25:45 +00007321 assert(Entry->getLinkage() == L);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007322
John McCalla4960982013-02-19 01:57:29 +00007323 if (ID->getVisibility() == HiddenVisibility)
Daniel Dunbar15894b72009-04-07 05:48:37 +00007324 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Micah Villmowdd31ca12012-10-08 16:25:52 +00007325 Entry->setAlignment(CGM.getDataLayout().getABITypeAlignment(
Daniel Dunbar710cb202010-04-25 20:39:32 +00007326 ObjCTypes.EHTypeTy));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007327
Rafael Espindola554256c2014-02-26 22:25:45 +00007328 if (ForDefinition)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007329 Entry->setSection("__DATA,__objc_const");
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007330
7331 return Entry;
7332}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007333
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00007334/* *** */
7335
Daniel Dunbarb036db82008-08-13 03:21:16 +00007336CodeGen::CGObjCRuntime *
7337CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00007338 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7339 case ObjCRuntime::FragileMacOSX:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007340 return new CGObjCMac(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00007341
7342 case ObjCRuntime::MacOSX:
7343 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00007344 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00007345 return new CGObjCNonFragileABIMac(CGM);
7346
David Chisnallb601c962012-07-03 20:49:52 +00007347 case ObjCRuntime::GNUstep:
7348 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +00007349 case ObjCRuntime::ObjFW:
John McCall5fb5df92012-06-20 06:18:46 +00007350 llvm_unreachable("these runtimes are not Mac runtimes");
7351 }
7352 llvm_unreachable("bad runtime");
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007353}