blob: 4f14f87275212f858cc4d60778632702e264217d [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.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001136 llvm::Constant *EmitMethodList(Twine Name, StringRef Section,
1137 ArrayRef<llvm::Constant *> Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001138
1139 /// EmitMethodDescList - Emit a method description list for a list of
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001140 /// method declarations.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001141 /// - TypeName: The name for the type containing the methods.
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001142 /// - IsProtocol: True iff these methods are for a protocol.
1143 /// - ClassMethds: True iff these are class methods.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001144 /// - Required: When true, only "required" methods are
1145 /// listed. Similarly, when false only "optional" methods are
1146 /// listed. For classes this should always be true.
1147 /// - begin, end: The method list to output.
1148 ///
1149 /// The return value has type MethodDescriptionListPtrTy.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001150 llvm::Constant *EmitMethodDescList(Twine Name, StringRef Section,
1151 ArrayRef<llvm::Constant *> Methods);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001152
Daniel Dunbarc475d422008-10-29 22:36:39 +00001153 /// GetOrEmitProtocol - Get the protocol object for the given
1154 /// declaration, emitting it if necessary. The return value has type
1155 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001156 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001157
1158 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1159 /// object for the given declaration, emitting it if needed. These
1160 /// forward references will be filled in with empty bodies if no
1161 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001162 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001163
Daniel Dunbarb036db82008-08-13 03:21:16 +00001164 /// EmitProtocolExtension - Generate the protocol extension
1165 /// structure used to store optional instance and class methods, and
1166 /// protocol properties. The return value has type
1167 /// ProtocolExtensionPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001168 llvm::Constant *
1169 EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001170 ArrayRef<llvm::Constant*> OptInstanceMethods,
1171 ArrayRef<llvm::Constant*> OptClassMethods,
1172 ArrayRef<llvm::Constant*> MethodTypesExt);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001173
1174 /// EmitProtocolList - Generate the list of referenced
1175 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001176 llvm::Constant *EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00001177 ObjCProtocolDecl::protocol_iterator begin,
1178 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001179
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001180 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1181 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001182 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1183 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001184
1185public:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001186 CGObjCMac(CodeGen::CodeGenModule &cgm);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001187
Craig Topper4f12f102014-03-12 06:41:41 +00001188 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001189
Craig Topper4f12f102014-03-12 06:41:41 +00001190 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1191 ReturnValueSlot Return,
1192 QualType ResultType,
1193 Selector Sel, llvm::Value *Receiver,
1194 const CallArgList &CallArgs,
1195 const ObjCInterfaceDecl *Class,
1196 const ObjCMethodDecl *Method) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001197
Craig Topper4f12f102014-03-12 06:41:41 +00001198 CodeGen::RValue
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001199 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001200 ReturnValueSlot Return, QualType ResultType,
1201 Selector Sel, const ObjCInterfaceDecl *Class,
1202 bool isCategoryImpl, llvm::Value *Receiver,
1203 bool IsClassMessage, const CallArgList &CallArgs,
1204 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001205
Craig Topper4f12f102014-03-12 06:41:41 +00001206 llvm::Value *GetClass(CodeGenFunction &CGF,
1207 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001208
John McCall7f416cc2015-09-08 08:05:57 +00001209 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
1210 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001211
1212 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1213 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001214 llvm::Value *GetSelector(CodeGenFunction &CGF,
1215 const ObjCMethodDecl *Method) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001216
Craig Topper4f12f102014-03-12 06:41:41 +00001217 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001218
Craig Topper4f12f102014-03-12 06:41:41 +00001219 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001220
Craig Topper4f12f102014-03-12 06:41:41 +00001221 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001222
Craig Topper4f12f102014-03-12 06:41:41 +00001223 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001224
Craig Topper4f12f102014-03-12 06:41:41 +00001225 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1226 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001227
Craig Topper4f12f102014-03-12 06:41:41 +00001228 llvm::Constant *GetPropertyGetFunction() override;
1229 llvm::Constant *GetPropertySetFunction() override;
1230 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1231 bool copy) override;
1232 llvm::Constant *GetGetStructFunction() override;
1233 llvm::Constant *GetSetStructFunction() override;
1234 llvm::Constant *GetCppAtomicObjectGetFunction() override;
1235 llvm::Constant *GetCppAtomicObjectSetFunction() override;
1236 llvm::Constant *EnumerationMutationFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001237
Craig Topper4f12f102014-03-12 06:41:41 +00001238 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1239 const ObjCAtTryStmt &S) override;
1240 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1241 const ObjCAtSynchronizedStmt &S) override;
John McCallbd309292010-07-06 01:34:17 +00001242 void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, const Stmt &S);
Craig Topper4f12f102014-03-12 06:41:41 +00001243 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1244 bool ClearInsertionPoint=true) override;
1245 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001246 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001247 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001248 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001249 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001250 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001251 bool threadlocal = false) override;
1252 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001253 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001254 llvm::Value *ivarOffset) override;
1255 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001256 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001257 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001258 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001259 llvm::Value *size) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001260
Craig Topper4f12f102014-03-12 06:41:41 +00001261 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1262 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1263 unsigned CVRQualifiers) override;
1264 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1265 const ObjCInterfaceDecl *Interface,
1266 const ObjCIvarDecl *Ivar) override;
1267
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001268 /// GetClassGlobal - Return the global variable for the Objective-C
1269 /// class of the given name.
Benjamin Kramer0772c422016-02-13 13:42:54 +00001270 llvm::GlobalVariable *GetClassGlobal(StringRef Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001271 bool Weak = false) override {
David Blaikie83d382b2011-09-23 05:06:16 +00001272 llvm_unreachable("CGObjCMac::GetClassGlobal");
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001273 }
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001274};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001275
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001276class CGObjCNonFragileABIMac : public CGObjCCommonMac {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001277private:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001278 ObjCNonFragileABITypesHelper ObjCTypes;
Fariborz Jahanian71394042009-01-23 23:53:38 +00001279 llvm::GlobalVariable* ObjCEmptyCacheVar;
1280 llvm::GlobalVariable* ObjCEmptyVtableVar;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001281
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001282 /// SuperClassReferences - uniqued super class references.
1283 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> SuperClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001284
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001285 /// MetaClassReferences - uniqued meta class references.
1286 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> MetaClassReferences;
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001287
1288 /// EHTypeReferences - uniqued class ehtype references.
1289 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> EHTypeReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001290
John McCall9e8bb002011-05-14 03:10:52 +00001291 /// VTableDispatchMethods - List of methods for which we generate
1292 /// vtable-based message dispatch.
1293 llvm::DenseSet<Selector> VTableDispatchMethods;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001294
Fariborz Jahanian67260552009-11-17 21:37:35 +00001295 /// DefinedMetaClasses - List of defined meta-classes.
1296 std::vector<llvm::GlobalValue*> DefinedMetaClasses;
1297
John McCall9e8bb002011-05-14 03:10:52 +00001298 /// isVTableDispatchedSelector - Returns true if SEL is a
1299 /// vtable-based selector.
1300 bool isVTableDispatchedSelector(Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001301
Fariborz Jahanian71394042009-01-23 23:53:38 +00001302 /// FinishNonFragileABIModule - Write out global data structures at the end of
1303 /// processing a translation unit.
1304 void FinishNonFragileABIModule();
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001305
Daniel Dunbar19573e72009-05-15 21:48:48 +00001306 /// AddModuleClassList - Add the given list of class pointers to the
1307 /// module with the provided symbol and section names.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001308 void AddModuleClassList(ArrayRef<llvm::GlobalValue *> Container,
1309 StringRef SymbolName, StringRef SectionName);
Daniel Dunbar19573e72009-05-15 21:48:48 +00001310
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001311 llvm::GlobalVariable * BuildClassRoTInitializer(unsigned flags,
1312 unsigned InstanceStart,
1313 unsigned InstanceSize,
1314 const ObjCImplementationDecl *ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001315 llvm::GlobalVariable * BuildClassMetaData(const std::string &ClassName,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001316 llvm::Constant *IsAGV,
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00001317 llvm::Constant *SuperClassGV,
Fariborz Jahanian82208252009-01-31 00:59:10 +00001318 llvm::Constant *ClassRoGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00001319 bool HiddenVisibility,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00001320 bool Weak);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001321
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001322 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001323
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00001324 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001325
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001326 /// EmitMethodList - Emit the method list for the given
1327 /// implementation. The return value has type MethodListnfABITy.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001328 llvm::Constant *EmitMethodList(Twine Name, StringRef Section,
1329 ArrayRef<llvm::Constant *> Methods);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00001330 /// EmitIvarList - Emit the ivar list for the given
1331 /// implementation. If ForClass is true the list of class ivars
1332 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1333 /// interface ivars will be emitted. The return value has type
1334 /// IvarListnfABIPtrTy.
1335 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001336
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001337 llvm::Constant *EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00001338 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00001339 unsigned long int offset);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001340
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001341 /// GetOrEmitProtocol - Get the protocol object for the given
1342 /// declaration, emitting it if necessary. The return value has type
1343 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001344 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001345
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001346 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1347 /// object for the given declaration, emitting it if needed. These
1348 /// forward references will be filled in with empty bodies if no
1349 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001350 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001351
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001352 /// EmitProtocolList - Generate the list of referenced
1353 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001354 llvm::Constant *EmitProtocolList(Twine Name,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001355 ObjCProtocolDecl::protocol_iterator begin,
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00001356 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001357
John McCall9e8bb002011-05-14 03:10:52 +00001358 CodeGen::RValue EmitVTableMessageSend(CodeGen::CodeGenFunction &CGF,
1359 ReturnValueSlot Return,
1360 QualType ResultType,
1361 Selector Sel,
1362 llvm::Value *Receiver,
1363 QualType Arg0Ty,
1364 bool IsSuper,
1365 const CallArgList &CallArgs,
1366 const ObjCMethodDecl *Method);
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001367
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00001368 /// GetClassGlobal - Return the global variable for the Objective-C
1369 /// class of the given name.
Benjamin Kramer0772c422016-02-13 13:42:54 +00001370 llvm::GlobalVariable *GetClassGlobal(StringRef Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001371 bool Weak = false) override;
Rafael Espindola554256c2014-02-26 22:25:45 +00001372
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00001373 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001374 /// for the given class reference.
John McCall882987f2013-02-28 19:01:20 +00001375 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001376 const ObjCInterfaceDecl *ID);
John McCall31168b02011-06-15 23:02:42 +00001377
John McCall882987f2013-02-28 19:01:20 +00001378 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001379 IdentifierInfo *II, bool Weak,
1380 const ObjCInterfaceDecl *ID);
Craig Topper4f12f102014-03-12 06:41:41 +00001381
1382 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001383
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001384 /// EmitSuperClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1385 /// for the given super class reference.
John McCall882987f2013-02-28 19:01:20 +00001386 llvm::Value *EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001387 const ObjCInterfaceDecl *ID);
1388
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001389 /// EmitMetaClassRef - Return a Value * of the address of _class_t
1390 /// meta-data
John McCall882987f2013-02-28 19:01:20 +00001391 llvm::Value *EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00001392 const ObjCInterfaceDecl *ID, bool Weak);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001393
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001394 /// ObjCIvarOffsetVariable - Returns the ivar offset variable for
1395 /// the given ivar.
1396 ///
Daniel Dunbara1060522009-04-19 00:31:15 +00001397 llvm::GlobalVariable * ObjCIvarOffsetVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001398 const ObjCInterfaceDecl *ID,
1399 const ObjCIvarDecl *Ivar);
1400
Fariborz Jahanian74b77222009-02-11 20:51:17 +00001401 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1402 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001403 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1404 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001405
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001406 /// GetInterfaceEHType - Get the cached ehtype for the given Objective-C
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001407 /// interface. The return value has type EHTypePtrTy.
John McCall2ca705e2010-07-24 00:37:23 +00001408 llvm::Constant *GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001409 bool ForDefinition);
Daniel Dunbar15894b72009-04-07 05:48:37 +00001410
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001411 StringRef getMetaclassSymbolPrefix() const { return "OBJC_METACLASS_$_"; }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001412
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001413 StringRef getClassSymbolPrefix() const { return "OBJC_CLASS_$_"; }
Daniel Dunbar15894b72009-04-07 05:48:37 +00001414
Daniel Dunbar961202372009-05-03 12:57:56 +00001415 void GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00001416 uint32_t &InstanceStart,
1417 uint32_t &InstanceSize);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001418
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001419 // Shamelessly stolen from Analysis/CFRefCount.cpp
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001420 Selector GetNullarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001421 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1422 return CGM.getContext().Selectors.getSelector(0, &II);
1423 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001424
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001425 Selector GetUnarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001426 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1427 return CGM.getContext().Selectors.getSelector(1, &II);
1428 }
Daniel Dunbar554fd792009-04-19 23:41:48 +00001429
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001430 /// ImplementationIsNonLazy - Check whether the given category or
1431 /// class implementation is "non-lazy".
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00001432 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001433
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001434 bool IsIvarOffsetKnownIdempotent(const CodeGen::CodeGenFunction &CGF,
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001435 const ObjCIvarDecl *IV) {
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001436 // Annotate the load as an invariant load iff inside an instance method
1437 // and ivar belongs to instance method's class and one of its super class.
1438 // This check is needed because the ivar offset is a lazily
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001439 // initialised value that may depend on objc_msgSend to perform a fixup on
1440 // the first message dispatch.
1441 //
1442 // An additional opportunity to mark the load as invariant arises when the
1443 // base of the ivar access is a parameter to an Objective C method.
1444 // However, because the parameters are not available in the current
1445 // interface, we cannot perform this check.
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001446 if (const ObjCMethodDecl *MD =
1447 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurFuncDecl))
Fariborz Jahanian7a583022014-03-04 22:57:32 +00001448 if (MD->isInstanceMethod())
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001449 if (const ObjCInterfaceDecl *ID = MD->getClassInterface())
1450 return IV->getContainingInterface()->isSuperClassOf(ID);
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001451 return false;
1452 }
1453
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001454public:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001455 CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian71394042009-01-23 23:53:38 +00001456 // FIXME. All stubs for now!
Craig Topper4f12f102014-03-12 06:41:41 +00001457 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001458
Craig Topper4f12f102014-03-12 06:41:41 +00001459 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1460 ReturnValueSlot Return,
1461 QualType ResultType, Selector Sel,
1462 llvm::Value *Receiver,
1463 const CallArgList &CallArgs,
1464 const ObjCInterfaceDecl *Class,
1465 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001466
Craig Topper4f12f102014-03-12 06:41:41 +00001467 CodeGen::RValue
Fariborz Jahanian71394042009-01-23 23:53:38 +00001468 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001469 ReturnValueSlot Return, QualType ResultType,
1470 Selector Sel, const ObjCInterfaceDecl *Class,
1471 bool isCategoryImpl, llvm::Value *Receiver,
1472 bool IsClassMessage, const CallArgList &CallArgs,
1473 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001474
Craig Topper4f12f102014-03-12 06:41:41 +00001475 llvm::Value *GetClass(CodeGenFunction &CGF,
1476 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001477
John McCall7f416cc2015-09-08 08:05:57 +00001478 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override
1479 { return EmitSelector(CGF, Sel); }
1480 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override
1481 { return EmitSelectorAddr(CGF, Sel); }
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001482
1483 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1484 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001485 llvm::Value *GetSelector(CodeGenFunction &CGF,
1486 const ObjCMethodDecl *Method) override
John McCall882987f2013-02-28 19:01:20 +00001487 { return EmitSelector(CGF, Method->getSelector()); }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001488
Craig Topper4f12f102014-03-12 06:41:41 +00001489 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001490
Craig Topper4f12f102014-03-12 06:41:41 +00001491 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
David Chisnall92d436b2012-01-31 18:59:20 +00001492
Craig Topper4f12f102014-03-12 06:41:41 +00001493 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001494
Craig Topper4f12f102014-03-12 06:41:41 +00001495 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1496 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001497
Craig Topper4f12f102014-03-12 06:41:41 +00001498 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001499
Craig Topper4f12f102014-03-12 06:41:41 +00001500 llvm::Constant *GetPropertyGetFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001501 return ObjCTypes.getGetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001502 }
Craig Topper4f12f102014-03-12 06:41:41 +00001503 llvm::Constant *GetPropertySetFunction() override {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001504 return ObjCTypes.getSetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001505 }
Craig Topper4f12f102014-03-12 06:41:41 +00001506
1507 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1508 bool copy) override {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001509 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
1510 }
Craig Topper4f12f102014-03-12 06:41:41 +00001511
1512 llvm::Constant *GetSetStructFunction() override {
David Chisnall168b80f2010-12-26 22:13:16 +00001513 return ObjCTypes.getCopyStructFn();
1514 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001515
Craig Topper4f12f102014-03-12 06:41:41 +00001516 llvm::Constant *GetGetStructFunction() override {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00001517 return ObjCTypes.getCopyStructFn();
1518 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001519
Craig Topper4f12f102014-03-12 06:41:41 +00001520 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +00001521 return ObjCTypes.getCppAtomicObjectFunction();
1522 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001523
Craig Topper4f12f102014-03-12 06:41:41 +00001524 llvm::Constant *GetCppAtomicObjectGetFunction() override {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00001525 return ObjCTypes.getCppAtomicObjectFunction();
1526 }
Craig Topper4f12f102014-03-12 06:41:41 +00001527
1528 llvm::Constant *EnumerationMutationFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001529 return ObjCTypes.getEnumerationMutationFn();
Daniel Dunbard73ea8162009-02-16 18:48:45 +00001530 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001531
Craig Topper4f12f102014-03-12 06:41:41 +00001532 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1533 const ObjCAtTryStmt &S) override;
1534 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1535 const ObjCAtSynchronizedStmt &S) override;
1536 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1537 bool ClearInsertionPoint=true) override;
1538 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001539 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001540 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001541 llvm::Value *src, Address edst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001542 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001543 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001544 bool threadlocal = false) override;
1545 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001546 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001547 llvm::Value *ivarOffset) override;
1548 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001549 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001550 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001551 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001552 llvm::Value *size) override;
1553 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1554 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1555 unsigned CVRQualifiers) override;
1556 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1557 const ObjCInterfaceDecl *Interface,
1558 const ObjCIvarDecl *Ivar) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001559};
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001560
1561/// A helper class for performing the null-initialization of a return
1562/// value.
1563struct NullReturnState {
1564 llvm::BasicBlock *NullBB;
Craig Topper8a13c412014-05-21 05:09:00 +00001565 NullReturnState() : NullBB(nullptr) {}
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001566
John McCall3d1e2c92013-02-12 05:53:35 +00001567 /// Perform a null-check of the given receiver.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001568 void init(CodeGenFunction &CGF, llvm::Value *receiver) {
John McCall3d1e2c92013-02-12 05:53:35 +00001569 // Make blocks for the null-receiver and call edges.
1570 NullBB = CGF.createBasicBlock("msgSend.null-receiver");
1571 llvm::BasicBlock *callBB = CGF.createBasicBlock("msgSend.call");
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001572
1573 // Check for a null receiver and, if there is one, jump to the
John McCall3d1e2c92013-02-12 05:53:35 +00001574 // null-receiver block. There's no point in trying to avoid it:
1575 // we're always going to put *something* there, because otherwise
1576 // we shouldn't have done this null-check in the first place.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001577 llvm::Value *isNull = CGF.Builder.CreateIsNull(receiver);
1578 CGF.Builder.CreateCondBr(isNull, NullBB, callBB);
1579
1580 // Otherwise, start performing the call.
1581 CGF.EmitBlock(callBB);
1582 }
1583
John McCall3d1e2c92013-02-12 05:53:35 +00001584 /// Complete the null-return operation. It is valid to call this
1585 /// regardless of whether 'init' has been called.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001586 RValue complete(CodeGenFunction &CGF, RValue result, QualType resultType,
1587 const CallArgList &CallArgs,
1588 const ObjCMethodDecl *Method) {
John McCall3d1e2c92013-02-12 05:53:35 +00001589 // If we never had to do a null-check, just use the raw result.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001590 if (!NullBB) return result;
John McCall3d1e2c92013-02-12 05:53:35 +00001591
1592 // The continuation block. This will be left null if we don't have an
1593 // IP, which can happen if the method we're calling is marked noreturn.
Craig Topper8a13c412014-05-21 05:09:00 +00001594 llvm::BasicBlock *contBB = nullptr;
1595
John McCall3d1e2c92013-02-12 05:53:35 +00001596 // Finish the call path.
1597 llvm::BasicBlock *callBB = CGF.Builder.GetInsertBlock();
1598 if (callBB) {
1599 contBB = CGF.createBasicBlock("msgSend.cont");
1600 CGF.Builder.CreateBr(contBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001601 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001602
John McCall3d1e2c92013-02-12 05:53:35 +00001603 // Okay, start emitting the null-receiver block.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001604 CGF.EmitBlock(NullBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001605
John McCall3d1e2c92013-02-12 05:53:35 +00001606 // Release any consumed arguments we've got.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001607 if (Method) {
1608 CallArgList::const_iterator I = CallArgs.begin();
1609 for (ObjCMethodDecl::param_const_iterator i = Method->param_begin(),
1610 e = Method->param_end(); i != e; ++i, ++I) {
1611 const ParmVarDecl *ParamDecl = (*i);
1612 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1613 RValue RV = I->RV;
1614 assert(RV.isScalar() &&
1615 "NullReturnState::complete - arg not on object");
John McCallcdda29c2013-03-13 03:10:54 +00001616 CGF.EmitARCRelease(RV.getScalarVal(), ARCImpreciseLifetime);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001617 }
1618 }
1619 }
John McCall3d1e2c92013-02-12 05:53:35 +00001620
1621 // The phi code below assumes that we haven't needed any control flow yet.
1622 assert(CGF.Builder.GetInsertBlock() == NullBB);
1623
1624 // If we've got a void return, just jump to the continuation block.
1625 if (result.isScalar() && resultType->isVoidType()) {
1626 // No jumps required if the message-send was noreturn.
1627 if (contBB) CGF.EmitBlock(contBB);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001628 return result;
1629 }
1630
John McCall3d1e2c92013-02-12 05:53:35 +00001631 // If we've got a scalar return, build a phi.
1632 if (result.isScalar()) {
1633 // Derive the null-initialization value.
1634 llvm::Constant *null = CGF.CGM.EmitNullConstant(resultType);
1635
1636 // If no join is necessary, just flow out.
1637 if (!contBB) return RValue::get(null);
1638
1639 // Otherwise, build a phi.
1640 CGF.EmitBlock(contBB);
1641 llvm::PHINode *phi = CGF.Builder.CreatePHI(null->getType(), 2);
1642 phi->addIncoming(result.getScalarVal(), callBB);
1643 phi->addIncoming(null, NullBB);
1644 return RValue::get(phi);
1645 }
1646
1647 // If we've got an aggregate return, null the buffer out.
1648 // FIXME: maybe we should be doing things differently for all the
1649 // cases where the ABI has us returning (1) non-agg values in
1650 // memory or (2) agg values in registers.
1651 if (result.isAggregate()) {
1652 assert(result.isAggregate() && "null init of non-aggregate result?");
John McCall7f416cc2015-09-08 08:05:57 +00001653 CGF.EmitNullInitialization(result.getAggregateAddress(), resultType);
John McCall3d1e2c92013-02-12 05:53:35 +00001654 if (contBB) CGF.EmitBlock(contBB);
1655 return result;
1656 }
1657
1658 // Complex types.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001659 CGF.EmitBlock(contBB);
John McCall3d1e2c92013-02-12 05:53:35 +00001660 CodeGenFunction::ComplexPairTy callResult = result.getComplexVal();
1661
1662 // Find the scalar type and its zero value.
1663 llvm::Type *scalarTy = callResult.first->getType();
1664 llvm::Constant *scalarZero = llvm::Constant::getNullValue(scalarTy);
1665
1666 // Build phis for both coordinates.
1667 llvm::PHINode *real = CGF.Builder.CreatePHI(scalarTy, 2);
1668 real->addIncoming(callResult.first, callBB);
1669 real->addIncoming(scalarZero, NullBB);
1670 llvm::PHINode *imag = CGF.Builder.CreatePHI(scalarTy, 2);
1671 imag->addIncoming(callResult.second, callBB);
1672 imag->addIncoming(scalarZero, NullBB);
1673 return RValue::getComplex(real, imag);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001674 }
1675};
1676
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001677} // end anonymous namespace
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001678
1679/* *** Helper Functions *** */
1680
1681/// getConstantGEP() - Help routine to construct simple GEPs.
Owen Anderson170229f2009-07-14 23:10:40 +00001682static llvm::Constant *getConstantGEP(llvm::LLVMContext &VMContext,
David Blaikiee3b172a2015-04-02 18:55:21 +00001683 llvm::GlobalVariable *C, unsigned idx0,
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001684 unsigned idx1) {
1685 llvm::Value *Idxs[] = {
Owen Anderson41a75022009-08-13 21:57:51 +00001686 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx0),
1687 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx1)
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001688 };
David Blaikiee3b172a2015-04-02 18:55:21 +00001689 return llvm::ConstantExpr::getGetElementPtr(C->getValueType(), C, Idxs);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001690}
1691
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001692/// hasObjCExceptionAttribute - Return true if this class or any super
1693/// class has the __objc_exception__ attribute.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001694static bool hasObjCExceptionAttribute(ASTContext &Context,
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001695 const ObjCInterfaceDecl *OID) {
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001696 if (OID->hasAttr<ObjCExceptionAttr>())
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001697 return true;
1698 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001699 return hasObjCExceptionAttribute(Context, Super);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001700 return false;
1701}
1702
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001703/* *** CGObjCMac Public Interface *** */
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001704
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001705CGObjCMac::CGObjCMac(CodeGen::CodeGenModule &cgm) : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00001706 ObjCTypes(cgm) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001707 ObjCABI = 1;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001708 EmitImageInfo();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001709}
1710
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001711/// GetClass - Return a reference to the class for the given interface
1712/// decl.
John McCall882987f2013-02-28 19:01:20 +00001713llvm::Value *CGObjCMac::GetClass(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001714 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00001715 return EmitClassRef(CGF, ID);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001716}
1717
1718/// GetSelector - Return the pointer to the unique'd string for this selector.
John McCall7f416cc2015-09-08 08:05:57 +00001719llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1720 return EmitSelector(CGF, Sel);
1721}
1722Address CGObjCMac::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1723 return EmitSelectorAddr(CGF, Sel);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001724}
John McCall882987f2013-02-28 19:01:20 +00001725llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, const ObjCMethodDecl
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001726 *Method) {
John McCall882987f2013-02-28 19:01:20 +00001727 return EmitSelector(CGF, Method->getSelector());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001728}
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001729
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001730llvm::Constant *CGObjCMac::GetEHType(QualType T) {
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001731 if (T->isObjCIdType() ||
1732 T->isObjCQualifiedIdType()) {
1733 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001734 CGM.getContext().getObjCIdRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001735 }
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001736 if (T->isObjCClassType() ||
1737 T->isObjCQualifiedClassType()) {
1738 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001739 CGM.getContext().getObjCClassRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001740 }
1741 if (T->isObjCObjectPointerType())
1742 return CGM.GetAddrOfRTTIDescriptor(T, /*ForEH=*/true);
1743
John McCall2ca705e2010-07-24 00:37:23 +00001744 llvm_unreachable("asking for catch type for ObjC type in fragile runtime");
John McCall2ca705e2010-07-24 00:37:23 +00001745}
1746
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001747/// Generate a constant CFString object.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001748/*
1749 struct __builtin_CFString {
1750 const int *isa; // point to __CFConstantStringClassReference
1751 int flags;
1752 const char *str;
1753 long length;
1754 };
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001755*/
1756
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001757/// or Generate a constant NSString object.
1758/*
1759 struct __builtin_NSString {
1760 const int *isa; // point to __NSConstantStringClassReference
1761 const char *str;
1762 unsigned int length;
1763 };
1764*/
1765
John McCall7f416cc2015-09-08 08:05:57 +00001766ConstantAddress CGObjCCommonMac::GenerateConstantString(
David Chisnall481e3a82010-01-23 02:40:42 +00001767 const StringLiteral *SL) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001768 return (CGM.getLangOpts().NoConstantCFStrings == 0 ?
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001769 CGM.GetAddrOfConstantCFString(SL) :
Fariborz Jahanian50c925f2010-10-19 17:19:29 +00001770 CGM.GetAddrOfConstantString(SL));
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001771}
1772
Ted Kremeneke65b0862012-03-06 20:05:56 +00001773enum {
1774 kCFTaggedObjectID_Integer = (1 << 1) + 1
1775};
1776
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001777/// Generates a message send where the super is the receiver. This is
1778/// a message send to self with special delivery semantics indicating
1779/// which class's method should be called.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001780CodeGen::RValue
1781CGObjCMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001782 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001783 QualType ResultType,
1784 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001785 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001786 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001787 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001788 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001789 const CodeGen::CallArgList &CallArgs,
1790 const ObjCMethodDecl *Method) {
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001791 // Create and init a super structure; this is a (receiver, class)
1792 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00001793 Address ObjCSuper =
1794 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
1795 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001796 llvm::Value *ReceiverAsObject =
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001797 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00001798 CGF.Builder.CreateStore(
1799 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00001800 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001801
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001802 // If this is a class message the metaclass is passed as the target.
1803 llvm::Value *Target;
1804 if (IsClassMessage) {
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001805 if (isCategoryImpl) {
1806 // Message sent to 'super' in a class method defined in a category
1807 // implementation requires an odd treatment.
1808 // If we are in a class method, we must retrieve the
1809 // _metaclass_ for the current class, pointed at by
1810 // the class's "isa" pointer. The following assumes that
1811 // isa" is the first ivar in a class (which it must be).
John McCall882987f2013-02-28 19:01:20 +00001812 Target = EmitClassRef(CGF, Class->getSuperClass());
David Blaikie1ed728c2015-04-05 22:45:47 +00001813 Target = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, Target, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001814 Target = CGF.Builder.CreateAlignedLoad(Target, CGF.getPointerAlign());
Mike Stump658fe022009-07-30 22:28:39 +00001815 } else {
David Blaikie1ed728c2015-04-05 22:45:47 +00001816 llvm::Constant *MetaClassPtr = EmitMetaClassRef(Class);
1817 llvm::Value *SuperPtr =
1818 CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, MetaClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001819 llvm::Value *Super =
1820 CGF.Builder.CreateAlignedLoad(SuperPtr, CGF.getPointerAlign());
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001821 Target = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001822 }
David Blaikie1ed728c2015-04-05 22:45:47 +00001823 } else if (isCategoryImpl)
John McCall882987f2013-02-28 19:01:20 +00001824 Target = EmitClassRef(CGF, Class->getSuperClass());
Fariborz Jahanianda2efb02009-11-14 02:18:31 +00001825 else {
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001826 llvm::Value *ClassPtr = EmitSuperClassRef(Class);
David Blaikie1ed728c2015-04-05 22:45:47 +00001827 ClassPtr = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, ClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001828 Target = CGF.Builder.CreateAlignedLoad(ClassPtr, CGF.getPointerAlign());
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001829 }
Mike Stump18bb9282009-05-16 07:57:57 +00001830 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
1831 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00001832 llvm::Type *ClassTy =
Daniel Dunbarc722b852008-08-30 03:02:31 +00001833 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
Daniel Dunbarc475d422008-10-29 22:36:39 +00001834 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
John McCall7f416cc2015-09-08 08:05:57 +00001835 CGF.Builder.CreateStore(Target,
1836 CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
John McCall9e8bb002011-05-14 03:10:52 +00001837 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001838 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00001839 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00001840 true, CallArgs, Method, Class, ObjCTypes);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001841}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001842
1843/// Generate code for a message send expression.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001844CodeGen::RValue CGObjCMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001845 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001846 QualType ResultType,
1847 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001848 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001849 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00001850 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001851 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00001852 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001853 EmitSelector(CGF, Sel),
John McCall9e8bb002011-05-14 03:10:52 +00001854 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00001855 false, CallArgs, Method, Class, ObjCTypes);
1856}
1857
1858static bool isWeakLinkedClass(const ObjCInterfaceDecl *ID) {
1859 do {
1860 if (ID->isWeakImported())
1861 return true;
1862 } while ((ID = ID->getSuperClass()));
1863
1864 return false;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00001865}
1866
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001867CodeGen::RValue
John McCall9e8bb002011-05-14 03:10:52 +00001868CGObjCCommonMac::EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1869 ReturnValueSlot Return,
1870 QualType ResultType,
1871 llvm::Value *Sel,
1872 llvm::Value *Arg0,
1873 QualType Arg0Ty,
1874 bool IsSuper,
1875 const CallArgList &CallArgs,
1876 const ObjCMethodDecl *Method,
John McCall1e3157b2015-09-10 22:27:50 +00001877 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001878 const ObjCCommonTypesHelper &ObjCTypes) {
Daniel Dunbarc722b852008-08-30 03:02:31 +00001879 CallArgList ActualArgs;
Fariborz Jahanian969bc682009-04-24 21:07:43 +00001880 if (!IsSuper)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001881 Arg0 = CGF.Builder.CreateBitCast(Arg0, ObjCTypes.ObjectPtrTy);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001882 ActualArgs.add(RValue::get(Arg0), Arg0Ty);
1883 ActualArgs.add(RValue::get(Sel), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001884 ActualArgs.addFrom(CallArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001885
John McCalla729c622012-02-17 03:33:10 +00001886 // If we're calling a method, use the formal signature.
1887 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001888
Anders Carlsson280e61f12010-06-21 20:59:55 +00001889 if (Method)
Alp Toker314cc812014-01-25 16:55:45 +00001890 assert(CGM.getContext().getCanonicalType(Method->getReturnType()) ==
1891 CGM.getContext().getCanonicalType(ResultType) &&
Anders Carlsson280e61f12010-06-21 20:59:55 +00001892 "Result type mismatch!");
1893
John McCall1e3157b2015-09-10 22:27:50 +00001894 bool ReceiverCanBeNull = true;
1895
1896 // Super dispatch assumes that self is non-null; even the messenger
1897 // doesn't have a null check internally.
1898 if (IsSuper) {
1899 ReceiverCanBeNull = false;
1900
1901 // If this is a direct dispatch of a class method, check whether the class,
1902 // or anything in its hierarchy, was weak-linked.
1903 } else if (ClassReceiver && Method && Method->isClassMethod()) {
1904 ReceiverCanBeNull = isWeakLinkedClass(ClassReceiver);
1905
1906 // If we're emitting a method, and self is const (meaning just ARC, for now),
1907 // and the receiver is a load of self, then self is a valid object.
1908 } else if (auto CurMethod =
1909 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl)) {
1910 auto Self = CurMethod->getSelfDecl();
1911 if (Self->getType().isConstQualified()) {
1912 if (auto LI = dyn_cast<llvm::LoadInst>(Arg0->stripPointerCasts())) {
1913 llvm::Value *SelfAddr = CGF.GetAddrOfLocalVar(Self).getPointer();
1914 if (SelfAddr == LI->getPointerOperand()) {
1915 ReceiverCanBeNull = false;
1916 }
1917 }
1918 }
1919 }
1920
John McCall5880fb82011-05-14 21:12:11 +00001921 NullReturnState nullReturn;
1922
Craig Topper8a13c412014-05-21 05:09:00 +00001923 llvm::Constant *Fn = nullptr;
Tim Northovere77cc392014-03-29 13:28:05 +00001924 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall1e3157b2015-09-10 22:27:50 +00001925 if (ReceiverCanBeNull) nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001926 Fn = (ObjCABI == 2) ? ObjCTypes.getSendStretFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001927 : ObjCTypes.getSendStretFn(IsSuper);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001928 } else if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1929 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFpretFn2(IsSuper)
1930 : ObjCTypes.getSendFpretFn(IsSuper);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001931 } else if (CGM.ReturnTypeUsesFP2Ret(ResultType)) {
1932 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFp2RetFn2(IsSuper)
1933 : ObjCTypes.getSendFp2retFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001934 } else {
Tim Northovere77cc392014-03-29 13:28:05 +00001935 // arm64 uses objc_msgSend for stret methods and yet null receiver check
1936 // must be made for it.
Ahmed Bougachaa3df87b2015-10-02 22:41:59 +00001937 if (ReceiverCanBeNull && CGM.ReturnTypeUsesSRet(MSI.CallInfo))
Tim Northovere77cc392014-03-29 13:28:05 +00001938 nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001939 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001940 : ObjCTypes.getSendFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001941 }
John McCall1e3157b2015-09-10 22:27:50 +00001942
1943 // Emit a null-check if there's a consumed argument other than the receiver.
1944 bool RequiresNullCheck = false;
1945 if (ReceiverCanBeNull && CGM.getLangOpts().ObjCAutoRefCount && Method) {
Aaron Ballman43b68be2014-03-07 17:50:17 +00001946 for (const auto *ParamDecl : Method->params()) {
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001947 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1948 if (!nullReturn.NullBB)
1949 nullReturn.init(CGF, Arg0);
John McCall1e3157b2015-09-10 22:27:50 +00001950 RequiresNullCheck = true;
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001951 break;
1952 }
1953 }
John McCall1e3157b2015-09-10 22:27:50 +00001954 }
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001955
John McCall1e3157b2015-09-10 22:27:50 +00001956 llvm::Instruction *CallSite;
John McCalla729c622012-02-17 03:33:10 +00001957 Fn = llvm::ConstantExpr::getBitCast(Fn, MSI.MessengerType);
John McCall1e3157b2015-09-10 22:27:50 +00001958 RValue rvalue = CGF.EmitCall(MSI.CallInfo, Fn, Return, ActualArgs,
Samuel Antao798f11c2015-11-23 22:04:44 +00001959 CGCalleeInfo(), &CallSite);
John McCall1e3157b2015-09-10 22:27:50 +00001960
1961 // Mark the call as noreturn if the method is marked noreturn and the
1962 // receiver cannot be null.
1963 if (Method && Method->hasAttr<NoReturnAttr>() && !ReceiverCanBeNull) {
1964 llvm::CallSite(CallSite).setDoesNotReturn();
1965 }
1966
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001967 return nullReturn.complete(CGF, rvalue, ResultType, CallArgs,
John McCall1e3157b2015-09-10 22:27:50 +00001968 RequiresNullCheck ? Method : nullptr);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001969}
1970
John McCall3fd13f062015-10-21 18:06:47 +00001971static Qualifiers::GC GetGCAttrTypeForType(ASTContext &Ctx, QualType FQT,
1972 bool pointee = false) {
1973 // Note that GC qualification applies recursively to C pointer types
1974 // that aren't otherwise decorated. This is weird, but it's probably
1975 // an intentional workaround to the unreliable placement of GC qualifiers.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001976 if (FQT.isObjCGCStrong())
1977 return Qualifiers::Strong;
John McCall3fd13f062015-10-21 18:06:47 +00001978
1979 if (FQT.isObjCGCWeak())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001980 return Qualifiers::Weak;
John McCall3fd13f062015-10-21 18:06:47 +00001981
1982 if (auto ownership = FQT.getObjCLifetime()) {
1983 // Ownership does not apply recursively to C pointer types.
1984 if (pointee) return Qualifiers::GCNone;
1985 switch (ownership) {
1986 case Qualifiers::OCL_Weak: return Qualifiers::Weak;
1987 case Qualifiers::OCL_Strong: return Qualifiers::Strong;
1988 case Qualifiers::OCL_ExplicitNone: return Qualifiers::GCNone;
1989 case Qualifiers::OCL_Autoreleasing: llvm_unreachable("autoreleasing ivar?");
1990 case Qualifiers::OCL_None: llvm_unreachable("known nonzero");
1991 }
1992 llvm_unreachable("bad objc ownership");
1993 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001994
John McCall3fd13f062015-10-21 18:06:47 +00001995 // Treat unqualified retainable pointers as strong.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001996 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
1997 return Qualifiers::Strong;
1998
John McCall3fd13f062015-10-21 18:06:47 +00001999 // Walk into C pointer types, but only in GC.
2000 if (Ctx.getLangOpts().getGC() != LangOptions::NonGC) {
2001 if (const PointerType *PT = FQT->getAs<PointerType>())
2002 return GetGCAttrTypeForType(Ctx, PT->getPointeeType(), /*pointee*/ true);
2003 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002004
2005 return Qualifiers::GCNone;
2006}
2007
John McCall3fd13f062015-10-21 18:06:47 +00002008namespace {
2009 struct IvarInfo {
2010 CharUnits Offset;
2011 uint64_t SizeInWords;
2012 IvarInfo(CharUnits offset, uint64_t sizeInWords)
2013 : Offset(offset), SizeInWords(sizeInWords) {}
2014
2015 // Allow sorting based on byte pos.
2016 bool operator<(const IvarInfo &other) const {
2017 return Offset < other.Offset;
2018 }
2019 };
2020
2021 /// A helper class for building GC layout strings.
2022 class IvarLayoutBuilder {
2023 CodeGenModule &CGM;
2024
2025 /// The start of the layout. Offsets will be relative to this value,
2026 /// and entries less than this value will be silently discarded.
2027 CharUnits InstanceBegin;
2028
2029 /// The end of the layout. Offsets will never exceed this value.
2030 CharUnits InstanceEnd;
2031
2032 /// Whether we're generating the strong layout or the weak layout.
2033 bool ForStrongLayout;
2034
2035 /// Whether the offsets in IvarsInfo might be out-of-order.
2036 bool IsDisordered = false;
2037
2038 llvm::SmallVector<IvarInfo, 8> IvarsInfo;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002039
John McCall3fd13f062015-10-21 18:06:47 +00002040 public:
2041 IvarLayoutBuilder(CodeGenModule &CGM, CharUnits instanceBegin,
2042 CharUnits instanceEnd, bool forStrongLayout)
2043 : CGM(CGM), InstanceBegin(instanceBegin), InstanceEnd(instanceEnd),
2044 ForStrongLayout(forStrongLayout) {
2045 }
2046
2047 void visitRecord(const RecordType *RT, CharUnits offset);
2048
2049 template <class Iterator, class GetOffsetFn>
2050 void visitAggregate(Iterator begin, Iterator end,
2051 CharUnits aggrOffset,
2052 const GetOffsetFn &getOffset);
2053
2054 void visitField(const FieldDecl *field, CharUnits offset);
2055
2056 /// Add the layout of a block implementation.
2057 void visitBlock(const CGBlockInfo &blockInfo);
2058
2059 /// Is there any information for an interesting bitmap?
2060 bool hasBitmapData() const { return !IvarsInfo.empty(); }
2061
2062 llvm::Constant *buildBitmap(CGObjCCommonMac &CGObjC,
2063 llvm::SmallVectorImpl<unsigned char> &buffer);
2064
2065 static void dump(ArrayRef<unsigned char> buffer) {
2066 const unsigned char *s = buffer.data();
2067 for (unsigned i = 0, e = buffer.size(); i < e; i++)
2068 if (!(s[i] & 0xf0))
2069 printf("0x0%x%s", s[i], s[i] != 0 ? ", " : "");
2070 else
2071 printf("0x%x%s", s[i], s[i] != 0 ? ", " : "");
2072 printf("\n");
2073 }
2074 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002075} // end anonymous namespace
John McCall3fd13f062015-10-21 18:06:47 +00002076
John McCall351762c2011-02-07 10:33:21 +00002077llvm::Constant *CGObjCCommonMac::BuildGCBlockLayout(CodeGenModule &CGM,
2078 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002079
Chris Lattnerece04092012-02-07 00:39:47 +00002080 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
John McCall460ce582015-10-22 18:38:17 +00002081 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
John McCall351762c2011-02-07 10:33:21 +00002082 return nullPtr;
2083
John McCall3fd13f062015-10-21 18:06:47 +00002084 IvarLayoutBuilder builder(CGM, CharUnits::Zero(), blockInfo.BlockSize,
2085 /*for strong layout*/ true);
2086
2087 builder.visitBlock(blockInfo);
2088
2089 if (!builder.hasBitmapData())
2090 return nullPtr;
2091
2092 llvm::SmallVector<unsigned char, 32> buffer;
2093 llvm::Constant *C = builder.buildBitmap(*this, buffer);
John McCallf5ea0722015-10-29 23:36:14 +00002094 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
John McCall3fd13f062015-10-21 18:06:47 +00002095 printf("\n block variable layout for block: ");
2096 builder.dump(buffer);
2097 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002098
John McCall3fd13f062015-10-21 18:06:47 +00002099 return C;
2100}
2101
2102void IvarLayoutBuilder::visitBlock(const CGBlockInfo &blockInfo) {
Fariborz Jahaniancfddabf2010-09-09 00:21:45 +00002103 // __isa is the first field in block descriptor and must assume by runtime's
2104 // convention that it is GC'able.
John McCall3fd13f062015-10-21 18:06:47 +00002105 IvarsInfo.push_back(IvarInfo(CharUnits::Zero(), 1));
John McCall351762c2011-02-07 10:33:21 +00002106
2107 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2108
John McCall351762c2011-02-07 10:33:21 +00002109 // Ignore the optional 'this' capture: C++ objects are not assumed
2110 // to be GC'ed.
2111
John McCall3fd13f062015-10-21 18:06:47 +00002112 CharUnits lastFieldOffset;
2113
John McCall351762c2011-02-07 10:33:21 +00002114 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002115 for (const auto &CI : blockDecl->captures()) {
2116 const VarDecl *variable = CI.getVariable();
John McCall351762c2011-02-07 10:33:21 +00002117 QualType type = variable->getType();
2118
2119 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2120
2121 // Ignore constant captures.
2122 if (capture.isConstant()) continue;
2123
John McCall3fd13f062015-10-21 18:06:47 +00002124 CharUnits fieldOffset = capture.getOffset();
2125
2126 // Block fields are not necessarily ordered; if we detect that we're
2127 // adding them out-of-order, make sure we sort later.
2128 if (fieldOffset < lastFieldOffset)
2129 IsDisordered = true;
2130 lastFieldOffset = fieldOffset;
John McCall351762c2011-02-07 10:33:21 +00002131
2132 // __block variables are passed by their descriptor address.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002133 if (CI.isByRef()) {
John McCall3fd13f062015-10-21 18:06:47 +00002134 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
Fariborz Jahanian933c6722010-09-11 01:27:29 +00002135 continue;
John McCall351762c2011-02-07 10:33:21 +00002136 }
2137
2138 assert(!type->isArrayType() && "array variable should not be caught");
2139 if (const RecordType *record = type->getAs<RecordType>()) {
John McCall3fd13f062015-10-21 18:06:47 +00002140 visitRecord(record, fieldOffset);
Fariborz Jahanian903aba32010-08-05 21:00:25 +00002141 continue;
2142 }
Fariborz Jahanianf95e3582010-08-06 16:28:55 +00002143
John McCall351762c2011-02-07 10:33:21 +00002144 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), type);
John McCall351762c2011-02-07 10:33:21 +00002145
John McCall3fd13f062015-10-21 18:06:47 +00002146 if (GCAttr == Qualifiers::Strong) {
2147 assert(CGM.getContext().getTypeSize(type)
2148 == CGM.getTarget().getPointerWidth(0));
2149 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
2150 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002151 }
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00002152}
2153
Fariborz Jahanian2c96d302012-11-04 18:19:40 +00002154/// getBlockCaptureLifetime - This routine returns life time of the captured
2155/// block variable for the purpose of block layout meta-data generation. FQT is
2156/// the type of the variable captured in the block.
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002157Qualifiers::ObjCLifetime CGObjCCommonMac::getBlockCaptureLifetime(QualType FQT,
2158 bool ByrefLayout) {
John McCall460ce582015-10-22 18:38:17 +00002159 // If it has an ownership qualifier, we're done.
2160 if (auto lifetime = FQT.getObjCLifetime())
2161 return lifetime;
2162
2163 // If it doesn't, and this is ARC, it has no ownership.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002164 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall460ce582015-10-22 18:38:17 +00002165 return Qualifiers::OCL_None;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002166
John McCall460ce582015-10-22 18:38:17 +00002167 // In MRC, retainable pointers are owned by non-__block variables.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002168 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002169 return ByrefLayout ? Qualifiers::OCL_ExplicitNone : Qualifiers::OCL_Strong;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002170
2171 return Qualifiers::OCL_None;
2172}
2173
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002174void CGObjCCommonMac::UpdateRunSkipBlockVars(bool IsByref,
2175 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002176 CharUnits FieldOffset,
2177 CharUnits FieldSize) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002178 // __block variables are passed by their descriptor address.
2179 if (IsByref)
2180 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_BYREF, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002181 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002182 else if (LifeTime == Qualifiers::OCL_Strong)
2183 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_STRONG, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002184 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002185 else if (LifeTime == Qualifiers::OCL_Weak)
2186 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_WEAK, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002187 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002188 else if (LifeTime == Qualifiers::OCL_ExplicitNone)
2189 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_UNRETAINED, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002190 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002191 else
2192 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_NON_OBJECT_BYTES,
2193 FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002194 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002195}
2196
2197void CGObjCCommonMac::BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
2198 const RecordDecl *RD,
2199 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002200 CharUnits BytePos, bool &HasUnion,
2201 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002202 bool IsUnion = (RD && RD->isUnion());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002203 CharUnits MaxUnionSize = CharUnits::Zero();
Craig Topper8a13c412014-05-21 05:09:00 +00002204 const FieldDecl *MaxField = nullptr;
2205 const FieldDecl *LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002206 CharUnits MaxFieldOffset = CharUnits::Zero();
2207 CharUnits LastBitfieldOrUnnamedOffset = CharUnits::Zero();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002208
2209 if (RecFields.empty())
2210 return;
John McCallc8e01702013-04-16 22:48:15 +00002211 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002212
2213 for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
2214 const FieldDecl *Field = RecFields[i];
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002215 // Note that 'i' here is actually the field index inside RD of Field,
2216 // although this dependency is hidden.
2217 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002218 CharUnits FieldOffset =
2219 CGM.getContext().toCharUnitsFromBits(RL.getFieldOffset(i));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002220
2221 // Skip over unnamed or bitfields
2222 if (!Field->getIdentifier() || Field->isBitField()) {
2223 LastFieldBitfieldOrUnnamed = Field;
2224 LastBitfieldOrUnnamedOffset = FieldOffset;
2225 continue;
2226 }
Craig Topper8a13c412014-05-21 05:09:00 +00002227
2228 LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002229 QualType FQT = Field->getType();
2230 if (FQT->isRecordType() || FQT->isUnionType()) {
2231 if (FQT->isUnionType())
2232 HasUnion = true;
2233
2234 BuildRCBlockVarRecordLayout(FQT->getAs<RecordType>(),
2235 BytePos + FieldOffset, HasUnion);
2236 continue;
2237 }
2238
2239 if (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2240 const ConstantArrayType *CArray =
2241 dyn_cast_or_null<ConstantArrayType>(Array);
2242 uint64_t ElCount = CArray->getSize().getZExtValue();
2243 assert(CArray && "only array with known element size is supported");
2244 FQT = CArray->getElementType();
2245 while (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2246 const ConstantArrayType *CArray =
2247 dyn_cast_or_null<ConstantArrayType>(Array);
2248 ElCount *= CArray->getSize().getZExtValue();
2249 FQT = CArray->getElementType();
2250 }
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002251 if (FQT->isRecordType() && ElCount) {
2252 int OldIndex = RunSkipBlockVars.size() - 1;
2253 const RecordType *RT = FQT->getAs<RecordType>();
2254 BuildRCBlockVarRecordLayout(RT, BytePos + FieldOffset,
2255 HasUnion);
2256
2257 // Replicate layout information for each array element. Note that
2258 // one element is already done.
2259 uint64_t ElIx = 1;
2260 for (int FirstIndex = RunSkipBlockVars.size() - 1 ;ElIx < ElCount; ElIx++) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002261 CharUnits Size = CGM.getContext().getTypeSizeInChars(RT);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002262 for (int i = OldIndex+1; i <= FirstIndex; ++i)
2263 RunSkipBlockVars.push_back(
2264 RUN_SKIP(RunSkipBlockVars[i].opcode,
2265 RunSkipBlockVars[i].block_var_bytepos + Size*ElIx,
2266 RunSkipBlockVars[i].block_var_size));
2267 }
2268 continue;
2269 }
2270 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002271 CharUnits FieldSize = CGM.getContext().getTypeSizeInChars(Field->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002272 if (IsUnion) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002273 CharUnits UnionIvarSize = FieldSize;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002274 if (UnionIvarSize > MaxUnionSize) {
2275 MaxUnionSize = UnionIvarSize;
2276 MaxField = Field;
2277 MaxFieldOffset = FieldOffset;
2278 }
2279 } else {
2280 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002281 getBlockCaptureLifetime(FQT, ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002282 BytePos + FieldOffset,
2283 FieldSize);
2284 }
2285 }
2286
2287 if (LastFieldBitfieldOrUnnamed) {
2288 if (LastFieldBitfieldOrUnnamed->isBitField()) {
2289 // Last field was a bitfield. Must update the info.
2290 uint64_t BitFieldSize
2291 = LastFieldBitfieldOrUnnamed->getBitWidthValue(CGM.getContext());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002292 unsigned UnsSize = (BitFieldSize / ByteSizeInBits) +
Eli Friedman8cbca202012-11-06 22:15:52 +00002293 ((BitFieldSize % ByteSizeInBits) != 0);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002294 CharUnits Size = CharUnits::fromQuantity(UnsSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002295 Size += LastBitfieldOrUnnamedOffset;
2296 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002297 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2298 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002299 BytePos + LastBitfieldOrUnnamedOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002300 Size);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002301 } else {
2302 assert(!LastFieldBitfieldOrUnnamed->getIdentifier() &&"Expected unnamed");
2303 // Last field was unnamed. Must update skip info.
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002304 CharUnits FieldSize
2305 = CGM.getContext().getTypeSizeInChars(LastFieldBitfieldOrUnnamed->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002306 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002307 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2308 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002309 BytePos + LastBitfieldOrUnnamedOffset,
2310 FieldSize);
2311 }
2312 }
2313
2314 if (MaxField)
2315 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002316 getBlockCaptureLifetime(MaxField->getType(), ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002317 BytePos + MaxFieldOffset,
2318 MaxUnionSize);
2319}
2320
2321void CGObjCCommonMac::BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002322 CharUnits BytePos,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002323 bool &HasUnion,
2324 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002325 const RecordDecl *RD = RT->getDecl();
Aaron Ballman62e47c42014-03-10 13:43:55 +00002326 SmallVector<const FieldDecl*, 16> Fields(RD->fields());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002327 llvm::Type *Ty = CGM.getTypes().ConvertType(QualType(RT, 0));
2328 const llvm::StructLayout *RecLayout =
2329 CGM.getDataLayout().getStructLayout(cast<llvm::StructType>(Ty));
2330
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002331 BuildRCRecordLayout(RecLayout, RD, Fields, BytePos, HasUnion, ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002332}
2333
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002334/// InlineLayoutInstruction - This routine produce an inline instruction for the
2335/// block variable layout if it can. If not, it returns 0. Rules are as follow:
2336/// If ((uintptr_t) layout) < (1 << 12), the layout is inline. In the 64bit world,
2337/// an inline layout of value 0x0000000000000xyz is interpreted as follows:
2338/// x captured object pointers of BLOCK_LAYOUT_STRONG. Followed by
2339/// y captured object of BLOCK_LAYOUT_BYREF. Followed by
2340/// z captured object of BLOCK_LAYOUT_WEAK. If any of the above is missing, zero
2341/// replaces it. For example, 0x00000x00 means x BLOCK_LAYOUT_STRONG and no
2342/// BLOCK_LAYOUT_BYREF and no BLOCK_LAYOUT_WEAK objects are captured.
2343uint64_t CGObjCCommonMac::InlineLayoutInstruction(
2344 SmallVectorImpl<unsigned char> &Layout) {
2345 uint64_t Result = 0;
2346 if (Layout.size() <= 3) {
2347 unsigned size = Layout.size();
2348 unsigned strong_word_count = 0, byref_word_count=0, weak_word_count=0;
2349 unsigned char inst;
2350 enum BLOCK_LAYOUT_OPCODE opcode ;
2351 switch (size) {
2352 case 3:
2353 inst = Layout[0];
2354 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2355 if (opcode == BLOCK_LAYOUT_STRONG)
2356 strong_word_count = (inst & 0xF)+1;
2357 else
2358 return 0;
2359 inst = Layout[1];
2360 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2361 if (opcode == BLOCK_LAYOUT_BYREF)
2362 byref_word_count = (inst & 0xF)+1;
2363 else
2364 return 0;
2365 inst = Layout[2];
2366 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2367 if (opcode == BLOCK_LAYOUT_WEAK)
2368 weak_word_count = (inst & 0xF)+1;
2369 else
2370 return 0;
2371 break;
2372
2373 case 2:
2374 inst = Layout[0];
2375 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2376 if (opcode == BLOCK_LAYOUT_STRONG) {
2377 strong_word_count = (inst & 0xF)+1;
2378 inst = Layout[1];
2379 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2380 if (opcode == BLOCK_LAYOUT_BYREF)
2381 byref_word_count = (inst & 0xF)+1;
2382 else if (opcode == BLOCK_LAYOUT_WEAK)
2383 weak_word_count = (inst & 0xF)+1;
2384 else
2385 return 0;
2386 }
2387 else if (opcode == BLOCK_LAYOUT_BYREF) {
2388 byref_word_count = (inst & 0xF)+1;
2389 inst = Layout[1];
2390 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2391 if (opcode == BLOCK_LAYOUT_WEAK)
2392 weak_word_count = (inst & 0xF)+1;
2393 else
2394 return 0;
2395 }
2396 else
2397 return 0;
2398 break;
2399
2400 case 1:
2401 inst = Layout[0];
2402 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2403 if (opcode == BLOCK_LAYOUT_STRONG)
2404 strong_word_count = (inst & 0xF)+1;
2405 else if (opcode == BLOCK_LAYOUT_BYREF)
2406 byref_word_count = (inst & 0xF)+1;
2407 else if (opcode == BLOCK_LAYOUT_WEAK)
2408 weak_word_count = (inst & 0xF)+1;
2409 else
2410 return 0;
2411 break;
2412
2413 default:
2414 return 0;
2415 }
2416
2417 // Cannot inline when any of the word counts is 15. Because this is one less
2418 // than the actual work count (so 15 means 16 actual word counts),
2419 // and we can only display 0 thru 15 word counts.
2420 if (strong_word_count == 16 || byref_word_count == 16 || weak_word_count == 16)
2421 return 0;
2422
2423 unsigned count =
2424 (strong_word_count != 0) + (byref_word_count != 0) + (weak_word_count != 0);
2425
2426 if (size == count) {
2427 if (strong_word_count)
2428 Result = strong_word_count;
2429 Result <<= 4;
2430 if (byref_word_count)
2431 Result += byref_word_count;
2432 Result <<= 4;
2433 if (weak_word_count)
2434 Result += weak_word_count;
2435 }
2436 }
2437 return Result;
2438}
2439
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002440llvm::Constant *CGObjCCommonMac::getBitmapBlockLayout(bool ComputeByrefLayout) {
2441 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2442 if (RunSkipBlockVars.empty())
2443 return nullPtr;
John McCallc8e01702013-04-16 22:48:15 +00002444 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2445 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002446 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2447
2448 // Sort on byte position; captures might not be allocated in order,
2449 // and unions can do funny things.
2450 llvm::array_pod_sort(RunSkipBlockVars.begin(), RunSkipBlockVars.end());
2451 SmallVector<unsigned char, 16> Layout;
2452
2453 unsigned size = RunSkipBlockVars.size();
2454 for (unsigned i = 0; i < size; i++) {
2455 enum BLOCK_LAYOUT_OPCODE opcode = RunSkipBlockVars[i].opcode;
2456 CharUnits start_byte_pos = RunSkipBlockVars[i].block_var_bytepos;
2457 CharUnits end_byte_pos = start_byte_pos;
2458 unsigned j = i+1;
2459 while (j < size) {
2460 if (opcode == RunSkipBlockVars[j].opcode) {
2461 end_byte_pos = RunSkipBlockVars[j++].block_var_bytepos;
2462 i++;
2463 }
2464 else
2465 break;
2466 }
2467 CharUnits size_in_bytes =
2468 end_byte_pos - start_byte_pos + RunSkipBlockVars[j-1].block_var_size;
2469 if (j < size) {
2470 CharUnits gap =
2471 RunSkipBlockVars[j].block_var_bytepos -
2472 RunSkipBlockVars[j-1].block_var_bytepos - RunSkipBlockVars[j-1].block_var_size;
2473 size_in_bytes += gap;
2474 }
2475 CharUnits residue_in_bytes = CharUnits::Zero();
2476 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES) {
2477 residue_in_bytes = size_in_bytes % WordSizeInBytes;
2478 size_in_bytes -= residue_in_bytes;
2479 opcode = BLOCK_LAYOUT_NON_OBJECT_WORDS;
2480 }
2481
2482 unsigned size_in_words = size_in_bytes.getQuantity() / WordSizeInBytes;
2483 while (size_in_words >= 16) {
2484 // Note that value in imm. is one less that the actual
2485 // value. So, 0xf means 16 words follow!
2486 unsigned char inst = (opcode << 4) | 0xf;
2487 Layout.push_back(inst);
2488 size_in_words -= 16;
2489 }
2490 if (size_in_words > 0) {
2491 // Note that value in imm. is one less that the actual
2492 // value. So, we subtract 1 away!
2493 unsigned char inst = (opcode << 4) | (size_in_words-1);
2494 Layout.push_back(inst);
2495 }
2496 if (residue_in_bytes > CharUnits::Zero()) {
2497 unsigned char inst =
2498 (BLOCK_LAYOUT_NON_OBJECT_BYTES << 4) | (residue_in_bytes.getQuantity()-1);
2499 Layout.push_back(inst);
2500 }
2501 }
2502
John McCall7f416cc2015-09-08 08:05:57 +00002503 while (!Layout.empty()) {
2504 unsigned char inst = Layout.back();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002505 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2506 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES || opcode == BLOCK_LAYOUT_NON_OBJECT_WORDS)
2507 Layout.pop_back();
2508 else
2509 break;
2510 }
2511
2512 uint64_t Result = InlineLayoutInstruction(Layout);
2513 if (Result != 0) {
2514 // Block variable layout instruction has been inlined.
2515 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2516 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002517 printf("\n Inline BYREF variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002518 else
John McCall7f416cc2015-09-08 08:05:57 +00002519 printf("\n Inline block variable layout: ");
2520 printf("0x0%" PRIx64 "", Result);
2521 if (auto numStrong = (Result & 0xF00) >> 8)
2522 printf(", BL_STRONG:%d", (int) numStrong);
2523 if (auto numByref = (Result & 0x0F0) >> 4)
2524 printf(", BL_BYREF:%d", (int) numByref);
2525 if (auto numWeak = (Result & 0x00F) >> 0)
2526 printf(", BL_WEAK:%d", (int) numWeak);
2527 printf(", BL_OPERATOR:0\n");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002528 }
Vedant Kumar3ed0df02015-12-21 19:43:25 +00002529 return llvm::ConstantInt::get(CGM.IntPtrTy, Result);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002530 }
2531
2532 unsigned char inst = (BLOCK_LAYOUT_OPERATOR << 4) | 0;
2533 Layout.push_back(inst);
2534 std::string BitMap;
2535 for (unsigned i = 0, e = Layout.size(); i != e; i++)
2536 BitMap += Layout[i];
2537
2538 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2539 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002540 printf("\n Byref variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002541 else
John McCall7f416cc2015-09-08 08:05:57 +00002542 printf("\n Block variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002543 for (unsigned i = 0, e = BitMap.size(); i != e; i++) {
2544 unsigned char inst = BitMap[i];
2545 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2546 unsigned delta = 1;
2547 switch (opcode) {
2548 case BLOCK_LAYOUT_OPERATOR:
2549 printf("BL_OPERATOR:");
2550 delta = 0;
2551 break;
2552 case BLOCK_LAYOUT_NON_OBJECT_BYTES:
2553 printf("BL_NON_OBJECT_BYTES:");
2554 break;
2555 case BLOCK_LAYOUT_NON_OBJECT_WORDS:
2556 printf("BL_NON_OBJECT_WORD:");
2557 break;
2558 case BLOCK_LAYOUT_STRONG:
2559 printf("BL_STRONG:");
2560 break;
2561 case BLOCK_LAYOUT_BYREF:
2562 printf("BL_BYREF:");
2563 break;
2564 case BLOCK_LAYOUT_WEAK:
2565 printf("BL_WEAK:");
2566 break;
2567 case BLOCK_LAYOUT_UNRETAINED:
2568 printf("BL_UNRETAINED:");
2569 break;
2570 }
2571 // Actual value of word count is one more that what is in the imm.
2572 // field of the instruction
2573 printf("%d", (inst & 0xf) + delta);
2574 if (i < e-1)
2575 printf(", ");
2576 else
2577 printf("\n");
2578 }
2579 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002580
2581 llvm::GlobalVariable *Entry = CreateMetadataVar(
2582 "OBJC_CLASS_NAME_",
2583 llvm::ConstantDataArray::getString(VMContext, BitMap, false),
John McCall7f416cc2015-09-08 08:05:57 +00002584 "__TEXT,__objc_classname,cstring_literals", CharUnits::One(), true);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002585 return getConstantGEP(VMContext, Entry, 0, 0);
2586}
2587
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002588llvm::Constant *CGObjCCommonMac::BuildRCBlockLayout(CodeGenModule &CGM,
2589 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002590 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2591
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002592 RunSkipBlockVars.clear();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002593 bool hasUnion = false;
2594
John McCallc8e01702013-04-16 22:48:15 +00002595 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2596 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002597 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2598
2599 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2600
2601 // Calculate the basic layout of the block structure.
2602 const llvm::StructLayout *layout =
2603 CGM.getDataLayout().getStructLayout(blockInfo.StructureType);
2604
2605 // Ignore the optional 'this' capture: C++ objects are not assumed
2606 // to be GC'ed.
Fariborz Jahanian4cf177e2012-12-04 17:20:57 +00002607 if (blockInfo.BlockHeaderForcedGapSize != CharUnits::Zero())
2608 UpdateRunSkipBlockVars(false, Qualifiers::OCL_None,
2609 blockInfo.BlockHeaderForcedGapOffset,
2610 blockInfo.BlockHeaderForcedGapSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002611 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002612 for (const auto &CI : blockDecl->captures()) {
2613 const VarDecl *variable = CI.getVariable();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002614 QualType type = variable->getType();
2615
2616 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2617
2618 // Ignore constant captures.
2619 if (capture.isConstant()) continue;
2620
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002621 CharUnits fieldOffset =
2622 CharUnits::fromQuantity(layout->getElementOffset(capture.getIndex()));
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002623
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002624 assert(!type->isArrayType() && "array variable should not be caught");
Aaron Ballman9371dd22014-03-14 18:34:04 +00002625 if (!CI.isByRef())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002626 if (const RecordType *record = type->getAs<RecordType>()) {
2627 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion);
2628 continue;
2629 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002630 CharUnits fieldSize;
Aaron Ballman9371dd22014-03-14 18:34:04 +00002631 if (CI.isByRef())
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002632 fieldSize = CharUnits::fromQuantity(WordSizeInBytes);
2633 else
2634 fieldSize = CGM.getContext().getTypeSizeInChars(type);
Aaron Ballman9371dd22014-03-14 18:34:04 +00002635 UpdateRunSkipBlockVars(CI.isByRef(), getBlockCaptureLifetime(type, false),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002636 fieldOffset, fieldSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002637 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002638 return getBitmapBlockLayout(false);
2639}
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002640
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002641llvm::Constant *CGObjCCommonMac::BuildByrefLayout(CodeGen::CodeGenModule &CGM,
2642 QualType T) {
2643 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2644 assert(!T->isArrayType() && "__block array variable should not be caught");
2645 CharUnits fieldOffset;
2646 RunSkipBlockVars.clear();
2647 bool hasUnion = false;
2648 if (const RecordType *record = T->getAs<RecordType>()) {
2649 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion, true /*ByrefLayout */);
2650 llvm::Constant *Result = getBitmapBlockLayout(true);
Vedant Kumar2f5bb1152015-12-21 20:21:15 +00002651 if (isa<llvm::ConstantInt>(Result))
2652 Result = llvm::ConstantExpr::getIntToPtr(Result, CGM.Int8PtrTy);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002653 return Result;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002654 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002655 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2656 return nullPtr;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002657}
2658
John McCall882987f2013-02-28 19:01:20 +00002659llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00002660 const ObjCProtocolDecl *PD) {
Daniel Dunbar7050c552008-09-04 04:33:15 +00002661 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002662 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar7050c552008-09-04 04:33:15 +00002663 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2664
Owen Andersonade90fd2009-07-29 18:54:39 +00002665 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00002666 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002667}
2668
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002669void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stump18bb9282009-05-16 07:57:57 +00002670 // FIXME: We shouldn't need this, the protocol decl should contain enough
2671 // information to tell us whether this was a declaration or a definition.
Daniel Dunbarc475d422008-10-29 22:36:39 +00002672 DefinedProtocols.insert(PD->getIdentifier());
2673
2674 // If we have generated a forward reference to this protocol, emit
2675 // it now. Otherwise do nothing, the protocol objects are lazily
2676 // emitted.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002677 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbarc475d422008-10-29 22:36:39 +00002678 GetOrEmitProtocol(PD);
2679}
2680
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002681llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002682 if (DefinedProtocols.count(PD->getIdentifier()))
2683 return GetOrEmitProtocol(PD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002684
Daniel Dunbarc475d422008-10-29 22:36:39 +00002685 return GetOrEmitProtocolRef(PD);
2686}
2687
Douglas Gregor24ae22c2016-04-01 23:23:52 +00002688llvm::Value *CGObjCCommonMac::EmitClassRefViaRuntime(
2689 CodeGenFunction &CGF,
2690 const ObjCInterfaceDecl *ID,
2691 ObjCCommonTypesHelper &ObjCTypes) {
2692 llvm::Constant *lookUpClassFn = ObjCTypes.getLookUpClassFn();
2693
2694 llvm::Value *className =
2695 CGF.CGM.GetAddrOfConstantCString(ID->getObjCRuntimeNameAsString())
2696 .getPointer();
2697 ASTContext &ctx = CGF.CGM.getContext();
2698 className =
2699 CGF.Builder.CreateBitCast(className,
2700 CGF.ConvertType(
2701 ctx.getPointerType(ctx.CharTy.withConst())));
2702 llvm::CallInst *call = CGF.Builder.CreateCall(lookUpClassFn, className);
2703 call->setDoesNotThrow();
2704 return call;
2705}
2706
Daniel Dunbarb036db82008-08-13 03:21:16 +00002707/*
Rafael Espindolaf9e1e5e2014-02-20 14:09:04 +00002708// Objective-C 1.0 extensions
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002709struct _objc_protocol {
2710struct _objc_protocol_extension *isa;
2711char *protocol_name;
2712struct _objc_protocol_list *protocol_list;
2713struct _objc__method_prototype_list *instance_methods;
2714struct _objc__method_prototype_list *class_methods
2715};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002716
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002717See EmitProtocolExtension().
Daniel Dunbarb036db82008-08-13 03:21:16 +00002718*/
Daniel Dunbarc475d422008-10-29 22:36:39 +00002719llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00002720 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbarc475d422008-10-29 22:36:39 +00002721
2722 // Early exit if a defining object has already been generated.
2723 if (Entry && Entry->hasInitializer())
2724 return Entry;
2725
Douglas Gregora715bff2012-01-01 19:51:50 +00002726 // Use the protocol definition, if there is one.
2727 if (const ObjCProtocolDecl *Def = PD->getDefinition())
2728 PD = Def;
2729
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002730 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002731 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002732 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2733
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002734 // Construct method lists.
2735 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
2736 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002737 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002738 for (const auto *MD : PD->instance_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002739 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002740 if (!C)
2741 return GetOrEmitProtocolRef(PD);
2742
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002743 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2744 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002745 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002746 } else {
2747 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002748 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002749 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002750 }
2751
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002752 for (const auto *MD : PD->class_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002753 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002754 if (!C)
2755 return GetOrEmitProtocolRef(PD);
2756
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002757 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2758 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002759 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002760 } else {
2761 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002762 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002763 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002764 }
2765
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002766 MethodTypesExt.insert(MethodTypesExt.end(),
2767 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
2768
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002769 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002770 EmitProtocolExtension(PD, OptInstanceMethods, OptClassMethods,
2771 MethodTypesExt),
2772 GetClassName(PD->getObjCRuntimeNameAsString()),
2773 EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
2774 PD->protocol_begin(), PD->protocol_end()),
2775 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_" + PD->getName(),
2776 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2777 InstanceMethods),
2778 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_" + PD->getName(),
2779 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2780 ClassMethods)};
Owen Anderson0e0189d2009-07-27 22:29:56 +00002781 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00002782 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002783
Daniel Dunbarb036db82008-08-13 03:21:16 +00002784 if (Entry) {
Rafael Espindola5d117f32014-03-06 01:10:46 +00002785 // Already created, update the initializer.
Rafael Espindolab3262952014-05-09 00:43:37 +00002786 assert(Entry->hasPrivateLinkage());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002787 Entry->setInitializer(Init);
2788 } else {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002789 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2790 false, llvm::GlobalValue::PrivateLinkage,
2791 Init, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002792 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002793 // FIXME: Is this necessary? Why only for protocol?
2794 Entry->setAlignment(4);
John McCallf9582a72012-03-30 21:29:05 +00002795
2796 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002797 }
Rafael Espindola060062a2014-03-06 22:15:10 +00002798 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbarc475d422008-10-29 22:36:39 +00002799
2800 return Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002801}
2802
Daniel Dunbarc475d422008-10-29 22:36:39 +00002803llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002804 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
2805
2806 if (!Entry) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002807 // We use the initializer as a marker of whether this is a forward
2808 // reference or not. At module finalization we add the empty
2809 // contents for protocols which were referenced but never defined.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002810 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2811 false, llvm::GlobalValue::PrivateLinkage,
2812 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002813 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002814 // FIXME: Is this necessary? Why only for protocol?
2815 Entry->setAlignment(4);
2816 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002817
Daniel Dunbarb036db82008-08-13 03:21:16 +00002818 return Entry;
2819}
2820
2821/*
2822 struct _objc_protocol_extension {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002823 uint32_t size;
2824 struct objc_method_description_list *optional_instance_methods;
2825 struct objc_method_description_list *optional_class_methods;
2826 struct objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002827 const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00002828 struct objc_property_list *class_properties;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002829 };
2830*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002831llvm::Constant *
2832CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002833 ArrayRef<llvm::Constant*> OptInstanceMethods,
2834 ArrayRef<llvm::Constant*> OptClassMethods,
2835 ArrayRef<llvm::Constant*> MethodTypesExt) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002836 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00002837 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002838 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002839 llvm::ConstantInt::get(ObjCTypes.IntTy, Size),
2840 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_OPT_" + PD->getName(),
2841 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2842 OptInstanceMethods),
2843 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_OPT_" + PD->getName(),
2844 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2845 OptClassMethods),
2846 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
Manman Renad0e7912016-01-29 19:22:54 +00002847 ObjCTypes, false),
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002848 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
Manman Rence7bff52016-01-29 23:46:55 +00002849 MethodTypesExt, ObjCTypes),
2850 EmitPropertyList("OBJC_$_CLASS_PROP_PROTO_LIST_" + PD->getName(), nullptr,
2851 PD, ObjCTypes, true)};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002852
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002853 // Return null if no extension bits are used.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002854 if (Values[1]->isNullValue() && Values[2]->isNullValue() &&
Manman Rence7bff52016-01-29 23:46:55 +00002855 Values[3]->isNullValue() && Values[4]->isNullValue() &&
2856 Values[5]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00002857 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002858
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002859 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00002860 llvm::ConstantStruct::get(ObjCTypes.ProtocolExtensionTy, Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002861
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002862 // No special section, but goes in llvm.used
Alp Toker541d5072014-06-07 23:30:53 +00002863 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00002864 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002865}
2866
2867/*
2868 struct objc_protocol_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002869 struct objc_protocol_list *next;
2870 long count;
2871 Protocol *list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00002872 };
2873*/
Daniel Dunbardec75f82008-08-21 21:57:41 +00002874llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002875CGObjCMac::EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00002876 ObjCProtocolDecl::protocol_iterator begin,
2877 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002878 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002879
Daniel Dunbardec75f82008-08-21 21:57:41 +00002880 for (; begin != end; ++begin)
2881 ProtocolRefs.push_back(GetProtocolRef(*begin));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002882
2883 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002884 if (ProtocolRefs.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002885 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002886
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002887 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00002888 ProtocolRefs.push_back(llvm::Constant::getNullValue(ObjCTypes.ProtocolPtrTy));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002889
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002890 llvm::Constant *Values[3];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002891 // This field is only used by the runtime.
Owen Anderson0b75f232009-07-31 20:28:54 +00002892 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002893 Values[1] = llvm::ConstantInt::get(ObjCTypes.LongTy,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002894 ProtocolRefs.size() - 1);
2895 Values[2] =
2896 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolPtrTy,
2897 ProtocolRefs.size()),
Daniel Dunbarb036db82008-08-13 03:21:16 +00002898 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002899
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002900 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002901 llvm::GlobalVariable *GV =
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002902 CreateMetadataVar(Name, Init, "__OBJC,__cat_cls_meth,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00002903 CGM.getPointerAlign(), false);
Owen Andersonade90fd2009-07-29 18:54:39 +00002904 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002905}
2906
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002907void CGObjCCommonMac::
2908PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002909 SmallVectorImpl<llvm::Constant *> &Properties,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002910 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +00002911 const ObjCProtocolDecl *Proto,
Manman Renad0e7912016-01-29 19:22:54 +00002912 const ObjCCommonTypesHelper &ObjCTypes,
2913 bool IsClassProperty) {
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00002914 for (const auto *P : Proto->protocols())
Manman Renad0e7912016-01-29 19:22:54 +00002915 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2916 IsClassProperty);
2917
2918 for (const auto *PD : Proto->properties()) {
2919 if (IsClassProperty != PD->isClassProperty())
2920 continue;
David Blaikie82e95a32014-11-19 07:49:47 +00002921 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002922 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002923 llvm::Constant *Prop[] = {
2924 GetPropertyName(PD->getIdentifier()),
2925 GetPropertyTypeString(PD, Container)
2926 };
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002927 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2928 }
2929}
2930
Daniel Dunbarb036db82008-08-13 03:21:16 +00002931/*
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002932 struct _objc_property {
Bill Wendlinga515b582012-02-09 22:16:49 +00002933 const char * const name;
2934 const char * const attributes;
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002935 };
2936
2937 struct _objc_property_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002938 uint32_t entsize; // sizeof (struct _objc_property)
2939 uint32_t prop_count;
2940 struct _objc_property[prop_count];
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002941 };
2942*/
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002943llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002944 const Decl *Container,
2945 const ObjCContainerDecl *OCD,
Manman Renad0e7912016-01-29 19:22:54 +00002946 const ObjCCommonTypesHelper &ObjCTypes,
2947 bool IsClassProperty) {
Manman Ren01b705e2016-04-19 19:05:03 +00002948 if (IsClassProperty) {
2949 // Make this entry NULL for OS X with deployment target < 10.11, for iOS
2950 // with deployment target < 9.0.
2951 const llvm::Triple &Triple = CGM.getTarget().getTriple();
2952 if ((Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 11)) ||
2953 (Triple.isiOS() && Triple.isOSVersionLT(9)))
2954 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
2955 }
2956
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002957 SmallVector<llvm::Constant *, 16> Properties;
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002958 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weber08c93332015-12-03 17:44:51 +00002959
2960 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2961 llvm::Constant *Prop[] = {GetPropertyName(PD->getIdentifier()),
2962 GetPropertyTypeString(PD, Container)};
2963 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2964 };
2965 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
2966 for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
Manman Renad0e7912016-01-29 19:22:54 +00002967 for (auto *PD : ClassExt->properties()) {
2968 if (IsClassProperty != PD->isClassProperty())
2969 continue;
Nico Weber08c93332015-12-03 17:44:51 +00002970 PropertySet.insert(PD->getIdentifier());
2971 AddProperty(PD);
2972 }
Manman Renad0e7912016-01-29 19:22:54 +00002973
2974 for (const auto *PD : OCD->properties()) {
2975 if (IsClassProperty != PD->isClassProperty())
2976 continue;
Nico Weber08c93332015-12-03 17:44:51 +00002977 // Don't emit duplicate metadata for properties that were already in a
2978 // class extension.
2979 if (!PropertySet.insert(PD->getIdentifier()).second)
2980 continue;
2981 AddProperty(PD);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002982 }
Nico Weber08c93332015-12-03 17:44:51 +00002983
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002984 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Aaron Ballmana9f49e32014-03-13 20:55:22 +00002985 for (const auto *P : OID->all_referenced_protocols())
Manman Renad0e7912016-01-29 19:22:54 +00002986 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2987 IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002988 }
2989 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Aaron Ballman19a41762014-03-14 12:55:57 +00002990 for (const auto *P : CD->protocols())
Manman Renad0e7912016-01-29 19:22:54 +00002991 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2992 IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002993 }
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002994
2995 // Return null for empty list.
2996 if (Properties.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002997 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002998
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002999 unsigned PropertySize =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003000 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003001 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003002 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, PropertySize);
3003 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Properties.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003004 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.PropertyTy,
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003005 Properties.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003006 Values[2] = llvm::ConstantArray::get(AT, Properties);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003007 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003008
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003009 llvm::GlobalVariable *GV =
3010 CreateMetadataVar(Name, Init,
3011 (ObjCABI == 2) ? "__DATA, __objc_const" :
Daniel Dunbarb25452a2009-04-15 02:56:18 +00003012 "__OBJC,__property,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00003013 CGM.getPointerAlign(),
Daniel Dunbarb25452a2009-04-15 02:56:18 +00003014 true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003015 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003016}
3017
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003018llvm::Constant *
3019CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
3020 ArrayRef<llvm::Constant*> MethodTypes,
3021 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003022 // Return null for empty list.
3023 if (MethodTypes.empty())
3024 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
3025
3026 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
3027 MethodTypes.size());
3028 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
3029
Alp Toker541d5072014-06-07 23:30:53 +00003030 llvm::GlobalVariable *GV = CreateMetadataVar(
3031 Name, Init, (ObjCABI == 2) ? "__DATA, __objc_const" : StringRef(),
John McCall7f416cc2015-09-08 08:05:57 +00003032 CGM.getPointerAlign(), true);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003033 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
3034}
3035
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003036/*
Daniel Dunbarb036db82008-08-13 03:21:16 +00003037 struct objc_method_description_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003038 int count;
3039 struct objc_method_description list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00003040 };
3041*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003042llvm::Constant *
3043CGObjCMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003044 llvm::Constant *Desc[] = {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003045 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003046 ObjCTypes.SelectorPtrTy),
3047 GetMethodVarType(MD)
3048 };
Douglas Gregora9d84932011-05-27 01:19:52 +00003049 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00003050 return nullptr;
3051
Owen Anderson0e0189d2009-07-27 22:29:56 +00003052 return llvm::ConstantStruct::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003053 Desc);
3054}
Daniel Dunbarb036db82008-08-13 03:21:16 +00003055
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003056llvm::Constant *
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00003057CGObjCMac::EmitMethodDescList(Twine Name, StringRef Section,
3058 ArrayRef<llvm::Constant *> Methods) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00003059 // Return null for empty list.
3060 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003061 return llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003062
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003063 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003064 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003065 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003066 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003067 Values[1] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003068 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003069
John McCall7f416cc2015-09-08 08:05:57 +00003070 llvm::GlobalVariable *GV =
3071 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003072 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003073 ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003074}
3075
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003076/*
3077 struct _objc_category {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003078 char *category_name;
3079 char *class_name;
3080 struct _objc_method_list *instance_methods;
3081 struct _objc_method_list *class_methods;
3082 struct _objc_protocol_list *protocols;
3083 uint32_t size; // <rdar://4585769>
3084 struct _objc_property_list *instance_properties;
Manman Ren96df0b32016-01-29 23:45:01 +00003085 struct _objc_property_list *class_properties;
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003086 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003087*/
Daniel Dunbar92992502008-08-15 22:20:32 +00003088void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00003089 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003090
Mike Stump18bb9282009-05-16 07:57:57 +00003091 // FIXME: This is poor design, the OCD should have a pointer to the category
3092 // decl. Additionally, note that Category can be null for the @implementation
3093 // w/o an @interface case. Sema should just create one for us as it does for
3094 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003095 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003096 const ObjCCategoryDecl *Category =
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003097 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003098
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003099 SmallString<256> ExtName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003100 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3101 << OCD->getName();
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003102
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003103 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003104 for (const auto *I : OCD->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003105 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003106 InstanceMethods.push_back(GetMethodConstant(I));
3107
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003108 for (const auto *I : OCD->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003109 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003110 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003111
Manman Ren96df0b32016-01-29 23:45:01 +00003112 llvm::Constant *Values[8];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003113 Values[0] = GetClassName(OCD->getName());
3114 Values[1] = GetClassName(Interface->getObjCRuntimeNameAsString());
Fariborz Jahaniane55f8662009-04-29 20:40:05 +00003115 LazySymbols.insert(Interface->getIdentifier());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003116 Values[2] = EmitMethodList("OBJC_CATEGORY_INSTANCE_METHODS_" + ExtName.str(),
3117 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
3118 InstanceMethods);
3119 Values[3] = EmitMethodList("OBJC_CATEGORY_CLASS_METHODS_" + ExtName.str(),
3120 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
3121 ClassMethods);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003122 if (Category) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003123 Values[4] =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003124 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
3125 Category->protocol_begin(), Category->protocol_end());
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003126 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003127 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003128 }
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003129 Values[5] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003130
3131 // If there is no category @interface then there can be no properties.
3132 if (Category) {
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003133 Values[6] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Manman Renad0e7912016-01-29 19:22:54 +00003134 OCD, Category, ObjCTypes, false);
Manman Ren96df0b32016-01-29 23:45:01 +00003135 Values[7] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
3136 OCD, Category, ObjCTypes, true);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003137 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003138 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Manman Ren96df0b32016-01-29 23:45:01 +00003139 Values[7] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003140 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003141
Owen Anderson0e0189d2009-07-27 22:29:56 +00003142 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.CategoryTy,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003143 Values);
3144
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003145 llvm::GlobalVariable *GV =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003146 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003147 "__OBJC,__category,regular,no_dead_strip",
3148 CGM.getPointerAlign(), true);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003149 DefinedCategories.push_back(GV);
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00003150 DefinedCategoryNames.insert(ExtName.str());
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003151 // method definition entries must be clear for next implementation.
3152 MethodDefinitions.clear();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003153}
3154
John McCallef19dbb2012-10-17 04:53:23 +00003155enum FragileClassFlags {
John McCall460ce582015-10-22 18:38:17 +00003156 /// Apparently: is not a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003157 FragileABI_Class_Factory = 0x00001,
John McCall460ce582015-10-22 18:38:17 +00003158
3159 /// Is a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003160 FragileABI_Class_Meta = 0x00002,
John McCall460ce582015-10-22 18:38:17 +00003161
3162 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003163 FragileABI_Class_HasCXXStructors = 0x02000,
John McCall460ce582015-10-22 18:38:17 +00003164
3165 /// Has hidden visibility.
John McCall09ec1ec2015-10-21 22:06:03 +00003166 FragileABI_Class_Hidden = 0x20000,
John McCall460ce582015-10-22 18:38:17 +00003167
3168 /// Class implementation was compiled under ARC.
3169 FragileABI_Class_CompiledByARC = 0x04000000,
3170
3171 /// Class implementation was compiled under MRC and has MRC weak ivars.
3172 /// Exclusive with CompiledByARC.
3173 FragileABI_Class_HasMRCWeakIvars = 0x08000000,
John McCallef19dbb2012-10-17 04:53:23 +00003174};
3175
3176enum NonFragileClassFlags {
3177 /// Is a meta-class.
3178 NonFragileABI_Class_Meta = 0x00001,
3179
3180 /// Is a root class.
3181 NonFragileABI_Class_Root = 0x00002,
3182
John McCall460ce582015-10-22 18:38:17 +00003183 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003184 NonFragileABI_Class_HasCXXStructors = 0x00004,
3185
3186 /// Has hidden visibility.
3187 NonFragileABI_Class_Hidden = 0x00010,
3188
3189 /// Has the exception attribute.
3190 NonFragileABI_Class_Exception = 0x00020,
3191
3192 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3193 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3194
3195 /// Class implementation was compiled under ARC.
John McCall0d54a172012-10-17 04:53:31 +00003196 NonFragileABI_Class_CompiledByARC = 0x00080,
3197
3198 /// Class has non-trivial destructors, but zero-initialization is okay.
John McCall460ce582015-10-22 18:38:17 +00003199 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100,
3200
3201 /// Class implementation was compiled under MRC and has MRC weak ivars.
3202 /// Exclusive with CompiledByARC.
3203 NonFragileABI_Class_HasMRCWeakIvars = 0x00200,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003204};
3205
John McCall460ce582015-10-22 18:38:17 +00003206static bool hasWeakMember(QualType type) {
3207 if (type.getObjCLifetime() == Qualifiers::OCL_Weak) {
3208 return true;
3209 }
3210
3211 if (auto recType = type->getAs<RecordType>()) {
3212 for (auto field : recType->getDecl()->fields()) {
3213 if (hasWeakMember(field->getType()))
3214 return true;
3215 }
3216 }
3217
3218 return false;
3219}
3220
3221/// For compatibility, we only want to set the "HasMRCWeakIvars" flag
3222/// (and actually fill in a layout string) if we really do have any
3223/// __weak ivars.
3224static bool hasMRCWeakIvars(CodeGenModule &CGM,
3225 const ObjCImplementationDecl *ID) {
3226 if (!CGM.getLangOpts().ObjCWeak) return false;
3227 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
3228
3229 for (const ObjCIvarDecl *ivar =
3230 ID->getClassInterface()->all_declared_ivar_begin();
3231 ivar; ivar = ivar->getNextIvar()) {
3232 if (hasWeakMember(ivar->getType()))
3233 return true;
3234 }
3235
3236 return false;
3237}
3238
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003239/*
3240 struct _objc_class {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003241 Class isa;
3242 Class super_class;
3243 const char *name;
3244 long version;
3245 long info;
3246 long instance_size;
3247 struct _objc_ivar_list *ivars;
3248 struct _objc_method_list *methods;
3249 struct _objc_cache *cache;
3250 struct _objc_protocol_list *protocols;
3251 // Objective-C 1.0 extensions (<rdr://4585769>)
3252 const char *ivar_layout;
3253 struct _objc_class_ext *ext;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003254 };
3255
3256 See EmitClassExtension();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003257*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003258void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003259 DefinedSymbols.insert(ID->getIdentifier());
3260
Chris Lattner86d7d912008-11-24 03:54:41 +00003261 std::string ClassName = ID->getNameAsString();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003262 // FIXME: Gross
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003263 ObjCInterfaceDecl *Interface =
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003264 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003265 llvm::Constant *Protocols =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003266 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3267 Interface->all_referenced_protocol_begin(),
3268 Interface->all_referenced_protocol_end());
John McCallef19dbb2012-10-17 04:53:23 +00003269 unsigned Flags = FragileABI_Class_Factory;
John McCall0d54a172012-10-17 04:53:31 +00003270 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCallef19dbb2012-10-17 04:53:23 +00003271 Flags |= FragileABI_Class_HasCXXStructors;
John McCall09ec1ec2015-10-21 22:06:03 +00003272
John McCall460ce582015-10-22 18:38:17 +00003273 bool hasMRCWeak = false;
3274
John McCall09ec1ec2015-10-21 22:06:03 +00003275 if (CGM.getLangOpts().ObjCAutoRefCount)
3276 Flags |= FragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00003277 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
3278 Flags |= FragileABI_Class_HasMRCWeakIvars;
John McCall09ec1ec2015-10-21 22:06:03 +00003279
John McCall3fd13f062015-10-21 18:06:47 +00003280 CharUnits Size =
3281 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003282
3283 // FIXME: Set CXX-structors flag.
John McCall457a04e2010-10-22 21:05:15 +00003284 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003285 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003286
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003287 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003288 for (const auto *I : ID->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003289 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003290 InstanceMethods.push_back(GetMethodConstant(I));
3291
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003292 for (const auto *I : ID->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003293 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003294 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003295
Aaron Ballmand85eff42014-03-14 15:02:45 +00003296 for (const auto *PID : ID->property_impls()) {
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003297 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3298 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3299
3300 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
3301 if (llvm::Constant *C = GetMethodConstant(MD))
3302 InstanceMethods.push_back(C);
3303 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
3304 if (llvm::Constant *C = GetMethodConstant(MD))
3305 InstanceMethods.push_back(C);
3306 }
3307 }
3308
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003309 llvm::Constant *Values[12];
Daniel Dunbarccf61832009-05-03 08:56:52 +00003310 Values[ 0] = EmitMetaClass(ID, Protocols, ClassMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003311 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003312 // Record a reference to the super class.
3313 LazySymbols.insert(Super->getIdentifier());
3314
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003315 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003316 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003317 ObjCTypes.ClassPtrTy);
3318 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003319 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003320 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003321 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003322 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003323 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3324 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
John McCall3fd13f062015-10-21 18:06:47 +00003325 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size.getQuantity());
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003326 Values[ 6] = EmitIvarList(ID, false);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003327 Values[7] = EmitMethodList("OBJC_INSTANCE_METHODS_" + ID->getName(),
3328 "__OBJC,__inst_meth,regular,no_dead_strip",
3329 InstanceMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003330 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003331 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003332 Values[ 9] = Protocols;
John McCall460ce582015-10-22 18:38:17 +00003333 Values[10] = BuildStrongIvarLayout(ID, CharUnits::Zero(), Size);
Manman Renad0e7912016-01-29 19:22:54 +00003334 Values[11] = EmitClassExtension(ID, Size, hasMRCWeak,
3335 false/*isClassProperty*/);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003336 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003337 Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003338 std::string Name("OBJC_CLASS_");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003339 Name += ClassName;
3340 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3341 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003342 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003343 if (GV) {
3344 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3345 "Forward metaclass reference has incorrect type.");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003346 GV->setInitializer(Init);
3347 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003348 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00003349 CGM.addCompilerUsedGlobal(GV);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003350 } else
John McCall7f416cc2015-09-08 08:05:57 +00003351 GV = CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003352 DefinedClasses.push_back(GV);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00003353 ImplementedClasses.push_back(Interface);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003354 // method definition entries must be clear for next implementation.
3355 MethodDefinitions.clear();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003356}
3357
3358llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3359 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003360 ArrayRef<llvm::Constant*> Methods) {
John McCallef19dbb2012-10-17 04:53:23 +00003361 unsigned Flags = FragileABI_Class_Meta;
Micah Villmowdd31ca12012-10-08 16:25:52 +00003362 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003363
John McCall457a04e2010-10-22 21:05:15 +00003364 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003365 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003366
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003367 llvm::Constant *Values[12];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003368 // The isa for the metaclass is the root of the hierarchy.
3369 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3370 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3371 Root = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003372 Values[ 0] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003373 llvm::ConstantExpr::getBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003374 ObjCTypes.ClassPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003375 // The super class for the metaclass is emitted as the name of the
3376 // super class. The runtime fixes this up to point to the
3377 // *metaclass* for the super class.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003378 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003379 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003380 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003381 ObjCTypes.ClassPtrTy);
3382 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003383 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003384 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003385 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003386 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003387 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3388 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
3389 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size);
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003390 Values[ 6] = EmitIvarList(ID, true);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003391 Values[7] =
3392 EmitMethodList("OBJC_CLASS_METHODS_" + ID->getNameAsString(),
3393 "__OBJC,__cls_meth,regular,no_dead_strip", Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003394 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003395 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003396 Values[ 9] = Protocols;
3397 // ivar_layout for metaclass is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003398 Values[10] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Manman Renad0e7912016-01-29 19:22:54 +00003399 // The class extension is used to store class properties for metaclasses.
3400 Values[11] = EmitClassExtension(ID, CharUnits::Zero(), false/*hasMRCWeak*/,
3401 true/*isClassProperty*/);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003402 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003403 Values);
3404
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003405 std::string Name("OBJC_METACLASS_");
Benjamin Kramer1bbcbd02012-07-31 11:45:39 +00003406 Name += ID->getName();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003407
3408 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003409 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003410 if (GV) {
3411 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3412 "Forward metaclass reference has incorrect type.");
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003413 GV->setInitializer(Init);
3414 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00003415 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003416 llvm::GlobalValue::PrivateLinkage,
Owen Andersonc10c8d32009-07-08 19:05:04 +00003417 Init, Name);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003418 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003419 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Daniel Dunbarae333842009-03-09 22:18:41 +00003420 GV->setAlignment(4);
Rafael Espindola060062a2014-03-06 22:15:10 +00003421 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003422
3423 return GV;
3424}
3425
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003426llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003427 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003428
Mike Stump18bb9282009-05-16 07:57:57 +00003429 // FIXME: Should we look these up somewhere other than the module. Its a bit
3430 // silly since we only generate these while processing an implementation, so
3431 // exactly one pointer would work if know when we entered/exitted an
3432 // implementation block.
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003433
3434 // Check for an existing forward reference.
Fariborz Jahanian475831b2009-01-07 20:11:22 +00003435 // Previously, metaclass with internal linkage may have been defined.
3436 // pass 'true' as 2nd argument so it is returned.
Rafael Espindola21039aa2014-02-27 16:26:32 +00003437 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3438 if (!GV)
3439 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003440 llvm::GlobalValue::PrivateLinkage, nullptr,
3441 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003442
3443 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3444 "Forward metaclass reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003445 return GV;
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003446}
3447
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003448llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003449 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Rafael Espindola21039aa2014-02-27 16:26:32 +00003450 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3451
3452 if (!GV)
3453 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003454 llvm::GlobalValue::PrivateLinkage, nullptr,
3455 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003456
3457 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3458 "Forward class metadata reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003459 return GV;
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003460}
3461
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003462/*
John McCall3fd13f062015-10-21 18:06:47 +00003463 Emit a "class extension", which in this specific context means extra
3464 data that doesn't fit in the normal fragile-ABI class structure, and
3465 has nothing to do with the language concept of a class extension.
3466
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003467 struct objc_class_ext {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003468 uint32_t size;
3469 const char *weak_ivar_layout;
3470 struct _objc_property_list *properties;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003471 };
3472*/
3473llvm::Constant *
John McCall3fd13f062015-10-21 18:06:47 +00003474CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
Manman Renad0e7912016-01-29 19:22:54 +00003475 CharUnits InstanceSize, bool hasMRCWeakIvars,
3476 bool isClassProperty) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003477 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003478 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003479
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003480 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003481 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Manman Ren92e0a712016-02-21 05:31:05 +00003482 if (isClassProperty) {
3483 llvm::Type *PtrTy = CGM.Int8PtrTy;
3484 Values[1] = llvm::Constant::getNullValue(PtrTy);
3485 } else
Manman Renad0e7912016-01-29 19:22:54 +00003486 Values[1] = BuildWeakIvarLayout(ID, CharUnits::Zero(), InstanceSize,
3487 hasMRCWeakIvars);
3488 if (isClassProperty)
3489 Values[2] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getName(),
3490 ID, ID->getClassInterface(), ObjCTypes, true);
3491 else
3492 Values[2] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getName(),
3493 ID, ID->getClassInterface(), ObjCTypes, false);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003494
3495 // Return null if no extension bits are used.
Manman Renad0e7912016-01-29 19:22:54 +00003496 if ((!Values[1] || Values[1]->isNullValue()) && Values[2]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00003497 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003498
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003499 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00003500 llvm::ConstantStruct::get(ObjCTypes.ClassExtensionTy, Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003501 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003502 "__OBJC,__class_ext,regular,no_dead_strip",
3503 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003504}
3505
3506/*
3507 struct objc_ivar {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003508 char *ivar_name;
3509 char *ivar_type;
3510 int ivar_offset;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003511 };
3512
3513 struct objc_ivar_list {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003514 int ivar_count;
3515 struct objc_ivar list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003516 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003517*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003518llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003519 bool ForClass) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003520 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003521
3522 // When emitting the root class GCC emits ivar entries for the
3523 // actual class structure. It is not clear if we need to follow this
3524 // behavior; for now lets try and get away with not doing it. If so,
3525 // the cleanest solution would be to make up an ObjCInterfaceDecl
3526 // for the class.
3527 if (ForClass)
Owen Anderson0b75f232009-07-31 20:28:54 +00003528 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003529
Jordy Rosea91768e2011-07-22 02:08:32 +00003530 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003531
Jordy Rosea91768e2011-07-22 02:08:32 +00003532 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00003533 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00003534 // Ignore unnamed bit-fields.
3535 if (!IVD->getDeclName())
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003536 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003537 llvm::Constant *Ivar[] = {
3538 GetMethodVarName(IVD->getIdentifier()),
3539 GetMethodVarType(IVD),
3540 llvm::ConstantInt::get(ObjCTypes.IntTy,
Eli Friedman8cbca202012-11-06 22:15:52 +00003541 ComputeIvarBaseOffset(CGM, OID, IVD))
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003542 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003543 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarTy, Ivar));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003544 }
3545
3546 // Return null for empty list.
3547 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003548 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003549
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003550 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003551 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003552 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003553 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003554 Values[1] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003555 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003556
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003557 llvm::GlobalVariable *GV;
3558 if (ForClass)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003559 GV =
3560 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003561 "__OBJC,__class_vars,regular,no_dead_strip",
3562 CGM.getPointerAlign(), true);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003563 else
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003564 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003565 "__OBJC,__instance_vars,regular,no_dead_strip",
3566 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003567 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003568}
3569
3570/*
3571 struct objc_method {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003572 SEL method_name;
3573 char *method_types;
3574 void *method;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003575 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003576
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003577 struct objc_method_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003578 struct objc_method_list *obsolete;
3579 int count;
3580 struct objc_method methods_list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003581 };
3582*/
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003583
3584/// GetMethodConstant - Return a struct objc_method constant for the
3585/// given method if it has been defined. The result is null if the
3586/// method has not been defined. The return value has type MethodPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003587llvm::Constant *CGObjCMac::GetMethodConstant(const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00003588 llvm::Function *Fn = GetMethodDefinition(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003589 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00003590 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003591
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003592 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00003593 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003594 ObjCTypes.SelectorPtrTy),
3595 GetMethodVarType(MD),
3596 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
3597 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003598 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003599}
3600
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00003601llvm::Constant *CGObjCMac::EmitMethodList(Twine Name, StringRef Section,
3602 ArrayRef<llvm::Constant *> Methods) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003603 // Return null for empty list.
3604 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003605 return llvm::Constant::getNullValue(ObjCTypes.MethodListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003606
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003607 llvm::Constant *Values[3];
Owen Anderson0b75f232009-07-31 20:28:54 +00003608 Values[0] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003609 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003610 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003611 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003612 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003613 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003614
John McCall7f416cc2015-09-08 08:05:57 +00003615 llvm::GlobalVariable *GV =
3616 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003617 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003618}
3619
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00003620llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003621 const ObjCContainerDecl *CD) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003622 SmallString<256> Name;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003623 GetNameForMethod(OMD, CD, Name);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003624
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003625 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003626 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003627 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003628 llvm::Function *Method =
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00003629 llvm::Function::Create(MethodTy,
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003630 llvm::GlobalValue::InternalLinkage,
Daniel Dunbard2386812009-10-19 01:21:19 +00003631 Name.str(),
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003632 &CGM.getModule());
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003633 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003634
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003635 return Method;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003636}
3637
Alp Toker541d5072014-06-07 23:30:53 +00003638llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
3639 llvm::Constant *Init,
3640 StringRef Section,
John McCall7f416cc2015-09-08 08:05:57 +00003641 CharUnits Align,
Alp Toker541d5072014-06-07 23:30:53 +00003642 bool AddToUsed) {
Chris Lattner2192fe52011-07-18 04:24:23 +00003643 llvm::Type *Ty = Init->getType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003644 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00003645 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003646 llvm::GlobalValue::PrivateLinkage, Init, Name);
Alp Toker541d5072014-06-07 23:30:53 +00003647 if (!Section.empty())
Daniel Dunbar30c65362009-03-09 20:09:19 +00003648 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003649 GV->setAlignment(Align.getQuantity());
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00003650 if (AddToUsed)
Rafael Espindola060062a2014-03-06 22:15:10 +00003651 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar30c65362009-03-09 20:09:19 +00003652 return GV;
3653}
3654
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003655llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00003656 // Abuse this interface function as a place to finalize.
3657 FinishModule();
Craig Topper8a13c412014-05-21 05:09:00 +00003658 return nullptr;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003659}
3660
Chris Lattnerd4808922009-03-22 21:03:39 +00003661llvm::Constant *CGObjCMac::GetPropertyGetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003662 return ObjCTypes.getGetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003663}
3664
Chris Lattnerd4808922009-03-22 21:03:39 +00003665llvm::Constant *CGObjCMac::GetPropertySetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003666 return ObjCTypes.getSetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003667}
3668
Ted Kremeneke65b0862012-03-06 20:05:56 +00003669llvm::Constant *CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
3670 bool copy) {
3671 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
3672}
3673
David Chisnall168b80f2010-12-26 22:13:16 +00003674llvm::Constant *CGObjCMac::GetGetStructFunction() {
3675 return ObjCTypes.getCopyStructFn();
3676}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003677
David Chisnall168b80f2010-12-26 22:13:16 +00003678llvm::Constant *CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003679 return ObjCTypes.getCopyStructFn();
3680}
3681
David Chisnall0d75e062012-12-17 18:54:24 +00003682llvm::Constant *CGObjCMac::GetCppAtomicObjectGetFunction() {
3683 return ObjCTypes.getCppAtomicObjectFunction();
3684}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003685
David Chisnall0d75e062012-12-17 18:54:24 +00003686llvm::Constant *CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00003687 return ObjCTypes.getCppAtomicObjectFunction();
3688}
3689
Chris Lattnerd4808922009-03-22 21:03:39 +00003690llvm::Constant *CGObjCMac::EnumerationMutationFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003691 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson3f35a262008-08-31 04:05:03 +00003692}
3693
John McCallbd309292010-07-06 01:34:17 +00003694void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
3695 return EmitTryOrSynchronizedStmt(CGF, S);
3696}
3697
3698void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
3699 const ObjCAtSynchronizedStmt &S) {
3700 return EmitTryOrSynchronizedStmt(CGF, S);
3701}
3702
John McCall65bea082010-07-21 06:59:36 +00003703namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00003704 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCall65bea082010-07-21 06:59:36 +00003705 const Stmt &S;
John McCall7f416cc2015-09-08 08:05:57 +00003706 Address SyncArgSlot;
3707 Address CallTryExitVar;
3708 Address ExceptionData;
John McCall65bea082010-07-21 06:59:36 +00003709 ObjCTypesHelper &ObjCTypes;
3710 PerformFragileFinally(const Stmt *S,
John McCall7f416cc2015-09-08 08:05:57 +00003711 Address SyncArgSlot,
3712 Address CallTryExitVar,
3713 Address ExceptionData,
John McCall65bea082010-07-21 06:59:36 +00003714 ObjCTypesHelper *ObjCTypes)
John McCall2dd7d442010-08-04 05:59:32 +00003715 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCall65bea082010-07-21 06:59:36 +00003716 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
3717
Craig Topper4f12f102014-03-12 06:41:41 +00003718 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall65bea082010-07-21 06:59:36 +00003719 // Check whether we need to call objc_exception_try_exit.
3720 // In optimized code, this branch will always be folded.
3721 llvm::BasicBlock *FinallyCallExit =
3722 CGF.createBasicBlock("finally.call_exit");
3723 llvm::BasicBlock *FinallyNoCallExit =
3724 CGF.createBasicBlock("finally.no_call_exit");
3725 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
3726 FinallyCallExit, FinallyNoCallExit);
3727
3728 CGF.EmitBlock(FinallyCallExit);
John McCall882987f2013-02-28 19:01:20 +00003729 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
John McCall7f416cc2015-09-08 08:05:57 +00003730 ExceptionData.getPointer());
John McCall65bea082010-07-21 06:59:36 +00003731
3732 CGF.EmitBlock(FinallyNoCallExit);
3733
3734 if (isa<ObjCAtTryStmt>(S)) {
3735 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCallcebe0ca2010-08-11 00:16:14 +00003736 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall638d4f52013-04-03 00:56:07 +00003737 // Don't try to do the @finally if this is an EH cleanup.
3738 if (flags.isForEHCleanup()) return;
3739
John McCallcebe0ca2010-08-11 00:16:14 +00003740 // Save the current cleanup destination in case there's
3741 // control flow inside the finally statement.
3742 llvm::Value *CurCleanupDest =
3743 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
3744
John McCall65bea082010-07-21 06:59:36 +00003745 CGF.EmitStmt(FinallyStmt->getFinallyBody());
3746
John McCallcebe0ca2010-08-11 00:16:14 +00003747 if (CGF.HaveInsertPoint()) {
3748 CGF.Builder.CreateStore(CurCleanupDest,
3749 CGF.getNormalCleanupDestSlot());
3750 } else {
3751 // Currently, the end of the cleanup must always exist.
3752 CGF.EnsureInsertPoint();
3753 }
3754 }
John McCall65bea082010-07-21 06:59:36 +00003755 } else {
3756 // Emit objc_sync_exit(expr); as finally's sole statement for
3757 // @synchronized.
John McCall2dd7d442010-08-04 05:59:32 +00003758 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCall882987f2013-02-28 19:01:20 +00003759 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCall65bea082010-07-21 06:59:36 +00003760 }
3761 }
3762 };
John McCall42227ed2010-07-31 23:20:56 +00003763
3764 class FragileHazards {
3765 CodeGenFunction &CGF;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003766 SmallVector<llvm::Value*, 20> Locals;
John McCall42227ed2010-07-31 23:20:56 +00003767 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
3768
3769 llvm::InlineAsm *ReadHazard;
3770 llvm::InlineAsm *WriteHazard;
3771
3772 llvm::FunctionType *GetAsmFnType();
3773
3774 void collectLocals();
3775 void emitReadHazard(CGBuilderTy &Builder);
3776
3777 public:
3778 FragileHazards(CodeGenFunction &CGF);
John McCall2dd7d442010-08-04 05:59:32 +00003779
John McCall42227ed2010-07-31 23:20:56 +00003780 void emitWriteHazard();
John McCall2dd7d442010-08-04 05:59:32 +00003781 void emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00003782 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003783} // end anonymous namespace
John McCall42227ed2010-07-31 23:20:56 +00003784
3785/// Create the fragile-ABI read and write hazards based on the current
3786/// state of the function, which is presumed to be immediately prior
3787/// to a @try block. These hazards are used to maintain correct
3788/// semantics in the face of optimization and the fragile ABI's
3789/// cavalier use of setjmp/longjmp.
3790FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
3791 collectLocals();
3792
3793 if (Locals.empty()) return;
3794
3795 // Collect all the blocks in the function.
3796 for (llvm::Function::iterator
3797 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
3798 BlocksBeforeTry.insert(&*I);
3799
3800 llvm::FunctionType *AsmFnTy = GetAsmFnType();
3801
3802 // Create a read hazard for the allocas. This inhibits dead-store
3803 // optimizations and forces the values to memory. This hazard is
3804 // inserted before any 'throwing' calls in the protected scope to
3805 // reflect the possibility that the variables might be read from the
3806 // catch block if the call throws.
3807 {
3808 std::string Constraint;
3809 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3810 if (I) Constraint += ',';
3811 Constraint += "*m";
3812 }
3813
3814 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3815 }
3816
3817 // Create a write hazard for the allocas. This inhibits folding
3818 // loads across the hazard. This hazard is inserted at the
3819 // beginning of the catch path to reflect the possibility that the
3820 // variables might have been written within the protected scope.
3821 {
3822 std::string Constraint;
3823 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3824 if (I) Constraint += ',';
3825 Constraint += "=*m";
3826 }
3827
3828 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3829 }
3830}
3831
3832/// Emit a write hazard at the current location.
3833void FragileHazards::emitWriteHazard() {
3834 if (Locals.empty()) return;
3835
John McCall882987f2013-02-28 19:01:20 +00003836 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall42227ed2010-07-31 23:20:56 +00003837}
3838
John McCall42227ed2010-07-31 23:20:56 +00003839void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
3840 assert(!Locals.empty());
John McCall882987f2013-02-28 19:01:20 +00003841 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
3842 call->setDoesNotThrow();
3843 call->setCallingConv(CGF.getRuntimeCC());
John McCall42227ed2010-07-31 23:20:56 +00003844}
3845
3846/// Emit read hazards in all the protected blocks, i.e. all the blocks
3847/// which have been inserted since the beginning of the try.
John McCall2dd7d442010-08-04 05:59:32 +00003848void FragileHazards::emitHazardsInNewBlocks() {
John McCall42227ed2010-07-31 23:20:56 +00003849 if (Locals.empty()) return;
3850
John McCall7f416cc2015-09-08 08:05:57 +00003851 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall42227ed2010-07-31 23:20:56 +00003852
3853 // Iterate through all blocks, skipping those prior to the try.
3854 for (llvm::Function::iterator
3855 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
3856 llvm::BasicBlock &BB = *FI;
3857 if (BlocksBeforeTry.count(&BB)) continue;
3858
3859 // Walk through all the calls in the block.
3860 for (llvm::BasicBlock::iterator
3861 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
3862 llvm::Instruction &I = *BI;
3863
3864 // Ignore instructions that aren't non-intrinsic calls.
3865 // These are the only calls that can possibly call longjmp.
3866 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I)) continue;
3867 if (isa<llvm::IntrinsicInst>(I))
3868 continue;
3869
3870 // Ignore call sites marked nounwind. This may be questionable,
3871 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
3872 llvm::CallSite CS(&I);
3873 if (CS.doesNotThrow()) continue;
3874
John McCall2dd7d442010-08-04 05:59:32 +00003875 // Insert a read hazard before the call. This will ensure that
3876 // any writes to the locals are performed before making the
3877 // call. If the call throws, then this is sufficient to
3878 // guarantee correctness as long as it doesn't also write to any
3879 // locals.
John McCall42227ed2010-07-31 23:20:56 +00003880 Builder.SetInsertPoint(&BB, BI);
3881 emitReadHazard(Builder);
3882 }
3883 }
3884}
3885
3886static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, llvm::Value *V) {
3887 if (V) S.insert(V);
3888}
3889
John McCall7f416cc2015-09-08 08:05:57 +00003890static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
3891 if (V.isValid()) S.insert(V.getPointer());
3892}
3893
John McCall42227ed2010-07-31 23:20:56 +00003894void FragileHazards::collectLocals() {
3895 // Compute a set of allocas to ignore.
3896 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
3897 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
3898 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall42227ed2010-07-31 23:20:56 +00003899
3900 // Collect all the allocas currently in the function. This is
3901 // probably way too aggressive.
3902 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
3903 for (llvm::BasicBlock::iterator
3904 I = Entry.begin(), E = Entry.end(); I != E; ++I)
3905 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
3906 Locals.push_back(&*I);
3907}
3908
3909llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003910 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall9dc0db22011-05-15 01:53:33 +00003911 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
3912 tys[i] = Locals[i]->getType();
3913 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCall65bea082010-07-21 06:59:36 +00003914}
3915
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003916/*
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003917
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003918 Objective-C setjmp-longjmp (sjlj) Exception Handling
3919 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003920
John McCallbd309292010-07-06 01:34:17 +00003921 A catch buffer is a setjmp buffer plus:
3922 - a pointer to the exception that was caught
3923 - a pointer to the previous exception data buffer
3924 - two pointers of reserved storage
3925 Therefore catch buffers form a stack, with a pointer to the top
3926 of the stack kept in thread-local storage.
3927
3928 objc_exception_try_enter pushes a catch buffer onto the EH stack.
3929 objc_exception_try_exit pops the given catch buffer, which is
3930 required to be the top of the EH stack.
3931 objc_exception_throw pops the top of the EH stack, writes the
3932 thrown exception into the appropriate field, and longjmps
3933 to the setjmp buffer. It crashes the process (with a printf
3934 and an abort()) if there are no catch buffers on the stack.
3935 objc_exception_extract just reads the exception pointer out of the
3936 catch buffer.
3937
3938 There's no reason an implementation couldn't use a light-weight
3939 setjmp here --- something like __builtin_setjmp, but API-compatible
3940 with the heavyweight setjmp. This will be more important if we ever
3941 want to implement correct ObjC/C++ exception interactions for the
3942 fragile ABI.
3943
3944 Note that for this use of setjmp/longjmp to be correct, we may need
3945 to mark some local variables volatile: if a non-volatile local
3946 variable is modified between the setjmp and the longjmp, it has
3947 indeterminate value. For the purposes of LLVM IR, it may be
3948 sufficient to make loads and stores within the @try (to variables
3949 declared outside the @try) volatile. This is necessary for
3950 optimized correctness, but is not currently being done; this is
3951 being tracked as rdar://problem/8160285
3952
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003953 The basic framework for a @try-catch-finally is as follows:
3954 {
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003955 objc_exception_data d;
3956 id _rethrow = null;
Anders Carlssonda0e4562009-02-07 21:26:04 +00003957 bool _call_try_exit = true;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003958
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003959 objc_exception_try_enter(&d);
3960 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003961 ... try body ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003962 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003963 // exception path
3964 id _caught = objc_exception_extract(&d);
3965
3966 // enter new try scope for handlers
3967 if (!setjmp(d.jmp_buf)) {
3968 ... match exception and execute catch blocks ...
3969
3970 // fell off end, rethrow.
3971 _rethrow = _caught;
3972 ... jump-through-finally to finally_rethrow ...
3973 } else {
3974 // exception in catch block
3975 _rethrow = objc_exception_extract(&d);
3976 _call_try_exit = false;
3977 ... jump-through-finally to finally_rethrow ...
3978 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003979 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003980 ... jump-through-finally to finally_end ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003981
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003982 finally:
Anders Carlssonda0e4562009-02-07 21:26:04 +00003983 if (_call_try_exit)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003984 objc_exception_try_exit(&d);
Anders Carlssonda0e4562009-02-07 21:26:04 +00003985
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003986 ... finally block ....
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003987 ... dispatch to finally destination ...
3988
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003989 finally_rethrow:
Daniel Dunbar2efd5382008-09-30 01:06:03 +00003990 objc_exception_throw(_rethrow);
3991
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003992 finally_end:
3993 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003994
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003995 This framework differs slightly from the one gcc uses, in that gcc
3996 uses _rethrow to determine if objc_exception_try_exit should be called
3997 and if the object should be rethrown. This breaks in the face of
3998 throwing nil and introduces unnecessary branches.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003999
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004000 We specialize this framework for a few particular circumstances:
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004001
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004002 - If there are no catch blocks, then we avoid emitting the second
4003 exception handling context.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004004
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004005 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
4006 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004007
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004008 - FIXME: If there is no @finally block we can do a few more
4009 simplifications.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004010
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004011 Rethrows and Jumps-Through-Finally
4012 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004013
John McCallbd309292010-07-06 01:34:17 +00004014 '@throw;' is supported by pushing the currently-caught exception
4015 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004016
John McCallbd309292010-07-06 01:34:17 +00004017 Branches through the @finally block are handled with an ordinary
4018 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
4019 exceptions are not compatible with C++ exceptions, and this is
4020 hardly the only place where this will go wrong.
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004021
John McCallbd309292010-07-06 01:34:17 +00004022 @synchronized(expr) { stmt; } is emitted as if it were:
4023 id synch_value = expr;
4024 objc_sync_enter(synch_value);
4025 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004026*/
4027
Fariborz Jahanianc2ad6dc2008-11-21 00:49:24 +00004028void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
4029 const Stmt &S) {
4030 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallbd309292010-07-06 01:34:17 +00004031
4032 // A destination for the fall-through edges of the catch handlers to
4033 // jump to.
4034 CodeGenFunction::JumpDest FinallyEnd =
4035 CGF.getJumpDestInCurrentScope("finally.end");
4036
4037 // A destination for the rethrow edge of the catch handlers to jump
4038 // to.
4039 CodeGenFunction::JumpDest FinallyRethrow =
4040 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004041
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004042 // For @synchronized, call objc_sync_enter(sync.expr). The
4043 // evaluation of the expression must occur before we enter the
John McCall2dd7d442010-08-04 05:59:32 +00004044 // @synchronized. We can't avoid a temp here because we need the
4045 // value to be preserved. If the backend ever does liveness
4046 // correctly after setjmp, this will be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00004047 Address SyncArgSlot = Address::invalid();
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004048 if (!isTry) {
John McCall2dd7d442010-08-04 05:59:32 +00004049 llvm::Value *SyncArg =
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004050 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
4051 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004052 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall2dd7d442010-08-04 05:59:32 +00004053
John McCall7f416cc2015-09-08 08:05:57 +00004054 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
4055 CGF.getPointerAlign(), "sync.arg");
John McCall2dd7d442010-08-04 05:59:32 +00004056 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004057 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004058
John McCall2dd7d442010-08-04 05:59:32 +00004059 // Allocate memory for the setjmp buffer. This needs to be kept
4060 // live throughout the try and catch blocks.
John McCall7f416cc2015-09-08 08:05:57 +00004061 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
4062 CGF.getPointerAlign(),
4063 "exceptiondata.ptr");
John McCall2dd7d442010-08-04 05:59:32 +00004064
John McCall42227ed2010-07-31 23:20:56 +00004065 // Create the fragile hazards. Note that this will not capture any
4066 // of the allocas required for exception processing, but will
4067 // capture the current basic block (which extends all the way to the
4068 // setjmp call) as "before the @try".
4069 FragileHazards Hazards(CGF);
4070
John McCallbd309292010-07-06 01:34:17 +00004071 // Create a flag indicating whether the cleanup needs to call
4072 // objc_exception_try_exit. This is true except when
4073 // - no catches match and we're branching through the cleanup
4074 // just to rethrow the exception, or
4075 // - a catch matched and we're falling out of the catch handler.
John McCall2dd7d442010-08-04 05:59:32 +00004076 // The setjmp-safety rule here is that we should always store to this
4077 // variable in a place that dominates the branch through the cleanup
4078 // without passing through any setjmps.
John McCall7f416cc2015-09-08 08:05:57 +00004079 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
4080 CharUnits::One(),
4081 "_call_try_exit");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004082
John McCall9916e3f2010-10-04 23:42:51 +00004083 // A slot containing the exception to rethrow. Only needed when we
4084 // have both a @catch and a @finally.
John McCall7f416cc2015-09-08 08:05:57 +00004085 Address PropagatingExnVar = Address::invalid();
John McCall9916e3f2010-10-04 23:42:51 +00004086
John McCallbd309292010-07-06 01:34:17 +00004087 // Push a normal cleanup to leave the try scope.
John McCall638d4f52013-04-03 00:56:07 +00004088 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall2dd7d442010-08-04 05:59:32 +00004089 SyncArgSlot,
John McCallcda666c2010-07-21 07:22:38 +00004090 CallTryExitVar,
4091 ExceptionData,
4092 &ObjCTypes);
John McCallbd309292010-07-06 01:34:17 +00004093
4094 // Enter a try block:
4095 // - Call objc_exception_try_enter to push ExceptionData on top of
4096 // the EH stack.
Nico Weber6307cf02015-02-26 20:43:00 +00004097 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004098 ExceptionData.getPointer());
John McCallbd309292010-07-06 01:34:17 +00004099
4100 // - Call setjmp on the exception data buffer.
4101 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
4102 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
David Blaikie6b2a8302015-04-03 17:47:16 +00004103 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
John McCall7f416cc2015-09-08 08:05:57 +00004104 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
4105 "setjmp_buffer");
Nico Weber6307cf02015-02-26 20:43:00 +00004106 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
4107 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004108 SetJmpResult->setCanReturnTwice();
John McCallbd309292010-07-06 01:34:17 +00004109
4110 // If setjmp returned 0, enter the protected block; otherwise,
4111 // branch to the handler.
Daniel Dunbar75283ff2008-11-11 02:29:29 +00004112 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
4113 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallbd309292010-07-06 01:34:17 +00004114 llvm::Value *DidCatch =
John McCallcebe0ca2010-08-11 00:16:14 +00004115 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4116 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004117
John McCallbd309292010-07-06 01:34:17 +00004118 // Emit the protected block.
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004119 CGF.EmitBlock(TryBlock);
John McCall2dd7d442010-08-04 05:59:32 +00004120 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004121 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallbd309292010-07-06 01:34:17 +00004122 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall2dd7d442010-08-04 05:59:32 +00004123
4124 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004125
John McCallbd309292010-07-06 01:34:17 +00004126 // Emit the exception handler block.
Daniel Dunbar7f086782008-09-27 23:30:04 +00004127 CGF.EmitBlock(TryHandler);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004128
John McCall42227ed2010-07-31 23:20:56 +00004129 // Don't optimize loads of the in-scope locals across this point.
4130 Hazards.emitWriteHazard();
4131
John McCallbd309292010-07-06 01:34:17 +00004132 // For a @synchronized (or a @try with no catches), just branch
4133 // through the cleanup to the rethrow block.
4134 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
4135 // Tell the cleanup not to re-pop the exit.
John McCall2dd7d442010-08-04 05:59:32 +00004136 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004137 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallbd309292010-07-06 01:34:17 +00004138
4139 // Otherwise, we have to match against the caught exceptions.
4140 } else {
John McCall2dd7d442010-08-04 05:59:32 +00004141 // Retrieve the exception object. We may emit multiple blocks but
4142 // nothing can cross this so the value is already in SSA form.
4143 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004144 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004145 ExceptionData.getPointer(), "caught");
John McCall2dd7d442010-08-04 05:59:32 +00004146
John McCallbd309292010-07-06 01:34:17 +00004147 // Push the exception to rethrow onto the EH value stack for the
4148 // benefit of any @throws in the handlers.
4149 CGF.ObjCEHValueStack.push_back(Caught);
4150
Douglas Gregor96c79492010-04-23 22:50:49 +00004151 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004152
Craig Topper8a13c412014-05-21 05:09:00 +00004153 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallbd309292010-07-06 01:34:17 +00004154
Craig Topper8a13c412014-05-21 05:09:00 +00004155 llvm::BasicBlock *CatchBlock = nullptr;
4156 llvm::BasicBlock *CatchHandler = nullptr;
John McCall2dd7d442010-08-04 05:59:32 +00004157 if (HasFinally) {
John McCall9916e3f2010-10-04 23:42:51 +00004158 // Save the currently-propagating exception before
4159 // objc_exception_try_enter clears the exception slot.
4160 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
John McCall7f416cc2015-09-08 08:05:57 +00004161 CGF.getPointerAlign(),
John McCall9916e3f2010-10-04 23:42:51 +00004162 "propagating_exception");
4163 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
4164
John McCall2dd7d442010-08-04 05:59:32 +00004165 // Enter a new exception try block (in case a @catch block
4166 // throws an exception).
John McCall882987f2013-02-28 19:01:20 +00004167 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004168 ExceptionData.getPointer());
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004169
John McCall2dd7d442010-08-04 05:59:32 +00004170 llvm::CallInst *SetJmpResult =
John McCall882987f2013-02-28 19:01:20 +00004171 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4172 SetJmpBuffer, "setjmp.result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004173 SetJmpResult->setCanReturnTwice();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004174
John McCall2dd7d442010-08-04 05:59:32 +00004175 llvm::Value *Threw =
4176 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4177
4178 CatchBlock = CGF.createBasicBlock("catch");
4179 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4180 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4181
4182 CGF.EmitBlock(CatchBlock);
4183 }
4184
4185 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004186
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004187 // Handle catch list. As a special case we check if everything is
4188 // matched and avoid generating code for falling off the end if
4189 // so.
4190 bool AllMatched = false;
Douglas Gregor96c79492010-04-23 22:50:49 +00004191 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4192 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004193
Douglas Gregor46a572b2010-04-26 16:46:50 +00004194 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00004195 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar523208f2008-09-27 07:36:24 +00004196
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004197 // catch(...) always matches.
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004198 if (!CatchParam) {
4199 AllMatched = true;
4200 } else {
John McCall9dd450b2009-09-21 23:43:11 +00004201 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004202
John McCallbd309292010-07-06 01:34:17 +00004203 // catch(id e) always matches under this ABI, since only
4204 // ObjC exceptions end up here in the first place.
Daniel Dunbar86919f42008-09-27 22:21:14 +00004205 // FIXME: For the time being we also match id<X>; this should
4206 // be rejected by Sema instead.
Eli Friedman55179ca2009-07-11 00:57:02 +00004207 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004208 AllMatched = true;
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004209 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004210
John McCallbd309292010-07-06 01:34:17 +00004211 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004212 if (AllMatched) {
John McCallbd309292010-07-06 01:34:17 +00004213 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4214
Anders Carlsson9396a892008-09-11 09:15:33 +00004215 if (CatchParam) {
John McCall1c9c3fd2010-10-15 04:57:14 +00004216 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004217 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallbd309292010-07-06 01:34:17 +00004218
4219 // These types work out because ConvertType(id) == i8*.
John McCall17f02752015-10-30 00:56:02 +00004220 EmitInitOfCatchParam(CGF, Caught, CatchParam);
Anders Carlsson9396a892008-09-11 09:15:33 +00004221 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004222
Anders Carlsson9396a892008-09-11 09:15:33 +00004223 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004224
4225 // The scope of the catch variable ends right here.
4226 CatchVarCleanups.ForceCleanup();
4227
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004228 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004229 break;
4230 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004231
Steve Naroff7cae42b2009-07-10 23:34:53 +00004232 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall96fa4842010-05-17 21:00:27 +00004233 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallbd309292010-07-06 01:34:17 +00004234
4235 // FIXME: @catch (Class c) ?
John McCall96fa4842010-05-17 21:00:27 +00004236 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4237 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004238
4239 // Check if the @catch block matches the exception object.
John McCall882987f2013-02-28 19:01:20 +00004240 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004241
John McCall882987f2013-02-28 19:01:20 +00004242 llvm::Value *matchArgs[] = { Class, Caught };
John McCallbd309292010-07-06 01:34:17 +00004243 llvm::CallInst *Match =
John McCall882987f2013-02-28 19:01:20 +00004244 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4245 matchArgs, "match");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004246
John McCallbd309292010-07-06 01:34:17 +00004247 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4248 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004249
4250 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbar7f086782008-09-27 23:30:04 +00004251 MatchedBlock, NextCatchBlock);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004252
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004253 // Emit the @catch block.
4254 CGF.EmitBlock(MatchedBlock);
John McCallbd309292010-07-06 01:34:17 +00004255
4256 // Collect any cleanups for the catch variable. The scope lasts until
4257 // the end of the catch body.
John McCall2dd7d442010-08-04 05:59:32 +00004258 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallbd309292010-07-06 01:34:17 +00004259
John McCall1c9c3fd2010-10-15 04:57:14 +00004260 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004261 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004262
John McCallbd309292010-07-06 01:34:17 +00004263 // Initialize the catch variable.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004264 llvm::Value *Tmp =
4265 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004266 CGF.ConvertType(CatchParam->getType()));
John McCall17f02752015-10-30 00:56:02 +00004267 EmitInitOfCatchParam(CGF, Tmp, CatchParam);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004268
Anders Carlsson9396a892008-09-11 09:15:33 +00004269 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004270
4271 // We're done with the catch variable.
4272 CatchVarCleanups.ForceCleanup();
4273
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004274 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004275
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004276 CGF.EmitBlock(NextCatchBlock);
4277 }
4278
John McCallbd309292010-07-06 01:34:17 +00004279 CGF.ObjCEHValueStack.pop_back();
4280
John McCall2dd7d442010-08-04 05:59:32 +00004281 // If nothing wanted anything to do with the caught exception,
4282 // kill the extract call.
4283 if (Caught->use_empty())
4284 Caught->eraseFromParent();
4285
4286 if (!AllMatched)
4287 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4288
4289 if (HasFinally) {
4290 // Emit the exception handler for the @catch blocks.
4291 CGF.EmitBlock(CatchHandler);
4292
4293 // In theory we might now need a write hazard, but actually it's
4294 // unnecessary because there's no local-accessing code between
4295 // the try's write hazard and here.
4296 //Hazards.emitWriteHazard();
4297
John McCall9916e3f2010-10-04 23:42:51 +00004298 // Extract the new exception and save it to the
4299 // propagating-exception slot.
John McCall7f416cc2015-09-08 08:05:57 +00004300 assert(PropagatingExnVar.isValid());
John McCall9916e3f2010-10-04 23:42:51 +00004301 llvm::CallInst *NewCaught =
John McCall882987f2013-02-28 19:01:20 +00004302 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004303 ExceptionData.getPointer(), "caught");
John McCall9916e3f2010-10-04 23:42:51 +00004304 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4305
John McCall2dd7d442010-08-04 05:59:32 +00004306 // Don't pop the catch handler; the throw already did.
4307 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004308 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004309 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004310 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004311
John McCall42227ed2010-07-31 23:20:56 +00004312 // Insert read hazards as required in the new blocks.
John McCall2dd7d442010-08-04 05:59:32 +00004313 Hazards.emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004314
John McCallbd309292010-07-06 01:34:17 +00004315 // Pop the cleanup.
John McCall2dd7d442010-08-04 05:59:32 +00004316 CGF.Builder.restoreIP(TryFallthroughIP);
4317 if (CGF.HaveInsertPoint())
4318 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallbd309292010-07-06 01:34:17 +00004319 CGF.PopCleanupBlock();
John McCall2dd7d442010-08-04 05:59:32 +00004320 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004321
John McCallbd309292010-07-06 01:34:17 +00004322 // Emit the rethrow block.
John McCall42227ed2010-07-31 23:20:56 +00004323 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallad5d61e2010-07-23 21:56:41 +00004324 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallbd309292010-07-06 01:34:17 +00004325 if (CGF.HaveInsertPoint()) {
John McCall9916e3f2010-10-04 23:42:51 +00004326 // If we have a propagating-exception variable, check it.
4327 llvm::Value *PropagatingExn;
John McCall7f416cc2015-09-08 08:05:57 +00004328 if (PropagatingExnVar.isValid()) {
John McCall9916e3f2010-10-04 23:42:51 +00004329 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall2dd7d442010-08-04 05:59:32 +00004330
John McCall9916e3f2010-10-04 23:42:51 +00004331 // Otherwise, just look in the buffer for the exception to throw.
4332 } else {
4333 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004334 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004335 ExceptionData.getPointer());
John McCall9916e3f2010-10-04 23:42:51 +00004336 PropagatingExn = Caught;
4337 }
4338
John McCall882987f2013-02-28 19:01:20 +00004339 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4340 PropagatingExn);
John McCallbd309292010-07-06 01:34:17 +00004341 CGF.Builder.CreateUnreachable();
Fariborz Jahaniane2caaaa2008-11-21 19:21:53 +00004342 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004343
John McCall42227ed2010-07-31 23:20:56 +00004344 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004345}
4346
4347void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004348 const ObjCAtThrowStmt &S,
4349 bool ClearInsertionPoint) {
Anders Carlssone005aa12008-09-09 16:16:55 +00004350 llvm::Value *ExceptionAsObject;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004351
Anders Carlssone005aa12008-09-09 16:16:55 +00004352 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00004353 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004354 ExceptionAsObject =
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004355 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlssone005aa12008-09-09 16:16:55 +00004356 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004357 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004358 "Unexpected rethrow outside @catch block.");
Anders Carlssonbf8a1be2009-02-07 21:37:21 +00004359 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlssone005aa12008-09-09 16:16:55 +00004360 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004361
John McCall882987f2013-02-28 19:01:20 +00004362 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallbd309292010-07-06 01:34:17 +00004363 ->setDoesNotReturn();
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004364 CGF.Builder.CreateUnreachable();
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004365
4366 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004367 if (ClearInsertionPoint)
4368 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004369}
4370
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004371/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004372/// object: objc_read_weak (id *src)
4373///
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004374llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004375 Address AddrWeakObj) {
4376 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004377 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4378 ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004379 llvm::Value *read_weak =
4380 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004381 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00004382 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004383 return read_weak;
4384}
4385
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004386/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4387/// objc_assign_weak (id src, id *dst)
4388///
4389void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004390 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004391 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004392 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004393 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004394 assert(Size <= 8 && "does not support size > 8");
4395 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004396 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004397 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4398 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004399 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4400 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004401 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004402 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4403 args, "weakassign");
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004404}
4405
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004406/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4407/// objc_assign_global (id src, id *dst)
4408///
4409void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004410 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00004411 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004412 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004413 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004414 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004415 assert(Size <= 8 && "does not support size > 8");
4416 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004417 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004418 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4419 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004420 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4421 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004422 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00004423 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00004424 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4425 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00004426 else
John McCall882987f2013-02-28 19:01:20 +00004427 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4428 args, "threadlocalassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004429}
4430
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004431/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004432/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004433///
4434void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004435 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004436 llvm::Value *ivarOffset) {
4437 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2192fe52011-07-18 04:24:23 +00004438 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004439 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004440 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004441 assert(Size <= 8 && "does not support size > 8");
4442 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004443 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004444 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4445 }
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004446 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4447 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004448 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00004449 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004450}
4451
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004452/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4453/// objc_assign_strongCast (id src, id *dst)
4454///
4455void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004456 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004457 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004458 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004459 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004460 assert(Size <= 8 && "does not support size > 8");
4461 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004462 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004463 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4464 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004465 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4466 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004467 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004468 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004469 args, "strongassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004470}
4471
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004472void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004473 Address DestPtr,
4474 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004475 llvm::Value *size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004476 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4477 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004478 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCall882987f2013-02-28 19:01:20 +00004479 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004480}
4481
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004482/// EmitObjCValueForIvar - Code Gen for ivar reference.
4483///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004484LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4485 QualType ObjectTy,
4486 llvm::Value *BaseValue,
4487 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004488 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004489 const ObjCInterfaceDecl *ID =
4490 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004491 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4492 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004493}
4494
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004495llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004496 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004497 const ObjCIvarDecl *Ivar) {
Eli Friedman8cbca202012-11-06 22:15:52 +00004498 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4499 return llvm::ConstantInt::get(
4500 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4501 Offset);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004502}
4503
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004504/* *** Private Interface *** */
4505
4506/// EmitImageInfo - Emit the image info marker used to encode some module
4507/// level information.
4508///
4509/// See: <rdr://4810609&4810587&4810587>
4510/// struct IMAGE_INFO {
4511/// unsigned version;
4512/// unsigned flags;
4513/// };
4514enum ImageInfoFlags {
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004515 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004516 eImageInfo_GarbageCollected = (1 << 1),
4517 eImageInfo_GCOnly = (1 << 2),
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004518 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbar75e909f2009-04-20 07:11:47 +00004519
Daniel Dunbar5e639272010-04-25 20:39:01 +00004520 // A flag indicating that the module has no instances of a @synthesize of a
4521 // superclass variable. <rdar://problem/6803242>
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004522 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Manman Ren96df0b32016-01-29 23:45:01 +00004523 eImageInfo_ImageIsSimulated = (1 << 5),
4524 eImageInfo_ClassProperties = (1 << 6)
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004525};
4526
Daniel Dunbar5e639272010-04-25 20:39:01 +00004527void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004528 unsigned version = 0; // Version is unused?
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004529 const char *Section = (ObjCABI == 1) ?
4530 "__OBJC, __image_info,regular" :
4531 "__DATA, __objc_imageinfo, regular, no_dead_strip";
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004532
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004533 // Generate module-level named metadata to convey this information to the
4534 // linker and code-gen.
4535 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004536
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004537 // Add the ObjC ABI version to the module flags.
4538 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4539 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4540 version);
4541 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
4542 llvm::MDString::get(VMContext,Section));
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004543
David Blaikiebbafb8a2012-03-11 07:00:24 +00004544 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004545 // Non-GC overrides those files which specify GC.
4546 Mod.addModuleFlag(llvm::Module::Override,
4547 "Objective-C Garbage Collection", (uint32_t)0);
4548 } else {
4549 // Add the ObjC garbage collection value.
4550 Mod.addModuleFlag(llvm::Module::Error,
4551 "Objective-C Garbage Collection",
4552 eImageInfo_GarbageCollected);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004553
David Blaikiebbafb8a2012-03-11 07:00:24 +00004554 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004555 // Add the ObjC GC Only value.
4556 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4557 eImageInfo_GCOnly);
4558
4559 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004560 llvm::Metadata *Ops[2] = {
4561 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4562 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4563 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004564 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4565 llvm::MDNode::get(VMContext, Ops));
4566 }
4567 }
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004568
4569 // Indicate whether we're compiling this to run on a simulator.
4570 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00004571 if ((Triple.isiOS() || Triple.isWatchOS()) &&
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004572 (Triple.getArch() == llvm::Triple::x86 ||
4573 Triple.getArch() == llvm::Triple::x86_64))
4574 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4575 eImageInfo_ImageIsSimulated);
Manman Ren96df0b32016-01-29 23:45:01 +00004576
4577 // Indicate whether we are generating class properties.
4578 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Class Properties",
4579 eImageInfo_ClassProperties);
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004580}
4581
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004582// struct objc_module {
4583// unsigned long version;
4584// unsigned long size;
4585// const char *name;
4586// Symtab symtab;
4587// };
4588
4589// FIXME: Get from somewhere
4590static const int ModuleVersion = 7;
4591
4592void CGObjCMac::EmitModuleInfo() {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004593 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004594
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004595 llvm::Constant *Values[] = {
4596 llvm::ConstantInt::get(ObjCTypes.LongTy, ModuleVersion),
4597 llvm::ConstantInt::get(ObjCTypes.LongTy, Size),
4598 // This used to be the filename, now it is unused. <rdr://4327263>
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004599 GetClassName(StringRef("")),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004600 EmitModuleSymbols()
4601 };
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004602 CreateMetadataVar("OBJC_MODULES",
Owen Anderson0e0189d2009-07-27 22:29:56 +00004603 llvm::ConstantStruct::get(ObjCTypes.ModuleTy, Values),
John McCall7f416cc2015-09-08 08:05:57 +00004604 "__OBJC,__module_info,regular,no_dead_strip",
4605 CGM.getPointerAlign(), true);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004606}
4607
4608llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004609 unsigned NumClasses = DefinedClasses.size();
4610 unsigned NumCategories = DefinedCategories.size();
4611
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004612 // Return null if no symbols were defined.
4613 if (!NumClasses && !NumCategories)
Owen Anderson0b75f232009-07-31 20:28:54 +00004614 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004615
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004616 llvm::Constant *Values[5];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004617 Values[0] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
Owen Anderson0b75f232009-07-31 20:28:54 +00004618 Values[1] = llvm::Constant::getNullValue(ObjCTypes.SelectorPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004619 Values[2] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumClasses);
4620 Values[3] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004621
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004622 // The runtime expects exactly the list of defined classes followed
4623 // by the list of defined categories, in a single array.
Chris Lattner3def9ae2012-02-06 22:16:34 +00004624 SmallVector<llvm::Constant*, 8> Symbols(NumClasses + NumCategories);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004625 for (unsigned i=0; i<NumClasses; i++) {
4626 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
4627 assert(ID);
4628 if (ObjCImplementationDecl *IMP = ID->getImplementation())
4629 // We are implementing a weak imported interface. Give it external linkage
4630 if (ID->isWeakImported() && !IMP->isWeakImported())
4631 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
4632
Owen Andersonade90fd2009-07-29 18:54:39 +00004633 Symbols[i] = llvm::ConstantExpr::getBitCast(DefinedClasses[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004634 ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004635 }
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004636 for (unsigned i=0; i<NumCategories; i++)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004637 Symbols[NumClasses + i] =
Owen Andersonade90fd2009-07-29 18:54:39 +00004638 llvm::ConstantExpr::getBitCast(DefinedCategories[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004639 ObjCTypes.Int8PtrTy);
4640
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004641 Values[4] =
Owen Anderson9793f0e2009-07-29 22:16:19 +00004642 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00004643 Symbols.size()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004644 Symbols);
4645
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004646 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004647
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004648 llvm::GlobalVariable *GV = CreateMetadataVar(
John McCall7f416cc2015-09-08 08:05:57 +00004649 "OBJC_SYMBOLS", Init, "__OBJC,__symbols,regular,no_dead_strip",
4650 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00004651 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004652}
4653
John McCall882987f2013-02-28 19:01:20 +00004654llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
4655 IdentifierInfo *II) {
John McCall31168b02011-06-15 23:02:42 +00004656 LazySymbols.insert(II);
4657
4658 llvm::GlobalVariable *&Entry = ClassReferences[II];
4659
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004660 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004661 llvm::Constant *Casted =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004662 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCall31168b02011-06-15 23:02:42 +00004663 ObjCTypes.ClassPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004664 Entry = CreateMetadataVar(
4665 "OBJC_CLASS_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004666 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
4667 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004668 }
John McCall31168b02011-06-15 23:02:42 +00004669
John McCall7f416cc2015-09-08 08:05:57 +00004670 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004671}
4672
John McCall882987f2013-02-28 19:01:20 +00004673llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00004674 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00004675 // If the class has the objc_runtime_visible attribute, we need to
4676 // use the Objective-C runtime to get the class.
4677 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
4678 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
4679
John McCall882987f2013-02-28 19:01:20 +00004680 return EmitClassRefFromId(CGF, ID->getIdentifier());
John McCall31168b02011-06-15 23:02:42 +00004681}
4682
John McCall882987f2013-02-28 19:01:20 +00004683llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00004684 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCall882987f2013-02-28 19:01:20 +00004685 return EmitClassRefFromId(CGF, II);
John McCall31168b02011-06-15 23:02:42 +00004686}
4687
John McCall7f416cc2015-09-08 08:05:57 +00004688llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
4689 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
4690}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004691
John McCall7f416cc2015-09-08 08:05:57 +00004692Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
4693 CharUnits Align = CGF.getPointerAlign();
4694
4695 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004696 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004697 llvm::Constant *Casted =
Owen Andersonade90fd2009-07-29 18:54:39 +00004698 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004699 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004700 Entry = CreateMetadataVar(
4701 "OBJC_SELECTOR_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004702 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman5c205962013-02-05 23:08:45 +00004703 Entry->setExternallyInitialized(true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004704 }
4705
John McCall7f416cc2015-09-08 08:05:57 +00004706 return Address(Entry, Align);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004707}
4708
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004709llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
4710 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
4711 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004712 Entry = CreateMetadataVar(
4713 "OBJC_CLASS_NAME_",
4714 llvm::ConstantDataArray::getString(VMContext, RuntimeName),
4715 ((ObjCABI == 2) ? "__TEXT,__objc_classname,cstring_literals"
4716 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004717 CharUnits::One(), true);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004718 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004719}
4720
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004721llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
4722 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
4723 I = MethodDefinitions.find(MD);
4724 if (I != MethodDefinitions.end())
4725 return I->second;
4726
Craig Topper8a13c412014-05-21 05:09:00 +00004727 return nullptr;
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004728}
4729
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004730/// GetIvarLayoutName - Returns a unique constant for the given
4731/// ivar layout bitmap.
4732llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004733 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Anderson0b75f232009-07-31 20:28:54 +00004734 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004735}
4736
John McCall3fd13f062015-10-21 18:06:47 +00004737void IvarLayoutBuilder::visitRecord(const RecordType *RT,
4738 CharUnits offset) {
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004739 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004740
John McCall3fd13f062015-10-21 18:06:47 +00004741 // If this is a union, remember that we had one, because it might mess
4742 // up the ordering of layout entries.
4743 if (RD->isUnion())
4744 IsDisordered = true;
4745
4746 const ASTRecordLayout *recLayout = nullptr;
4747 visitAggregate(RD->field_begin(), RD->field_end(), offset,
4748 [&](const FieldDecl *field) -> CharUnits {
4749 if (!recLayout)
4750 recLayout = &CGM.getContext().getASTRecordLayout(RD);
4751 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
4752 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
4753 });
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004754}
4755
John McCall3fd13f062015-10-21 18:06:47 +00004756template <class Iterator, class GetOffsetFn>
4757void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
4758 CharUnits aggregateOffset,
4759 const GetOffsetFn &getOffset) {
4760 for (; begin != end; ++begin) {
4761 auto field = *begin;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004762
John McCall3fd13f062015-10-21 18:06:47 +00004763 // Skip over bitfields.
4764 if (field->isBitField()) {
4765 continue;
4766 }
4767
4768 // Compute the offset of the field within the aggregate.
4769 CharUnits fieldOffset = aggregateOffset + getOffset(field);
4770
4771 visitField(field, fieldOffset);
4772 }
4773}
4774
4775/// Collect layout information for the given fields into IvarsInfo.
4776void IvarLayoutBuilder::visitField(const FieldDecl *field,
4777 CharUnits fieldOffset) {
4778 QualType fieldType = field->getType();
4779
4780 // Drill down into arrays.
4781 uint64_t numElts = 1;
4782 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
4783 numElts *= arrayType->getSize().getZExtValue();
4784 fieldType = arrayType->getElementType();
4785 }
4786
4787 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
4788
4789 // If we ended up with a zero-sized array, we've done what we can do within
4790 // the limits of this layout encoding.
4791 if (numElts == 0) return;
4792
4793 // Recurse if the base element type is a record type.
4794 if (auto recType = fieldType->getAs<RecordType>()) {
4795 size_t oldEnd = IvarsInfo.size();
4796
4797 visitRecord(recType, fieldOffset);
4798
4799 // If we have an array, replicate the first entry's layout information.
4800 auto numEltEntries = IvarsInfo.size() - oldEnd;
4801 if (numElts != 1 && numEltEntries != 0) {
4802 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
4803 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
4804 // Copy the last numEltEntries onto the end of the array, adjusting
4805 // each for the element size.
4806 for (size_t i = 0; i != numEltEntries; ++i) {
4807 auto firstEntry = IvarsInfo[oldEnd + i];
4808 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
4809 firstEntry.SizeInWords));
4810 }
4811 }
4812 }
4813
Fariborz Jahanian524bb202009-03-10 16:22:08 +00004814 return;
Fariborz Jahanian3b0f8862009-03-11 00:07:04 +00004815 }
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004816
John McCall3fd13f062015-10-21 18:06:47 +00004817 // Classify the element type.
4818 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004819
John McCall3fd13f062015-10-21 18:06:47 +00004820 // If it matches what we're looking for, add an entry.
4821 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
4822 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
4823 assert(CGM.getContext().getTypeSizeInChars(fieldType)
4824 == CGM.getPointerSize());
4825 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
4826 }
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00004827}
4828
John McCall3fd13f062015-10-21 18:06:47 +00004829/// buildBitmap - This routine does the horsework of taking the offsets of
4830/// strong/weak references and creating a bitmap. The bitmap is also
4831/// returned in the given buffer, suitable for being passed to \c dump().
4832llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
4833 llvm::SmallVectorImpl<unsigned char> &buffer) {
4834 // The bitmap is a series of skip/scan instructions, aligned to word
4835 // boundaries. The skip is performed first.
4836 const unsigned char MaxNibble = 0xF;
4837 const unsigned char SkipMask = 0xF0, SkipShift = 4;
4838 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004839
John McCall3fd13f062015-10-21 18:06:47 +00004840 assert(!IvarsInfo.empty() && "generating bitmap for no data");
4841
4842 // Sort the ivar info on byte position in case we encounterred a
4843 // union nested in the ivar list.
4844 if (IsDisordered) {
4845 // This isn't a stable sort, but our algorithm should handle it fine.
4846 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
4847 } else {
Craig Toppera3467052016-01-03 19:43:20 +00004848 assert(std::is_sorted(IvarsInfo.begin(), IvarsInfo.end()));
John McCall3fd13f062015-10-21 18:06:47 +00004849 }
4850 assert(IvarsInfo.back().Offset < InstanceEnd);
4851
4852 assert(buffer.empty());
4853
4854 // Skip the next N words.
4855 auto skip = [&](unsigned numWords) {
4856 assert(numWords > 0);
4857
4858 // Try to merge into the previous byte. Since scans happen second, we
4859 // can't do this if it includes a scan.
4860 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
4861 unsigned lastSkip = buffer.back() >> SkipShift;
4862 if (lastSkip < MaxNibble) {
4863 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
4864 numWords -= claimed;
4865 lastSkip += claimed;
4866 buffer.back() = (lastSkip << SkipShift);
4867 }
4868 }
4869
4870 while (numWords >= MaxNibble) {
4871 buffer.push_back(MaxNibble << SkipShift);
4872 numWords -= MaxNibble;
4873 }
4874 if (numWords) {
4875 buffer.push_back(numWords << SkipShift);
4876 }
4877 };
4878
4879 // Scan the next N words.
4880 auto scan = [&](unsigned numWords) {
4881 assert(numWords > 0);
4882
4883 // Try to merge into the previous byte. Since scans happen second, we can
4884 // do this even if it includes a skip.
4885 if (!buffer.empty()) {
4886 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
4887 if (lastScan < MaxNibble) {
4888 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
4889 numWords -= claimed;
4890 lastScan += claimed;
4891 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
4892 }
4893 }
4894
4895 while (numWords >= MaxNibble) {
4896 buffer.push_back(MaxNibble << ScanShift);
4897 numWords -= MaxNibble;
4898 }
4899 if (numWords) {
4900 buffer.push_back(numWords << ScanShift);
4901 }
4902 };
4903
4904 // One past the end of the last scan.
4905 unsigned endOfLastScanInWords = 0;
4906 const CharUnits WordSize = CGM.getPointerSize();
4907
4908 // Consider all the scan requests.
4909 for (auto &request : IvarsInfo) {
4910 CharUnits beginOfScan = request.Offset - InstanceBegin;
4911
4912 // Ignore scan requests that don't start at an even multiple of the
4913 // word size. We can't encode them.
4914 if ((beginOfScan % WordSize) != 0) continue;
4915
4916 // Ignore scan requests that start before the instance start.
4917 // This assumes that scans never span that boundary. The boundary
4918 // isn't the true start of the ivars, because in the fragile-ARC case
4919 // it's rounded up to word alignment, but the test above should leave
4920 // us ignoring that possibility.
4921 if (beginOfScan.isNegative()) {
4922 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
4923 continue;
4924 }
4925
4926 unsigned beginOfScanInWords = beginOfScan / WordSize;
4927 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
4928
4929 // If the scan starts some number of words after the last one ended,
4930 // skip forward.
4931 if (beginOfScanInWords > endOfLastScanInWords) {
4932 skip(beginOfScanInWords - endOfLastScanInWords);
4933
4934 // Otherwise, start scanning where the last left off.
4935 } else {
4936 beginOfScanInWords = endOfLastScanInWords;
4937
4938 // If that leaves us with nothing to scan, ignore this request.
4939 if (beginOfScanInWords >= endOfScanInWords) continue;
4940 }
4941
4942 // Scan to the end of the request.
4943 assert(beginOfScanInWords < endOfScanInWords);
4944 scan(endOfScanInWords - beginOfScanInWords);
4945 endOfLastScanInWords = endOfScanInWords;
4946 }
4947
John McCallf5ea0722015-10-29 23:36:14 +00004948 if (buffer.empty())
4949 return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
4950
John McCall3fd13f062015-10-21 18:06:47 +00004951 // For GC layouts, emit a skip to the end of the allocation so that we
4952 // have precise information about the entire thing. This isn't useful
4953 // or necessary for the ARC-style layout strings.
4954 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
4955 unsigned lastOffsetInWords =
4956 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
4957 if (lastOffsetInWords > endOfLastScanInWords) {
4958 skip(lastOffsetInWords - endOfLastScanInWords);
4959 }
4960 }
4961
4962 // Null terminate the string.
4963 buffer.push_back(0);
4964
4965 bool isNonFragileABI = CGObjC.isNonFragileABI();
4966
4967 llvm::GlobalVariable *Entry = CGObjC.CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004968 "OBJC_CLASS_NAME_",
John McCall3fd13f062015-10-21 18:06:47 +00004969 llvm::ConstantDataArray::get(CGM.getLLVMContext(), buffer),
4970 (isNonFragileABI ? "__TEXT,__objc_classname,cstring_literals"
4971 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00004972 CharUnits::One(), true);
John McCall3fd13f062015-10-21 18:06:47 +00004973 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004974}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004975
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00004976/// BuildIvarLayout - Builds ivar layout bitmap for the class
4977/// implementation for the __strong or __weak case.
4978/// The layout map displays which words in ivar list must be skipped
4979/// and which must be scanned by GC (see below). String is built of bytes.
4980/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
4981/// of words to skip and right nibble is count of words to scan. So, each
4982/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
4983/// represented by a 0x00 byte which also ends the string.
4984/// 1. when ForStrongLayout is true, following ivars are scanned:
4985/// - id, Class
4986/// - object *
4987/// - __strong anything
4988///
4989/// 2. When ForStrongLayout is false, following ivars are scanned:
4990/// - __weak anything
4991///
John McCall3fd13f062015-10-21 18:06:47 +00004992llvm::Constant *
4993CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
4994 CharUnits beginOffset, CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +00004995 bool ForStrongLayout, bool HasMRCWeakIvars) {
4996 // If this is MRC, and we're either building a strong layout or there
4997 // are no weak ivars, bail out early.
Chris Lattnerece04092012-02-07 00:39:47 +00004998 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikiebbafb8a2012-03-11 07:00:24 +00004999 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
John McCall460ce582015-10-22 18:38:17 +00005000 !CGM.getLangOpts().ObjCAutoRefCount &&
5001 (ForStrongLayout || !HasMRCWeakIvars))
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005002 return llvm::Constant::getNullValue(PtrTy);
5003
Jordy Rosea91768e2011-07-22 02:08:32 +00005004 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
John McCall3fd13f062015-10-21 18:06:47 +00005005 SmallVector<const ObjCIvarDecl*, 32> ivars;
5006
5007 // GC layout strings include the complete object layout, possibly
5008 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
5009 // up.
5010 //
5011 // ARC layout strings only include the class's ivars. In non-fragile
John McCallf5ea0722015-10-29 23:36:14 +00005012 // runtimes, that means starting at InstanceStart, rounded up to word
5013 // alignment. In fragile runtimes, there's no InstanceStart, so it means
John McCalld80218f2015-11-19 02:27:55 +00005014 // starting at the offset of the first ivar, rounded up to word alignment.
John McCall460ce582015-10-22 18:38:17 +00005015 //
5016 // MRC weak layout strings follow the ARC style.
John McCall3fd13f062015-10-21 18:06:47 +00005017 CharUnits baseOffset;
John McCall460ce582015-10-22 18:38:17 +00005018 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Jordy Rosea91768e2011-07-22 02:08:32 +00005019 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005020 IVD; IVD = IVD->getNextIvar())
John McCall3fd13f062015-10-21 18:06:47 +00005021 ivars.push_back(IVD);
5022
5023 if (isNonFragileABI()) {
5024 baseOffset = beginOffset; // InstanceStart
John McCalld80218f2015-11-19 02:27:55 +00005025 } else if (!ivars.empty()) {
5026 baseOffset =
5027 CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivars[0]));
John McCall3fd13f062015-10-21 18:06:47 +00005028 } else {
5029 baseOffset = CharUnits::Zero();
5030 }
John McCallf5ea0722015-10-29 23:36:14 +00005031
Rui Ueyama83aa9792016-01-14 21:00:27 +00005032 baseOffset = baseOffset.alignTo(CGM.getPointerAlign());
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005033 }
5034 else {
John McCall3fd13f062015-10-21 18:06:47 +00005035 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005036
John McCall3fd13f062015-10-21 18:06:47 +00005037 baseOffset = CharUnits::Zero();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005038 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005039
John McCall3fd13f062015-10-21 18:06:47 +00005040 if (ivars.empty())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005041 return llvm::Constant::getNullValue(PtrTy);
5042
John McCall3fd13f062015-10-21 18:06:47 +00005043 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005044
John McCall3fd13f062015-10-21 18:06:47 +00005045 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
5046 [&](const ObjCIvarDecl *ivar) -> CharUnits {
5047 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
5048 });
5049
5050 if (!builder.hasBitmapData())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005051 return llvm::Constant::getNullValue(PtrTy);
John McCall3fd13f062015-10-21 18:06:47 +00005052
5053 llvm::SmallVector<unsigned char, 4> buffer;
5054 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005055
John McCallf5ea0722015-10-29 23:36:14 +00005056 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005057 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005058 ForStrongLayout ? "strong" : "weak",
Ben Langmuire013bdc2014-07-11 00:43:47 +00005059 OMD->getClassInterface()->getName().str().c_str());
John McCall3fd13f062015-10-21 18:06:47 +00005060 builder.dump(buffer);
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005061 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005062 return C;
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00005063}
5064
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005065llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005066 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
5067
Chris Lattner3def9ae2012-02-06 22:16:34 +00005068 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005069 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005070 Entry = CreateMetadataVar(
5071 "OBJC_METH_VAR_NAME_",
5072 llvm::ConstantDataArray::getString(VMContext, Sel.getAsString()),
5073 ((ObjCABI == 2) ? "__TEXT,__objc_methname,cstring_literals"
5074 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005075 CharUnits::One(), true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005076
Owen Anderson170229f2009-07-14 23:10:40 +00005077 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005078}
5079
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005080// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005081llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005082 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
5083}
5084
Daniel Dunbarf5c18462009-04-20 06:54:31 +00005085llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005086 std::string TypeStr;
5087 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
5088
5089 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbarb036db82008-08-13 03:21:16 +00005090
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005091 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005092 Entry = CreateMetadataVar(
5093 "OBJC_METH_VAR_TYPE_",
5094 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5095 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5096 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005097 CharUnits::One(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005098
Owen Anderson170229f2009-07-14 23:10:40 +00005099 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005100}
5101
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005102llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
5103 bool Extended) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005104 std::string TypeStr;
Bill Wendlinge22bef72012-02-09 22:45:21 +00005105 if (CGM.getContext().getObjCEncodingForMethodDecl(D, TypeStr, Extended))
Craig Topper8a13c412014-05-21 05:09:00 +00005106 return nullptr;
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005107
5108 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
5109
Daniel Dunbar3241fae2009-04-14 23:14:47 +00005110 if (!Entry)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005111 Entry = CreateMetadataVar(
5112 "OBJC_METH_VAR_TYPE_",
5113 llvm::ConstantDataArray::getString(VMContext, TypeStr),
5114 ((ObjCABI == 2) ? "__TEXT,__objc_methtype,cstring_literals"
5115 : "__TEXT,__cstring,cstring_literals"),
John McCall7f416cc2015-09-08 08:05:57 +00005116 CharUnits::One(), true);
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005117
Owen Anderson170229f2009-07-14 23:10:40 +00005118 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005119}
5120
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005121// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005122llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005123 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005124
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005125 if (!Entry)
Alp Toker541d5072014-06-07 23:30:53 +00005126 Entry = CreateMetadataVar(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005127 "OBJC_PROP_NAME_ATTR_",
Alp Toker541d5072014-06-07 23:30:53 +00005128 llvm::ConstantDataArray::getString(VMContext, Ident->getName()),
John McCall7f416cc2015-09-08 08:05:57 +00005129 "__TEXT,__cstring,cstring_literals", CharUnits::One(), true);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005130
Owen Anderson170229f2009-07-14 23:10:40 +00005131 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005132}
5133
5134// FIXME: Merge into a single cstring creation function.
Daniel Dunbar4932b362008-08-28 04:38:10 +00005135// FIXME: This Decl should be more precise.
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005136llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005137CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
5138 const Decl *Container) {
Daniel Dunbar4932b362008-08-28 04:38:10 +00005139 std::string TypeStr;
5140 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container, TypeStr);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005141 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
5142}
5143
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005144void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005145 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005146 SmallVectorImpl<char> &Name) {
Daniel Dunbard2386812009-10-19 01:21:19 +00005147 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00005148 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbard2386812009-10-19 01:21:19 +00005149 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
5150 << '[' << CD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005151 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbard2386812009-10-19 01:21:19 +00005152 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramer2f569922012-02-07 11:57:45 +00005153 OS << '(' << *CID << ')';
Daniel Dunbard2386812009-10-19 01:21:19 +00005154 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbara94ecd22008-08-16 03:19:19 +00005155}
5156
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005157void CGObjCMac::FinishModule() {
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005158 EmitModuleInfo();
5159
Daniel Dunbarc475d422008-10-29 22:36:39 +00005160 // Emit the dummy bodies for any protocols which were referenced but
5161 // never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005162 for (llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*>::iterator
Chris Lattnerf56501c2009-07-17 23:57:13 +00005163 I = Protocols.begin(), e = Protocols.end(); I != e; ++I) {
5164 if (I->second->hasInitializer())
Daniel Dunbarc475d422008-10-29 22:36:39 +00005165 continue;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005166
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005167 llvm::Constant *Values[5];
Owen Anderson0b75f232009-07-31 20:28:54 +00005168 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005169 Values[1] = GetClassName(I->first->getName());
Owen Anderson0b75f232009-07-31 20:28:54 +00005170 Values[2] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005171 Values[3] = Values[4] =
Owen Anderson0b75f232009-07-31 20:28:54 +00005172 llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00005173 I->second->setInitializer(llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarc475d422008-10-29 22:36:39 +00005174 Values));
Rafael Espindola060062a2014-03-06 22:15:10 +00005175 CGM.addCompilerUsedGlobal(I->second);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005176 }
5177
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005178 // Add assembler directives to add lazy undefined symbol references
5179 // for classes which are referenced but not defined. This is
5180 // important for correct linker interaction.
Daniel Dunbard027a922009-09-07 00:20:42 +00005181 //
5182 // FIXME: It would be nice if we had an LLVM construct for this.
5183 if (!LazySymbols.empty() || !DefinedSymbols.empty()) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005184 SmallString<256> Asm;
Daniel Dunbard027a922009-09-07 00:20:42 +00005185 Asm += CGM.getModule().getModuleInlineAsm();
5186 if (!Asm.empty() && Asm.back() != '\n')
5187 Asm += '\n';
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005188
Daniel Dunbard027a922009-09-07 00:20:42 +00005189 llvm::raw_svector_ostream OS(Asm);
Daniel Dunbard027a922009-09-07 00:20:42 +00005190 for (llvm::SetVector<IdentifierInfo*>::iterator I = DefinedSymbols.begin(),
5191 e = DefinedSymbols.end(); I != e; ++I)
Daniel Dunbar07d07852009-10-18 21:17:35 +00005192 OS << "\t.objc_class_name_" << (*I)->getName() << "=0\n"
5193 << "\t.globl .objc_class_name_" << (*I)->getName() << "\n";
Chris Lattnera299f2c2010-04-17 18:26:20 +00005194 for (llvm::SetVector<IdentifierInfo*>::iterator I = LazySymbols.begin(),
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005195 e = LazySymbols.end(); I != e; ++I) {
Chris Lattnera299f2c2010-04-17 18:26:20 +00005196 OS << "\t.lazy_reference .objc_class_name_" << (*I)->getName() << "\n";
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005197 }
5198
Bill Wendling53136852012-02-07 09:06:01 +00005199 for (size_t i = 0, e = DefinedCategoryNames.size(); i < e; ++i) {
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005200 OS << "\t.objc_category_name_" << DefinedCategoryNames[i] << "=0\n"
5201 << "\t.globl .objc_category_name_" << DefinedCategoryNames[i] << "\n";
5202 }
Chris Lattnera299f2c2010-04-17 18:26:20 +00005203
Daniel Dunbard027a922009-09-07 00:20:42 +00005204 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005205 }
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005206}
5207
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005208CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005209 : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00005210 ObjCTypes(cgm) {
Craig Topper8a13c412014-05-21 05:09:00 +00005211 ObjCEmptyCacheVar = ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005212 ObjCABI = 2;
5213}
5214
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005215/* *** */
5216
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005217ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Craig Topper8a13c412014-05-21 05:09:00 +00005218 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregora95f9aa2012-01-17 23:38:32 +00005219{
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005220 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5221 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005222
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005223 ShortTy = Types.ConvertType(Ctx.ShortTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005224 IntTy = Types.ConvertType(Ctx.IntTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005225 LongTy = Types.ConvertType(Ctx.LongTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00005226 LongLongTy = Types.ConvertType(Ctx.LongLongTy);
Chris Lattnerece04092012-02-07 00:39:47 +00005227 Int8PtrTy = CGM.Int8PtrTy;
5228 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005229
Tim Northover238b5082014-03-29 13:42:40 +00005230 // arm64 targets use "int" ivar offset variables. All others,
5231 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Tim Northover40956e62014-07-23 12:32:58 +00005232 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Tim Northover238b5082014-03-29 13:42:40 +00005233 IvarOffsetVarTy = IntTy;
5234 else
5235 IvarOffsetVarTy = LongTy;
5236
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005237 ObjectPtrTy = Types.ConvertType(Ctx.getObjCIdType());
Owen Anderson9793f0e2009-07-29 22:16:19 +00005238 PtrObjectPtrTy = llvm::PointerType::getUnqual(ObjectPtrTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005239 SelectorPtrTy = Types.ConvertType(Ctx.getObjCSelType());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005240
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005241 // I'm not sure I like this. The implicit coordination is a bit
5242 // gross. We should solve this in a reasonable fashion because this
5243 // is a pretty common task (match some runtime data structure with
5244 // an LLVM data structure).
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005245
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005246 // FIXME: This is leaked.
5247 // FIXME: Merge with rewriter code?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005248
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005249 // struct _objc_super {
5250 // id self;
5251 // Class cls;
5252 // }
Abramo Bagnara6150c882010-05-11 21:36:43 +00005253 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005254 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005255 SourceLocation(), SourceLocation(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005256 &Ctx.Idents.get("_objc_super"));
Craig Topper8a13c412014-05-21 05:09:00 +00005257 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5258 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5259 false, ICIS_NoInit));
5260 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5261 nullptr, Ctx.getObjCClassType(), nullptr,
5262 nullptr, false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005263 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005264
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005265 SuperCTy = Ctx.getTagDeclType(RD);
5266 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005267
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005268 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005269 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5270
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005271 // struct _prop_t {
5272 // char *name;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005273 // char *attributes;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005274 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005275 PropertyTy = llvm::StructType::create("struct._prop_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005276 Int8PtrTy, Int8PtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005277
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005278 // struct _prop_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005279 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005280 // uint32_t count_of_properties;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005281 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005282 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005283 PropertyListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005284 llvm::StructType::create("struct._prop_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005285 llvm::ArrayType::get(PropertyTy, 0), nullptr);
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005286 // struct _prop_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005287 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005288
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005289 // struct _objc_method {
5290 // SEL _cmd;
5291 // char *method_type;
5292 // char *_imp;
5293 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005294 MethodTy = llvm::StructType::create("struct._objc_method",
5295 SelectorPtrTy, Int8PtrTy, Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005296 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005297
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005298 // struct _objc_cache *
Chris Lattner5ec04a52011-08-12 17:43:31 +00005299 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005300 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005301}
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005302
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005303ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005304 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005305 // struct _objc_method_description {
5306 // SEL name;
5307 // char *types;
5308 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005309 MethodDescriptionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005310 llvm::StructType::create("struct._objc_method_description",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005311 SelectorPtrTy, Int8PtrTy, nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005312
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005313 // struct _objc_method_description_list {
5314 // int count;
5315 // struct _objc_method_description[1];
5316 // }
Reid Kleckneree7cf842014-12-01 22:02:27 +00005317 MethodDescriptionListTy = llvm::StructType::create(
5318 "struct._objc_method_description_list", IntTy,
5319 llvm::ArrayType::get(MethodDescriptionTy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005320
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005321 // struct _objc_method_description_list *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005322 MethodDescriptionListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005323 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005324
Daniel Dunbarb036db82008-08-13 03:21:16 +00005325 // Protocol description structures
5326
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005327 // struct _objc_protocol_extension {
5328 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5329 // struct _objc_method_description_list *optional_instance_methods;
5330 // struct _objc_method_description_list *optional_class_methods;
5331 // struct _objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005332 // const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00005333 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005334 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005335 ProtocolExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005336 llvm::StructType::create("struct._objc_protocol_extension",
5337 IntTy, MethodDescriptionListPtrTy,
5338 MethodDescriptionListPtrTy, PropertyListPtrTy,
Manman Rence7bff52016-01-29 23:46:55 +00005339 Int8PtrPtrTy, PropertyListPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005340
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005341 // struct _objc_protocol_extension *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005342 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005343
Daniel Dunbarc475d422008-10-29 22:36:39 +00005344 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbarb036db82008-08-13 03:21:16 +00005345
Chris Lattnera5f58b02011-07-09 17:41:47 +00005346 ProtocolTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005347 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbarb036db82008-08-13 03:21:16 +00005348
Chris Lattnera5f58b02011-07-09 17:41:47 +00005349 ProtocolListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005350 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005351 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy),
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005352 LongTy,
Chris Lattnera5f58b02011-07-09 17:41:47 +00005353 llvm::ArrayType::get(ProtocolTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005354 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005355
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005356 // struct _objc_protocol {
5357 // struct _objc_protocol_extension *isa;
5358 // char *protocol_name;
5359 // struct _objc_protocol **_objc_protocol_list;
5360 // struct _objc_method_description_list *instance_methods;
5361 // struct _objc_method_description_list *class_methods;
5362 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005363 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5364 llvm::PointerType::getUnqual(ProtocolListTy),
5365 MethodDescriptionListPtrTy,
5366 MethodDescriptionListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005367 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005368
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005369 // struct _objc_protocol_list *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005370 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005371
Owen Anderson9793f0e2009-07-29 22:16:19 +00005372 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005373
5374 // Class description structures
5375
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005376 // struct _objc_ivar {
5377 // char *ivar_name;
5378 // char *ivar_type;
5379 // int ivar_offset;
5380 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005381 IvarTy = llvm::StructType::create("struct._objc_ivar",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005382 Int8PtrTy, Int8PtrTy, IntTy, nullptr);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005383
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005384 // struct _objc_ivar_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005385 IvarListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005386 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005387 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005388
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005389 // struct _objc_method_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005390 MethodListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005391 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005392 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005393
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005394 // struct _objc_class_extension *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005395 ClassExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005396 llvm::StructType::create("struct._objc_class_extension",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005397 IntTy, Int8PtrTy, PropertyListPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005398 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005399
Chris Lattner5ec04a52011-08-12 17:43:31 +00005400 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005401
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005402 // struct _objc_class {
5403 // Class isa;
5404 // Class super_class;
5405 // char *name;
5406 // long version;
5407 // long info;
5408 // long instance_size;
5409 // struct _objc_ivar_list *ivars;
5410 // struct _objc_method_list *methods;
5411 // struct _objc_cache *cache;
5412 // struct _objc_protocol_list *protocols;
5413 // char *ivar_layout;
5414 // struct _objc_class_ext *ext;
5415 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005416 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
5417 llvm::PointerType::getUnqual(ClassTy),
5418 Int8PtrTy,
5419 LongTy,
5420 LongTy,
5421 LongTy,
5422 IvarListPtrTy,
5423 MethodListPtrTy,
5424 CachePtrTy,
5425 ProtocolListPtrTy,
5426 Int8PtrTy,
5427 ClassExtensionPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005428 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005429
Owen Anderson9793f0e2009-07-29 22:16:19 +00005430 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005431
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005432 // struct _objc_category {
5433 // char *category_name;
5434 // char *class_name;
5435 // struct _objc_method_list *instance_method;
5436 // struct _objc_method_list *class_method;
Manman Renb3736772016-01-25 22:37:47 +00005437 // struct _objc_protocol_list *protocols;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005438 // uint32_t size; // sizeof(struct _objc_category)
5439 // struct _objc_property_list *instance_properties;// category's @property
Manman Ren96df0b32016-01-29 23:45:01 +00005440 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005441 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005442 CategoryTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005443 llvm::StructType::create("struct._objc_category",
5444 Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5445 MethodListPtrTy, ProtocolListPtrTy,
Manman Ren96df0b32016-01-29 23:45:01 +00005446 IntTy, PropertyListPtrTy, PropertyListPtrTy,
5447 nullptr);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005448
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005449 // Global metadata structures
5450
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005451 // struct _objc_symtab {
5452 // long sel_ref_cnt;
5453 // SEL *refs;
5454 // short cls_def_cnt;
5455 // short cat_def_cnt;
5456 // char *defs[cls_def_cnt + cat_def_cnt];
5457 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005458 SymtabTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005459 llvm::StructType::create("struct._objc_symtab",
5460 LongTy, SelectorPtrTy, ShortTy, ShortTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005461 llvm::ArrayType::get(Int8PtrTy, 0), nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005462 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005463
Fariborz Jahanianeee54df2009-01-22 00:37:21 +00005464 // struct _objc_module {
5465 // long version;
5466 // long size; // sizeof(struct _objc_module)
5467 // char *name;
5468 // struct _objc_symtab* symtab;
5469 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005470 ModuleTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005471 llvm::StructType::create("struct._objc_module",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005472 LongTy, LongTy, Int8PtrTy, SymtabPtrTy, nullptr);
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00005473
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005474
Mike Stump18bb9282009-05-16 07:57:57 +00005475 // FIXME: This is the size of the setjmp buffer and should be target
5476 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson9ff22482008-09-09 10:10:21 +00005477 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005478
Anders Carlsson9ff22482008-09-09 10:10:21 +00005479 // Exceptions
Chris Lattnerece04092012-02-07 00:39:47 +00005480 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005481
5482 ExceptionDataTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005483 llvm::StructType::create("struct._objc_exception_data",
Chris Lattnerece04092012-02-07 00:39:47 +00005484 llvm::ArrayType::get(CGM.Int32Ty,SetJmpBufferSize),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005485 StackPtrTy, nullptr);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005486}
5487
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005488ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005489 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005490 // struct _method_list_t {
5491 // uint32_t entsize; // sizeof(struct _objc_method)
5492 // uint32_t method_count;
5493 // struct _objc_method method_list[method_count];
5494 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005495 MethodListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005496 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005497 llvm::ArrayType::get(MethodTy, 0), nullptr);
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005498 // struct method_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005499 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005500
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005501 // struct _protocol_t {
5502 // id isa; // NULL
5503 // const char * const protocol_name;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005504 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005505 // const struct method_list_t * const instance_methods;
5506 // const struct method_list_t * const class_methods;
5507 // const struct method_list_t *optionalInstanceMethods;
5508 // const struct method_list_t *optionalClassMethods;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005509 // const struct _prop_list_t * properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005510 // const uint32_t size; // sizeof(struct _protocol_t)
5511 // const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005512 // const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005513 // const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00005514 // const struct _prop_list_t * class_properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005515 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005516
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005517 // Holder for struct _protocol_list_t *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005518 ProtocolListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005519 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005520
Chris Lattnera5f58b02011-07-09 17:41:47 +00005521 ProtocolnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005522 llvm::StructType::create("struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5523 llvm::PointerType::getUnqual(ProtocolListnfABITy),
5524 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5525 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005526 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy,
Manman Rence7bff52016-01-29 23:46:55 +00005527 Int8PtrTy, PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005528 nullptr);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005529
5530 // struct _protocol_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005531 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005532
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005533 // struct _protocol_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005534 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005535 // struct _protocol_t *[protocol_count];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005536 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005537 ProtocolListnfABITy->setBody(LongTy,
5538 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005539 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005540
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005541 // struct _objc_protocol_list*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005542 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005543
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005544 // struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00005545 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005546 // char *name;
5547 // char *type;
5548 // uint32_t alignment;
5549 // uint32_t size;
5550 // }
Tim Northover238b5082014-03-29 13:42:40 +00005551 IvarnfABITy = llvm::StructType::create(
5552 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005553 Int8PtrTy, Int8PtrTy, IntTy, IntTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005554
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005555 // struct _ivar_list_t {
5556 // uint32 entsize; // sizeof(struct _ivar_t)
5557 // uint32 count;
5558 // struct _iver_t list[count];
5559 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005560 IvarListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005561 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005562 llvm::ArrayType::get(IvarnfABITy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005563
Owen Anderson9793f0e2009-07-29 22:16:19 +00005564 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005565
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005566 // struct _class_ro_t {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005567 // uint32_t const flags;
5568 // uint32_t const instanceStart;
5569 // uint32_t const instanceSize;
5570 // uint32_t const reserved; // only when building for 64bit targets
5571 // const uint8_t * const ivarLayout;
5572 // const char *const name;
5573 // const struct _method_list_t * const baseMethods;
5574 // const struct _objc_protocol_list *const baseProtocols;
5575 // const struct _ivar_list_t *const ivars;
5576 // const uint8_t * const weakIvarLayout;
5577 // const struct _prop_list_t * const properties;
5578 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005579
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005580 // FIXME. Add 'reserved' field in 64bit abi mode!
Chris Lattner5ec04a52011-08-12 17:43:31 +00005581 ClassRonfABITy = llvm::StructType::create("struct._class_ro_t",
5582 IntTy, IntTy, IntTy, Int8PtrTy,
5583 Int8PtrTy, MethodListnfABIPtrTy,
5584 ProtocolListnfABIPtrTy,
5585 IvarListnfABIPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005586 Int8PtrTy, PropertyListPtrTy,
5587 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005588
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005589 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +00005590 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +00005591 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5592 ->getPointerTo();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005593
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005594 // struct _class_t {
5595 // struct _class_t *isa;
5596 // struct _class_t * const superclass;
5597 // void *cache;
5598 // IMP *vtable;
5599 // struct class_ro_t *ro;
5600 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005601
Chris Lattner5ec04a52011-08-12 17:43:31 +00005602 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005603 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
5604 llvm::PointerType::getUnqual(ClassnfABITy),
5605 CachePtrTy,
5606 llvm::PointerType::getUnqual(ImpnfABITy),
5607 llvm::PointerType::getUnqual(ClassRonfABITy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005608 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005609
Fariborz Jahanian71394042009-01-23 23:53:38 +00005610 // LLVM for struct _class_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005611 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005612
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005613 // struct _category_t {
5614 // const char * const name;
5615 // struct _class_t *const cls;
5616 // const struct _method_list_t * const instance_methods;
5617 // const struct _method_list_t * const class_methods;
5618 // const struct _protocol_list_t * const protocols;
5619 // const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00005620 // const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00005621 // const uint32_t size;
Fariborz Jahanian5a63e4c2009-01-23 17:41:22 +00005622 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005623 CategorynfABITy = llvm::StructType::create("struct._category_t",
5624 Int8PtrTy, ClassnfABIPtrTy,
5625 MethodListnfABIPtrTy,
5626 MethodListnfABIPtrTy,
5627 ProtocolListnfABIPtrTy,
5628 PropertyListPtrTy,
Manman Ren96df0b32016-01-29 23:45:01 +00005629 PropertyListPtrTy,
Manman Ren42ff3902016-02-24 17:49:50 +00005630 IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005631 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005632
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005633 // New types for nonfragile abi messaging.
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005634 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5635 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005636
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005637 // MessageRefTy - LLVM for:
5638 // struct _message_ref_t {
5639 // IMP messenger;
5640 // SEL name;
5641 // };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005642
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005643 // First the clang type for struct _message_ref_t
Abramo Bagnara6150c882010-05-11 21:36:43 +00005644 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005645 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005646 SourceLocation(), SourceLocation(),
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005647 &Ctx.Idents.get("_message_ref_t"));
Craig Topper8a13c412014-05-21 05:09:00 +00005648 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5649 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smith2b013182012-06-10 03:12:00 +00005650 ICIS_NoInit));
Craig Topper8a13c412014-05-21 05:09:00 +00005651 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5652 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5653 false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005654 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005655
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005656 MessageRefCTy = Ctx.getTagDeclType(RD);
5657 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5658 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005659
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005660 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005661 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005662
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005663 // SuperMessageRefTy - LLVM for:
5664 // struct _super_message_ref_t {
5665 // SUPER_IMP messenger;
5666 // SEL name;
5667 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005668 SuperMessageRefTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005669 llvm::StructType::create("struct._super_message_ref_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005670 ImpnfABITy, SelectorPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005671
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005672 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005673 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005674
Daniel Dunbarb1559a42009-03-01 04:46:24 +00005675
5676 // struct objc_typeinfo {
5677 // const void** vtable; // objc_ehtype_vtable + 2
5678 // const char* name; // c++ typeinfo string
5679 // Class cls;
5680 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005681 EHTypeTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005682 llvm::StructType::create("struct._objc_typeinfo",
5683 llvm::PointerType::getUnqual(Int8PtrTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005684 Int8PtrTy, ClassnfABIPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005685 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005686}
5687
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005688llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanian71394042009-01-23 23:53:38 +00005689 FinishNonFragileABIModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005690
Craig Topper8a13c412014-05-21 05:09:00 +00005691 return nullptr;
Fariborz Jahanian71394042009-01-23 23:53:38 +00005692}
5693
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00005694void CGObjCNonFragileABIMac::AddModuleClassList(
5695 ArrayRef<llvm::GlobalValue *> Container, StringRef SymbolName,
5696 StringRef SectionName) {
Daniel Dunbar19573e72009-05-15 21:48:48 +00005697 unsigned NumClasses = Container.size();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005698
Daniel Dunbar19573e72009-05-15 21:48:48 +00005699 if (!NumClasses)
5700 return;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005701
Chris Lattner3def9ae2012-02-06 22:16:34 +00005702 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005703 for (unsigned i=0; i<NumClasses; i++)
Owen Andersonade90fd2009-07-29 18:54:39 +00005704 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar19573e72009-05-15 21:48:48 +00005705 ObjCTypes.Int8PtrTy);
Chris Lattner3def9ae2012-02-06 22:16:34 +00005706 llvm::Constant *Init =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005707 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00005708 Symbols.size()),
Daniel Dunbar19573e72009-05-15 21:48:48 +00005709 Symbols);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005710
Daniel Dunbar19573e72009-05-15 21:48:48 +00005711 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00005712 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005713 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar19573e72009-05-15 21:48:48 +00005714 Init,
Owen Andersonc10c8d32009-07-08 19:05:04 +00005715 SymbolName);
Micah Villmowdd31ca12012-10-08 16:25:52 +00005716 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar19573e72009-05-15 21:48:48 +00005717 GV->setSection(SectionName);
Rafael Espindola060062a2014-03-06 22:15:10 +00005718 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005719}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005720
Fariborz Jahanian71394042009-01-23 23:53:38 +00005721void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
5722 // nonfragile abi has no module definition.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005723
Daniel Dunbar19573e72009-05-15 21:48:48 +00005724 // Build list of all implemented class addresses in array
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005725 // L_OBJC_LABEL_CLASS_$.
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005726
5727 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
5728 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5729 assert(ID);
5730 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5731 // We are implementing a weak imported interface. Give it external linkage
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005732 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005733 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005734 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
5735 }
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005736 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005737
5738 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005739 "__DATA, __objc_classlist, regular, no_dead_strip");
Rafael Espindola554256c2014-02-26 22:25:45 +00005740
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005741 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005742 "__DATA, __objc_nlclslist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005743
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005744 // Build list of all implemented category addresses in array
5745 // L_OBJC_LABEL_CATEGORY_$.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005746 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005747 "__DATA, __objc_catlist, regular, no_dead_strip");
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005748 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005749 "__DATA, __objc_nlcatlist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005750
Daniel Dunbar5e639272010-04-25 20:39:01 +00005751 EmitImageInfo();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005752}
5753
John McCall9e8bb002011-05-14 03:10:52 +00005754/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
5755/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005756/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005757/// message dispatch call for all the rest.
John McCall9e8bb002011-05-14 03:10:52 +00005758bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
5759 // At various points we've experimented with using vtable-based
5760 // dispatch for all methods.
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005761 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005762 case CodeGenOptions::Legacy:
Fariborz Jahaniandfb39832010-04-19 17:53:30 +00005763 return false;
John McCall9e8bb002011-05-14 03:10:52 +00005764 case CodeGenOptions::NonLegacy:
5765 return true;
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005766 case CodeGenOptions::Mixed:
5767 break;
5768 }
5769
5770 // If so, see whether this selector is in the white-list of things which must
5771 // use the new dispatch convention. We lazily build a dense set for this.
John McCall9e8bb002011-05-14 03:10:52 +00005772 if (VTableDispatchMethods.empty()) {
5773 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
5774 VTableDispatchMethods.insert(GetNullarySelector("class"));
5775 VTableDispatchMethods.insert(GetNullarySelector("self"));
5776 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
5777 VTableDispatchMethods.insert(GetNullarySelector("length"));
5778 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005779
John McCall9e8bb002011-05-14 03:10:52 +00005780 // These are vtable-based if GC is disabled.
5781 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005782 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall9e8bb002011-05-14 03:10:52 +00005783 VTableDispatchMethods.insert(GetNullarySelector("retain"));
5784 VTableDispatchMethods.insert(GetNullarySelector("release"));
5785 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
5786 }
5787
5788 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
5789 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
5790 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
5791 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
5792 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
5793 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
5794 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
5795
5796 // These are vtable-based if GC is enabled.
5797 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005798 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall9e8bb002011-05-14 03:10:52 +00005799 VTableDispatchMethods.insert(GetNullarySelector("hash"));
5800 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
5801
5802 // "countByEnumeratingWithState:objects:count"
5803 IdentifierInfo *KeyIdents[] = {
5804 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
5805 &CGM.getContext().Idents.get("objects"),
5806 &CGM.getContext().Idents.get("count")
5807 };
5808 VTableDispatchMethods.insert(
5809 CGM.getContext().Selectors.getSelector(3, KeyIdents));
5810 }
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005811 }
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005812
John McCall9e8bb002011-05-14 03:10:52 +00005813 return VTableDispatchMethods.count(Sel);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005814}
5815
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005816/// BuildClassRoTInitializer - generate meta-data for:
5817/// struct _class_ro_t {
5818/// uint32_t const flags;
5819/// uint32_t const instanceStart;
5820/// uint32_t const instanceSize;
5821/// uint32_t const reserved; // only when building for 64bit targets
5822/// const uint8_t * const ivarLayout;
5823/// const char *const name;
5824/// const struct _method_list_t * const baseMethods;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005825/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005826/// const struct _ivar_list_t *const ivars;
5827/// const uint8_t * const weakIvarLayout;
5828/// const struct _prop_list_t * const properties;
5829/// }
5830///
5831llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005832 unsigned flags,
5833 unsigned InstanceStart,
5834 unsigned InstanceSize,
5835 const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005836 std::string ClassName = ID->getObjCRuntimeNameAsString();
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005837 llvm::Constant *Values[10]; // 11 for 64bit targets!
John McCall31168b02011-06-15 23:02:42 +00005838
John McCall3fd13f062015-10-21 18:06:47 +00005839 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
5840 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
5841
John McCall460ce582015-10-22 18:38:17 +00005842 bool hasMRCWeak = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005843 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallef19dbb2012-10-17 04:53:23 +00005844 flags |= NonFragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00005845 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
5846 flags |= NonFragileABI_Class_HasMRCWeakIvars;
John McCall31168b02011-06-15 23:02:42 +00005847
Owen Andersonb7a2fe62009-07-24 23:12:58 +00005848 Values[ 0] = llvm::ConstantInt::get(ObjCTypes.IntTy, flags);
5849 Values[ 1] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceStart);
5850 Values[ 2] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceSize);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005851 // FIXME. For 64bit targets add 0 here.
John McCallef19dbb2012-10-17 04:53:23 +00005852 Values[ 3] = (flags & NonFragileABI_Class_Meta)
Craig Topper8a13c412014-05-21 05:09:00 +00005853 ? GetIvarLayoutName(nullptr, ObjCTypes)
John McCall460ce582015-10-22 18:38:17 +00005854 : BuildStrongIvarLayout(ID, beginInstance, endInstance);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005855 Values[ 4] = GetClassName(ID->getObjCRuntimeNameAsString());
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005856 // const struct _method_list_t * const baseMethods;
5857 std::vector<llvm::Constant*> Methods;
5858 std::string MethodListName("\01l_OBJC_$_");
John McCallef19dbb2012-10-17 04:53:23 +00005859 if (flags & NonFragileABI_Class_Meta) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005860 MethodListName += "CLASS_METHODS_";
5861 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005862 for (const auto *I : ID->class_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005863 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005864 Methods.push_back(GetMethodConstant(I));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005865 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005866 MethodListName += "INSTANCE_METHODS_";
5867 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005868 for (const auto *I : ID->instance_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005869 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005870 Methods.push_back(GetMethodConstant(I));
5871
Aaron Ballmand85eff42014-03-14 15:02:45 +00005872 for (const auto *PID : ID->property_impls()) {
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005873 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
5874 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005875
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005876 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
5877 if (llvm::Constant *C = GetMethodConstant(MD))
5878 Methods.push_back(C);
5879 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
5880 if (llvm::Constant *C = GetMethodConstant(MD))
5881 Methods.push_back(C);
5882 }
5883 }
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005884 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005885 Values[ 5] = EmitMethodList(MethodListName,
5886 "__DATA, __objc_const", Methods);
5887
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005888 const ObjCInterfaceDecl *OID = ID->getClassInterface();
5889 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005890 Values[ 6] = EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005891 + OID->getObjCRuntimeNameAsString(),
Ted Kremenek0ef508d2010-09-01 01:21:15 +00005892 OID->all_referenced_protocol_begin(),
5893 OID->all_referenced_protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005894
John McCallef19dbb2012-10-17 04:53:23 +00005895 if (flags & NonFragileABI_Class_Meta) {
Owen Anderson0b75f232009-07-31 20:28:54 +00005896 Values[ 7] = llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00005897 Values[ 8] = GetIvarLayoutName(nullptr, ObjCTypes);
Manman Renad0e7912016-01-29 19:22:54 +00005898 Values[ 9] = EmitPropertyList(
5899 "\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
5900 ID, ID->getClassInterface(), ObjCTypes, true);
John McCallef19dbb2012-10-17 04:53:23 +00005901 } else {
5902 Values[ 7] = EmitIvarList(ID);
John McCall460ce582015-10-22 18:38:17 +00005903 Values[ 8] = BuildWeakIvarLayout(ID, beginInstance, endInstance,
5904 hasMRCWeak);
Manman Renad0e7912016-01-29 19:22:54 +00005905 Values[ 9] = EmitPropertyList(
5906 "\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
5907 ID, ID->getClassInterface(), ObjCTypes, false);
John McCallef19dbb2012-10-17 04:53:23 +00005908 }
Owen Anderson0e0189d2009-07-27 22:29:56 +00005909 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassRonfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005910 Values);
5911 llvm::GlobalVariable *CLASS_RO_GV =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005912 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassRonfABITy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005913 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005914 Init,
John McCallef19dbb2012-10-17 04:53:23 +00005915 (flags & NonFragileABI_Class_Meta) ?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005916 std::string("\01l_OBJC_METACLASS_RO_$_")+ClassName :
5917 std::string("\01l_OBJC_CLASS_RO_$_")+ClassName);
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005918 CLASS_RO_GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005919 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassRonfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00005920 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005921 return CLASS_RO_GV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00005922
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005923}
5924
5925/// BuildClassMetaData - This routine defines that to-level meta-data
5926/// for the given ClassName for:
5927/// struct _class_t {
5928/// struct _class_t *isa;
5929/// struct _class_t * const superclass;
5930/// void *cache;
5931/// IMP *vtable;
5932/// struct class_ro_t *ro;
5933/// }
5934///
Rafael Espindola554256c2014-02-26 22:25:45 +00005935llvm::GlobalVariable *CGObjCNonFragileABIMac::BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005936 const std::string &ClassName, llvm::Constant *IsAGV, llvm::Constant *SuperClassGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00005937 llvm::Constant *ClassRoGV, bool HiddenVisibility, bool Weak) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005938 llvm::Constant *Values[] = {
5939 IsAGV,
5940 SuperClassGV,
5941 ObjCEmptyCacheVar, // &ObjCEmptyCacheVar
5942 ObjCEmptyVtableVar, // &ObjCEmptyVtableVar
5943 ClassRoGV // &CLASS_RO_GV
5944 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005945 if (!Values[1])
5946 Values[1] = llvm::Constant::getNullValue(ObjCTypes.ClassnfABIPtrTy);
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005947 if (!Values[3])
5948 Values[3] = llvm::Constant::getNullValue(
5949 llvm::PointerType::getUnqual(ObjCTypes.ImpnfABITy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005950 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassnfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005951 Values);
Rafael Espindola554256c2014-02-26 22:25:45 +00005952 llvm::GlobalVariable *GV = GetClassGlobal(ClassName, Weak);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00005953 GV->setInitializer(Init);
Fariborz Jahanian04087232009-01-31 01:07:39 +00005954 GV->setSection("__DATA, __objc_data");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005955 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005956 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Fariborz Jahanian82208252009-01-31 00:59:10 +00005957 if (HiddenVisibility)
5958 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005959 return GV;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005960}
5961
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005962bool
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00005963CGObjCNonFragileABIMac::ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
Craig Topper8a13c412014-05-21 05:09:00 +00005964 return OD->getClassMethod(GetNullarySelector("load")) != nullptr;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005965}
5966
Daniel Dunbar961202372009-05-03 12:57:56 +00005967void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00005968 uint32_t &InstanceStart,
5969 uint32_t &InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005970 const ASTRecordLayout &RL =
Daniel Dunbar9252ee12009-05-04 21:26:30 +00005971 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005972
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005973 // InstanceSize is really instance end.
Ken Dyckd5090c12011-02-11 02:20:09 +00005974 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005975
5976 // If there are no fields, the start is the same as the end.
5977 if (!RL.getFieldCount())
5978 InstanceStart = InstanceSize;
5979 else
Ken Dyckc5ca8762011-04-14 00:43:09 +00005980 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbar554fd792009-04-19 23:41:48 +00005981}
5982
Fariborz Jahanian71394042009-01-23 23:53:38 +00005983void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005984 std::string ClassName = ID->getObjCRuntimeNameAsString();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005985 if (!ObjCEmptyCacheVar) {
5986 ObjCEmptyCacheVar = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005987 CGM.getModule(),
5988 ObjCTypes.CacheTy,
5989 false,
5990 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00005991 nullptr,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005992 "_objc_empty_cache");
Craig Topper8a13c412014-05-21 05:09:00 +00005993
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005994 // Make this entry NULL for any iOS device target, any iOS simulator target,
5995 // OS X with deployment target 10.9 or later.
5996 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00005997 if (Triple.isiOS() || Triple.isWatchOS() ||
5998 (Triple.isMacOSX() && !Triple.isMacOSXVersionLT(10, 9)))
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005999 // This entry will be null.
Craig Topper8a13c412014-05-21 05:09:00 +00006000 ObjCEmptyVtableVar = nullptr;
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006001 else
6002 ObjCEmptyVtableVar = new llvm::GlobalVariable(
6003 CGM.getModule(),
6004 ObjCTypes.ImpnfABITy,
6005 false,
6006 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00006007 nullptr,
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006008 "_objc_empty_vtable");
Fariborz Jahanian71394042009-01-23 23:53:38 +00006009 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006010 assert(ID->getClassInterface() &&
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006011 "CGObjCNonFragileABIMac::GenerateClass - class is 0");
Daniel Dunbare3f5cfc2009-04-20 20:18:54 +00006012 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006013 uint32_t InstanceStart =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006014 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006015 uint32_t InstanceSize = InstanceStart;
John McCallef19dbb2012-10-17 04:53:23 +00006016 uint32_t flags = NonFragileABI_Class_Meta;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006017 llvm::SmallString<64> ObjCMetaClassName(getMetaclassSymbolPrefix());
6018 llvm::SmallString<64> ObjCClassName(getClassSymbolPrefix());
6019 llvm::SmallString<64> TClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006020
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006021 llvm::GlobalVariable *SuperClassGV, *IsAGV;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006022
John McCall0d54a172012-10-17 04:53:31 +00006023 // Build the flags for the metaclass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006024 bool classIsHidden =
John McCall457a04e2010-10-22 21:05:15 +00006025 ID->getClassInterface()->getVisibility() == HiddenVisibility;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006026 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006027 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006028
6029 // FIXME: why is this flag set on the metaclass?
6030 // ObjC metaclasses have no fields and don't really get constructed.
6031 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006032 flags |= NonFragileABI_Class_HasCXXStructors;
John McCall0d54a172012-10-17 04:53:31 +00006033 if (!ID->hasNonZeroConstructors())
6034 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6035 }
6036
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006037 if (!ID->getClassInterface()->getSuperClass()) {
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006038 // class is root
John McCallef19dbb2012-10-17 04:53:23 +00006039 flags |= NonFragileABI_Class_Root;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006040 TClassName = ObjCClassName;
6041 TClassName += ClassName;
6042 SuperClassGV = GetClassGlobal(TClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006043 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006044 TClassName = ObjCMetaClassName;
6045 TClassName += ClassName;
6046 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00006047 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006048 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006049 // Has a root. Current class is not a root.
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00006050 const ObjCInterfaceDecl *Root = ID->getClassInterface();
6051 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
6052 Root = Super;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006053 TClassName = ObjCMetaClassName ;
6054 TClassName += Root->getObjCRuntimeNameAsString();
6055 IsAGV = GetClassGlobal(TClassName.str(),
Rafael Espindola554256c2014-02-26 22:25:45 +00006056 Root->isWeakImported());
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006057
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00006058 // work on super class metadata symbol.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006059 TClassName = ObjCMetaClassName;
6060 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00006061 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006062 TClassName.str(),
6063 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006064 }
6065 llvm::GlobalVariable *CLASS_RO_GV = BuildClassRoTInitializer(flags,
6066 InstanceStart,
6067 InstanceSize,ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006068 TClassName = ObjCMetaClassName;
6069 TClassName += ClassName;
Rafael Espindola554256c2014-02-26 22:25:45 +00006070 llvm::GlobalVariable *MetaTClass = BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006071 TClassName.str(), IsAGV, SuperClassGV, CLASS_RO_GV, classIsHidden,
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00006072 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian67260552009-11-17 21:37:35 +00006073 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar15894b72009-04-07 05:48:37 +00006074
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006075 // Metadata for the class
John McCallef19dbb2012-10-17 04:53:23 +00006076 flags = 0;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006077 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006078 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006079
6080 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006081 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006082
John McCall0d54a172012-10-17 04:53:31 +00006083 // Set a flag to enable a runtime optimization when a class has
6084 // fields that require destruction but which don't require
6085 // anything except zero-initialization during construction. This
6086 // is most notably true of __strong and __weak types, but you can
6087 // also imagine there being C++ types with non-trivial default
6088 // constructors that merely set all fields to null.
6089 if (!ID->hasNonZeroConstructors())
6090 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6091 }
6092
Douglas Gregor78bd61f2009-06-18 16:11:24 +00006093 if (hasObjCExceptionAttribute(CGM.getContext(), ID->getClassInterface()))
John McCallef19dbb2012-10-17 04:53:23 +00006094 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006095
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006096 if (!ID->getClassInterface()->getSuperClass()) {
John McCallef19dbb2012-10-17 04:53:23 +00006097 flags |= NonFragileABI_Class_Root;
Craig Topper8a13c412014-05-21 05:09:00 +00006098 SuperClassGV = nullptr;
Chris Lattnerb433b272009-04-19 06:02:28 +00006099 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006100 // Has a root. Current class is not a root.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006101 TClassName = ObjCClassName;
6102 TClassName += ID->getClassInterface()->getSuperClass()->getObjCRuntimeNameAsString();
Rafael Espindola554256c2014-02-26 22:25:45 +00006103 SuperClassGV = GetClassGlobal(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006104 TClassName.str(),
6105 ID->getClassInterface()->getSuperClass()->isWeakImported());
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006106 }
Daniel Dunbar961202372009-05-03 12:57:56 +00006107 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006108 CLASS_RO_GV = BuildClassRoTInitializer(flags,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00006109 InstanceStart,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006110 InstanceSize,
Fariborz Jahaniana887e632009-01-24 23:43:01 +00006111 ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006112
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006113 TClassName = ObjCClassName;
6114 TClassName += ClassName;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006115 llvm::GlobalVariable *ClassMD =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006116 BuildClassMetaData(TClassName.str(), MetaTClass, SuperClassGV, CLASS_RO_GV,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006117 classIsHidden,
6118 ID->getClassInterface()->isWeakImported());
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006119 DefinedClasses.push_back(ClassMD);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006120 ImplementedClasses.push_back(ID->getClassInterface());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006121
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006122 // Determine if this class is also "non-lazy".
6123 if (ImplementationIsNonLazy(ID))
6124 DefinedNonLazyClasses.push_back(ClassMD);
6125
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006126 // Force the definition of the EHType if necessary.
John McCallef19dbb2012-10-17 04:53:23 +00006127 if (flags & NonFragileABI_Class_Exception)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006128 GetInterfaceEHType(ID->getClassInterface(), true);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006129 // Make sure method definition entries are all clear for next implementation.
6130 MethodDefinitions.clear();
Fariborz Jahanian71394042009-01-23 23:53:38 +00006131}
6132
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006133/// GenerateProtocolRef - This routine is called to generate code for
6134/// a protocol reference expression; as in:
6135/// @code
6136/// @protocol(Proto1);
6137/// @endcode
6138/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
6139/// which will hold address of the protocol meta-data.
6140///
John McCall882987f2013-02-28 19:01:20 +00006141llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006142 const ObjCProtocolDecl *PD) {
6143
Fariborz Jahanian464423d2009-04-10 18:47:34 +00006144 // This routine is called for @protocol only. So, we must build definition
6145 // of protocol's meta-data (not a reference to it!)
6146 //
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006147 llvm::Constant *Init =
6148 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00006149 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006150
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006151 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006152 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006153
John McCall7f416cc2015-09-08 08:05:57 +00006154 CharUnits Align = CGF.getPointerAlign();
6155
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006156 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
6157 if (PTGV)
John McCall7f416cc2015-09-08 08:05:57 +00006158 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006159 PTGV = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006160 CGM.getModule(),
6161 Init->getType(), false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006162 llvm::GlobalValue::WeakAnyLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006163 Init,
6164 ProtocolName);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006165 PTGV->setSection("__DATA, __objc_protorefs, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006166 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall7f416cc2015-09-08 08:05:57 +00006167 PTGV->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00006168 CGM.addCompilerUsedGlobal(PTGV);
John McCall7f416cc2015-09-08 08:05:57 +00006169 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006170}
6171
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006172/// GenerateCategory - Build metadata for a category implementation.
6173/// struct _category_t {
6174/// const char * const name;
6175/// struct _class_t *const cls;
6176/// const struct _method_list_t * const instance_methods;
6177/// const struct _method_list_t * const class_methods;
6178/// const struct _protocol_list_t * const protocols;
6179/// const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00006180/// const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00006181/// const uint32_t size;
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006182/// }
6183///
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006184void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006185 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006186 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006187
6188 llvm::SmallString<64> ExtCatName(Prefix);
6189 ExtCatName += Interface->getObjCRuntimeNameAsString();
6190 ExtCatName += "_$_";
6191 ExtCatName += OCD->getNameAsString();
6192
6193 llvm::SmallString<64> ExtClassName(getClassSymbolPrefix());
6194 ExtClassName += Interface->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006195
Manman Ren42ff3902016-02-24 17:49:50 +00006196 llvm::Constant *Values[8];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006197 Values[0] = GetClassName(OCD->getIdentifier()->getName());
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006198 // meta-class entry symbol
Rafael Espindola554256c2014-02-26 22:25:45 +00006199 llvm::GlobalVariable *ClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006200 GetClassGlobal(ExtClassName.str(), Interface->isWeakImported());
Rafael Espindola554256c2014-02-26 22:25:45 +00006201
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006202 Values[1] = ClassGV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006203 std::vector<llvm::Constant*> Methods;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006204 llvm::SmallString<64> MethodListName(Prefix);
6205
6206 MethodListName += "INSTANCE_METHODS_";
6207 MethodListName += Interface->getObjCRuntimeNameAsString();
6208 MethodListName += "_$_";
6209 MethodListName += OCD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006210
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006211 for (const auto *I : OCD->instance_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006212 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006213 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006214
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006215 Values[2] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006216 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006217 Methods);
6218
6219 MethodListName = Prefix;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006220 MethodListName += "CLASS_METHODS_";
6221 MethodListName += Interface->getObjCRuntimeNameAsString();
6222 MethodListName += "_$_";
6223 MethodListName += OCD->getNameAsString();
6224
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006225 Methods.clear();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006226 for (const auto *I : OCD->class_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006227 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006228 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006229
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006230 Values[3] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006231 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006232 Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006233 const ObjCCategoryDecl *Category =
Fariborz Jahanian066347e2009-01-28 22:18:42 +00006234 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006235 if (Category) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006236 SmallString<256> ExtName;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006237 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006238 << OCD->getName();
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006239 Values[4] = EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006240 + Interface->getObjCRuntimeNameAsString() + "_$_"
6241 + Category->getName(),
6242 Category->protocol_begin(),
6243 Category->protocol_end());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006244 Values[5] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Manman Renad0e7912016-01-29 19:22:54 +00006245 OCD, Category, ObjCTypes, false);
Manman Ren96df0b32016-01-29 23:45:01 +00006246 Values[6] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
6247 OCD, Category, ObjCTypes, true);
Mike Stump658fe022009-07-30 22:28:39 +00006248 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00006249 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
6250 Values[5] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Manman Ren96df0b32016-01-29 23:45:01 +00006251 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006252 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006253
Manman Ren42ff3902016-02-24 17:49:50 +00006254 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategorynfABITy);
6255 Values[7] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6256
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006257 llvm::Constant *Init =
6258 llvm::ConstantStruct::get(ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006259 Values);
6260 llvm::GlobalVariable *GCATV
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006261 = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006262 false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006263 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006264 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006265 ExtCatName.str());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006266 GCATV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006267 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.CategorynfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006268 GCATV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006269 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006270 DefinedCategories.push_back(GCATV);
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006271
6272 // Determine if this category is also "non-lazy".
6273 if (ImplementationIsNonLazy(OCD))
6274 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006275 // method definition entries must be clear for next implementation.
6276 MethodDefinitions.clear();
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006277}
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006278
6279/// GetMethodConstant - Return a struct objc_method constant for the
6280/// given method if it has been defined. The result is null if the
6281/// method has not been defined. The return value has type MethodPtrTy.
6282llvm::Constant *CGObjCNonFragileABIMac::GetMethodConstant(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006283 const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00006284 llvm::Function *Fn = GetMethodDefinition(MD);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006285 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00006286 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006287
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006288 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00006289 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006290 ObjCTypes.SelectorPtrTy),
6291 GetMethodVarType(MD),
6292 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
6293 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00006294 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006295}
6296
6297/// EmitMethodList - Build meta-data for method declarations
6298/// struct _method_list_t {
6299/// uint32_t entsize; // sizeof(struct _objc_method)
6300/// uint32_t method_count;
6301/// struct _objc_method method_list[method_count];
6302/// }
6303///
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00006304llvm::Constant *
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00006305CGObjCNonFragileABIMac::EmitMethodList(Twine Name, StringRef Section,
6306 ArrayRef<llvm::Constant *> Methods) {
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006307 // Return null for empty list.
6308 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006309 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006310
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006311 llvm::Constant *Values[3];
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006312 // sizeof(struct _objc_method)
Micah Villmowdd31ca12012-10-08 16:25:52 +00006313 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006314 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006315 // method_count
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006316 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006317 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006318 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006319 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006320 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006321
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006322 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006323 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006324 llvm::GlobalValue::PrivateLinkage, Init, Name);
Micah Villmowdd31ca12012-10-08 16:25:52 +00006325 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006326 GV->setSection(Section);
Rafael Espindola060062a2014-03-06 22:15:10 +00006327 CGM.addCompilerUsedGlobal(GV);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006328 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006329}
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006330
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006331/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6332/// the given ivar.
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006333llvm::GlobalVariable *
6334CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6335 const ObjCIvarDecl *Ivar) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006336
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006337 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006338 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6339 Name += Container->getObjCRuntimeNameAsString();
6340 Name += ".";
6341 Name += Ivar->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006342 llvm::GlobalVariable *IvarOffsetGV =
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006343 CGM.getModule().getGlobalVariable(Name);
6344 if (!IvarOffsetGV)
Tim Northover238b5082014-03-29 13:42:40 +00006345 IvarOffsetGV = new llvm::GlobalVariable(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006346 CGM.getModule(), ObjCTypes.IvarOffsetVarTy, false,
6347 llvm::GlobalValue::ExternalLinkage, nullptr, Name.str());
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006348 return IvarOffsetGV;
6349}
6350
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006351llvm::Constant *
6352CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6353 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00006354 unsigned long int Offset) {
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006355 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Tim Northover238b5082014-03-29 13:42:40 +00006356 IvarOffsetGV->setInitializer(
6357 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006358 IvarOffsetGV->setAlignment(
Tim Northover238b5082014-03-29 13:42:40 +00006359 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006360
Mike Stump18bb9282009-05-16 07:57:57 +00006361 // FIXME: This matches gcc, but shouldn't the visibility be set on the use as
6362 // well (i.e., in ObjCIvarOffsetVariable).
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006363 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6364 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
John McCall457a04e2010-10-22 21:05:15 +00006365 ID->getVisibility() == HiddenVisibility)
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00006366 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Daniel Dunbarf5f359f2009-04-14 06:00:08 +00006367 else
Fariborz Jahanianbc3c77b2009-04-06 18:30:00 +00006368 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
Bill Wendlingf7d45982011-05-04 21:37:25 +00006369 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006370 return IvarOffsetGV;
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006371}
6372
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006373/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006374/// implementation. The return value has type
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006375/// IvarListnfABIPtrTy.
6376/// struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00006377/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006378/// char *name;
6379/// char *type;
6380/// uint32_t alignment;
6381/// uint32_t size;
6382/// }
6383/// struct _ivar_list_t {
6384/// uint32 entsize; // sizeof(struct _ivar_t)
6385/// uint32 count;
6386/// struct _iver_t list[count];
6387/// }
6388///
Daniel Dunbarf5c18462009-04-20 06:54:31 +00006389
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006390llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006391 const ObjCImplementationDecl *ID) {
6392
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006393 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006394
Jordy Rosea91768e2011-07-22 02:08:32 +00006395 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006396 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006397
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006398 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006399
Jordy Rosea91768e2011-07-22 02:08:32 +00006400 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00006401 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00006402 // Ignore unnamed bit-fields.
6403 if (!IVD->getDeclName())
6404 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006405 llvm::Constant *Ivar[5];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006406 Ivar[0] = EmitIvarOffsetVar(ID->getClassInterface(), IVD,
Daniel Dunbar961202372009-05-03 12:57:56 +00006407 ComputeIvarBaseOffset(CGM, ID, IVD));
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006408 Ivar[1] = GetMethodVarName(IVD->getIdentifier());
6409 Ivar[2] = GetMethodVarType(IVD);
Chris Lattner2192fe52011-07-18 04:24:23 +00006410 llvm::Type *FieldTy =
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006411 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmowdd31ca12012-10-08 16:25:52 +00006412 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006413 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006414 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006415 Align = llvm::Log2_32(Align);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006416 Ivar[3] = llvm::ConstantInt::get(ObjCTypes.IntTy, Align);
Daniel Dunbarae032262009-04-20 00:33:43 +00006417 // NOTE. Size of a bitfield does not match gcc's, because of the
6418 // way bitfields are treated special in each. But I am told that
6419 // 'size' for bitfield ivars is ignored by the runtime so it does
6420 // not matter. If it matters, there is enough info to get the
6421 // bitfield right!
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006422 Ivar[4] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006423 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarnfABITy, Ivar));
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006424 }
6425 // Return null for empty list.
6426 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006427 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006428
6429 llvm::Constant *Values[3];
Micah Villmowdd31ca12012-10-08 16:25:52 +00006430 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006431 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6432 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006433 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarnfABITy,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006434 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006435 Values[2] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006436 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006437 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6438 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006439 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006440 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006441 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006442 Prefix + OID->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006443 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006444 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006445 GV->setSection("__DATA, __objc_const");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006446
Rafael Espindola060062a2014-03-06 22:15:10 +00006447 CGM.addCompilerUsedGlobal(GV);
Owen Andersonade90fd2009-07-29 18:54:39 +00006448 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006449}
6450
6451llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006452 const ObjCProtocolDecl *PD) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006453 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006454
Akira Hatanaka7f550f32016-02-11 06:36:35 +00006455 if (!Entry)
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006456 // We use the initializer as a marker of whether this is a forward
6457 // reference or not. At module finalization we add the empty
6458 // contents for protocols which were referenced but never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006459 Entry =
Rafael Espindola5d117f32014-03-06 01:10:46 +00006460 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola24615092014-09-12 20:14:20 +00006461 false, llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00006462 nullptr,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006463 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006464
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006465 return Entry;
6466}
6467
6468/// GetOrEmitProtocol - Generate the protocol meta-data:
6469/// @code
6470/// struct _protocol_t {
6471/// id isa; // NULL
6472/// const char * const protocol_name;
6473/// const struct _protocol_list_t * protocol_list; // super protocols
6474/// const struct method_list_t * const instance_methods;
6475/// const struct method_list_t * const class_methods;
6476/// const struct method_list_t *optionalInstanceMethods;
6477/// const struct method_list_t *optionalClassMethods;
6478/// const struct _prop_list_t * properties;
6479/// const uint32_t size; // sizeof(struct _protocol_t)
6480/// const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006481/// const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006482/// const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00006483/// const struct _prop_list_t * class_properties;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006484/// }
6485/// @endcode
6486///
6487
6488llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006489 const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00006490 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006491
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006492 // Early exit if a defining object has already been generated.
6493 if (Entry && Entry->hasInitializer())
6494 return Entry;
6495
Douglas Gregora715bff2012-01-01 19:51:50 +00006496 // Use the protocol definition, if there is one.
6497 if (const ObjCProtocolDecl *Def = PD->getDefinition())
6498 PD = Def;
6499
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006500 // Construct method lists.
6501 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
6502 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006503 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006504 for (const auto *MD : PD->instance_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006505 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006506 if (!C)
6507 return GetOrEmitProtocolRef(PD);
6508
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006509 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6510 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006511 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006512 } else {
6513 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006514 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006515 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006516 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006517
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006518 for (const auto *MD : PD->class_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006519 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006520 if (!C)
6521 return GetOrEmitProtocolRef(PD);
6522
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006523 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6524 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006525 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006526 } else {
6527 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006528 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006529 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006530 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006531
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006532 MethodTypesExt.insert(MethodTypesExt.end(),
6533 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
6534
Manman Rence7bff52016-01-29 23:46:55 +00006535 llvm::Constant *Values[13];
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006536 // isa is NULL
Owen Anderson0b75f232009-07-31 20:28:54 +00006537 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ObjectPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006538 Values[1] = GetClassName(PD->getObjCRuntimeNameAsString());
6539 Values[2] = EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_" + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006540 PD->protocol_begin(),
6541 PD->protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006542
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006543 Values[3] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006544 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006545 "__DATA, __objc_const",
6546 InstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006547 Values[4] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006548 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006549 "__DATA, __objc_const",
6550 ClassMethods);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006551 Values[5] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006552 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006553 "__DATA, __objc_const",
6554 OptInstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006555 Values[6] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006556 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006557 "__DATA, __objc_const",
6558 OptClassMethods);
Manman Renad0e7912016-01-29 19:22:54 +00006559 Values[7] = EmitPropertyList(
6560 "\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6561 nullptr, PD, ObjCTypes, false);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006562 uint32_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006563 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006564 Values[8] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0b75f232009-07-31 20:28:54 +00006565 Values[9] = llvm::Constant::getNullValue(ObjCTypes.IntTy);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006566 Values[10] = EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006567 + PD->getObjCRuntimeNameAsString(),
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006568 MethodTypesExt, ObjCTypes);
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006569 // const char *demangledName;
6570 Values[11] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Manman Rence7bff52016-01-29 23:46:55 +00006571
6572 Values[12] = EmitPropertyList(
6573 "\01l_OBJC_$_CLASS_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6574 nullptr, PD, ObjCTypes, true);
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006575
Owen Anderson0e0189d2009-07-27 22:29:56 +00006576 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolnfABITy,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006577 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006578
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006579 if (Entry) {
Rafael Espindola24615092014-09-12 20:14:20 +00006580 // Already created, fix the linkage and update the initializer.
6581 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006582 Entry->setInitializer(Init);
6583 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006584 Entry =
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006585 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006586 false, llvm::GlobalValue::WeakAnyLinkage, Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006587 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006588 Entry->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006589 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABITy));
John McCallf9582a72012-03-30 21:29:05 +00006590
6591 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006592 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006593 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006594 CGM.addCompilerUsedGlobal(Entry);
Chris Lattnerf56501c2009-07-17 23:57:13 +00006595
Fariborz Jahanian61cd4b52009-01-29 20:10:59 +00006596 // Use this protocol meta-data to build protocol list table in section
6597 // __DATA, __objc_protolist
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006598 llvm::GlobalVariable *PTGV =
6599 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006600 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006601 "\01l_OBJC_LABEL_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006602 PTGV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006603 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Daniel Dunbarb25452a2009-04-15 02:56:18 +00006604 PTGV->setSection("__DATA, __objc_protolist, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006605 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006606 CGM.addCompilerUsedGlobal(PTGV);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006607 return Entry;
6608}
6609
6610/// EmitProtocolList - Generate protocol list meta-data:
6611/// @code
6612/// struct _protocol_list_t {
6613/// long protocol_count; // Note, this is 32/64 bit
6614/// struct _protocol_t[protocol_count];
6615/// }
6616/// @endcode
6617///
6618llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00006619CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006620 ObjCProtocolDecl::protocol_iterator begin,
6621 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006622 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006623
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006624 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006625 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00006626 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006627
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006628 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006629 SmallString<256> TmpName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006630 Name.toVector(TmpName);
6631 llvm::GlobalVariable *GV =
6632 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006633 if (GV)
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006634 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006635
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006636 for (; begin != end; ++begin)
6637 ProtocolRefs.push_back(GetProtocolRef(*begin)); // Implemented???
6638
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006639 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00006640 ProtocolRefs.push_back(llvm::Constant::getNullValue(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006641 ObjCTypes.ProtocolnfABIPtrTy));
6642
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006643 llvm::Constant *Values[2];
Owen Anderson170229f2009-07-14 23:10:40 +00006644 Values[0] =
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006645 llvm::ConstantInt::get(ObjCTypes.LongTy, ProtocolRefs.size() - 1);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006646 Values[1] =
Bill Wendlinga515b582012-02-09 22:16:49 +00006647 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolnfABIPtrTy,
6648 ProtocolRefs.size()),
6649 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006650
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006651 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Owen Andersonc10c8d32009-07-08 19:05:04 +00006652 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006653 llvm::GlobalValue::PrivateLinkage,
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006654 Init, Name);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006655 GV->setSection("__DATA, __objc_const");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006656 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006657 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Rafael Espindola060062a2014-03-06 22:15:10 +00006658 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006659 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006660 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006661}
6662
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006663/// GetMethodDescriptionConstant - This routine build following meta-data:
6664/// struct _objc_method {
6665/// SEL _cmd;
6666/// char *method_type;
6667/// char *_imp;
6668/// }
6669
6670llvm::Constant *
6671CGObjCNonFragileABIMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006672 llvm::Constant *Desc[3];
Owen Anderson170229f2009-07-14 23:10:40 +00006673 Desc[0] =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006674 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
6675 ObjCTypes.SelectorPtrTy);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006676 Desc[1] = GetMethodVarType(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006677 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00006678 return nullptr;
6679
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006680 // Protocol methods have no implementation. So, this entry is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00006681 Desc[2] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006682 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Desc);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006683}
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006684
6685/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6686/// This code gen. amounts to generating code for:
6687/// @code
6688/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6689/// @encode
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006690///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00006691LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall96fa4842010-05-17 21:00:27 +00006692 CodeGen::CodeGenFunction &CGF,
6693 QualType ObjectTy,
6694 llvm::Value *BaseValue,
6695 const ObjCIvarDecl *Ivar,
6696 unsigned CVRQualifiers) {
6697 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006698 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00006699 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006700 Offset);
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006701}
6702
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006703llvm::Value *CGObjCNonFragileABIMac::EmitIvarOffset(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006704 CodeGen::CodeGenFunction &CGF,
6705 const ObjCInterfaceDecl *Interface,
6706 const ObjCIvarDecl *Ivar) {
Tim Northover238b5082014-03-29 13:42:40 +00006707 llvm::Value *IvarOffsetValue = ObjCIvarOffsetVariable(Interface, Ivar);
John McCall7f416cc2015-09-08 08:05:57 +00006708 IvarOffsetValue = CGF.Builder.CreateAlignedLoad(IvarOffsetValue,
6709 CGF.getSizeAlign(), "ivar");
Tim Northover238b5082014-03-29 13:42:40 +00006710 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
6711 cast<llvm::LoadInst>(IvarOffsetValue)
6712 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
Craig Topper5fc8fc22014-08-27 06:28:36 +00006713 llvm::MDNode::get(VMContext, None));
Tim Northover238b5082014-03-29 13:42:40 +00006714
6715 // This could be 32bit int or 64bit integer depending on the architecture.
6716 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
6717 // as this is what caller always expectes.
6718 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
6719 IvarOffsetValue = CGF.Builder.CreateIntCast(
6720 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
6721 return IvarOffsetValue;
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006722}
6723
John McCall234eac82011-05-13 23:16:18 +00006724static void appendSelectorForMessageRefTable(std::string &buffer,
6725 Selector selector) {
6726 if (selector.isUnarySelector()) {
6727 buffer += selector.getNameForSlot(0);
6728 return;
6729 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006730
John McCall234eac82011-05-13 23:16:18 +00006731 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
6732 buffer += selector.getNameForSlot(i);
6733 buffer += '_';
6734 }
6735}
6736
Eric Christopherd160c502016-01-29 01:35:53 +00006737/// Emit a "vtable" message send. We emit a weak hidden-visibility
John McCall9e8bb002011-05-14 03:10:52 +00006738/// struct, initially containing the selector pointer and a pointer to
6739/// a "fixup" variant of the appropriate objc_msgSend. To call, we
6740/// load and call the function pointer, passing the address of the
6741/// struct as the second parameter. The runtime determines whether
6742/// the selector is currently emitted using vtable dispatch; if so, it
6743/// substitutes a stub function which simply tail-calls through the
6744/// appropriate vtable slot, and if not, it substitues a stub function
6745/// which tail-calls objc_msgSend. Both stubs adjust the selector
6746/// argument to correctly point to the selector.
6747RValue
6748CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
6749 ReturnValueSlot returnSlot,
6750 QualType resultType,
6751 Selector selector,
6752 llvm::Value *arg0,
6753 QualType arg0Type,
6754 bool isSuper,
6755 const CallArgList &formalArgs,
6756 const ObjCMethodDecl *method) {
John McCall234eac82011-05-13 23:16:18 +00006757 // Compute the actual arguments.
6758 CallArgList args;
6759
John McCall9e8bb002011-05-14 03:10:52 +00006760 // First argument: the receiver / super-call structure.
John McCall234eac82011-05-13 23:16:18 +00006761 if (!isSuper)
John McCall9e8bb002011-05-14 03:10:52 +00006762 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
6763 args.add(RValue::get(arg0), arg0Type);
John McCall234eac82011-05-13 23:16:18 +00006764
John McCall9e8bb002011-05-14 03:10:52 +00006765 // Second argument: a pointer to the message ref structure. Leave
6766 // the actual argument value blank for now.
Craig Topper8a13c412014-05-21 05:09:00 +00006767 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCall234eac82011-05-13 23:16:18 +00006768
6769 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
6770
John McCalla729c622012-02-17 03:33:10 +00006771 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCall234eac82011-05-13 23:16:18 +00006772
John McCall5880fb82011-05-14 21:12:11 +00006773 NullReturnState nullReturn;
6774
John McCall9e8bb002011-05-14 03:10:52 +00006775 // Find the function to call and the mangled name for the message
6776 // ref structure. Using a different mangled name wouldn't actually
6777 // be a problem; it would just be a waste.
6778 //
6779 // The runtime currently never uses vtable dispatch for anything
6780 // except normal, non-super message-sends.
6781 // FIXME: don't use this for that.
Craig Topper8a13c412014-05-21 05:09:00 +00006782 llvm::Constant *fn = nullptr;
John McCall234eac82011-05-13 23:16:18 +00006783 std::string messageRefName("\01l_");
Tim Northovere77cc392014-03-29 13:28:05 +00006784 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall234eac82011-05-13 23:16:18 +00006785 if (isSuper) {
6786 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
6787 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006788 } else {
John McCall5880fb82011-05-14 21:12:11 +00006789 nullReturn.init(CGF, arg0);
John McCall234eac82011-05-13 23:16:18 +00006790 fn = ObjCTypes.getMessageSendStretFixupFn();
6791 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006792 }
John McCall234eac82011-05-13 23:16:18 +00006793 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
6794 fn = ObjCTypes.getMessageSendFpretFixupFn();
6795 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stump658fe022009-07-30 22:28:39 +00006796 } else {
John McCall234eac82011-05-13 23:16:18 +00006797 if (isSuper) {
6798 fn = ObjCTypes.getMessageSendSuper2FixupFn();
6799 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006800 } else {
John McCall234eac82011-05-13 23:16:18 +00006801 fn = ObjCTypes.getMessageSendFixupFn();
6802 messageRefName += "objc_msgSend_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006803 }
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00006804 }
John McCall234eac82011-05-13 23:16:18 +00006805 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
6806 messageRefName += '_';
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006807
John McCall234eac82011-05-13 23:16:18 +00006808 // Append the selector name, except use underscores anywhere we
6809 // would have used colons.
6810 appendSelectorForMessageRefTable(messageRefName, selector);
6811
6812 llvm::GlobalVariable *messageRef
6813 = CGM.getModule().getGlobalVariable(messageRefName);
6814 if (!messageRef) {
John McCall9e8bb002011-05-14 03:10:52 +00006815 // Build the message ref structure.
John McCall234eac82011-05-13 23:16:18 +00006816 llvm::Constant *values[] = { fn, GetMethodVarName(selector) };
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006817 llvm::Constant *init = llvm::ConstantStruct::getAnon(values);
John McCall234eac82011-05-13 23:16:18 +00006818 messageRef = new llvm::GlobalVariable(CGM.getModule(),
6819 init->getType(),
6820 /*constant*/ false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006821 llvm::GlobalValue::WeakAnyLinkage,
John McCall234eac82011-05-13 23:16:18 +00006822 init,
6823 messageRefName);
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006824 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall234eac82011-05-13 23:16:18 +00006825 messageRef->setAlignment(16);
6826 messageRef->setSection("__DATA, __objc_msgrefs, coalesced");
6827 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006828
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006829 bool requiresnullCheck = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00006830 if (CGM.getLangOpts().ObjCAutoRefCount && method)
Aaron Ballman43b68be2014-03-07 17:50:17 +00006831 for (const auto *ParamDecl : method->params()) {
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006832 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
6833 if (!nullReturn.NullBB)
6834 nullReturn.init(CGF, arg0);
6835 requiresnullCheck = true;
6836 break;
6837 }
6838 }
6839
John McCall7f416cc2015-09-08 08:05:57 +00006840 Address mref =
6841 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
6842 CGF.getPointerAlign());
John McCall234eac82011-05-13 23:16:18 +00006843
John McCall9e8bb002011-05-14 03:10:52 +00006844 // Update the message ref argument.
John McCall7f416cc2015-09-08 08:05:57 +00006845 args[1].RV = RValue::get(mref.getPointer());
John McCall234eac82011-05-13 23:16:18 +00006846
6847 // Load the function to call from the message ref table.
John McCall7f416cc2015-09-08 08:05:57 +00006848 Address calleeAddr =
6849 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
6850 llvm::Value *callee = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCall234eac82011-05-13 23:16:18 +00006851
John McCalla729c622012-02-17 03:33:10 +00006852 callee = CGF.Builder.CreateBitCast(callee, MSI.MessengerType);
John McCall234eac82011-05-13 23:16:18 +00006853
John McCalla729c622012-02-17 03:33:10 +00006854 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Craig Topper8a13c412014-05-21 05:09:00 +00006855 return nullReturn.complete(CGF, result, resultType, formalArgs,
6856 requiresnullCheck ? method : nullptr);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006857}
6858
6859/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006860CodeGen::RValue
6861CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006862 ReturnValueSlot Return,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006863 QualType ResultType,
6864 Selector Sel,
6865 llvm::Value *Receiver,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006866 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00006867 const ObjCInterfaceDecl *Class,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006868 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00006869 return isVTableDispatchedSelector(Sel)
6870 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006871 Receiver, CGF.getContext().getObjCIdType(),
John McCall9e8bb002011-05-14 03:10:52 +00006872 false, CallArgs, Method)
6873 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00006874 EmitSelector(CGF, Sel),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006875 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00006876 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006877}
6878
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006879llvm::GlobalVariable *
Benjamin Kramer0772c422016-02-13 13:42:54 +00006880CGObjCNonFragileABIMac::GetClassGlobal(StringRef Name, bool Weak) {
Rafael Espindola554256c2014-02-26 22:25:45 +00006881 llvm::GlobalValue::LinkageTypes L =
6882 Weak ? llvm::GlobalValue::ExternalWeakLinkage
6883 : llvm::GlobalValue::ExternalLinkage;
6884
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006885 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
6886
Rafael Espindola554256c2014-02-26 22:25:45 +00006887 if (!GV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006888 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABITy,
Craig Topper8a13c412014-05-21 05:09:00 +00006889 false, L, nullptr, Name);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006890
Rafael Espindola554256c2014-02-26 22:25:45 +00006891 assert(GV->getLinkage() == L);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006892 return GV;
6893}
6894
John McCall882987f2013-02-28 19:01:20 +00006895llvm::Value *CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
Rafael Espindola554256c2014-02-26 22:25:45 +00006896 IdentifierInfo *II,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006897 bool Weak,
6898 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006899 CharUnits Align = CGF.getPointerAlign();
John McCall31168b02011-06-15 23:02:42 +00006900 llvm::GlobalVariable *&Entry = ClassReferences[II];
6901
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006902 if (!Entry) {
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00006903 StringRef Name = ID ? ID->getObjCRuntimeNameAsString() : II->getName();
6904 std::string ClassName = (getClassSymbolPrefix() + Name).str();
Rafael Espindola554256c2014-02-26 22:25:45 +00006905 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName, Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006906 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6907 false, llvm::GlobalValue::PrivateLinkage,
6908 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006909 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006910 Entry->setSection("__DATA, __objc_classrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006911 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006912 }
John McCall7f416cc2015-09-08 08:05:57 +00006913 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006914}
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006915
John McCall882987f2013-02-28 19:01:20 +00006916llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00006917 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00006918 // If the class has the objc_runtime_visible attribute, we need to
6919 // use the Objective-C runtime to get the class.
6920 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
6921 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
6922
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006923 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID->isWeakImported(), ID);
John McCall31168b02011-06-15 23:02:42 +00006924}
6925
6926llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCall882987f2013-02-28 19:01:20 +00006927 CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00006928 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
Hans Wennborgdcfba332015-10-06 23:40:43 +00006929 return EmitClassRefFromId(CGF, II, false, nullptr);
John McCall31168b02011-06-15 23:02:42 +00006930}
6931
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006932llvm::Value *
John McCall882987f2013-02-28 19:01:20 +00006933CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006934 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006935 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006936 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006937
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006938 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006939 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6940 ClassName += ID->getObjCRuntimeNameAsString();
6941 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006942 ID->isWeakImported());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006943 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6944 false, llvm::GlobalValue::PrivateLinkage,
6945 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006946 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006947 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006948 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006949 }
John McCall7f416cc2015-09-08 08:05:57 +00006950 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006951}
6952
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006953/// EmitMetaClassRef - Return a Value * of the address of _class_t
6954/// meta-data
6955///
John McCall882987f2013-02-28 19:01:20 +00006956llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006957 const ObjCInterfaceDecl *ID,
6958 bool Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00006959 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006960 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Rafael Espindola21039aa2014-02-27 16:26:32 +00006961 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006962 llvm::SmallString<64> MetaClassName(getMetaclassSymbolPrefix());
6963 MetaClassName += ID->getObjCRuntimeNameAsString();
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00006964 llvm::GlobalVariable *MetaClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006965 GetClassGlobal(MetaClassName.str(), Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006966
Rafael Espindola21039aa2014-02-27 16:26:32 +00006967 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006968 false, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006969 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006970 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006971
Rafael Espindola21039aa2014-02-27 16:26:32 +00006972 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006973 CGM.addCompilerUsedGlobal(Entry);
Rafael Espindola21039aa2014-02-27 16:26:32 +00006974 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006975
John McCall7f416cc2015-09-08 08:05:57 +00006976 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006977}
6978
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006979/// GetClass - Return a reference to the class for the given interface
6980/// decl.
John McCall882987f2013-02-28 19:01:20 +00006981llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006982 const ObjCInterfaceDecl *ID) {
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00006983 if (ID->isWeakImported()) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006984 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6985 ClassName += ID->getObjCRuntimeNameAsString();
6986 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(), true);
Nick Lewycky9a441642014-02-27 00:36:00 +00006987 (void)ClassGV;
Rafael Espindolab3262952014-05-09 00:43:37 +00006988 assert(ClassGV->hasExternalWeakLinkage());
Fariborz Jahanian95ace552009-11-17 22:42:00 +00006989 }
6990
John McCall882987f2013-02-28 19:01:20 +00006991 return EmitClassRef(CGF, ID);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006992}
6993
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00006994/// Generates a message send where the super is the receiver. This is
6995/// a message send to self with special delivery semantics indicating
6996/// which class's method should be called.
6997CodeGen::RValue
6998CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006999 ReturnValueSlot Return,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007000 QualType ResultType,
7001 Selector Sel,
7002 const ObjCInterfaceDecl *Class,
7003 bool isCategoryImpl,
7004 llvm::Value *Receiver,
7005 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007006 const CodeGen::CallArgList &CallArgs,
7007 const ObjCMethodDecl *Method) {
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007008 // ...
7009 // Create and init a super structure; this is a (receiver, class)
7010 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00007011 Address ObjCSuper =
7012 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
7013 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007014
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007015 llvm::Value *ReceiverAsObject =
7016 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007017 CGF.Builder.CreateStore(
7018 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00007019 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007020
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007021 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00007022 llvm::Value *Target;
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007023 if (IsClassMessage)
Fariborz Jahanian85b99da2014-08-28 17:05:17 +00007024 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007025 else
John McCall882987f2013-02-28 19:01:20 +00007026 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007027
Mike Stump18bb9282009-05-16 07:57:57 +00007028 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
7029 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00007030 llvm::Type *ClassTy =
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007031 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
7032 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007033 CGF.Builder.CreateStore(
John McCall7f416cc2015-09-08 08:05:57 +00007034 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007035
John McCall9e8bb002011-05-14 03:10:52 +00007036 return (isVTableDispatchedSelector(Sel))
7037 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
John McCall7f416cc2015-09-08 08:05:57 +00007038 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall9e8bb002011-05-14 03:10:52 +00007039 true, CallArgs, Method)
7040 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00007041 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00007042 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00007043 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007044}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007045
John McCall882987f2013-02-28 19:01:20 +00007046llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007047 Selector Sel) {
7048 Address Addr = EmitSelectorAddr(CGF, Sel);
7049
7050 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
7051 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
7052 llvm::MDNode::get(VMContext, None));
7053 return LI;
7054}
7055
7056Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
7057 Selector Sel) {
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007058 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007059
John McCall7f416cc2015-09-08 08:05:57 +00007060 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007061 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007062 llvm::Constant *Casted =
7063 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
7064 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007065 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
7066 false, llvm::GlobalValue::PrivateLinkage,
7067 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman5c205962013-02-05 23:08:45 +00007068 Entry->setExternallyInitialized(true);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00007069 Entry->setSection("__DATA, __objc_selrefs, literal_pointers, no_dead_strip");
John McCall7f416cc2015-09-08 08:05:57 +00007070 Entry->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00007071 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007072 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007073
John McCall7f416cc2015-09-08 08:05:57 +00007074 return Address(Entry, Align);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007075}
John McCall7f416cc2015-09-08 08:05:57 +00007076
Fariborz Jahanian06292952009-02-16 22:52:32 +00007077/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007078/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian06292952009-02-16 22:52:32 +00007079///
7080void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00007081 llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +00007082 Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007083 llvm::Value *ivarOffset) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007084 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007085 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007086 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007087 assert(Size <= 8 && "does not support size > 8");
7088 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7089 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007090 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7091 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007092 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7093 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007094 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00007095 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007096}
7097
7098/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
7099/// objc_assign_strongCast (id src, id *dst)
7100///
7101void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007102 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007103 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007104 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007105 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007106 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007107 assert(Size <= 8 && "does not support size > 8");
7108 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007109 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007110 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7111 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007112 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7113 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007114 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007115 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
7116 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007117}
7118
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007119void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007120 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007121 Address DestPtr,
7122 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00007123 llvm::Value *Size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007124 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
7125 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007126 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCall882987f2013-02-28 19:01:20 +00007127 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007128}
7129
Fariborz Jahanian06292952009-02-16 22:52:32 +00007130/// EmitObjCWeakRead - Code gen for loading value of a __weak
7131/// object: objc_read_weak (id *src)
7132///
7133llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007134 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007135 Address AddrWeakObj) {
7136 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007137 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007138 llvm::Value *read_weak =
7139 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00007140 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00007141 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007142 return read_weak;
7143}
7144
7145/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
7146/// objc_assign_weak (id src, id *dst)
7147///
7148void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007149 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007150 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007151 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007152 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007153 assert(Size <= 8 && "does not support size > 8");
7154 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7155 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007156 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7157 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007158 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7159 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007160 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007161 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
7162 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007163}
7164
7165/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
7166/// objc_assign_global (id src, id *dst)
7167///
7168void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007169 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00007170 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007171 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007172 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007173 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007174 assert(Size <= 8 && "does not support size > 8");
7175 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7176 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007177 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7178 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007179 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7180 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007181 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00007182 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00007183 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
7184 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00007185 else
John McCall882987f2013-02-28 19:01:20 +00007186 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
7187 args, "threadlocalassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007188}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007189
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007190void
John McCallbd309292010-07-06 01:34:17 +00007191CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
7192 const ObjCAtSynchronizedStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007193 EmitAtSynchronizedStmt(CGF, S,
7194 cast<llvm::Function>(ObjCTypes.getSyncEnterFn()),
7195 cast<llvm::Function>(ObjCTypes.getSyncExitFn()));
John McCallbd309292010-07-06 01:34:17 +00007196}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007197
John McCall2ca705e2010-07-24 00:37:23 +00007198llvm::Constant *
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00007199CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall2ca705e2010-07-24 00:37:23 +00007200 // There's a particular fixed type info for 'id'.
7201 if (T->isObjCIdType() ||
7202 T->isObjCQualifiedIdType()) {
7203 llvm::Constant *IDEHType =
7204 CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
7205 if (!IDEHType)
7206 IDEHType =
7207 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7208 false,
7209 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007210 nullptr, "OBJC_EHTYPE_id");
John McCall2ca705e2010-07-24 00:37:23 +00007211 return IDEHType;
7212 }
7213
7214 // All other types should be Objective-C interface pointer types.
7215 const ObjCObjectPointerType *PT =
7216 T->getAs<ObjCObjectPointerType>();
7217 assert(PT && "Invalid @catch type.");
7218 const ObjCInterfaceType *IT = PT->getInterfaceType();
7219 assert(IT && "Invalid @catch type.");
7220 return GetInterfaceEHType(IT->getDecl(), false);
7221}
7222
John McCallbd309292010-07-06 01:34:17 +00007223void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7224 const ObjCAtTryStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007225 EmitTryCatchStmt(CGF, S,
7226 cast<llvm::Function>(ObjCTypes.getObjCBeginCatchFn()),
7227 cast<llvm::Function>(ObjCTypes.getObjCEndCatchFn()),
7228 cast<llvm::Function>(ObjCTypes.getExceptionRethrowFn()));
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +00007229}
7230
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007231/// EmitThrowStmt - Generate code for a throw statement.
7232void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007233 const ObjCAtThrowStmt &S,
7234 bool ClearInsertionPoint) {
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007235 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00007236 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer76399eb2011-09-27 21:06:10 +00007237 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007238 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception)
John McCall17afe452010-10-16 08:21:07 +00007239 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007240 } else {
John McCall882987f2013-02-28 19:01:20 +00007241 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn())
John McCall17afe452010-10-16 08:21:07 +00007242 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007243 }
7244
John McCall17afe452010-10-16 08:21:07 +00007245 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007246 if (ClearInsertionPoint)
7247 CGF.Builder.ClearInsertionPoint();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007248}
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007249
John McCall2ca705e2010-07-24 00:37:23 +00007250llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007251CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007252 bool ForDefinition) {
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007253 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007254
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007255 // If we don't need a definition, return the entry if found or check
7256 // if we use an external reference.
7257 if (!ForDefinition) {
7258 if (Entry)
7259 return Entry;
Daniel Dunbard7beeea2009-04-07 06:43:45 +00007260
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007261 // If this type (or a super class) has the __objc_exception__
7262 // attribute, emit an external reference.
Douglas Gregor78bd61f2009-06-18 16:11:24 +00007263 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007264 return Entry =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007265 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7266 llvm::GlobalValue::ExternalLinkage,
7267 nullptr,
7268 ("OBJC_EHTYPE_$_" +
7269 ID->getObjCRuntimeNameAsString()));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007270 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007271
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007272 // Otherwise we need to either make a new entry or fill in the
7273 // initializer.
7274 assert((!Entry || !Entry->hasInitializer()) && "Duplicate EHType definition");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007275 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
7276 ClassName += ID->getObjCRuntimeNameAsString();
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007277 std::string VTableName = "objc_ehtype_vtable";
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007278 llvm::GlobalVariable *VTableGV =
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007279 CGM.getModule().getGlobalVariable(VTableName);
7280 if (!VTableGV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007281 VTableGV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.Int8PtrTy,
7282 false,
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007283 llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00007284 nullptr, VTableName);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007285
Chris Lattnerece04092012-02-07 00:39:47 +00007286 llvm::Value *VTableIdx = llvm::ConstantInt::get(CGM.Int32Ty, 2);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007287
Benjamin Kramer22d24c22011-10-15 12:20:02 +00007288 llvm::Constant *Values[] = {
David Blaikiee3b172a2015-04-02 18:55:21 +00007289 llvm::ConstantExpr::getGetElementPtr(VTableGV->getValueType(), VTableGV,
7290 VTableIdx),
7291 GetClassName(ID->getObjCRuntimeNameAsString()),
7292 GetClassGlobal(ClassName.str())};
Owen Anderson170229f2009-07-14 23:10:40 +00007293 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00007294 llvm::ConstantStruct::get(ObjCTypes.EHTypeTy, Values);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007295
Rafael Espindola554256c2014-02-26 22:25:45 +00007296 llvm::GlobalValue::LinkageTypes L = ForDefinition
7297 ? llvm::GlobalValue::ExternalLinkage
7298 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007299 if (Entry) {
7300 Entry->setInitializer(Init);
7301 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007302 llvm::SmallString<64> EHTYPEName("OBJC_EHTYPE_$_");
7303 EHTYPEName += ID->getObjCRuntimeNameAsString();
Owen Andersonc10c8d32009-07-08 19:05:04 +00007304 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
Rafael Espindola554256c2014-02-26 22:25:45 +00007305 L,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007306 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007307 EHTYPEName.str());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007308 }
Rafael Espindola554256c2014-02-26 22:25:45 +00007309 assert(Entry->getLinkage() == L);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007310
John McCalla4960982013-02-19 01:57:29 +00007311 if (ID->getVisibility() == HiddenVisibility)
Daniel Dunbar15894b72009-04-07 05:48:37 +00007312 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Micah Villmowdd31ca12012-10-08 16:25:52 +00007313 Entry->setAlignment(CGM.getDataLayout().getABITypeAlignment(
Daniel Dunbar710cb202010-04-25 20:39:32 +00007314 ObjCTypes.EHTypeTy));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007315
Rafael Espindola554256c2014-02-26 22:25:45 +00007316 if (ForDefinition)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007317 Entry->setSection("__DATA,__objc_const");
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007318
7319 return Entry;
7320}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007321
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00007322/* *** */
7323
Daniel Dunbarb036db82008-08-13 03:21:16 +00007324CodeGen::CGObjCRuntime *
7325CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00007326 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7327 case ObjCRuntime::FragileMacOSX:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007328 return new CGObjCMac(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00007329
7330 case ObjCRuntime::MacOSX:
7331 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00007332 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00007333 return new CGObjCNonFragileABIMac(CGM);
7334
David Chisnallb601c962012-07-03 20:49:52 +00007335 case ObjCRuntime::GNUstep:
7336 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +00007337 case ObjCRuntime::ObjFW:
John McCall5fb5df92012-06-20 06:18:46 +00007338 llvm_unreachable("these runtimes are not Mac runtimes");
7339 }
7340 llvm_unreachable("bad runtime");
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007341}