blob: fad36f6232aff6ea4ac63d7693f042b8d6e6fffb [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)
John McCall2da83a32010-02-26 00:48:12 +0000239 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
240 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Benjamin Kramer30934732016-07-02 11:41:41 +0000241 CanQualType Params[] = {
242 IdType, SelType,
243 Ctx.getPointerDiffType()->getCanonicalTypeUnqualified(), Ctx.BoolTy};
Chris Lattner2192fe52011-07-18 04:24:23 +0000244 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000245 Types.GetFunctionType(
246 Types.arrangeBuiltinFunctionDeclaration(IdType, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000247 return CGM.CreateRuntimeFunction(FTy, "objc_getProperty");
248 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000249
Chris Lattnerce8754e2009-04-22 02:44:54 +0000250 llvm::Constant *getSetPropertyFn() {
251 CodeGen::CodeGenTypes &Types = CGM.getTypes();
252 ASTContext &Ctx = CGM.getContext();
253 // void objc_setProperty (id, SEL, ptrdiff_t, id, bool, bool)
John McCall2da83a32010-02-26 00:48:12 +0000254 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
255 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Benjamin Kramer30934732016-07-02 11:41:41 +0000256 CanQualType Params[] = {
257 IdType,
258 SelType,
259 Ctx.getPointerDiffType()->getCanonicalTypeUnqualified(),
260 IdType,
261 Ctx.BoolTy,
262 Ctx.BoolTy};
Chris Lattner2192fe52011-07-18 04:24:23 +0000263 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000264 Types.GetFunctionType(
265 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000266 return CGM.CreateRuntimeFunction(FTy, "objc_setProperty");
267 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000268
Ted Kremeneke65b0862012-03-06 20:05:56 +0000269 llvm::Constant *getOptimizedSetPropertyFn(bool atomic, bool copy) {
270 CodeGen::CodeGenTypes &Types = CGM.getTypes();
271 ASTContext &Ctx = CGM.getContext();
272 // void objc_setProperty_atomic(id self, SEL _cmd,
273 // id newValue, ptrdiff_t offset);
274 // void objc_setProperty_nonatomic(id self, SEL _cmd,
275 // id newValue, ptrdiff_t offset);
276 // void objc_setProperty_atomic_copy(id self, SEL _cmd,
277 // id newValue, ptrdiff_t offset);
278 // void objc_setProperty_nonatomic_copy(id self, SEL _cmd,
279 // id newValue, ptrdiff_t offset);
280
281 SmallVector<CanQualType,4> Params;
282 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
283 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
284 Params.push_back(IdType);
285 Params.push_back(SelType);
286 Params.push_back(IdType);
287 Params.push_back(Ctx.getPointerDiffType()->getCanonicalTypeUnqualified());
288 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000289 Types.GetFunctionType(
290 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Ted Kremeneke65b0862012-03-06 20:05:56 +0000291 const char *name;
292 if (atomic && copy)
293 name = "objc_setProperty_atomic_copy";
294 else if (atomic && !copy)
295 name = "objc_setProperty_atomic";
296 else if (!atomic && copy)
297 name = "objc_setProperty_nonatomic_copy";
298 else
299 name = "objc_setProperty_nonatomic";
300
301 return CGM.CreateRuntimeFunction(FTy, name);
302 }
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000303
304 llvm::Constant *getCopyStructFn() {
305 CodeGen::CodeGenTypes &Types = CGM.getTypes();
306 ASTContext &Ctx = CGM.getContext();
307 // void objc_copyStruct (void *, const void *, size_t, bool, bool)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000308 SmallVector<CanQualType,5> Params;
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000309 Params.push_back(Ctx.VoidPtrTy);
310 Params.push_back(Ctx.VoidPtrTy);
311 Params.push_back(Ctx.LongTy);
312 Params.push_back(Ctx.BoolTy);
313 Params.push_back(Ctx.BoolTy);
Chris Lattner2192fe52011-07-18 04:24:23 +0000314 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000315 Types.GetFunctionType(
316 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000317 return CGM.CreateRuntimeFunction(FTy, "objc_copyStruct");
318 }
319
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000320 /// This routine declares and returns address of:
321 /// void objc_copyCppObjectAtomic(
322 /// void *dest, const void *src,
323 /// void (*copyHelper) (void *dest, const void *source));
324 llvm::Constant *getCppAtomicObjectFunction() {
325 CodeGen::CodeGenTypes &Types = CGM.getTypes();
326 ASTContext &Ctx = CGM.getContext();
327 /// void objc_copyCppObjectAtomic(void *dest, const void *src, void *helper);
328 SmallVector<CanQualType,3> Params;
329 Params.push_back(Ctx.VoidPtrTy);
330 Params.push_back(Ctx.VoidPtrTy);
331 Params.push_back(Ctx.VoidPtrTy);
332 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000333 Types.GetFunctionType(
334 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000335 return CGM.CreateRuntimeFunction(FTy, "objc_copyCppObjectAtomic");
336 }
337
Chris Lattnerce8754e2009-04-22 02:44:54 +0000338 llvm::Constant *getEnumerationMutationFn() {
Daniel Dunbar9d82da42009-07-11 20:32:50 +0000339 CodeGen::CodeGenTypes &Types = CGM.getTypes();
340 ASTContext &Ctx = CGM.getContext();
Chris Lattnerce8754e2009-04-22 02:44:54 +0000341 // void objc_enumerationMutation (id)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000342 SmallVector<CanQualType,1> Params;
John McCall2da83a32010-02-26 00:48:12 +0000343 Params.push_back(Ctx.getCanonicalParamType(Ctx.getObjCIdType()));
Chris Lattner2192fe52011-07-18 04:24:23 +0000344 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000345 Types.GetFunctionType(
346 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000347 return CGM.CreateRuntimeFunction(FTy, "objc_enumerationMutation");
348 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000349
Douglas Gregor24ae22c2016-04-01 23:23:52 +0000350 llvm::Constant *getLookUpClassFn() {
351 CodeGen::CodeGenTypes &Types = CGM.getTypes();
352 ASTContext &Ctx = CGM.getContext();
353 // Class objc_lookUpClass (const char *)
354 SmallVector<CanQualType,1> Params;
355 Params.push_back(
356 Ctx.getCanonicalType(Ctx.getPointerType(Ctx.CharTy.withConst())));
357 llvm::FunctionType *FTy =
358 Types.GetFunctionType(Types.arrangeBuiltinFunctionDeclaration(
359 Ctx.getCanonicalType(Ctx.getObjCClassType()),
360 Params));
361 return CGM.CreateRuntimeFunction(FTy, "objc_lookUpClass");
362 }
363
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000364 /// GcReadWeakFn -- LLVM objc_read_weak (id *src) function.
Chris Lattnerce8754e2009-04-22 02:44:54 +0000365 llvm::Constant *getGcReadWeakFn() {
366 // id objc_read_weak (id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000367 llvm::Type *args[] = { ObjectPtrTy->getPointerTo() };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000368 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000369 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattnerce8754e2009-04-22 02:44:54 +0000370 return CGM.CreateRuntimeFunction(FTy, "objc_read_weak");
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000371 }
372
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000373 /// GcAssignWeakFn -- LLVM objc_assign_weak function.
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000374 llvm::Constant *getGcAssignWeakFn() {
375 // id objc_assign_weak (id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000376 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000377 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000378 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000379 return CGM.CreateRuntimeFunction(FTy, "objc_assign_weak");
380 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000381
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000382 /// GcAssignGlobalFn -- LLVM objc_assign_global function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000383 llvm::Constant *getGcAssignGlobalFn() {
384 // id objc_assign_global(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000385 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000386 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000387 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000388 return CGM.CreateRuntimeFunction(FTy, "objc_assign_global");
389 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000390
Fariborz Jahanian217af242010-07-20 20:30:03 +0000391 /// GcAssignThreadLocalFn -- LLVM objc_assign_threadlocal function.
392 llvm::Constant *getGcAssignThreadLocalFn() {
393 // id objc_assign_threadlocal(id src, id * dest)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000394 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Fariborz Jahanian217af242010-07-20 20:30:03 +0000395 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000396 llvm::FunctionType::get(ObjectPtrTy, args, false);
Fariborz Jahanian217af242010-07-20 20:30:03 +0000397 return CGM.CreateRuntimeFunction(FTy, "objc_assign_threadlocal");
398 }
399
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000400 /// GcAssignIvarFn -- LLVM objc_assign_ivar function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000401 llvm::Constant *getGcAssignIvarFn() {
Fariborz Jahanian7a95d722009-09-24 22:25:38 +0000402 // id objc_assign_ivar(id, id *, ptrdiff_t)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000403 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo(),
404 CGM.PtrDiffTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000405 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000406 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000407 return CGM.CreateRuntimeFunction(FTy, "objc_assign_ivar");
408 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000409
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000410 /// GcMemmoveCollectableFn -- LLVM objc_memmove_collectable function.
411 llvm::Constant *GcMemmoveCollectableFn() {
412 // void *objc_memmove_collectable(void *dst, const void *src, size_t size)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000413 llvm::Type *args[] = { Int8PtrTy, Int8PtrTy, LongTy };
John McCall9dc0db22011-05-15 01:53:33 +0000414 llvm::FunctionType *FTy = llvm::FunctionType::get(Int8PtrTy, args, false);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000415 return CGM.CreateRuntimeFunction(FTy, "objc_memmove_collectable");
416 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000417
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000418 /// GcAssignStrongCastFn -- LLVM objc_assign_strongCast function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000419 llvm::Constant *getGcAssignStrongCastFn() {
Fariborz Jahanian217af242010-07-20 20:30:03 +0000420 // id objc_assign_strongCast(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000421 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000422 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000423 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000424 return CGM.CreateRuntimeFunction(FTy, "objc_assign_strongCast");
425 }
Anders Carlsson9ab53d12009-02-16 22:59:18 +0000426
427 /// ExceptionThrowFn - LLVM objc_exception_throw function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000428 llvm::Constant *getExceptionThrowFn() {
429 // void objc_exception_throw(id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000430 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000431 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000432 llvm::FunctionType::get(CGM.VoidTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000433 return CGM.CreateRuntimeFunction(FTy, "objc_exception_throw");
434 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000435
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000436 /// ExceptionRethrowFn - LLVM objc_exception_rethrow function.
437 llvm::Constant *getExceptionRethrowFn() {
438 // void objc_exception_rethrow(void)
John McCall9dc0db22011-05-15 01:53:33 +0000439 llvm::FunctionType *FTy = llvm::FunctionType::get(CGM.VoidTy, false);
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000440 return CGM.CreateRuntimeFunction(FTy, "objc_exception_rethrow");
441 }
442
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000443 /// SyncEnterFn - LLVM object_sync_enter function.
Chris Lattnerdcceee72009-04-06 16:53:45 +0000444 llvm::Constant *getSyncEnterFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000445 // int objc_sync_enter (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000446 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattnerdcceee72009-04-06 16:53:45 +0000447 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000448 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattnerdcceee72009-04-06 16:53:45 +0000449 return CGM.CreateRuntimeFunction(FTy, "objc_sync_enter");
450 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000451
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000452 /// SyncExitFn - LLVM object_sync_exit function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000453 llvm::Constant *getSyncExitFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000454 // int objc_sync_exit (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000455 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000456 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000457 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000458 return CGM.CreateRuntimeFunction(FTy, "objc_sync_exit");
459 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000460
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000461 llvm::Constant *getSendFn(bool IsSuper) const {
462 return IsSuper ? getMessageSendSuperFn() : getMessageSendFn();
463 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000464
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000465 llvm::Constant *getSendFn2(bool IsSuper) const {
466 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFn();
467 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000468
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000469 llvm::Constant *getSendStretFn(bool IsSuper) const {
470 return IsSuper ? getMessageSendSuperStretFn() : getMessageSendStretFn();
471 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000472
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000473 llvm::Constant *getSendStretFn2(bool IsSuper) const {
474 return IsSuper ? getMessageSendSuperStretFn2() : getMessageSendStretFn();
475 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000476
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000477 llvm::Constant *getSendFpretFn(bool IsSuper) const {
478 return IsSuper ? getMessageSendSuperFpretFn() : getMessageSendFpretFn();
479 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000480
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000481 llvm::Constant *getSendFpretFn2(bool IsSuper) const {
482 return IsSuper ? getMessageSendSuperFpretFn2() : getMessageSendFpretFn();
483 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000484
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000485 llvm::Constant *getSendFp2retFn(bool IsSuper) const {
486 return IsSuper ? getMessageSendSuperFn() : getMessageSendFp2retFn();
487 }
488
489 llvm::Constant *getSendFp2RetFn2(bool IsSuper) const {
490 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFp2retFn();
491 }
492
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000493 ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000494};
Daniel Dunbarf6397fe2008-08-23 04:28:29 +0000495
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000496/// ObjCTypesHelper - Helper class that encapsulates lazy
497/// construction of varies types used during ObjC generation.
498class ObjCTypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000499public:
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000500 /// SymtabTy - LLVM type for struct objc_symtab.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000501 llvm::StructType *SymtabTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000502 /// SymtabPtrTy - LLVM type for struct objc_symtab *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000503 llvm::Type *SymtabPtrTy;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000504 /// ModuleTy - LLVM type for struct objc_module.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000505 llvm::StructType *ModuleTy;
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000506
Daniel Dunbarb036db82008-08-13 03:21:16 +0000507 /// ProtocolTy - LLVM type for struct objc_protocol.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000508 llvm::StructType *ProtocolTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000509 /// ProtocolPtrTy - LLVM type for struct objc_protocol *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000510 llvm::Type *ProtocolPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000511 /// ProtocolExtensionTy - LLVM type for struct
512 /// objc_protocol_extension.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000513 llvm::StructType *ProtocolExtensionTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000514 /// ProtocolExtensionTy - LLVM type for struct
515 /// objc_protocol_extension *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000516 llvm::Type *ProtocolExtensionPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000517 /// MethodDescriptionTy - LLVM type for struct
518 /// objc_method_description.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000519 llvm::StructType *MethodDescriptionTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000520 /// MethodDescriptionListTy - LLVM type for struct
521 /// objc_method_description_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000522 llvm::StructType *MethodDescriptionListTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000523 /// MethodDescriptionListPtrTy - LLVM type for struct
524 /// objc_method_description_list *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000525 llvm::Type *MethodDescriptionListPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000526 /// ProtocolListTy - LLVM type for struct objc_property_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000527 llvm::StructType *ProtocolListTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000528 /// ProtocolListPtrTy - LLVM type for struct objc_property_list*.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000529 llvm::Type *ProtocolListPtrTy;
Daniel Dunbar938a77f2008-08-22 20:34:54 +0000530 /// CategoryTy - LLVM type for struct objc_category.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000531 llvm::StructType *CategoryTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000532 /// ClassTy - LLVM type for struct objc_class.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000533 llvm::StructType *ClassTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000534 /// ClassPtrTy - LLVM type for struct objc_class *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000535 llvm::Type *ClassPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000536 /// ClassExtensionTy - LLVM type for struct objc_class_ext.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000537 llvm::StructType *ClassExtensionTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000538 /// ClassExtensionPtrTy - LLVM type for struct objc_class_ext *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000539 llvm::Type *ClassExtensionPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000540 // IvarTy - LLVM type for struct objc_ivar.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000541 llvm::StructType *IvarTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000542 /// IvarListTy - LLVM type for struct objc_ivar_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000543 llvm::Type *IvarListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000544 /// IvarListPtrTy - LLVM type for struct objc_ivar_list *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000545 llvm::Type *IvarListPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000546 /// MethodListTy - LLVM type for struct objc_method_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000547 llvm::Type *MethodListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000548 /// MethodListPtrTy - LLVM type for struct objc_method_list *.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000549 llvm::Type *MethodListPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000550
Anders Carlsson9ff22482008-09-09 10:10:21 +0000551 /// ExceptionDataTy - LLVM type for struct _objc_exception_data.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000552 llvm::Type *ExceptionDataTy;
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +0000553
Anders Carlsson9ff22482008-09-09 10:10:21 +0000554 /// ExceptionTryEnterFn - LLVM objc_exception_try_enter function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000555 llvm::Constant *getExceptionTryEnterFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000556 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000557 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000558 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000559 "objc_exception_try_enter");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000560 }
Anders Carlsson9ff22482008-09-09 10:10:21 +0000561
562 /// ExceptionTryExitFn - LLVM objc_exception_try_exit function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000563 llvm::Constant *getExceptionTryExitFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000564 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000565 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000566 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000567 "objc_exception_try_exit");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000568 }
Anders Carlsson9ff22482008-09-09 10:10:21 +0000569
570 /// ExceptionExtractFn - LLVM objc_exception_extract function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000571 llvm::Constant *getExceptionExtractFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000572 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000573 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000574 params, false),
Chris Lattnerc6406db2009-04-22 02:26:14 +0000575 "objc_exception_extract");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000576 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000577
Anders Carlsson9ff22482008-09-09 10:10:21 +0000578 /// ExceptionMatchFn - LLVM objc_exception_match function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000579 llvm::Constant *getExceptionMatchFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000580 llvm::Type *params[] = { ClassPtrTy, ObjectPtrTy };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000581 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000582 llvm::FunctionType::get(CGM.Int32Ty, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000583 "objc_exception_match");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000584 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000585
Anders Carlsson9ff22482008-09-09 10:10:21 +0000586 /// SetJmpFn - LLVM _setjmp function.
Chris Lattnerc6406db2009-04-22 02:26:14 +0000587 llvm::Constant *getSetJmpFn() {
John McCall9dc0db22011-05-15 01:53:33 +0000588 // This is specifically the prototype for x86.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000589 llvm::Type *params[] = { CGM.Int32Ty->getPointerTo() };
Bill Wendling8594fcb2013-01-31 00:30:05 +0000590 return
591 CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.Int32Ty,
592 params, false),
593 "_setjmp",
594 llvm::AttributeSet::get(CGM.getLLVMContext(),
595 llvm::AttributeSet::FunctionIndex,
596 llvm::Attribute::NonLazyBind));
Chris Lattnerc6406db2009-04-22 02:26:14 +0000597 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000598
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000599public:
600 ObjCTypesHelper(CodeGen::CodeGenModule &cgm);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000601};
602
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000603/// ObjCNonFragileABITypesHelper - will have all types needed by objective-c's
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000604/// modern abi
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000605class ObjCNonFragileABITypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000606public:
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000607 // MethodListnfABITy - LLVM for struct _method_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000608 llvm::StructType *MethodListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000609
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000610 // MethodListnfABIPtrTy - LLVM for struct _method_list_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000611 llvm::Type *MethodListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000612
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000613 // ProtocolnfABITy = LLVM for struct _protocol_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000614 llvm::StructType *ProtocolnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000615
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000616 // ProtocolnfABIPtrTy = LLVM for struct _protocol_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000617 llvm::Type *ProtocolnfABIPtrTy;
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000618
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000619 // ProtocolListnfABITy - LLVM for struct _objc_protocol_list
Chris Lattnera5f58b02011-07-09 17:41:47 +0000620 llvm::StructType *ProtocolListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000621
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000622 // ProtocolListnfABIPtrTy - LLVM for struct _objc_protocol_list*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000623 llvm::Type *ProtocolListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000624
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000625 // ClassnfABITy - LLVM for struct _class_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000626 llvm::StructType *ClassnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000627
Fariborz Jahanian71394042009-01-23 23:53:38 +0000628 // ClassnfABIPtrTy - LLVM for struct _class_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000629 llvm::Type *ClassnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000630
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000631 // IvarnfABITy - LLVM for struct _ivar_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000632 llvm::StructType *IvarnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000633
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000634 // IvarListnfABITy - LLVM for struct _ivar_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000635 llvm::StructType *IvarListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000636
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000637 // IvarListnfABIPtrTy = LLVM for struct _ivar_list_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000638 llvm::Type *IvarListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000639
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000640 // ClassRonfABITy - LLVM for struct _class_ro_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000641 llvm::StructType *ClassRonfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000642
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000643 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000644 llvm::Type *ImpnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000645
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000646 // CategorynfABITy - LLVM for struct _category_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000647 llvm::StructType *CategorynfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000648
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000649 // New types for nonfragile abi messaging.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000650
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000651 // MessageRefTy - LLVM for:
652 // struct _message_ref_t {
653 // IMP messenger;
654 // SEL name;
655 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000656 llvm::StructType *MessageRefTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000657 // MessageRefCTy - clang type for struct _message_ref_t
658 QualType MessageRefCTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000659
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000660 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000661 llvm::Type *MessageRefPtrTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000662 // MessageRefCPtrTy - clang type for struct _message_ref_t*
663 QualType MessageRefCPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000664
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000665 // SuperMessageRefTy - LLVM for:
666 // struct _super_message_ref_t {
667 // SUPER_IMP messenger;
668 // SEL name;
669 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000670 llvm::StructType *SuperMessageRefTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000671
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000672 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000673 llvm::Type *SuperMessageRefPtrTy;
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +0000674
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000675 llvm::Constant *getMessageSendFixupFn() {
676 // id objc_msgSend_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000677 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000678 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000679 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000680 "objc_msgSend_fixup");
681 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000682
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000683 llvm::Constant *getMessageSendFpretFixupFn() {
684 // id objc_msgSend_fpret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000685 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000686 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000687 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000688 "objc_msgSend_fpret_fixup");
689 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000690
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000691 llvm::Constant *getMessageSendStretFixupFn() {
692 // id objc_msgSend_stret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000693 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000694 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000695 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000696 "objc_msgSend_stret_fixup");
697 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000698
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000699 llvm::Constant *getMessageSendSuper2FixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000700 // id objc_msgSendSuper2_fixup (struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000701 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000702 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000703 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000704 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000705 "objc_msgSendSuper2_fixup");
706 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000707
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000708 llvm::Constant *getMessageSendSuper2StretFixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000709 // id objc_msgSendSuper2_stret_fixup(struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000710 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000711 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000712 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000713 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000714 "objc_msgSendSuper2_stret_fixup");
715 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000716
Chris Lattnera7c00b42009-04-22 02:15:23 +0000717 llvm::Constant *getObjCEndCatchFn() {
John McCall9dc0db22011-05-15 01:53:33 +0000718 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000719 "objc_end_catch");
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000720
Chris Lattnera7c00b42009-04-22 02:15:23 +0000721 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000722
Chris Lattnera7c00b42009-04-22 02:15:23 +0000723 llvm::Constant *getObjCBeginCatchFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000724 llvm::Type *params[] = { Int8PtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000725 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(Int8PtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000726 params, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000727 "objc_begin_catch");
728 }
Daniel Dunbarb1559a42009-03-01 04:46:24 +0000729
Chris Lattnera5f58b02011-07-09 17:41:47 +0000730 llvm::StructType *EHTypeTy;
731 llvm::Type *EHTypePtrTy;
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +0000732
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000733 ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000734};
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000735
Saleem Abdulrasool271106c2016-09-16 23:41:13 +0000736enum class ObjCLabelType {
737 ClassName,
738 MethodVarName,
739 MethodVarType,
740 PropertyName,
741};
742
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000743class CGObjCCommonMac : public CodeGen::CGObjCRuntime {
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000744public:
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000745 class SKIP_SCAN {
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000746 public:
747 unsigned skip;
748 unsigned scan;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000749 SKIP_SCAN(unsigned _skip = 0, unsigned _scan = 0)
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000750 : skip(_skip), scan(_scan) {}
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000751 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000752
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000753 /// opcode for captured block variables layout 'instructions'.
754 /// In the following descriptions, 'I' is the value of the immediate field.
755 /// (field following the opcode).
756 ///
757 enum BLOCK_LAYOUT_OPCODE {
758 /// An operator which affects how the following layout should be
759 /// interpreted.
760 /// I == 0: Halt interpretation and treat everything else as
761 /// a non-pointer. Note that this instruction is equal
762 /// to '\0'.
763 /// I != 0: Currently unused.
764 BLOCK_LAYOUT_OPERATOR = 0,
765
766 /// The next I+1 bytes do not contain a value of object pointer type.
767 /// Note that this can leave the stream unaligned, meaning that
768 /// subsequent word-size instructions do not begin at a multiple of
769 /// the pointer size.
770 BLOCK_LAYOUT_NON_OBJECT_BYTES = 1,
771
772 /// The next I+1 words do not contain a value of object pointer type.
773 /// This is simply an optimized version of BLOCK_LAYOUT_BYTES for
774 /// when the required skip quantity is a multiple of the pointer size.
775 BLOCK_LAYOUT_NON_OBJECT_WORDS = 2,
776
777 /// The next I+1 words are __strong pointers to Objective-C
778 /// objects or blocks.
779 BLOCK_LAYOUT_STRONG = 3,
780
781 /// The next I+1 words are pointers to __block variables.
782 BLOCK_LAYOUT_BYREF = 4,
783
784 /// The next I+1 words are __weak pointers to Objective-C
785 /// objects or blocks.
786 BLOCK_LAYOUT_WEAK = 5,
787
788 /// The next I+1 words are __unsafe_unretained pointers to
789 /// Objective-C objects or blocks.
790 BLOCK_LAYOUT_UNRETAINED = 6
791
792 /// The next I+1 words are block or object pointers with some
793 /// as-yet-unspecified ownership semantics. If we add more
794 /// flavors of ownership semantics, values will be taken from
795 /// this range.
796 ///
797 /// This is included so that older tools can at least continue
798 /// processing the layout past such things.
799 //BLOCK_LAYOUT_OWNERSHIP_UNKNOWN = 7..10,
800
801 /// All other opcodes are reserved. Halt interpretation and
802 /// treat everything else as opaque.
803 };
804
805 class RUN_SKIP {
806 public:
807 enum BLOCK_LAYOUT_OPCODE opcode;
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000808 CharUnits block_var_bytepos;
809 CharUnits block_var_size;
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000810 RUN_SKIP(enum BLOCK_LAYOUT_OPCODE Opcode = BLOCK_LAYOUT_OPERATOR,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000811 CharUnits BytePos = CharUnits::Zero(),
812 CharUnits Size = CharUnits::Zero())
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +0000813 : opcode(Opcode), block_var_bytepos(BytePos), block_var_size(Size) {}
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000814
815 // Allow sorting based on byte pos.
816 bool operator<(const RUN_SKIP &b) const {
817 return block_var_bytepos < b.block_var_bytepos;
818 }
819 };
820
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000821protected:
Owen Andersonae86c192009-07-13 04:10:07 +0000822 llvm::LLVMContext &VMContext;
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000823 // FIXME! May not be needing this after all.
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000824 unsigned ObjCABI;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000825
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000826 // arc/mrr layout of captured block literal variables.
827 SmallVector<RUN_SKIP, 16> RunSkipBlockVars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000828
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000829 /// LazySymbols - Symbols to generate a lazy reference for. See
830 /// DefinedSymbols and FinishModule().
Daniel Dunbard027a922009-09-07 00:20:42 +0000831 llvm::SetVector<IdentifierInfo*> LazySymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000832
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000833 /// DefinedSymbols - External symbols which are defined by this
834 /// module. The symbols in this list and LazySymbols are used to add
835 /// special linker symbols which ensure that Objective-C modules are
836 /// linked properly.
Daniel Dunbard027a922009-09-07 00:20:42 +0000837 llvm::SetVector<IdentifierInfo*> DefinedSymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000838
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000839 /// ClassNames - uniqued class names.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000840 llvm::StringMap<llvm::GlobalVariable*> ClassNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000841
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000842 /// MethodVarNames - uniqued method variable names.
843 llvm::DenseMap<Selector, llvm::GlobalVariable*> MethodVarNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000844
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000845 /// DefinedCategoryNames - list of category names in form Class_Category.
Rafael Espindolacd676622015-11-18 06:54:13 +0000846 llvm::SmallSetVector<std::string, 16> DefinedCategoryNames;
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000847
Daniel Dunbarb036db82008-08-13 03:21:16 +0000848 /// MethodVarTypes - uniqued method type signatures. We have to use
849 /// a StringMap here because have no other unique reference.
850 llvm::StringMap<llvm::GlobalVariable*> MethodVarTypes;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000851
Daniel Dunbar3c76cb52008-08-26 21:51:14 +0000852 /// MethodDefinitions - map of methods which have been defined in
853 /// this translation unit.
854 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*> MethodDefinitions;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000855
Daniel Dunbar80a840b2008-08-23 00:19:03 +0000856 /// PropertyNames - uniqued method variable names.
857 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> PropertyNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000858
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000859 /// ClassReferences - uniqued class references.
860 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> ClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000861
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000862 /// SelectorReferences - uniqued selector references.
863 llvm::DenseMap<Selector, llvm::GlobalVariable*> SelectorReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000864
Daniel Dunbarb036db82008-08-13 03:21:16 +0000865 /// Protocols - Protocols for which an objc_protocol structure has
866 /// been emitted. Forward declarations are handled by creating an
867 /// empty structure whose initializer is filled in when/if defined.
868 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> Protocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000869
Daniel Dunbarc475d422008-10-29 22:36:39 +0000870 /// DefinedProtocols - Protocols which have actually been
871 /// defined. We should not need this, see FIXME in GenerateProtocol.
872 llvm::DenseSet<IdentifierInfo*> DefinedProtocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000873
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000874 /// DefinedClasses - List of defined classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000875 SmallVector<llvm::GlobalValue*, 16> DefinedClasses;
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +0000876
877 /// ImplementedClasses - List of @implemented classes.
878 SmallVector<const ObjCInterfaceDecl*, 16> ImplementedClasses;
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000879
880 /// DefinedNonLazyClasses - List of defined "non-lazy" classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000881 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyClasses;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000882
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000883 /// DefinedCategories - List of defined categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000884 SmallVector<llvm::GlobalValue*, 16> DefinedCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000885
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000886 /// DefinedNonLazyCategories - List of defined "non-lazy" categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000887 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000888
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000889 /// GetNameForMethod - Return a name for the given method.
890 /// \param[out] NameOut - The return value.
891 void GetNameForMethod(const ObjCMethodDecl *OMD,
892 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000893 SmallVectorImpl<char> &NameOut);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000894
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000895 /// GetMethodVarName - Return a unique constant for the given
896 /// selector's name. The return value has type char *.
897 llvm::Constant *GetMethodVarName(Selector Sel);
898 llvm::Constant *GetMethodVarName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000899
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000900 /// GetMethodVarType - Return a unique constant for the given
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000901 /// method's type encoding string. The return value has type char *.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000902
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000903 // FIXME: This is a horrible name.
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000904 llvm::Constant *GetMethodVarType(const ObjCMethodDecl *D,
905 bool Extended = false);
Daniel Dunbarf5c18462009-04-20 06:54:31 +0000906 llvm::Constant *GetMethodVarType(const FieldDecl *D);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000907
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000908 /// GetPropertyName - Return a unique constant for the given
909 /// name. The return value has type char *.
910 llvm::Constant *GetPropertyName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000911
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000912 // FIXME: This can be dropped once string functions are unified.
913 llvm::Constant *GetPropertyTypeString(const ObjCPropertyDecl *PD,
914 const Decl *Container);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000915
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +0000916 /// GetClassName - Return a unique constant for the given selector's
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000917 /// runtime name (which may change via use of objc_runtime_name attribute on
918 /// class or protocol definition. The return value has type char *.
919 llvm::Constant *GetClassName(StringRef RuntimeName);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000920
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +0000921 llvm::Function *GetMethodDefinition(const ObjCMethodDecl *MD);
922
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +0000923 /// BuildIvarLayout - Builds ivar layout bitmap for the class
924 /// implementation for the __strong or __weak case.
925 ///
John McCall460ce582015-10-22 18:38:17 +0000926 /// \param hasMRCWeakIvars - Whether we are compiling in MRC and there
927 /// are any weak ivars defined directly in the class. Meaningless unless
928 /// building a weak layout. Does not guarantee that the layout will
929 /// actually have any entries, because the ivar might be under-aligned.
Fariborz Jahanian1bf72882009-03-12 22:50:49 +0000930 llvm::Constant *BuildIvarLayout(const ObjCImplementationDecl *OI,
John McCall3fd13f062015-10-21 18:06:47 +0000931 CharUnits beginOffset,
932 CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +0000933 bool forStrongLayout,
934 bool hasMRCWeakIvars);
935
936 llvm::Constant *BuildStrongIvarLayout(const ObjCImplementationDecl *OI,
937 CharUnits beginOffset,
938 CharUnits endOffset) {
939 return BuildIvarLayout(OI, beginOffset, endOffset, true, false);
940 }
941
942 llvm::Constant *BuildWeakIvarLayout(const ObjCImplementationDecl *OI,
943 CharUnits beginOffset,
944 CharUnits endOffset,
945 bool hasMRCWeakIvars) {
946 return BuildIvarLayout(OI, beginOffset, endOffset, false, hasMRCWeakIvars);
947 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +0000948
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000949 Qualifiers::ObjCLifetime getBlockCaptureLifetime(QualType QT, bool ByrefLayout);
Fariborz Jahanian2dd78192012-11-02 22:51:18 +0000950
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000951 void UpdateRunSkipBlockVars(bool IsByref,
952 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000953 CharUnits FieldOffset,
954 CharUnits FieldSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000955
956 void BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000957 CharUnits BytePos, bool &HasUnion,
958 bool ByrefLayout=false);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000959
960 void BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
961 const RecordDecl *RD,
962 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000963 CharUnits BytePos, bool &HasUnion,
964 bool ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000965
Fariborz Jahanian23290b02012-11-01 18:32:55 +0000966 uint64_t InlineLayoutInstruction(SmallVectorImpl<unsigned char> &Layout);
967
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000968 llvm::Constant *getBitmapBlockLayout(bool ComputeByrefLayout);
969
Fariborz Jahanian01dff422009-03-05 19:17:31 +0000970 /// GetIvarLayoutName - Returns a unique constant for the given
971 /// ivar layout bitmap.
972 llvm::Constant *GetIvarLayoutName(IdentifierInfo *Ident,
973 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000974
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000975 /// EmitPropertyList - Emit the given property list. The return
976 /// value has type PropertyListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000977 llvm::Constant *EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000978 const Decl *Container,
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000979 const ObjCContainerDecl *OCD,
Manman Renad0e7912016-01-29 19:22:54 +0000980 const ObjCCommonTypesHelper &ObjCTypes,
981 bool IsClassProperty);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000982
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000983 /// EmitProtocolMethodTypes - Generate the array of extended method type
984 /// strings. The return value has type Int8PtrPtrTy.
985 llvm::Constant *EmitProtocolMethodTypes(Twine Name,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +0000986 ArrayRef<llvm::Constant*> MethodTypes,
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000987 const ObjCCommonTypesHelper &ObjCTypes);
988
Fariborz Jahanian751c1e72009-12-12 21:26:21 +0000989 /// PushProtocolProperties - Push protocol's property on the input stack.
Bill Wendlinga515b582012-02-09 22:16:49 +0000990 void PushProtocolProperties(
991 llvm::SmallPtrSet<const IdentifierInfo*, 16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000992 SmallVectorImpl<llvm::Constant*> &Properties,
Bill Wendlinga515b582012-02-09 22:16:49 +0000993 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +0000994 const ObjCProtocolDecl *Proto,
Manman Renad0e7912016-01-29 19:22:54 +0000995 const ObjCCommonTypesHelper &ObjCTypes,
996 bool IsClassProperty);
Fariborz Jahanian751c1e72009-12-12 21:26:21 +0000997
Fariborz Jahanian56b3b772009-01-29 19:24:30 +0000998 /// GetProtocolRef - Return a reference to the internal protocol
999 /// description, creating an empty one if it has not been
1000 /// defined. The return value has type ProtocolPtrTy.
1001 llvm::Constant *GetProtocolRef(const ObjCProtocolDecl *PD);
Fariborz Jahanian67726212009-03-08 20:18:37 +00001002
Douglas Gregor24ae22c2016-04-01 23:23:52 +00001003 /// Return a reference to the given Class using runtime calls rather than
1004 /// by a symbol reference.
1005 llvm::Value *EmitClassRefViaRuntime(CodeGenFunction &CGF,
1006 const ObjCInterfaceDecl *ID,
1007 ObjCCommonTypesHelper &ObjCTypes);
1008
John McCall3fd13f062015-10-21 18:06:47 +00001009public:
Daniel Dunbar30c65362009-03-09 20:09:19 +00001010 /// CreateMetadataVar - Create a global variable with internal
1011 /// linkage for use by the Objective-C runtime.
1012 ///
1013 /// This is a convenience wrapper which not only creates the
1014 /// variable, but also sets the section and alignment and adds the
Chris Lattnerf56501c2009-07-17 23:57:13 +00001015 /// global to the "llvm.used" list.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001016 ///
1017 /// \param Name - The variable name.
1018 /// \param Init - The variable initializer; this is also used to
1019 /// define the type of the variable.
Alp Toker541d5072014-06-07 23:30:53 +00001020 /// \param Section - The section the variable should go into, or empty.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001021 /// \param Align - The alignment for the variable, or 0.
1022 /// \param AddToUsed - Whether the variable should be added to
Daniel Dunbar4527d302009-04-14 17:42:51 +00001023 /// "llvm.used".
Alp Toker541d5072014-06-07 23:30:53 +00001024 llvm::GlobalVariable *CreateMetadataVar(Twine Name, llvm::Constant *Init,
John McCall7f416cc2015-09-08 08:05:57 +00001025 StringRef Section, CharUnits Align,
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001026 bool AddToUsed);
Daniel Dunbar30c65362009-03-09 20:09:19 +00001027
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00001028 llvm::GlobalVariable *CreateCStringLiteral(StringRef Name,
1029 ObjCLabelType LabelType);
1030
John McCall3fd13f062015-10-21 18:06:47 +00001031protected:
John McCall9e8bb002011-05-14 03:10:52 +00001032 CodeGen::RValue EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1033 ReturnValueSlot Return,
1034 QualType ResultType,
1035 llvm::Value *Sel,
1036 llvm::Value *Arg0,
1037 QualType Arg0Ty,
1038 bool IsSuper,
1039 const CallArgList &CallArgs,
1040 const ObjCMethodDecl *OMD,
John McCall1e3157b2015-09-10 22:27:50 +00001041 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001042 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbarf5c18462009-04-20 06:54:31 +00001043
Daniel Dunbar5e639272010-04-25 20:39:01 +00001044 /// EmitImageInfo - Emit the image info marker used to encode some module
1045 /// level information.
1046 void EmitImageInfo();
1047
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001048public:
Owen Andersonae86c192009-07-13 04:10:07 +00001049 CGObjCCommonMac(CodeGen::CodeGenModule &cgm) :
John McCalla729c622012-02-17 03:33:10 +00001050 CGObjCRuntime(cgm), VMContext(cgm.getLLVMContext()) { }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001051
John McCall3fd13f062015-10-21 18:06:47 +00001052 bool isNonFragileABI() const {
1053 return ObjCABI == 2;
1054 }
1055
John McCall7f416cc2015-09-08 08:05:57 +00001056 ConstantAddress GenerateConstantString(const StringLiteral *SL) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001057
Craig Topper4f12f102014-03-12 06:41:41 +00001058 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
Craig Topper8a13c412014-05-21 05:09:00 +00001059 const ObjCContainerDecl *CD=nullptr) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001060
1061 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001062
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001063 /// GetOrEmitProtocol - Get the protocol object for the given
1064 /// declaration, emitting it if necessary. The return value has type
1065 /// ProtocolPtrTy.
1066 virtual llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD)=0;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001067
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001068 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1069 /// object for the given declaration, emitting it if needed. These
1070 /// forward references will be filled in with empty bodies if no
1071 /// definition is seen. The return value has type ProtocolPtrTy.
1072 virtual llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD)=0;
Craig Topper4f12f102014-03-12 06:41:41 +00001073 llvm::Constant *BuildGCBlockLayout(CodeGen::CodeGenModule &CGM,
1074 const CGBlockInfo &blockInfo) override;
1075 llvm::Constant *BuildRCBlockLayout(CodeGen::CodeGenModule &CGM,
1076 const CGBlockInfo &blockInfo) override;
1077
1078 llvm::Constant *BuildByrefLayout(CodeGen::CodeGenModule &CGM,
1079 QualType T) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001080};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001081
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001082class CGObjCMac : public CGObjCCommonMac {
1083private:
1084 ObjCTypesHelper ObjCTypes;
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001085
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001086 /// EmitModuleInfo - Another marker encoding module level
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001087 /// information.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001088 void EmitModuleInfo();
1089
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001090 /// EmitModuleSymols - Emit module symbols, the list of defined
1091 /// classes and categories. The result has type SymtabPtrTy.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001092 llvm::Constant *EmitModuleSymbols();
1093
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001094 /// FinishModule - Write out global data structures at the end of
1095 /// processing a translation unit.
1096 void FinishModule();
Daniel Dunbarb036db82008-08-13 03:21:16 +00001097
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001098 /// EmitClassExtension - Generate the class extension structure used
1099 /// to store the weak ivar layout and properties. The return value
1100 /// has type ClassExtensionPtrTy.
John McCall3fd13f062015-10-21 18:06:47 +00001101 llvm::Constant *EmitClassExtension(const ObjCImplementationDecl *ID,
John McCall460ce582015-10-22 18:38:17 +00001102 CharUnits instanceSize,
Manman Renad0e7912016-01-29 19:22:54 +00001103 bool hasMRCWeakIvars,
1104 bool isClassProperty);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001105
1106 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1107 /// for the given class.
John McCall882987f2013-02-28 19:01:20 +00001108 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001109 const ObjCInterfaceDecl *ID);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001110
John McCall882987f2013-02-28 19:01:20 +00001111 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00001112 IdentifierInfo *II);
Craig Topper4f12f102014-03-12 06:41:41 +00001113
1114 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
1115
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001116 /// EmitSuperClassRef - Emits reference to class's main metadata class.
1117 llvm::Value *EmitSuperClassRef(const ObjCInterfaceDecl *ID);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001118
1119 /// EmitIvarList - Emit the ivar list for the given
1120 /// implementation. If ForClass is true the list of class ivars
1121 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1122 /// interface ivars will be emitted. The return value has type
1123 /// IvarListPtrTy.
1124 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00001125 bool ForClass);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001126
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001127 /// EmitMetaClass - Emit a forward reference to the class structure
1128 /// for the metaclass of the given interface. The return value has
1129 /// type ClassPtrTy.
1130 llvm::Constant *EmitMetaClassRef(const ObjCInterfaceDecl *ID);
1131
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001132 /// EmitMetaClass - Emit a class structure for the metaclass of the
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001133 /// given implementation. The return value has type ClassPtrTy.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001134 llvm::Constant *EmitMetaClass(const ObjCImplementationDecl *ID,
1135 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001136 ArrayRef<llvm::Constant*> Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001137
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001138 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001139
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001140 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001141
1142 /// EmitMethodList - Emit the method list for the given
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001143 /// implementation. The return value has type MethodListPtrTy.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001144 llvm::Constant *EmitMethodList(Twine Name, StringRef Section,
1145 ArrayRef<llvm::Constant *> Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001146
1147 /// EmitMethodDescList - Emit a method description list for a list of
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001148 /// method declarations.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001149 /// - TypeName: The name for the type containing the methods.
Sylvestre Ledru33b5baf2012-09-27 10:16:10 +00001150 /// - IsProtocol: True iff these methods are for a protocol.
1151 /// - ClassMethds: True iff these are class methods.
Daniel Dunbarb036db82008-08-13 03:21:16 +00001152 /// - Required: When true, only "required" methods are
1153 /// listed. Similarly, when false only "optional" methods are
1154 /// listed. For classes this should always be true.
1155 /// - begin, end: The method list to output.
1156 ///
1157 /// The return value has type MethodDescriptionListPtrTy.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001158 llvm::Constant *EmitMethodDescList(Twine Name, StringRef Section,
1159 ArrayRef<llvm::Constant *> Methods);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001160
Daniel Dunbarc475d422008-10-29 22:36:39 +00001161 /// GetOrEmitProtocol - Get the protocol object for the given
1162 /// declaration, emitting it if necessary. The return value has type
1163 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001164 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001165
1166 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1167 /// object for the given declaration, emitting it if needed. These
1168 /// forward references will be filled in with empty bodies if no
1169 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001170 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001171
Daniel Dunbarb036db82008-08-13 03:21:16 +00001172 /// EmitProtocolExtension - Generate the protocol extension
1173 /// structure used to store optional instance and class methods, and
1174 /// protocol properties. The return value has type
1175 /// ProtocolExtensionPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001176 llvm::Constant *
1177 EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00001178 ArrayRef<llvm::Constant*> OptInstanceMethods,
1179 ArrayRef<llvm::Constant*> OptClassMethods,
1180 ArrayRef<llvm::Constant*> MethodTypesExt);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001181
1182 /// EmitProtocolList - Generate the list of referenced
1183 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001184 llvm::Constant *EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00001185 ObjCProtocolDecl::protocol_iterator begin,
1186 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001187
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001188 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1189 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001190 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1191 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001192
1193public:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001194 CGObjCMac(CodeGen::CodeGenModule &cgm);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001195
Craig Topper4f12f102014-03-12 06:41:41 +00001196 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001197
Craig Topper4f12f102014-03-12 06:41:41 +00001198 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1199 ReturnValueSlot Return,
1200 QualType ResultType,
1201 Selector Sel, llvm::Value *Receiver,
1202 const CallArgList &CallArgs,
1203 const ObjCInterfaceDecl *Class,
1204 const ObjCMethodDecl *Method) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001205
Craig Topper4f12f102014-03-12 06:41:41 +00001206 CodeGen::RValue
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001207 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001208 ReturnValueSlot Return, QualType ResultType,
1209 Selector Sel, const ObjCInterfaceDecl *Class,
1210 bool isCategoryImpl, llvm::Value *Receiver,
1211 bool IsClassMessage, const CallArgList &CallArgs,
1212 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001213
Craig Topper4f12f102014-03-12 06:41:41 +00001214 llvm::Value *GetClass(CodeGenFunction &CGF,
1215 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001216
John McCall7f416cc2015-09-08 08:05:57 +00001217 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
1218 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001219
1220 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1221 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001222 llvm::Value *GetSelector(CodeGenFunction &CGF,
1223 const ObjCMethodDecl *Method) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001224
Craig Topper4f12f102014-03-12 06:41:41 +00001225 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001226
Craig Topper4f12f102014-03-12 06:41:41 +00001227 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001228
Craig Topper4f12f102014-03-12 06:41:41 +00001229 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001230
Craig Topper4f12f102014-03-12 06:41:41 +00001231 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001232
Craig Topper4f12f102014-03-12 06:41:41 +00001233 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1234 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001235
Craig Topper4f12f102014-03-12 06:41:41 +00001236 llvm::Constant *GetPropertyGetFunction() override;
1237 llvm::Constant *GetPropertySetFunction() override;
1238 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1239 bool copy) override;
1240 llvm::Constant *GetGetStructFunction() override;
1241 llvm::Constant *GetSetStructFunction() override;
1242 llvm::Constant *GetCppAtomicObjectGetFunction() override;
1243 llvm::Constant *GetCppAtomicObjectSetFunction() override;
1244 llvm::Constant *EnumerationMutationFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001245
Craig Topper4f12f102014-03-12 06:41:41 +00001246 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1247 const ObjCAtTryStmt &S) override;
1248 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1249 const ObjCAtSynchronizedStmt &S) override;
John McCallbd309292010-07-06 01:34:17 +00001250 void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, const Stmt &S);
Craig Topper4f12f102014-03-12 06:41:41 +00001251 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1252 bool ClearInsertionPoint=true) override;
1253 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001254 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001255 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001256 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001257 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001258 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001259 bool threadlocal = false) override;
1260 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001261 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001262 llvm::Value *ivarOffset) override;
1263 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001264 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001265 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001266 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001267 llvm::Value *size) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001268
Craig Topper4f12f102014-03-12 06:41:41 +00001269 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1270 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1271 unsigned CVRQualifiers) override;
1272 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1273 const ObjCInterfaceDecl *Interface,
1274 const ObjCIvarDecl *Ivar) override;
1275
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001276 /// GetClassGlobal - Return the global variable for the Objective-C
1277 /// class of the given name.
Benjamin Kramer0772c422016-02-13 13:42:54 +00001278 llvm::GlobalVariable *GetClassGlobal(StringRef Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001279 bool Weak = false) override {
David Blaikie83d382b2011-09-23 05:06:16 +00001280 llvm_unreachable("CGObjCMac::GetClassGlobal");
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001281 }
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001282};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001283
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001284class CGObjCNonFragileABIMac : public CGObjCCommonMac {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001285private:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001286 ObjCNonFragileABITypesHelper ObjCTypes;
Fariborz Jahanian71394042009-01-23 23:53:38 +00001287 llvm::GlobalVariable* ObjCEmptyCacheVar;
1288 llvm::GlobalVariable* ObjCEmptyVtableVar;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001289
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001290 /// SuperClassReferences - uniqued super class references.
1291 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> SuperClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001292
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001293 /// MetaClassReferences - uniqued meta class references.
1294 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> MetaClassReferences;
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001295
1296 /// EHTypeReferences - uniqued class ehtype references.
1297 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> EHTypeReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001298
John McCall9e8bb002011-05-14 03:10:52 +00001299 /// VTableDispatchMethods - List of methods for which we generate
1300 /// vtable-based message dispatch.
1301 llvm::DenseSet<Selector> VTableDispatchMethods;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001302
Fariborz Jahanian67260552009-11-17 21:37:35 +00001303 /// DefinedMetaClasses - List of defined meta-classes.
1304 std::vector<llvm::GlobalValue*> DefinedMetaClasses;
1305
John McCall9e8bb002011-05-14 03:10:52 +00001306 /// isVTableDispatchedSelector - Returns true if SEL is a
1307 /// vtable-based selector.
1308 bool isVTableDispatchedSelector(Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001309
Fariborz Jahanian71394042009-01-23 23:53:38 +00001310 /// FinishNonFragileABIModule - Write out global data structures at the end of
1311 /// processing a translation unit.
1312 void FinishNonFragileABIModule();
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001313
Daniel Dunbar19573e72009-05-15 21:48:48 +00001314 /// AddModuleClassList - Add the given list of class pointers to the
1315 /// module with the provided symbol and section names.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001316 void AddModuleClassList(ArrayRef<llvm::GlobalValue *> Container,
1317 StringRef SymbolName, StringRef SectionName);
Daniel Dunbar19573e72009-05-15 21:48:48 +00001318
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001319 llvm::GlobalVariable * BuildClassRoTInitializer(unsigned flags,
1320 unsigned InstanceStart,
1321 unsigned InstanceSize,
1322 const ObjCImplementationDecl *ID);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001323 llvm::GlobalVariable * BuildClassMetaData(const std::string &ClassName,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001324 llvm::Constant *IsAGV,
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00001325 llvm::Constant *SuperClassGV,
Fariborz Jahanian82208252009-01-31 00:59:10 +00001326 llvm::Constant *ClassRoGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00001327 bool HiddenVisibility,
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00001328 bool Weak);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001329
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001330 llvm::Constant *GetMethodConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001331
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00001332 llvm::Constant *GetMethodDescriptionConstant(const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001333
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00001334 /// EmitMethodList - Emit the method list for the given
1335 /// implementation. The return value has type MethodListnfABITy.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001336 llvm::Constant *EmitMethodList(Twine Name, StringRef Section,
1337 ArrayRef<llvm::Constant *> Methods);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00001338 /// EmitIvarList - Emit the ivar list for the given
1339 /// implementation. If ForClass is true the list of class ivars
1340 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1341 /// interface ivars will be emitted. The return value has type
1342 /// IvarListnfABIPtrTy.
1343 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001344
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001345 llvm::Constant *EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00001346 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00001347 unsigned long int offset);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001348
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001349 /// GetOrEmitProtocol - Get the protocol object for the given
1350 /// declaration, emitting it if necessary. The return value has type
1351 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001352 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001353
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001354 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1355 /// object for the given declaration, emitting it if needed. These
1356 /// forward references will be filled in with empty bodies if no
1357 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001358 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001359
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001360 /// EmitProtocolList - Generate the list of referenced
1361 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001362 llvm::Constant *EmitProtocolList(Twine Name,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001363 ObjCProtocolDecl::protocol_iterator begin,
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00001364 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001365
John McCall9e8bb002011-05-14 03:10:52 +00001366 CodeGen::RValue EmitVTableMessageSend(CodeGen::CodeGenFunction &CGF,
1367 ReturnValueSlot Return,
1368 QualType ResultType,
1369 Selector Sel,
1370 llvm::Value *Receiver,
1371 QualType Arg0Ty,
1372 bool IsSuper,
1373 const CallArgList &CallArgs,
1374 const ObjCMethodDecl *Method);
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001375
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00001376 /// GetClassGlobal - Return the global variable for the Objective-C
1377 /// class of the given name.
Benjamin Kramer0772c422016-02-13 13:42:54 +00001378 llvm::GlobalVariable *GetClassGlobal(StringRef Name,
Craig Toppera798a9d2014-03-02 09:32:10 +00001379 bool Weak = false) override;
Rafael Espindola554256c2014-02-26 22:25:45 +00001380
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00001381 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001382 /// for the given class reference.
John McCall882987f2013-02-28 19:01:20 +00001383 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001384 const ObjCInterfaceDecl *ID);
John McCall31168b02011-06-15 23:02:42 +00001385
John McCall882987f2013-02-28 19:01:20 +00001386 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001387 IdentifierInfo *II, bool Weak,
1388 const ObjCInterfaceDecl *ID);
Craig Topper4f12f102014-03-12 06:41:41 +00001389
1390 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001391
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001392 /// EmitSuperClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1393 /// for the given super class reference.
John McCall882987f2013-02-28 19:01:20 +00001394 llvm::Value *EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001395 const ObjCInterfaceDecl *ID);
1396
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001397 /// EmitMetaClassRef - Return a Value * of the address of _class_t
1398 /// meta-data
John McCall882987f2013-02-28 19:01:20 +00001399 llvm::Value *EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00001400 const ObjCInterfaceDecl *ID, bool Weak);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001401
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001402 /// ObjCIvarOffsetVariable - Returns the ivar offset variable for
1403 /// the given ivar.
1404 ///
Daniel Dunbara1060522009-04-19 00:31:15 +00001405 llvm::GlobalVariable * ObjCIvarOffsetVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001406 const ObjCInterfaceDecl *ID,
1407 const ObjCIvarDecl *Ivar);
1408
Fariborz Jahanian74b77222009-02-11 20:51:17 +00001409 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1410 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001411 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1412 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001413
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001414 /// GetInterfaceEHType - Get the cached ehtype for the given Objective-C
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001415 /// interface. The return value has type EHTypePtrTy.
John McCall2ca705e2010-07-24 00:37:23 +00001416 llvm::Constant *GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001417 bool ForDefinition);
Daniel Dunbar15894b72009-04-07 05:48:37 +00001418
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001419 StringRef getMetaclassSymbolPrefix() const { return "OBJC_METACLASS_$_"; }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001420
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001421 StringRef getClassSymbolPrefix() const { return "OBJC_CLASS_$_"; }
Daniel Dunbar15894b72009-04-07 05:48:37 +00001422
Daniel Dunbar961202372009-05-03 12:57:56 +00001423 void GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00001424 uint32_t &InstanceStart,
1425 uint32_t &InstanceSize);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001426
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001427 // Shamelessly stolen from Analysis/CFRefCount.cpp
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001428 Selector GetNullarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001429 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1430 return CGM.getContext().Selectors.getSelector(0, &II);
1431 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001432
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001433 Selector GetUnarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001434 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1435 return CGM.getContext().Selectors.getSelector(1, &II);
1436 }
Daniel Dunbar554fd792009-04-19 23:41:48 +00001437
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001438 /// ImplementationIsNonLazy - Check whether the given category or
1439 /// class implementation is "non-lazy".
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00001440 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001441
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001442 bool IsIvarOffsetKnownIdempotent(const CodeGen::CodeGenFunction &CGF,
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001443 const ObjCIvarDecl *IV) {
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001444 // Annotate the load as an invariant load iff inside an instance method
1445 // and ivar belongs to instance method's class and one of its super class.
1446 // This check is needed because the ivar offset is a lazily
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001447 // initialised value that may depend on objc_msgSend to perform a fixup on
1448 // the first message dispatch.
1449 //
1450 // An additional opportunity to mark the load as invariant arises when the
1451 // base of the ivar access is a parameter to an Objective C method.
1452 // However, because the parameters are not available in the current
1453 // interface, we cannot perform this check.
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001454 if (const ObjCMethodDecl *MD =
1455 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurFuncDecl))
Fariborz Jahanian7a583022014-03-04 22:57:32 +00001456 if (MD->isInstanceMethod())
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001457 if (const ObjCInterfaceDecl *ID = MD->getClassInterface())
1458 return IV->getContainingInterface()->isSuperClassOf(ID);
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001459 return false;
1460 }
1461
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001462public:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001463 CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian71394042009-01-23 23:53:38 +00001464 // FIXME. All stubs for now!
Craig Topper4f12f102014-03-12 06:41:41 +00001465 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001466
Craig Topper4f12f102014-03-12 06:41:41 +00001467 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1468 ReturnValueSlot Return,
1469 QualType ResultType, Selector Sel,
1470 llvm::Value *Receiver,
1471 const CallArgList &CallArgs,
1472 const ObjCInterfaceDecl *Class,
1473 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001474
Craig Topper4f12f102014-03-12 06:41:41 +00001475 CodeGen::RValue
Fariborz Jahanian71394042009-01-23 23:53:38 +00001476 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001477 ReturnValueSlot Return, QualType ResultType,
1478 Selector Sel, const ObjCInterfaceDecl *Class,
1479 bool isCategoryImpl, llvm::Value *Receiver,
1480 bool IsClassMessage, const CallArgList &CallArgs,
1481 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001482
Craig Topper4f12f102014-03-12 06:41:41 +00001483 llvm::Value *GetClass(CodeGenFunction &CGF,
1484 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001485
John McCall7f416cc2015-09-08 08:05:57 +00001486 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override
1487 { return EmitSelector(CGF, Sel); }
1488 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override
1489 { return EmitSelectorAddr(CGF, Sel); }
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001490
1491 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1492 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001493 llvm::Value *GetSelector(CodeGenFunction &CGF,
1494 const ObjCMethodDecl *Method) override
John McCall882987f2013-02-28 19:01:20 +00001495 { return EmitSelector(CGF, Method->getSelector()); }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001496
Craig Topper4f12f102014-03-12 06:41:41 +00001497 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001498
Craig Topper4f12f102014-03-12 06:41:41 +00001499 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
David Chisnall92d436b2012-01-31 18:59:20 +00001500
Craig Topper4f12f102014-03-12 06:41:41 +00001501 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001502
Craig Topper4f12f102014-03-12 06:41:41 +00001503 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1504 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001505
Craig Topper4f12f102014-03-12 06:41:41 +00001506 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001507
Craig Topper4f12f102014-03-12 06:41:41 +00001508 llvm::Constant *GetPropertyGetFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001509 return ObjCTypes.getGetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001510 }
Craig Topper4f12f102014-03-12 06:41:41 +00001511 llvm::Constant *GetPropertySetFunction() override {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001512 return ObjCTypes.getSetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001513 }
Craig Topper4f12f102014-03-12 06:41:41 +00001514
1515 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1516 bool copy) override {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001517 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
1518 }
Craig Topper4f12f102014-03-12 06:41:41 +00001519
1520 llvm::Constant *GetSetStructFunction() override {
David Chisnall168b80f2010-12-26 22:13:16 +00001521 return ObjCTypes.getCopyStructFn();
1522 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001523
Craig Topper4f12f102014-03-12 06:41:41 +00001524 llvm::Constant *GetGetStructFunction() override {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00001525 return ObjCTypes.getCopyStructFn();
1526 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001527
Craig Topper4f12f102014-03-12 06:41:41 +00001528 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +00001529 return ObjCTypes.getCppAtomicObjectFunction();
1530 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001531
Craig Topper4f12f102014-03-12 06:41:41 +00001532 llvm::Constant *GetCppAtomicObjectGetFunction() override {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00001533 return ObjCTypes.getCppAtomicObjectFunction();
1534 }
Craig Topper4f12f102014-03-12 06:41:41 +00001535
1536 llvm::Constant *EnumerationMutationFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001537 return ObjCTypes.getEnumerationMutationFn();
Daniel Dunbard73ea8162009-02-16 18:48:45 +00001538 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001539
Craig Topper4f12f102014-03-12 06:41:41 +00001540 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1541 const ObjCAtTryStmt &S) override;
1542 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1543 const ObjCAtSynchronizedStmt &S) override;
1544 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1545 bool ClearInsertionPoint=true) override;
1546 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001547 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001548 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001549 llvm::Value *src, Address edst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001550 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001551 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001552 bool threadlocal = false) override;
1553 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001554 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001555 llvm::Value *ivarOffset) override;
1556 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001557 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001558 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001559 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001560 llvm::Value *size) override;
1561 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1562 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1563 unsigned CVRQualifiers) override;
1564 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1565 const ObjCInterfaceDecl *Interface,
1566 const ObjCIvarDecl *Ivar) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001567};
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001568
1569/// A helper class for performing the null-initialization of a return
1570/// value.
1571struct NullReturnState {
1572 llvm::BasicBlock *NullBB;
Craig Topper8a13c412014-05-21 05:09:00 +00001573 NullReturnState() : NullBB(nullptr) {}
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001574
John McCall3d1e2c92013-02-12 05:53:35 +00001575 /// Perform a null-check of the given receiver.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001576 void init(CodeGenFunction &CGF, llvm::Value *receiver) {
John McCall3d1e2c92013-02-12 05:53:35 +00001577 // Make blocks for the null-receiver and call edges.
1578 NullBB = CGF.createBasicBlock("msgSend.null-receiver");
1579 llvm::BasicBlock *callBB = CGF.createBasicBlock("msgSend.call");
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001580
1581 // Check for a null receiver and, if there is one, jump to the
John McCall3d1e2c92013-02-12 05:53:35 +00001582 // null-receiver block. There's no point in trying to avoid it:
1583 // we're always going to put *something* there, because otherwise
1584 // we shouldn't have done this null-check in the first place.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001585 llvm::Value *isNull = CGF.Builder.CreateIsNull(receiver);
1586 CGF.Builder.CreateCondBr(isNull, NullBB, callBB);
1587
1588 // Otherwise, start performing the call.
1589 CGF.EmitBlock(callBB);
1590 }
1591
John McCall3d1e2c92013-02-12 05:53:35 +00001592 /// Complete the null-return operation. It is valid to call this
1593 /// regardless of whether 'init' has been called.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001594 RValue complete(CodeGenFunction &CGF, RValue result, QualType resultType,
1595 const CallArgList &CallArgs,
1596 const ObjCMethodDecl *Method) {
John McCall3d1e2c92013-02-12 05:53:35 +00001597 // If we never had to do a null-check, just use the raw result.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001598 if (!NullBB) return result;
John McCall3d1e2c92013-02-12 05:53:35 +00001599
1600 // The continuation block. This will be left null if we don't have an
1601 // IP, which can happen if the method we're calling is marked noreturn.
Craig Topper8a13c412014-05-21 05:09:00 +00001602 llvm::BasicBlock *contBB = nullptr;
1603
John McCall3d1e2c92013-02-12 05:53:35 +00001604 // Finish the call path.
1605 llvm::BasicBlock *callBB = CGF.Builder.GetInsertBlock();
1606 if (callBB) {
1607 contBB = CGF.createBasicBlock("msgSend.cont");
1608 CGF.Builder.CreateBr(contBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001609 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001610
John McCall3d1e2c92013-02-12 05:53:35 +00001611 // Okay, start emitting the null-receiver block.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001612 CGF.EmitBlock(NullBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001613
John McCall3d1e2c92013-02-12 05:53:35 +00001614 // Release any consumed arguments we've got.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001615 if (Method) {
1616 CallArgList::const_iterator I = CallArgs.begin();
1617 for (ObjCMethodDecl::param_const_iterator i = Method->param_begin(),
1618 e = Method->param_end(); i != e; ++i, ++I) {
1619 const ParmVarDecl *ParamDecl = (*i);
1620 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1621 RValue RV = I->RV;
1622 assert(RV.isScalar() &&
1623 "NullReturnState::complete - arg not on object");
John McCallcdda29c2013-03-13 03:10:54 +00001624 CGF.EmitARCRelease(RV.getScalarVal(), ARCImpreciseLifetime);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001625 }
1626 }
1627 }
John McCall3d1e2c92013-02-12 05:53:35 +00001628
1629 // The phi code below assumes that we haven't needed any control flow yet.
1630 assert(CGF.Builder.GetInsertBlock() == NullBB);
1631
1632 // If we've got a void return, just jump to the continuation block.
1633 if (result.isScalar() && resultType->isVoidType()) {
1634 // No jumps required if the message-send was noreturn.
1635 if (contBB) CGF.EmitBlock(contBB);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001636 return result;
1637 }
1638
John McCall3d1e2c92013-02-12 05:53:35 +00001639 // If we've got a scalar return, build a phi.
1640 if (result.isScalar()) {
1641 // Derive the null-initialization value.
1642 llvm::Constant *null = CGF.CGM.EmitNullConstant(resultType);
1643
1644 // If no join is necessary, just flow out.
1645 if (!contBB) return RValue::get(null);
1646
1647 // Otherwise, build a phi.
1648 CGF.EmitBlock(contBB);
1649 llvm::PHINode *phi = CGF.Builder.CreatePHI(null->getType(), 2);
1650 phi->addIncoming(result.getScalarVal(), callBB);
1651 phi->addIncoming(null, NullBB);
1652 return RValue::get(phi);
1653 }
1654
1655 // If we've got an aggregate return, null the buffer out.
1656 // FIXME: maybe we should be doing things differently for all the
1657 // cases where the ABI has us returning (1) non-agg values in
1658 // memory or (2) agg values in registers.
1659 if (result.isAggregate()) {
1660 assert(result.isAggregate() && "null init of non-aggregate result?");
John McCall7f416cc2015-09-08 08:05:57 +00001661 CGF.EmitNullInitialization(result.getAggregateAddress(), resultType);
John McCall3d1e2c92013-02-12 05:53:35 +00001662 if (contBB) CGF.EmitBlock(contBB);
1663 return result;
1664 }
1665
1666 // Complex types.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001667 CGF.EmitBlock(contBB);
John McCall3d1e2c92013-02-12 05:53:35 +00001668 CodeGenFunction::ComplexPairTy callResult = result.getComplexVal();
1669
1670 // Find the scalar type and its zero value.
1671 llvm::Type *scalarTy = callResult.first->getType();
1672 llvm::Constant *scalarZero = llvm::Constant::getNullValue(scalarTy);
1673
1674 // Build phis for both coordinates.
1675 llvm::PHINode *real = CGF.Builder.CreatePHI(scalarTy, 2);
1676 real->addIncoming(callResult.first, callBB);
1677 real->addIncoming(scalarZero, NullBB);
1678 llvm::PHINode *imag = CGF.Builder.CreatePHI(scalarTy, 2);
1679 imag->addIncoming(callResult.second, callBB);
1680 imag->addIncoming(scalarZero, NullBB);
1681 return RValue::getComplex(real, imag);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001682 }
1683};
1684
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001685} // end anonymous namespace
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001686
1687/* *** Helper Functions *** */
1688
1689/// getConstantGEP() - Help routine to construct simple GEPs.
Owen Anderson170229f2009-07-14 23:10:40 +00001690static llvm::Constant *getConstantGEP(llvm::LLVMContext &VMContext,
David Blaikiee3b172a2015-04-02 18:55:21 +00001691 llvm::GlobalVariable *C, unsigned idx0,
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001692 unsigned idx1) {
1693 llvm::Value *Idxs[] = {
Owen Anderson41a75022009-08-13 21:57:51 +00001694 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx0),
1695 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx1)
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001696 };
David Blaikiee3b172a2015-04-02 18:55:21 +00001697 return llvm::ConstantExpr::getGetElementPtr(C->getValueType(), C, Idxs);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001698}
1699
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001700/// hasObjCExceptionAttribute - Return true if this class or any super
1701/// class has the __objc_exception__ attribute.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001702static bool hasObjCExceptionAttribute(ASTContext &Context,
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001703 const ObjCInterfaceDecl *OID) {
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001704 if (OID->hasAttr<ObjCExceptionAttr>())
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001705 return true;
1706 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001707 return hasObjCExceptionAttribute(Context, Super);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001708 return false;
1709}
1710
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001711/* *** CGObjCMac Public Interface *** */
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001712
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001713CGObjCMac::CGObjCMac(CodeGen::CodeGenModule &cgm) : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00001714 ObjCTypes(cgm) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001715 ObjCABI = 1;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001716 EmitImageInfo();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001717}
1718
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001719/// GetClass - Return a reference to the class for the given interface
1720/// decl.
John McCall882987f2013-02-28 19:01:20 +00001721llvm::Value *CGObjCMac::GetClass(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001722 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00001723 return EmitClassRef(CGF, ID);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001724}
1725
1726/// GetSelector - Return the pointer to the unique'd string for this selector.
John McCall7f416cc2015-09-08 08:05:57 +00001727llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1728 return EmitSelector(CGF, Sel);
1729}
1730Address CGObjCMac::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1731 return EmitSelectorAddr(CGF, Sel);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001732}
John McCall882987f2013-02-28 19:01:20 +00001733llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, const ObjCMethodDecl
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001734 *Method) {
John McCall882987f2013-02-28 19:01:20 +00001735 return EmitSelector(CGF, Method->getSelector());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001736}
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001737
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001738llvm::Constant *CGObjCMac::GetEHType(QualType T) {
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001739 if (T->isObjCIdType() ||
1740 T->isObjCQualifiedIdType()) {
1741 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001742 CGM.getContext().getObjCIdRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001743 }
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001744 if (T->isObjCClassType() ||
1745 T->isObjCQualifiedClassType()) {
1746 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001747 CGM.getContext().getObjCClassRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001748 }
1749 if (T->isObjCObjectPointerType())
1750 return CGM.GetAddrOfRTTIDescriptor(T, /*ForEH=*/true);
1751
John McCall2ca705e2010-07-24 00:37:23 +00001752 llvm_unreachable("asking for catch type for ObjC type in fragile runtime");
John McCall2ca705e2010-07-24 00:37:23 +00001753}
1754
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001755/// Generate a constant CFString object.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001756/*
1757 struct __builtin_CFString {
1758 const int *isa; // point to __CFConstantStringClassReference
1759 int flags;
1760 const char *str;
1761 long length;
1762 };
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001763*/
1764
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001765/// or Generate a constant NSString object.
1766/*
1767 struct __builtin_NSString {
1768 const int *isa; // point to __NSConstantStringClassReference
1769 const char *str;
1770 unsigned int length;
1771 };
1772*/
1773
John McCall7f416cc2015-09-08 08:05:57 +00001774ConstantAddress CGObjCCommonMac::GenerateConstantString(
David Chisnall481e3a82010-01-23 02:40:42 +00001775 const StringLiteral *SL) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001776 return (CGM.getLangOpts().NoConstantCFStrings == 0 ?
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001777 CGM.GetAddrOfConstantCFString(SL) :
Fariborz Jahanian50c925f2010-10-19 17:19:29 +00001778 CGM.GetAddrOfConstantString(SL));
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001779}
1780
Ted Kremeneke65b0862012-03-06 20:05:56 +00001781enum {
1782 kCFTaggedObjectID_Integer = (1 << 1) + 1
1783};
1784
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001785/// Generates a message send where the super is the receiver. This is
1786/// a message send to self with special delivery semantics indicating
1787/// which class's method should be called.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001788CodeGen::RValue
1789CGObjCMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001790 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001791 QualType ResultType,
1792 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001793 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001794 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001795 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001796 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001797 const CodeGen::CallArgList &CallArgs,
1798 const ObjCMethodDecl *Method) {
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001799 // Create and init a super structure; this is a (receiver, class)
1800 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00001801 Address ObjCSuper =
1802 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
1803 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001804 llvm::Value *ReceiverAsObject =
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001805 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00001806 CGF.Builder.CreateStore(
1807 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00001808 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001809
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001810 // If this is a class message the metaclass is passed as the target.
1811 llvm::Value *Target;
1812 if (IsClassMessage) {
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001813 if (isCategoryImpl) {
1814 // Message sent to 'super' in a class method defined in a category
1815 // implementation requires an odd treatment.
1816 // If we are in a class method, we must retrieve the
1817 // _metaclass_ for the current class, pointed at by
1818 // the class's "isa" pointer. The following assumes that
1819 // isa" is the first ivar in a class (which it must be).
John McCall882987f2013-02-28 19:01:20 +00001820 Target = EmitClassRef(CGF, Class->getSuperClass());
David Blaikie1ed728c2015-04-05 22:45:47 +00001821 Target = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, Target, 0);
John McCall7f416cc2015-09-08 08:05:57 +00001822 Target = CGF.Builder.CreateAlignedLoad(Target, CGF.getPointerAlign());
Mike Stump658fe022009-07-30 22:28:39 +00001823 } else {
David Blaikie1ed728c2015-04-05 22:45:47 +00001824 llvm::Constant *MetaClassPtr = EmitMetaClassRef(Class);
1825 llvm::Value *SuperPtr =
1826 CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, MetaClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001827 llvm::Value *Super =
1828 CGF.Builder.CreateAlignedLoad(SuperPtr, CGF.getPointerAlign());
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001829 Target = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001830 }
David Blaikie1ed728c2015-04-05 22:45:47 +00001831 } else if (isCategoryImpl)
John McCall882987f2013-02-28 19:01:20 +00001832 Target = EmitClassRef(CGF, Class->getSuperClass());
Fariborz Jahanianda2efb02009-11-14 02:18:31 +00001833 else {
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001834 llvm::Value *ClassPtr = EmitSuperClassRef(Class);
David Blaikie1ed728c2015-04-05 22:45:47 +00001835 ClassPtr = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, ClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00001836 Target = CGF.Builder.CreateAlignedLoad(ClassPtr, CGF.getPointerAlign());
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001837 }
Mike Stump18bb9282009-05-16 07:57:57 +00001838 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
1839 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00001840 llvm::Type *ClassTy =
Daniel Dunbarc722b852008-08-30 03:02:31 +00001841 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
Daniel Dunbarc475d422008-10-29 22:36:39 +00001842 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
John McCall7f416cc2015-09-08 08:05:57 +00001843 CGF.Builder.CreateStore(Target,
1844 CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
John McCall9e8bb002011-05-14 03:10:52 +00001845 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001846 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00001847 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00001848 true, CallArgs, Method, Class, ObjCTypes);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001849}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001850
1851/// Generate code for a message send expression.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001852CodeGen::RValue CGObjCMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001853 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001854 QualType ResultType,
1855 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001856 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001857 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00001858 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001859 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00001860 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00001861 EmitSelector(CGF, Sel),
John McCall9e8bb002011-05-14 03:10:52 +00001862 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00001863 false, CallArgs, Method, Class, ObjCTypes);
1864}
1865
1866static bool isWeakLinkedClass(const ObjCInterfaceDecl *ID) {
1867 do {
1868 if (ID->isWeakImported())
1869 return true;
1870 } while ((ID = ID->getSuperClass()));
1871
1872 return false;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00001873}
1874
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001875CodeGen::RValue
John McCall9e8bb002011-05-14 03:10:52 +00001876CGObjCCommonMac::EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1877 ReturnValueSlot Return,
1878 QualType ResultType,
1879 llvm::Value *Sel,
1880 llvm::Value *Arg0,
1881 QualType Arg0Ty,
1882 bool IsSuper,
1883 const CallArgList &CallArgs,
1884 const ObjCMethodDecl *Method,
John McCall1e3157b2015-09-10 22:27:50 +00001885 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001886 const ObjCCommonTypesHelper &ObjCTypes) {
Daniel Dunbarc722b852008-08-30 03:02:31 +00001887 CallArgList ActualArgs;
Fariborz Jahanian969bc682009-04-24 21:07:43 +00001888 if (!IsSuper)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00001889 Arg0 = CGF.Builder.CreateBitCast(Arg0, ObjCTypes.ObjectPtrTy);
Eli Friedman43dca6a2011-05-02 17:57:46 +00001890 ActualArgs.add(RValue::get(Arg0), Arg0Ty);
1891 ActualArgs.add(RValue::get(Sel), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00001892 ActualArgs.addFrom(CallArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001893
John McCalla729c622012-02-17 03:33:10 +00001894 // If we're calling a method, use the formal signature.
1895 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001896
Anders Carlsson280e61f12010-06-21 20:59:55 +00001897 if (Method)
Alp Toker314cc812014-01-25 16:55:45 +00001898 assert(CGM.getContext().getCanonicalType(Method->getReturnType()) ==
1899 CGM.getContext().getCanonicalType(ResultType) &&
Anders Carlsson280e61f12010-06-21 20:59:55 +00001900 "Result type mismatch!");
1901
John McCall1e3157b2015-09-10 22:27:50 +00001902 bool ReceiverCanBeNull = true;
1903
1904 // Super dispatch assumes that self is non-null; even the messenger
1905 // doesn't have a null check internally.
1906 if (IsSuper) {
1907 ReceiverCanBeNull = false;
1908
1909 // If this is a direct dispatch of a class method, check whether the class,
1910 // or anything in its hierarchy, was weak-linked.
1911 } else if (ClassReceiver && Method && Method->isClassMethod()) {
1912 ReceiverCanBeNull = isWeakLinkedClass(ClassReceiver);
1913
1914 // If we're emitting a method, and self is const (meaning just ARC, for now),
1915 // and the receiver is a load of self, then self is a valid object.
1916 } else if (auto CurMethod =
1917 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl)) {
1918 auto Self = CurMethod->getSelfDecl();
1919 if (Self->getType().isConstQualified()) {
1920 if (auto LI = dyn_cast<llvm::LoadInst>(Arg0->stripPointerCasts())) {
1921 llvm::Value *SelfAddr = CGF.GetAddrOfLocalVar(Self).getPointer();
1922 if (SelfAddr == LI->getPointerOperand()) {
1923 ReceiverCanBeNull = false;
1924 }
1925 }
1926 }
1927 }
1928
John McCall5880fb82011-05-14 21:12:11 +00001929 NullReturnState nullReturn;
1930
Craig Topper8a13c412014-05-21 05:09:00 +00001931 llvm::Constant *Fn = nullptr;
Tim Northovere77cc392014-03-29 13:28:05 +00001932 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall1e3157b2015-09-10 22:27:50 +00001933 if (ReceiverCanBeNull) nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001934 Fn = (ObjCABI == 2) ? ObjCTypes.getSendStretFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001935 : ObjCTypes.getSendStretFn(IsSuper);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00001936 } else if (CGM.ReturnTypeUsesFPRet(ResultType)) {
1937 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFpretFn2(IsSuper)
1938 : ObjCTypes.getSendFpretFn(IsSuper);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00001939 } else if (CGM.ReturnTypeUsesFP2Ret(ResultType)) {
1940 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFp2RetFn2(IsSuper)
1941 : ObjCTypes.getSendFp2retFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001942 } else {
Tim Northovere77cc392014-03-29 13:28:05 +00001943 // arm64 uses objc_msgSend for stret methods and yet null receiver check
1944 // must be made for it.
Ahmed Bougachaa3df87b2015-10-02 22:41:59 +00001945 if (ReceiverCanBeNull && CGM.ReturnTypeUsesSRet(MSI.CallInfo))
Tim Northovere77cc392014-03-29 13:28:05 +00001946 nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00001947 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001948 : ObjCTypes.getSendFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00001949 }
John McCall1e3157b2015-09-10 22:27:50 +00001950
1951 // Emit a null-check if there's a consumed argument other than the receiver.
1952 bool RequiresNullCheck = false;
1953 if (ReceiverCanBeNull && CGM.getLangOpts().ObjCAutoRefCount && Method) {
David Majnemer59f77922016-06-24 04:05:48 +00001954 for (const auto *ParamDecl : Method->parameters()) {
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001955 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1956 if (!nullReturn.NullBB)
1957 nullReturn.init(CGF, Arg0);
John McCall1e3157b2015-09-10 22:27:50 +00001958 RequiresNullCheck = true;
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001959 break;
1960 }
1961 }
John McCall1e3157b2015-09-10 22:27:50 +00001962 }
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001963
John McCall1e3157b2015-09-10 22:27:50 +00001964 llvm::Instruction *CallSite;
John McCalla729c622012-02-17 03:33:10 +00001965 Fn = llvm::ConstantExpr::getBitCast(Fn, MSI.MessengerType);
John McCall1e3157b2015-09-10 22:27:50 +00001966 RValue rvalue = CGF.EmitCall(MSI.CallInfo, Fn, Return, ActualArgs,
Samuel Antao798f11c2015-11-23 22:04:44 +00001967 CGCalleeInfo(), &CallSite);
John McCall1e3157b2015-09-10 22:27:50 +00001968
1969 // Mark the call as noreturn if the method is marked noreturn and the
1970 // receiver cannot be null.
1971 if (Method && Method->hasAttr<NoReturnAttr>() && !ReceiverCanBeNull) {
1972 llvm::CallSite(CallSite).setDoesNotReturn();
1973 }
1974
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001975 return nullReturn.complete(CGF, rvalue, ResultType, CallArgs,
John McCall1e3157b2015-09-10 22:27:50 +00001976 RequiresNullCheck ? Method : nullptr);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001977}
1978
John McCall3fd13f062015-10-21 18:06:47 +00001979static Qualifiers::GC GetGCAttrTypeForType(ASTContext &Ctx, QualType FQT,
1980 bool pointee = false) {
1981 // Note that GC qualification applies recursively to C pointer types
1982 // that aren't otherwise decorated. This is weird, but it's probably
1983 // an intentional workaround to the unreliable placement of GC qualifiers.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001984 if (FQT.isObjCGCStrong())
1985 return Qualifiers::Strong;
John McCall3fd13f062015-10-21 18:06:47 +00001986
1987 if (FQT.isObjCGCWeak())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00001988 return Qualifiers::Weak;
John McCall3fd13f062015-10-21 18:06:47 +00001989
1990 if (auto ownership = FQT.getObjCLifetime()) {
1991 // Ownership does not apply recursively to C pointer types.
1992 if (pointee) return Qualifiers::GCNone;
1993 switch (ownership) {
1994 case Qualifiers::OCL_Weak: return Qualifiers::Weak;
1995 case Qualifiers::OCL_Strong: return Qualifiers::Strong;
1996 case Qualifiers::OCL_ExplicitNone: return Qualifiers::GCNone;
1997 case Qualifiers::OCL_Autoreleasing: llvm_unreachable("autoreleasing ivar?");
1998 case Qualifiers::OCL_None: llvm_unreachable("known nonzero");
1999 }
2000 llvm_unreachable("bad objc ownership");
2001 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002002
John McCall3fd13f062015-10-21 18:06:47 +00002003 // Treat unqualified retainable pointers as strong.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002004 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
2005 return Qualifiers::Strong;
2006
John McCall3fd13f062015-10-21 18:06:47 +00002007 // Walk into C pointer types, but only in GC.
2008 if (Ctx.getLangOpts().getGC() != LangOptions::NonGC) {
2009 if (const PointerType *PT = FQT->getAs<PointerType>())
2010 return GetGCAttrTypeForType(Ctx, PT->getPointeeType(), /*pointee*/ true);
2011 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002012
2013 return Qualifiers::GCNone;
2014}
2015
John McCall3fd13f062015-10-21 18:06:47 +00002016namespace {
2017 struct IvarInfo {
2018 CharUnits Offset;
2019 uint64_t SizeInWords;
2020 IvarInfo(CharUnits offset, uint64_t sizeInWords)
2021 : Offset(offset), SizeInWords(sizeInWords) {}
2022
2023 // Allow sorting based on byte pos.
2024 bool operator<(const IvarInfo &other) const {
2025 return Offset < other.Offset;
2026 }
2027 };
2028
2029 /// A helper class for building GC layout strings.
2030 class IvarLayoutBuilder {
2031 CodeGenModule &CGM;
2032
2033 /// The start of the layout. Offsets will be relative to this value,
2034 /// and entries less than this value will be silently discarded.
2035 CharUnits InstanceBegin;
2036
2037 /// The end of the layout. Offsets will never exceed this value.
2038 CharUnits InstanceEnd;
2039
2040 /// Whether we're generating the strong layout or the weak layout.
2041 bool ForStrongLayout;
2042
2043 /// Whether the offsets in IvarsInfo might be out-of-order.
2044 bool IsDisordered = false;
2045
2046 llvm::SmallVector<IvarInfo, 8> IvarsInfo;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002047
John McCall3fd13f062015-10-21 18:06:47 +00002048 public:
2049 IvarLayoutBuilder(CodeGenModule &CGM, CharUnits instanceBegin,
2050 CharUnits instanceEnd, bool forStrongLayout)
2051 : CGM(CGM), InstanceBegin(instanceBegin), InstanceEnd(instanceEnd),
2052 ForStrongLayout(forStrongLayout) {
2053 }
2054
2055 void visitRecord(const RecordType *RT, CharUnits offset);
2056
2057 template <class Iterator, class GetOffsetFn>
2058 void visitAggregate(Iterator begin, Iterator end,
2059 CharUnits aggrOffset,
2060 const GetOffsetFn &getOffset);
2061
2062 void visitField(const FieldDecl *field, CharUnits offset);
2063
2064 /// Add the layout of a block implementation.
2065 void visitBlock(const CGBlockInfo &blockInfo);
2066
2067 /// Is there any information for an interesting bitmap?
2068 bool hasBitmapData() const { return !IvarsInfo.empty(); }
2069
2070 llvm::Constant *buildBitmap(CGObjCCommonMac &CGObjC,
2071 llvm::SmallVectorImpl<unsigned char> &buffer);
2072
2073 static void dump(ArrayRef<unsigned char> buffer) {
2074 const unsigned char *s = buffer.data();
2075 for (unsigned i = 0, e = buffer.size(); i < e; i++)
2076 if (!(s[i] & 0xf0))
2077 printf("0x0%x%s", s[i], s[i] != 0 ? ", " : "");
2078 else
2079 printf("0x%x%s", s[i], s[i] != 0 ? ", " : "");
2080 printf("\n");
2081 }
2082 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002083} // end anonymous namespace
John McCall3fd13f062015-10-21 18:06:47 +00002084
John McCall351762c2011-02-07 10:33:21 +00002085llvm::Constant *CGObjCCommonMac::BuildGCBlockLayout(CodeGenModule &CGM,
2086 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002087
Chris Lattnerece04092012-02-07 00:39:47 +00002088 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
John McCall460ce582015-10-22 18:38:17 +00002089 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
John McCall351762c2011-02-07 10:33:21 +00002090 return nullPtr;
2091
John McCall3fd13f062015-10-21 18:06:47 +00002092 IvarLayoutBuilder builder(CGM, CharUnits::Zero(), blockInfo.BlockSize,
2093 /*for strong layout*/ true);
2094
2095 builder.visitBlock(blockInfo);
2096
2097 if (!builder.hasBitmapData())
2098 return nullPtr;
2099
2100 llvm::SmallVector<unsigned char, 32> buffer;
2101 llvm::Constant *C = builder.buildBitmap(*this, buffer);
John McCallf5ea0722015-10-29 23:36:14 +00002102 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
John McCall3fd13f062015-10-21 18:06:47 +00002103 printf("\n block variable layout for block: ");
2104 builder.dump(buffer);
2105 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002106
John McCall3fd13f062015-10-21 18:06:47 +00002107 return C;
2108}
2109
2110void IvarLayoutBuilder::visitBlock(const CGBlockInfo &blockInfo) {
Fariborz Jahaniancfddabf2010-09-09 00:21:45 +00002111 // __isa is the first field in block descriptor and must assume by runtime's
2112 // convention that it is GC'able.
John McCall3fd13f062015-10-21 18:06:47 +00002113 IvarsInfo.push_back(IvarInfo(CharUnits::Zero(), 1));
John McCall351762c2011-02-07 10:33:21 +00002114
2115 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2116
John McCall351762c2011-02-07 10:33:21 +00002117 // Ignore the optional 'this' capture: C++ objects are not assumed
2118 // to be GC'ed.
2119
John McCall3fd13f062015-10-21 18:06:47 +00002120 CharUnits lastFieldOffset;
2121
John McCall351762c2011-02-07 10:33:21 +00002122 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002123 for (const auto &CI : blockDecl->captures()) {
2124 const VarDecl *variable = CI.getVariable();
John McCall351762c2011-02-07 10:33:21 +00002125 QualType type = variable->getType();
2126
2127 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2128
2129 // Ignore constant captures.
2130 if (capture.isConstant()) continue;
2131
John McCall3fd13f062015-10-21 18:06:47 +00002132 CharUnits fieldOffset = capture.getOffset();
2133
2134 // Block fields are not necessarily ordered; if we detect that we're
2135 // adding them out-of-order, make sure we sort later.
2136 if (fieldOffset < lastFieldOffset)
2137 IsDisordered = true;
2138 lastFieldOffset = fieldOffset;
John McCall351762c2011-02-07 10:33:21 +00002139
2140 // __block variables are passed by their descriptor address.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002141 if (CI.isByRef()) {
John McCall3fd13f062015-10-21 18:06:47 +00002142 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
Fariborz Jahanian933c6722010-09-11 01:27:29 +00002143 continue;
John McCall351762c2011-02-07 10:33:21 +00002144 }
2145
2146 assert(!type->isArrayType() && "array variable should not be caught");
2147 if (const RecordType *record = type->getAs<RecordType>()) {
John McCall3fd13f062015-10-21 18:06:47 +00002148 visitRecord(record, fieldOffset);
Fariborz Jahanian903aba32010-08-05 21:00:25 +00002149 continue;
2150 }
Fariborz Jahanianf95e3582010-08-06 16:28:55 +00002151
John McCall351762c2011-02-07 10:33:21 +00002152 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), type);
John McCall351762c2011-02-07 10:33:21 +00002153
John McCall3fd13f062015-10-21 18:06:47 +00002154 if (GCAttr == Qualifiers::Strong) {
2155 assert(CGM.getContext().getTypeSize(type)
2156 == CGM.getTarget().getPointerWidth(0));
2157 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
2158 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002159 }
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00002160}
2161
Fariborz Jahanian2c96d302012-11-04 18:19:40 +00002162/// getBlockCaptureLifetime - This routine returns life time of the captured
2163/// block variable for the purpose of block layout meta-data generation. FQT is
2164/// the type of the variable captured in the block.
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002165Qualifiers::ObjCLifetime CGObjCCommonMac::getBlockCaptureLifetime(QualType FQT,
2166 bool ByrefLayout) {
John McCall460ce582015-10-22 18:38:17 +00002167 // If it has an ownership qualifier, we're done.
2168 if (auto lifetime = FQT.getObjCLifetime())
2169 return lifetime;
2170
2171 // If it doesn't, and this is ARC, it has no ownership.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002172 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall460ce582015-10-22 18:38:17 +00002173 return Qualifiers::OCL_None;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002174
John McCall460ce582015-10-22 18:38:17 +00002175 // In MRC, retainable pointers are owned by non-__block variables.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002176 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002177 return ByrefLayout ? Qualifiers::OCL_ExplicitNone : Qualifiers::OCL_Strong;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002178
2179 return Qualifiers::OCL_None;
2180}
2181
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002182void CGObjCCommonMac::UpdateRunSkipBlockVars(bool IsByref,
2183 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002184 CharUnits FieldOffset,
2185 CharUnits FieldSize) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002186 // __block variables are passed by their descriptor address.
2187 if (IsByref)
2188 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_BYREF, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002189 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002190 else if (LifeTime == Qualifiers::OCL_Strong)
2191 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_STRONG, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002192 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002193 else if (LifeTime == Qualifiers::OCL_Weak)
2194 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_WEAK, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002195 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002196 else if (LifeTime == Qualifiers::OCL_ExplicitNone)
2197 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_UNRETAINED, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002198 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002199 else
2200 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_NON_OBJECT_BYTES,
2201 FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002202 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002203}
2204
2205void CGObjCCommonMac::BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
2206 const RecordDecl *RD,
2207 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002208 CharUnits BytePos, bool &HasUnion,
2209 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002210 bool IsUnion = (RD && RD->isUnion());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002211 CharUnits MaxUnionSize = CharUnits::Zero();
Craig Topper8a13c412014-05-21 05:09:00 +00002212 const FieldDecl *MaxField = nullptr;
2213 const FieldDecl *LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002214 CharUnits MaxFieldOffset = CharUnits::Zero();
2215 CharUnits LastBitfieldOrUnnamedOffset = CharUnits::Zero();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002216
2217 if (RecFields.empty())
2218 return;
John McCallc8e01702013-04-16 22:48:15 +00002219 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002220
2221 for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
2222 const FieldDecl *Field = RecFields[i];
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002223 // Note that 'i' here is actually the field index inside RD of Field,
2224 // although this dependency is hidden.
2225 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002226 CharUnits FieldOffset =
2227 CGM.getContext().toCharUnitsFromBits(RL.getFieldOffset(i));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002228
2229 // Skip over unnamed or bitfields
2230 if (!Field->getIdentifier() || Field->isBitField()) {
2231 LastFieldBitfieldOrUnnamed = Field;
2232 LastBitfieldOrUnnamedOffset = FieldOffset;
2233 continue;
2234 }
Craig Topper8a13c412014-05-21 05:09:00 +00002235
2236 LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002237 QualType FQT = Field->getType();
2238 if (FQT->isRecordType() || FQT->isUnionType()) {
2239 if (FQT->isUnionType())
2240 HasUnion = true;
2241
2242 BuildRCBlockVarRecordLayout(FQT->getAs<RecordType>(),
2243 BytePos + FieldOffset, HasUnion);
2244 continue;
2245 }
2246
2247 if (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2248 const ConstantArrayType *CArray =
2249 dyn_cast_or_null<ConstantArrayType>(Array);
2250 uint64_t ElCount = CArray->getSize().getZExtValue();
2251 assert(CArray && "only array with known element size is supported");
2252 FQT = CArray->getElementType();
2253 while (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2254 const ConstantArrayType *CArray =
2255 dyn_cast_or_null<ConstantArrayType>(Array);
2256 ElCount *= CArray->getSize().getZExtValue();
2257 FQT = CArray->getElementType();
2258 }
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002259 if (FQT->isRecordType() && ElCount) {
2260 int OldIndex = RunSkipBlockVars.size() - 1;
2261 const RecordType *RT = FQT->getAs<RecordType>();
2262 BuildRCBlockVarRecordLayout(RT, BytePos + FieldOffset,
2263 HasUnion);
2264
2265 // Replicate layout information for each array element. Note that
2266 // one element is already done.
2267 uint64_t ElIx = 1;
2268 for (int FirstIndex = RunSkipBlockVars.size() - 1 ;ElIx < ElCount; ElIx++) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002269 CharUnits Size = CGM.getContext().getTypeSizeInChars(RT);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002270 for (int i = OldIndex+1; i <= FirstIndex; ++i)
2271 RunSkipBlockVars.push_back(
2272 RUN_SKIP(RunSkipBlockVars[i].opcode,
2273 RunSkipBlockVars[i].block_var_bytepos + Size*ElIx,
2274 RunSkipBlockVars[i].block_var_size));
2275 }
2276 continue;
2277 }
2278 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002279 CharUnits FieldSize = CGM.getContext().getTypeSizeInChars(Field->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002280 if (IsUnion) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002281 CharUnits UnionIvarSize = FieldSize;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002282 if (UnionIvarSize > MaxUnionSize) {
2283 MaxUnionSize = UnionIvarSize;
2284 MaxField = Field;
2285 MaxFieldOffset = FieldOffset;
2286 }
2287 } else {
2288 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002289 getBlockCaptureLifetime(FQT, ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002290 BytePos + FieldOffset,
2291 FieldSize);
2292 }
2293 }
2294
2295 if (LastFieldBitfieldOrUnnamed) {
2296 if (LastFieldBitfieldOrUnnamed->isBitField()) {
2297 // Last field was a bitfield. Must update the info.
2298 uint64_t BitFieldSize
2299 = LastFieldBitfieldOrUnnamed->getBitWidthValue(CGM.getContext());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002300 unsigned UnsSize = (BitFieldSize / ByteSizeInBits) +
Eli Friedman8cbca202012-11-06 22:15:52 +00002301 ((BitFieldSize % ByteSizeInBits) != 0);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002302 CharUnits Size = CharUnits::fromQuantity(UnsSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002303 Size += LastBitfieldOrUnnamedOffset;
2304 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002305 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2306 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002307 BytePos + LastBitfieldOrUnnamedOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002308 Size);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002309 } else {
2310 assert(!LastFieldBitfieldOrUnnamed->getIdentifier() &&"Expected unnamed");
2311 // Last field was unnamed. Must update skip info.
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002312 CharUnits FieldSize
2313 = CGM.getContext().getTypeSizeInChars(LastFieldBitfieldOrUnnamed->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002314 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002315 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2316 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002317 BytePos + LastBitfieldOrUnnamedOffset,
2318 FieldSize);
2319 }
2320 }
2321
2322 if (MaxField)
2323 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002324 getBlockCaptureLifetime(MaxField->getType(), ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002325 BytePos + MaxFieldOffset,
2326 MaxUnionSize);
2327}
2328
2329void CGObjCCommonMac::BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002330 CharUnits BytePos,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002331 bool &HasUnion,
2332 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002333 const RecordDecl *RD = RT->getDecl();
Aaron Ballman62e47c42014-03-10 13:43:55 +00002334 SmallVector<const FieldDecl*, 16> Fields(RD->fields());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002335 llvm::Type *Ty = CGM.getTypes().ConvertType(QualType(RT, 0));
2336 const llvm::StructLayout *RecLayout =
2337 CGM.getDataLayout().getStructLayout(cast<llvm::StructType>(Ty));
2338
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002339 BuildRCRecordLayout(RecLayout, RD, Fields, BytePos, HasUnion, ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002340}
2341
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002342/// InlineLayoutInstruction - This routine produce an inline instruction for the
2343/// block variable layout if it can. If not, it returns 0. Rules are as follow:
2344/// If ((uintptr_t) layout) < (1 << 12), the layout is inline. In the 64bit world,
2345/// an inline layout of value 0x0000000000000xyz is interpreted as follows:
2346/// x captured object pointers of BLOCK_LAYOUT_STRONG. Followed by
2347/// y captured object of BLOCK_LAYOUT_BYREF. Followed by
2348/// z captured object of BLOCK_LAYOUT_WEAK. If any of the above is missing, zero
2349/// replaces it. For example, 0x00000x00 means x BLOCK_LAYOUT_STRONG and no
2350/// BLOCK_LAYOUT_BYREF and no BLOCK_LAYOUT_WEAK objects are captured.
2351uint64_t CGObjCCommonMac::InlineLayoutInstruction(
2352 SmallVectorImpl<unsigned char> &Layout) {
2353 uint64_t Result = 0;
2354 if (Layout.size() <= 3) {
2355 unsigned size = Layout.size();
2356 unsigned strong_word_count = 0, byref_word_count=0, weak_word_count=0;
2357 unsigned char inst;
2358 enum BLOCK_LAYOUT_OPCODE opcode ;
2359 switch (size) {
2360 case 3:
2361 inst = Layout[0];
2362 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2363 if (opcode == BLOCK_LAYOUT_STRONG)
2364 strong_word_count = (inst & 0xF)+1;
2365 else
2366 return 0;
2367 inst = Layout[1];
2368 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2369 if (opcode == BLOCK_LAYOUT_BYREF)
2370 byref_word_count = (inst & 0xF)+1;
2371 else
2372 return 0;
2373 inst = Layout[2];
2374 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2375 if (opcode == BLOCK_LAYOUT_WEAK)
2376 weak_word_count = (inst & 0xF)+1;
2377 else
2378 return 0;
2379 break;
2380
2381 case 2:
2382 inst = Layout[0];
2383 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2384 if (opcode == BLOCK_LAYOUT_STRONG) {
2385 strong_word_count = (inst & 0xF)+1;
2386 inst = Layout[1];
2387 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2388 if (opcode == BLOCK_LAYOUT_BYREF)
2389 byref_word_count = (inst & 0xF)+1;
2390 else if (opcode == BLOCK_LAYOUT_WEAK)
2391 weak_word_count = (inst & 0xF)+1;
2392 else
2393 return 0;
2394 }
2395 else if (opcode == BLOCK_LAYOUT_BYREF) {
2396 byref_word_count = (inst & 0xF)+1;
2397 inst = Layout[1];
2398 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2399 if (opcode == BLOCK_LAYOUT_WEAK)
2400 weak_word_count = (inst & 0xF)+1;
2401 else
2402 return 0;
2403 }
2404 else
2405 return 0;
2406 break;
2407
2408 case 1:
2409 inst = Layout[0];
2410 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2411 if (opcode == BLOCK_LAYOUT_STRONG)
2412 strong_word_count = (inst & 0xF)+1;
2413 else if (opcode == BLOCK_LAYOUT_BYREF)
2414 byref_word_count = (inst & 0xF)+1;
2415 else if (opcode == BLOCK_LAYOUT_WEAK)
2416 weak_word_count = (inst & 0xF)+1;
2417 else
2418 return 0;
2419 break;
2420
2421 default:
2422 return 0;
2423 }
2424
2425 // Cannot inline when any of the word counts is 15. Because this is one less
2426 // than the actual work count (so 15 means 16 actual word counts),
2427 // and we can only display 0 thru 15 word counts.
2428 if (strong_word_count == 16 || byref_word_count == 16 || weak_word_count == 16)
2429 return 0;
2430
2431 unsigned count =
2432 (strong_word_count != 0) + (byref_word_count != 0) + (weak_word_count != 0);
2433
2434 if (size == count) {
2435 if (strong_word_count)
2436 Result = strong_word_count;
2437 Result <<= 4;
2438 if (byref_word_count)
2439 Result += byref_word_count;
2440 Result <<= 4;
2441 if (weak_word_count)
2442 Result += weak_word_count;
2443 }
2444 }
2445 return Result;
2446}
2447
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002448llvm::Constant *CGObjCCommonMac::getBitmapBlockLayout(bool ComputeByrefLayout) {
2449 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2450 if (RunSkipBlockVars.empty())
2451 return nullPtr;
John McCallc8e01702013-04-16 22:48:15 +00002452 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2453 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002454 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2455
2456 // Sort on byte position; captures might not be allocated in order,
2457 // and unions can do funny things.
2458 llvm::array_pod_sort(RunSkipBlockVars.begin(), RunSkipBlockVars.end());
2459 SmallVector<unsigned char, 16> Layout;
2460
2461 unsigned size = RunSkipBlockVars.size();
2462 for (unsigned i = 0; i < size; i++) {
2463 enum BLOCK_LAYOUT_OPCODE opcode = RunSkipBlockVars[i].opcode;
2464 CharUnits start_byte_pos = RunSkipBlockVars[i].block_var_bytepos;
2465 CharUnits end_byte_pos = start_byte_pos;
2466 unsigned j = i+1;
2467 while (j < size) {
2468 if (opcode == RunSkipBlockVars[j].opcode) {
2469 end_byte_pos = RunSkipBlockVars[j++].block_var_bytepos;
2470 i++;
2471 }
2472 else
2473 break;
2474 }
2475 CharUnits size_in_bytes =
2476 end_byte_pos - start_byte_pos + RunSkipBlockVars[j-1].block_var_size;
2477 if (j < size) {
2478 CharUnits gap =
2479 RunSkipBlockVars[j].block_var_bytepos -
2480 RunSkipBlockVars[j-1].block_var_bytepos - RunSkipBlockVars[j-1].block_var_size;
2481 size_in_bytes += gap;
2482 }
2483 CharUnits residue_in_bytes = CharUnits::Zero();
2484 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES) {
2485 residue_in_bytes = size_in_bytes % WordSizeInBytes;
2486 size_in_bytes -= residue_in_bytes;
2487 opcode = BLOCK_LAYOUT_NON_OBJECT_WORDS;
2488 }
2489
2490 unsigned size_in_words = size_in_bytes.getQuantity() / WordSizeInBytes;
2491 while (size_in_words >= 16) {
2492 // Note that value in imm. is one less that the actual
2493 // value. So, 0xf means 16 words follow!
2494 unsigned char inst = (opcode << 4) | 0xf;
2495 Layout.push_back(inst);
2496 size_in_words -= 16;
2497 }
2498 if (size_in_words > 0) {
2499 // Note that value in imm. is one less that the actual
2500 // value. So, we subtract 1 away!
2501 unsigned char inst = (opcode << 4) | (size_in_words-1);
2502 Layout.push_back(inst);
2503 }
2504 if (residue_in_bytes > CharUnits::Zero()) {
2505 unsigned char inst =
2506 (BLOCK_LAYOUT_NON_OBJECT_BYTES << 4) | (residue_in_bytes.getQuantity()-1);
2507 Layout.push_back(inst);
2508 }
2509 }
2510
John McCall7f416cc2015-09-08 08:05:57 +00002511 while (!Layout.empty()) {
2512 unsigned char inst = Layout.back();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002513 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2514 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES || opcode == BLOCK_LAYOUT_NON_OBJECT_WORDS)
2515 Layout.pop_back();
2516 else
2517 break;
2518 }
2519
2520 uint64_t Result = InlineLayoutInstruction(Layout);
2521 if (Result != 0) {
2522 // Block variable layout instruction has been inlined.
2523 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2524 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002525 printf("\n Inline BYREF variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002526 else
John McCall7f416cc2015-09-08 08:05:57 +00002527 printf("\n Inline block variable layout: ");
2528 printf("0x0%" PRIx64 "", Result);
2529 if (auto numStrong = (Result & 0xF00) >> 8)
2530 printf(", BL_STRONG:%d", (int) numStrong);
2531 if (auto numByref = (Result & 0x0F0) >> 4)
2532 printf(", BL_BYREF:%d", (int) numByref);
2533 if (auto numWeak = (Result & 0x00F) >> 0)
2534 printf(", BL_WEAK:%d", (int) numWeak);
2535 printf(", BL_OPERATOR:0\n");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002536 }
Vedant Kumar3ed0df02015-12-21 19:43:25 +00002537 return llvm::ConstantInt::get(CGM.IntPtrTy, Result);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002538 }
2539
2540 unsigned char inst = (BLOCK_LAYOUT_OPERATOR << 4) | 0;
2541 Layout.push_back(inst);
2542 std::string BitMap;
2543 for (unsigned i = 0, e = Layout.size(); i != e; i++)
2544 BitMap += Layout[i];
2545
2546 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2547 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002548 printf("\n Byref variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002549 else
John McCall7f416cc2015-09-08 08:05:57 +00002550 printf("\n Block variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002551 for (unsigned i = 0, e = BitMap.size(); i != e; i++) {
2552 unsigned char inst = BitMap[i];
2553 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2554 unsigned delta = 1;
2555 switch (opcode) {
2556 case BLOCK_LAYOUT_OPERATOR:
2557 printf("BL_OPERATOR:");
2558 delta = 0;
2559 break;
2560 case BLOCK_LAYOUT_NON_OBJECT_BYTES:
2561 printf("BL_NON_OBJECT_BYTES:");
2562 break;
2563 case BLOCK_LAYOUT_NON_OBJECT_WORDS:
2564 printf("BL_NON_OBJECT_WORD:");
2565 break;
2566 case BLOCK_LAYOUT_STRONG:
2567 printf("BL_STRONG:");
2568 break;
2569 case BLOCK_LAYOUT_BYREF:
2570 printf("BL_BYREF:");
2571 break;
2572 case BLOCK_LAYOUT_WEAK:
2573 printf("BL_WEAK:");
2574 break;
2575 case BLOCK_LAYOUT_UNRETAINED:
2576 printf("BL_UNRETAINED:");
2577 break;
2578 }
2579 // Actual value of word count is one more that what is in the imm.
2580 // field of the instruction
2581 printf("%d", (inst & 0xf) + delta);
2582 if (i < e-1)
2583 printf(", ");
2584 else
2585 printf("\n");
2586 }
2587 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002588
2589 llvm::GlobalVariable *Entry = CreateMetadataVar(
2590 "OBJC_CLASS_NAME_",
2591 llvm::ConstantDataArray::getString(VMContext, BitMap, false),
John McCall7f416cc2015-09-08 08:05:57 +00002592 "__TEXT,__objc_classname,cstring_literals", CharUnits::One(), true);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002593 return getConstantGEP(VMContext, Entry, 0, 0);
2594}
2595
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002596llvm::Constant *CGObjCCommonMac::BuildRCBlockLayout(CodeGenModule &CGM,
2597 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002598 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2599
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002600 RunSkipBlockVars.clear();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002601 bool hasUnion = false;
2602
John McCallc8e01702013-04-16 22:48:15 +00002603 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2604 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002605 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2606
2607 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2608
2609 // Calculate the basic layout of the block structure.
2610 const llvm::StructLayout *layout =
2611 CGM.getDataLayout().getStructLayout(blockInfo.StructureType);
2612
2613 // Ignore the optional 'this' capture: C++ objects are not assumed
2614 // to be GC'ed.
Fariborz Jahanian4cf177e2012-12-04 17:20:57 +00002615 if (blockInfo.BlockHeaderForcedGapSize != CharUnits::Zero())
2616 UpdateRunSkipBlockVars(false, Qualifiers::OCL_None,
2617 blockInfo.BlockHeaderForcedGapOffset,
2618 blockInfo.BlockHeaderForcedGapSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002619 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002620 for (const auto &CI : blockDecl->captures()) {
2621 const VarDecl *variable = CI.getVariable();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002622 QualType type = variable->getType();
2623
2624 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2625
2626 // Ignore constant captures.
2627 if (capture.isConstant()) continue;
2628
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002629 CharUnits fieldOffset =
2630 CharUnits::fromQuantity(layout->getElementOffset(capture.getIndex()));
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002631
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002632 assert(!type->isArrayType() && "array variable should not be caught");
Aaron Ballman9371dd22014-03-14 18:34:04 +00002633 if (!CI.isByRef())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002634 if (const RecordType *record = type->getAs<RecordType>()) {
2635 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion);
2636 continue;
2637 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002638 CharUnits fieldSize;
Aaron Ballman9371dd22014-03-14 18:34:04 +00002639 if (CI.isByRef())
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002640 fieldSize = CharUnits::fromQuantity(WordSizeInBytes);
2641 else
2642 fieldSize = CGM.getContext().getTypeSizeInChars(type);
Aaron Ballman9371dd22014-03-14 18:34:04 +00002643 UpdateRunSkipBlockVars(CI.isByRef(), getBlockCaptureLifetime(type, false),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002644 fieldOffset, fieldSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002645 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002646 return getBitmapBlockLayout(false);
2647}
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002648
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002649llvm::Constant *CGObjCCommonMac::BuildByrefLayout(CodeGen::CodeGenModule &CGM,
2650 QualType T) {
2651 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2652 assert(!T->isArrayType() && "__block array variable should not be caught");
2653 CharUnits fieldOffset;
2654 RunSkipBlockVars.clear();
2655 bool hasUnion = false;
2656 if (const RecordType *record = T->getAs<RecordType>()) {
2657 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion, true /*ByrefLayout */);
2658 llvm::Constant *Result = getBitmapBlockLayout(true);
Vedant Kumar2f5bb1152015-12-21 20:21:15 +00002659 if (isa<llvm::ConstantInt>(Result))
2660 Result = llvm::ConstantExpr::getIntToPtr(Result, CGM.Int8PtrTy);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002661 return Result;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002662 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002663 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2664 return nullPtr;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002665}
2666
John McCall882987f2013-02-28 19:01:20 +00002667llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00002668 const ObjCProtocolDecl *PD) {
Daniel Dunbar7050c552008-09-04 04:33:15 +00002669 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002670 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar7050c552008-09-04 04:33:15 +00002671 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2672
Owen Andersonade90fd2009-07-29 18:54:39 +00002673 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00002674 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002675}
2676
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002677void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stump18bb9282009-05-16 07:57:57 +00002678 // FIXME: We shouldn't need this, the protocol decl should contain enough
2679 // information to tell us whether this was a declaration or a definition.
Daniel Dunbarc475d422008-10-29 22:36:39 +00002680 DefinedProtocols.insert(PD->getIdentifier());
2681
2682 // If we have generated a forward reference to this protocol, emit
2683 // it now. Otherwise do nothing, the protocol objects are lazily
2684 // emitted.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002685 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbarc475d422008-10-29 22:36:39 +00002686 GetOrEmitProtocol(PD);
2687}
2688
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002689llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002690 if (DefinedProtocols.count(PD->getIdentifier()))
2691 return GetOrEmitProtocol(PD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002692
Daniel Dunbarc475d422008-10-29 22:36:39 +00002693 return GetOrEmitProtocolRef(PD);
2694}
2695
Douglas Gregor24ae22c2016-04-01 23:23:52 +00002696llvm::Value *CGObjCCommonMac::EmitClassRefViaRuntime(
2697 CodeGenFunction &CGF,
2698 const ObjCInterfaceDecl *ID,
2699 ObjCCommonTypesHelper &ObjCTypes) {
2700 llvm::Constant *lookUpClassFn = ObjCTypes.getLookUpClassFn();
2701
2702 llvm::Value *className =
2703 CGF.CGM.GetAddrOfConstantCString(ID->getObjCRuntimeNameAsString())
2704 .getPointer();
2705 ASTContext &ctx = CGF.CGM.getContext();
2706 className =
2707 CGF.Builder.CreateBitCast(className,
2708 CGF.ConvertType(
2709 ctx.getPointerType(ctx.CharTy.withConst())));
2710 llvm::CallInst *call = CGF.Builder.CreateCall(lookUpClassFn, className);
2711 call->setDoesNotThrow();
2712 return call;
2713}
2714
Daniel Dunbarb036db82008-08-13 03:21:16 +00002715/*
Rafael Espindolaf9e1e5e2014-02-20 14:09:04 +00002716// Objective-C 1.0 extensions
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002717struct _objc_protocol {
2718struct _objc_protocol_extension *isa;
2719char *protocol_name;
2720struct _objc_protocol_list *protocol_list;
2721struct _objc__method_prototype_list *instance_methods;
2722struct _objc__method_prototype_list *class_methods
2723};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002724
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002725See EmitProtocolExtension().
Daniel Dunbarb036db82008-08-13 03:21:16 +00002726*/
Daniel Dunbarc475d422008-10-29 22:36:39 +00002727llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00002728 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbarc475d422008-10-29 22:36:39 +00002729
2730 // Early exit if a defining object has already been generated.
2731 if (Entry && Entry->hasInitializer())
2732 return Entry;
2733
Douglas Gregora715bff2012-01-01 19:51:50 +00002734 // Use the protocol definition, if there is one.
2735 if (const ObjCProtocolDecl *Def = PD->getDefinition())
2736 PD = Def;
2737
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002738 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002739 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002740 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2741
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002742 // Construct method lists.
2743 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
2744 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002745 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00002746 for (const auto *MD : PD->instance_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002747 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002748 if (!C)
2749 return GetOrEmitProtocolRef(PD);
2750
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002751 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2752 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002753 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002754 } else {
2755 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002756 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002757 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002758 }
2759
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00002760 for (const auto *MD : PD->class_methods()) {
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002761 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002762 if (!C)
2763 return GetOrEmitProtocolRef(PD);
2764
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002765 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
2766 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002767 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002768 } else {
2769 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002770 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002771 }
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002772 }
2773
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002774 MethodTypesExt.insert(MethodTypesExt.end(),
2775 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
2776
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002777 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002778 EmitProtocolExtension(PD, OptInstanceMethods, OptClassMethods,
2779 MethodTypesExt),
2780 GetClassName(PD->getObjCRuntimeNameAsString()),
2781 EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
2782 PD->protocol_begin(), PD->protocol_end()),
2783 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_" + PD->getName(),
2784 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2785 InstanceMethods),
2786 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_" + PD->getName(),
2787 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2788 ClassMethods)};
Owen Anderson0e0189d2009-07-27 22:29:56 +00002789 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00002790 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002791
Daniel Dunbarb036db82008-08-13 03:21:16 +00002792 if (Entry) {
Rafael Espindola5d117f32014-03-06 01:10:46 +00002793 // Already created, update the initializer.
Rafael Espindolab3262952014-05-09 00:43:37 +00002794 assert(Entry->hasPrivateLinkage());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002795 Entry->setInitializer(Init);
2796 } else {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002797 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2798 false, llvm::GlobalValue::PrivateLinkage,
2799 Init, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002800 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002801 // FIXME: Is this necessary? Why only for protocol?
2802 Entry->setAlignment(4);
John McCallf9582a72012-03-30 21:29:05 +00002803
2804 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002805 }
Rafael Espindola060062a2014-03-06 22:15:10 +00002806 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbarc475d422008-10-29 22:36:39 +00002807
2808 return Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002809}
2810
Daniel Dunbarc475d422008-10-29 22:36:39 +00002811llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002812 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
2813
2814 if (!Entry) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002815 // We use the initializer as a marker of whether this is a forward
2816 // reference or not. At module finalization we add the empty
2817 // contents for protocols which were referenced but never defined.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002818 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2819 false, llvm::GlobalValue::PrivateLinkage,
2820 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002821 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002822 // FIXME: Is this necessary? Why only for protocol?
2823 Entry->setAlignment(4);
2824 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002825
Daniel Dunbarb036db82008-08-13 03:21:16 +00002826 return Entry;
2827}
2828
2829/*
2830 struct _objc_protocol_extension {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002831 uint32_t size;
2832 struct objc_method_description_list *optional_instance_methods;
2833 struct objc_method_description_list *optional_class_methods;
2834 struct objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002835 const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00002836 struct objc_property_list *class_properties;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002837 };
2838*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002839llvm::Constant *
2840CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002841 ArrayRef<llvm::Constant*> OptInstanceMethods,
2842 ArrayRef<llvm::Constant*> OptClassMethods,
2843 ArrayRef<llvm::Constant*> MethodTypesExt) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002844 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00002845 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002846 llvm::Constant *Values[] = {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002847 llvm::ConstantInt::get(ObjCTypes.IntTy, Size),
2848 EmitMethodDescList("OBJC_PROTOCOL_INSTANCE_METHODS_OPT_" + PD->getName(),
2849 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
2850 OptInstanceMethods),
2851 EmitMethodDescList("OBJC_PROTOCOL_CLASS_METHODS_OPT_" + PD->getName(),
2852 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
2853 OptClassMethods),
2854 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
Manman Renad0e7912016-01-29 19:22:54 +00002855 ObjCTypes, false),
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002856 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
Manman Rence7bff52016-01-29 23:46:55 +00002857 MethodTypesExt, ObjCTypes),
2858 EmitPropertyList("OBJC_$_CLASS_PROP_PROTO_LIST_" + PD->getName(), nullptr,
2859 PD, ObjCTypes, true)};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002860
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002861 // Return null if no extension bits are used.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002862 if (Values[1]->isNullValue() && Values[2]->isNullValue() &&
Manman Rence7bff52016-01-29 23:46:55 +00002863 Values[3]->isNullValue() && Values[4]->isNullValue() &&
2864 Values[5]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00002865 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002866
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002867 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00002868 llvm::ConstantStruct::get(ObjCTypes.ProtocolExtensionTy, Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002869
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002870 // No special section, but goes in llvm.used
Alp Toker541d5072014-06-07 23:30:53 +00002871 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00002872 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002873}
2874
2875/*
2876 struct objc_protocol_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002877 struct objc_protocol_list *next;
2878 long count;
2879 Protocol *list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00002880 };
2881*/
Daniel Dunbardec75f82008-08-21 21:57:41 +00002882llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002883CGObjCMac::EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00002884 ObjCProtocolDecl::protocol_iterator begin,
2885 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002886 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002887
Daniel Dunbardec75f82008-08-21 21:57:41 +00002888 for (; begin != end; ++begin)
2889 ProtocolRefs.push_back(GetProtocolRef(*begin));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002890
2891 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002892 if (ProtocolRefs.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00002893 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002894
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002895 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00002896 ProtocolRefs.push_back(llvm::Constant::getNullValue(ObjCTypes.ProtocolPtrTy));
Daniel Dunbarb036db82008-08-13 03:21:16 +00002897
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002898 llvm::Constant *Values[3];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00002899 // This field is only used by the runtime.
Owen Anderson0b75f232009-07-31 20:28:54 +00002900 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00002901 Values[1] = llvm::ConstantInt::get(ObjCTypes.LongTy,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002902 ProtocolRefs.size() - 1);
2903 Values[2] =
2904 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolPtrTy,
2905 ProtocolRefs.size()),
Daniel Dunbarb036db82008-08-13 03:21:16 +00002906 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002907
Chris Lattnere64d7ba2011-06-20 04:01:35 +00002908 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002909 llvm::GlobalVariable *GV =
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00002910 CreateMetadataVar(Name, Init, "__OBJC,__cat_cls_meth,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00002911 CGM.getPointerAlign(), false);
Owen Andersonade90fd2009-07-29 18:54:39 +00002912 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002913}
2914
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002915void CGObjCCommonMac::
2916PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002917 SmallVectorImpl<llvm::Constant *> &Properties,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00002918 const Decl *Container,
Aaron Ballmandc4bea42014-03-13 18:47:37 +00002919 const ObjCProtocolDecl *Proto,
Manman Renad0e7912016-01-29 19:22:54 +00002920 const ObjCCommonTypesHelper &ObjCTypes,
2921 bool IsClassProperty) {
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00002922 for (const auto *P : Proto->protocols())
Manman Renad0e7912016-01-29 19:22:54 +00002923 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2924 IsClassProperty);
2925
2926 for (const auto *PD : Proto->properties()) {
2927 if (IsClassProperty != PD->isClassProperty())
2928 continue;
David Blaikie82e95a32014-11-19 07:49:47 +00002929 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002930 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00002931 llvm::Constant *Prop[] = {
2932 GetPropertyName(PD->getIdentifier()),
2933 GetPropertyTypeString(PD, Container)
2934 };
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002935 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2936 }
2937}
2938
Daniel Dunbarb036db82008-08-13 03:21:16 +00002939/*
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002940 struct _objc_property {
Bill Wendlinga515b582012-02-09 22:16:49 +00002941 const char * const name;
2942 const char * const attributes;
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002943 };
2944
2945 struct _objc_property_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00002946 uint32_t entsize; // sizeof (struct _objc_property)
2947 uint32_t prop_count;
2948 struct _objc_property[prop_count];
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002949 };
2950*/
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002951llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002952 const Decl *Container,
2953 const ObjCContainerDecl *OCD,
Manman Renad0e7912016-01-29 19:22:54 +00002954 const ObjCCommonTypesHelper &ObjCTypes,
2955 bool IsClassProperty) {
Manman Ren01b705e2016-04-19 19:05:03 +00002956 if (IsClassProperty) {
2957 // Make this entry NULL for OS X with deployment target < 10.11, for iOS
2958 // with deployment target < 9.0.
2959 const llvm::Triple &Triple = CGM.getTarget().getTriple();
2960 if ((Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 11)) ||
2961 (Triple.isiOS() && Triple.isOSVersionLT(9)))
2962 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
2963 }
2964
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002965 SmallVector<llvm::Constant *, 16> Properties;
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00002966 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weber08c93332015-12-03 17:44:51 +00002967
2968 auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2969 llvm::Constant *Prop[] = {GetPropertyName(PD->getIdentifier()),
2970 GetPropertyTypeString(PD, Container)};
2971 Properties.push_back(llvm::ConstantStruct::get(ObjCTypes.PropertyTy, Prop));
2972 };
2973 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
2974 for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
Manman Renad0e7912016-01-29 19:22:54 +00002975 for (auto *PD : ClassExt->properties()) {
2976 if (IsClassProperty != PD->isClassProperty())
2977 continue;
Nico Weber08c93332015-12-03 17:44:51 +00002978 PropertySet.insert(PD->getIdentifier());
2979 AddProperty(PD);
2980 }
Manman Renad0e7912016-01-29 19:22:54 +00002981
2982 for (const auto *PD : OCD->properties()) {
2983 if (IsClassProperty != PD->isClassProperty())
2984 continue;
Nico Weber08c93332015-12-03 17:44:51 +00002985 // Don't emit duplicate metadata for properties that were already in a
2986 // class extension.
2987 if (!PropertySet.insert(PD->getIdentifier()).second)
2988 continue;
2989 AddProperty(PD);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00002990 }
Nico Weber08c93332015-12-03 17:44:51 +00002991
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002992 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Aaron Ballmana9f49e32014-03-13 20:55:22 +00002993 for (const auto *P : OID->all_referenced_protocols())
Manman Renad0e7912016-01-29 19:22:54 +00002994 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
2995 IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00002996 }
2997 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Aaron Ballman19a41762014-03-14 12:55:57 +00002998 for (const auto *P : CD->protocols())
Manman Renad0e7912016-01-29 19:22:54 +00002999 PushProtocolProperties(PropertySet, Properties, Container, P, ObjCTypes,
3000 IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003001 }
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003002
3003 // Return null for empty list.
3004 if (Properties.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003005 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003006
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003007 unsigned PropertySize =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003008 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003009 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003010 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, PropertySize);
3011 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Properties.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003012 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.PropertyTy,
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003013 Properties.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003014 Values[2] = llvm::ConstantArray::get(AT, Properties);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003015 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003016
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003017 llvm::GlobalVariable *GV =
3018 CreateMetadataVar(Name, Init,
3019 (ObjCABI == 2) ? "__DATA, __objc_const" :
Daniel Dunbarb25452a2009-04-15 02:56:18 +00003020 "__OBJC,__property,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00003021 CGM.getPointerAlign(),
Daniel Dunbarb25452a2009-04-15 02:56:18 +00003022 true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003023 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003024}
3025
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003026llvm::Constant *
3027CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
3028 ArrayRef<llvm::Constant*> MethodTypes,
3029 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003030 // Return null for empty list.
3031 if (MethodTypes.empty())
3032 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
3033
3034 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
3035 MethodTypes.size());
3036 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
3037
Alp Toker541d5072014-06-07 23:30:53 +00003038 llvm::GlobalVariable *GV = CreateMetadataVar(
3039 Name, Init, (ObjCABI == 2) ? "__DATA, __objc_const" : StringRef(),
John McCall7f416cc2015-09-08 08:05:57 +00003040 CGM.getPointerAlign(), true);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003041 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
3042}
3043
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003044/*
Daniel Dunbarb036db82008-08-13 03:21:16 +00003045 struct objc_method_description_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003046 int count;
3047 struct objc_method_description list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00003048 };
3049*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003050llvm::Constant *
3051CGObjCMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003052 llvm::Constant *Desc[] = {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003053 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003054 ObjCTypes.SelectorPtrTy),
3055 GetMethodVarType(MD)
3056 };
Douglas Gregora9d84932011-05-27 01:19:52 +00003057 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00003058 return nullptr;
3059
Owen Anderson0e0189d2009-07-27 22:29:56 +00003060 return llvm::ConstantStruct::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003061 Desc);
3062}
Daniel Dunbarb036db82008-08-13 03:21:16 +00003063
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003064llvm::Constant *
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00003065CGObjCMac::EmitMethodDescList(Twine Name, StringRef Section,
3066 ArrayRef<llvm::Constant *> Methods) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00003067 // Return null for empty list.
3068 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003069 return llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003070
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003071 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003072 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003073 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodDescriptionTy,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003074 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003075 Values[1] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003076 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003077
John McCall7f416cc2015-09-08 08:05:57 +00003078 llvm::GlobalVariable *GV =
3079 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003080 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbarb036db82008-08-13 03:21:16 +00003081 ObjCTypes.MethodDescriptionListPtrTy);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003082}
3083
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003084/*
3085 struct _objc_category {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003086 char *category_name;
3087 char *class_name;
3088 struct _objc_method_list *instance_methods;
3089 struct _objc_method_list *class_methods;
3090 struct _objc_protocol_list *protocols;
3091 uint32_t size; // <rdar://4585769>
3092 struct _objc_property_list *instance_properties;
Manman Ren96df0b32016-01-29 23:45:01 +00003093 struct _objc_property_list *class_properties;
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003094 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003095*/
Daniel Dunbar92992502008-08-15 22:20:32 +00003096void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00003097 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003098
Mike Stump18bb9282009-05-16 07:57:57 +00003099 // FIXME: This is poor design, the OCD should have a pointer to the category
3100 // decl. Additionally, note that Category can be null for the @implementation
3101 // w/o an @interface case. Sema should just create one for us as it does for
3102 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003103 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003104 const ObjCCategoryDecl *Category =
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003105 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003106
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003107 SmallString<256> ExtName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003108 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3109 << OCD->getName();
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003110
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003111 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003112 for (const auto *I : OCD->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003113 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003114 InstanceMethods.push_back(GetMethodConstant(I));
3115
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003116 for (const auto *I : OCD->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003117 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003118 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003119
Manman Ren96df0b32016-01-29 23:45:01 +00003120 llvm::Constant *Values[8];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003121 Values[0] = GetClassName(OCD->getName());
3122 Values[1] = GetClassName(Interface->getObjCRuntimeNameAsString());
Fariborz Jahaniane55f8662009-04-29 20:40:05 +00003123 LazySymbols.insert(Interface->getIdentifier());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003124 Values[2] = EmitMethodList("OBJC_CATEGORY_INSTANCE_METHODS_" + ExtName.str(),
3125 "__OBJC,__cat_inst_meth,regular,no_dead_strip",
3126 InstanceMethods);
3127 Values[3] = EmitMethodList("OBJC_CATEGORY_CLASS_METHODS_" + ExtName.str(),
3128 "__OBJC,__cat_cls_meth,regular,no_dead_strip",
3129 ClassMethods);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003130 if (Category) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003131 Values[4] =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003132 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
3133 Category->protocol_begin(), Category->protocol_end());
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003134 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003135 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003136 }
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003137 Values[5] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003138
3139 // If there is no category @interface then there can be no properties.
3140 if (Category) {
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003141 Values[6] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Manman Renad0e7912016-01-29 19:22:54 +00003142 OCD, Category, ObjCTypes, false);
Manman Ren96df0b32016-01-29 23:45:01 +00003143 Values[7] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
3144 OCD, Category, ObjCTypes, true);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003145 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003146 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Manman Ren96df0b32016-01-29 23:45:01 +00003147 Values[7] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003148 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003149
Owen Anderson0e0189d2009-07-27 22:29:56 +00003150 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.CategoryTy,
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003151 Values);
3152
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003153 llvm::GlobalVariable *GV =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003154 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003155 "__OBJC,__category,regular,no_dead_strip",
3156 CGM.getPointerAlign(), true);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003157 DefinedCategories.push_back(GV);
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00003158 DefinedCategoryNames.insert(ExtName.str());
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003159 // method definition entries must be clear for next implementation.
3160 MethodDefinitions.clear();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003161}
3162
John McCallef19dbb2012-10-17 04:53:23 +00003163enum FragileClassFlags {
John McCall460ce582015-10-22 18:38:17 +00003164 /// Apparently: is not a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003165 FragileABI_Class_Factory = 0x00001,
John McCall460ce582015-10-22 18:38:17 +00003166
3167 /// Is a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003168 FragileABI_Class_Meta = 0x00002,
John McCall460ce582015-10-22 18:38:17 +00003169
3170 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003171 FragileABI_Class_HasCXXStructors = 0x02000,
John McCall460ce582015-10-22 18:38:17 +00003172
3173 /// Has hidden visibility.
John McCall09ec1ec2015-10-21 22:06:03 +00003174 FragileABI_Class_Hidden = 0x20000,
John McCall460ce582015-10-22 18:38:17 +00003175
3176 /// Class implementation was compiled under ARC.
3177 FragileABI_Class_CompiledByARC = 0x04000000,
3178
3179 /// Class implementation was compiled under MRC and has MRC weak ivars.
3180 /// Exclusive with CompiledByARC.
3181 FragileABI_Class_HasMRCWeakIvars = 0x08000000,
John McCallef19dbb2012-10-17 04:53:23 +00003182};
3183
3184enum NonFragileClassFlags {
3185 /// Is a meta-class.
3186 NonFragileABI_Class_Meta = 0x00001,
3187
3188 /// Is a root class.
3189 NonFragileABI_Class_Root = 0x00002,
3190
John McCall460ce582015-10-22 18:38:17 +00003191 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003192 NonFragileABI_Class_HasCXXStructors = 0x00004,
3193
3194 /// Has hidden visibility.
3195 NonFragileABI_Class_Hidden = 0x00010,
3196
3197 /// Has the exception attribute.
3198 NonFragileABI_Class_Exception = 0x00020,
3199
3200 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3201 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3202
3203 /// Class implementation was compiled under ARC.
John McCall0d54a172012-10-17 04:53:31 +00003204 NonFragileABI_Class_CompiledByARC = 0x00080,
3205
3206 /// Class has non-trivial destructors, but zero-initialization is okay.
John McCall460ce582015-10-22 18:38:17 +00003207 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100,
3208
3209 /// Class implementation was compiled under MRC and has MRC weak ivars.
3210 /// Exclusive with CompiledByARC.
3211 NonFragileABI_Class_HasMRCWeakIvars = 0x00200,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003212};
3213
John McCall460ce582015-10-22 18:38:17 +00003214static bool hasWeakMember(QualType type) {
3215 if (type.getObjCLifetime() == Qualifiers::OCL_Weak) {
3216 return true;
3217 }
3218
3219 if (auto recType = type->getAs<RecordType>()) {
3220 for (auto field : recType->getDecl()->fields()) {
3221 if (hasWeakMember(field->getType()))
3222 return true;
3223 }
3224 }
3225
3226 return false;
3227}
3228
3229/// For compatibility, we only want to set the "HasMRCWeakIvars" flag
3230/// (and actually fill in a layout string) if we really do have any
3231/// __weak ivars.
3232static bool hasMRCWeakIvars(CodeGenModule &CGM,
3233 const ObjCImplementationDecl *ID) {
3234 if (!CGM.getLangOpts().ObjCWeak) return false;
3235 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
3236
3237 for (const ObjCIvarDecl *ivar =
3238 ID->getClassInterface()->all_declared_ivar_begin();
3239 ivar; ivar = ivar->getNextIvar()) {
3240 if (hasWeakMember(ivar->getType()))
3241 return true;
3242 }
3243
3244 return false;
3245}
3246
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003247/*
3248 struct _objc_class {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003249 Class isa;
3250 Class super_class;
3251 const char *name;
3252 long version;
3253 long info;
3254 long instance_size;
3255 struct _objc_ivar_list *ivars;
3256 struct _objc_method_list *methods;
3257 struct _objc_cache *cache;
3258 struct _objc_protocol_list *protocols;
3259 // Objective-C 1.0 extensions (<rdr://4585769>)
3260 const char *ivar_layout;
3261 struct _objc_class_ext *ext;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003262 };
3263
3264 See EmitClassExtension();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003265*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003266void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003267 DefinedSymbols.insert(ID->getIdentifier());
3268
Chris Lattner86d7d912008-11-24 03:54:41 +00003269 std::string ClassName = ID->getNameAsString();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003270 // FIXME: Gross
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003271 ObjCInterfaceDecl *Interface =
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003272 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003273 llvm::Constant *Protocols =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003274 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3275 Interface->all_referenced_protocol_begin(),
3276 Interface->all_referenced_protocol_end());
John McCallef19dbb2012-10-17 04:53:23 +00003277 unsigned Flags = FragileABI_Class_Factory;
John McCall0d54a172012-10-17 04:53:31 +00003278 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCallef19dbb2012-10-17 04:53:23 +00003279 Flags |= FragileABI_Class_HasCXXStructors;
John McCall09ec1ec2015-10-21 22:06:03 +00003280
John McCall460ce582015-10-22 18:38:17 +00003281 bool hasMRCWeak = false;
3282
John McCall09ec1ec2015-10-21 22:06:03 +00003283 if (CGM.getLangOpts().ObjCAutoRefCount)
3284 Flags |= FragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00003285 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
3286 Flags |= FragileABI_Class_HasMRCWeakIvars;
John McCall09ec1ec2015-10-21 22:06:03 +00003287
John McCall3fd13f062015-10-21 18:06:47 +00003288 CharUnits Size =
3289 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003290
3291 // FIXME: Set CXX-structors flag.
John McCall457a04e2010-10-22 21:05:15 +00003292 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003293 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003294
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003295 SmallVector<llvm::Constant *, 16> InstanceMethods, ClassMethods;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003296 for (const auto *I : ID->instance_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003297 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003298 InstanceMethods.push_back(GetMethodConstant(I));
3299
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003300 for (const auto *I : ID->class_methods())
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003301 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00003302 ClassMethods.push_back(GetMethodConstant(I));
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003303
Aaron Ballmand85eff42014-03-14 15:02:45 +00003304 for (const auto *PID : ID->property_impls()) {
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003305 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3306 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3307
3308 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
3309 if (llvm::Constant *C = GetMethodConstant(MD))
3310 InstanceMethods.push_back(C);
3311 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
3312 if (llvm::Constant *C = GetMethodConstant(MD))
3313 InstanceMethods.push_back(C);
3314 }
3315 }
3316
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003317 llvm::Constant *Values[12];
Daniel Dunbarccf61832009-05-03 08:56:52 +00003318 Values[ 0] = EmitMetaClass(ID, Protocols, ClassMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003319 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003320 // Record a reference to the super class.
3321 LazySymbols.insert(Super->getIdentifier());
3322
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003323 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003324 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003325 ObjCTypes.ClassPtrTy);
3326 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003327 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003328 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003329 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003330 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003331 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3332 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
John McCall3fd13f062015-10-21 18:06:47 +00003333 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size.getQuantity());
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003334 Values[ 6] = EmitIvarList(ID, false);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003335 Values[7] = EmitMethodList("OBJC_INSTANCE_METHODS_" + ID->getName(),
3336 "__OBJC,__inst_meth,regular,no_dead_strip",
3337 InstanceMethods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003338 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003339 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003340 Values[ 9] = Protocols;
John McCall460ce582015-10-22 18:38:17 +00003341 Values[10] = BuildStrongIvarLayout(ID, CharUnits::Zero(), Size);
Manman Renad0e7912016-01-29 19:22:54 +00003342 Values[11] = EmitClassExtension(ID, Size, hasMRCWeak,
3343 false/*isClassProperty*/);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003344 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003345 Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003346 std::string Name("OBJC_CLASS_");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003347 Name += ClassName;
3348 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3349 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003350 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003351 if (GV) {
3352 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3353 "Forward metaclass reference has incorrect type.");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003354 GV->setInitializer(Init);
3355 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003356 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00003357 CGM.addCompilerUsedGlobal(GV);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003358 } else
John McCall7f416cc2015-09-08 08:05:57 +00003359 GV = CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003360 DefinedClasses.push_back(GV);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00003361 ImplementedClasses.push_back(Interface);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003362 // method definition entries must be clear for next implementation.
3363 MethodDefinitions.clear();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003364}
3365
3366llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3367 llvm::Constant *Protocols,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003368 ArrayRef<llvm::Constant*> Methods) {
John McCallef19dbb2012-10-17 04:53:23 +00003369 unsigned Flags = FragileABI_Class_Meta;
Micah Villmowdd31ca12012-10-08 16:25:52 +00003370 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003371
John McCall457a04e2010-10-22 21:05:15 +00003372 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003373 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003374
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003375 llvm::Constant *Values[12];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003376 // The isa for the metaclass is the root of the hierarchy.
3377 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3378 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3379 Root = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003380 Values[ 0] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003381 llvm::ConstantExpr::getBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003382 ObjCTypes.ClassPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003383 // The super class for the metaclass is emitted as the name of the
3384 // super class. The runtime fixes this up to point to the
3385 // *metaclass* for the super class.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003386 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003387 Values[ 1] =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003388 llvm::ConstantExpr::getBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003389 ObjCTypes.ClassPtrTy);
3390 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00003391 Values[ 1] = llvm::Constant::getNullValue(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003392 }
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00003393 Values[ 2] = GetClassName(ID->getObjCRuntimeNameAsString());
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003394 // Version is always 0.
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003395 Values[ 3] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
3396 Values[ 4] = llvm::ConstantInt::get(ObjCTypes.LongTy, Flags);
3397 Values[ 5] = llvm::ConstantInt::get(ObjCTypes.LongTy, Size);
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003398 Values[ 6] = EmitIvarList(ID, true);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003399 Values[7] =
3400 EmitMethodList("OBJC_CLASS_METHODS_" + ID->getNameAsString(),
3401 "__OBJC,__cls_meth,regular,no_dead_strip", Methods);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003402 // cache is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003403 Values[ 8] = llvm::Constant::getNullValue(ObjCTypes.CachePtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003404 Values[ 9] = Protocols;
3405 // ivar_layout for metaclass is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00003406 Values[10] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Manman Renad0e7912016-01-29 19:22:54 +00003407 // The class extension is used to store class properties for metaclasses.
3408 Values[11] = EmitClassExtension(ID, CharUnits::Zero(), false/*hasMRCWeak*/,
3409 true/*isClassProperty*/);
Owen Anderson0e0189d2009-07-27 22:29:56 +00003410 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003411 Values);
3412
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003413 std::string Name("OBJC_METACLASS_");
Benjamin Kramer1bbcbd02012-07-31 11:45:39 +00003414 Name += ID->getName();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003415
3416 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003417 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003418 if (GV) {
3419 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3420 "Forward metaclass reference has incorrect type.");
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003421 GV->setInitializer(Init);
3422 } else {
Owen Andersonc10c8d32009-07-08 19:05:04 +00003423 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003424 llvm::GlobalValue::PrivateLinkage,
Owen Andersonc10c8d32009-07-08 19:05:04 +00003425 Init, Name);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003426 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003427 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Daniel Dunbarae333842009-03-09 22:18:41 +00003428 GV->setAlignment(4);
Rafael Espindola060062a2014-03-06 22:15:10 +00003429 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003430
3431 return GV;
3432}
3433
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003434llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003435 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003436
Mike Stump18bb9282009-05-16 07:57:57 +00003437 // FIXME: Should we look these up somewhere other than the module. Its a bit
3438 // silly since we only generate these while processing an implementation, so
3439 // exactly one pointer would work if know when we entered/exitted an
3440 // implementation block.
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003441
3442 // Check for an existing forward reference.
Fariborz Jahanian475831b2009-01-07 20:11:22 +00003443 // Previously, metaclass with internal linkage may have been defined.
3444 // pass 'true' as 2nd argument so it is returned.
Rafael Espindola21039aa2014-02-27 16:26:32 +00003445 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3446 if (!GV)
3447 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003448 llvm::GlobalValue::PrivateLinkage, nullptr,
3449 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003450
3451 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3452 "Forward metaclass reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003453 return GV;
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003454}
3455
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003456llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003457 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Rafael Espindola21039aa2014-02-27 16:26:32 +00003458 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3459
3460 if (!GV)
3461 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003462 llvm::GlobalValue::PrivateLinkage, nullptr,
3463 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003464
3465 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3466 "Forward class metadata reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003467 return GV;
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003468}
3469
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003470/*
John McCall3fd13f062015-10-21 18:06:47 +00003471 Emit a "class extension", which in this specific context means extra
3472 data that doesn't fit in the normal fragile-ABI class structure, and
3473 has nothing to do with the language concept of a class extension.
3474
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003475 struct objc_class_ext {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003476 uint32_t size;
3477 const char *weak_ivar_layout;
3478 struct _objc_property_list *properties;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003479 };
3480*/
3481llvm::Constant *
John McCall3fd13f062015-10-21 18:06:47 +00003482CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
Manman Renad0e7912016-01-29 19:22:54 +00003483 CharUnits InstanceSize, bool hasMRCWeakIvars,
3484 bool isClassProperty) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003485 uint64_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003486 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003487
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003488 llvm::Constant *Values[3];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003489 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Manman Ren92e0a712016-02-21 05:31:05 +00003490 if (isClassProperty) {
3491 llvm::Type *PtrTy = CGM.Int8PtrTy;
3492 Values[1] = llvm::Constant::getNullValue(PtrTy);
3493 } else
Manman Renad0e7912016-01-29 19:22:54 +00003494 Values[1] = BuildWeakIvarLayout(ID, CharUnits::Zero(), InstanceSize,
3495 hasMRCWeakIvars);
3496 if (isClassProperty)
3497 Values[2] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getName(),
3498 ID, ID->getClassInterface(), ObjCTypes, true);
3499 else
3500 Values[2] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ID->getName(),
3501 ID, ID->getClassInterface(), ObjCTypes, false);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003502
3503 // Return null if no extension bits are used.
Manman Renad0e7912016-01-29 19:22:54 +00003504 if ((!Values[1] || Values[1]->isNullValue()) && Values[2]->isNullValue())
Owen Anderson0b75f232009-07-31 20:28:54 +00003505 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003506
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003507 llvm::Constant *Init =
Owen Anderson0e0189d2009-07-27 22:29:56 +00003508 llvm::ConstantStruct::get(ObjCTypes.ClassExtensionTy, Values);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003509 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003510 "__OBJC,__class_ext,regular,no_dead_strip",
3511 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003512}
3513
3514/*
3515 struct objc_ivar {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003516 char *ivar_name;
3517 char *ivar_type;
3518 int ivar_offset;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003519 };
3520
3521 struct objc_ivar_list {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003522 int ivar_count;
3523 struct objc_ivar list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003524 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003525*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003526llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003527 bool ForClass) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003528 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003529
3530 // When emitting the root class GCC emits ivar entries for the
3531 // actual class structure. It is not clear if we need to follow this
3532 // behavior; for now lets try and get away with not doing it. If so,
3533 // the cleanest solution would be to make up an ObjCInterfaceDecl
3534 // for the class.
3535 if (ForClass)
Owen Anderson0b75f232009-07-31 20:28:54 +00003536 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003537
Jordy Rosea91768e2011-07-22 02:08:32 +00003538 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003539
Jordy Rosea91768e2011-07-22 02:08:32 +00003540 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00003541 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00003542 // Ignore unnamed bit-fields.
3543 if (!IVD->getDeclName())
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003544 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003545 llvm::Constant *Ivar[] = {
3546 GetMethodVarName(IVD->getIdentifier()),
3547 GetMethodVarType(IVD),
3548 llvm::ConstantInt::get(ObjCTypes.IntTy,
Eli Friedman8cbca202012-11-06 22:15:52 +00003549 ComputeIvarBaseOffset(CGM, OID, IVD))
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003550 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003551 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarTy, Ivar));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003552 }
3553
3554 // Return null for empty list.
3555 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003556 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003557
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003558 llvm::Constant *Values[2];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003559 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003560 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003561 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003562 Values[1] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003563 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003564
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003565 llvm::GlobalVariable *GV;
3566 if (ForClass)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003567 GV =
3568 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003569 "__OBJC,__class_vars,regular,no_dead_strip",
3570 CGM.getPointerAlign(), true);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003571 else
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003572 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), Init,
John McCall7f416cc2015-09-08 08:05:57 +00003573 "__OBJC,__instance_vars,regular,no_dead_strip",
3574 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003575 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003576}
3577
3578/*
3579 struct objc_method {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003580 SEL method_name;
3581 char *method_types;
3582 void *method;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003583 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003584
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003585 struct objc_method_list {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003586 struct objc_method_list *obsolete;
3587 int count;
3588 struct objc_method methods_list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003589 };
3590*/
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003591
3592/// GetMethodConstant - Return a struct objc_method constant for the
3593/// given method if it has been defined. The result is null if the
3594/// method has not been defined. The return value has type MethodPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003595llvm::Constant *CGObjCMac::GetMethodConstant(const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00003596 llvm::Function *Fn = GetMethodDefinition(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003597 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00003598 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003599
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003600 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00003601 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00003602 ObjCTypes.SelectorPtrTy),
3603 GetMethodVarType(MD),
3604 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
3605 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00003606 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003607}
3608
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00003609llvm::Constant *CGObjCMac::EmitMethodList(Twine Name, StringRef Section,
3610 ArrayRef<llvm::Constant *> Methods) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003611 // Return null for empty list.
3612 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003613 return llvm::Constant::getNullValue(ObjCTypes.MethodListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003614
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003615 llvm::Constant *Values[3];
Owen Anderson0b75f232009-07-31 20:28:54 +00003616 Values[0] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00003617 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00003618 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003619 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00003620 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003621 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003622
John McCall7f416cc2015-09-08 08:05:57 +00003623 llvm::GlobalVariable *GV =
3624 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003625 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003626}
3627
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00003628llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003629 const ObjCContainerDecl *CD) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003630 SmallString<256> Name;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003631 GetNameForMethod(OMD, CD, Name);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003632
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003633 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003634 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003635 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003636 llvm::Function *Method =
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00003637 llvm::Function::Create(MethodTy,
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003638 llvm::GlobalValue::InternalLinkage,
Daniel Dunbard2386812009-10-19 01:21:19 +00003639 Name.str(),
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003640 &CGM.getModule());
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003641 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003642
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003643 return Method;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003644}
3645
Alp Toker541d5072014-06-07 23:30:53 +00003646llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
3647 llvm::Constant *Init,
3648 StringRef Section,
John McCall7f416cc2015-09-08 08:05:57 +00003649 CharUnits Align,
Alp Toker541d5072014-06-07 23:30:53 +00003650 bool AddToUsed) {
Chris Lattner2192fe52011-07-18 04:24:23 +00003651 llvm::Type *Ty = Init->getType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003652 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00003653 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003654 llvm::GlobalValue::PrivateLinkage, Init, Name);
Alp Toker541d5072014-06-07 23:30:53 +00003655 if (!Section.empty())
Daniel Dunbar30c65362009-03-09 20:09:19 +00003656 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003657 GV->setAlignment(Align.getQuantity());
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00003658 if (AddToUsed)
Rafael Espindola060062a2014-03-06 22:15:10 +00003659 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar30c65362009-03-09 20:09:19 +00003660 return GV;
3661}
3662
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003663llvm::GlobalVariable *
3664CGObjCCommonMac::CreateCStringLiteral(StringRef Name, ObjCLabelType Type) {
3665 StringRef Label;
3666 switch (Type) {
3667 case ObjCLabelType::ClassName: Label = "OBJC_CLASS_NAME_"; break;
3668 case ObjCLabelType::MethodVarName: Label = "OBJC_METH_VAR_NAME_"; break;
3669 case ObjCLabelType::MethodVarType: Label = "OBJC_METH_VAR_TYPE_"; break;
3670 case ObjCLabelType::PropertyName: Label = "OBJC_PROP_NAME_ATTR_"; break;
3671 }
3672
3673 StringRef Section;
3674 switch (Type) {
3675 case ObjCLabelType::ClassName:
3676 Section = isNonFragileABI() ? "__TEXT,__objc_classname,cstring_literals"
3677 : "__TEXT,__cstring,cstring_literals";
3678 break;
3679 case ObjCLabelType::MethodVarName:
3680 Section = isNonFragileABI() ? "__TEXT,__objc_methname,cstring_literals"
3681 : "__TEXT,__cstring,cstring_literals";
3682 break;
3683 case ObjCLabelType::MethodVarType:
3684 Section = isNonFragileABI() ? "__TEXT,__objc_methtype,cstring_literals"
3685 : "__TEXT,__cstring,cstring_literals";
3686 break;
3687 case ObjCLabelType::PropertyName:
3688 Section = "__TEXT,__cstring,cstring_literals";
3689 break;
3690 }
3691
3692 llvm::Constant *Value = llvm::ConstantDataArray::getString(VMContext, Name);
3693 llvm::GlobalVariable *GV =
3694 new llvm::GlobalVariable(CGM.getModule(), Value->getType(), false,
3695 llvm::GlobalValue::PrivateLinkage, Value, Label);
3696 GV->setSection(Section);
3697 GV->setAlignment(CharUnits::One().getQuantity());
3698 CGM.addCompilerUsedGlobal(GV);
3699
3700 return GV;
3701}
3702
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003703llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00003704 // Abuse this interface function as a place to finalize.
3705 FinishModule();
Craig Topper8a13c412014-05-21 05:09:00 +00003706 return nullptr;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003707}
3708
Chris Lattnerd4808922009-03-22 21:03:39 +00003709llvm::Constant *CGObjCMac::GetPropertyGetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003710 return ObjCTypes.getGetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003711}
3712
Chris Lattnerd4808922009-03-22 21:03:39 +00003713llvm::Constant *CGObjCMac::GetPropertySetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003714 return ObjCTypes.getSetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003715}
3716
Ted Kremeneke65b0862012-03-06 20:05:56 +00003717llvm::Constant *CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
3718 bool copy) {
3719 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
3720}
3721
David Chisnall168b80f2010-12-26 22:13:16 +00003722llvm::Constant *CGObjCMac::GetGetStructFunction() {
3723 return ObjCTypes.getCopyStructFn();
3724}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003725
David Chisnall168b80f2010-12-26 22:13:16 +00003726llvm::Constant *CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003727 return ObjCTypes.getCopyStructFn();
3728}
3729
David Chisnall0d75e062012-12-17 18:54:24 +00003730llvm::Constant *CGObjCMac::GetCppAtomicObjectGetFunction() {
3731 return ObjCTypes.getCppAtomicObjectFunction();
3732}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003733
David Chisnall0d75e062012-12-17 18:54:24 +00003734llvm::Constant *CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00003735 return ObjCTypes.getCppAtomicObjectFunction();
3736}
3737
Chris Lattnerd4808922009-03-22 21:03:39 +00003738llvm::Constant *CGObjCMac::EnumerationMutationFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003739 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson3f35a262008-08-31 04:05:03 +00003740}
3741
John McCallbd309292010-07-06 01:34:17 +00003742void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
3743 return EmitTryOrSynchronizedStmt(CGF, S);
3744}
3745
3746void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
3747 const ObjCAtSynchronizedStmt &S) {
3748 return EmitTryOrSynchronizedStmt(CGF, S);
3749}
3750
John McCall65bea082010-07-21 06:59:36 +00003751namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00003752 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCall65bea082010-07-21 06:59:36 +00003753 const Stmt &S;
John McCall7f416cc2015-09-08 08:05:57 +00003754 Address SyncArgSlot;
3755 Address CallTryExitVar;
3756 Address ExceptionData;
John McCall65bea082010-07-21 06:59:36 +00003757 ObjCTypesHelper &ObjCTypes;
3758 PerformFragileFinally(const Stmt *S,
John McCall7f416cc2015-09-08 08:05:57 +00003759 Address SyncArgSlot,
3760 Address CallTryExitVar,
3761 Address ExceptionData,
John McCall65bea082010-07-21 06:59:36 +00003762 ObjCTypesHelper *ObjCTypes)
John McCall2dd7d442010-08-04 05:59:32 +00003763 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCall65bea082010-07-21 06:59:36 +00003764 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
3765
Craig Topper4f12f102014-03-12 06:41:41 +00003766 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall65bea082010-07-21 06:59:36 +00003767 // Check whether we need to call objc_exception_try_exit.
3768 // In optimized code, this branch will always be folded.
3769 llvm::BasicBlock *FinallyCallExit =
3770 CGF.createBasicBlock("finally.call_exit");
3771 llvm::BasicBlock *FinallyNoCallExit =
3772 CGF.createBasicBlock("finally.no_call_exit");
3773 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
3774 FinallyCallExit, FinallyNoCallExit);
3775
3776 CGF.EmitBlock(FinallyCallExit);
John McCall882987f2013-02-28 19:01:20 +00003777 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
John McCall7f416cc2015-09-08 08:05:57 +00003778 ExceptionData.getPointer());
John McCall65bea082010-07-21 06:59:36 +00003779
3780 CGF.EmitBlock(FinallyNoCallExit);
3781
3782 if (isa<ObjCAtTryStmt>(S)) {
3783 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCallcebe0ca2010-08-11 00:16:14 +00003784 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall638d4f52013-04-03 00:56:07 +00003785 // Don't try to do the @finally if this is an EH cleanup.
3786 if (flags.isForEHCleanup()) return;
3787
John McCallcebe0ca2010-08-11 00:16:14 +00003788 // Save the current cleanup destination in case there's
3789 // control flow inside the finally statement.
3790 llvm::Value *CurCleanupDest =
3791 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
3792
John McCall65bea082010-07-21 06:59:36 +00003793 CGF.EmitStmt(FinallyStmt->getFinallyBody());
3794
John McCallcebe0ca2010-08-11 00:16:14 +00003795 if (CGF.HaveInsertPoint()) {
3796 CGF.Builder.CreateStore(CurCleanupDest,
3797 CGF.getNormalCleanupDestSlot());
3798 } else {
3799 // Currently, the end of the cleanup must always exist.
3800 CGF.EnsureInsertPoint();
3801 }
3802 }
John McCall65bea082010-07-21 06:59:36 +00003803 } else {
3804 // Emit objc_sync_exit(expr); as finally's sole statement for
3805 // @synchronized.
John McCall2dd7d442010-08-04 05:59:32 +00003806 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCall882987f2013-02-28 19:01:20 +00003807 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCall65bea082010-07-21 06:59:36 +00003808 }
3809 }
3810 };
John McCall42227ed2010-07-31 23:20:56 +00003811
3812 class FragileHazards {
3813 CodeGenFunction &CGF;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003814 SmallVector<llvm::Value*, 20> Locals;
John McCall42227ed2010-07-31 23:20:56 +00003815 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
3816
3817 llvm::InlineAsm *ReadHazard;
3818 llvm::InlineAsm *WriteHazard;
3819
3820 llvm::FunctionType *GetAsmFnType();
3821
3822 void collectLocals();
3823 void emitReadHazard(CGBuilderTy &Builder);
3824
3825 public:
3826 FragileHazards(CodeGenFunction &CGF);
John McCall2dd7d442010-08-04 05:59:32 +00003827
John McCall42227ed2010-07-31 23:20:56 +00003828 void emitWriteHazard();
John McCall2dd7d442010-08-04 05:59:32 +00003829 void emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00003830 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003831} // end anonymous namespace
John McCall42227ed2010-07-31 23:20:56 +00003832
3833/// Create the fragile-ABI read and write hazards based on the current
3834/// state of the function, which is presumed to be immediately prior
3835/// to a @try block. These hazards are used to maintain correct
3836/// semantics in the face of optimization and the fragile ABI's
3837/// cavalier use of setjmp/longjmp.
3838FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
3839 collectLocals();
3840
3841 if (Locals.empty()) return;
3842
3843 // Collect all the blocks in the function.
3844 for (llvm::Function::iterator
3845 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
3846 BlocksBeforeTry.insert(&*I);
3847
3848 llvm::FunctionType *AsmFnTy = GetAsmFnType();
3849
3850 // Create a read hazard for the allocas. This inhibits dead-store
3851 // optimizations and forces the values to memory. This hazard is
3852 // inserted before any 'throwing' calls in the protected scope to
3853 // reflect the possibility that the variables might be read from the
3854 // catch block if the call throws.
3855 {
3856 std::string Constraint;
3857 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3858 if (I) Constraint += ',';
3859 Constraint += "*m";
3860 }
3861
3862 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3863 }
3864
3865 // Create a write hazard for the allocas. This inhibits folding
3866 // loads across the hazard. This hazard is inserted at the
3867 // beginning of the catch path to reflect the possibility that the
3868 // variables might have been written within the protected scope.
3869 {
3870 std::string Constraint;
3871 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
3872 if (I) Constraint += ',';
3873 Constraint += "=*m";
3874 }
3875
3876 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
3877 }
3878}
3879
3880/// Emit a write hazard at the current location.
3881void FragileHazards::emitWriteHazard() {
3882 if (Locals.empty()) return;
3883
John McCall882987f2013-02-28 19:01:20 +00003884 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall42227ed2010-07-31 23:20:56 +00003885}
3886
John McCall42227ed2010-07-31 23:20:56 +00003887void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
3888 assert(!Locals.empty());
John McCall882987f2013-02-28 19:01:20 +00003889 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
3890 call->setDoesNotThrow();
3891 call->setCallingConv(CGF.getRuntimeCC());
John McCall42227ed2010-07-31 23:20:56 +00003892}
3893
3894/// Emit read hazards in all the protected blocks, i.e. all the blocks
3895/// which have been inserted since the beginning of the try.
John McCall2dd7d442010-08-04 05:59:32 +00003896void FragileHazards::emitHazardsInNewBlocks() {
John McCall42227ed2010-07-31 23:20:56 +00003897 if (Locals.empty()) return;
3898
John McCall7f416cc2015-09-08 08:05:57 +00003899 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall42227ed2010-07-31 23:20:56 +00003900
3901 // Iterate through all blocks, skipping those prior to the try.
3902 for (llvm::Function::iterator
3903 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
3904 llvm::BasicBlock &BB = *FI;
3905 if (BlocksBeforeTry.count(&BB)) continue;
3906
3907 // Walk through all the calls in the block.
3908 for (llvm::BasicBlock::iterator
3909 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
3910 llvm::Instruction &I = *BI;
3911
3912 // Ignore instructions that aren't non-intrinsic calls.
3913 // These are the only calls that can possibly call longjmp.
3914 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I)) continue;
3915 if (isa<llvm::IntrinsicInst>(I))
3916 continue;
3917
3918 // Ignore call sites marked nounwind. This may be questionable,
3919 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
3920 llvm::CallSite CS(&I);
3921 if (CS.doesNotThrow()) continue;
3922
John McCall2dd7d442010-08-04 05:59:32 +00003923 // Insert a read hazard before the call. This will ensure that
3924 // any writes to the locals are performed before making the
3925 // call. If the call throws, then this is sufficient to
3926 // guarantee correctness as long as it doesn't also write to any
3927 // locals.
John McCall42227ed2010-07-31 23:20:56 +00003928 Builder.SetInsertPoint(&BB, BI);
3929 emitReadHazard(Builder);
3930 }
3931 }
3932}
3933
3934static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, llvm::Value *V) {
3935 if (V) S.insert(V);
3936}
3937
John McCall7f416cc2015-09-08 08:05:57 +00003938static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
3939 if (V.isValid()) S.insert(V.getPointer());
3940}
3941
John McCall42227ed2010-07-31 23:20:56 +00003942void FragileHazards::collectLocals() {
3943 // Compute a set of allocas to ignore.
3944 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
3945 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
3946 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall42227ed2010-07-31 23:20:56 +00003947
3948 // Collect all the allocas currently in the function. This is
3949 // probably way too aggressive.
3950 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
3951 for (llvm::BasicBlock::iterator
3952 I = Entry.begin(), E = Entry.end(); I != E; ++I)
3953 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
3954 Locals.push_back(&*I);
3955}
3956
3957llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003958 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall9dc0db22011-05-15 01:53:33 +00003959 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
3960 tys[i] = Locals[i]->getType();
3961 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCall65bea082010-07-21 06:59:36 +00003962}
3963
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003964/*
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003965
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003966 Objective-C setjmp-longjmp (sjlj) Exception Handling
3967 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00003968
John McCallbd309292010-07-06 01:34:17 +00003969 A catch buffer is a setjmp buffer plus:
3970 - a pointer to the exception that was caught
3971 - a pointer to the previous exception data buffer
3972 - two pointers of reserved storage
3973 Therefore catch buffers form a stack, with a pointer to the top
3974 of the stack kept in thread-local storage.
3975
3976 objc_exception_try_enter pushes a catch buffer onto the EH stack.
3977 objc_exception_try_exit pops the given catch buffer, which is
3978 required to be the top of the EH stack.
3979 objc_exception_throw pops the top of the EH stack, writes the
3980 thrown exception into the appropriate field, and longjmps
3981 to the setjmp buffer. It crashes the process (with a printf
3982 and an abort()) if there are no catch buffers on the stack.
3983 objc_exception_extract just reads the exception pointer out of the
3984 catch buffer.
3985
3986 There's no reason an implementation couldn't use a light-weight
3987 setjmp here --- something like __builtin_setjmp, but API-compatible
3988 with the heavyweight setjmp. This will be more important if we ever
3989 want to implement correct ObjC/C++ exception interactions for the
3990 fragile ABI.
3991
3992 Note that for this use of setjmp/longjmp to be correct, we may need
3993 to mark some local variables volatile: if a non-volatile local
3994 variable is modified between the setjmp and the longjmp, it has
3995 indeterminate value. For the purposes of LLVM IR, it may be
3996 sufficient to make loads and stores within the @try (to variables
3997 declared outside the @try) volatile. This is necessary for
3998 optimized correctness, but is not currently being done; this is
3999 being tracked as rdar://problem/8160285
4000
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004001 The basic framework for a @try-catch-finally is as follows:
4002 {
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004003 objc_exception_data d;
4004 id _rethrow = null;
Anders Carlssonda0e4562009-02-07 21:26:04 +00004005 bool _call_try_exit = true;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004006
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004007 objc_exception_try_enter(&d);
4008 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004009 ... try body ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004010 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004011 // exception path
4012 id _caught = objc_exception_extract(&d);
4013
4014 // enter new try scope for handlers
4015 if (!setjmp(d.jmp_buf)) {
4016 ... match exception and execute catch blocks ...
4017
4018 // fell off end, rethrow.
4019 _rethrow = _caught;
4020 ... jump-through-finally to finally_rethrow ...
4021 } else {
4022 // exception in catch block
4023 _rethrow = objc_exception_extract(&d);
4024 _call_try_exit = false;
4025 ... jump-through-finally to finally_rethrow ...
4026 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004027 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004028 ... jump-through-finally to finally_end ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004029
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004030 finally:
Anders Carlssonda0e4562009-02-07 21:26:04 +00004031 if (_call_try_exit)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004032 objc_exception_try_exit(&d);
Anders Carlssonda0e4562009-02-07 21:26:04 +00004033
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004034 ... finally block ....
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004035 ... dispatch to finally destination ...
4036
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004037 finally_rethrow:
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004038 objc_exception_throw(_rethrow);
4039
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004040 finally_end:
4041 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004042
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004043 This framework differs slightly from the one gcc uses, in that gcc
4044 uses _rethrow to determine if objc_exception_try_exit should be called
4045 and if the object should be rethrown. This breaks in the face of
4046 throwing nil and introduces unnecessary branches.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004047
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004048 We specialize this framework for a few particular circumstances:
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004049
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004050 - If there are no catch blocks, then we avoid emitting the second
4051 exception handling context.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004052
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004053 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
4054 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004055
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004056 - FIXME: If there is no @finally block we can do a few more
4057 simplifications.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004058
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004059 Rethrows and Jumps-Through-Finally
4060 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004061
John McCallbd309292010-07-06 01:34:17 +00004062 '@throw;' is supported by pushing the currently-caught exception
4063 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004064
John McCallbd309292010-07-06 01:34:17 +00004065 Branches through the @finally block are handled with an ordinary
4066 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
4067 exceptions are not compatible with C++ exceptions, and this is
4068 hardly the only place where this will go wrong.
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004069
John McCallbd309292010-07-06 01:34:17 +00004070 @synchronized(expr) { stmt; } is emitted as if it were:
4071 id synch_value = expr;
4072 objc_sync_enter(synch_value);
4073 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004074*/
4075
Fariborz Jahanianc2ad6dc2008-11-21 00:49:24 +00004076void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
4077 const Stmt &S) {
4078 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallbd309292010-07-06 01:34:17 +00004079
4080 // A destination for the fall-through edges of the catch handlers to
4081 // jump to.
4082 CodeGenFunction::JumpDest FinallyEnd =
4083 CGF.getJumpDestInCurrentScope("finally.end");
4084
4085 // A destination for the rethrow edge of the catch handlers to jump
4086 // to.
4087 CodeGenFunction::JumpDest FinallyRethrow =
4088 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004089
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004090 // For @synchronized, call objc_sync_enter(sync.expr). The
4091 // evaluation of the expression must occur before we enter the
John McCall2dd7d442010-08-04 05:59:32 +00004092 // @synchronized. We can't avoid a temp here because we need the
4093 // value to be preserved. If the backend ever does liveness
4094 // correctly after setjmp, this will be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00004095 Address SyncArgSlot = Address::invalid();
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004096 if (!isTry) {
John McCall2dd7d442010-08-04 05:59:32 +00004097 llvm::Value *SyncArg =
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004098 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
4099 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004100 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall2dd7d442010-08-04 05:59:32 +00004101
John McCall7f416cc2015-09-08 08:05:57 +00004102 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
4103 CGF.getPointerAlign(), "sync.arg");
John McCall2dd7d442010-08-04 05:59:32 +00004104 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004105 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004106
John McCall2dd7d442010-08-04 05:59:32 +00004107 // Allocate memory for the setjmp buffer. This needs to be kept
4108 // live throughout the try and catch blocks.
John McCall7f416cc2015-09-08 08:05:57 +00004109 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
4110 CGF.getPointerAlign(),
4111 "exceptiondata.ptr");
John McCall2dd7d442010-08-04 05:59:32 +00004112
John McCall42227ed2010-07-31 23:20:56 +00004113 // Create the fragile hazards. Note that this will not capture any
4114 // of the allocas required for exception processing, but will
4115 // capture the current basic block (which extends all the way to the
4116 // setjmp call) as "before the @try".
4117 FragileHazards Hazards(CGF);
4118
John McCallbd309292010-07-06 01:34:17 +00004119 // Create a flag indicating whether the cleanup needs to call
4120 // objc_exception_try_exit. This is true except when
4121 // - no catches match and we're branching through the cleanup
4122 // just to rethrow the exception, or
4123 // - a catch matched and we're falling out of the catch handler.
John McCall2dd7d442010-08-04 05:59:32 +00004124 // The setjmp-safety rule here is that we should always store to this
4125 // variable in a place that dominates the branch through the cleanup
4126 // without passing through any setjmps.
John McCall7f416cc2015-09-08 08:05:57 +00004127 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
4128 CharUnits::One(),
4129 "_call_try_exit");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004130
John McCall9916e3f2010-10-04 23:42:51 +00004131 // A slot containing the exception to rethrow. Only needed when we
4132 // have both a @catch and a @finally.
John McCall7f416cc2015-09-08 08:05:57 +00004133 Address PropagatingExnVar = Address::invalid();
John McCall9916e3f2010-10-04 23:42:51 +00004134
John McCallbd309292010-07-06 01:34:17 +00004135 // Push a normal cleanup to leave the try scope.
John McCall638d4f52013-04-03 00:56:07 +00004136 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall2dd7d442010-08-04 05:59:32 +00004137 SyncArgSlot,
John McCallcda666c2010-07-21 07:22:38 +00004138 CallTryExitVar,
4139 ExceptionData,
4140 &ObjCTypes);
John McCallbd309292010-07-06 01:34:17 +00004141
4142 // Enter a try block:
4143 // - Call objc_exception_try_enter to push ExceptionData on top of
4144 // the EH stack.
Nico Weber6307cf02015-02-26 20:43:00 +00004145 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004146 ExceptionData.getPointer());
John McCallbd309292010-07-06 01:34:17 +00004147
4148 // - Call setjmp on the exception data buffer.
4149 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
4150 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
David Blaikie6b2a8302015-04-03 17:47:16 +00004151 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
John McCall7f416cc2015-09-08 08:05:57 +00004152 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
4153 "setjmp_buffer");
Nico Weber6307cf02015-02-26 20:43:00 +00004154 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
4155 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004156 SetJmpResult->setCanReturnTwice();
John McCallbd309292010-07-06 01:34:17 +00004157
4158 // If setjmp returned 0, enter the protected block; otherwise,
4159 // branch to the handler.
Daniel Dunbar75283ff2008-11-11 02:29:29 +00004160 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
4161 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallbd309292010-07-06 01:34:17 +00004162 llvm::Value *DidCatch =
John McCallcebe0ca2010-08-11 00:16:14 +00004163 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4164 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004165
John McCallbd309292010-07-06 01:34:17 +00004166 // Emit the protected block.
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004167 CGF.EmitBlock(TryBlock);
John McCall2dd7d442010-08-04 05:59:32 +00004168 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004169 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallbd309292010-07-06 01:34:17 +00004170 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall2dd7d442010-08-04 05:59:32 +00004171
4172 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004173
John McCallbd309292010-07-06 01:34:17 +00004174 // Emit the exception handler block.
Daniel Dunbar7f086782008-09-27 23:30:04 +00004175 CGF.EmitBlock(TryHandler);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004176
John McCall42227ed2010-07-31 23:20:56 +00004177 // Don't optimize loads of the in-scope locals across this point.
4178 Hazards.emitWriteHazard();
4179
John McCallbd309292010-07-06 01:34:17 +00004180 // For a @synchronized (or a @try with no catches), just branch
4181 // through the cleanup to the rethrow block.
4182 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
4183 // Tell the cleanup not to re-pop the exit.
John McCall2dd7d442010-08-04 05:59:32 +00004184 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004185 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallbd309292010-07-06 01:34:17 +00004186
4187 // Otherwise, we have to match against the caught exceptions.
4188 } else {
John McCall2dd7d442010-08-04 05:59:32 +00004189 // Retrieve the exception object. We may emit multiple blocks but
4190 // nothing can cross this so the value is already in SSA form.
4191 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004192 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004193 ExceptionData.getPointer(), "caught");
John McCall2dd7d442010-08-04 05:59:32 +00004194
John McCallbd309292010-07-06 01:34:17 +00004195 // Push the exception to rethrow onto the EH value stack for the
4196 // benefit of any @throws in the handlers.
4197 CGF.ObjCEHValueStack.push_back(Caught);
4198
Douglas Gregor96c79492010-04-23 22:50:49 +00004199 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004200
Craig Topper8a13c412014-05-21 05:09:00 +00004201 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallbd309292010-07-06 01:34:17 +00004202
Craig Topper8a13c412014-05-21 05:09:00 +00004203 llvm::BasicBlock *CatchBlock = nullptr;
4204 llvm::BasicBlock *CatchHandler = nullptr;
John McCall2dd7d442010-08-04 05:59:32 +00004205 if (HasFinally) {
John McCall9916e3f2010-10-04 23:42:51 +00004206 // Save the currently-propagating exception before
4207 // objc_exception_try_enter clears the exception slot.
4208 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
John McCall7f416cc2015-09-08 08:05:57 +00004209 CGF.getPointerAlign(),
John McCall9916e3f2010-10-04 23:42:51 +00004210 "propagating_exception");
4211 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
4212
John McCall2dd7d442010-08-04 05:59:32 +00004213 // Enter a new exception try block (in case a @catch block
4214 // throws an exception).
John McCall882987f2013-02-28 19:01:20 +00004215 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004216 ExceptionData.getPointer());
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004217
John McCall2dd7d442010-08-04 05:59:32 +00004218 llvm::CallInst *SetJmpResult =
John McCall882987f2013-02-28 19:01:20 +00004219 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4220 SetJmpBuffer, "setjmp.result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004221 SetJmpResult->setCanReturnTwice();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004222
John McCall2dd7d442010-08-04 05:59:32 +00004223 llvm::Value *Threw =
4224 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4225
4226 CatchBlock = CGF.createBasicBlock("catch");
4227 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4228 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4229
4230 CGF.EmitBlock(CatchBlock);
4231 }
4232
4233 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004234
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004235 // Handle catch list. As a special case we check if everything is
4236 // matched and avoid generating code for falling off the end if
4237 // so.
4238 bool AllMatched = false;
Douglas Gregor96c79492010-04-23 22:50:49 +00004239 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4240 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004241
Douglas Gregor46a572b2010-04-26 16:46:50 +00004242 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00004243 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar523208f2008-09-27 07:36:24 +00004244
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004245 // catch(...) always matches.
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004246 if (!CatchParam) {
4247 AllMatched = true;
4248 } else {
John McCall9dd450b2009-09-21 23:43:11 +00004249 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004250
John McCallbd309292010-07-06 01:34:17 +00004251 // catch(id e) always matches under this ABI, since only
4252 // ObjC exceptions end up here in the first place.
Daniel Dunbar86919f42008-09-27 22:21:14 +00004253 // FIXME: For the time being we also match id<X>; this should
4254 // be rejected by Sema instead.
Eli Friedman55179ca2009-07-11 00:57:02 +00004255 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004256 AllMatched = true;
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004257 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004258
John McCallbd309292010-07-06 01:34:17 +00004259 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004260 if (AllMatched) {
John McCallbd309292010-07-06 01:34:17 +00004261 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4262
Anders Carlsson9396a892008-09-11 09:15:33 +00004263 if (CatchParam) {
John McCall1c9c3fd2010-10-15 04:57:14 +00004264 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004265 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallbd309292010-07-06 01:34:17 +00004266
4267 // These types work out because ConvertType(id) == i8*.
John McCall17f02752015-10-30 00:56:02 +00004268 EmitInitOfCatchParam(CGF, Caught, CatchParam);
Anders Carlsson9396a892008-09-11 09:15:33 +00004269 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004270
Anders Carlsson9396a892008-09-11 09:15:33 +00004271 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004272
4273 // The scope of the catch variable ends right here.
4274 CatchVarCleanups.ForceCleanup();
4275
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004276 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004277 break;
4278 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004279
Steve Naroff7cae42b2009-07-10 23:34:53 +00004280 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall96fa4842010-05-17 21:00:27 +00004281 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallbd309292010-07-06 01:34:17 +00004282
4283 // FIXME: @catch (Class c) ?
John McCall96fa4842010-05-17 21:00:27 +00004284 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4285 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004286
4287 // Check if the @catch block matches the exception object.
John McCall882987f2013-02-28 19:01:20 +00004288 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004289
John McCall882987f2013-02-28 19:01:20 +00004290 llvm::Value *matchArgs[] = { Class, Caught };
John McCallbd309292010-07-06 01:34:17 +00004291 llvm::CallInst *Match =
John McCall882987f2013-02-28 19:01:20 +00004292 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4293 matchArgs, "match");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004294
John McCallbd309292010-07-06 01:34:17 +00004295 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4296 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004297
4298 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbar7f086782008-09-27 23:30:04 +00004299 MatchedBlock, NextCatchBlock);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004300
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004301 // Emit the @catch block.
4302 CGF.EmitBlock(MatchedBlock);
John McCallbd309292010-07-06 01:34:17 +00004303
4304 // Collect any cleanups for the catch variable. The scope lasts until
4305 // the end of the catch body.
John McCall2dd7d442010-08-04 05:59:32 +00004306 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallbd309292010-07-06 01:34:17 +00004307
John McCall1c9c3fd2010-10-15 04:57:14 +00004308 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004309 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004310
John McCallbd309292010-07-06 01:34:17 +00004311 // Initialize the catch variable.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004312 llvm::Value *Tmp =
4313 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004314 CGF.ConvertType(CatchParam->getType()));
John McCall17f02752015-10-30 00:56:02 +00004315 EmitInitOfCatchParam(CGF, Tmp, CatchParam);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004316
Anders Carlsson9396a892008-09-11 09:15:33 +00004317 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004318
4319 // We're done with the catch variable.
4320 CatchVarCleanups.ForceCleanup();
4321
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004322 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004323
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004324 CGF.EmitBlock(NextCatchBlock);
4325 }
4326
John McCallbd309292010-07-06 01:34:17 +00004327 CGF.ObjCEHValueStack.pop_back();
4328
John McCall2dd7d442010-08-04 05:59:32 +00004329 // If nothing wanted anything to do with the caught exception,
4330 // kill the extract call.
4331 if (Caught->use_empty())
4332 Caught->eraseFromParent();
4333
4334 if (!AllMatched)
4335 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4336
4337 if (HasFinally) {
4338 // Emit the exception handler for the @catch blocks.
4339 CGF.EmitBlock(CatchHandler);
4340
4341 // In theory we might now need a write hazard, but actually it's
4342 // unnecessary because there's no local-accessing code between
4343 // the try's write hazard and here.
4344 //Hazards.emitWriteHazard();
4345
John McCall9916e3f2010-10-04 23:42:51 +00004346 // Extract the new exception and save it to the
4347 // propagating-exception slot.
John McCall7f416cc2015-09-08 08:05:57 +00004348 assert(PropagatingExnVar.isValid());
John McCall9916e3f2010-10-04 23:42:51 +00004349 llvm::CallInst *NewCaught =
John McCall882987f2013-02-28 19:01:20 +00004350 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004351 ExceptionData.getPointer(), "caught");
John McCall9916e3f2010-10-04 23:42:51 +00004352 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4353
John McCall2dd7d442010-08-04 05:59:32 +00004354 // Don't pop the catch handler; the throw already did.
4355 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004356 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004357 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004358 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004359
John McCall42227ed2010-07-31 23:20:56 +00004360 // Insert read hazards as required in the new blocks.
John McCall2dd7d442010-08-04 05:59:32 +00004361 Hazards.emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004362
John McCallbd309292010-07-06 01:34:17 +00004363 // Pop the cleanup.
John McCall2dd7d442010-08-04 05:59:32 +00004364 CGF.Builder.restoreIP(TryFallthroughIP);
4365 if (CGF.HaveInsertPoint())
4366 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallbd309292010-07-06 01:34:17 +00004367 CGF.PopCleanupBlock();
John McCall2dd7d442010-08-04 05:59:32 +00004368 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004369
John McCallbd309292010-07-06 01:34:17 +00004370 // Emit the rethrow block.
John McCall42227ed2010-07-31 23:20:56 +00004371 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallad5d61e2010-07-23 21:56:41 +00004372 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallbd309292010-07-06 01:34:17 +00004373 if (CGF.HaveInsertPoint()) {
John McCall9916e3f2010-10-04 23:42:51 +00004374 // If we have a propagating-exception variable, check it.
4375 llvm::Value *PropagatingExn;
John McCall7f416cc2015-09-08 08:05:57 +00004376 if (PropagatingExnVar.isValid()) {
John McCall9916e3f2010-10-04 23:42:51 +00004377 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall2dd7d442010-08-04 05:59:32 +00004378
John McCall9916e3f2010-10-04 23:42:51 +00004379 // Otherwise, just look in the buffer for the exception to throw.
4380 } else {
4381 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004382 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004383 ExceptionData.getPointer());
John McCall9916e3f2010-10-04 23:42:51 +00004384 PropagatingExn = Caught;
4385 }
4386
John McCall882987f2013-02-28 19:01:20 +00004387 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4388 PropagatingExn);
John McCallbd309292010-07-06 01:34:17 +00004389 CGF.Builder.CreateUnreachable();
Fariborz Jahaniane2caaaa2008-11-21 19:21:53 +00004390 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004391
John McCall42227ed2010-07-31 23:20:56 +00004392 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004393}
4394
4395void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004396 const ObjCAtThrowStmt &S,
4397 bool ClearInsertionPoint) {
Anders Carlssone005aa12008-09-09 16:16:55 +00004398 llvm::Value *ExceptionAsObject;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004399
Anders Carlssone005aa12008-09-09 16:16:55 +00004400 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00004401 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004402 ExceptionAsObject =
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004403 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlssone005aa12008-09-09 16:16:55 +00004404 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004405 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004406 "Unexpected rethrow outside @catch block.");
Anders Carlssonbf8a1be2009-02-07 21:37:21 +00004407 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlssone005aa12008-09-09 16:16:55 +00004408 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004409
John McCall882987f2013-02-28 19:01:20 +00004410 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallbd309292010-07-06 01:34:17 +00004411 ->setDoesNotReturn();
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004412 CGF.Builder.CreateUnreachable();
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004413
4414 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004415 if (ClearInsertionPoint)
4416 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004417}
4418
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004419/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004420/// object: objc_read_weak (id *src)
4421///
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004422llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004423 Address AddrWeakObj) {
4424 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004425 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4426 ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004427 llvm::Value *read_weak =
4428 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004429 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00004430 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004431 return read_weak;
4432}
4433
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004434/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4435/// objc_assign_weak (id src, id *dst)
4436///
4437void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004438 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004439 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004440 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004441 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004442 assert(Size <= 8 && "does not support size > 8");
4443 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004444 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004445 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4446 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004447 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4448 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004449 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004450 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4451 args, "weakassign");
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004452}
4453
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004454/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4455/// objc_assign_global (id src, id *dst)
4456///
4457void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004458 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00004459 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004460 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004461 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004462 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004463 assert(Size <= 8 && "does not support size > 8");
4464 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004465 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004466 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4467 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004468 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4469 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004470 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00004471 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00004472 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4473 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00004474 else
John McCall882987f2013-02-28 19:01:20 +00004475 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4476 args, "threadlocalassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004477}
4478
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004479/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004480/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004481///
4482void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004483 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004484 llvm::Value *ivarOffset) {
4485 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2192fe52011-07-18 04:24:23 +00004486 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004487 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004488 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004489 assert(Size <= 8 && "does not support size > 8");
4490 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004491 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004492 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4493 }
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004494 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4495 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004496 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00004497 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004498}
4499
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004500/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4501/// objc_assign_strongCast (id src, id *dst)
4502///
4503void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004504 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004505 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004506 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004507 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004508 assert(Size <= 8 && "does not support size > 8");
4509 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004510 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongLongTy);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004511 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4512 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004513 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4514 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004515 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004516 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004517 args, "strongassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004518}
4519
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004520void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004521 Address DestPtr,
4522 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004523 llvm::Value *size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004524 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4525 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004526 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCall882987f2013-02-28 19:01:20 +00004527 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004528}
4529
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004530/// EmitObjCValueForIvar - Code Gen for ivar reference.
4531///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004532LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4533 QualType ObjectTy,
4534 llvm::Value *BaseValue,
4535 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004536 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004537 const ObjCInterfaceDecl *ID =
4538 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004539 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4540 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004541}
4542
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004543llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004544 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004545 const ObjCIvarDecl *Ivar) {
Eli Friedman8cbca202012-11-06 22:15:52 +00004546 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4547 return llvm::ConstantInt::get(
4548 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4549 Offset);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004550}
4551
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004552/* *** Private Interface *** */
4553
4554/// EmitImageInfo - Emit the image info marker used to encode some module
4555/// level information.
4556///
4557/// See: <rdr://4810609&4810587&4810587>
4558/// struct IMAGE_INFO {
4559/// unsigned version;
4560/// unsigned flags;
4561/// };
4562enum ImageInfoFlags {
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004563 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004564 eImageInfo_GarbageCollected = (1 << 1),
4565 eImageInfo_GCOnly = (1 << 2),
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004566 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbar75e909f2009-04-20 07:11:47 +00004567
Daniel Dunbar5e639272010-04-25 20:39:01 +00004568 // A flag indicating that the module has no instances of a @synthesize of a
4569 // superclass variable. <rdar://problem/6803242>
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004570 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Manman Ren96df0b32016-01-29 23:45:01 +00004571 eImageInfo_ImageIsSimulated = (1 << 5),
4572 eImageInfo_ClassProperties = (1 << 6)
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004573};
4574
Daniel Dunbar5e639272010-04-25 20:39:01 +00004575void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004576 unsigned version = 0; // Version is unused?
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004577 const char *Section = (ObjCABI == 1) ?
4578 "__OBJC, __image_info,regular" :
4579 "__DATA, __objc_imageinfo, regular, no_dead_strip";
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004580
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004581 // Generate module-level named metadata to convey this information to the
4582 // linker and code-gen.
4583 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004584
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004585 // Add the ObjC ABI version to the module flags.
4586 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4587 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4588 version);
4589 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
4590 llvm::MDString::get(VMContext,Section));
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004591
David Blaikiebbafb8a2012-03-11 07:00:24 +00004592 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004593 // Non-GC overrides those files which specify GC.
4594 Mod.addModuleFlag(llvm::Module::Override,
4595 "Objective-C Garbage Collection", (uint32_t)0);
4596 } else {
4597 // Add the ObjC garbage collection value.
4598 Mod.addModuleFlag(llvm::Module::Error,
4599 "Objective-C Garbage Collection",
4600 eImageInfo_GarbageCollected);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004601
David Blaikiebbafb8a2012-03-11 07:00:24 +00004602 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004603 // Add the ObjC GC Only value.
4604 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4605 eImageInfo_GCOnly);
4606
4607 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004608 llvm::Metadata *Ops[2] = {
4609 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4610 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4611 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004612 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4613 llvm::MDNode::get(VMContext, Ops));
4614 }
4615 }
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004616
4617 // Indicate whether we're compiling this to run on a simulator.
4618 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00004619 if ((Triple.isiOS() || Triple.isWatchOS()) &&
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004620 (Triple.getArch() == llvm::Triple::x86 ||
4621 Triple.getArch() == llvm::Triple::x86_64))
4622 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4623 eImageInfo_ImageIsSimulated);
Manman Ren96df0b32016-01-29 23:45:01 +00004624
4625 // Indicate whether we are generating class properties.
4626 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Class Properties",
4627 eImageInfo_ClassProperties);
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004628}
4629
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004630// struct objc_module {
4631// unsigned long version;
4632// unsigned long size;
4633// const char *name;
4634// Symtab symtab;
4635// };
4636
4637// FIXME: Get from somewhere
4638static const int ModuleVersion = 7;
4639
4640void CGObjCMac::EmitModuleInfo() {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004641 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004642
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004643 llvm::Constant *Values[] = {
4644 llvm::ConstantInt::get(ObjCTypes.LongTy, ModuleVersion),
4645 llvm::ConstantInt::get(ObjCTypes.LongTy, Size),
4646 // This used to be the filename, now it is unused. <rdr://4327263>
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004647 GetClassName(StringRef("")),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00004648 EmitModuleSymbols()
4649 };
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004650 CreateMetadataVar("OBJC_MODULES",
Owen Anderson0e0189d2009-07-27 22:29:56 +00004651 llvm::ConstantStruct::get(ObjCTypes.ModuleTy, Values),
John McCall7f416cc2015-09-08 08:05:57 +00004652 "__OBJC,__module_info,regular,no_dead_strip",
4653 CGM.getPointerAlign(), true);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004654}
4655
4656llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004657 unsigned NumClasses = DefinedClasses.size();
4658 unsigned NumCategories = DefinedCategories.size();
4659
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004660 // Return null if no symbols were defined.
4661 if (!NumClasses && !NumCategories)
Owen Anderson0b75f232009-07-31 20:28:54 +00004662 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004663
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004664 llvm::Constant *Values[5];
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004665 Values[0] = llvm::ConstantInt::get(ObjCTypes.LongTy, 0);
Owen Anderson0b75f232009-07-31 20:28:54 +00004666 Values[1] = llvm::Constant::getNullValue(ObjCTypes.SelectorPtrTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00004667 Values[2] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumClasses);
4668 Values[3] = llvm::ConstantInt::get(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004669
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004670 // The runtime expects exactly the list of defined classes followed
4671 // by the list of defined categories, in a single array.
Chris Lattner3def9ae2012-02-06 22:16:34 +00004672 SmallVector<llvm::Constant*, 8> Symbols(NumClasses + NumCategories);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004673 for (unsigned i=0; i<NumClasses; i++) {
4674 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
4675 assert(ID);
4676 if (ObjCImplementationDecl *IMP = ID->getImplementation())
4677 // We are implementing a weak imported interface. Give it external linkage
4678 if (ID->isWeakImported() && !IMP->isWeakImported())
4679 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
4680
Owen Andersonade90fd2009-07-29 18:54:39 +00004681 Symbols[i] = llvm::ConstantExpr::getBitCast(DefinedClasses[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004682 ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004683 }
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004684 for (unsigned i=0; i<NumCategories; i++)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004685 Symbols[NumClasses + i] =
Owen Andersonade90fd2009-07-29 18:54:39 +00004686 llvm::ConstantExpr::getBitCast(DefinedCategories[i],
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004687 ObjCTypes.Int8PtrTy);
4688
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004689 Values[4] =
Owen Anderson9793f0e2009-07-29 22:16:19 +00004690 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00004691 Symbols.size()),
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004692 Symbols);
4693
Chris Lattnere64d7ba2011-06-20 04:01:35 +00004694 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004695
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004696 llvm::GlobalVariable *GV = CreateMetadataVar(
John McCall7f416cc2015-09-08 08:05:57 +00004697 "OBJC_SYMBOLS", Init, "__OBJC,__symbols,regular,no_dead_strip",
4698 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00004699 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004700}
4701
John McCall882987f2013-02-28 19:01:20 +00004702llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
4703 IdentifierInfo *II) {
John McCall31168b02011-06-15 23:02:42 +00004704 LazySymbols.insert(II);
4705
4706 llvm::GlobalVariable *&Entry = ClassReferences[II];
4707
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004708 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004709 llvm::Constant *Casted =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004710 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCall31168b02011-06-15 23:02:42 +00004711 ObjCTypes.ClassPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004712 Entry = CreateMetadataVar(
4713 "OBJC_CLASS_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004714 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
4715 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004716 }
John McCall31168b02011-06-15 23:02:42 +00004717
John McCall7f416cc2015-09-08 08:05:57 +00004718 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004719}
4720
John McCall882987f2013-02-28 19:01:20 +00004721llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00004722 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00004723 // If the class has the objc_runtime_visible attribute, we need to
4724 // use the Objective-C runtime to get the class.
4725 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
4726 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
4727
John McCall882987f2013-02-28 19:01:20 +00004728 return EmitClassRefFromId(CGF, ID->getIdentifier());
John McCall31168b02011-06-15 23:02:42 +00004729}
4730
John McCall882987f2013-02-28 19:01:20 +00004731llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00004732 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCall882987f2013-02-28 19:01:20 +00004733 return EmitClassRefFromId(CGF, II);
John McCall31168b02011-06-15 23:02:42 +00004734}
4735
John McCall7f416cc2015-09-08 08:05:57 +00004736llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
4737 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
4738}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004739
John McCall7f416cc2015-09-08 08:05:57 +00004740Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
4741 CharUnits Align = CGF.getPointerAlign();
4742
4743 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004744 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004745 llvm::Constant *Casted =
Owen Andersonade90fd2009-07-29 18:54:39 +00004746 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004747 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004748 Entry = CreateMetadataVar(
4749 "OBJC_SELECTOR_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004750 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman5c205962013-02-05 23:08:45 +00004751 Entry->setExternallyInitialized(true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004752 }
4753
John McCall7f416cc2015-09-08 08:05:57 +00004754 return Address(Entry, Align);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004755}
4756
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004757llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
4758 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
4759 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00004760 Entry = CreateCStringLiteral(RuntimeName, ObjCLabelType::ClassName);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004761 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004762}
4763
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004764llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
4765 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
4766 I = MethodDefinitions.find(MD);
4767 if (I != MethodDefinitions.end())
4768 return I->second;
4769
Craig Topper8a13c412014-05-21 05:09:00 +00004770 return nullptr;
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004771}
4772
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004773/// GetIvarLayoutName - Returns a unique constant for the given
4774/// ivar layout bitmap.
4775llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004776 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Anderson0b75f232009-07-31 20:28:54 +00004777 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahanian01dff422009-03-05 19:17:31 +00004778}
4779
John McCall3fd13f062015-10-21 18:06:47 +00004780void IvarLayoutBuilder::visitRecord(const RecordType *RT,
4781 CharUnits offset) {
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004782 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004783
John McCall3fd13f062015-10-21 18:06:47 +00004784 // If this is a union, remember that we had one, because it might mess
4785 // up the ordering of layout entries.
4786 if (RD->isUnion())
4787 IsDisordered = true;
4788
4789 const ASTRecordLayout *recLayout = nullptr;
4790 visitAggregate(RD->field_begin(), RD->field_end(), offset,
4791 [&](const FieldDecl *field) -> CharUnits {
4792 if (!recLayout)
4793 recLayout = &CGM.getContext().getASTRecordLayout(RD);
4794 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
4795 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
4796 });
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004797}
4798
John McCall3fd13f062015-10-21 18:06:47 +00004799template <class Iterator, class GetOffsetFn>
4800void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
4801 CharUnits aggregateOffset,
4802 const GetOffsetFn &getOffset) {
4803 for (; begin != end; ++begin) {
4804 auto field = *begin;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004805
John McCall3fd13f062015-10-21 18:06:47 +00004806 // Skip over bitfields.
4807 if (field->isBitField()) {
4808 continue;
4809 }
4810
4811 // Compute the offset of the field within the aggregate.
4812 CharUnits fieldOffset = aggregateOffset + getOffset(field);
4813
4814 visitField(field, fieldOffset);
4815 }
4816}
4817
4818/// Collect layout information for the given fields into IvarsInfo.
4819void IvarLayoutBuilder::visitField(const FieldDecl *field,
4820 CharUnits fieldOffset) {
4821 QualType fieldType = field->getType();
4822
4823 // Drill down into arrays.
4824 uint64_t numElts = 1;
4825 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
4826 numElts *= arrayType->getSize().getZExtValue();
4827 fieldType = arrayType->getElementType();
4828 }
4829
4830 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
4831
4832 // If we ended up with a zero-sized array, we've done what we can do within
4833 // the limits of this layout encoding.
4834 if (numElts == 0) return;
4835
4836 // Recurse if the base element type is a record type.
4837 if (auto recType = fieldType->getAs<RecordType>()) {
4838 size_t oldEnd = IvarsInfo.size();
4839
4840 visitRecord(recType, fieldOffset);
4841
4842 // If we have an array, replicate the first entry's layout information.
4843 auto numEltEntries = IvarsInfo.size() - oldEnd;
4844 if (numElts != 1 && numEltEntries != 0) {
4845 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
4846 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
4847 // Copy the last numEltEntries onto the end of the array, adjusting
4848 // each for the element size.
4849 for (size_t i = 0; i != numEltEntries; ++i) {
4850 auto firstEntry = IvarsInfo[oldEnd + i];
4851 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
4852 firstEntry.SizeInWords));
4853 }
4854 }
4855 }
4856
Fariborz Jahanian524bb202009-03-10 16:22:08 +00004857 return;
Fariborz Jahanian3b0f8862009-03-11 00:07:04 +00004858 }
Daniel Dunbar15bd8882009-05-03 14:10:34 +00004859
John McCall3fd13f062015-10-21 18:06:47 +00004860 // Classify the element type.
4861 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004862
John McCall3fd13f062015-10-21 18:06:47 +00004863 // If it matches what we're looking for, add an entry.
4864 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
4865 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
4866 assert(CGM.getContext().getTypeSizeInChars(fieldType)
4867 == CGM.getPointerSize());
4868 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
4869 }
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00004870}
4871
John McCall3fd13f062015-10-21 18:06:47 +00004872/// buildBitmap - This routine does the horsework of taking the offsets of
4873/// strong/weak references and creating a bitmap. The bitmap is also
4874/// returned in the given buffer, suitable for being passed to \c dump().
4875llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
4876 llvm::SmallVectorImpl<unsigned char> &buffer) {
4877 // The bitmap is a series of skip/scan instructions, aligned to word
4878 // boundaries. The skip is performed first.
4879 const unsigned char MaxNibble = 0xF;
4880 const unsigned char SkipMask = 0xF0, SkipShift = 4;
4881 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004882
John McCall3fd13f062015-10-21 18:06:47 +00004883 assert(!IvarsInfo.empty() && "generating bitmap for no data");
4884
4885 // Sort the ivar info on byte position in case we encounterred a
4886 // union nested in the ivar list.
4887 if (IsDisordered) {
4888 // This isn't a stable sort, but our algorithm should handle it fine.
4889 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
4890 } else {
Craig Toppera3467052016-01-03 19:43:20 +00004891 assert(std::is_sorted(IvarsInfo.begin(), IvarsInfo.end()));
John McCall3fd13f062015-10-21 18:06:47 +00004892 }
4893 assert(IvarsInfo.back().Offset < InstanceEnd);
4894
4895 assert(buffer.empty());
4896
4897 // Skip the next N words.
4898 auto skip = [&](unsigned numWords) {
4899 assert(numWords > 0);
4900
4901 // Try to merge into the previous byte. Since scans happen second, we
4902 // can't do this if it includes a scan.
4903 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
4904 unsigned lastSkip = buffer.back() >> SkipShift;
4905 if (lastSkip < MaxNibble) {
4906 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
4907 numWords -= claimed;
4908 lastSkip += claimed;
4909 buffer.back() = (lastSkip << SkipShift);
4910 }
4911 }
4912
4913 while (numWords >= MaxNibble) {
4914 buffer.push_back(MaxNibble << SkipShift);
4915 numWords -= MaxNibble;
4916 }
4917 if (numWords) {
4918 buffer.push_back(numWords << SkipShift);
4919 }
4920 };
4921
4922 // Scan the next N words.
4923 auto scan = [&](unsigned numWords) {
4924 assert(numWords > 0);
4925
4926 // Try to merge into the previous byte. Since scans happen second, we can
4927 // do this even if it includes a skip.
4928 if (!buffer.empty()) {
4929 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
4930 if (lastScan < MaxNibble) {
4931 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
4932 numWords -= claimed;
4933 lastScan += claimed;
4934 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
4935 }
4936 }
4937
4938 while (numWords >= MaxNibble) {
4939 buffer.push_back(MaxNibble << ScanShift);
4940 numWords -= MaxNibble;
4941 }
4942 if (numWords) {
4943 buffer.push_back(numWords << ScanShift);
4944 }
4945 };
4946
4947 // One past the end of the last scan.
4948 unsigned endOfLastScanInWords = 0;
4949 const CharUnits WordSize = CGM.getPointerSize();
4950
4951 // Consider all the scan requests.
4952 for (auto &request : IvarsInfo) {
4953 CharUnits beginOfScan = request.Offset - InstanceBegin;
4954
4955 // Ignore scan requests that don't start at an even multiple of the
4956 // word size. We can't encode them.
4957 if ((beginOfScan % WordSize) != 0) continue;
4958
4959 // Ignore scan requests that start before the instance start.
4960 // This assumes that scans never span that boundary. The boundary
4961 // isn't the true start of the ivars, because in the fragile-ARC case
4962 // it's rounded up to word alignment, but the test above should leave
4963 // us ignoring that possibility.
4964 if (beginOfScan.isNegative()) {
4965 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
4966 continue;
4967 }
4968
4969 unsigned beginOfScanInWords = beginOfScan / WordSize;
4970 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
4971
4972 // If the scan starts some number of words after the last one ended,
4973 // skip forward.
4974 if (beginOfScanInWords > endOfLastScanInWords) {
4975 skip(beginOfScanInWords - endOfLastScanInWords);
4976
4977 // Otherwise, start scanning where the last left off.
4978 } else {
4979 beginOfScanInWords = endOfLastScanInWords;
4980
4981 // If that leaves us with nothing to scan, ignore this request.
4982 if (beginOfScanInWords >= endOfScanInWords) continue;
4983 }
4984
4985 // Scan to the end of the request.
4986 assert(beginOfScanInWords < endOfScanInWords);
4987 scan(endOfScanInWords - beginOfScanInWords);
4988 endOfLastScanInWords = endOfScanInWords;
4989 }
4990
John McCallf5ea0722015-10-29 23:36:14 +00004991 if (buffer.empty())
4992 return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
4993
John McCall3fd13f062015-10-21 18:06:47 +00004994 // For GC layouts, emit a skip to the end of the allocation so that we
4995 // have precise information about the entire thing. This isn't useful
4996 // or necessary for the ARC-style layout strings.
4997 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
4998 unsigned lastOffsetInWords =
4999 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
5000 if (lastOffsetInWords > endOfLastScanInWords) {
5001 skip(lastOffsetInWords - endOfLastScanInWords);
5002 }
5003 }
5004
5005 // Null terminate the string.
5006 buffer.push_back(0);
5007
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005008 auto *Entry = CGObjC.CreateCStringLiteral(
5009 reinterpret_cast<char *>(buffer.data()), ObjCLabelType::ClassName);
John McCall3fd13f062015-10-21 18:06:47 +00005010 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005011}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005012
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005013/// BuildIvarLayout - Builds ivar layout bitmap for the class
5014/// implementation for the __strong or __weak case.
5015/// The layout map displays which words in ivar list must be skipped
5016/// and which must be scanned by GC (see below). String is built of bytes.
5017/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
5018/// of words to skip and right nibble is count of words to scan. So, each
5019/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
5020/// represented by a 0x00 byte which also ends the string.
5021/// 1. when ForStrongLayout is true, following ivars are scanned:
5022/// - id, Class
5023/// - object *
5024/// - __strong anything
5025///
5026/// 2. When ForStrongLayout is false, following ivars are scanned:
5027/// - __weak anything
5028///
John McCall3fd13f062015-10-21 18:06:47 +00005029llvm::Constant *
5030CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
5031 CharUnits beginOffset, CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +00005032 bool ForStrongLayout, bool HasMRCWeakIvars) {
5033 // If this is MRC, and we're either building a strong layout or there
5034 // are no weak ivars, bail out early.
Chris Lattnerece04092012-02-07 00:39:47 +00005035 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005036 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
John McCall460ce582015-10-22 18:38:17 +00005037 !CGM.getLangOpts().ObjCAutoRefCount &&
5038 (ForStrongLayout || !HasMRCWeakIvars))
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005039 return llvm::Constant::getNullValue(PtrTy);
5040
Jordy Rosea91768e2011-07-22 02:08:32 +00005041 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
John McCall3fd13f062015-10-21 18:06:47 +00005042 SmallVector<const ObjCIvarDecl*, 32> ivars;
5043
5044 // GC layout strings include the complete object layout, possibly
5045 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
5046 // up.
5047 //
5048 // ARC layout strings only include the class's ivars. In non-fragile
John McCallf5ea0722015-10-29 23:36:14 +00005049 // runtimes, that means starting at InstanceStart, rounded up to word
5050 // alignment. In fragile runtimes, there's no InstanceStart, so it means
John McCalld80218f2015-11-19 02:27:55 +00005051 // starting at the offset of the first ivar, rounded up to word alignment.
John McCall460ce582015-10-22 18:38:17 +00005052 //
5053 // MRC weak layout strings follow the ARC style.
John McCall3fd13f062015-10-21 18:06:47 +00005054 CharUnits baseOffset;
John McCall460ce582015-10-22 18:38:17 +00005055 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Jordy Rosea91768e2011-07-22 02:08:32 +00005056 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005057 IVD; IVD = IVD->getNextIvar())
John McCall3fd13f062015-10-21 18:06:47 +00005058 ivars.push_back(IVD);
5059
5060 if (isNonFragileABI()) {
5061 baseOffset = beginOffset; // InstanceStart
John McCalld80218f2015-11-19 02:27:55 +00005062 } else if (!ivars.empty()) {
5063 baseOffset =
5064 CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivars[0]));
John McCall3fd13f062015-10-21 18:06:47 +00005065 } else {
5066 baseOffset = CharUnits::Zero();
5067 }
John McCallf5ea0722015-10-29 23:36:14 +00005068
Rui Ueyama83aa9792016-01-14 21:00:27 +00005069 baseOffset = baseOffset.alignTo(CGM.getPointerAlign());
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005070 }
5071 else {
John McCall3fd13f062015-10-21 18:06:47 +00005072 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005073
John McCall3fd13f062015-10-21 18:06:47 +00005074 baseOffset = CharUnits::Zero();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005075 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005076
John McCall3fd13f062015-10-21 18:06:47 +00005077 if (ivars.empty())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005078 return llvm::Constant::getNullValue(PtrTy);
5079
John McCall3fd13f062015-10-21 18:06:47 +00005080 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005081
John McCall3fd13f062015-10-21 18:06:47 +00005082 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
5083 [&](const ObjCIvarDecl *ivar) -> CharUnits {
5084 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
5085 });
5086
5087 if (!builder.hasBitmapData())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005088 return llvm::Constant::getNullValue(PtrTy);
John McCall3fd13f062015-10-21 18:06:47 +00005089
5090 llvm::SmallVector<unsigned char, 4> buffer;
5091 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005092
John McCallf5ea0722015-10-29 23:36:14 +00005093 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005094 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005095 ForStrongLayout ? "strong" : "weak",
Ben Langmuire013bdc2014-07-11 00:43:47 +00005096 OMD->getClassInterface()->getName().str().c_str());
John McCall3fd13f062015-10-21 18:06:47 +00005097 builder.dump(buffer);
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005098 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005099 return C;
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00005100}
5101
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005102llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005103 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
Chris Lattner3def9ae2012-02-06 22:16:34 +00005104 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005105 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005106 Entry = CreateCStringLiteral(Sel.getAsString(), ObjCLabelType::MethodVarName);
Owen Anderson170229f2009-07-14 23:10:40 +00005107 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005108}
5109
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005110// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005111llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005112 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
5113}
5114
Daniel Dunbarf5c18462009-04-20 06:54:31 +00005115llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005116 std::string TypeStr;
5117 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
5118
5119 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005120 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005121 Entry = CreateCStringLiteral(TypeStr, ObjCLabelType::MethodVarType);
Owen Anderson170229f2009-07-14 23:10:40 +00005122 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005123}
5124
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005125llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
5126 bool Extended) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005127 std::string TypeStr;
Bill Wendlinge22bef72012-02-09 22:45:21 +00005128 if (CGM.getContext().getObjCEncodingForMethodDecl(D, TypeStr, Extended))
Craig Topper8a13c412014-05-21 05:09:00 +00005129 return nullptr;
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005130
5131 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbar3241fae2009-04-14 23:14:47 +00005132 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005133 Entry = CreateCStringLiteral(TypeStr, ObjCLabelType::MethodVarType);
Owen Anderson170229f2009-07-14 23:10:40 +00005134 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005135}
5136
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005137// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005138llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005139 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005140 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005141 Entry = CreateCStringLiteral(Ident->getName(), ObjCLabelType::PropertyName);
Owen Anderson170229f2009-07-14 23:10:40 +00005142 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005143}
5144
5145// FIXME: Merge into a single cstring creation function.
Daniel Dunbar4932b362008-08-28 04:38:10 +00005146// FIXME: This Decl should be more precise.
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005147llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005148CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
5149 const Decl *Container) {
Daniel Dunbar4932b362008-08-28 04:38:10 +00005150 std::string TypeStr;
5151 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container, TypeStr);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005152 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
5153}
5154
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005155void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005156 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005157 SmallVectorImpl<char> &Name) {
Daniel Dunbard2386812009-10-19 01:21:19 +00005158 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00005159 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbard2386812009-10-19 01:21:19 +00005160 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
5161 << '[' << CD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005162 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbard2386812009-10-19 01:21:19 +00005163 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramer2f569922012-02-07 11:57:45 +00005164 OS << '(' << *CID << ')';
Daniel Dunbard2386812009-10-19 01:21:19 +00005165 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbara94ecd22008-08-16 03:19:19 +00005166}
5167
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005168void CGObjCMac::FinishModule() {
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005169 EmitModuleInfo();
5170
Daniel Dunbarc475d422008-10-29 22:36:39 +00005171 // Emit the dummy bodies for any protocols which were referenced but
5172 // never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005173 for (llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*>::iterator
Chris Lattnerf56501c2009-07-17 23:57:13 +00005174 I = Protocols.begin(), e = Protocols.end(); I != e; ++I) {
5175 if (I->second->hasInitializer())
Daniel Dunbarc475d422008-10-29 22:36:39 +00005176 continue;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005177
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005178 llvm::Constant *Values[5];
Owen Anderson0b75f232009-07-31 20:28:54 +00005179 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005180 Values[1] = GetClassName(I->first->getName());
Owen Anderson0b75f232009-07-31 20:28:54 +00005181 Values[2] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005182 Values[3] = Values[4] =
Owen Anderson0b75f232009-07-31 20:28:54 +00005183 llvm::Constant::getNullValue(ObjCTypes.MethodDescriptionListPtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00005184 I->second->setInitializer(llvm::ConstantStruct::get(ObjCTypes.ProtocolTy,
Daniel Dunbarc475d422008-10-29 22:36:39 +00005185 Values));
Rafael Espindola060062a2014-03-06 22:15:10 +00005186 CGM.addCompilerUsedGlobal(I->second);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005187 }
5188
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005189 // Add assembler directives to add lazy undefined symbol references
5190 // for classes which are referenced but not defined. This is
5191 // important for correct linker interaction.
Daniel Dunbard027a922009-09-07 00:20:42 +00005192 //
5193 // FIXME: It would be nice if we had an LLVM construct for this.
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005194 if ((!LazySymbols.empty() || !DefinedSymbols.empty()) &&
5195 CGM.getTriple().isOSBinFormatMachO()) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005196 SmallString<256> Asm;
Daniel Dunbard027a922009-09-07 00:20:42 +00005197 Asm += CGM.getModule().getModuleInlineAsm();
5198 if (!Asm.empty() && Asm.back() != '\n')
5199 Asm += '\n';
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005200
Daniel Dunbard027a922009-09-07 00:20:42 +00005201 llvm::raw_svector_ostream OS(Asm);
Saleem Abdulrasool39217d42016-09-16 14:24:26 +00005202 for (const auto *Sym : DefinedSymbols)
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005203 OS << "\t.objc_class_name_" << Sym->getName() << "=0\n"
5204 << "\t.globl .objc_class_name_" << Sym->getName() << "\n";
Saleem Abdulrasool39217d42016-09-16 14:24:26 +00005205 for (const auto *Sym : LazySymbols)
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005206 OS << "\t.lazy_reference .objc_class_name_" << Sym->getName() << "\n";
5207 for (const auto &Category : DefinedCategoryNames)
5208 OS << "\t.objc_category_name_" << Category << "=0\n"
5209 << "\t.globl .objc_category_name_" << Category << "\n";
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005210
Daniel Dunbard027a922009-09-07 00:20:42 +00005211 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005212 }
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005213}
5214
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005215CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00005216 : CGObjCCommonMac(cgm), ObjCTypes(cgm), ObjCEmptyCacheVar(nullptr),
5217 ObjCEmptyVtableVar(nullptr) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005218 ObjCABI = 2;
5219}
5220
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005221/* *** */
5222
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005223ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Craig Topper8a13c412014-05-21 05:09:00 +00005224 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregora95f9aa2012-01-17 23:38:32 +00005225{
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005226 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5227 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005228
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005229 ShortTy = Types.ConvertType(Ctx.ShortTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005230 IntTy = Types.ConvertType(Ctx.IntTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005231 LongTy = Types.ConvertType(Ctx.LongTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00005232 LongLongTy = Types.ConvertType(Ctx.LongLongTy);
Chris Lattnerece04092012-02-07 00:39:47 +00005233 Int8PtrTy = CGM.Int8PtrTy;
5234 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005235
Tim Northover238b5082014-03-29 13:42:40 +00005236 // arm64 targets use "int" ivar offset variables. All others,
5237 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Tim Northover40956e62014-07-23 12:32:58 +00005238 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Tim Northover238b5082014-03-29 13:42:40 +00005239 IvarOffsetVarTy = IntTy;
5240 else
5241 IvarOffsetVarTy = LongTy;
5242
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005243 ObjectPtrTy = Types.ConvertType(Ctx.getObjCIdType());
Owen Anderson9793f0e2009-07-29 22:16:19 +00005244 PtrObjectPtrTy = llvm::PointerType::getUnqual(ObjectPtrTy);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005245 SelectorPtrTy = Types.ConvertType(Ctx.getObjCSelType());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005246
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005247 // I'm not sure I like this. The implicit coordination is a bit
5248 // gross. We should solve this in a reasonable fashion because this
5249 // is a pretty common task (match some runtime data structure with
5250 // an LLVM data structure).
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005251
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005252 // FIXME: This is leaked.
5253 // FIXME: Merge with rewriter code?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005254
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005255 // struct _objc_super {
5256 // id self;
5257 // Class cls;
5258 // }
Abramo Bagnara6150c882010-05-11 21:36:43 +00005259 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005260 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005261 SourceLocation(), SourceLocation(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005262 &Ctx.Idents.get("_objc_super"));
Craig Topper8a13c412014-05-21 05:09:00 +00005263 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5264 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5265 false, ICIS_NoInit));
5266 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5267 nullptr, Ctx.getObjCClassType(), nullptr,
5268 nullptr, false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005269 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005270
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005271 SuperCTy = Ctx.getTagDeclType(RD);
5272 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005273
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005274 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005275 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5276
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005277 // struct _prop_t {
5278 // char *name;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005279 // char *attributes;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005280 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005281 PropertyTy = llvm::StructType::create("struct._prop_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005282 Int8PtrTy, Int8PtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005283
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005284 // struct _prop_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005285 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005286 // uint32_t count_of_properties;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005287 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005288 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005289 PropertyListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005290 llvm::StructType::create("struct._prop_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005291 llvm::ArrayType::get(PropertyTy, 0), nullptr);
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005292 // struct _prop_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005293 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005294
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005295 // struct _objc_method {
5296 // SEL _cmd;
5297 // char *method_type;
5298 // char *_imp;
5299 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005300 MethodTy = llvm::StructType::create("struct._objc_method",
5301 SelectorPtrTy, Int8PtrTy, Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005302 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005303
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005304 // struct _objc_cache *
Chris Lattner5ec04a52011-08-12 17:43:31 +00005305 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005306 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005307}
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005308
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005309ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005310 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005311 // struct _objc_method_description {
5312 // SEL name;
5313 // char *types;
5314 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005315 MethodDescriptionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005316 llvm::StructType::create("struct._objc_method_description",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005317 SelectorPtrTy, Int8PtrTy, nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005318
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005319 // struct _objc_method_description_list {
5320 // int count;
5321 // struct _objc_method_description[1];
5322 // }
Reid Kleckneree7cf842014-12-01 22:02:27 +00005323 MethodDescriptionListTy = llvm::StructType::create(
5324 "struct._objc_method_description_list", IntTy,
5325 llvm::ArrayType::get(MethodDescriptionTy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005326
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005327 // struct _objc_method_description_list *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005328 MethodDescriptionListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005329 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005330
Daniel Dunbarb036db82008-08-13 03:21:16 +00005331 // Protocol description structures
5332
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005333 // struct _objc_protocol_extension {
5334 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5335 // struct _objc_method_description_list *optional_instance_methods;
5336 // struct _objc_method_description_list *optional_class_methods;
5337 // struct _objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005338 // const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00005339 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005340 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005341 ProtocolExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005342 llvm::StructType::create("struct._objc_protocol_extension",
5343 IntTy, MethodDescriptionListPtrTy,
5344 MethodDescriptionListPtrTy, PropertyListPtrTy,
Manman Rence7bff52016-01-29 23:46:55 +00005345 Int8PtrPtrTy, PropertyListPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005346
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005347 // struct _objc_protocol_extension *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005348 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005349
Daniel Dunbarc475d422008-10-29 22:36:39 +00005350 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbarb036db82008-08-13 03:21:16 +00005351
Chris Lattnera5f58b02011-07-09 17:41:47 +00005352 ProtocolTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005353 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbarb036db82008-08-13 03:21:16 +00005354
Chris Lattnera5f58b02011-07-09 17:41:47 +00005355 ProtocolListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005356 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005357 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy),
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005358 LongTy,
Chris Lattnera5f58b02011-07-09 17:41:47 +00005359 llvm::ArrayType::get(ProtocolTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005360 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005361
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005362 // struct _objc_protocol {
5363 // struct _objc_protocol_extension *isa;
5364 // char *protocol_name;
5365 // struct _objc_protocol **_objc_protocol_list;
5366 // struct _objc_method_description_list *instance_methods;
5367 // struct _objc_method_description_list *class_methods;
5368 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005369 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5370 llvm::PointerType::getUnqual(ProtocolListTy),
5371 MethodDescriptionListPtrTy,
5372 MethodDescriptionListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005373 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005374
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005375 // struct _objc_protocol_list *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005376 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005377
Owen Anderson9793f0e2009-07-29 22:16:19 +00005378 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005379
5380 // Class description structures
5381
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005382 // struct _objc_ivar {
5383 // char *ivar_name;
5384 // char *ivar_type;
5385 // int ivar_offset;
5386 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005387 IvarTy = llvm::StructType::create("struct._objc_ivar",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005388 Int8PtrTy, Int8PtrTy, IntTy, nullptr);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005389
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005390 // struct _objc_ivar_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005391 IvarListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005392 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005393 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005394
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005395 // struct _objc_method_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005396 MethodListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005397 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005398 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005399
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005400 // struct _objc_class_extension *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005401 ClassExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005402 llvm::StructType::create("struct._objc_class_extension",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005403 IntTy, Int8PtrTy, PropertyListPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005404 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005405
Chris Lattner5ec04a52011-08-12 17:43:31 +00005406 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005407
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005408 // struct _objc_class {
5409 // Class isa;
5410 // Class super_class;
5411 // char *name;
5412 // long version;
5413 // long info;
5414 // long instance_size;
5415 // struct _objc_ivar_list *ivars;
5416 // struct _objc_method_list *methods;
5417 // struct _objc_cache *cache;
5418 // struct _objc_protocol_list *protocols;
5419 // char *ivar_layout;
5420 // struct _objc_class_ext *ext;
5421 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005422 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
5423 llvm::PointerType::getUnqual(ClassTy),
5424 Int8PtrTy,
5425 LongTy,
5426 LongTy,
5427 LongTy,
5428 IvarListPtrTy,
5429 MethodListPtrTy,
5430 CachePtrTy,
5431 ProtocolListPtrTy,
5432 Int8PtrTy,
5433 ClassExtensionPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005434 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005435
Owen Anderson9793f0e2009-07-29 22:16:19 +00005436 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005437
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005438 // struct _objc_category {
5439 // char *category_name;
5440 // char *class_name;
5441 // struct _objc_method_list *instance_method;
5442 // struct _objc_method_list *class_method;
Manman Renb3736772016-01-25 22:37:47 +00005443 // struct _objc_protocol_list *protocols;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005444 // uint32_t size; // sizeof(struct _objc_category)
5445 // struct _objc_property_list *instance_properties;// category's @property
Manman Ren96df0b32016-01-29 23:45:01 +00005446 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005447 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005448 CategoryTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005449 llvm::StructType::create("struct._objc_category",
5450 Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5451 MethodListPtrTy, ProtocolListPtrTy,
Manman Ren96df0b32016-01-29 23:45:01 +00005452 IntTy, PropertyListPtrTy, PropertyListPtrTy,
5453 nullptr);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005454
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005455 // Global metadata structures
5456
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005457 // struct _objc_symtab {
5458 // long sel_ref_cnt;
5459 // SEL *refs;
5460 // short cls_def_cnt;
5461 // short cat_def_cnt;
5462 // char *defs[cls_def_cnt + cat_def_cnt];
5463 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005464 SymtabTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005465 llvm::StructType::create("struct._objc_symtab",
5466 LongTy, SelectorPtrTy, ShortTy, ShortTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005467 llvm::ArrayType::get(Int8PtrTy, 0), nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005468 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005469
Fariborz Jahanianeee54df2009-01-22 00:37:21 +00005470 // struct _objc_module {
5471 // long version;
5472 // long size; // sizeof(struct _objc_module)
5473 // char *name;
5474 // struct _objc_symtab* symtab;
5475 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005476 ModuleTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005477 llvm::StructType::create("struct._objc_module",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005478 LongTy, LongTy, Int8PtrTy, SymtabPtrTy, nullptr);
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00005479
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005480
Mike Stump18bb9282009-05-16 07:57:57 +00005481 // FIXME: This is the size of the setjmp buffer and should be target
5482 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson9ff22482008-09-09 10:10:21 +00005483 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005484
Anders Carlsson9ff22482008-09-09 10:10:21 +00005485 // Exceptions
Chris Lattnerece04092012-02-07 00:39:47 +00005486 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005487
5488 ExceptionDataTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005489 llvm::StructType::create("struct._objc_exception_data",
Chris Lattnerece04092012-02-07 00:39:47 +00005490 llvm::ArrayType::get(CGM.Int32Ty,SetJmpBufferSize),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005491 StackPtrTy, nullptr);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005492}
5493
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005494ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005495 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005496 // struct _method_list_t {
5497 // uint32_t entsize; // sizeof(struct _objc_method)
5498 // uint32_t method_count;
5499 // struct _objc_method method_list[method_count];
5500 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005501 MethodListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005502 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005503 llvm::ArrayType::get(MethodTy, 0), nullptr);
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005504 // struct method_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005505 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005506
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005507 // struct _protocol_t {
5508 // id isa; // NULL
5509 // const char * const protocol_name;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005510 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005511 // const struct method_list_t * const instance_methods;
5512 // const struct method_list_t * const class_methods;
5513 // const struct method_list_t *optionalInstanceMethods;
5514 // const struct method_list_t *optionalClassMethods;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005515 // const struct _prop_list_t * properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005516 // const uint32_t size; // sizeof(struct _protocol_t)
5517 // const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005518 // const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005519 // const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00005520 // const struct _prop_list_t * class_properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005521 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005522
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005523 // Holder for struct _protocol_list_t *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005524 ProtocolListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005525 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005526
Chris Lattnera5f58b02011-07-09 17:41:47 +00005527 ProtocolnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005528 llvm::StructType::create("struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5529 llvm::PointerType::getUnqual(ProtocolListnfABITy),
5530 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5531 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005532 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy,
Manman Rence7bff52016-01-29 23:46:55 +00005533 Int8PtrTy, PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005534 nullptr);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005535
5536 // struct _protocol_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005537 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005538
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005539 // struct _protocol_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005540 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005541 // struct _protocol_t *[protocol_count];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005542 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005543 ProtocolListnfABITy->setBody(LongTy,
5544 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005545 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005546
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005547 // struct _objc_protocol_list*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005548 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005549
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005550 // struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00005551 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005552 // char *name;
5553 // char *type;
5554 // uint32_t alignment;
5555 // uint32_t size;
5556 // }
Tim Northover238b5082014-03-29 13:42:40 +00005557 IvarnfABITy = llvm::StructType::create(
5558 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005559 Int8PtrTy, Int8PtrTy, IntTy, IntTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005560
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005561 // struct _ivar_list_t {
5562 // uint32 entsize; // sizeof(struct _ivar_t)
5563 // uint32 count;
5564 // struct _iver_t list[count];
5565 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005566 IvarListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005567 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005568 llvm::ArrayType::get(IvarnfABITy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005569
Owen Anderson9793f0e2009-07-29 22:16:19 +00005570 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005571
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005572 // struct _class_ro_t {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005573 // uint32_t const flags;
5574 // uint32_t const instanceStart;
5575 // uint32_t const instanceSize;
5576 // uint32_t const reserved; // only when building for 64bit targets
5577 // const uint8_t * const ivarLayout;
5578 // const char *const name;
5579 // const struct _method_list_t * const baseMethods;
5580 // const struct _objc_protocol_list *const baseProtocols;
5581 // const struct _ivar_list_t *const ivars;
5582 // const uint8_t * const weakIvarLayout;
5583 // const struct _prop_list_t * const properties;
5584 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005585
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005586 // FIXME. Add 'reserved' field in 64bit abi mode!
Chris Lattner5ec04a52011-08-12 17:43:31 +00005587 ClassRonfABITy = llvm::StructType::create("struct._class_ro_t",
5588 IntTy, IntTy, IntTy, Int8PtrTy,
5589 Int8PtrTy, MethodListnfABIPtrTy,
5590 ProtocolListnfABIPtrTy,
5591 IvarListnfABIPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005592 Int8PtrTy, PropertyListPtrTy,
5593 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005594
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005595 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +00005596 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +00005597 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5598 ->getPointerTo();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005599
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005600 // struct _class_t {
5601 // struct _class_t *isa;
5602 // struct _class_t * const superclass;
5603 // void *cache;
5604 // IMP *vtable;
5605 // struct class_ro_t *ro;
5606 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005607
Chris Lattner5ec04a52011-08-12 17:43:31 +00005608 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005609 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
5610 llvm::PointerType::getUnqual(ClassnfABITy),
5611 CachePtrTy,
5612 llvm::PointerType::getUnqual(ImpnfABITy),
5613 llvm::PointerType::getUnqual(ClassRonfABITy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005614 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005615
Fariborz Jahanian71394042009-01-23 23:53:38 +00005616 // LLVM for struct _class_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005617 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005618
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005619 // struct _category_t {
5620 // const char * const name;
5621 // struct _class_t *const cls;
5622 // const struct _method_list_t * const instance_methods;
5623 // const struct _method_list_t * const class_methods;
5624 // const struct _protocol_list_t * const protocols;
5625 // const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00005626 // const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00005627 // const uint32_t size;
Fariborz Jahanian5a63e4c2009-01-23 17:41:22 +00005628 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005629 CategorynfABITy = llvm::StructType::create("struct._category_t",
5630 Int8PtrTy, ClassnfABIPtrTy,
5631 MethodListnfABIPtrTy,
5632 MethodListnfABIPtrTy,
5633 ProtocolListnfABIPtrTy,
5634 PropertyListPtrTy,
Manman Ren96df0b32016-01-29 23:45:01 +00005635 PropertyListPtrTy,
Manman Ren42ff3902016-02-24 17:49:50 +00005636 IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005637 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005638
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005639 // New types for nonfragile abi messaging.
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005640 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5641 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005642
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005643 // MessageRefTy - LLVM for:
5644 // struct _message_ref_t {
5645 // IMP messenger;
5646 // SEL name;
5647 // };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005648
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005649 // First the clang type for struct _message_ref_t
Abramo Bagnara6150c882010-05-11 21:36:43 +00005650 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005651 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005652 SourceLocation(), SourceLocation(),
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005653 &Ctx.Idents.get("_message_ref_t"));
Craig Topper8a13c412014-05-21 05:09:00 +00005654 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5655 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smith2b013182012-06-10 03:12:00 +00005656 ICIS_NoInit));
Craig Topper8a13c412014-05-21 05:09:00 +00005657 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5658 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5659 false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005660 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005661
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005662 MessageRefCTy = Ctx.getTagDeclType(RD);
5663 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5664 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005665
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005666 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005667 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005668
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005669 // SuperMessageRefTy - LLVM for:
5670 // struct _super_message_ref_t {
5671 // SUPER_IMP messenger;
5672 // SEL name;
5673 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005674 SuperMessageRefTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005675 llvm::StructType::create("struct._super_message_ref_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005676 ImpnfABITy, SelectorPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005677
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005678 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005679 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005680
Daniel Dunbarb1559a42009-03-01 04:46:24 +00005681
5682 // struct objc_typeinfo {
5683 // const void** vtable; // objc_ehtype_vtable + 2
5684 // const char* name; // c++ typeinfo string
5685 // Class cls;
5686 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005687 EHTypeTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005688 llvm::StructType::create("struct._objc_typeinfo",
5689 llvm::PointerType::getUnqual(Int8PtrTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005690 Int8PtrTy, ClassnfABIPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005691 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005692}
5693
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005694llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanian71394042009-01-23 23:53:38 +00005695 FinishNonFragileABIModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005696
Craig Topper8a13c412014-05-21 05:09:00 +00005697 return nullptr;
Fariborz Jahanian71394042009-01-23 23:53:38 +00005698}
5699
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00005700void CGObjCNonFragileABIMac::AddModuleClassList(
5701 ArrayRef<llvm::GlobalValue *> Container, StringRef SymbolName,
5702 StringRef SectionName) {
Daniel Dunbar19573e72009-05-15 21:48:48 +00005703 unsigned NumClasses = Container.size();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005704
Daniel Dunbar19573e72009-05-15 21:48:48 +00005705 if (!NumClasses)
5706 return;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005707
Chris Lattner3def9ae2012-02-06 22:16:34 +00005708 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005709 for (unsigned i=0; i<NumClasses; i++)
Owen Andersonade90fd2009-07-29 18:54:39 +00005710 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar19573e72009-05-15 21:48:48 +00005711 ObjCTypes.Int8PtrTy);
Chris Lattner3def9ae2012-02-06 22:16:34 +00005712 llvm::Constant *Init =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005713 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00005714 Symbols.size()),
Daniel Dunbar19573e72009-05-15 21:48:48 +00005715 Symbols);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005716
Daniel Dunbar19573e72009-05-15 21:48:48 +00005717 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00005718 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005719 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar19573e72009-05-15 21:48:48 +00005720 Init,
Owen Andersonc10c8d32009-07-08 19:05:04 +00005721 SymbolName);
Micah Villmowdd31ca12012-10-08 16:25:52 +00005722 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar19573e72009-05-15 21:48:48 +00005723 GV->setSection(SectionName);
Rafael Espindola060062a2014-03-06 22:15:10 +00005724 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005725}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005726
Fariborz Jahanian71394042009-01-23 23:53:38 +00005727void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
5728 // nonfragile abi has no module definition.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005729
Daniel Dunbar19573e72009-05-15 21:48:48 +00005730 // Build list of all implemented class addresses in array
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005731 // L_OBJC_LABEL_CLASS_$.
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005732
5733 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
5734 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5735 assert(ID);
5736 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5737 // We are implementing a weak imported interface. Give it external linkage
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005738 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005739 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005740 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
5741 }
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005742 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005743
5744 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005745 "__DATA, __objc_classlist, regular, no_dead_strip");
Rafael Espindola554256c2014-02-26 22:25:45 +00005746
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005747 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005748 "__DATA, __objc_nlclslist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005749
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005750 // Build list of all implemented category addresses in array
5751 // L_OBJC_LABEL_CATEGORY_$.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005752 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005753 "__DATA, __objc_catlist, regular, no_dead_strip");
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005754 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005755 "__DATA, __objc_nlcatlist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005756
Daniel Dunbar5e639272010-04-25 20:39:01 +00005757 EmitImageInfo();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005758}
5759
John McCall9e8bb002011-05-14 03:10:52 +00005760/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
5761/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005762/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005763/// message dispatch call for all the rest.
John McCall9e8bb002011-05-14 03:10:52 +00005764bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
5765 // At various points we've experimented with using vtable-based
5766 // dispatch for all methods.
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005767 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005768 case CodeGenOptions::Legacy:
Fariborz Jahaniandfb39832010-04-19 17:53:30 +00005769 return false;
John McCall9e8bb002011-05-14 03:10:52 +00005770 case CodeGenOptions::NonLegacy:
5771 return true;
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005772 case CodeGenOptions::Mixed:
5773 break;
5774 }
5775
5776 // If so, see whether this selector is in the white-list of things which must
5777 // use the new dispatch convention. We lazily build a dense set for this.
John McCall9e8bb002011-05-14 03:10:52 +00005778 if (VTableDispatchMethods.empty()) {
5779 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
5780 VTableDispatchMethods.insert(GetNullarySelector("class"));
5781 VTableDispatchMethods.insert(GetNullarySelector("self"));
5782 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
5783 VTableDispatchMethods.insert(GetNullarySelector("length"));
5784 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005785
John McCall9e8bb002011-05-14 03:10:52 +00005786 // These are vtable-based if GC is disabled.
5787 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005788 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall9e8bb002011-05-14 03:10:52 +00005789 VTableDispatchMethods.insert(GetNullarySelector("retain"));
5790 VTableDispatchMethods.insert(GetNullarySelector("release"));
5791 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
5792 }
5793
5794 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
5795 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
5796 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
5797 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
5798 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
5799 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
5800 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
5801
5802 // These are vtable-based if GC is enabled.
5803 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00005804 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall9e8bb002011-05-14 03:10:52 +00005805 VTableDispatchMethods.insert(GetNullarySelector("hash"));
5806 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
5807
5808 // "countByEnumeratingWithState:objects:count"
5809 IdentifierInfo *KeyIdents[] = {
5810 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
5811 &CGM.getContext().Idents.get("objects"),
5812 &CGM.getContext().Idents.get("count")
5813 };
5814 VTableDispatchMethods.insert(
5815 CGM.getContext().Selectors.getSelector(3, KeyIdents));
5816 }
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005817 }
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005818
John McCall9e8bb002011-05-14 03:10:52 +00005819 return VTableDispatchMethods.count(Sel);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005820}
5821
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005822/// BuildClassRoTInitializer - generate meta-data for:
5823/// struct _class_ro_t {
5824/// uint32_t const flags;
5825/// uint32_t const instanceStart;
5826/// uint32_t const instanceSize;
5827/// uint32_t const reserved; // only when building for 64bit targets
5828/// const uint8_t * const ivarLayout;
5829/// const char *const name;
5830/// const struct _method_list_t * const baseMethods;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005831/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005832/// const struct _ivar_list_t *const ivars;
5833/// const uint8_t * const weakIvarLayout;
5834/// const struct _prop_list_t * const properties;
5835/// }
5836///
5837llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005838 unsigned flags,
5839 unsigned InstanceStart,
5840 unsigned InstanceSize,
5841 const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005842 std::string ClassName = ID->getObjCRuntimeNameAsString();
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005843 llvm::Constant *Values[10]; // 11 for 64bit targets!
John McCall31168b02011-06-15 23:02:42 +00005844
John McCall3fd13f062015-10-21 18:06:47 +00005845 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
5846 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
5847
John McCall460ce582015-10-22 18:38:17 +00005848 bool hasMRCWeak = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005849 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallef19dbb2012-10-17 04:53:23 +00005850 flags |= NonFragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00005851 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
5852 flags |= NonFragileABI_Class_HasMRCWeakIvars;
John McCall31168b02011-06-15 23:02:42 +00005853
Owen Andersonb7a2fe62009-07-24 23:12:58 +00005854 Values[ 0] = llvm::ConstantInt::get(ObjCTypes.IntTy, flags);
5855 Values[ 1] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceStart);
5856 Values[ 2] = llvm::ConstantInt::get(ObjCTypes.IntTy, InstanceSize);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005857 // FIXME. For 64bit targets add 0 here.
John McCallef19dbb2012-10-17 04:53:23 +00005858 Values[ 3] = (flags & NonFragileABI_Class_Meta)
Craig Topper8a13c412014-05-21 05:09:00 +00005859 ? GetIvarLayoutName(nullptr, ObjCTypes)
John McCall460ce582015-10-22 18:38:17 +00005860 : BuildStrongIvarLayout(ID, beginInstance, endInstance);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005861 Values[ 4] = GetClassName(ID->getObjCRuntimeNameAsString());
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005862 // const struct _method_list_t * const baseMethods;
5863 std::vector<llvm::Constant*> Methods;
5864 std::string MethodListName("\01l_OBJC_$_");
John McCallef19dbb2012-10-17 04:53:23 +00005865 if (flags & NonFragileABI_Class_Meta) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005866 MethodListName += "CLASS_METHODS_";
5867 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005868 for (const auto *I : ID->class_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005869 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00005870 Methods.push_back(GetMethodConstant(I));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005871 } else {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005872 MethodListName += "INSTANCE_METHODS_";
5873 MethodListName += ID->getObjCRuntimeNameAsString();
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005874 for (const auto *I : ID->instance_methods())
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005875 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00005876 Methods.push_back(GetMethodConstant(I));
5877
Aaron Ballmand85eff42014-03-14 15:02:45 +00005878 for (const auto *PID : ID->property_impls()) {
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005879 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
5880 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005881
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00005882 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
5883 if (llvm::Constant *C = GetMethodConstant(MD))
5884 Methods.push_back(C);
5885 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
5886 if (llvm::Constant *C = GetMethodConstant(MD))
5887 Methods.push_back(C);
5888 }
5889 }
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00005890 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005891 Values[ 5] = EmitMethodList(MethodListName,
5892 "__DATA, __objc_const", Methods);
5893
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005894 const ObjCInterfaceDecl *OID = ID->getClassInterface();
5895 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005896 Values[ 6] = EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005897 + OID->getObjCRuntimeNameAsString(),
Ted Kremenek0ef508d2010-09-01 01:21:15 +00005898 OID->all_referenced_protocol_begin(),
5899 OID->all_referenced_protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005900
John McCallef19dbb2012-10-17 04:53:23 +00005901 if (flags & NonFragileABI_Class_Meta) {
Owen Anderson0b75f232009-07-31 20:28:54 +00005902 Values[ 7] = llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Craig Topper8a13c412014-05-21 05:09:00 +00005903 Values[ 8] = GetIvarLayoutName(nullptr, ObjCTypes);
Manman Renad0e7912016-01-29 19:22:54 +00005904 Values[ 9] = EmitPropertyList(
5905 "\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
5906 ID, ID->getClassInterface(), ObjCTypes, true);
John McCallef19dbb2012-10-17 04:53:23 +00005907 } else {
5908 Values[ 7] = EmitIvarList(ID);
John McCall460ce582015-10-22 18:38:17 +00005909 Values[ 8] = BuildWeakIvarLayout(ID, beginInstance, endInstance,
5910 hasMRCWeak);
Manman Renad0e7912016-01-29 19:22:54 +00005911 Values[ 9] = EmitPropertyList(
5912 "\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
5913 ID, ID->getClassInterface(), ObjCTypes, false);
John McCallef19dbb2012-10-17 04:53:23 +00005914 }
Owen Anderson0e0189d2009-07-27 22:29:56 +00005915 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassRonfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005916 Values);
5917 llvm::GlobalVariable *CLASS_RO_GV =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005918 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassRonfABITy, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005919 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005920 Init,
John McCallef19dbb2012-10-17 04:53:23 +00005921 (flags & NonFragileABI_Class_Meta) ?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005922 std::string("\01l_OBJC_METACLASS_RO_$_")+ClassName :
5923 std::string("\01l_OBJC_CLASS_RO_$_")+ClassName);
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005924 CLASS_RO_GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005925 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassRonfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00005926 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005927 return CLASS_RO_GV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00005928
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005929}
5930
5931/// BuildClassMetaData - This routine defines that to-level meta-data
5932/// for the given ClassName for:
5933/// struct _class_t {
5934/// struct _class_t *isa;
5935/// struct _class_t * const superclass;
5936/// void *cache;
5937/// IMP *vtable;
5938/// struct class_ro_t *ro;
5939/// }
5940///
Rafael Espindola554256c2014-02-26 22:25:45 +00005941llvm::GlobalVariable *CGObjCNonFragileABIMac::BuildClassMetaData(
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005942 const std::string &ClassName, llvm::Constant *IsAGV, llvm::Constant *SuperClassGV,
Rafael Espindola554256c2014-02-26 22:25:45 +00005943 llvm::Constant *ClassRoGV, bool HiddenVisibility, bool Weak) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00005944 llvm::Constant *Values[] = {
5945 IsAGV,
5946 SuperClassGV,
5947 ObjCEmptyCacheVar, // &ObjCEmptyCacheVar
5948 ObjCEmptyVtableVar, // &ObjCEmptyVtableVar
5949 ClassRoGV // &CLASS_RO_GV
5950 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005951 if (!Values[1])
5952 Values[1] = llvm::Constant::getNullValue(ObjCTypes.ClassnfABIPtrTy);
Fariborz Jahanian42d49552013-10-24 17:40:28 +00005953 if (!Values[3])
5954 Values[3] = llvm::Constant::getNullValue(
5955 llvm::PointerType::getUnqual(ObjCTypes.ImpnfABITy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005956 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ClassnfABITy,
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005957 Values);
Rafael Espindola554256c2014-02-26 22:25:45 +00005958 llvm::GlobalVariable *GV = GetClassGlobal(ClassName, Weak);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00005959 GV->setInitializer(Init);
Fariborz Jahanian04087232009-01-31 01:07:39 +00005960 GV->setSection("__DATA, __objc_data");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00005961 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00005962 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00005963 if (!CGM.getTriple().isOSBinFormatCOFF())
5964 if (HiddenVisibility)
5965 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00005966 return GV;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00005967}
5968
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005969bool
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00005970CGObjCNonFragileABIMac::ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
Craig Topper8a13c412014-05-21 05:09:00 +00005971 return OD->getClassMethod(GetNullarySelector("load")) != nullptr;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005972}
5973
Daniel Dunbar961202372009-05-03 12:57:56 +00005974void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00005975 uint32_t &InstanceStart,
5976 uint32_t &InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005977 const ASTRecordLayout &RL =
Daniel Dunbar9252ee12009-05-04 21:26:30 +00005978 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005979
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005980 // InstanceSize is really instance end.
Ken Dyckd5090c12011-02-11 02:20:09 +00005981 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar9b042e02009-05-04 23:23:09 +00005982
5983 // If there are no fields, the start is the same as the end.
5984 if (!RL.getFieldCount())
5985 InstanceStart = InstanceSize;
5986 else
Ken Dyckc5ca8762011-04-14 00:43:09 +00005987 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbar554fd792009-04-19 23:41:48 +00005988}
5989
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00005990static llvm::GlobalValue::DLLStorageClassTypes getStorage(CodeGenModule &CGM,
5991 StringRef Name) {
5992 IdentifierInfo &II = CGM.getContext().Idents.get(Name);
5993 TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
5994 DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
5995
5996 const VarDecl *VD = nullptr;
5997 for (const auto &Result : DC->lookup(&II))
5998 if ((VD = dyn_cast<VarDecl>(Result)))
5999 break;
6000
6001 if (!VD)
6002 return llvm::GlobalValue::DLLImportStorageClass;
6003 if (VD->hasAttr<DLLExportAttr>())
6004 return llvm::GlobalValue::DLLExportStorageClass;
6005 if (VD->hasAttr<DLLImportAttr>())
6006 return llvm::GlobalValue::DLLImportStorageClass;
6007 return llvm::GlobalValue::DefaultStorageClass;
6008}
6009
Fariborz Jahanian71394042009-01-23 23:53:38 +00006010void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Fariborz Jahanian71394042009-01-23 23:53:38 +00006011 if (!ObjCEmptyCacheVar) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006012 ObjCEmptyCacheVar =
6013 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CacheTy, false,
6014 llvm::GlobalValue::ExternalLinkage, nullptr,
6015 "_objc_empty_cache");
6016 if (CGM.getTriple().isOSBinFormatCOFF())
6017 ObjCEmptyCacheVar->setDLLStorageClass(getStorage(CGM, "_objc_empty_cache"));
Craig Topper8a13c412014-05-21 05:09:00 +00006018
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00006019 // Only OS X with deployment version <10.9 use the empty vtable symbol
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006020 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00006021 if (Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 9))
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006022 ObjCEmptyVtableVar =
6023 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ImpnfABITy, false,
6024 llvm::GlobalValue::ExternalLinkage, nullptr,
6025 "_objc_empty_vtable");
Fariborz Jahanian71394042009-01-23 23:53:38 +00006026 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006027
Daniel Dunbare3f5cfc2009-04-20 20:18:54 +00006028 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006029 uint32_t InstanceStart =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006030 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006031 uint32_t InstanceSize = InstanceStart;
John McCallef19dbb2012-10-17 04:53:23 +00006032 uint32_t flags = NonFragileABI_Class_Meta;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006033
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006034 llvm::GlobalVariable *SuperClassGV, *IsAGV;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006035
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006036 StringRef ClassName = ID->getObjCRuntimeNameAsString();
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006037 const auto *CI = ID->getClassInterface();
6038 assert(CI && "CGObjCNonFragileABIMac::GenerateClass - class is 0");
6039
John McCall0d54a172012-10-17 04:53:31 +00006040 // Build the flags for the metaclass.
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006041 bool classIsHidden = (CGM.getTriple().isOSBinFormatCOFF())
6042 ? !CI->hasAttr<DLLExportAttr>()
6043 : CI->getVisibility() == HiddenVisibility;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006044 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006045 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006046
6047 // FIXME: why is this flag set on the metaclass?
6048 // ObjC metaclasses have no fields and don't really get constructed.
6049 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006050 flags |= NonFragileABI_Class_HasCXXStructors;
John McCall0d54a172012-10-17 04:53:31 +00006051 if (!ID->hasNonZeroConstructors())
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006052 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
John McCall0d54a172012-10-17 04:53:31 +00006053 }
6054
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006055 if (!CI->getSuperClass()) {
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006056 // class is root
John McCallef19dbb2012-10-17 04:53:23 +00006057 flags |= NonFragileABI_Class_Root;
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006058
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006059 SuperClassGV = GetClassGlobal((getClassSymbolPrefix() + ClassName).str(),
6060 CI->isWeakImported());
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006061 if (CGM.getTriple().isOSBinFormatCOFF())
6062 if (CI->hasAttr<DLLImportAttr>())
6063 SuperClassGV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006064
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006065 IsAGV = GetClassGlobal((getMetaclassSymbolPrefix() + ClassName).str(),
6066 CI->isWeakImported());
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006067 if (CGM.getTriple().isOSBinFormatCOFF())
6068 if (CI->hasAttr<DLLImportAttr>())
6069 IsAGV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006070 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006071 // Has a root. Current class is not a root.
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00006072 const ObjCInterfaceDecl *Root = ID->getClassInterface();
6073 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
6074 Root = Super;
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006075
6076 const auto *Super = CI->getSuperClass();
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006077 StringRef RootClassName = Root->getObjCRuntimeNameAsString();
6078 StringRef SuperClassName = Super->getObjCRuntimeNameAsString();
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006079
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006080 IsAGV = GetClassGlobal((getMetaclassSymbolPrefix() + RootClassName).str(),
6081 Root->isWeakImported());
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006082 if (CGM.getTriple().isOSBinFormatCOFF())
6083 if (Root->hasAttr<DLLImportAttr>())
6084 IsAGV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006085
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00006086 // work on super class metadata symbol.
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006087 SuperClassGV =
6088 GetClassGlobal((getMetaclassSymbolPrefix() + SuperClassName).str(),
6089 Super->isWeakImported());
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006090 if (CGM.getTriple().isOSBinFormatCOFF())
6091 if (Super->hasAttr<DLLImportAttr>())
6092 SuperClassGV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006093 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006094
6095 llvm::GlobalVariable *CLASS_RO_GV =
6096 BuildClassRoTInitializer(flags, InstanceStart, InstanceSize, ID);
6097
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006098 llvm::GlobalVariable *MetaTClass =
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006099 BuildClassMetaData((getMetaclassSymbolPrefix() + ClassName).str(), IsAGV,
6100 SuperClassGV, CLASS_RO_GV, classIsHidden,
6101 CI->isWeakImported());
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006102 if (CGM.getTriple().isOSBinFormatCOFF())
6103 if (CI->hasAttr<DLLExportAttr>())
6104 MetaTClass->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
Fariborz Jahanian67260552009-11-17 21:37:35 +00006105 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar15894b72009-04-07 05:48:37 +00006106
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006107 // Metadata for the class
John McCallef19dbb2012-10-17 04:53:23 +00006108 flags = 0;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006109 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006110 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006111
6112 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006113 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006114
John McCall0d54a172012-10-17 04:53:31 +00006115 // Set a flag to enable a runtime optimization when a class has
6116 // fields that require destruction but which don't require
6117 // anything except zero-initialization during construction. This
6118 // is most notably true of __strong and __weak types, but you can
6119 // also imagine there being C++ types with non-trivial default
6120 // constructors that merely set all fields to null.
6121 if (!ID->hasNonZeroConstructors())
6122 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6123 }
6124
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006125 if (hasObjCExceptionAttribute(CGM.getContext(), CI))
John McCallef19dbb2012-10-17 04:53:23 +00006126 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006127
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006128 if (!CI->getSuperClass()) {
John McCallef19dbb2012-10-17 04:53:23 +00006129 flags |= NonFragileABI_Class_Root;
Craig Topper8a13c412014-05-21 05:09:00 +00006130 SuperClassGV = nullptr;
Chris Lattnerb433b272009-04-19 06:02:28 +00006131 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006132 // Has a root. Current class is not a root.
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006133 const auto *Super = CI->getSuperClass();
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006134 StringRef SuperClassName = Super->getObjCRuntimeNameAsString();
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006135
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006136 SuperClassGV =
6137 GetClassGlobal((getClassSymbolPrefix() + SuperClassName).str(),
6138 Super->isWeakImported());
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006139 if (CGM.getTriple().isOSBinFormatCOFF())
6140 if (Super->hasAttr<DLLImportAttr>())
6141 SuperClassGV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006142 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006143
Daniel Dunbar961202372009-05-03 12:57:56 +00006144 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006145 CLASS_RO_GV =
6146 BuildClassRoTInitializer(flags, InstanceStart, InstanceSize, ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006147
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006148 llvm::GlobalVariable *ClassMD =
Saleem Abdulrasool10fd1ff2016-07-16 22:42:06 +00006149 BuildClassMetaData((getClassSymbolPrefix() + ClassName).str(), MetaTClass,
6150 SuperClassGV, CLASS_RO_GV, classIsHidden,
6151 CI->isWeakImported());
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006152 if (CGM.getTriple().isOSBinFormatCOFF())
6153 if (CI->hasAttr<DLLExportAttr>())
6154 ClassMD->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006155 DefinedClasses.push_back(ClassMD);
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006156 ImplementedClasses.push_back(CI);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006157
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006158 // Determine if this class is also "non-lazy".
6159 if (ImplementationIsNonLazy(ID))
6160 DefinedNonLazyClasses.push_back(ClassMD);
6161
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006162 // Force the definition of the EHType if necessary.
John McCallef19dbb2012-10-17 04:53:23 +00006163 if (flags & NonFragileABI_Class_Exception)
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006164 GetInterfaceEHType(CI, true);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006165 // Make sure method definition entries are all clear for next implementation.
6166 MethodDefinitions.clear();
Fariborz Jahanian71394042009-01-23 23:53:38 +00006167}
6168
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006169/// GenerateProtocolRef - This routine is called to generate code for
6170/// a protocol reference expression; as in:
6171/// @code
6172/// @protocol(Proto1);
6173/// @endcode
6174/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
6175/// which will hold address of the protocol meta-data.
6176///
John McCall882987f2013-02-28 19:01:20 +00006177llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006178 const ObjCProtocolDecl *PD) {
6179
Fariborz Jahanian464423d2009-04-10 18:47:34 +00006180 // This routine is called for @protocol only. So, we must build definition
6181 // of protocol's meta-data (not a reference to it!)
6182 //
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006183 llvm::Constant *Init =
6184 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00006185 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006186
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006187 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006188 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006189
John McCall7f416cc2015-09-08 08:05:57 +00006190 CharUnits Align = CGF.getPointerAlign();
6191
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006192 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
6193 if (PTGV)
John McCall7f416cc2015-09-08 08:05:57 +00006194 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006195 PTGV = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006196 CGM.getModule(),
6197 Init->getType(), false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006198 llvm::GlobalValue::WeakAnyLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006199 Init,
6200 ProtocolName);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006201 PTGV->setSection("__DATA, __objc_protorefs, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006202 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall7f416cc2015-09-08 08:05:57 +00006203 PTGV->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00006204 CGM.addCompilerUsedGlobal(PTGV);
John McCall7f416cc2015-09-08 08:05:57 +00006205 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006206}
6207
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006208/// GenerateCategory - Build metadata for a category implementation.
6209/// struct _category_t {
6210/// const char * const name;
6211/// struct _class_t *const cls;
6212/// const struct _method_list_t * const instance_methods;
6213/// const struct _method_list_t * const class_methods;
6214/// const struct _protocol_list_t * const protocols;
6215/// const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00006216/// const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00006217/// const uint32_t size;
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006218/// }
6219///
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006220void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006221 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006222 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006223
6224 llvm::SmallString<64> ExtCatName(Prefix);
6225 ExtCatName += Interface->getObjCRuntimeNameAsString();
6226 ExtCatName += "_$_";
6227 ExtCatName += OCD->getNameAsString();
6228
6229 llvm::SmallString<64> ExtClassName(getClassSymbolPrefix());
6230 ExtClassName += Interface->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006231
Manman Ren42ff3902016-02-24 17:49:50 +00006232 llvm::Constant *Values[8];
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006233 Values[0] = GetClassName(OCD->getIdentifier()->getName());
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006234 // meta-class entry symbol
Rafael Espindola554256c2014-02-26 22:25:45 +00006235 llvm::GlobalVariable *ClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006236 GetClassGlobal(ExtClassName.str(), Interface->isWeakImported());
Rafael Espindola554256c2014-02-26 22:25:45 +00006237
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006238 Values[1] = ClassGV;
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006239 std::vector<llvm::Constant*> Methods;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006240 llvm::SmallString<64> MethodListName(Prefix);
6241
6242 MethodListName += "INSTANCE_METHODS_";
6243 MethodListName += Interface->getObjCRuntimeNameAsString();
6244 MethodListName += "_$_";
6245 MethodListName += OCD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006246
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006247 for (const auto *I : OCD->instance_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006248 // Instance methods should always be defined.
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006249 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006250
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006251 Values[2] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006252 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006253 Methods);
6254
6255 MethodListName = Prefix;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006256 MethodListName += "CLASS_METHODS_";
6257 MethodListName += Interface->getObjCRuntimeNameAsString();
6258 MethodListName += "_$_";
6259 MethodListName += OCD->getNameAsString();
6260
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006261 Methods.clear();
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006262 for (const auto *I : OCD->class_methods())
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006263 // Class methods should always be defined.
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006264 Methods.push_back(GetMethodConstant(I));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006265
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006266 Values[3] = EmitMethodList(MethodListName.str(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006267 "__DATA, __objc_const",
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006268 Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006269 const ObjCCategoryDecl *Category =
Fariborz Jahanian066347e2009-01-28 22:18:42 +00006270 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006271 if (Category) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006272 SmallString<256> ExtName;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006273 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006274 << OCD->getName();
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006275 Values[4] = EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006276 + Interface->getObjCRuntimeNameAsString() + "_$_"
6277 + Category->getName(),
6278 Category->protocol_begin(),
6279 Category->protocol_end());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006280 Values[5] = EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
Manman Renad0e7912016-01-29 19:22:54 +00006281 OCD, Category, ObjCTypes, false);
Manman Ren96df0b32016-01-29 23:45:01 +00006282 Values[6] = EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
6283 OCD, Category, ObjCTypes, true);
Mike Stump658fe022009-07-30 22:28:39 +00006284 } else {
Owen Anderson0b75f232009-07-31 20:28:54 +00006285 Values[4] = llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
6286 Values[5] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Manman Ren96df0b32016-01-29 23:45:01 +00006287 Values[6] = llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006288 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006289
Manman Ren42ff3902016-02-24 17:49:50 +00006290 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategorynfABITy);
6291 Values[7] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6292
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006293 llvm::Constant *Init =
6294 llvm::ConstantStruct::get(ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006295 Values);
6296 llvm::GlobalVariable *GCATV
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006297 = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CategorynfABITy,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006298 false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006299 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006300 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006301 ExtCatName.str());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006302 GCATV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006303 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.CategorynfABITy));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006304 GCATV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006305 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006306 DefinedCategories.push_back(GCATV);
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006307
6308 // Determine if this category is also "non-lazy".
6309 if (ImplementationIsNonLazy(OCD))
6310 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006311 // method definition entries must be clear for next implementation.
6312 MethodDefinitions.clear();
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006313}
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006314
6315/// GetMethodConstant - Return a struct objc_method constant for the
6316/// given method if it has been defined. The result is null if the
6317/// method has not been defined. The return value has type MethodPtrTy.
6318llvm::Constant *CGObjCNonFragileABIMac::GetMethodConstant(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006319 const ObjCMethodDecl *MD) {
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00006320 llvm::Function *Fn = GetMethodDefinition(MD);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006321 if (!Fn)
Craig Topper8a13c412014-05-21 05:09:00 +00006322 return nullptr;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006323
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006324 llvm::Constant *Method[] = {
Owen Andersonade90fd2009-07-29 18:54:39 +00006325 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006326 ObjCTypes.SelectorPtrTy),
6327 GetMethodVarType(MD),
6328 llvm::ConstantExpr::getBitCast(Fn, ObjCTypes.Int8PtrTy)
6329 };
Owen Anderson0e0189d2009-07-27 22:29:56 +00006330 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Method);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006331}
6332
6333/// EmitMethodList - Build meta-data for method declarations
6334/// struct _method_list_t {
6335/// uint32_t entsize; // sizeof(struct _objc_method)
6336/// uint32_t method_count;
6337/// struct _objc_method method_list[method_count];
6338/// }
6339///
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00006340llvm::Constant *
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00006341CGObjCNonFragileABIMac::EmitMethodList(Twine Name, StringRef Section,
6342 ArrayRef<llvm::Constant *> Methods) {
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006343 // Return null for empty list.
6344 if (Methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006345 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006346
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006347 llvm::Constant *Values[3];
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006348 // sizeof(struct _objc_method)
Micah Villmowdd31ca12012-10-08 16:25:52 +00006349 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006350 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006351 // method_count
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006352 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Methods.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006353 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.MethodTy,
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006354 Methods.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006355 Values[2] = llvm::ConstantArray::get(AT, Methods);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006356 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006357
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006358 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006359 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006360 llvm::GlobalValue::PrivateLinkage, Init, Name);
Micah Villmowdd31ca12012-10-08 16:25:52 +00006361 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006362 GV->setSection(Section);
Rafael Espindola060062a2014-03-06 22:15:10 +00006363 CGM.addCompilerUsedGlobal(GV);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006364 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006365}
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006366
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006367/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6368/// the given ivar.
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006369llvm::GlobalVariable *
6370CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6371 const ObjCIvarDecl *Ivar) {
6372 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006373 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6374 Name += Container->getObjCRuntimeNameAsString();
6375 Name += ".";
6376 Name += Ivar->getName();
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006377 llvm::GlobalVariable *IvarOffsetGV = CGM.getModule().getGlobalVariable(Name);
6378 if (!IvarOffsetGV) {
6379 IvarOffsetGV =
6380 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.IvarOffsetVarTy,
6381 false, llvm::GlobalValue::ExternalLinkage,
6382 nullptr, Name.str());
6383 if (CGM.getTriple().isOSBinFormatCOFF()) {
6384 bool IsPrivateOrPackage =
6385 Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6386 Ivar->getAccessControl() == ObjCIvarDecl::Package;
6387
6388 if (ID->hasAttr<DLLExportAttr>() && !IsPrivateOrPackage)
6389 IvarOffsetGV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
6390 else if (ID->hasAttr<DLLImportAttr>())
6391 IvarOffsetGV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
6392 }
6393 }
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006394 return IvarOffsetGV;
6395}
6396
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006397llvm::Constant *
6398CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6399 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00006400 unsigned long int Offset) {
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006401 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Tim Northover238b5082014-03-29 13:42:40 +00006402 IvarOffsetGV->setInitializer(
6403 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006404 IvarOffsetGV->setAlignment(
Tim Northover238b5082014-03-29 13:42:40 +00006405 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006406
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006407 if (!CGM.getTriple().isOSBinFormatCOFF()) {
6408 // FIXME: This matches gcc, but shouldn't the visibility be set on the use
6409 // as well (i.e., in ObjCIvarOffsetVariable).
6410 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6411 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
6412 ID->getVisibility() == HiddenVisibility)
6413 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
6414 else
6415 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
6416 }
6417
Bill Wendlingf7d45982011-05-04 21:37:25 +00006418 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006419 return IvarOffsetGV;
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006420}
6421
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006422/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006423/// implementation. The return value has type
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006424/// IvarListnfABIPtrTy.
6425/// struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00006426/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006427/// char *name;
6428/// char *type;
6429/// uint32_t alignment;
6430/// uint32_t size;
6431/// }
6432/// struct _ivar_list_t {
6433/// uint32 entsize; // sizeof(struct _ivar_t)
6434/// uint32 count;
6435/// struct _iver_t list[count];
6436/// }
6437///
Daniel Dunbarf5c18462009-04-20 06:54:31 +00006438
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006439llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006440 const ObjCImplementationDecl *ID) {
6441
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006442 std::vector<llvm::Constant*> Ivars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006443
Jordy Rosea91768e2011-07-22 02:08:32 +00006444 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006445 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006446
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006447 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006448
Jordy Rosea91768e2011-07-22 02:08:32 +00006449 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00006450 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00006451 // Ignore unnamed bit-fields.
6452 if (!IVD->getDeclName())
6453 continue;
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006454 llvm::Constant *Ivar[5];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006455 Ivar[0] = EmitIvarOffsetVar(ID->getClassInterface(), IVD,
Daniel Dunbar961202372009-05-03 12:57:56 +00006456 ComputeIvarBaseOffset(CGM, ID, IVD));
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006457 Ivar[1] = GetMethodVarName(IVD->getIdentifier());
6458 Ivar[2] = GetMethodVarType(IVD);
Chris Lattner2192fe52011-07-18 04:24:23 +00006459 llvm::Type *FieldTy =
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006460 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmowdd31ca12012-10-08 16:25:52 +00006461 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006462 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006463 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006464 Align = llvm::Log2_32(Align);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006465 Ivar[3] = llvm::ConstantInt::get(ObjCTypes.IntTy, Align);
Daniel Dunbarae032262009-04-20 00:33:43 +00006466 // NOTE. Size of a bitfield does not match gcc's, because of the
6467 // way bitfields are treated special in each. But I am told that
6468 // 'size' for bitfield ivars is ignored by the runtime so it does
6469 // not matter. If it matters, there is enough info to get the
6470 // bitfield right!
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006471 Ivar[4] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006472 Ivars.push_back(llvm::ConstantStruct::get(ObjCTypes.IvarnfABITy, Ivar));
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006473 }
6474 // Return null for empty list.
6475 if (Ivars.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006476 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006477
6478 llvm::Constant *Values[3];
Micah Villmowdd31ca12012-10-08 16:25:52 +00006479 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006480 Values[0] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
6481 Values[1] = llvm::ConstantInt::get(ObjCTypes.IntTy, Ivars.size());
Owen Anderson9793f0e2009-07-29 22:16:19 +00006482 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.IvarnfABITy,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006483 Ivars.size());
Owen Anderson47034e12009-07-28 18:33:04 +00006484 Values[2] = llvm::ConstantArray::get(AT, Ivars);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006485 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006486 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6487 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006488 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006489 llvm::GlobalValue::PrivateLinkage,
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006490 Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006491 Prefix + OID->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006492 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006493 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006494 GV->setSection("__DATA, __objc_const");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006495
Rafael Espindola060062a2014-03-06 22:15:10 +00006496 CGM.addCompilerUsedGlobal(GV);
Owen Andersonade90fd2009-07-29 18:54:39 +00006497 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006498}
6499
6500llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006501 const ObjCProtocolDecl *PD) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006502 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006503
Akira Hatanaka7f550f32016-02-11 06:36:35 +00006504 if (!Entry)
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006505 // We use the initializer as a marker of whether this is a forward
6506 // reference or not. At module finalization we add the empty
6507 // contents for protocols which were referenced but never defined.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006508 Entry =
Rafael Espindola5d117f32014-03-06 01:10:46 +00006509 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola24615092014-09-12 20:14:20 +00006510 false, llvm::GlobalValue::ExternalLinkage,
Craig Topper8a13c412014-05-21 05:09:00 +00006511 nullptr,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006512 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006513
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006514 return Entry;
6515}
6516
6517/// GetOrEmitProtocol - Generate the protocol meta-data:
6518/// @code
6519/// struct _protocol_t {
6520/// id isa; // NULL
6521/// const char * const protocol_name;
6522/// const struct _protocol_list_t * protocol_list; // super protocols
6523/// const struct method_list_t * const instance_methods;
6524/// const struct method_list_t * const class_methods;
6525/// const struct method_list_t *optionalInstanceMethods;
6526/// const struct method_list_t *optionalClassMethods;
6527/// const struct _prop_list_t * properties;
6528/// const uint32_t size; // sizeof(struct _protocol_t)
6529/// const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006530/// const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006531/// const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00006532/// const struct _prop_list_t * class_properties;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006533/// }
6534/// @endcode
6535///
6536
6537llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006538 const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00006539 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006540
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006541 // Early exit if a defining object has already been generated.
6542 if (Entry && Entry->hasInitializer())
6543 return Entry;
6544
Douglas Gregora715bff2012-01-01 19:51:50 +00006545 // Use the protocol definition, if there is one.
6546 if (const ObjCProtocolDecl *Def = PD->getDefinition())
6547 PD = Def;
6548
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006549 // Construct method lists.
6550 std::vector<llvm::Constant*> InstanceMethods, ClassMethods;
6551 std::vector<llvm::Constant*> OptInstanceMethods, OptClassMethods;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006552 std::vector<llvm::Constant*> MethodTypesExt, OptMethodTypesExt;
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006553 for (const auto *MD : PD->instance_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006554 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006555 if (!C)
6556 return GetOrEmitProtocolRef(PD);
6557
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006558 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6559 OptInstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006560 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006561 } else {
6562 InstanceMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006563 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006564 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006565 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006566
Aaron Ballmane8a7dc92014-03-13 20:11:06 +00006567 for (const auto *MD : PD->class_methods()) {
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006568 llvm::Constant *C = GetMethodDescriptionConstant(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006569 if (!C)
6570 return GetOrEmitProtocolRef(PD);
6571
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006572 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) {
6573 OptClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006574 OptMethodTypesExt.push_back(GetMethodVarType(MD, true));
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006575 } else {
6576 ClassMethods.push_back(C);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006577 MethodTypesExt.push_back(GetMethodVarType(MD, true));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006578 }
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006579 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006580
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006581 MethodTypesExt.insert(MethodTypesExt.end(),
6582 OptMethodTypesExt.begin(), OptMethodTypesExt.end());
6583
Manman Rence7bff52016-01-29 23:46:55 +00006584 llvm::Constant *Values[13];
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006585 // isa is NULL
Owen Anderson0b75f232009-07-31 20:28:54 +00006586 Values[0] = llvm::Constant::getNullValue(ObjCTypes.ObjectPtrTy);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006587 Values[1] = GetClassName(PD->getObjCRuntimeNameAsString());
6588 Values[2] = EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_" + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006589 PD->protocol_begin(),
6590 PD->protocol_end());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006591
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006592 Values[3] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006593 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006594 "__DATA, __objc_const",
6595 InstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006596 Values[4] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006597 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006598 "__DATA, __objc_const",
6599 ClassMethods);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006600 Values[5] = EmitMethodList("\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006601 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006602 "__DATA, __objc_const",
6603 OptInstanceMethods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006604 Values[6] = EmitMethodList("\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006605 + PD->getObjCRuntimeNameAsString(),
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006606 "__DATA, __objc_const",
6607 OptClassMethods);
Manman Renad0e7912016-01-29 19:22:54 +00006608 Values[7] = EmitPropertyList(
6609 "\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6610 nullptr, PD, ObjCTypes, false);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006611 uint32_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006612 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006613 Values[8] = llvm::ConstantInt::get(ObjCTypes.IntTy, Size);
Owen Anderson0b75f232009-07-31 20:28:54 +00006614 Values[9] = llvm::Constant::getNullValue(ObjCTypes.IntTy);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006615 Values[10] = EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006616 + PD->getObjCRuntimeNameAsString(),
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006617 MethodTypesExt, ObjCTypes);
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006618 // const char *demangledName;
6619 Values[11] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Manman Rence7bff52016-01-29 23:46:55 +00006620
6621 Values[12] = EmitPropertyList(
6622 "\01l_OBJC_$_CLASS_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6623 nullptr, PD, ObjCTypes, true);
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006624
Owen Anderson0e0189d2009-07-27 22:29:56 +00006625 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.ProtocolnfABITy,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006626 Values);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006627
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006628 if (Entry) {
Rafael Espindola24615092014-09-12 20:14:20 +00006629 // Already created, fix the linkage and update the initializer.
6630 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006631 Entry->setInitializer(Init);
6632 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006633 Entry =
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006634 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006635 false, llvm::GlobalValue::WeakAnyLinkage, Init,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006636 "\01l_OBJC_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006637 Entry->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006638 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABITy));
John McCallf9582a72012-03-30 21:29:05 +00006639
6640 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006641 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006642 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006643 CGM.addCompilerUsedGlobal(Entry);
Chris Lattnerf56501c2009-07-17 23:57:13 +00006644
Fariborz Jahanian61cd4b52009-01-29 20:10:59 +00006645 // Use this protocol meta-data to build protocol list table in section
6646 // __DATA, __objc_protolist
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006647 llvm::GlobalVariable *PTGV =
6648 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006649 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006650 "\01l_OBJC_LABEL_PROTOCOL_$_" + PD->getObjCRuntimeNameAsString());
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006651 PTGV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006652 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Daniel Dunbarb25452a2009-04-15 02:56:18 +00006653 PTGV->setSection("__DATA, __objc_protolist, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006654 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006655 CGM.addCompilerUsedGlobal(PTGV);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006656 return Entry;
6657}
6658
6659/// EmitProtocolList - Generate protocol list meta-data:
6660/// @code
6661/// struct _protocol_list_t {
6662/// long protocol_count; // Note, this is 32/64 bit
6663/// struct _protocol_t[protocol_count];
6664/// }
6665/// @endcode
6666///
6667llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00006668CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006669 ObjCProtocolDecl::protocol_iterator begin,
6670 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006671 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006672
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006673 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006674 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00006675 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006676
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006677 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006678 SmallString<256> TmpName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006679 Name.toVector(TmpName);
6680 llvm::GlobalVariable *GV =
6681 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006682 if (GV)
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006683 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006684
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006685 for (; begin != end; ++begin)
6686 ProtocolRefs.push_back(GetProtocolRef(*begin)); // Implemented???
6687
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006688 // This list is null terminated.
Owen Anderson0b75f232009-07-31 20:28:54 +00006689 ProtocolRefs.push_back(llvm::Constant::getNullValue(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006690 ObjCTypes.ProtocolnfABIPtrTy));
6691
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006692 llvm::Constant *Values[2];
Owen Anderson170229f2009-07-14 23:10:40 +00006693 Values[0] =
Owen Andersonb7a2fe62009-07-24 23:12:58 +00006694 llvm::ConstantInt::get(ObjCTypes.LongTy, ProtocolRefs.size() - 1);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006695 Values[1] =
Bill Wendlinga515b582012-02-09 22:16:49 +00006696 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.ProtocolnfABIPtrTy,
6697 ProtocolRefs.size()),
6698 ProtocolRefs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006699
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006700 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Values);
Owen Andersonc10c8d32009-07-08 19:05:04 +00006701 GV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006702 llvm::GlobalValue::PrivateLinkage,
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006703 Init, Name);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006704 GV->setSection("__DATA, __objc_const");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006705 GV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006706 CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Rafael Espindola060062a2014-03-06 22:15:10 +00006707 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006708 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006709 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006710}
6711
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006712/// GetMethodDescriptionConstant - This routine build following meta-data:
6713/// struct _objc_method {
6714/// SEL _cmd;
6715/// char *method_type;
6716/// char *_imp;
6717/// }
6718
6719llvm::Constant *
6720CGObjCNonFragileABIMac::GetMethodDescriptionConstant(const ObjCMethodDecl *MD) {
Benjamin Kramer22d24c22011-10-15 12:20:02 +00006721 llvm::Constant *Desc[3];
Owen Anderson170229f2009-07-14 23:10:40 +00006722 Desc[0] =
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006723 llvm::ConstantExpr::getBitCast(GetMethodVarName(MD->getSelector()),
6724 ObjCTypes.SelectorPtrTy);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006725 Desc[1] = GetMethodVarType(MD);
Douglas Gregora9d84932011-05-27 01:19:52 +00006726 if (!Desc[1])
Craig Topper8a13c412014-05-21 05:09:00 +00006727 return nullptr;
6728
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006729 // Protocol methods have no implementation. So, this entry is always NULL.
Owen Anderson0b75f232009-07-31 20:28:54 +00006730 Desc[2] = llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Owen Anderson0e0189d2009-07-27 22:29:56 +00006731 return llvm::ConstantStruct::get(ObjCTypes.MethodTy, Desc);
Fariborz Jahaniand9c28b82009-01-30 00:46:37 +00006732}
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006733
6734/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6735/// This code gen. amounts to generating code for:
6736/// @code
6737/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6738/// @encode
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006739///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00006740LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall96fa4842010-05-17 21:00:27 +00006741 CodeGen::CodeGenFunction &CGF,
6742 QualType ObjectTy,
6743 llvm::Value *BaseValue,
6744 const ObjCIvarDecl *Ivar,
6745 unsigned CVRQualifiers) {
6746 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006747 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00006748 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006749 Offset);
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006750}
6751
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006752llvm::Value *CGObjCNonFragileABIMac::EmitIvarOffset(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006753 CodeGen::CodeGenFunction &CGF,
6754 const ObjCInterfaceDecl *Interface,
6755 const ObjCIvarDecl *Ivar) {
Tim Northover238b5082014-03-29 13:42:40 +00006756 llvm::Value *IvarOffsetValue = ObjCIvarOffsetVariable(Interface, Ivar);
John McCall7f416cc2015-09-08 08:05:57 +00006757 IvarOffsetValue = CGF.Builder.CreateAlignedLoad(IvarOffsetValue,
6758 CGF.getSizeAlign(), "ivar");
Tim Northover238b5082014-03-29 13:42:40 +00006759 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
6760 cast<llvm::LoadInst>(IvarOffsetValue)
6761 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
Craig Topper5fc8fc22014-08-27 06:28:36 +00006762 llvm::MDNode::get(VMContext, None));
Tim Northover238b5082014-03-29 13:42:40 +00006763
6764 // This could be 32bit int or 64bit integer depending on the architecture.
6765 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
6766 // as this is what caller always expectes.
6767 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
6768 IvarOffsetValue = CGF.Builder.CreateIntCast(
6769 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
6770 return IvarOffsetValue;
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006771}
6772
John McCall234eac82011-05-13 23:16:18 +00006773static void appendSelectorForMessageRefTable(std::string &buffer,
6774 Selector selector) {
6775 if (selector.isUnarySelector()) {
6776 buffer += selector.getNameForSlot(0);
6777 return;
6778 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006779
John McCall234eac82011-05-13 23:16:18 +00006780 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
6781 buffer += selector.getNameForSlot(i);
6782 buffer += '_';
6783 }
6784}
6785
Eric Christopherd160c502016-01-29 01:35:53 +00006786/// Emit a "vtable" message send. We emit a weak hidden-visibility
John McCall9e8bb002011-05-14 03:10:52 +00006787/// struct, initially containing the selector pointer and a pointer to
6788/// a "fixup" variant of the appropriate objc_msgSend. To call, we
6789/// load and call the function pointer, passing the address of the
6790/// struct as the second parameter. The runtime determines whether
6791/// the selector is currently emitted using vtable dispatch; if so, it
6792/// substitutes a stub function which simply tail-calls through the
6793/// appropriate vtable slot, and if not, it substitues a stub function
6794/// which tail-calls objc_msgSend. Both stubs adjust the selector
6795/// argument to correctly point to the selector.
6796RValue
6797CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
6798 ReturnValueSlot returnSlot,
6799 QualType resultType,
6800 Selector selector,
6801 llvm::Value *arg0,
6802 QualType arg0Type,
6803 bool isSuper,
6804 const CallArgList &formalArgs,
6805 const ObjCMethodDecl *method) {
John McCall234eac82011-05-13 23:16:18 +00006806 // Compute the actual arguments.
6807 CallArgList args;
6808
John McCall9e8bb002011-05-14 03:10:52 +00006809 // First argument: the receiver / super-call structure.
John McCall234eac82011-05-13 23:16:18 +00006810 if (!isSuper)
John McCall9e8bb002011-05-14 03:10:52 +00006811 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
6812 args.add(RValue::get(arg0), arg0Type);
John McCall234eac82011-05-13 23:16:18 +00006813
John McCall9e8bb002011-05-14 03:10:52 +00006814 // Second argument: a pointer to the message ref structure. Leave
6815 // the actual argument value blank for now.
Craig Topper8a13c412014-05-21 05:09:00 +00006816 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCall234eac82011-05-13 23:16:18 +00006817
6818 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
6819
John McCalla729c622012-02-17 03:33:10 +00006820 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCall234eac82011-05-13 23:16:18 +00006821
John McCall5880fb82011-05-14 21:12:11 +00006822 NullReturnState nullReturn;
6823
John McCall9e8bb002011-05-14 03:10:52 +00006824 // Find the function to call and the mangled name for the message
6825 // ref structure. Using a different mangled name wouldn't actually
6826 // be a problem; it would just be a waste.
6827 //
6828 // The runtime currently never uses vtable dispatch for anything
6829 // except normal, non-super message-sends.
6830 // FIXME: don't use this for that.
Craig Topper8a13c412014-05-21 05:09:00 +00006831 llvm::Constant *fn = nullptr;
John McCall234eac82011-05-13 23:16:18 +00006832 std::string messageRefName("\01l_");
Tim Northovere77cc392014-03-29 13:28:05 +00006833 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall234eac82011-05-13 23:16:18 +00006834 if (isSuper) {
6835 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
6836 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006837 } else {
John McCall5880fb82011-05-14 21:12:11 +00006838 nullReturn.init(CGF, arg0);
John McCall234eac82011-05-13 23:16:18 +00006839 fn = ObjCTypes.getMessageSendStretFixupFn();
6840 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006841 }
John McCall234eac82011-05-13 23:16:18 +00006842 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
6843 fn = ObjCTypes.getMessageSendFpretFixupFn();
6844 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stump658fe022009-07-30 22:28:39 +00006845 } else {
John McCall234eac82011-05-13 23:16:18 +00006846 if (isSuper) {
6847 fn = ObjCTypes.getMessageSendSuper2FixupFn();
6848 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006849 } else {
John McCall234eac82011-05-13 23:16:18 +00006850 fn = ObjCTypes.getMessageSendFixupFn();
6851 messageRefName += "objc_msgSend_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00006852 }
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00006853 }
John McCall234eac82011-05-13 23:16:18 +00006854 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
6855 messageRefName += '_';
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006856
John McCall234eac82011-05-13 23:16:18 +00006857 // Append the selector name, except use underscores anywhere we
6858 // would have used colons.
6859 appendSelectorForMessageRefTable(messageRefName, selector);
6860
6861 llvm::GlobalVariable *messageRef
6862 = CGM.getModule().getGlobalVariable(messageRefName);
6863 if (!messageRef) {
John McCall9e8bb002011-05-14 03:10:52 +00006864 // Build the message ref structure.
John McCall234eac82011-05-13 23:16:18 +00006865 llvm::Constant *values[] = { fn, GetMethodVarName(selector) };
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006866 llvm::Constant *init = llvm::ConstantStruct::getAnon(values);
John McCall234eac82011-05-13 23:16:18 +00006867 messageRef = new llvm::GlobalVariable(CGM.getModule(),
6868 init->getType(),
6869 /*constant*/ false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006870 llvm::GlobalValue::WeakAnyLinkage,
John McCall234eac82011-05-13 23:16:18 +00006871 init,
6872 messageRefName);
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006873 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall234eac82011-05-13 23:16:18 +00006874 messageRef->setAlignment(16);
6875 messageRef->setSection("__DATA, __objc_msgrefs, coalesced");
6876 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006877
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006878 bool requiresnullCheck = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00006879 if (CGM.getLangOpts().ObjCAutoRefCount && method)
David Majnemer59f77922016-06-24 04:05:48 +00006880 for (const auto *ParamDecl : method->parameters()) {
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00006881 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
6882 if (!nullReturn.NullBB)
6883 nullReturn.init(CGF, arg0);
6884 requiresnullCheck = true;
6885 break;
6886 }
6887 }
6888
John McCall7f416cc2015-09-08 08:05:57 +00006889 Address mref =
6890 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
6891 CGF.getPointerAlign());
John McCall234eac82011-05-13 23:16:18 +00006892
John McCall9e8bb002011-05-14 03:10:52 +00006893 // Update the message ref argument.
John McCall7f416cc2015-09-08 08:05:57 +00006894 args[1].RV = RValue::get(mref.getPointer());
John McCall234eac82011-05-13 23:16:18 +00006895
6896 // Load the function to call from the message ref table.
John McCall7f416cc2015-09-08 08:05:57 +00006897 Address calleeAddr =
6898 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
6899 llvm::Value *callee = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCall234eac82011-05-13 23:16:18 +00006900
John McCalla729c622012-02-17 03:33:10 +00006901 callee = CGF.Builder.CreateBitCast(callee, MSI.MessengerType);
John McCall234eac82011-05-13 23:16:18 +00006902
John McCalla729c622012-02-17 03:33:10 +00006903 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Craig Topper8a13c412014-05-21 05:09:00 +00006904 return nullReturn.complete(CGF, result, resultType, formalArgs,
6905 requiresnullCheck ? method : nullptr);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006906}
6907
6908/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006909CodeGen::RValue
6910CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00006911 ReturnValueSlot Return,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006912 QualType ResultType,
6913 Selector Sel,
6914 llvm::Value *Receiver,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006915 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00006916 const ObjCInterfaceDecl *Class,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00006917 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00006918 return isVTableDispatchedSelector(Sel)
6919 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006920 Receiver, CGF.getContext().getObjCIdType(),
John McCall9e8bb002011-05-14 03:10:52 +00006921 false, CallArgs, Method)
6922 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00006923 EmitSelector(CGF, Sel),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006924 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00006925 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00006926}
6927
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006928llvm::GlobalVariable *
Benjamin Kramer0772c422016-02-13 13:42:54 +00006929CGObjCNonFragileABIMac::GetClassGlobal(StringRef Name, bool Weak) {
Rafael Espindola554256c2014-02-26 22:25:45 +00006930 llvm::GlobalValue::LinkageTypes L =
6931 Weak ? llvm::GlobalValue::ExternalWeakLinkage
6932 : llvm::GlobalValue::ExternalLinkage;
6933
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006934 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
6935
Rafael Espindola554256c2014-02-26 22:25:45 +00006936 if (!GV)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006937 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABITy,
Craig Topper8a13c412014-05-21 05:09:00 +00006938 false, L, nullptr, Name);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006939
Rafael Espindola554256c2014-02-26 22:25:45 +00006940 assert(GV->getLinkage() == L);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00006941 return GV;
6942}
6943
John McCall882987f2013-02-28 19:01:20 +00006944llvm::Value *CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
Rafael Espindola554256c2014-02-26 22:25:45 +00006945 IdentifierInfo *II,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006946 bool Weak,
6947 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006948 CharUnits Align = CGF.getPointerAlign();
John McCall31168b02011-06-15 23:02:42 +00006949 llvm::GlobalVariable *&Entry = ClassReferences[II];
6950
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006951 if (!Entry) {
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00006952 StringRef Name = ID ? ID->getObjCRuntimeNameAsString() : II->getName();
6953 std::string ClassName = (getClassSymbolPrefix() + Name).str();
Rafael Espindola554256c2014-02-26 22:25:45 +00006954 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName, Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006955 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6956 false, llvm::GlobalValue::PrivateLinkage,
6957 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006958 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006959 Entry->setSection("__DATA, __objc_classrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006960 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006961 }
John McCall7f416cc2015-09-08 08:05:57 +00006962 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006963}
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006964
John McCall882987f2013-02-28 19:01:20 +00006965llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00006966 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00006967 // If the class has the objc_runtime_visible attribute, we need to
6968 // use the Objective-C runtime to get the class.
6969 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
6970 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
6971
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006972 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID->isWeakImported(), ID);
John McCall31168b02011-06-15 23:02:42 +00006973}
6974
6975llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCall882987f2013-02-28 19:01:20 +00006976 CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00006977 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
Hans Wennborgdcfba332015-10-06 23:40:43 +00006978 return EmitClassRefFromId(CGF, II, false, nullptr);
John McCall31168b02011-06-15 23:02:42 +00006979}
6980
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006981llvm::Value *
John McCall882987f2013-02-28 19:01:20 +00006982CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006983 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00006984 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006985 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006986
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006987 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006988 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
6989 ClassName += ID->getObjCRuntimeNameAsString();
6990 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(),
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006991 ID->isWeakImported());
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006992 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
6993 false, llvm::GlobalValue::PrivateLinkage,
6994 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00006995 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006996 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00006997 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00006998 }
John McCall7f416cc2015-09-08 08:05:57 +00006999 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007000}
7001
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007002/// EmitMetaClassRef - Return a Value * of the address of _class_t
7003/// meta-data
7004///
John McCall882987f2013-02-28 19:01:20 +00007005llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00007006 const ObjCInterfaceDecl *ID,
7007 bool Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00007008 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007009 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Rafael Espindola21039aa2014-02-27 16:26:32 +00007010 if (!Entry) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007011 llvm::SmallString<64> MetaClassName(getMetaclassSymbolPrefix());
7012 MetaClassName += ID->getObjCRuntimeNameAsString();
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00007013 llvm::GlobalVariable *MetaClassGV =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007014 GetClassGlobal(MetaClassName.str(), Weak);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007015
Rafael Espindola21039aa2014-02-27 16:26:32 +00007016 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00007017 false, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007018 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007019 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007020
Rafael Espindola21039aa2014-02-27 16:26:32 +00007021 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00007022 CGM.addCompilerUsedGlobal(Entry);
Rafael Espindola21039aa2014-02-27 16:26:32 +00007023 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007024
John McCall7f416cc2015-09-08 08:05:57 +00007025 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007026}
7027
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007028/// GetClass - Return a reference to the class for the given interface
7029/// decl.
John McCall882987f2013-02-28 19:01:20 +00007030llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007031 const ObjCInterfaceDecl *ID) {
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00007032 if (ID->isWeakImported()) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00007033 llvm::SmallString<64> ClassName(getClassSymbolPrefix());
7034 ClassName += ID->getObjCRuntimeNameAsString();
7035 llvm::GlobalVariable *ClassGV = GetClassGlobal(ClassName.str(), true);
Nick Lewycky9a441642014-02-27 00:36:00 +00007036 (void)ClassGV;
Rafael Espindolab3262952014-05-09 00:43:37 +00007037 assert(ClassGV->hasExternalWeakLinkage());
Fariborz Jahanian95ace552009-11-17 22:42:00 +00007038 }
7039
John McCall882987f2013-02-28 19:01:20 +00007040 return EmitClassRef(CGF, ID);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007041}
7042
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007043/// Generates a message send where the super is the receiver. This is
7044/// a message send to self with special delivery semantics indicating
7045/// which class's method should be called.
7046CodeGen::RValue
7047CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00007048 ReturnValueSlot Return,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007049 QualType ResultType,
7050 Selector Sel,
7051 const ObjCInterfaceDecl *Class,
7052 bool isCategoryImpl,
7053 llvm::Value *Receiver,
7054 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007055 const CodeGen::CallArgList &CallArgs,
7056 const ObjCMethodDecl *Method) {
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007057 // ...
7058 // Create and init a super structure; this is a (receiver, class)
7059 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00007060 Address ObjCSuper =
7061 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
7062 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007063
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007064 llvm::Value *ReceiverAsObject =
7065 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007066 CGF.Builder.CreateStore(
7067 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00007068 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007069
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007070 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00007071 llvm::Value *Target;
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007072 if (IsClassMessage)
Fariborz Jahanian85b99da2014-08-28 17:05:17 +00007073 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007074 else
John McCall882987f2013-02-28 19:01:20 +00007075 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007076
Mike Stump18bb9282009-05-16 07:57:57 +00007077 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
7078 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00007079 llvm::Type *ClassTy =
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007080 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
7081 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007082 CGF.Builder.CreateStore(
John McCall7f416cc2015-09-08 08:05:57 +00007083 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007084
John McCall9e8bb002011-05-14 03:10:52 +00007085 return (isVTableDispatchedSelector(Sel))
7086 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
John McCall7f416cc2015-09-08 08:05:57 +00007087 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall9e8bb002011-05-14 03:10:52 +00007088 true, CallArgs, Method)
7089 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00007090 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00007091 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00007092 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007093}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007094
John McCall882987f2013-02-28 19:01:20 +00007095llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007096 Selector Sel) {
7097 Address Addr = EmitSelectorAddr(CGF, Sel);
7098
7099 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
7100 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
7101 llvm::MDNode::get(VMContext, None));
7102 return LI;
7103}
7104
7105Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
7106 Selector Sel) {
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007107 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007108
John McCall7f416cc2015-09-08 08:05:57 +00007109 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007110 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007111 llvm::Constant *Casted =
7112 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
7113 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007114 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
7115 false, llvm::GlobalValue::PrivateLinkage,
7116 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman5c205962013-02-05 23:08:45 +00007117 Entry->setExternallyInitialized(true);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00007118 Entry->setSection("__DATA, __objc_selrefs, literal_pointers, no_dead_strip");
John McCall7f416cc2015-09-08 08:05:57 +00007119 Entry->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00007120 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007121 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007122
John McCall7f416cc2015-09-08 08:05:57 +00007123 return Address(Entry, Align);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007124}
John McCall7f416cc2015-09-08 08:05:57 +00007125
Fariborz Jahanian06292952009-02-16 22:52:32 +00007126/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007127/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian06292952009-02-16 22:52:32 +00007128///
7129void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00007130 llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +00007131 Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007132 llvm::Value *ivarOffset) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007133 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007134 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007135 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007136 assert(Size <= 8 && "does not support size > 8");
7137 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7138 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007139 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7140 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007141 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7142 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007143 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00007144 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007145}
7146
7147/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
7148/// objc_assign_strongCast (id src, id *dst)
7149///
7150void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007151 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007152 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007153 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007154 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007155 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007156 assert(Size <= 8 && "does not support size > 8");
7157 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007158 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007159 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7160 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007161 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7162 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007163 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007164 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
7165 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007166}
7167
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007168void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007169 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007170 Address DestPtr,
7171 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00007172 llvm::Value *Size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007173 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
7174 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007175 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCall882987f2013-02-28 19:01:20 +00007176 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007177}
7178
Fariborz Jahanian06292952009-02-16 22:52:32 +00007179/// EmitObjCWeakRead - Code gen for loading value of a __weak
7180/// object: objc_read_weak (id *src)
7181///
7182llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007183 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007184 Address AddrWeakObj) {
7185 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007186 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007187 llvm::Value *read_weak =
7188 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00007189 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00007190 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007191 return read_weak;
7192}
7193
7194/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
7195/// objc_assign_weak (id src, id *dst)
7196///
7197void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007198 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007199 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007200 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007201 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007202 assert(Size <= 8 && "does not support size > 8");
7203 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7204 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007205 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7206 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007207 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7208 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007209 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007210 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
7211 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007212}
7213
7214/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
7215/// objc_assign_global (id src, id *dst)
7216///
7217void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007218 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00007219 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007220 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007221 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007222 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007223 assert(Size <= 8 && "does not support size > 8");
7224 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7225 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007226 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7227 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007228 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7229 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007230 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00007231 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00007232 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
7233 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00007234 else
John McCall882987f2013-02-28 19:01:20 +00007235 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
7236 args, "threadlocalassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007237}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007238
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007239void
John McCallbd309292010-07-06 01:34:17 +00007240CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
7241 const ObjCAtSynchronizedStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007242 EmitAtSynchronizedStmt(CGF, S,
7243 cast<llvm::Function>(ObjCTypes.getSyncEnterFn()),
7244 cast<llvm::Function>(ObjCTypes.getSyncExitFn()));
John McCallbd309292010-07-06 01:34:17 +00007245}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007246
John McCall2ca705e2010-07-24 00:37:23 +00007247llvm::Constant *
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00007248CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall2ca705e2010-07-24 00:37:23 +00007249 // There's a particular fixed type info for 'id'.
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007250 if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
7251 auto *IDEHType = CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007252 if (!IDEHType) {
John McCall2ca705e2010-07-24 00:37:23 +00007253 IDEHType =
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007254 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7255 llvm::GlobalValue::ExternalLinkage, nullptr,
7256 "OBJC_EHTYPE_id");
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007257 if (CGM.getTriple().isOSBinFormatCOFF())
7258 IDEHType->setDLLStorageClass(getStorage(CGM, "OBJC_EHTYPE_id"));
7259 }
John McCall2ca705e2010-07-24 00:37:23 +00007260 return IDEHType;
7261 }
7262
7263 // All other types should be Objective-C interface pointer types.
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007264 const ObjCObjectPointerType *PT = T->getAs<ObjCObjectPointerType>();
John McCall2ca705e2010-07-24 00:37:23 +00007265 assert(PT && "Invalid @catch type.");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007266
John McCall2ca705e2010-07-24 00:37:23 +00007267 const ObjCInterfaceType *IT = PT->getInterfaceType();
7268 assert(IT && "Invalid @catch type.");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007269
John McCall2ca705e2010-07-24 00:37:23 +00007270 return GetInterfaceEHType(IT->getDecl(), false);
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007271}
John McCall2ca705e2010-07-24 00:37:23 +00007272
John McCallbd309292010-07-06 01:34:17 +00007273void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7274 const ObjCAtTryStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007275 EmitTryCatchStmt(CGF, S,
7276 cast<llvm::Function>(ObjCTypes.getObjCBeginCatchFn()),
7277 cast<llvm::Function>(ObjCTypes.getObjCEndCatchFn()),
7278 cast<llvm::Function>(ObjCTypes.getExceptionRethrowFn()));
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +00007279}
7280
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007281/// EmitThrowStmt - Generate code for a throw statement.
7282void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007283 const ObjCAtThrowStmt &S,
7284 bool ClearInsertionPoint) {
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007285 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00007286 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer76399eb2011-09-27 21:06:10 +00007287 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007288 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception)
John McCall17afe452010-10-16 08:21:07 +00007289 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007290 } else {
John McCall882987f2013-02-28 19:01:20 +00007291 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn())
John McCall17afe452010-10-16 08:21:07 +00007292 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007293 }
7294
John McCall17afe452010-10-16 08:21:07 +00007295 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007296 if (ClearInsertionPoint)
7297 CGF.Builder.ClearInsertionPoint();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007298}
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007299
John McCall2ca705e2010-07-24 00:37:23 +00007300llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007301CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007302 bool ForDefinition) {
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007303 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007304 StringRef ClassName = ID->getObjCRuntimeNameAsString();
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007305
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007306 // If we don't need a definition, return the entry if found or check
7307 // if we use an external reference.
7308 if (!ForDefinition) {
7309 if (Entry)
7310 return Entry;
Daniel Dunbard7beeea2009-04-07 06:43:45 +00007311
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007312 // If this type (or a super class) has the __objc_exception__
7313 // attribute, emit an external reference.
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007314 if (hasObjCExceptionAttribute(CGM.getContext(), ID)) {
7315 std::string EHTypeName = ("OBJC_EHTYPE_$_" + ClassName).str();
7316 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7317 false, llvm::GlobalValue::ExternalLinkage,
7318 nullptr, EHTypeName);
7319 if (CGM.getTriple().isOSBinFormatCOFF()) {
7320 if (ID->hasAttr<DLLExportAttr>())
7321 Entry->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
7322 else if (ID->hasAttr<DLLImportAttr>())
7323 Entry->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
7324 }
7325 return Entry;
7326 }
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007327 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007328
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007329 // Otherwise we need to either make a new entry or fill in the initializer.
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007330 assert((!Entry || !Entry->hasInitializer()) && "Duplicate EHType definition");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007331
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007332 std::string VTableName = "objc_ehtype_vtable";
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007333 auto *VTableGV = CGM.getModule().getGlobalVariable(VTableName);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007334 if (!VTableGV) {
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007335 VTableGV =
7336 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.Int8PtrTy, false,
7337 llvm::GlobalValue::ExternalLinkage, nullptr,
7338 VTableName);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007339 if (CGM.getTriple().isOSBinFormatCOFF())
7340 VTableGV->setDLLStorageClass(getStorage(CGM, VTableName));
7341 }
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007342
Chris Lattnerece04092012-02-07 00:39:47 +00007343 llvm::Value *VTableIdx = llvm::ConstantInt::get(CGM.Int32Ty, 2);
Benjamin Kramer22d24c22011-10-15 12:20:02 +00007344 llvm::Constant *Values[] = {
David Blaikiee3b172a2015-04-02 18:55:21 +00007345 llvm::ConstantExpr::getGetElementPtr(VTableGV->getValueType(), VTableGV,
7346 VTableIdx),
7347 GetClassName(ID->getObjCRuntimeNameAsString()),
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007348 GetClassGlobal((getClassSymbolPrefix() + ClassName).str()),
7349 };
7350 llvm::Constant *Init = llvm::ConstantStruct::get(ObjCTypes.EHTypeTy, Values);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007351
Rafael Espindola554256c2014-02-26 22:25:45 +00007352 llvm::GlobalValue::LinkageTypes L = ForDefinition
7353 ? llvm::GlobalValue::ExternalLinkage
7354 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007355 if (Entry) {
7356 Entry->setInitializer(Init);
7357 } else {
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007358 Entry =
7359 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false, L,
7360 Init, ("OBJC_EHTYPE_$_" + ClassName).str());
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007361 if (CGM.getTriple().isOSBinFormatCOFF())
7362 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
7363 if (ID->hasAttr<DLLExportAttr>())
7364 Entry->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007365 }
Rafael Espindola554256c2014-02-26 22:25:45 +00007366 assert(Entry->getLinkage() == L);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007367
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007368 if (!CGM.getTriple().isOSBinFormatCOFF())
7369 if (ID->getVisibility() == HiddenVisibility)
7370 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007371
7372 const auto &DL = CGM.getDataLayout();
7373 Entry->setAlignment(DL.getABITypeAlignment(ObjCTypes.EHTypeTy));
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007374
Rafael Espindola554256c2014-02-26 22:25:45 +00007375 if (ForDefinition)
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007376 Entry->setSection("__DATA,__objc_const");
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007377
7378 return Entry;
7379}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007380
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00007381/* *** */
7382
Daniel Dunbarb036db82008-08-13 03:21:16 +00007383CodeGen::CGObjCRuntime *
7384CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00007385 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7386 case ObjCRuntime::FragileMacOSX:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007387 return new CGObjCMac(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00007388
7389 case ObjCRuntime::MacOSX:
7390 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00007391 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00007392 return new CGObjCNonFragileABIMac(CGM);
7393
David Chisnallb601c962012-07-03 20:49:52 +00007394 case ObjCRuntime::GNUstep:
7395 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +00007396 case ObjCRuntime::ObjFW:
John McCall5fb5df92012-06-20 06:18:46 +00007397 llvm_unreachable("these runtimes are not Mac runtimes");
7398 }
7399 llvm_unreachable("bad runtime");
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007400}