blob: 0c766575dc21860701a011058f96f3d0c747aff1 [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
John McCallad7c5c12011-02-08 08:22:06 +000014#include "CGBlocks.h"
John McCalled1ae862011-01-28 11:13:47 +000015#include "CGCleanup.h"
Justin Lebar5e83dfe2016-10-21 21:45:01 +000016#include "CGObjCRuntime.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CGRecordLayout.h"
18#include "CodeGenFunction.h"
19#include "CodeGenModule.h"
John McCall5ad74072017-03-02 20:04:19 +000020#include "clang/CodeGen/ConstantInitBuilder.h"
Daniel Dunbar8b8683f2008-08-12 00:12:39 +000021#include "clang/AST/ASTContext.h"
Daniel Dunbar221fa942008-08-11 04:54:23 +000022#include "clang/AST/Decl.h"
Daniel Dunbarb036db82008-08-13 03:21:16 +000023#include "clang/AST/DeclObjC.h"
Anders Carlsson15b73de2009-07-18 19:43:29 +000024#include "clang/AST/RecordLayout.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000025#include "clang/AST/StmtObjC.h"
Daniel Dunbar3ad53482008-08-11 21:35:06 +000026#include "clang/Basic/LangOptions.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000027#include "clang/CodeGen/CGFunctionInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000028#include "clang/Frontend/CodeGenOptions.h"
Justin Lebar5e83dfe2016-10-21 21:45:01 +000029#include "llvm/ADT/CachedHashString.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000030#include "llvm/ADT/DenseSet.h"
31#include "llvm/ADT/SetVector.h"
32#include "llvm/ADT/SmallPtrSet.h"
33#include "llvm/ADT/SmallString.h"
Chandler Carruthc80ceea2014-03-04 11:02:08 +000034#include "llvm/IR/CallSite.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000035#include "llvm/IR/DataLayout.h"
36#include "llvm/IR/InlineAsm.h"
37#include "llvm/IR/IntrinsicInst.h"
38#include "llvm/IR/LLVMContext.h"
39#include "llvm/IR/Module.h"
Daniel Dunbard027a922009-09-07 00:20:42 +000040#include "llvm/Support/raw_ostream.h"
Torok Edwindb714922009-08-24 13:25:12 +000041#include <cstdio>
Daniel Dunbar303e2c22008-08-11 02:45:11 +000042
43using namespace clang;
Daniel Dunbar41cf9de2008-09-09 01:06:48 +000044using namespace CodeGen;
Daniel Dunbar303e2c22008-08-11 02:45:11 +000045
46namespace {
Daniel Dunbar8b8683f2008-08-12 00:12:39 +000047
Daniel Dunbar59e476b2009-08-03 17:06:42 +000048// FIXME: We should find a nicer way to make the labels for metadata, string
49// concatenation is lame.
Daniel Dunbarb036db82008-08-13 03:21:16 +000050
Fariborz Jahanian279eda62009-01-21 22:04:16 +000051class ObjCCommonTypesHelper {
Owen Anderson170229f2009-07-14 23:10:40 +000052protected:
53 llvm::LLVMContext &VMContext;
Daniel Dunbar59e476b2009-08-03 17:06:42 +000054
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000055private:
John McCall9dc0db22011-05-15 01:53:33 +000056 // The types of these functions don't really matter because we
57 // should always bitcast before calling them.
58
59 /// id objc_msgSend (id, SEL, ...)
60 ///
61 /// The default messenger, used for sends whose ABI is unchanged from
62 /// the all-integer/pointer case.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000063 llvm::Constant *getMessageSendFn() const {
John McCall31168b02011-06-15 23:02:42 +000064 // Add the non-lazy-bind attribute, since objc_msgSend is likely to
65 // be called a lot.
Chris Lattnera5f58b02011-07-09 17:41:47 +000066 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
Reid Klecknerde864822017-03-21 16:57:30 +000067 return CGM.CreateRuntimeFunction(
68 llvm::FunctionType::get(ObjectPtrTy, params, true), "objc_msgSend",
69 llvm::AttributeList::get(CGM.getLLVMContext(),
70 llvm::AttributeList::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);
Serge Guelton1d993272017-05-09 19:31:30 +0000108 llvm::Type *resultType =
109 llvm::StructType::get(longDoubleType, longDoubleType);
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:
John McCall176f8922016-11-30 02:39:18 +0000175 llvm::IntegerType *ShortTy, *IntTy, *LongTy;
176 llvm::PointerType *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))
John McCall176f8922016-11-30 02:39:18 +0000180 llvm::PointerType *ObjectPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000181
Fariborz Jahanian406b1172008-11-18 20:18:11 +0000182 /// PtrObjectPtrTy - LLVM type for id *
John McCall176f8922016-11-30 02:39:18 +0000183 llvm::PointerType *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))
John McCall176f8922016-11-30 02:39:18 +0000186 llvm::PointerType *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 *.
John McCall176f8922016-11-30 02:39:18 +0000215 llvm::PointerType *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*.
John McCall176f8922016-11-30 02:39:18 +0000225 llvm::PointerType *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 *.
John McCall176f8922016-11-30 02:39:18 +0000233 llvm::PointerType *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);
Saleem Abdulrasool91d9bfc2017-06-17 17:30:31 +0000311 Params.push_back(Ctx.getSizeType());
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000312 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 *.
John McCall176f8922016-11-30 02:39:18 +0000503 llvm::PointerType *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 *.
John McCall176f8922016-11-30 02:39:18 +0000510 llvm::PointerType *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 *.
John McCall176f8922016-11-30 02:39:18 +0000516 llvm::PointerType *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 *.
John McCall176f8922016-11-30 02:39:18 +0000525 llvm::PointerType *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*.
John McCall176f8922016-11-30 02:39:18 +0000529 llvm::PointerType *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 *.
John McCall176f8922016-11-30 02:39:18 +0000535 llvm::PointerType *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 *.
John McCall176f8922016-11-30 02:39:18 +0000539 llvm::PointerType *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.
John McCall176f8922016-11-30 02:39:18 +0000543 llvm::StructType *IvarListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000544 /// IvarListPtrTy - LLVM type for struct objc_ivar_list *.
John McCall176f8922016-11-30 02:39:18 +0000545 llvm::PointerType *IvarListPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000546 /// MethodListTy - LLVM type for struct objc_method_list.
John McCall176f8922016-11-30 02:39:18 +0000547 llvm::StructType *MethodListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000548 /// MethodListPtrTy - LLVM type for struct objc_method_list *.
John McCall176f8922016-11-30 02:39:18 +0000549 llvm::PointerType *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.
John McCall176f8922016-11-30 02:39:18 +0000552 llvm::StructType *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() };
Reid Klecknerde864822017-03-21 16:57:30 +0000590 return CGM.CreateRuntimeFunction(
591 llvm::FunctionType::get(CGM.Int32Ty, params, false), "_setjmp",
592 llvm::AttributeList::get(CGM.getLLVMContext(),
593 llvm::AttributeList::FunctionIndex,
594 llvm::Attribute::NonLazyBind));
Chris Lattnerc6406db2009-04-22 02:26:14 +0000595 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000596
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000597public:
598 ObjCTypesHelper(CodeGen::CodeGenModule &cgm);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000599};
600
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000601/// ObjCNonFragileABITypesHelper - will have all types needed by objective-c's
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000602/// modern abi
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000603class ObjCNonFragileABITypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000604public:
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000605 // MethodListnfABITy - LLVM for struct _method_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000606 llvm::StructType *MethodListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000607
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000608 // MethodListnfABIPtrTy - LLVM for struct _method_list_t*
John McCall176f8922016-11-30 02:39:18 +0000609 llvm::PointerType *MethodListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000610
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000611 // ProtocolnfABITy = LLVM for struct _protocol_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000612 llvm::StructType *ProtocolnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000613
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000614 // ProtocolnfABIPtrTy = LLVM for struct _protocol_t*
John McCall176f8922016-11-30 02:39:18 +0000615 llvm::PointerType *ProtocolnfABIPtrTy;
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000616
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000617 // ProtocolListnfABITy - LLVM for struct _objc_protocol_list
Chris Lattnera5f58b02011-07-09 17:41:47 +0000618 llvm::StructType *ProtocolListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000619
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000620 // ProtocolListnfABIPtrTy - LLVM for struct _objc_protocol_list*
John McCall176f8922016-11-30 02:39:18 +0000621 llvm::PointerType *ProtocolListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000622
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000623 // ClassnfABITy - LLVM for struct _class_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000624 llvm::StructType *ClassnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000625
Fariborz Jahanian71394042009-01-23 23:53:38 +0000626 // ClassnfABIPtrTy - LLVM for struct _class_t*
John McCall176f8922016-11-30 02:39:18 +0000627 llvm::PointerType *ClassnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000628
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000629 // IvarnfABITy - LLVM for struct _ivar_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000630 llvm::StructType *IvarnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000631
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000632 // IvarListnfABITy - LLVM for struct _ivar_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000633 llvm::StructType *IvarListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000634
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000635 // IvarListnfABIPtrTy = LLVM for struct _ivar_list_t*
John McCall176f8922016-11-30 02:39:18 +0000636 llvm::PointerType *IvarListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000637
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000638 // ClassRonfABITy - LLVM for struct _class_ro_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000639 llvm::StructType *ClassRonfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000640
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000641 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
John McCall176f8922016-11-30 02:39:18 +0000642 llvm::PointerType *ImpnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000643
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000644 // CategorynfABITy - LLVM for struct _category_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000645 llvm::StructType *CategorynfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000646
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000647 // New types for nonfragile abi messaging.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000648
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000649 // MessageRefTy - LLVM for:
650 // struct _message_ref_t {
651 // IMP messenger;
652 // SEL name;
653 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000654 llvm::StructType *MessageRefTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000655 // MessageRefCTy - clang type for struct _message_ref_t
656 QualType MessageRefCTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000657
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000658 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000659 llvm::Type *MessageRefPtrTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000660 // MessageRefCPtrTy - clang type for struct _message_ref_t*
661 QualType MessageRefCPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000662
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000663 // SuperMessageRefTy - LLVM for:
664 // struct _super_message_ref_t {
665 // SUPER_IMP messenger;
666 // SEL name;
667 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000668 llvm::StructType *SuperMessageRefTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000669
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000670 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
John McCall176f8922016-11-30 02:39:18 +0000671 llvm::PointerType *SuperMessageRefPtrTy;
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +0000672
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000673 llvm::Constant *getMessageSendFixupFn() {
674 // id objc_msgSend_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000675 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000676 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000677 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000678 "objc_msgSend_fixup");
679 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000680
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000681 llvm::Constant *getMessageSendFpretFixupFn() {
682 // id objc_msgSend_fpret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000683 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000684 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000685 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000686 "objc_msgSend_fpret_fixup");
687 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000688
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000689 llvm::Constant *getMessageSendStretFixupFn() {
690 // id objc_msgSend_stret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000691 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000692 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000693 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000694 "objc_msgSend_stret_fixup");
695 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000696
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000697 llvm::Constant *getMessageSendSuper2FixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000698 // id objc_msgSendSuper2_fixup (struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000699 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000700 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000701 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000702 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000703 "objc_msgSendSuper2_fixup");
704 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000705
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000706 llvm::Constant *getMessageSendSuper2StretFixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000707 // id objc_msgSendSuper2_stret_fixup(struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000708 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000709 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000710 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000711 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000712 "objc_msgSendSuper2_stret_fixup");
713 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000714
Chris Lattnera7c00b42009-04-22 02:15:23 +0000715 llvm::Constant *getObjCEndCatchFn() {
John McCall9dc0db22011-05-15 01:53:33 +0000716 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000717 "objc_end_catch");
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000718
Chris Lattnera7c00b42009-04-22 02:15:23 +0000719 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000720
Chris Lattnera7c00b42009-04-22 02:15:23 +0000721 llvm::Constant *getObjCBeginCatchFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000722 llvm::Type *params[] = { Int8PtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000723 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(Int8PtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000724 params, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000725 "objc_begin_catch");
726 }
Daniel Dunbarb1559a42009-03-01 04:46:24 +0000727
Chris Lattnera5f58b02011-07-09 17:41:47 +0000728 llvm::StructType *EHTypeTy;
729 llvm::Type *EHTypePtrTy;
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +0000730
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000731 ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000732};
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000733
Saleem Abdulrasool271106c2016-09-16 23:41:13 +0000734enum class ObjCLabelType {
735 ClassName,
736 MethodVarName,
737 MethodVarType,
738 PropertyName,
739};
740
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000741class CGObjCCommonMac : public CodeGen::CGObjCRuntime {
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000742public:
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000743 class SKIP_SCAN {
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000744 public:
745 unsigned skip;
746 unsigned scan;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000747 SKIP_SCAN(unsigned _skip = 0, unsigned _scan = 0)
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000748 : skip(_skip), scan(_scan) {}
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000749 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000750
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000751 /// opcode for captured block variables layout 'instructions'.
752 /// In the following descriptions, 'I' is the value of the immediate field.
753 /// (field following the opcode).
754 ///
755 enum BLOCK_LAYOUT_OPCODE {
756 /// An operator which affects how the following layout should be
757 /// interpreted.
758 /// I == 0: Halt interpretation and treat everything else as
759 /// a non-pointer. Note that this instruction is equal
760 /// to '\0'.
761 /// I != 0: Currently unused.
762 BLOCK_LAYOUT_OPERATOR = 0,
763
764 /// The next I+1 bytes do not contain a value of object pointer type.
765 /// Note that this can leave the stream unaligned, meaning that
766 /// subsequent word-size instructions do not begin at a multiple of
767 /// the pointer size.
768 BLOCK_LAYOUT_NON_OBJECT_BYTES = 1,
769
770 /// The next I+1 words do not contain a value of object pointer type.
771 /// This is simply an optimized version of BLOCK_LAYOUT_BYTES for
772 /// when the required skip quantity is a multiple of the pointer size.
773 BLOCK_LAYOUT_NON_OBJECT_WORDS = 2,
774
775 /// The next I+1 words are __strong pointers to Objective-C
776 /// objects or blocks.
777 BLOCK_LAYOUT_STRONG = 3,
778
779 /// The next I+1 words are pointers to __block variables.
780 BLOCK_LAYOUT_BYREF = 4,
781
782 /// The next I+1 words are __weak pointers to Objective-C
783 /// objects or blocks.
784 BLOCK_LAYOUT_WEAK = 5,
785
786 /// The next I+1 words are __unsafe_unretained pointers to
787 /// Objective-C objects or blocks.
788 BLOCK_LAYOUT_UNRETAINED = 6
789
790 /// The next I+1 words are block or object pointers with some
791 /// as-yet-unspecified ownership semantics. If we add more
792 /// flavors of ownership semantics, values will be taken from
793 /// this range.
794 ///
795 /// This is included so that older tools can at least continue
796 /// processing the layout past such things.
797 //BLOCK_LAYOUT_OWNERSHIP_UNKNOWN = 7..10,
798
799 /// All other opcodes are reserved. Halt interpretation and
800 /// treat everything else as opaque.
801 };
802
803 class RUN_SKIP {
804 public:
805 enum BLOCK_LAYOUT_OPCODE opcode;
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000806 CharUnits block_var_bytepos;
807 CharUnits block_var_size;
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000808 RUN_SKIP(enum BLOCK_LAYOUT_OPCODE Opcode = BLOCK_LAYOUT_OPERATOR,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000809 CharUnits BytePos = CharUnits::Zero(),
810 CharUnits Size = CharUnits::Zero())
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +0000811 : opcode(Opcode), block_var_bytepos(BytePos), block_var_size(Size) {}
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000812
813 // Allow sorting based on byte pos.
814 bool operator<(const RUN_SKIP &b) const {
815 return block_var_bytepos < b.block_var_bytepos;
816 }
817 };
818
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000819protected:
Owen Andersonae86c192009-07-13 04:10:07 +0000820 llvm::LLVMContext &VMContext;
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000821 // FIXME! May not be needing this after all.
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000822 unsigned ObjCABI;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000823
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000824 // arc/mrr layout of captured block literal variables.
825 SmallVector<RUN_SKIP, 16> RunSkipBlockVars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000826
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000827 /// LazySymbols - Symbols to generate a lazy reference for. See
828 /// DefinedSymbols and FinishModule().
Daniel Dunbard027a922009-09-07 00:20:42 +0000829 llvm::SetVector<IdentifierInfo*> LazySymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000830
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000831 /// DefinedSymbols - External symbols which are defined by this
832 /// module. The symbols in this list and LazySymbols are used to add
833 /// special linker symbols which ensure that Objective-C modules are
834 /// linked properly.
Daniel Dunbard027a922009-09-07 00:20:42 +0000835 llvm::SetVector<IdentifierInfo*> DefinedSymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000836
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000837 /// ClassNames - uniqued class names.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000838 llvm::StringMap<llvm::GlobalVariable*> ClassNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000839
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000840 /// MethodVarNames - uniqued method variable names.
841 llvm::DenseMap<Selector, llvm::GlobalVariable*> MethodVarNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000842
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000843 /// DefinedCategoryNames - list of category names in form Class_Category.
Justin Lebar5e83dfe2016-10-21 21:45:01 +0000844 llvm::SmallSetVector<llvm::CachedHashString, 16> DefinedCategoryNames;
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000845
Daniel Dunbarb036db82008-08-13 03:21:16 +0000846 /// MethodVarTypes - uniqued method type signatures. We have to use
847 /// a StringMap here because have no other unique reference.
848 llvm::StringMap<llvm::GlobalVariable*> MethodVarTypes;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000849
Daniel Dunbar3c76cb52008-08-26 21:51:14 +0000850 /// MethodDefinitions - map of methods which have been defined in
851 /// this translation unit.
852 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*> MethodDefinitions;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000853
Daniel Dunbar80a840b2008-08-23 00:19:03 +0000854 /// PropertyNames - uniqued method variable names.
855 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> PropertyNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000856
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000857 /// ClassReferences - uniqued class references.
858 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> ClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000859
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000860 /// SelectorReferences - uniqued selector references.
861 llvm::DenseMap<Selector, llvm::GlobalVariable*> SelectorReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000862
Daniel Dunbarb036db82008-08-13 03:21:16 +0000863 /// Protocols - Protocols for which an objc_protocol structure has
864 /// been emitted. Forward declarations are handled by creating an
865 /// empty structure whose initializer is filled in when/if defined.
866 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> Protocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000867
Daniel Dunbarc475d422008-10-29 22:36:39 +0000868 /// DefinedProtocols - Protocols which have actually been
869 /// defined. We should not need this, see FIXME in GenerateProtocol.
870 llvm::DenseSet<IdentifierInfo*> DefinedProtocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000871
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000872 /// DefinedClasses - List of defined classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000873 SmallVector<llvm::GlobalValue*, 16> DefinedClasses;
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +0000874
875 /// ImplementedClasses - List of @implemented classes.
876 SmallVector<const ObjCInterfaceDecl*, 16> ImplementedClasses;
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000877
878 /// DefinedNonLazyClasses - List of defined "non-lazy" classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000879 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyClasses;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000880
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000881 /// DefinedCategories - List of defined categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000882 SmallVector<llvm::GlobalValue*, 16> DefinedCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000883
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000884 /// DefinedNonLazyCategories - List of defined "non-lazy" categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000885 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000886
John McCallcd21d542016-11-30 23:15:55 +0000887 /// Cached reference to the class for constant strings. This value has type
888 /// int * but is actually an Obj-C class pointer.
Sanjoy Dase369bd92017-05-01 17:08:00 +0000889 llvm::WeakTrackingVH ConstantStringClassRef;
John McCallcd21d542016-11-30 23:15:55 +0000890
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000891 /// The LLVM type corresponding to NSConstantString.
John McCallcd21d542016-11-30 23:15:55 +0000892 llvm::StructType *NSConstantStringType = nullptr;
893
894 llvm::StringMap<llvm::GlobalVariable *> NSConstantStringMap;
895
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000896 /// GetNameForMethod - Return a name for the given method.
897 /// \param[out] NameOut - The return value.
898 void GetNameForMethod(const ObjCMethodDecl *OMD,
899 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000900 SmallVectorImpl<char> &NameOut);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000901
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000902 /// GetMethodVarName - Return a unique constant for the given
903 /// selector's name. The return value has type char *.
904 llvm::Constant *GetMethodVarName(Selector Sel);
905 llvm::Constant *GetMethodVarName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000906
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000907 /// GetMethodVarType - Return a unique constant for the given
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000908 /// method's type encoding string. The return value has type char *.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000909
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000910 // FIXME: This is a horrible name.
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000911 llvm::Constant *GetMethodVarType(const ObjCMethodDecl *D,
912 bool Extended = false);
Daniel Dunbarf5c18462009-04-20 06:54:31 +0000913 llvm::Constant *GetMethodVarType(const FieldDecl *D);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000914
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000915 /// GetPropertyName - Return a unique constant for the given
916 /// name. The return value has type char *.
917 llvm::Constant *GetPropertyName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000918
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000919 // FIXME: This can be dropped once string functions are unified.
920 llvm::Constant *GetPropertyTypeString(const ObjCPropertyDecl *PD,
921 const Decl *Container);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000922
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +0000923 /// GetClassName - Return a unique constant for the given selector's
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000924 /// runtime name (which may change via use of objc_runtime_name attribute on
925 /// class or protocol definition. The return value has type char *.
926 llvm::Constant *GetClassName(StringRef RuntimeName);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000927
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +0000928 llvm::Function *GetMethodDefinition(const ObjCMethodDecl *MD);
929
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +0000930 /// BuildIvarLayout - Builds ivar layout bitmap for the class
931 /// implementation for the __strong or __weak case.
932 ///
John McCall460ce582015-10-22 18:38:17 +0000933 /// \param hasMRCWeakIvars - Whether we are compiling in MRC and there
934 /// are any weak ivars defined directly in the class. Meaningless unless
935 /// building a weak layout. Does not guarantee that the layout will
936 /// actually have any entries, because the ivar might be under-aligned.
Fariborz Jahanian1bf72882009-03-12 22:50:49 +0000937 llvm::Constant *BuildIvarLayout(const ObjCImplementationDecl *OI,
John McCall3fd13f062015-10-21 18:06:47 +0000938 CharUnits beginOffset,
939 CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +0000940 bool forStrongLayout,
941 bool hasMRCWeakIvars);
942
943 llvm::Constant *BuildStrongIvarLayout(const ObjCImplementationDecl *OI,
944 CharUnits beginOffset,
945 CharUnits endOffset) {
946 return BuildIvarLayout(OI, beginOffset, endOffset, true, false);
947 }
948
949 llvm::Constant *BuildWeakIvarLayout(const ObjCImplementationDecl *OI,
950 CharUnits beginOffset,
951 CharUnits endOffset,
952 bool hasMRCWeakIvars) {
953 return BuildIvarLayout(OI, beginOffset, endOffset, false, hasMRCWeakIvars);
954 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +0000955
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000956 Qualifiers::ObjCLifetime getBlockCaptureLifetime(QualType QT, bool ByrefLayout);
Fariborz Jahanian2dd78192012-11-02 22:51:18 +0000957
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000958 void UpdateRunSkipBlockVars(bool IsByref,
959 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000960 CharUnits FieldOffset,
961 CharUnits FieldSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000962
963 void BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000964 CharUnits BytePos, bool &HasUnion,
965 bool ByrefLayout=false);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000966
967 void BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
968 const RecordDecl *RD,
969 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000970 CharUnits BytePos, bool &HasUnion,
971 bool ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000972
Fariborz Jahanian23290b02012-11-01 18:32:55 +0000973 uint64_t InlineLayoutInstruction(SmallVectorImpl<unsigned char> &Layout);
974
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000975 llvm::Constant *getBitmapBlockLayout(bool ComputeByrefLayout);
976
Fariborz Jahanian01dff422009-03-05 19:17:31 +0000977 /// GetIvarLayoutName - Returns a unique constant for the given
978 /// ivar layout bitmap.
979 llvm::Constant *GetIvarLayoutName(IdentifierInfo *Ident,
980 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000981
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000982 /// EmitPropertyList - Emit the given property list. The return
983 /// value has type PropertyListPtrTy.
Zachary Turner41a9ee92017-10-11 23:54:34 +0000984 llvm::Constant *EmitPropertyList(Twine Name,
985 const Decl *Container,
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000986 const ObjCContainerDecl *OCD,
Manman Renad0e7912016-01-29 19:22:54 +0000987 const ObjCCommonTypesHelper &ObjCTypes,
988 bool IsClassProperty);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000989
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000990 /// EmitProtocolMethodTypes - Generate the array of extended method type
991 /// strings. The return value has type Int8PtrPtrTy.
Zachary Turner41a9ee92017-10-11 23:54:34 +0000992 llvm::Constant *EmitProtocolMethodTypes(Twine Name,
993 ArrayRef<llvm::Constant*> MethodTypes,
994 const ObjCCommonTypesHelper &ObjCTypes);
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000995
Fariborz Jahanian56b3b772009-01-29 19:24:30 +0000996 /// GetProtocolRef - Return a reference to the internal protocol
997 /// description, creating an empty one if it has not been
998 /// defined. The return value has type ProtocolPtrTy.
999 llvm::Constant *GetProtocolRef(const ObjCProtocolDecl *PD);
Fariborz Jahanian67726212009-03-08 20:18:37 +00001000
Douglas Gregor24ae22c2016-04-01 23:23:52 +00001001 /// Return a reference to the given Class using runtime calls rather than
1002 /// by a symbol reference.
1003 llvm::Value *EmitClassRefViaRuntime(CodeGenFunction &CGF,
1004 const ObjCInterfaceDecl *ID,
1005 ObjCCommonTypesHelper &ObjCTypes);
1006
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00001007 std::string GetSectionName(StringRef Section, StringRef MachOAttributes);
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
John McCall176f8922016-11-30 02:39:18 +00001019 /// 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
John McCall176f8922016-11-30 02:39:18 +00001023 /// "llvm.used".
Zachary Turner41a9ee92017-10-11 23:54:34 +00001024 llvm::GlobalVariable *CreateMetadataVar(Twine Name,
John McCall176f8922016-11-30 02:39:18 +00001025 ConstantStructBuilder &Init,
1026 StringRef Section, CharUnits Align,
1027 bool AddToUsed);
Zachary Turner41a9ee92017-10-11 23:54:34 +00001028 llvm::GlobalVariable *CreateMetadataVar(Twine Name,
John McCall176f8922016-11-30 02:39:18 +00001029 llvm::Constant *Init,
John McCall7f416cc2015-09-08 08:05:57 +00001030 StringRef Section, CharUnits Align,
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001031 bool AddToUsed);
Daniel Dunbar30c65362009-03-09 20:09:19 +00001032
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00001033 llvm::GlobalVariable *CreateCStringLiteral(StringRef Name,
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00001034 ObjCLabelType LabelType,
1035 bool ForceNonFragileABI = false,
1036 bool NullTerminate = true);
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00001037
John McCall3fd13f062015-10-21 18:06:47 +00001038protected:
John McCall9e8bb002011-05-14 03:10:52 +00001039 CodeGen::RValue EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1040 ReturnValueSlot Return,
1041 QualType ResultType,
1042 llvm::Value *Sel,
1043 llvm::Value *Arg0,
1044 QualType Arg0Ty,
1045 bool IsSuper,
1046 const CallArgList &CallArgs,
1047 const ObjCMethodDecl *OMD,
John McCall1e3157b2015-09-10 22:27:50 +00001048 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001049 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbarf5c18462009-04-20 06:54:31 +00001050
Daniel Dunbar5e639272010-04-25 20:39:01 +00001051 /// EmitImageInfo - Emit the image info marker used to encode some module
1052 /// level information.
1053 void EmitImageInfo();
1054
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001055public:
Owen Andersonae86c192009-07-13 04:10:07 +00001056 CGObjCCommonMac(CodeGen::CodeGenModule &cgm) :
John McCalla729c622012-02-17 03:33:10 +00001057 CGObjCRuntime(cgm), VMContext(cgm.getLLVMContext()) { }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001058
John McCall3fd13f062015-10-21 18:06:47 +00001059 bool isNonFragileABI() const {
1060 return ObjCABI == 2;
1061 }
1062
John McCall7f416cc2015-09-08 08:05:57 +00001063 ConstantAddress GenerateConstantString(const StringLiteral *SL) override;
John McCallcd21d542016-11-30 23:15:55 +00001064 ConstantAddress GenerateConstantNSString(const StringLiteral *SL);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001065
Craig Topper4f12f102014-03-12 06:41:41 +00001066 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
Craig Topper8a13c412014-05-21 05:09:00 +00001067 const ObjCContainerDecl *CD=nullptr) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001068
1069 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001070
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001071 /// GetOrEmitProtocol - Get the protocol object for the given
1072 /// declaration, emitting it if necessary. The return value has type
1073 /// ProtocolPtrTy.
1074 virtual llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD)=0;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001075
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001076 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1077 /// object for the given declaration, emitting it if needed. These
1078 /// forward references will be filled in with empty bodies if no
1079 /// definition is seen. The return value has type ProtocolPtrTy.
1080 virtual llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD)=0;
John McCallcd21d542016-11-30 23:15:55 +00001081
1082 virtual llvm::Constant *getNSConstantStringClassRef() = 0;
1083
Craig Topper4f12f102014-03-12 06:41:41 +00001084 llvm::Constant *BuildGCBlockLayout(CodeGen::CodeGenModule &CGM,
1085 const CGBlockInfo &blockInfo) override;
1086 llvm::Constant *BuildRCBlockLayout(CodeGen::CodeGenModule &CGM,
1087 const CGBlockInfo &blockInfo) override;
1088
1089 llvm::Constant *BuildByrefLayout(CodeGen::CodeGenModule &CGM,
1090 QualType T) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001091};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001092
John McCall176f8922016-11-30 02:39:18 +00001093namespace {
1094
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00001095enum class MethodListType {
1096 CategoryInstanceMethods,
1097 CategoryClassMethods,
1098 InstanceMethods,
1099 ClassMethods,
1100 ProtocolInstanceMethods,
1101 ProtocolClassMethods,
1102 OptionalProtocolInstanceMethods,
1103 OptionalProtocolClassMethods,
1104};
1105
John McCall176f8922016-11-30 02:39:18 +00001106/// A convenience class for splitting the methods of a protocol into
1107/// the four interesting groups.
1108class ProtocolMethodLists {
1109public:
1110 enum Kind {
1111 RequiredInstanceMethods,
1112 RequiredClassMethods,
1113 OptionalInstanceMethods,
1114 OptionalClassMethods
1115 };
1116 enum {
1117 NumProtocolMethodLists = 4
1118 };
1119
1120 static MethodListType getMethodListKind(Kind kind) {
1121 switch (kind) {
1122 case RequiredInstanceMethods:
1123 return MethodListType::ProtocolInstanceMethods;
1124 case RequiredClassMethods:
1125 return MethodListType::ProtocolClassMethods;
1126 case OptionalInstanceMethods:
1127 return MethodListType::OptionalProtocolInstanceMethods;
1128 case OptionalClassMethods:
1129 return MethodListType::OptionalProtocolClassMethods;
1130 }
1131 llvm_unreachable("bad kind");
1132 }
1133
1134 SmallVector<const ObjCMethodDecl *, 4> Methods[NumProtocolMethodLists];
1135
1136 static ProtocolMethodLists get(const ObjCProtocolDecl *PD) {
1137 ProtocolMethodLists result;
1138
1139 for (auto MD : PD->methods()) {
1140 size_t index = (2 * size_t(MD->isOptional()))
1141 + (size_t(MD->isClassMethod()));
1142 result.Methods[index].push_back(MD);
1143 }
1144
1145 return result;
1146 }
1147
1148 template <class Self>
1149 SmallVector<llvm::Constant*, 8> emitExtendedTypesArray(Self *self) const {
1150 // In both ABIs, the method types list is parallel with the
1151 // concatenation of the methods arrays in the following order:
1152 // instance methods
1153 // class methods
1154 // optional instance methods
1155 // optional class methods
1156 SmallVector<llvm::Constant*, 8> result;
1157
1158 // Methods is already in the correct order for both ABIs.
1159 for (auto &list : Methods) {
1160 for (auto MD : list) {
1161 result.push_back(self->GetMethodVarType(MD, true));
1162 }
1163 }
1164
1165 return result;
1166 }
1167
1168 template <class Self>
1169 llvm::Constant *emitMethodList(Self *self, const ObjCProtocolDecl *PD,
1170 Kind kind) const {
1171 return self->emitMethodList(PD->getObjCRuntimeNameAsString(),
1172 getMethodListKind(kind), Methods[kind]);
1173 }
1174};
1175
1176} // end anonymous namespace
1177
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001178class CGObjCMac : public CGObjCCommonMac {
1179private:
John McCallc4ae1dd2016-11-30 04:18:19 +00001180 friend ProtocolMethodLists;
John McCall176f8922016-11-30 02:39:18 +00001181
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001182 ObjCTypesHelper ObjCTypes;
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001183
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001184 /// EmitModuleInfo - Another marker encoding module level
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001185 /// information.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001186 void EmitModuleInfo();
1187
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001188 /// EmitModuleSymols - Emit module symbols, the list of defined
1189 /// classes and categories. The result has type SymtabPtrTy.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001190 llvm::Constant *EmitModuleSymbols();
1191
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001192 /// FinishModule - Write out global data structures at the end of
1193 /// processing a translation unit.
1194 void FinishModule();
Daniel Dunbarb036db82008-08-13 03:21:16 +00001195
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001196 /// EmitClassExtension - Generate the class extension structure used
1197 /// to store the weak ivar layout and properties. The return value
1198 /// has type ClassExtensionPtrTy.
John McCall3fd13f062015-10-21 18:06:47 +00001199 llvm::Constant *EmitClassExtension(const ObjCImplementationDecl *ID,
John McCall460ce582015-10-22 18:38:17 +00001200 CharUnits instanceSize,
Manman Renad0e7912016-01-29 19:22:54 +00001201 bool hasMRCWeakIvars,
John McCall176f8922016-11-30 02:39:18 +00001202 bool isMetaclass);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001203
1204 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1205 /// for the given class.
John McCall882987f2013-02-28 19:01:20 +00001206 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001207 const ObjCInterfaceDecl *ID);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001208
John McCall882987f2013-02-28 19:01:20 +00001209 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00001210 IdentifierInfo *II);
Craig Topper4f12f102014-03-12 06:41:41 +00001211
1212 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
1213
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001214 /// EmitSuperClassRef - Emits reference to class's main metadata class.
1215 llvm::Value *EmitSuperClassRef(const ObjCInterfaceDecl *ID);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001216
1217 /// EmitIvarList - Emit the ivar list for the given
1218 /// implementation. If ForClass is true the list of class ivars
1219 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1220 /// interface ivars will be emitted. The return value has type
1221 /// IvarListPtrTy.
1222 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00001223 bool ForClass);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001224
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001225 /// EmitMetaClass - Emit a forward reference to the class structure
1226 /// for the metaclass of the given interface. The return value has
1227 /// type ClassPtrTy.
1228 llvm::Constant *EmitMetaClassRef(const ObjCInterfaceDecl *ID);
1229
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001230 /// EmitMetaClass - Emit a class structure for the metaclass of the
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001231 /// given implementation. The return value has type ClassPtrTy.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001232 llvm::Constant *EmitMetaClass(const ObjCImplementationDecl *ID,
1233 llvm::Constant *Protocols,
John McCall176f8922016-11-30 02:39:18 +00001234 ArrayRef<const ObjCMethodDecl *> Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001235
John McCall176f8922016-11-30 02:39:18 +00001236 void emitMethodConstant(ConstantArrayBuilder &builder,
1237 const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001238
John McCall176f8922016-11-30 02:39:18 +00001239 void emitMethodDescriptionConstant(ConstantArrayBuilder &builder,
1240 const ObjCMethodDecl *MD);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001241
1242 /// EmitMethodList - Emit the method list for the given
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001243 /// implementation. The return value has type MethodListPtrTy.
Zachary Turner41a9ee92017-10-11 23:54:34 +00001244 llvm::Constant *emitMethodList(Twine Name, MethodListType MLT,
John McCall176f8922016-11-30 02:39:18 +00001245 ArrayRef<const ObjCMethodDecl *> Methods);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001246
Daniel Dunbarc475d422008-10-29 22:36:39 +00001247 /// GetOrEmitProtocol - Get the protocol object for the given
1248 /// declaration, emitting it if necessary. The return value has type
1249 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001250 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001251
1252 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1253 /// object for the given declaration, emitting it if needed. These
1254 /// forward references will be filled in with empty bodies if no
1255 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001256 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001257
Daniel Dunbarb036db82008-08-13 03:21:16 +00001258 /// EmitProtocolExtension - Generate the protocol extension
1259 /// structure used to store optional instance and class methods, and
1260 /// protocol properties. The return value has type
1261 /// ProtocolExtensionPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001262 llvm::Constant *
1263 EmitProtocolExtension(const ObjCProtocolDecl *PD,
John McCall176f8922016-11-30 02:39:18 +00001264 const ProtocolMethodLists &methodLists);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001265
1266 /// EmitProtocolList - Generate the list of referenced
1267 /// protocols. The return value has type ProtocolListPtrTy.
Zachary Turner41a9ee92017-10-11 23:54:34 +00001268 llvm::Constant *EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00001269 ObjCProtocolDecl::protocol_iterator begin,
1270 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001271
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001272 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1273 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001274 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1275 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001276
1277public:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001278 CGObjCMac(CodeGen::CodeGenModule &cgm);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001279
John McCallcd21d542016-11-30 23:15:55 +00001280 llvm::Constant *getNSConstantStringClassRef() override;
1281
Craig Topper4f12f102014-03-12 06:41:41 +00001282 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001283
Craig Topper4f12f102014-03-12 06:41:41 +00001284 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1285 ReturnValueSlot Return,
1286 QualType ResultType,
1287 Selector Sel, llvm::Value *Receiver,
1288 const CallArgList &CallArgs,
1289 const ObjCInterfaceDecl *Class,
1290 const ObjCMethodDecl *Method) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001291
Craig Topper4f12f102014-03-12 06:41:41 +00001292 CodeGen::RValue
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001293 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001294 ReturnValueSlot Return, QualType ResultType,
1295 Selector Sel, const ObjCInterfaceDecl *Class,
1296 bool isCategoryImpl, llvm::Value *Receiver,
1297 bool IsClassMessage, const CallArgList &CallArgs,
1298 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001299
Craig Topper4f12f102014-03-12 06:41:41 +00001300 llvm::Value *GetClass(CodeGenFunction &CGF,
1301 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001302
John McCall7f416cc2015-09-08 08:05:57 +00001303 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
1304 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001305
1306 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1307 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001308 llvm::Value *GetSelector(CodeGenFunction &CGF,
1309 const ObjCMethodDecl *Method) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001310
Craig Topper4f12f102014-03-12 06:41:41 +00001311 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001312
Craig Topper4f12f102014-03-12 06:41:41 +00001313 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001314
Craig Topper4f12f102014-03-12 06:41:41 +00001315 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001316
Craig Topper4f12f102014-03-12 06:41:41 +00001317 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001318
Craig Topper4f12f102014-03-12 06:41:41 +00001319 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1320 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001321
Craig Topper4f12f102014-03-12 06:41:41 +00001322 llvm::Constant *GetPropertyGetFunction() override;
1323 llvm::Constant *GetPropertySetFunction() override;
1324 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1325 bool copy) override;
1326 llvm::Constant *GetGetStructFunction() override;
1327 llvm::Constant *GetSetStructFunction() override;
1328 llvm::Constant *GetCppAtomicObjectGetFunction() override;
1329 llvm::Constant *GetCppAtomicObjectSetFunction() override;
1330 llvm::Constant *EnumerationMutationFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001331
Craig Topper4f12f102014-03-12 06:41:41 +00001332 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1333 const ObjCAtTryStmt &S) override;
1334 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1335 const ObjCAtSynchronizedStmt &S) override;
John McCallbd309292010-07-06 01:34:17 +00001336 void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, const Stmt &S);
Craig Topper4f12f102014-03-12 06:41:41 +00001337 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1338 bool ClearInsertionPoint=true) override;
1339 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001340 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001341 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001342 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001343 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001344 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001345 bool threadlocal = false) override;
1346 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001347 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001348 llvm::Value *ivarOffset) override;
1349 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001350 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001351 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001352 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001353 llvm::Value *size) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001354
Craig Topper4f12f102014-03-12 06:41:41 +00001355 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1356 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1357 unsigned CVRQualifiers) override;
1358 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1359 const ObjCInterfaceDecl *Interface,
1360 const ObjCIvarDecl *Ivar) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001361};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001362
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001363class CGObjCNonFragileABIMac : public CGObjCCommonMac {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001364private:
John McCallc4ae1dd2016-11-30 04:18:19 +00001365 friend ProtocolMethodLists;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001366 ObjCNonFragileABITypesHelper ObjCTypes;
Fariborz Jahanian71394042009-01-23 23:53:38 +00001367 llvm::GlobalVariable* ObjCEmptyCacheVar;
John McCall176f8922016-11-30 02:39:18 +00001368 llvm::Constant* ObjCEmptyVtableVar;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001369
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001370 /// SuperClassReferences - uniqued super class references.
1371 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> SuperClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001372
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001373 /// MetaClassReferences - uniqued meta class references.
1374 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> MetaClassReferences;
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001375
1376 /// EHTypeReferences - uniqued class ehtype references.
1377 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> EHTypeReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001378
John McCall9e8bb002011-05-14 03:10:52 +00001379 /// VTableDispatchMethods - List of methods for which we generate
1380 /// vtable-based message dispatch.
1381 llvm::DenseSet<Selector> VTableDispatchMethods;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001382
Fariborz Jahanian67260552009-11-17 21:37:35 +00001383 /// DefinedMetaClasses - List of defined meta-classes.
1384 std::vector<llvm::GlobalValue*> DefinedMetaClasses;
1385
John McCall9e8bb002011-05-14 03:10:52 +00001386 /// isVTableDispatchedSelector - Returns true if SEL is a
1387 /// vtable-based selector.
1388 bool isVTableDispatchedSelector(Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001389
Fariborz Jahanian71394042009-01-23 23:53:38 +00001390 /// FinishNonFragileABIModule - Write out global data structures at the end of
1391 /// processing a translation unit.
1392 void FinishNonFragileABIModule();
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001393
Daniel Dunbar19573e72009-05-15 21:48:48 +00001394 /// AddModuleClassList - Add the given list of class pointers to the
1395 /// module with the provided symbol and section names.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001396 void AddModuleClassList(ArrayRef<llvm::GlobalValue *> Container,
1397 StringRef SymbolName, StringRef SectionName);
Daniel Dunbar19573e72009-05-15 21:48:48 +00001398
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001399 llvm::GlobalVariable * BuildClassRoTInitializer(unsigned flags,
1400 unsigned InstanceStart,
1401 unsigned InstanceSize,
1402 const ObjCImplementationDecl *ID);
John McCalldba63a72016-11-30 23:54:50 +00001403 llvm::GlobalVariable *BuildClassObject(const ObjCInterfaceDecl *CI,
1404 bool isMetaclass,
1405 llvm::Constant *IsAGV,
1406 llvm::Constant *SuperClassGV,
1407 llvm::Constant *ClassRoGV,
1408 bool HiddenVisibility);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001409
John McCall176f8922016-11-30 02:39:18 +00001410 void emitMethodConstant(ConstantArrayBuilder &builder,
1411 const ObjCMethodDecl *MD,
1412 bool forProtocol);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001413
John McCall176f8922016-11-30 02:39:18 +00001414 /// Emit the method list for the given implementation. The return value
1415 /// has type MethodListnfABITy.
Zachary Turner41a9ee92017-10-11 23:54:34 +00001416 llvm::Constant *emitMethodList(Twine Name, MethodListType MLT,
John McCall176f8922016-11-30 02:39:18 +00001417 ArrayRef<const ObjCMethodDecl *> Methods);
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00001418
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00001419 /// EmitIvarList - Emit the ivar list for the given
1420 /// implementation. If ForClass is true the list of class ivars
1421 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1422 /// interface ivars will be emitted. The return value has type
1423 /// IvarListnfABIPtrTy.
1424 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001425
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001426 llvm::Constant *EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00001427 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00001428 unsigned long int offset);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001429
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001430 /// GetOrEmitProtocol - Get the protocol object for the given
1431 /// declaration, emitting it if necessary. The return value has type
1432 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001433 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001434
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001435 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1436 /// object for the given declaration, emitting it if needed. These
1437 /// forward references will be filled in with empty bodies if no
1438 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001439 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001440
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001441 /// EmitProtocolList - Generate the list of referenced
1442 /// protocols. The return value has type ProtocolListPtrTy.
Zachary Turner41a9ee92017-10-11 23:54:34 +00001443 llvm::Constant *EmitProtocolList(Twine Name,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001444 ObjCProtocolDecl::protocol_iterator begin,
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00001445 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001446
John McCall9e8bb002011-05-14 03:10:52 +00001447 CodeGen::RValue EmitVTableMessageSend(CodeGen::CodeGenFunction &CGF,
1448 ReturnValueSlot Return,
1449 QualType ResultType,
1450 Selector Sel,
1451 llvm::Value *Receiver,
1452 QualType Arg0Ty,
1453 bool IsSuper,
1454 const CallArgList &CallArgs,
1455 const ObjCMethodDecl *Method);
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001456
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00001457 /// GetClassGlobal - Return the global variable for the Objective-C
1458 /// class of the given name.
John McCalldba63a72016-11-30 23:54:50 +00001459 llvm::Constant *GetClassGlobal(StringRef Name,
1460 ForDefinition_t IsForDefinition,
1461 bool Weak = false, bool DLLImport = false);
1462 llvm::Constant *GetClassGlobal(const ObjCInterfaceDecl *ID,
1463 bool isMetaclass,
1464 ForDefinition_t isForDefinition);
Rafael Espindola554256c2014-02-26 22:25:45 +00001465
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00001466 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001467 /// for the given class reference.
John McCall882987f2013-02-28 19:01:20 +00001468 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001469 const ObjCInterfaceDecl *ID);
John McCall31168b02011-06-15 23:02:42 +00001470
John McCall882987f2013-02-28 19:01:20 +00001471 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCalldba63a72016-11-30 23:54:50 +00001472 IdentifierInfo *II,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001473 const ObjCInterfaceDecl *ID);
Craig Topper4f12f102014-03-12 06:41:41 +00001474
1475 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001476
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001477 /// EmitSuperClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1478 /// for the given super class reference.
John McCall882987f2013-02-28 19:01:20 +00001479 llvm::Value *EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001480 const ObjCInterfaceDecl *ID);
1481
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001482 /// EmitMetaClassRef - Return a Value * of the address of _class_t
1483 /// meta-data
John McCall882987f2013-02-28 19:01:20 +00001484 llvm::Value *EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00001485 const ObjCInterfaceDecl *ID, bool Weak);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001486
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001487 /// ObjCIvarOffsetVariable - Returns the ivar offset variable for
1488 /// the given ivar.
1489 ///
Daniel Dunbara1060522009-04-19 00:31:15 +00001490 llvm::GlobalVariable * ObjCIvarOffsetVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001491 const ObjCInterfaceDecl *ID,
1492 const ObjCIvarDecl *Ivar);
1493
Fariborz Jahanian74b77222009-02-11 20:51:17 +00001494 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1495 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001496 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1497 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001498
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001499 /// GetInterfaceEHType - Get the cached ehtype for the given Objective-C
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001500 /// interface. The return value has type EHTypePtrTy.
John McCall2ca705e2010-07-24 00:37:23 +00001501 llvm::Constant *GetInterfaceEHType(const ObjCInterfaceDecl *ID,
John McCalldba63a72016-11-30 23:54:50 +00001502 ForDefinition_t IsForDefinition);
Daniel Dunbar15894b72009-04-07 05:48:37 +00001503
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001504 StringRef getMetaclassSymbolPrefix() const { return "OBJC_METACLASS_$_"; }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001505
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001506 StringRef getClassSymbolPrefix() const { return "OBJC_CLASS_$_"; }
Daniel Dunbar15894b72009-04-07 05:48:37 +00001507
Daniel Dunbar961202372009-05-03 12:57:56 +00001508 void GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00001509 uint32_t &InstanceStart,
1510 uint32_t &InstanceSize);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001511
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001512 // Shamelessly stolen from Analysis/CFRefCount.cpp
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001513 Selector GetNullarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001514 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1515 return CGM.getContext().Selectors.getSelector(0, &II);
1516 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001517
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001518 Selector GetUnarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001519 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1520 return CGM.getContext().Selectors.getSelector(1, &II);
1521 }
Daniel Dunbar554fd792009-04-19 23:41:48 +00001522
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001523 /// ImplementationIsNonLazy - Check whether the given category or
1524 /// class implementation is "non-lazy".
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00001525 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001526
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001527 bool IsIvarOffsetKnownIdempotent(const CodeGen::CodeGenFunction &CGF,
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001528 const ObjCIvarDecl *IV) {
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001529 // Annotate the load as an invariant load iff inside an instance method
1530 // and ivar belongs to instance method's class and one of its super class.
1531 // This check is needed because the ivar offset is a lazily
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001532 // initialised value that may depend on objc_msgSend to perform a fixup on
1533 // the first message dispatch.
1534 //
1535 // An additional opportunity to mark the load as invariant arises when the
1536 // base of the ivar access is a parameter to an Objective C method.
1537 // However, because the parameters are not available in the current
1538 // interface, we cannot perform this check.
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001539 if (const ObjCMethodDecl *MD =
1540 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurFuncDecl))
Fariborz Jahanian7a583022014-03-04 22:57:32 +00001541 if (MD->isInstanceMethod())
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001542 if (const ObjCInterfaceDecl *ID = MD->getClassInterface())
1543 return IV->getContainingInterface()->isSuperClassOf(ID);
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001544 return false;
1545 }
1546
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001547public:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001548 CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm);
John McCallcd21d542016-11-30 23:15:55 +00001549
1550 llvm::Constant *getNSConstantStringClassRef() override;
1551
Craig Topper4f12f102014-03-12 06:41:41 +00001552 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001553
Craig Topper4f12f102014-03-12 06:41:41 +00001554 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1555 ReturnValueSlot Return,
1556 QualType ResultType, Selector Sel,
1557 llvm::Value *Receiver,
1558 const CallArgList &CallArgs,
1559 const ObjCInterfaceDecl *Class,
1560 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001561
Craig Topper4f12f102014-03-12 06:41:41 +00001562 CodeGen::RValue
Fariborz Jahanian71394042009-01-23 23:53:38 +00001563 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001564 ReturnValueSlot Return, QualType ResultType,
1565 Selector Sel, const ObjCInterfaceDecl *Class,
1566 bool isCategoryImpl, llvm::Value *Receiver,
1567 bool IsClassMessage, const CallArgList &CallArgs,
1568 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001569
Craig Topper4f12f102014-03-12 06:41:41 +00001570 llvm::Value *GetClass(CodeGenFunction &CGF,
1571 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001572
John McCall7f416cc2015-09-08 08:05:57 +00001573 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override
1574 { return EmitSelector(CGF, Sel); }
1575 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override
1576 { return EmitSelectorAddr(CGF, Sel); }
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001577
1578 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1579 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001580 llvm::Value *GetSelector(CodeGenFunction &CGF,
1581 const ObjCMethodDecl *Method) override
John McCall882987f2013-02-28 19:01:20 +00001582 { return EmitSelector(CGF, Method->getSelector()); }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001583
Craig Topper4f12f102014-03-12 06:41:41 +00001584 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001585
Craig Topper4f12f102014-03-12 06:41:41 +00001586 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
David Chisnall92d436b2012-01-31 18:59:20 +00001587
Craig Topper4f12f102014-03-12 06:41:41 +00001588 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001589
Craig Topper4f12f102014-03-12 06:41:41 +00001590 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1591 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001592
Craig Topper4f12f102014-03-12 06:41:41 +00001593 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001594
Craig Topper4f12f102014-03-12 06:41:41 +00001595 llvm::Constant *GetPropertyGetFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001596 return ObjCTypes.getGetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001597 }
Craig Topper4f12f102014-03-12 06:41:41 +00001598 llvm::Constant *GetPropertySetFunction() override {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001599 return ObjCTypes.getSetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001600 }
Craig Topper4f12f102014-03-12 06:41:41 +00001601
1602 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1603 bool copy) override {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001604 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
1605 }
Craig Topper4f12f102014-03-12 06:41:41 +00001606
1607 llvm::Constant *GetSetStructFunction() override {
David Chisnall168b80f2010-12-26 22:13:16 +00001608 return ObjCTypes.getCopyStructFn();
1609 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001610
Craig Topper4f12f102014-03-12 06:41:41 +00001611 llvm::Constant *GetGetStructFunction() override {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00001612 return ObjCTypes.getCopyStructFn();
1613 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001614
Craig Topper4f12f102014-03-12 06:41:41 +00001615 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +00001616 return ObjCTypes.getCppAtomicObjectFunction();
1617 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001618
Craig Topper4f12f102014-03-12 06:41:41 +00001619 llvm::Constant *GetCppAtomicObjectGetFunction() override {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00001620 return ObjCTypes.getCppAtomicObjectFunction();
1621 }
Craig Topper4f12f102014-03-12 06:41:41 +00001622
1623 llvm::Constant *EnumerationMutationFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001624 return ObjCTypes.getEnumerationMutationFn();
Daniel Dunbard73ea8162009-02-16 18:48:45 +00001625 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001626
Craig Topper4f12f102014-03-12 06:41:41 +00001627 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1628 const ObjCAtTryStmt &S) override;
1629 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1630 const ObjCAtSynchronizedStmt &S) override;
1631 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1632 bool ClearInsertionPoint=true) override;
1633 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001634 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001635 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001636 llvm::Value *src, Address edst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001637 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001638 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001639 bool threadlocal = false) override;
1640 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001641 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001642 llvm::Value *ivarOffset) override;
1643 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001644 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001645 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001646 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001647 llvm::Value *size) override;
1648 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1649 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1650 unsigned CVRQualifiers) override;
1651 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1652 const ObjCInterfaceDecl *Interface,
1653 const ObjCIvarDecl *Ivar) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001654};
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001655
1656/// A helper class for performing the null-initialization of a return
1657/// value.
1658struct NullReturnState {
1659 llvm::BasicBlock *NullBB;
Craig Topper8a13c412014-05-21 05:09:00 +00001660 NullReturnState() : NullBB(nullptr) {}
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001661
John McCall3d1e2c92013-02-12 05:53:35 +00001662 /// Perform a null-check of the given receiver.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001663 void init(CodeGenFunction &CGF, llvm::Value *receiver) {
John McCall3d1e2c92013-02-12 05:53:35 +00001664 // Make blocks for the null-receiver and call edges.
1665 NullBB = CGF.createBasicBlock("msgSend.null-receiver");
1666 llvm::BasicBlock *callBB = CGF.createBasicBlock("msgSend.call");
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001667
1668 // Check for a null receiver and, if there is one, jump to the
John McCall3d1e2c92013-02-12 05:53:35 +00001669 // null-receiver block. There's no point in trying to avoid it:
1670 // we're always going to put *something* there, because otherwise
1671 // we shouldn't have done this null-check in the first place.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001672 llvm::Value *isNull = CGF.Builder.CreateIsNull(receiver);
1673 CGF.Builder.CreateCondBr(isNull, NullBB, callBB);
1674
1675 // Otherwise, start performing the call.
1676 CGF.EmitBlock(callBB);
1677 }
1678
John McCall3d1e2c92013-02-12 05:53:35 +00001679 /// Complete the null-return operation. It is valid to call this
1680 /// regardless of whether 'init' has been called.
Kuba Mracekbce5cea2017-06-30 16:28:15 +00001681 RValue complete(CodeGenFunction &CGF,
1682 ReturnValueSlot returnSlot,
1683 RValue result,
1684 QualType resultType,
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001685 const CallArgList &CallArgs,
1686 const ObjCMethodDecl *Method) {
John McCall3d1e2c92013-02-12 05:53:35 +00001687 // If we never had to do a null-check, just use the raw result.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001688 if (!NullBB) return result;
John McCall3d1e2c92013-02-12 05:53:35 +00001689
1690 // The continuation block. This will be left null if we don't have an
1691 // IP, which can happen if the method we're calling is marked noreturn.
Craig Topper8a13c412014-05-21 05:09:00 +00001692 llvm::BasicBlock *contBB = nullptr;
1693
John McCall3d1e2c92013-02-12 05:53:35 +00001694 // Finish the call path.
1695 llvm::BasicBlock *callBB = CGF.Builder.GetInsertBlock();
1696 if (callBB) {
1697 contBB = CGF.createBasicBlock("msgSend.cont");
1698 CGF.Builder.CreateBr(contBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001699 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001700
John McCall3d1e2c92013-02-12 05:53:35 +00001701 // Okay, start emitting the null-receiver block.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001702 CGF.EmitBlock(NullBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001703
John McCall3d1e2c92013-02-12 05:53:35 +00001704 // Release any consumed arguments we've got.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001705 if (Method) {
1706 CallArgList::const_iterator I = CallArgs.begin();
1707 for (ObjCMethodDecl::param_const_iterator i = Method->param_begin(),
1708 e = Method->param_end(); i != e; ++i, ++I) {
1709 const ParmVarDecl *ParamDecl = (*i);
1710 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001711 RValue RV = I->getRValue(CGF);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001712 assert(RV.isScalar() &&
1713 "NullReturnState::complete - arg not on object");
John McCallcdda29c2013-03-13 03:10:54 +00001714 CGF.EmitARCRelease(RV.getScalarVal(), ARCImpreciseLifetime);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001715 }
1716 }
1717 }
John McCall3d1e2c92013-02-12 05:53:35 +00001718
1719 // The phi code below assumes that we haven't needed any control flow yet.
1720 assert(CGF.Builder.GetInsertBlock() == NullBB);
1721
1722 // If we've got a void return, just jump to the continuation block.
1723 if (result.isScalar() && resultType->isVoidType()) {
1724 // No jumps required if the message-send was noreturn.
1725 if (contBB) CGF.EmitBlock(contBB);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001726 return result;
1727 }
1728
John McCall3d1e2c92013-02-12 05:53:35 +00001729 // If we've got a scalar return, build a phi.
1730 if (result.isScalar()) {
1731 // Derive the null-initialization value.
1732 llvm::Constant *null = CGF.CGM.EmitNullConstant(resultType);
1733
1734 // If no join is necessary, just flow out.
1735 if (!contBB) return RValue::get(null);
1736
1737 // Otherwise, build a phi.
1738 CGF.EmitBlock(contBB);
1739 llvm::PHINode *phi = CGF.Builder.CreatePHI(null->getType(), 2);
1740 phi->addIncoming(result.getScalarVal(), callBB);
1741 phi->addIncoming(null, NullBB);
1742 return RValue::get(phi);
1743 }
1744
1745 // If we've got an aggregate return, null the buffer out.
1746 // FIXME: maybe we should be doing things differently for all the
1747 // cases where the ABI has us returning (1) non-agg values in
1748 // memory or (2) agg values in registers.
1749 if (result.isAggregate()) {
1750 assert(result.isAggregate() && "null init of non-aggregate result?");
Kuba Mracekbce5cea2017-06-30 16:28:15 +00001751 if (!returnSlot.isUnused())
1752 CGF.EmitNullInitialization(result.getAggregateAddress(), resultType);
John McCall3d1e2c92013-02-12 05:53:35 +00001753 if (contBB) CGF.EmitBlock(contBB);
1754 return result;
1755 }
1756
1757 // Complex types.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001758 CGF.EmitBlock(contBB);
John McCall3d1e2c92013-02-12 05:53:35 +00001759 CodeGenFunction::ComplexPairTy callResult = result.getComplexVal();
1760
1761 // Find the scalar type and its zero value.
1762 llvm::Type *scalarTy = callResult.first->getType();
1763 llvm::Constant *scalarZero = llvm::Constant::getNullValue(scalarTy);
1764
1765 // Build phis for both coordinates.
1766 llvm::PHINode *real = CGF.Builder.CreatePHI(scalarTy, 2);
1767 real->addIncoming(callResult.first, callBB);
1768 real->addIncoming(scalarZero, NullBB);
1769 llvm::PHINode *imag = CGF.Builder.CreatePHI(scalarTy, 2);
1770 imag->addIncoming(callResult.second, callBB);
1771 imag->addIncoming(scalarZero, NullBB);
1772 return RValue::getComplex(real, imag);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001773 }
1774};
1775
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001776} // end anonymous namespace
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001777
1778/* *** Helper Functions *** */
1779
1780/// getConstantGEP() - Help routine to construct simple GEPs.
Owen Anderson170229f2009-07-14 23:10:40 +00001781static llvm::Constant *getConstantGEP(llvm::LLVMContext &VMContext,
David Blaikiee3b172a2015-04-02 18:55:21 +00001782 llvm::GlobalVariable *C, unsigned idx0,
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001783 unsigned idx1) {
1784 llvm::Value *Idxs[] = {
Owen Anderson41a75022009-08-13 21:57:51 +00001785 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx0),
1786 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx1)
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001787 };
David Blaikiee3b172a2015-04-02 18:55:21 +00001788 return llvm::ConstantExpr::getGetElementPtr(C->getValueType(), C, Idxs);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001789}
1790
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001791/// hasObjCExceptionAttribute - Return true if this class or any super
1792/// class has the __objc_exception__ attribute.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001793static bool hasObjCExceptionAttribute(ASTContext &Context,
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001794 const ObjCInterfaceDecl *OID) {
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001795 if (OID->hasAttr<ObjCExceptionAttr>())
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001796 return true;
1797 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001798 return hasObjCExceptionAttribute(Context, Super);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001799 return false;
1800}
1801
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001802/* *** CGObjCMac Public Interface *** */
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001803
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001804CGObjCMac::CGObjCMac(CodeGen::CodeGenModule &cgm) : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00001805 ObjCTypes(cgm) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001806 ObjCABI = 1;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001807 EmitImageInfo();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001808}
1809
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001810/// GetClass - Return a reference to the class for the given interface
1811/// decl.
John McCall882987f2013-02-28 19:01:20 +00001812llvm::Value *CGObjCMac::GetClass(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001813 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00001814 return EmitClassRef(CGF, ID);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001815}
1816
1817/// GetSelector - Return the pointer to the unique'd string for this selector.
John McCall7f416cc2015-09-08 08:05:57 +00001818llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1819 return EmitSelector(CGF, Sel);
1820}
1821Address CGObjCMac::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1822 return EmitSelectorAddr(CGF, Sel);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001823}
John McCall882987f2013-02-28 19:01:20 +00001824llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, const ObjCMethodDecl
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001825 *Method) {
John McCall882987f2013-02-28 19:01:20 +00001826 return EmitSelector(CGF, Method->getSelector());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001827}
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001828
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001829llvm::Constant *CGObjCMac::GetEHType(QualType T) {
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001830 if (T->isObjCIdType() ||
1831 T->isObjCQualifiedIdType()) {
1832 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001833 CGM.getContext().getObjCIdRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001834 }
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001835 if (T->isObjCClassType() ||
1836 T->isObjCQualifiedClassType()) {
1837 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001838 CGM.getContext().getObjCClassRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001839 }
1840 if (T->isObjCObjectPointerType())
1841 return CGM.GetAddrOfRTTIDescriptor(T, /*ForEH=*/true);
1842
John McCall2ca705e2010-07-24 00:37:23 +00001843 llvm_unreachable("asking for catch type for ObjC type in fragile runtime");
John McCall2ca705e2010-07-24 00:37:23 +00001844}
1845
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001846/// Generate a constant CFString object.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001847/*
1848 struct __builtin_CFString {
1849 const int *isa; // point to __CFConstantStringClassReference
1850 int flags;
1851 const char *str;
1852 long length;
1853 };
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001854*/
1855
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001856/// or Generate a constant NSString object.
1857/*
1858 struct __builtin_NSString {
1859 const int *isa; // point to __NSConstantStringClassReference
1860 const char *str;
1861 unsigned int length;
1862 };
1863*/
1864
John McCallcd21d542016-11-30 23:15:55 +00001865ConstantAddress
1866CGObjCCommonMac::GenerateConstantString(const StringLiteral *SL) {
1867 return (!CGM.getLangOpts().NoConstantCFStrings
1868 ? CGM.GetAddrOfConstantCFString(SL)
1869 : GenerateConstantNSString(SL));
1870}
1871
1872static llvm::StringMapEntry<llvm::GlobalVariable *> &
1873GetConstantStringEntry(llvm::StringMap<llvm::GlobalVariable *> &Map,
1874 const StringLiteral *Literal, unsigned &StringLength) {
1875 StringRef String = Literal->getString();
1876 StringLength = String.size();
1877 return *Map.insert(std::make_pair(String, nullptr)).first;
1878}
1879
1880llvm::Constant *CGObjCMac::getNSConstantStringClassRef() {
1881 if (llvm::Value *V = ConstantStringClassRef)
1882 return cast<llvm::Constant>(V);
1883
1884 auto &StringClass = CGM.getLangOpts().ObjCConstantStringClass;
1885 std::string str =
1886 StringClass.empty() ? "_NSConstantStringClassReference"
1887 : "_" + StringClass + "ClassReference";
1888
1889 llvm::Type *PTy = llvm::ArrayType::get(CGM.IntTy, 0);
1890 auto GV = CGM.CreateRuntimeVariable(PTy, str);
1891 auto V = llvm::ConstantExpr::getBitCast(GV, CGM.IntTy->getPointerTo());
1892 ConstantStringClassRef = V;
1893 return V;
1894}
1895
1896llvm::Constant *CGObjCNonFragileABIMac::getNSConstantStringClassRef() {
1897 if (llvm::Value *V = ConstantStringClassRef)
1898 return cast<llvm::Constant>(V);
1899
1900 auto &StringClass = CGM.getLangOpts().ObjCConstantStringClass;
1901 std::string str =
1902 StringClass.empty() ? "OBJC_CLASS_$_NSConstantString"
1903 : "OBJC_CLASS_$_" + StringClass;
John McCalldba63a72016-11-30 23:54:50 +00001904 auto GV = GetClassGlobal(str, NotForDefinition);
John McCallcd21d542016-11-30 23:15:55 +00001905
1906 // Make sure the result is of the correct type.
1907 auto V = llvm::ConstantExpr::getBitCast(GV, CGM.IntTy->getPointerTo());
1908
1909 ConstantStringClassRef = V;
1910 return V;
1911}
1912
1913ConstantAddress
1914CGObjCCommonMac::GenerateConstantNSString(const StringLiteral *Literal) {
1915 unsigned StringLength = 0;
1916 llvm::StringMapEntry<llvm::GlobalVariable *> &Entry =
1917 GetConstantStringEntry(NSConstantStringMap, Literal, StringLength);
1918
1919 if (auto *C = Entry.second)
1920 return ConstantAddress(C, CharUnits::fromQuantity(C->getAlignment()));
1921
1922 // If we don't already have it, get _NSConstantStringClassReference.
1923 llvm::Constant *Class = getNSConstantStringClassRef();
1924
1925 // If we don't already have it, construct the type for a constant NSString.
1926 if (!NSConstantStringType) {
1927 NSConstantStringType =
1928 llvm::StructType::create({
1929 CGM.Int32Ty->getPointerTo(),
1930 CGM.Int8PtrTy,
1931 CGM.IntTy
1932 }, "struct.__builtin_NSString");
1933 }
1934
1935 ConstantInitBuilder Builder(CGM);
1936 auto Fields = Builder.beginStruct(NSConstantStringType);
1937
1938 // Class pointer.
1939 Fields.add(Class);
1940
1941 // String pointer.
1942 llvm::Constant *C =
1943 llvm::ConstantDataArray::getString(VMContext, Entry.first());
1944
1945 llvm::GlobalValue::LinkageTypes Linkage = llvm::GlobalValue::PrivateLinkage;
1946 bool isConstant = !CGM.getLangOpts().WritableStrings;
1947
1948 auto *GV = new llvm::GlobalVariable(CGM.getModule(), C->getType(), isConstant,
1949 Linkage, C, ".str");
1950 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1951 // Don't enforce the target's minimum global alignment, since the only use
1952 // of the string is via this class initializer.
1953 GV->setAlignment(1);
1954 Fields.addBitCast(GV, CGM.Int8PtrTy);
1955
1956 // String length.
1957 Fields.addInt(CGM.IntTy, StringLength);
1958
1959 // The struct.
1960 CharUnits Alignment = CGM.getPointerAlign();
1961 GV = Fields.finishAndCreateGlobal("_unnamed_nsstring_", Alignment,
1962 /*constant*/ true,
1963 llvm::GlobalVariable::PrivateLinkage);
1964 const char *NSStringSection = "__OBJC,__cstring_object,regular,no_dead_strip";
1965 const char *NSStringNonFragileABISection =
1966 "__DATA,__objc_stringobj,regular,no_dead_strip";
1967 // FIXME. Fix section.
1968 GV->setSection(CGM.getLangOpts().ObjCRuntime.isNonFragile()
1969 ? NSStringNonFragileABISection
1970 : NSStringSection);
1971 Entry.second = GV;
1972
1973 return ConstantAddress(GV, Alignment);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001974}
1975
Ted Kremeneke65b0862012-03-06 20:05:56 +00001976enum {
1977 kCFTaggedObjectID_Integer = (1 << 1) + 1
1978};
1979
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001980/// Generates a message send where the super is the receiver. This is
1981/// a message send to self with special delivery semantics indicating
1982/// which class's method should be called.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001983CodeGen::RValue
1984CGObjCMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001985 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001986 QualType ResultType,
1987 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001988 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001989 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001990 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001991 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001992 const CodeGen::CallArgList &CallArgs,
1993 const ObjCMethodDecl *Method) {
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001994 // Create and init a super structure; this is a (receiver, class)
1995 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00001996 Address ObjCSuper =
1997 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
1998 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001999 llvm::Value *ReceiverAsObject =
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00002000 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00002001 CGF.Builder.CreateStore(
2002 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00002003 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00002004
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002005 // If this is a class message the metaclass is passed as the target.
2006 llvm::Value *Target;
2007 if (IsClassMessage) {
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00002008 if (isCategoryImpl) {
2009 // Message sent to 'super' in a class method defined in a category
2010 // implementation requires an odd treatment.
2011 // If we are in a class method, we must retrieve the
2012 // _metaclass_ for the current class, pointed at by
2013 // the class's "isa" pointer. The following assumes that
2014 // isa" is the first ivar in a class (which it must be).
John McCall882987f2013-02-28 19:01:20 +00002015 Target = EmitClassRef(CGF, Class->getSuperClass());
David Blaikie1ed728c2015-04-05 22:45:47 +00002016 Target = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, Target, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002017 Target = CGF.Builder.CreateAlignedLoad(Target, CGF.getPointerAlign());
Mike Stump658fe022009-07-30 22:28:39 +00002018 } else {
David Blaikie1ed728c2015-04-05 22:45:47 +00002019 llvm::Constant *MetaClassPtr = EmitMetaClassRef(Class);
2020 llvm::Value *SuperPtr =
2021 CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, MetaClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00002022 llvm::Value *Super =
2023 CGF.Builder.CreateAlignedLoad(SuperPtr, CGF.getPointerAlign());
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00002024 Target = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002025 }
David Blaikie1ed728c2015-04-05 22:45:47 +00002026 } else if (isCategoryImpl)
John McCall882987f2013-02-28 19:01:20 +00002027 Target = EmitClassRef(CGF, Class->getSuperClass());
Fariborz Jahanianda2efb02009-11-14 02:18:31 +00002028 else {
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00002029 llvm::Value *ClassPtr = EmitSuperClassRef(Class);
David Blaikie1ed728c2015-04-05 22:45:47 +00002030 ClassPtr = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, ClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00002031 Target = CGF.Builder.CreateAlignedLoad(ClassPtr, CGF.getPointerAlign());
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002032 }
Mike Stump18bb9282009-05-16 07:57:57 +00002033 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
2034 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00002035 llvm::Type *ClassTy =
Daniel Dunbarc722b852008-08-30 03:02:31 +00002036 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
Daniel Dunbarc475d422008-10-29 22:36:39 +00002037 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
John McCall7f416cc2015-09-08 08:05:57 +00002038 CGF.Builder.CreateStore(Target,
2039 CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
John McCall9e8bb002011-05-14 03:10:52 +00002040 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00002041 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00002042 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00002043 true, CallArgs, Method, Class, ObjCTypes);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002044}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002045
2046/// Generate code for a message send expression.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00002047CodeGen::RValue CGObjCMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00002048 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002049 QualType ResultType,
2050 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002051 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002052 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00002053 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002054 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00002055 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00002056 EmitSelector(CGF, Sel),
John McCall9e8bb002011-05-14 03:10:52 +00002057 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00002058 false, CallArgs, Method, Class, ObjCTypes);
2059}
2060
2061static bool isWeakLinkedClass(const ObjCInterfaceDecl *ID) {
2062 do {
2063 if (ID->isWeakImported())
2064 return true;
2065 } while ((ID = ID->getSuperClass()));
2066
2067 return false;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00002068}
2069
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00002070CodeGen::RValue
John McCall9e8bb002011-05-14 03:10:52 +00002071CGObjCCommonMac::EmitMessageSend(CodeGen::CodeGenFunction &CGF,
2072 ReturnValueSlot Return,
2073 QualType ResultType,
2074 llvm::Value *Sel,
2075 llvm::Value *Arg0,
2076 QualType Arg0Ty,
2077 bool IsSuper,
2078 const CallArgList &CallArgs,
2079 const ObjCMethodDecl *Method,
John McCall1e3157b2015-09-10 22:27:50 +00002080 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00002081 const ObjCCommonTypesHelper &ObjCTypes) {
Daniel Dunbarc722b852008-08-30 03:02:31 +00002082 CallArgList ActualArgs;
Fariborz Jahanian969bc682009-04-24 21:07:43 +00002083 if (!IsSuper)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00002084 Arg0 = CGF.Builder.CreateBitCast(Arg0, ObjCTypes.ObjectPtrTy);
Eli Friedman43dca6a2011-05-02 17:57:46 +00002085 ActualArgs.add(RValue::get(Arg0), Arg0Ty);
2086 ActualArgs.add(RValue::get(Sel), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00002087 ActualArgs.addFrom(CallArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002088
John McCalla729c622012-02-17 03:33:10 +00002089 // If we're calling a method, use the formal signature.
2090 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002091
Anders Carlsson280e61f12010-06-21 20:59:55 +00002092 if (Method)
Alp Toker314cc812014-01-25 16:55:45 +00002093 assert(CGM.getContext().getCanonicalType(Method->getReturnType()) ==
2094 CGM.getContext().getCanonicalType(ResultType) &&
Anders Carlsson280e61f12010-06-21 20:59:55 +00002095 "Result type mismatch!");
2096
John McCall1e3157b2015-09-10 22:27:50 +00002097 bool ReceiverCanBeNull = true;
2098
2099 // Super dispatch assumes that self is non-null; even the messenger
2100 // doesn't have a null check internally.
2101 if (IsSuper) {
2102 ReceiverCanBeNull = false;
2103
2104 // If this is a direct dispatch of a class method, check whether the class,
2105 // or anything in its hierarchy, was weak-linked.
2106 } else if (ClassReceiver && Method && Method->isClassMethod()) {
2107 ReceiverCanBeNull = isWeakLinkedClass(ClassReceiver);
2108
2109 // If we're emitting a method, and self is const (meaning just ARC, for now),
2110 // and the receiver is a load of self, then self is a valid object.
2111 } else if (auto CurMethod =
2112 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl)) {
2113 auto Self = CurMethod->getSelfDecl();
2114 if (Self->getType().isConstQualified()) {
2115 if (auto LI = dyn_cast<llvm::LoadInst>(Arg0->stripPointerCasts())) {
2116 llvm::Value *SelfAddr = CGF.GetAddrOfLocalVar(Self).getPointer();
2117 if (SelfAddr == LI->getPointerOperand()) {
2118 ReceiverCanBeNull = false;
2119 }
2120 }
2121 }
2122 }
2123
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002124 bool RequiresNullCheck = false;
John McCall5880fb82011-05-14 21:12:11 +00002125
Craig Topper8a13c412014-05-21 05:09:00 +00002126 llvm::Constant *Fn = nullptr;
Tim Northovere77cc392014-03-29 13:28:05 +00002127 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002128 if (ReceiverCanBeNull) RequiresNullCheck = true;
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00002129 Fn = (ObjCABI == 2) ? ObjCTypes.getSendStretFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002130 : ObjCTypes.getSendStretFn(IsSuper);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00002131 } else if (CGM.ReturnTypeUsesFPRet(ResultType)) {
2132 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFpretFn2(IsSuper)
2133 : ObjCTypes.getSendFpretFn(IsSuper);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00002134 } else if (CGM.ReturnTypeUsesFP2Ret(ResultType)) {
2135 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFp2RetFn2(IsSuper)
2136 : ObjCTypes.getSendFp2retFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00002137 } else {
Tim Northovere77cc392014-03-29 13:28:05 +00002138 // arm64 uses objc_msgSend for stret methods and yet null receiver check
2139 // must be made for it.
Ahmed Bougachaa3df87b2015-10-02 22:41:59 +00002140 if (ReceiverCanBeNull && CGM.ReturnTypeUsesSRet(MSI.CallInfo))
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002141 RequiresNullCheck = true;
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00002142 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002143 : ObjCTypes.getSendFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00002144 }
John McCall1e3157b2015-09-10 22:27:50 +00002145
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002146 // We don't need to emit a null check to zero out an indirect result if the
2147 // result is ignored.
2148 if (Return.isUnused())
2149 RequiresNullCheck = false;
2150
John McCall1e3157b2015-09-10 22:27:50 +00002151 // Emit a null-check if there's a consumed argument other than the receiver.
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002152 if (!RequiresNullCheck && CGM.getLangOpts().ObjCAutoRefCount && Method) {
David Majnemer59f77922016-06-24 04:05:48 +00002153 for (const auto *ParamDecl : Method->parameters()) {
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00002154 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
John McCall1e3157b2015-09-10 22:27:50 +00002155 RequiresNullCheck = true;
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00002156 break;
2157 }
2158 }
John McCall1e3157b2015-09-10 22:27:50 +00002159 }
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002160
2161 NullReturnState nullReturn;
2162 if (RequiresNullCheck) {
2163 nullReturn.init(CGF, Arg0);
2164 }
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00002165
John McCall1e3157b2015-09-10 22:27:50 +00002166 llvm::Instruction *CallSite;
John McCalla729c622012-02-17 03:33:10 +00002167 Fn = llvm::ConstantExpr::getBitCast(Fn, MSI.MessengerType);
John McCallb92ab1a2016-10-26 23:46:34 +00002168 CGCallee Callee = CGCallee::forDirect(Fn);
2169 RValue rvalue = CGF.EmitCall(MSI.CallInfo, Callee, Return, ActualArgs,
2170 &CallSite);
John McCall1e3157b2015-09-10 22:27:50 +00002171
2172 // Mark the call as noreturn if the method is marked noreturn and the
2173 // receiver cannot be null.
2174 if (Method && Method->hasAttr<NoReturnAttr>() && !ReceiverCanBeNull) {
2175 llvm::CallSite(CallSite).setDoesNotReturn();
2176 }
2177
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002178 return nullReturn.complete(CGF, Return, rvalue, ResultType, CallArgs,
John McCall1e3157b2015-09-10 22:27:50 +00002179 RequiresNullCheck ? Method : nullptr);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002180}
2181
John McCall3fd13f062015-10-21 18:06:47 +00002182static Qualifiers::GC GetGCAttrTypeForType(ASTContext &Ctx, QualType FQT,
2183 bool pointee = false) {
2184 // Note that GC qualification applies recursively to C pointer types
2185 // that aren't otherwise decorated. This is weird, but it's probably
2186 // an intentional workaround to the unreliable placement of GC qualifiers.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002187 if (FQT.isObjCGCStrong())
2188 return Qualifiers::Strong;
John McCall3fd13f062015-10-21 18:06:47 +00002189
2190 if (FQT.isObjCGCWeak())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002191 return Qualifiers::Weak;
John McCall3fd13f062015-10-21 18:06:47 +00002192
2193 if (auto ownership = FQT.getObjCLifetime()) {
2194 // Ownership does not apply recursively to C pointer types.
2195 if (pointee) return Qualifiers::GCNone;
2196 switch (ownership) {
2197 case Qualifiers::OCL_Weak: return Qualifiers::Weak;
2198 case Qualifiers::OCL_Strong: return Qualifiers::Strong;
2199 case Qualifiers::OCL_ExplicitNone: return Qualifiers::GCNone;
2200 case Qualifiers::OCL_Autoreleasing: llvm_unreachable("autoreleasing ivar?");
2201 case Qualifiers::OCL_None: llvm_unreachable("known nonzero");
2202 }
2203 llvm_unreachable("bad objc ownership");
2204 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002205
John McCall3fd13f062015-10-21 18:06:47 +00002206 // Treat unqualified retainable pointers as strong.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002207 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
2208 return Qualifiers::Strong;
2209
John McCall3fd13f062015-10-21 18:06:47 +00002210 // Walk into C pointer types, but only in GC.
2211 if (Ctx.getLangOpts().getGC() != LangOptions::NonGC) {
2212 if (const PointerType *PT = FQT->getAs<PointerType>())
2213 return GetGCAttrTypeForType(Ctx, PT->getPointeeType(), /*pointee*/ true);
2214 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002215
2216 return Qualifiers::GCNone;
2217}
2218
John McCall3fd13f062015-10-21 18:06:47 +00002219namespace {
2220 struct IvarInfo {
2221 CharUnits Offset;
2222 uint64_t SizeInWords;
2223 IvarInfo(CharUnits offset, uint64_t sizeInWords)
2224 : Offset(offset), SizeInWords(sizeInWords) {}
2225
2226 // Allow sorting based on byte pos.
2227 bool operator<(const IvarInfo &other) const {
2228 return Offset < other.Offset;
2229 }
2230 };
2231
2232 /// A helper class for building GC layout strings.
2233 class IvarLayoutBuilder {
2234 CodeGenModule &CGM;
2235
2236 /// The start of the layout. Offsets will be relative to this value,
2237 /// and entries less than this value will be silently discarded.
2238 CharUnits InstanceBegin;
2239
2240 /// The end of the layout. Offsets will never exceed this value.
2241 CharUnits InstanceEnd;
2242
2243 /// Whether we're generating the strong layout or the weak layout.
2244 bool ForStrongLayout;
2245
2246 /// Whether the offsets in IvarsInfo might be out-of-order.
2247 bool IsDisordered = false;
2248
2249 llvm::SmallVector<IvarInfo, 8> IvarsInfo;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002250
John McCall3fd13f062015-10-21 18:06:47 +00002251 public:
2252 IvarLayoutBuilder(CodeGenModule &CGM, CharUnits instanceBegin,
2253 CharUnits instanceEnd, bool forStrongLayout)
2254 : CGM(CGM), InstanceBegin(instanceBegin), InstanceEnd(instanceEnd),
2255 ForStrongLayout(forStrongLayout) {
2256 }
2257
2258 void visitRecord(const RecordType *RT, CharUnits offset);
2259
2260 template <class Iterator, class GetOffsetFn>
2261 void visitAggregate(Iterator begin, Iterator end,
2262 CharUnits aggrOffset,
2263 const GetOffsetFn &getOffset);
2264
2265 void visitField(const FieldDecl *field, CharUnits offset);
2266
2267 /// Add the layout of a block implementation.
2268 void visitBlock(const CGBlockInfo &blockInfo);
2269
2270 /// Is there any information for an interesting bitmap?
2271 bool hasBitmapData() const { return !IvarsInfo.empty(); }
2272
2273 llvm::Constant *buildBitmap(CGObjCCommonMac &CGObjC,
2274 llvm::SmallVectorImpl<unsigned char> &buffer);
2275
2276 static void dump(ArrayRef<unsigned char> buffer) {
2277 const unsigned char *s = buffer.data();
2278 for (unsigned i = 0, e = buffer.size(); i < e; i++)
2279 if (!(s[i] & 0xf0))
2280 printf("0x0%x%s", s[i], s[i] != 0 ? ", " : "");
2281 else
2282 printf("0x%x%s", s[i], s[i] != 0 ? ", " : "");
2283 printf("\n");
2284 }
2285 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002286} // end anonymous namespace
John McCall3fd13f062015-10-21 18:06:47 +00002287
John McCall351762c2011-02-07 10:33:21 +00002288llvm::Constant *CGObjCCommonMac::BuildGCBlockLayout(CodeGenModule &CGM,
2289 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002290
Chris Lattnerece04092012-02-07 00:39:47 +00002291 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
John McCall460ce582015-10-22 18:38:17 +00002292 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
John McCall351762c2011-02-07 10:33:21 +00002293 return nullPtr;
2294
John McCall3fd13f062015-10-21 18:06:47 +00002295 IvarLayoutBuilder builder(CGM, CharUnits::Zero(), blockInfo.BlockSize,
2296 /*for strong layout*/ true);
2297
2298 builder.visitBlock(blockInfo);
2299
2300 if (!builder.hasBitmapData())
2301 return nullPtr;
2302
2303 llvm::SmallVector<unsigned char, 32> buffer;
2304 llvm::Constant *C = builder.buildBitmap(*this, buffer);
John McCallf5ea0722015-10-29 23:36:14 +00002305 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
John McCall3fd13f062015-10-21 18:06:47 +00002306 printf("\n block variable layout for block: ");
2307 builder.dump(buffer);
2308 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002309
John McCall3fd13f062015-10-21 18:06:47 +00002310 return C;
2311}
2312
2313void IvarLayoutBuilder::visitBlock(const CGBlockInfo &blockInfo) {
Fariborz Jahaniancfddabf2010-09-09 00:21:45 +00002314 // __isa is the first field in block descriptor and must assume by runtime's
2315 // convention that it is GC'able.
John McCall3fd13f062015-10-21 18:06:47 +00002316 IvarsInfo.push_back(IvarInfo(CharUnits::Zero(), 1));
John McCall351762c2011-02-07 10:33:21 +00002317
2318 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2319
John McCall351762c2011-02-07 10:33:21 +00002320 // Ignore the optional 'this' capture: C++ objects are not assumed
2321 // to be GC'ed.
2322
John McCall3fd13f062015-10-21 18:06:47 +00002323 CharUnits lastFieldOffset;
2324
John McCall351762c2011-02-07 10:33:21 +00002325 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002326 for (const auto &CI : blockDecl->captures()) {
2327 const VarDecl *variable = CI.getVariable();
John McCall351762c2011-02-07 10:33:21 +00002328 QualType type = variable->getType();
2329
2330 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2331
2332 // Ignore constant captures.
2333 if (capture.isConstant()) continue;
2334
John McCall3fd13f062015-10-21 18:06:47 +00002335 CharUnits fieldOffset = capture.getOffset();
2336
2337 // Block fields are not necessarily ordered; if we detect that we're
2338 // adding them out-of-order, make sure we sort later.
2339 if (fieldOffset < lastFieldOffset)
2340 IsDisordered = true;
2341 lastFieldOffset = fieldOffset;
John McCall351762c2011-02-07 10:33:21 +00002342
2343 // __block variables are passed by their descriptor address.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002344 if (CI.isByRef()) {
John McCall3fd13f062015-10-21 18:06:47 +00002345 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
Fariborz Jahanian933c6722010-09-11 01:27:29 +00002346 continue;
John McCall351762c2011-02-07 10:33:21 +00002347 }
2348
2349 assert(!type->isArrayType() && "array variable should not be caught");
2350 if (const RecordType *record = type->getAs<RecordType>()) {
John McCall3fd13f062015-10-21 18:06:47 +00002351 visitRecord(record, fieldOffset);
Fariborz Jahanian903aba32010-08-05 21:00:25 +00002352 continue;
2353 }
Fariborz Jahanianf95e3582010-08-06 16:28:55 +00002354
John McCall351762c2011-02-07 10:33:21 +00002355 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), type);
John McCall351762c2011-02-07 10:33:21 +00002356
John McCall3fd13f062015-10-21 18:06:47 +00002357 if (GCAttr == Qualifiers::Strong) {
2358 assert(CGM.getContext().getTypeSize(type)
2359 == CGM.getTarget().getPointerWidth(0));
2360 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
2361 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002362 }
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00002363}
2364
Fariborz Jahanian2c96d302012-11-04 18:19:40 +00002365/// getBlockCaptureLifetime - This routine returns life time of the captured
2366/// block variable for the purpose of block layout meta-data generation. FQT is
2367/// the type of the variable captured in the block.
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002368Qualifiers::ObjCLifetime CGObjCCommonMac::getBlockCaptureLifetime(QualType FQT,
2369 bool ByrefLayout) {
John McCall460ce582015-10-22 18:38:17 +00002370 // If it has an ownership qualifier, we're done.
2371 if (auto lifetime = FQT.getObjCLifetime())
2372 return lifetime;
2373
2374 // If it doesn't, and this is ARC, it has no ownership.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002375 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall460ce582015-10-22 18:38:17 +00002376 return Qualifiers::OCL_None;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002377
John McCall460ce582015-10-22 18:38:17 +00002378 // In MRC, retainable pointers are owned by non-__block variables.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002379 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002380 return ByrefLayout ? Qualifiers::OCL_ExplicitNone : Qualifiers::OCL_Strong;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002381
2382 return Qualifiers::OCL_None;
2383}
2384
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002385void CGObjCCommonMac::UpdateRunSkipBlockVars(bool IsByref,
2386 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002387 CharUnits FieldOffset,
2388 CharUnits FieldSize) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002389 // __block variables are passed by their descriptor address.
2390 if (IsByref)
2391 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_BYREF, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002392 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002393 else if (LifeTime == Qualifiers::OCL_Strong)
2394 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_STRONG, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002395 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002396 else if (LifeTime == Qualifiers::OCL_Weak)
2397 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_WEAK, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002398 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002399 else if (LifeTime == Qualifiers::OCL_ExplicitNone)
2400 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_UNRETAINED, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002401 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002402 else
2403 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_NON_OBJECT_BYTES,
2404 FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002405 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002406}
2407
2408void CGObjCCommonMac::BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
2409 const RecordDecl *RD,
2410 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002411 CharUnits BytePos, bool &HasUnion,
2412 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002413 bool IsUnion = (RD && RD->isUnion());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002414 CharUnits MaxUnionSize = CharUnits::Zero();
Craig Topper8a13c412014-05-21 05:09:00 +00002415 const FieldDecl *MaxField = nullptr;
2416 const FieldDecl *LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002417 CharUnits MaxFieldOffset = CharUnits::Zero();
2418 CharUnits LastBitfieldOrUnnamedOffset = CharUnits::Zero();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002419
2420 if (RecFields.empty())
2421 return;
John McCallc8e01702013-04-16 22:48:15 +00002422 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002423
2424 for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
2425 const FieldDecl *Field = RecFields[i];
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002426 // Note that 'i' here is actually the field index inside RD of Field,
2427 // although this dependency is hidden.
2428 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002429 CharUnits FieldOffset =
2430 CGM.getContext().toCharUnitsFromBits(RL.getFieldOffset(i));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002431
2432 // Skip over unnamed or bitfields
2433 if (!Field->getIdentifier() || Field->isBitField()) {
2434 LastFieldBitfieldOrUnnamed = Field;
2435 LastBitfieldOrUnnamedOffset = FieldOffset;
2436 continue;
2437 }
Craig Topper8a13c412014-05-21 05:09:00 +00002438
2439 LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002440 QualType FQT = Field->getType();
2441 if (FQT->isRecordType() || FQT->isUnionType()) {
2442 if (FQT->isUnionType())
2443 HasUnion = true;
2444
2445 BuildRCBlockVarRecordLayout(FQT->getAs<RecordType>(),
2446 BytePos + FieldOffset, HasUnion);
2447 continue;
2448 }
2449
2450 if (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2451 const ConstantArrayType *CArray =
2452 dyn_cast_or_null<ConstantArrayType>(Array);
2453 uint64_t ElCount = CArray->getSize().getZExtValue();
2454 assert(CArray && "only array with known element size is supported");
2455 FQT = CArray->getElementType();
2456 while (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2457 const ConstantArrayType *CArray =
2458 dyn_cast_or_null<ConstantArrayType>(Array);
2459 ElCount *= CArray->getSize().getZExtValue();
2460 FQT = CArray->getElementType();
2461 }
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002462 if (FQT->isRecordType() && ElCount) {
2463 int OldIndex = RunSkipBlockVars.size() - 1;
2464 const RecordType *RT = FQT->getAs<RecordType>();
2465 BuildRCBlockVarRecordLayout(RT, BytePos + FieldOffset,
2466 HasUnion);
2467
2468 // Replicate layout information for each array element. Note that
2469 // one element is already done.
2470 uint64_t ElIx = 1;
2471 for (int FirstIndex = RunSkipBlockVars.size() - 1 ;ElIx < ElCount; ElIx++) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002472 CharUnits Size = CGM.getContext().getTypeSizeInChars(RT);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002473 for (int i = OldIndex+1; i <= FirstIndex; ++i)
2474 RunSkipBlockVars.push_back(
2475 RUN_SKIP(RunSkipBlockVars[i].opcode,
2476 RunSkipBlockVars[i].block_var_bytepos + Size*ElIx,
2477 RunSkipBlockVars[i].block_var_size));
2478 }
2479 continue;
2480 }
2481 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002482 CharUnits FieldSize = CGM.getContext().getTypeSizeInChars(Field->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002483 if (IsUnion) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002484 CharUnits UnionIvarSize = FieldSize;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002485 if (UnionIvarSize > MaxUnionSize) {
2486 MaxUnionSize = UnionIvarSize;
2487 MaxField = Field;
2488 MaxFieldOffset = FieldOffset;
2489 }
2490 } else {
2491 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002492 getBlockCaptureLifetime(FQT, ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002493 BytePos + FieldOffset,
2494 FieldSize);
2495 }
2496 }
2497
2498 if (LastFieldBitfieldOrUnnamed) {
2499 if (LastFieldBitfieldOrUnnamed->isBitField()) {
2500 // Last field was a bitfield. Must update the info.
2501 uint64_t BitFieldSize
2502 = LastFieldBitfieldOrUnnamed->getBitWidthValue(CGM.getContext());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002503 unsigned UnsSize = (BitFieldSize / ByteSizeInBits) +
Eli Friedman8cbca202012-11-06 22:15:52 +00002504 ((BitFieldSize % ByteSizeInBits) != 0);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002505 CharUnits Size = CharUnits::fromQuantity(UnsSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002506 Size += LastBitfieldOrUnnamedOffset;
2507 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002508 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2509 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002510 BytePos + LastBitfieldOrUnnamedOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002511 Size);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002512 } else {
2513 assert(!LastFieldBitfieldOrUnnamed->getIdentifier() &&"Expected unnamed");
2514 // Last field was unnamed. Must update skip info.
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002515 CharUnits FieldSize
2516 = CGM.getContext().getTypeSizeInChars(LastFieldBitfieldOrUnnamed->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002517 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002518 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2519 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002520 BytePos + LastBitfieldOrUnnamedOffset,
2521 FieldSize);
2522 }
2523 }
2524
2525 if (MaxField)
2526 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002527 getBlockCaptureLifetime(MaxField->getType(), ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002528 BytePos + MaxFieldOffset,
2529 MaxUnionSize);
2530}
2531
2532void CGObjCCommonMac::BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002533 CharUnits BytePos,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002534 bool &HasUnion,
2535 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002536 const RecordDecl *RD = RT->getDecl();
Aaron Ballman62e47c42014-03-10 13:43:55 +00002537 SmallVector<const FieldDecl*, 16> Fields(RD->fields());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002538 llvm::Type *Ty = CGM.getTypes().ConvertType(QualType(RT, 0));
2539 const llvm::StructLayout *RecLayout =
2540 CGM.getDataLayout().getStructLayout(cast<llvm::StructType>(Ty));
2541
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002542 BuildRCRecordLayout(RecLayout, RD, Fields, BytePos, HasUnion, ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002543}
2544
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002545/// InlineLayoutInstruction - This routine produce an inline instruction for the
2546/// block variable layout if it can. If not, it returns 0. Rules are as follow:
2547/// If ((uintptr_t) layout) < (1 << 12), the layout is inline. In the 64bit world,
2548/// an inline layout of value 0x0000000000000xyz is interpreted as follows:
2549/// x captured object pointers of BLOCK_LAYOUT_STRONG. Followed by
2550/// y captured object of BLOCK_LAYOUT_BYREF. Followed by
2551/// z captured object of BLOCK_LAYOUT_WEAK. If any of the above is missing, zero
2552/// replaces it. For example, 0x00000x00 means x BLOCK_LAYOUT_STRONG and no
2553/// BLOCK_LAYOUT_BYREF and no BLOCK_LAYOUT_WEAK objects are captured.
2554uint64_t CGObjCCommonMac::InlineLayoutInstruction(
2555 SmallVectorImpl<unsigned char> &Layout) {
2556 uint64_t Result = 0;
2557 if (Layout.size() <= 3) {
2558 unsigned size = Layout.size();
2559 unsigned strong_word_count = 0, byref_word_count=0, weak_word_count=0;
2560 unsigned char inst;
2561 enum BLOCK_LAYOUT_OPCODE opcode ;
2562 switch (size) {
2563 case 3:
2564 inst = Layout[0];
2565 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2566 if (opcode == BLOCK_LAYOUT_STRONG)
2567 strong_word_count = (inst & 0xF)+1;
2568 else
2569 return 0;
2570 inst = Layout[1];
2571 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2572 if (opcode == BLOCK_LAYOUT_BYREF)
2573 byref_word_count = (inst & 0xF)+1;
2574 else
2575 return 0;
2576 inst = Layout[2];
2577 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2578 if (opcode == BLOCK_LAYOUT_WEAK)
2579 weak_word_count = (inst & 0xF)+1;
2580 else
2581 return 0;
2582 break;
2583
2584 case 2:
2585 inst = Layout[0];
2586 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2587 if (opcode == BLOCK_LAYOUT_STRONG) {
2588 strong_word_count = (inst & 0xF)+1;
2589 inst = Layout[1];
2590 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2591 if (opcode == BLOCK_LAYOUT_BYREF)
2592 byref_word_count = (inst & 0xF)+1;
2593 else if (opcode == BLOCK_LAYOUT_WEAK)
2594 weak_word_count = (inst & 0xF)+1;
2595 else
2596 return 0;
2597 }
2598 else if (opcode == BLOCK_LAYOUT_BYREF) {
2599 byref_word_count = (inst & 0xF)+1;
2600 inst = Layout[1];
2601 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2602 if (opcode == BLOCK_LAYOUT_WEAK)
2603 weak_word_count = (inst & 0xF)+1;
2604 else
2605 return 0;
2606 }
2607 else
2608 return 0;
2609 break;
2610
2611 case 1:
2612 inst = Layout[0];
2613 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2614 if (opcode == BLOCK_LAYOUT_STRONG)
2615 strong_word_count = (inst & 0xF)+1;
2616 else if (opcode == BLOCK_LAYOUT_BYREF)
2617 byref_word_count = (inst & 0xF)+1;
2618 else if (opcode == BLOCK_LAYOUT_WEAK)
2619 weak_word_count = (inst & 0xF)+1;
2620 else
2621 return 0;
2622 break;
2623
2624 default:
2625 return 0;
2626 }
2627
2628 // Cannot inline when any of the word counts is 15. Because this is one less
2629 // than the actual work count (so 15 means 16 actual word counts),
2630 // and we can only display 0 thru 15 word counts.
2631 if (strong_word_count == 16 || byref_word_count == 16 || weak_word_count == 16)
2632 return 0;
2633
2634 unsigned count =
2635 (strong_word_count != 0) + (byref_word_count != 0) + (weak_word_count != 0);
2636
2637 if (size == count) {
2638 if (strong_word_count)
2639 Result = strong_word_count;
2640 Result <<= 4;
2641 if (byref_word_count)
2642 Result += byref_word_count;
2643 Result <<= 4;
2644 if (weak_word_count)
2645 Result += weak_word_count;
2646 }
2647 }
2648 return Result;
2649}
2650
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002651llvm::Constant *CGObjCCommonMac::getBitmapBlockLayout(bool ComputeByrefLayout) {
2652 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2653 if (RunSkipBlockVars.empty())
2654 return nullPtr;
John McCallc8e01702013-04-16 22:48:15 +00002655 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2656 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002657 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2658
2659 // Sort on byte position; captures might not be allocated in order,
2660 // and unions can do funny things.
2661 llvm::array_pod_sort(RunSkipBlockVars.begin(), RunSkipBlockVars.end());
2662 SmallVector<unsigned char, 16> Layout;
2663
2664 unsigned size = RunSkipBlockVars.size();
2665 for (unsigned i = 0; i < size; i++) {
2666 enum BLOCK_LAYOUT_OPCODE opcode = RunSkipBlockVars[i].opcode;
2667 CharUnits start_byte_pos = RunSkipBlockVars[i].block_var_bytepos;
2668 CharUnits end_byte_pos = start_byte_pos;
2669 unsigned j = i+1;
2670 while (j < size) {
2671 if (opcode == RunSkipBlockVars[j].opcode) {
2672 end_byte_pos = RunSkipBlockVars[j++].block_var_bytepos;
2673 i++;
2674 }
2675 else
2676 break;
2677 }
2678 CharUnits size_in_bytes =
2679 end_byte_pos - start_byte_pos + RunSkipBlockVars[j-1].block_var_size;
2680 if (j < size) {
2681 CharUnits gap =
2682 RunSkipBlockVars[j].block_var_bytepos -
2683 RunSkipBlockVars[j-1].block_var_bytepos - RunSkipBlockVars[j-1].block_var_size;
2684 size_in_bytes += gap;
2685 }
2686 CharUnits residue_in_bytes = CharUnits::Zero();
2687 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES) {
2688 residue_in_bytes = size_in_bytes % WordSizeInBytes;
2689 size_in_bytes -= residue_in_bytes;
2690 opcode = BLOCK_LAYOUT_NON_OBJECT_WORDS;
2691 }
2692
2693 unsigned size_in_words = size_in_bytes.getQuantity() / WordSizeInBytes;
2694 while (size_in_words >= 16) {
2695 // Note that value in imm. is one less that the actual
2696 // value. So, 0xf means 16 words follow!
2697 unsigned char inst = (opcode << 4) | 0xf;
2698 Layout.push_back(inst);
2699 size_in_words -= 16;
2700 }
2701 if (size_in_words > 0) {
2702 // Note that value in imm. is one less that the actual
2703 // value. So, we subtract 1 away!
2704 unsigned char inst = (opcode << 4) | (size_in_words-1);
2705 Layout.push_back(inst);
2706 }
2707 if (residue_in_bytes > CharUnits::Zero()) {
2708 unsigned char inst =
2709 (BLOCK_LAYOUT_NON_OBJECT_BYTES << 4) | (residue_in_bytes.getQuantity()-1);
2710 Layout.push_back(inst);
2711 }
2712 }
2713
John McCall7f416cc2015-09-08 08:05:57 +00002714 while (!Layout.empty()) {
2715 unsigned char inst = Layout.back();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002716 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2717 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES || opcode == BLOCK_LAYOUT_NON_OBJECT_WORDS)
2718 Layout.pop_back();
2719 else
2720 break;
2721 }
2722
2723 uint64_t Result = InlineLayoutInstruction(Layout);
2724 if (Result != 0) {
2725 // Block variable layout instruction has been inlined.
2726 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2727 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002728 printf("\n Inline BYREF variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002729 else
John McCall7f416cc2015-09-08 08:05:57 +00002730 printf("\n Inline block variable layout: ");
2731 printf("0x0%" PRIx64 "", Result);
2732 if (auto numStrong = (Result & 0xF00) >> 8)
2733 printf(", BL_STRONG:%d", (int) numStrong);
2734 if (auto numByref = (Result & 0x0F0) >> 4)
2735 printf(", BL_BYREF:%d", (int) numByref);
2736 if (auto numWeak = (Result & 0x00F) >> 0)
2737 printf(", BL_WEAK:%d", (int) numWeak);
2738 printf(", BL_OPERATOR:0\n");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002739 }
Vedant Kumar3ed0df02015-12-21 19:43:25 +00002740 return llvm::ConstantInt::get(CGM.IntPtrTy, Result);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002741 }
2742
2743 unsigned char inst = (BLOCK_LAYOUT_OPERATOR << 4) | 0;
2744 Layout.push_back(inst);
2745 std::string BitMap;
2746 for (unsigned i = 0, e = Layout.size(); i != e; i++)
2747 BitMap += Layout[i];
2748
2749 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2750 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002751 printf("\n Byref variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002752 else
John McCall7f416cc2015-09-08 08:05:57 +00002753 printf("\n Block variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002754 for (unsigned i = 0, e = BitMap.size(); i != e; i++) {
2755 unsigned char inst = BitMap[i];
2756 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2757 unsigned delta = 1;
2758 switch (opcode) {
2759 case BLOCK_LAYOUT_OPERATOR:
2760 printf("BL_OPERATOR:");
2761 delta = 0;
2762 break;
2763 case BLOCK_LAYOUT_NON_OBJECT_BYTES:
2764 printf("BL_NON_OBJECT_BYTES:");
2765 break;
2766 case BLOCK_LAYOUT_NON_OBJECT_WORDS:
2767 printf("BL_NON_OBJECT_WORD:");
2768 break;
2769 case BLOCK_LAYOUT_STRONG:
2770 printf("BL_STRONG:");
2771 break;
2772 case BLOCK_LAYOUT_BYREF:
2773 printf("BL_BYREF:");
2774 break;
2775 case BLOCK_LAYOUT_WEAK:
2776 printf("BL_WEAK:");
2777 break;
2778 case BLOCK_LAYOUT_UNRETAINED:
2779 printf("BL_UNRETAINED:");
2780 break;
2781 }
2782 // Actual value of word count is one more that what is in the imm.
2783 // field of the instruction
2784 printf("%d", (inst & 0xf) + delta);
2785 if (i < e-1)
2786 printf(", ");
2787 else
2788 printf("\n");
2789 }
2790 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002791
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00002792 auto *Entry = CreateCStringLiteral(BitMap, ObjCLabelType::ClassName,
2793 /*ForceNonFragileABI=*/true,
2794 /*NullTerminate=*/false);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002795 return getConstantGEP(VMContext, Entry, 0, 0);
2796}
2797
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002798llvm::Constant *CGObjCCommonMac::BuildRCBlockLayout(CodeGenModule &CGM,
2799 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002800 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2801
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002802 RunSkipBlockVars.clear();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002803 bool hasUnion = false;
2804
John McCallc8e01702013-04-16 22:48:15 +00002805 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2806 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002807 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2808
2809 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2810
2811 // Calculate the basic layout of the block structure.
2812 const llvm::StructLayout *layout =
2813 CGM.getDataLayout().getStructLayout(blockInfo.StructureType);
2814
2815 // Ignore the optional 'this' capture: C++ objects are not assumed
2816 // to be GC'ed.
Fariborz Jahanian4cf177e2012-12-04 17:20:57 +00002817 if (blockInfo.BlockHeaderForcedGapSize != CharUnits::Zero())
2818 UpdateRunSkipBlockVars(false, Qualifiers::OCL_None,
2819 blockInfo.BlockHeaderForcedGapOffset,
2820 blockInfo.BlockHeaderForcedGapSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002821 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002822 for (const auto &CI : blockDecl->captures()) {
2823 const VarDecl *variable = CI.getVariable();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002824 QualType type = variable->getType();
2825
2826 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2827
2828 // Ignore constant captures.
2829 if (capture.isConstant()) continue;
2830
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002831 CharUnits fieldOffset =
2832 CharUnits::fromQuantity(layout->getElementOffset(capture.getIndex()));
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002833
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002834 assert(!type->isArrayType() && "array variable should not be caught");
Aaron Ballman9371dd22014-03-14 18:34:04 +00002835 if (!CI.isByRef())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002836 if (const RecordType *record = type->getAs<RecordType>()) {
2837 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion);
2838 continue;
2839 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002840 CharUnits fieldSize;
Aaron Ballman9371dd22014-03-14 18:34:04 +00002841 if (CI.isByRef())
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002842 fieldSize = CharUnits::fromQuantity(WordSizeInBytes);
2843 else
2844 fieldSize = CGM.getContext().getTypeSizeInChars(type);
Aaron Ballman9371dd22014-03-14 18:34:04 +00002845 UpdateRunSkipBlockVars(CI.isByRef(), getBlockCaptureLifetime(type, false),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002846 fieldOffset, fieldSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002847 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002848 return getBitmapBlockLayout(false);
2849}
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002850
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002851llvm::Constant *CGObjCCommonMac::BuildByrefLayout(CodeGen::CodeGenModule &CGM,
2852 QualType T) {
2853 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2854 assert(!T->isArrayType() && "__block array variable should not be caught");
2855 CharUnits fieldOffset;
2856 RunSkipBlockVars.clear();
2857 bool hasUnion = false;
2858 if (const RecordType *record = T->getAs<RecordType>()) {
2859 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion, true /*ByrefLayout */);
2860 llvm::Constant *Result = getBitmapBlockLayout(true);
Vedant Kumar2f5bb1152015-12-21 20:21:15 +00002861 if (isa<llvm::ConstantInt>(Result))
2862 Result = llvm::ConstantExpr::getIntToPtr(Result, CGM.Int8PtrTy);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002863 return Result;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002864 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002865 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2866 return nullPtr;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002867}
2868
John McCall882987f2013-02-28 19:01:20 +00002869llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00002870 const ObjCProtocolDecl *PD) {
Daniel Dunbar7050c552008-09-04 04:33:15 +00002871 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002872 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar7050c552008-09-04 04:33:15 +00002873 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2874
Owen Andersonade90fd2009-07-29 18:54:39 +00002875 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00002876 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002877}
2878
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002879void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stump18bb9282009-05-16 07:57:57 +00002880 // FIXME: We shouldn't need this, the protocol decl should contain enough
2881 // information to tell us whether this was a declaration or a definition.
Daniel Dunbarc475d422008-10-29 22:36:39 +00002882 DefinedProtocols.insert(PD->getIdentifier());
2883
2884 // If we have generated a forward reference to this protocol, emit
2885 // it now. Otherwise do nothing, the protocol objects are lazily
2886 // emitted.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002887 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbarc475d422008-10-29 22:36:39 +00002888 GetOrEmitProtocol(PD);
2889}
2890
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002891llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002892 if (DefinedProtocols.count(PD->getIdentifier()))
2893 return GetOrEmitProtocol(PD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002894
Daniel Dunbarc475d422008-10-29 22:36:39 +00002895 return GetOrEmitProtocolRef(PD);
2896}
2897
Douglas Gregor24ae22c2016-04-01 23:23:52 +00002898llvm::Value *CGObjCCommonMac::EmitClassRefViaRuntime(
2899 CodeGenFunction &CGF,
2900 const ObjCInterfaceDecl *ID,
2901 ObjCCommonTypesHelper &ObjCTypes) {
2902 llvm::Constant *lookUpClassFn = ObjCTypes.getLookUpClassFn();
2903
2904 llvm::Value *className =
2905 CGF.CGM.GetAddrOfConstantCString(ID->getObjCRuntimeNameAsString())
2906 .getPointer();
2907 ASTContext &ctx = CGF.CGM.getContext();
2908 className =
2909 CGF.Builder.CreateBitCast(className,
2910 CGF.ConvertType(
2911 ctx.getPointerType(ctx.CharTy.withConst())));
2912 llvm::CallInst *call = CGF.Builder.CreateCall(lookUpClassFn, className);
2913 call->setDoesNotThrow();
2914 return call;
2915}
2916
Daniel Dunbarb036db82008-08-13 03:21:16 +00002917/*
Rafael Espindolaf9e1e5e2014-02-20 14:09:04 +00002918// Objective-C 1.0 extensions
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002919struct _objc_protocol {
2920struct _objc_protocol_extension *isa;
2921char *protocol_name;
2922struct _objc_protocol_list *protocol_list;
2923struct _objc__method_prototype_list *instance_methods;
2924struct _objc__method_prototype_list *class_methods
2925};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002926
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002927See EmitProtocolExtension().
Daniel Dunbarb036db82008-08-13 03:21:16 +00002928*/
Daniel Dunbarc475d422008-10-29 22:36:39 +00002929llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00002930 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbarc475d422008-10-29 22:36:39 +00002931
2932 // Early exit if a defining object has already been generated.
2933 if (Entry && Entry->hasInitializer())
2934 return Entry;
2935
Douglas Gregora715bff2012-01-01 19:51:50 +00002936 // Use the protocol definition, if there is one.
2937 if (const ObjCProtocolDecl *Def = PD->getDefinition())
2938 PD = Def;
2939
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002940 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002941 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002942 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2943
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002944 // Construct method lists.
John McCall176f8922016-11-30 02:39:18 +00002945 auto methodLists = ProtocolMethodLists::get(PD);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002946
John McCall176f8922016-11-30 02:39:18 +00002947 ConstantInitBuilder builder(CGM);
2948 auto values = builder.beginStruct(ObjCTypes.ProtocolTy);
2949 values.add(EmitProtocolExtension(PD, methodLists));
2950 values.add(GetClassName(PD->getObjCRuntimeNameAsString()));
2951 values.add(EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
2952 PD->protocol_begin(), PD->protocol_end()));
2953 values.add(methodLists.emitMethodList(this, PD,
2954 ProtocolMethodLists::RequiredInstanceMethods));
2955 values.add(methodLists.emitMethodList(this, PD,
2956 ProtocolMethodLists::RequiredClassMethods));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002957
Daniel Dunbarb036db82008-08-13 03:21:16 +00002958 if (Entry) {
Rafael Espindola5d117f32014-03-06 01:10:46 +00002959 // Already created, update the initializer.
Rafael Espindolab3262952014-05-09 00:43:37 +00002960 assert(Entry->hasPrivateLinkage());
John McCall176f8922016-11-30 02:39:18 +00002961 values.finishAndSetAsInitializer(Entry);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002962 } else {
John McCall176f8922016-11-30 02:39:18 +00002963 Entry = values.finishAndCreateGlobal("OBJC_PROTOCOL_" + PD->getName(),
2964 CGM.getPointerAlign(),
2965 /*constant*/ false,
2966 llvm::GlobalValue::PrivateLinkage);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002967 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
John McCallf9582a72012-03-30 21:29:05 +00002968
2969 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002970 }
Rafael Espindola060062a2014-03-06 22:15:10 +00002971 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbarc475d422008-10-29 22:36:39 +00002972
2973 return Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002974}
2975
Daniel Dunbarc475d422008-10-29 22:36:39 +00002976llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002977 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
2978
2979 if (!Entry) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002980 // We use the initializer as a marker of whether this is a forward
2981 // reference or not. At module finalization we add the empty
2982 // contents for protocols which were referenced but never defined.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002983 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2984 false, llvm::GlobalValue::PrivateLinkage,
2985 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002986 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002987 // FIXME: Is this necessary? Why only for protocol?
2988 Entry->setAlignment(4);
2989 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002990
Daniel Dunbarb036db82008-08-13 03:21:16 +00002991 return Entry;
2992}
2993
2994/*
2995 struct _objc_protocol_extension {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002996 uint32_t size;
2997 struct objc_method_description_list *optional_instance_methods;
2998 struct objc_method_description_list *optional_class_methods;
2999 struct objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003000 const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00003001 struct objc_property_list *class_properties;
Daniel Dunbarb036db82008-08-13 03:21:16 +00003002 };
3003*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003004llvm::Constant *
3005CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
John McCall176f8922016-11-30 02:39:18 +00003006 const ProtocolMethodLists &methodLists) {
3007 auto optInstanceMethods =
3008 methodLists.emitMethodList(this, PD,
3009 ProtocolMethodLists::OptionalInstanceMethods);
3010 auto optClassMethods =
3011 methodLists.emitMethodList(this, PD,
3012 ProtocolMethodLists::OptionalClassMethods);
3013
3014 auto extendedMethodTypes =
3015 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
3016 methodLists.emitExtendedTypesArray(this),
3017 ObjCTypes);
3018
3019 auto instanceProperties =
3020 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
3021 ObjCTypes, false);
3022 auto classProperties =
3023 EmitPropertyList("OBJC_$_CLASS_PROP_PROTO_LIST_" + PD->getName(), nullptr,
3024 PD, ObjCTypes, true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003025
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003026 // Return null if no extension bits are used.
John McCall176f8922016-11-30 02:39:18 +00003027 if (optInstanceMethods->isNullValue() &&
3028 optClassMethods->isNullValue() &&
3029 extendedMethodTypes->isNullValue() &&
3030 instanceProperties->isNullValue() &&
3031 classProperties->isNullValue()) {
Owen Anderson0b75f232009-07-31 20:28:54 +00003032 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
John McCall176f8922016-11-30 02:39:18 +00003033 }
Daniel Dunbarb036db82008-08-13 03:21:16 +00003034
John McCall176f8922016-11-30 02:39:18 +00003035 uint64_t size =
3036 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
3037
3038 ConstantInitBuilder builder(CGM);
3039 auto values = builder.beginStruct(ObjCTypes.ProtocolExtensionTy);
3040 values.addInt(ObjCTypes.IntTy, size);
3041 values.add(optInstanceMethods);
3042 values.add(optClassMethods);
3043 values.add(instanceProperties);
3044 values.add(extendedMethodTypes);
3045 values.add(classProperties);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003046
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003047 // No special section, but goes in llvm.used
John McCall176f8922016-11-30 02:39:18 +00003048 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), values,
John McCall7f416cc2015-09-08 08:05:57 +00003049 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003050}
3051
3052/*
3053 struct objc_protocol_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00003054 struct objc_protocol_list *next;
3055 long count;
3056 Protocol *list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00003057 };
3058*/
Daniel Dunbardec75f82008-08-21 21:57:41 +00003059llvm::Constant *
Zachary Turner41a9ee92017-10-11 23:54:34 +00003060CGObjCMac::EmitProtocolList(Twine name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00003061 ObjCProtocolDecl::protocol_iterator begin,
3062 ObjCProtocolDecl::protocol_iterator end) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00003063 // Just return null for empty protocol lists
John McCall176f8922016-11-30 02:39:18 +00003064 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00003065 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003066
John McCall176f8922016-11-30 02:39:18 +00003067 ConstantInitBuilder builder(CGM);
3068 auto values = builder.beginStruct();
Daniel Dunbarb036db82008-08-13 03:21:16 +00003069
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003070 // This field is only used by the runtime.
John McCall176f8922016-11-30 02:39:18 +00003071 values.addNullPointer(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003072
John McCall176f8922016-11-30 02:39:18 +00003073 // Reserve a slot for the count.
3074 auto countSlot = values.addPlaceholder();
3075
3076 auto refsArray = values.beginArray(ObjCTypes.ProtocolPtrTy);
3077 for (; begin != end; ++begin) {
3078 refsArray.add(GetProtocolRef(*begin));
3079 }
3080 auto count = refsArray.size();
3081
3082 // This list is null terminated.
3083 refsArray.addNullPointer(ObjCTypes.ProtocolPtrTy);
3084
3085 refsArray.finishAndAddTo(values);
3086 values.fillPlaceholderWithInt(countSlot, ObjCTypes.LongTy, count);
3087
3088 StringRef section;
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003089 if (CGM.getTriple().isOSBinFormatMachO())
John McCall176f8922016-11-30 02:39:18 +00003090 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003091
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003092 llvm::GlobalVariable *GV =
Zachary Turner41a9ee92017-10-11 23:54:34 +00003093 CreateMetadataVar(name, values, section, CGM.getPointerAlign(), false);
Owen Andersonade90fd2009-07-29 18:54:39 +00003094 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003095}
3096
John McCall176f8922016-11-30 02:39:18 +00003097static void
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003098PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
John McCall176f8922016-11-30 02:39:18 +00003099 SmallVectorImpl<const ObjCPropertyDecl *> &Properties,
Aaron Ballmandc4bea42014-03-13 18:47:37 +00003100 const ObjCProtocolDecl *Proto,
Manman Renad0e7912016-01-29 19:22:54 +00003101 bool IsClassProperty) {
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00003102 for (const auto *P : Proto->protocols())
John McCall176f8922016-11-30 02:39:18 +00003103 PushProtocolProperties(PropertySet, Properties, P, IsClassProperty);
Manman Renad0e7912016-01-29 19:22:54 +00003104
3105 for (const auto *PD : Proto->properties()) {
3106 if (IsClassProperty != PD->isClassProperty())
3107 continue;
David Blaikie82e95a32014-11-19 07:49:47 +00003108 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00003109 continue;
John McCall176f8922016-11-30 02:39:18 +00003110 Properties.push_back(PD);
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00003111 }
3112}
3113
Daniel Dunbarb036db82008-08-13 03:21:16 +00003114/*
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003115 struct _objc_property {
Bill Wendlinga515b582012-02-09 22:16:49 +00003116 const char * const name;
3117 const char * const attributes;
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003118 };
3119
3120 struct _objc_property_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00003121 uint32_t entsize; // sizeof (struct _objc_property)
3122 uint32_t prop_count;
3123 struct _objc_property[prop_count];
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003124 };
3125*/
Zachary Turner41a9ee92017-10-11 23:54:34 +00003126llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
3127 const Decl *Container,
3128 const ObjCContainerDecl *OCD,
3129 const ObjCCommonTypesHelper &ObjCTypes,
3130 bool IsClassProperty) {
Manman Ren01b705e2016-04-19 19:05:03 +00003131 if (IsClassProperty) {
3132 // Make this entry NULL for OS X with deployment target < 10.11, for iOS
3133 // with deployment target < 9.0.
3134 const llvm::Triple &Triple = CGM.getTarget().getTriple();
3135 if ((Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 11)) ||
3136 (Triple.isiOS() && Triple.isOSVersionLT(9)))
3137 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
3138 }
3139
John McCall176f8922016-11-30 02:39:18 +00003140 SmallVector<const ObjCPropertyDecl *, 16> Properties;
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00003141 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weber08c93332015-12-03 17:44:51 +00003142
Nico Weber08c93332015-12-03 17:44:51 +00003143 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
3144 for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
Manman Renad0e7912016-01-29 19:22:54 +00003145 for (auto *PD : ClassExt->properties()) {
3146 if (IsClassProperty != PD->isClassProperty())
3147 continue;
Nico Weber08c93332015-12-03 17:44:51 +00003148 PropertySet.insert(PD->getIdentifier());
John McCall176f8922016-11-30 02:39:18 +00003149 Properties.push_back(PD);
Nico Weber08c93332015-12-03 17:44:51 +00003150 }
Manman Renad0e7912016-01-29 19:22:54 +00003151
3152 for (const auto *PD : OCD->properties()) {
3153 if (IsClassProperty != PD->isClassProperty())
3154 continue;
Nico Weber08c93332015-12-03 17:44:51 +00003155 // Don't emit duplicate metadata for properties that were already in a
3156 // class extension.
3157 if (!PropertySet.insert(PD->getIdentifier()).second)
3158 continue;
John McCall176f8922016-11-30 02:39:18 +00003159 Properties.push_back(PD);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003160 }
Nico Weber08c93332015-12-03 17:44:51 +00003161
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003162 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Aaron Ballmana9f49e32014-03-13 20:55:22 +00003163 for (const auto *P : OID->all_referenced_protocols())
John McCall176f8922016-11-30 02:39:18 +00003164 PushProtocolProperties(PropertySet, Properties, P, IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003165 }
3166 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Aaron Ballman19a41762014-03-14 12:55:57 +00003167 for (const auto *P : CD->protocols())
John McCall176f8922016-11-30 02:39:18 +00003168 PushProtocolProperties(PropertySet, Properties, P, IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003169 }
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003170
3171 // Return null for empty list.
3172 if (Properties.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003173 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003174
John McCall176f8922016-11-30 02:39:18 +00003175 unsigned propertySize =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003176 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
John McCall176f8922016-11-30 02:39:18 +00003177
3178 ConstantInitBuilder builder(CGM);
3179 auto values = builder.beginStruct();
3180 values.addInt(ObjCTypes.IntTy, propertySize);
3181 values.addInt(ObjCTypes.IntTy, Properties.size());
3182 auto propertiesArray = values.beginArray(ObjCTypes.PropertyTy);
3183 for (auto PD : Properties) {
3184 auto property = propertiesArray.beginStruct(ObjCTypes.PropertyTy);
3185 property.add(GetPropertyName(PD->getIdentifier()));
3186 property.add(GetPropertyTypeString(PD, Container));
3187 property.finishAndAddTo(propertiesArray);
3188 }
3189 propertiesArray.finishAndAddTo(values);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003190
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003191 StringRef Section;
3192 if (CGM.getTriple().isOSBinFormatMachO())
3193 Section = (ObjCABI == 2) ? "__DATA, __objc_const"
3194 : "__OBJC,__property,regular,no_dead_strip";
3195
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003196 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00003197 CreateMetadataVar(Name, values, Section, CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003198 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003199}
3200
Zachary Turner41a9ee92017-10-11 23:54:34 +00003201llvm::Constant *
3202CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
3203 ArrayRef<llvm::Constant*> MethodTypes,
3204 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003205 // Return null for empty list.
3206 if (MethodTypes.empty())
3207 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
3208
3209 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
3210 MethodTypes.size());
3211 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
3212
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003213 StringRef Section;
3214 if (CGM.getTriple().isOSBinFormatMachO() && ObjCABI == 2)
3215 Section = "__DATA, __objc_const";
3216
3217 llvm::GlobalVariable *GV =
3218 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003219 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
3220}
3221
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003222/*
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003223 struct _objc_category {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003224 char *category_name;
3225 char *class_name;
3226 struct _objc_method_list *instance_methods;
3227 struct _objc_method_list *class_methods;
3228 struct _objc_protocol_list *protocols;
3229 uint32_t size; // <rdar://4585769>
3230 struct _objc_property_list *instance_properties;
Manman Ren96df0b32016-01-29 23:45:01 +00003231 struct _objc_property_list *class_properties;
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003232 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003233*/
Daniel Dunbar92992502008-08-15 22:20:32 +00003234void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00003235 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003236
Mike Stump18bb9282009-05-16 07:57:57 +00003237 // FIXME: This is poor design, the OCD should have a pointer to the category
3238 // decl. Additionally, note that Category can be null for the @implementation
3239 // w/o an @interface case. Sema should just create one for us as it does for
3240 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003241 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003242 const ObjCCategoryDecl *Category =
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003243 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003244
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003245 SmallString<256> ExtName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003246 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3247 << OCD->getName();
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003248
John McCall176f8922016-11-30 02:39:18 +00003249 ConstantInitBuilder Builder(CGM);
3250 auto Values = Builder.beginStruct(ObjCTypes.CategoryTy);
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003251
John McCall176f8922016-11-30 02:39:18 +00003252 enum {
3253 InstanceMethods,
3254 ClassMethods,
3255 NumMethodLists
3256 };
3257 SmallVector<const ObjCMethodDecl *, 16> Methods[NumMethodLists];
3258 for (const auto *MD : OCD->methods()) {
3259 Methods[unsigned(MD->isClassMethod())].push_back(MD);
3260 }
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003261
John McCall176f8922016-11-30 02:39:18 +00003262 Values.add(GetClassName(OCD->getName()));
3263 Values.add(GetClassName(Interface->getObjCRuntimeNameAsString()));
Fariborz Jahaniane55f8662009-04-29 20:40:05 +00003264 LazySymbols.insert(Interface->getIdentifier());
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003265
John McCall176f8922016-11-30 02:39:18 +00003266 Values.add(emitMethodList(ExtName, MethodListType::CategoryInstanceMethods,
3267 Methods[InstanceMethods]));
3268 Values.add(emitMethodList(ExtName, MethodListType::CategoryClassMethods,
3269 Methods[ClassMethods]));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003270 if (Category) {
John McCall176f8922016-11-30 02:39:18 +00003271 Values.add(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003272 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
John McCall176f8922016-11-30 02:39:18 +00003273 Category->protocol_begin(), Category->protocol_end()));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003274 } else {
John McCall176f8922016-11-30 02:39:18 +00003275 Values.addNullPointer(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003276 }
John McCall176f8922016-11-30 02:39:18 +00003277 Values.addInt(ObjCTypes.IntTy, Size);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003278
3279 // If there is no category @interface then there can be no properties.
3280 if (Category) {
John McCall176f8922016-11-30 02:39:18 +00003281 Values.add(EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
3282 OCD, Category, ObjCTypes, false));
3283 Values.add(EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
3284 OCD, Category, ObjCTypes, true));
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003285 } else {
John McCall176f8922016-11-30 02:39:18 +00003286 Values.addNullPointer(ObjCTypes.PropertyListPtrTy);
3287 Values.addNullPointer(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003288 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003289
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003290 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00003291 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Values,
John McCall7f416cc2015-09-08 08:05:57 +00003292 "__OBJC,__category,regular,no_dead_strip",
3293 CGM.getPointerAlign(), true);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003294 DefinedCategories.push_back(GV);
Justin Lebar5e83dfe2016-10-21 21:45:01 +00003295 DefinedCategoryNames.insert(llvm::CachedHashString(ExtName));
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003296 // method definition entries must be clear for next implementation.
3297 MethodDefinitions.clear();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003298}
3299
John McCallef19dbb2012-10-17 04:53:23 +00003300enum FragileClassFlags {
John McCall460ce582015-10-22 18:38:17 +00003301 /// Apparently: is not a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003302 FragileABI_Class_Factory = 0x00001,
John McCall460ce582015-10-22 18:38:17 +00003303
3304 /// Is a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003305 FragileABI_Class_Meta = 0x00002,
John McCall460ce582015-10-22 18:38:17 +00003306
3307 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003308 FragileABI_Class_HasCXXStructors = 0x02000,
John McCall460ce582015-10-22 18:38:17 +00003309
3310 /// Has hidden visibility.
John McCall09ec1ec2015-10-21 22:06:03 +00003311 FragileABI_Class_Hidden = 0x20000,
John McCall460ce582015-10-22 18:38:17 +00003312
3313 /// Class implementation was compiled under ARC.
3314 FragileABI_Class_CompiledByARC = 0x04000000,
3315
3316 /// Class implementation was compiled under MRC and has MRC weak ivars.
3317 /// Exclusive with CompiledByARC.
3318 FragileABI_Class_HasMRCWeakIvars = 0x08000000,
John McCallef19dbb2012-10-17 04:53:23 +00003319};
3320
3321enum NonFragileClassFlags {
3322 /// Is a meta-class.
3323 NonFragileABI_Class_Meta = 0x00001,
3324
3325 /// Is a root class.
3326 NonFragileABI_Class_Root = 0x00002,
3327
John McCall460ce582015-10-22 18:38:17 +00003328 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003329 NonFragileABI_Class_HasCXXStructors = 0x00004,
3330
3331 /// Has hidden visibility.
3332 NonFragileABI_Class_Hidden = 0x00010,
3333
3334 /// Has the exception attribute.
3335 NonFragileABI_Class_Exception = 0x00020,
3336
3337 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3338 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3339
3340 /// Class implementation was compiled under ARC.
John McCall0d54a172012-10-17 04:53:31 +00003341 NonFragileABI_Class_CompiledByARC = 0x00080,
3342
3343 /// Class has non-trivial destructors, but zero-initialization is okay.
John McCall460ce582015-10-22 18:38:17 +00003344 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100,
3345
3346 /// Class implementation was compiled under MRC and has MRC weak ivars.
3347 /// Exclusive with CompiledByARC.
3348 NonFragileABI_Class_HasMRCWeakIvars = 0x00200,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003349};
3350
John McCall460ce582015-10-22 18:38:17 +00003351static bool hasWeakMember(QualType type) {
3352 if (type.getObjCLifetime() == Qualifiers::OCL_Weak) {
3353 return true;
3354 }
3355
3356 if (auto recType = type->getAs<RecordType>()) {
3357 for (auto field : recType->getDecl()->fields()) {
3358 if (hasWeakMember(field->getType()))
3359 return true;
3360 }
3361 }
3362
3363 return false;
3364}
3365
3366/// For compatibility, we only want to set the "HasMRCWeakIvars" flag
3367/// (and actually fill in a layout string) if we really do have any
3368/// __weak ivars.
3369static bool hasMRCWeakIvars(CodeGenModule &CGM,
3370 const ObjCImplementationDecl *ID) {
3371 if (!CGM.getLangOpts().ObjCWeak) return false;
3372 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
3373
3374 for (const ObjCIvarDecl *ivar =
3375 ID->getClassInterface()->all_declared_ivar_begin();
3376 ivar; ivar = ivar->getNextIvar()) {
3377 if (hasWeakMember(ivar->getType()))
3378 return true;
3379 }
3380
3381 return false;
3382}
3383
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003384/*
3385 struct _objc_class {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003386 Class isa;
3387 Class super_class;
3388 const char *name;
3389 long version;
3390 long info;
3391 long instance_size;
3392 struct _objc_ivar_list *ivars;
3393 struct _objc_method_list *methods;
3394 struct _objc_cache *cache;
3395 struct _objc_protocol_list *protocols;
3396 // Objective-C 1.0 extensions (<rdr://4585769>)
3397 const char *ivar_layout;
3398 struct _objc_class_ext *ext;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003399 };
3400
3401 See EmitClassExtension();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003402*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003403void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Akira Hatanaka0c194462018-04-03 22:50:16 +00003404 IdentifierInfo *RuntimeName =
3405 &CGM.getContext().Idents.get(ID->getObjCRuntimeNameAsString());
3406 DefinedSymbols.insert(RuntimeName);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003407
Chris Lattner86d7d912008-11-24 03:54:41 +00003408 std::string ClassName = ID->getNameAsString();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003409 // FIXME: Gross
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003410 ObjCInterfaceDecl *Interface =
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003411 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003412 llvm::Constant *Protocols =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003413 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3414 Interface->all_referenced_protocol_begin(),
3415 Interface->all_referenced_protocol_end());
John McCallef19dbb2012-10-17 04:53:23 +00003416 unsigned Flags = FragileABI_Class_Factory;
John McCall0d54a172012-10-17 04:53:31 +00003417 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCallef19dbb2012-10-17 04:53:23 +00003418 Flags |= FragileABI_Class_HasCXXStructors;
John McCall09ec1ec2015-10-21 22:06:03 +00003419
John McCall460ce582015-10-22 18:38:17 +00003420 bool hasMRCWeak = false;
3421
John McCall09ec1ec2015-10-21 22:06:03 +00003422 if (CGM.getLangOpts().ObjCAutoRefCount)
3423 Flags |= FragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00003424 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
3425 Flags |= FragileABI_Class_HasMRCWeakIvars;
John McCall09ec1ec2015-10-21 22:06:03 +00003426
John McCall3fd13f062015-10-21 18:06:47 +00003427 CharUnits Size =
3428 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003429
3430 // FIXME: Set CXX-structors flag.
John McCall457a04e2010-10-22 21:05:15 +00003431 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003432 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003433
John McCall176f8922016-11-30 02:39:18 +00003434 enum {
3435 InstanceMethods,
3436 ClassMethods,
3437 NumMethodLists
3438 };
3439 SmallVector<const ObjCMethodDecl *, 16> Methods[NumMethodLists];
3440 for (const auto *MD : ID->methods()) {
3441 Methods[unsigned(MD->isClassMethod())].push_back(MD);
3442 }
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003443
Aaron Ballmand85eff42014-03-14 15:02:45 +00003444 for (const auto *PID : ID->property_impls()) {
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003445 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3446 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3447
3448 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
John McCall176f8922016-11-30 02:39:18 +00003449 if (GetMethodDefinition(MD))
3450 Methods[InstanceMethods].push_back(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003451 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
John McCall176f8922016-11-30 02:39:18 +00003452 if (GetMethodDefinition(MD))
3453 Methods[InstanceMethods].push_back(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003454 }
3455 }
3456
John McCall176f8922016-11-30 02:39:18 +00003457 ConstantInitBuilder builder(CGM);
3458 auto values = builder.beginStruct(ObjCTypes.ClassTy);
3459 values.add(EmitMetaClass(ID, Protocols, Methods[ClassMethods]));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003460 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003461 // Record a reference to the super class.
3462 LazySymbols.insert(Super->getIdentifier());
3463
John McCall176f8922016-11-30 02:39:18 +00003464 values.addBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
3465 ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003466 } else {
John McCall176f8922016-11-30 02:39:18 +00003467 values.addNullPointer(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003468 }
John McCall176f8922016-11-30 02:39:18 +00003469 values.add(GetClassName(ID->getObjCRuntimeNameAsString()));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003470 // Version is always 0.
John McCall176f8922016-11-30 02:39:18 +00003471 values.addInt(ObjCTypes.LongTy, 0);
3472 values.addInt(ObjCTypes.LongTy, Flags);
3473 values.addInt(ObjCTypes.LongTy, Size.getQuantity());
3474 values.add(EmitIvarList(ID, false));
3475 values.add(emitMethodList(ID->getName(), MethodListType::InstanceMethods,
3476 Methods[InstanceMethods]));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003477 // cache is always NULL.
John McCall176f8922016-11-30 02:39:18 +00003478 values.addNullPointer(ObjCTypes.CachePtrTy);
3479 values.add(Protocols);
3480 values.add(BuildStrongIvarLayout(ID, CharUnits::Zero(), Size));
3481 values.add(EmitClassExtension(ID, Size, hasMRCWeak,
3482 /*isMetaclass*/ false));
3483
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003484 std::string Name("OBJC_CLASS_");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003485 Name += ClassName;
3486 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3487 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003488 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003489 if (GV) {
3490 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3491 "Forward metaclass reference has incorrect type.");
John McCall176f8922016-11-30 02:39:18 +00003492 values.finishAndSetAsInitializer(GV);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003493 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003494 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00003495 CGM.addCompilerUsedGlobal(GV);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003496 } else
John McCall176f8922016-11-30 02:39:18 +00003497 GV = CreateMetadataVar(Name, values, Section, CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003498 DefinedClasses.push_back(GV);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00003499 ImplementedClasses.push_back(Interface);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003500 // method definition entries must be clear for next implementation.
3501 MethodDefinitions.clear();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003502}
3503
3504llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3505 llvm::Constant *Protocols,
John McCall176f8922016-11-30 02:39:18 +00003506 ArrayRef<const ObjCMethodDecl*> Methods) {
John McCallef19dbb2012-10-17 04:53:23 +00003507 unsigned Flags = FragileABI_Class_Meta;
Micah Villmowdd31ca12012-10-08 16:25:52 +00003508 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003509
John McCall457a04e2010-10-22 21:05:15 +00003510 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003511 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003512
John McCall176f8922016-11-30 02:39:18 +00003513 ConstantInitBuilder builder(CGM);
3514 auto values = builder.beginStruct(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003515 // The isa for the metaclass is the root of the hierarchy.
3516 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3517 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3518 Root = Super;
John McCall176f8922016-11-30 02:39:18 +00003519 values.addBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
3520 ObjCTypes.ClassPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003521 // The super class for the metaclass is emitted as the name of the
3522 // super class. The runtime fixes this up to point to the
3523 // *metaclass* for the super class.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003524 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
John McCall176f8922016-11-30 02:39:18 +00003525 values.addBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
3526 ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003527 } else {
John McCall176f8922016-11-30 02:39:18 +00003528 values.addNullPointer(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003529 }
John McCall176f8922016-11-30 02:39:18 +00003530 values.add(GetClassName(ID->getObjCRuntimeNameAsString()));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003531 // Version is always 0.
John McCall176f8922016-11-30 02:39:18 +00003532 values.addInt(ObjCTypes.LongTy, 0);
3533 values.addInt(ObjCTypes.LongTy, Flags);
3534 values.addInt(ObjCTypes.LongTy, Size);
3535 values.add(EmitIvarList(ID, true));
3536 values.add(emitMethodList(ID->getName(), MethodListType::ClassMethods,
3537 Methods));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003538 // cache is always NULL.
John McCall176f8922016-11-30 02:39:18 +00003539 values.addNullPointer(ObjCTypes.CachePtrTy);
3540 values.add(Protocols);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003541 // ivar_layout for metaclass is always NULL.
John McCall176f8922016-11-30 02:39:18 +00003542 values.addNullPointer(ObjCTypes.Int8PtrTy);
Manman Renad0e7912016-01-29 19:22:54 +00003543 // The class extension is used to store class properties for metaclasses.
John McCall176f8922016-11-30 02:39:18 +00003544 values.add(EmitClassExtension(ID, CharUnits::Zero(), false/*hasMRCWeak*/,
3545 /*isMetaclass*/true));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003546
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003547 std::string Name("OBJC_METACLASS_");
Benjamin Kramer1bbcbd02012-07-31 11:45:39 +00003548 Name += ID->getName();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003549
3550 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003551 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003552 if (GV) {
3553 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3554 "Forward metaclass reference has incorrect type.");
John McCall176f8922016-11-30 02:39:18 +00003555 values.finishAndSetAsInitializer(GV);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003556 } else {
John McCall176f8922016-11-30 02:39:18 +00003557 GV = values.finishAndCreateGlobal(Name, CGM.getPointerAlign(),
3558 /*constant*/ false,
3559 llvm::GlobalValue::PrivateLinkage);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003560 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003561 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00003562 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003563
3564 return GV;
3565}
3566
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003567llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003568 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003569
Mike Stump18bb9282009-05-16 07:57:57 +00003570 // FIXME: Should we look these up somewhere other than the module. Its a bit
3571 // silly since we only generate these while processing an implementation, so
3572 // exactly one pointer would work if know when we entered/exitted an
3573 // implementation block.
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003574
3575 // Check for an existing forward reference.
Fariborz Jahanian475831b2009-01-07 20:11:22 +00003576 // Previously, metaclass with internal linkage may have been defined.
3577 // pass 'true' as 2nd argument so it is returned.
Rafael Espindola21039aa2014-02-27 16:26:32 +00003578 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3579 if (!GV)
3580 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003581 llvm::GlobalValue::PrivateLinkage, nullptr,
3582 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003583
3584 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3585 "Forward metaclass reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003586 return GV;
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003587}
3588
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003589llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003590 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Rafael Espindola21039aa2014-02-27 16:26:32 +00003591 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3592
3593 if (!GV)
3594 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003595 llvm::GlobalValue::PrivateLinkage, nullptr,
3596 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003597
3598 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3599 "Forward class metadata reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003600 return GV;
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003601}
3602
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003603/*
John McCall3fd13f062015-10-21 18:06:47 +00003604 Emit a "class extension", which in this specific context means extra
3605 data that doesn't fit in the normal fragile-ABI class structure, and
3606 has nothing to do with the language concept of a class extension.
3607
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003608 struct objc_class_ext {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003609 uint32_t size;
3610 const char *weak_ivar_layout;
3611 struct _objc_property_list *properties;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003612 };
3613*/
3614llvm::Constant *
John McCall3fd13f062015-10-21 18:06:47 +00003615CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
Manman Renad0e7912016-01-29 19:22:54 +00003616 CharUnits InstanceSize, bool hasMRCWeakIvars,
John McCall176f8922016-11-30 02:39:18 +00003617 bool isMetaclass) {
3618 // Weak ivar layout.
3619 llvm::Constant *layout;
3620 if (isMetaclass) {
3621 layout = llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
3622 } else {
3623 layout = BuildWeakIvarLayout(ID, CharUnits::Zero(), InstanceSize,
3624 hasMRCWeakIvars);
3625 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003626
John McCall176f8922016-11-30 02:39:18 +00003627 // Properties.
3628 llvm::Constant *propertyList =
3629 EmitPropertyList((isMetaclass ? Twine("\01l_OBJC_$_CLASS_PROP_LIST_")
3630 : Twine("\01l_OBJC_$_PROP_LIST_"))
3631 + ID->getName(),
3632 ID, ID->getClassInterface(), ObjCTypes, isMetaclass);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003633
3634 // Return null if no extension bits are used.
John McCall176f8922016-11-30 02:39:18 +00003635 if (layout->isNullValue() && propertyList->isNullValue()) {
Owen Anderson0b75f232009-07-31 20:28:54 +00003636 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
John McCall176f8922016-11-30 02:39:18 +00003637 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003638
John McCall176f8922016-11-30 02:39:18 +00003639 uint64_t size =
3640 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
3641
3642 ConstantInitBuilder builder(CGM);
3643 auto values = builder.beginStruct(ObjCTypes.ClassExtensionTy);
3644 values.addInt(ObjCTypes.IntTy, size);
3645 values.add(layout);
3646 values.add(propertyList);
3647
3648 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), values,
John McCall7f416cc2015-09-08 08:05:57 +00003649 "__OBJC,__class_ext,regular,no_dead_strip",
3650 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003651}
3652
3653/*
3654 struct objc_ivar {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003655 char *ivar_name;
3656 char *ivar_type;
3657 int ivar_offset;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003658 };
3659
3660 struct objc_ivar_list {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003661 int ivar_count;
3662 struct objc_ivar list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003663 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003664*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003665llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003666 bool ForClass) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003667 // When emitting the root class GCC emits ivar entries for the
3668 // actual class structure. It is not clear if we need to follow this
3669 // behavior; for now lets try and get away with not doing it. If so,
3670 // the cleanest solution would be to make up an ObjCInterfaceDecl
3671 // for the class.
3672 if (ForClass)
Owen Anderson0b75f232009-07-31 20:28:54 +00003673 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003674
Jordy Rosea91768e2011-07-22 02:08:32 +00003675 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003676
John McCall176f8922016-11-30 02:39:18 +00003677 ConstantInitBuilder builder(CGM);
3678 auto ivarList = builder.beginStruct();
3679 auto countSlot = ivarList.addPlaceholder();
3680 auto ivars = ivarList.beginArray(ObjCTypes.IvarTy);
3681
Jordy Rosea91768e2011-07-22 02:08:32 +00003682 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00003683 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00003684 // Ignore unnamed bit-fields.
3685 if (!IVD->getDeclName())
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003686 continue;
John McCall176f8922016-11-30 02:39:18 +00003687
3688 auto ivar = ivars.beginStruct(ObjCTypes.IvarTy);
3689 ivar.add(GetMethodVarName(IVD->getIdentifier()));
3690 ivar.add(GetMethodVarType(IVD));
3691 ivar.addInt(ObjCTypes.IntTy, ComputeIvarBaseOffset(CGM, OID, IVD));
3692 ivar.finishAndAddTo(ivars);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003693 }
3694
3695 // Return null for empty list.
John McCall176f8922016-11-30 02:39:18 +00003696 auto count = ivars.size();
3697 if (count == 0) {
3698 ivars.abandon();
3699 ivarList.abandon();
Owen Anderson0b75f232009-07-31 20:28:54 +00003700 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
John McCall176f8922016-11-30 02:39:18 +00003701 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003702
John McCall176f8922016-11-30 02:39:18 +00003703 ivars.finishAndAddTo(ivarList);
3704 ivarList.fillPlaceholderWithInt(countSlot, ObjCTypes.IntTy, count);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003705
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003706 llvm::GlobalVariable *GV;
3707 if (ForClass)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003708 GV =
John McCall176f8922016-11-30 02:39:18 +00003709 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), ivarList,
John McCall7f416cc2015-09-08 08:05:57 +00003710 "__OBJC,__class_vars,regular,no_dead_strip",
3711 CGM.getPointerAlign(), true);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003712 else
John McCall176f8922016-11-30 02:39:18 +00003713 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), ivarList,
John McCall7f416cc2015-09-08 08:05:57 +00003714 "__OBJC,__instance_vars,regular,no_dead_strip",
3715 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003716 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003717}
3718
John McCall176f8922016-11-30 02:39:18 +00003719/// Build a struct objc_method_description constant for the given method.
3720///
3721/// struct objc_method_description {
3722/// SEL method_name;
3723/// char *method_types;
3724/// };
3725void CGObjCMac::emitMethodDescriptionConstant(ConstantArrayBuilder &builder,
3726 const ObjCMethodDecl *MD) {
3727 auto description = builder.beginStruct(ObjCTypes.MethodDescriptionTy);
3728 description.addBitCast(GetMethodVarName(MD->getSelector()),
3729 ObjCTypes.SelectorPtrTy);
3730 description.add(GetMethodVarType(MD));
3731 description.finishAndAddTo(builder);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003732}
3733
John McCall176f8922016-11-30 02:39:18 +00003734/// Build a struct objc_method constant for the given method.
3735///
3736/// struct objc_method {
3737/// SEL method_name;
3738/// char *method_types;
3739/// void *method;
3740/// };
3741void CGObjCMac::emitMethodConstant(ConstantArrayBuilder &builder,
3742 const ObjCMethodDecl *MD) {
3743 llvm::Function *fn = GetMethodDefinition(MD);
3744 assert(fn && "no definition registered for method");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003745
John McCall176f8922016-11-30 02:39:18 +00003746 auto method = builder.beginStruct(ObjCTypes.MethodTy);
3747 method.addBitCast(GetMethodVarName(MD->getSelector()),
3748 ObjCTypes.SelectorPtrTy);
3749 method.add(GetMethodVarType(MD));
3750 method.addBitCast(fn, ObjCTypes.Int8PtrTy);
3751 method.finishAndAddTo(builder);
3752}
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003753
John McCall176f8922016-11-30 02:39:18 +00003754/// Build a struct objc_method_list or struct objc_method_description_list,
3755/// as appropriate.
3756///
3757/// struct objc_method_list {
3758/// struct objc_method_list *obsolete;
3759/// int count;
3760/// struct objc_method methods_list[count];
3761/// };
3762///
3763/// struct objc_method_description_list {
3764/// int count;
3765/// struct objc_method_description list[count];
3766/// };
Zachary Turner41a9ee92017-10-11 23:54:34 +00003767llvm::Constant *CGObjCMac::emitMethodList(Twine name, MethodListType MLT,
3768 ArrayRef<const ObjCMethodDecl *> methods) {
John McCall176f8922016-11-30 02:39:18 +00003769 StringRef prefix;
3770 StringRef section;
3771 bool forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003772 switch (MLT) {
3773 case MethodListType::CategoryInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003774 prefix = "OBJC_CATEGORY_INSTANCE_METHODS_";
3775 section = "__OBJC,__cat_inst_meth,regular,no_dead_strip";
3776 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003777 break;
3778 case MethodListType::CategoryClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003779 prefix = "OBJC_CATEGORY_CLASS_METHODS_";
3780 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
3781 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003782 break;
3783 case MethodListType::InstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003784 prefix = "OBJC_INSTANCE_METHODS_";
3785 section = "__OBJC,__inst_meth,regular,no_dead_strip";
3786 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003787 break;
3788 case MethodListType::ClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003789 prefix = "OBJC_CLASS_METHODS_";
3790 section = "__OBJC,__cls_meth,regular,no_dead_strip";
3791 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003792 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003793 case MethodListType::ProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003794 prefix = "OBJC_PROTOCOL_INSTANCE_METHODS_";
3795 section = "__OBJC,__cat_inst_meth,regular,no_dead_strip";
3796 forProtocol = true;
3797 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003798 case MethodListType::ProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003799 prefix = "OBJC_PROTOCOL_CLASS_METHODS_";
3800 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
3801 forProtocol = true;
3802 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003803 case MethodListType::OptionalProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003804 prefix = "OBJC_PROTOCOL_INSTANCE_METHODS_OPT_";
3805 section = "__OBJC,__cat_inst_meth,regular,no_dead_strip";
3806 forProtocol = true;
3807 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003808 case MethodListType::OptionalProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003809 prefix = "OBJC_PROTOCOL_CLASS_METHODS_OPT_";
3810 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
3811 forProtocol = true;
3812 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003813 }
3814
John McCall176f8922016-11-30 02:39:18 +00003815 // Return null for empty list.
3816 if (methods.empty())
3817 return llvm::Constant::getNullValue(forProtocol
3818 ? ObjCTypes.MethodDescriptionListPtrTy
3819 : ObjCTypes.MethodListPtrTy);
3820
3821 // For protocols, this is an objc_method_description_list, which has
3822 // a slightly different structure.
3823 if (forProtocol) {
3824 ConstantInitBuilder builder(CGM);
3825 auto values = builder.beginStruct();
3826 values.addInt(ObjCTypes.IntTy, methods.size());
3827 auto methodArray = values.beginArray(ObjCTypes.MethodDescriptionTy);
3828 for (auto MD : methods) {
3829 emitMethodDescriptionConstant(methodArray, MD);
3830 }
3831 methodArray.finishAndAddTo(values);
3832
Zachary Turner41a9ee92017-10-11 23:54:34 +00003833 llvm::GlobalVariable *GV = CreateMetadataVar(prefix + name, values, section,
John McCall176f8922016-11-30 02:39:18 +00003834 CGM.getPointerAlign(), true);
3835 return llvm::ConstantExpr::getBitCast(GV,
3836 ObjCTypes.MethodDescriptionListPtrTy);
3837 }
3838
3839 // Otherwise, it's an objc_method_list.
3840 ConstantInitBuilder builder(CGM);
3841 auto values = builder.beginStruct();
3842 values.addNullPointer(ObjCTypes.Int8PtrTy);
3843 values.addInt(ObjCTypes.IntTy, methods.size());
3844 auto methodArray = values.beginArray(ObjCTypes.MethodTy);
3845 for (auto MD : methods) {
3846 emitMethodConstant(methodArray, MD);
3847 }
3848 methodArray.finishAndAddTo(values);
3849
Zachary Turner41a9ee92017-10-11 23:54:34 +00003850 llvm::GlobalVariable *GV = CreateMetadataVar(prefix + name, values, section,
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003851 CGM.getPointerAlign(), true);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003852 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003853}
3854
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00003855llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003856 const ObjCContainerDecl *CD) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003857 SmallString<256> Name;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003858 GetNameForMethod(OMD, CD, Name);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003859
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003860 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003861 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003862 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003863 llvm::Function *Method =
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00003864 llvm::Function::Create(MethodTy,
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003865 llvm::GlobalValue::InternalLinkage,
Daniel Dunbard2386812009-10-19 01:21:19 +00003866 Name.str(),
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003867 &CGM.getModule());
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003868 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003869
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003870 return Method;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003871}
3872
Zachary Turner41a9ee92017-10-11 23:54:34 +00003873llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
3874 ConstantStructBuilder &Init,
3875 StringRef Section,
3876 CharUnits Align,
3877 bool AddToUsed) {
John McCall176f8922016-11-30 02:39:18 +00003878 llvm::GlobalVariable *GV =
3879 Init.finishAndCreateGlobal(Name, Align, /*constant*/ false,
3880 llvm::GlobalValue::PrivateLinkage);
3881 if (!Section.empty())
3882 GV->setSection(Section);
3883 if (AddToUsed)
3884 CGM.addCompilerUsedGlobal(GV);
3885 return GV;
3886}
3887
Zachary Turner41a9ee92017-10-11 23:54:34 +00003888llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
Alp Toker541d5072014-06-07 23:30:53 +00003889 llvm::Constant *Init,
3890 StringRef Section,
John McCall7f416cc2015-09-08 08:05:57 +00003891 CharUnits Align,
Alp Toker541d5072014-06-07 23:30:53 +00003892 bool AddToUsed) {
Chris Lattner2192fe52011-07-18 04:24:23 +00003893 llvm::Type *Ty = Init->getType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003894 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00003895 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003896 llvm::GlobalValue::PrivateLinkage, Init, Name);
Alp Toker541d5072014-06-07 23:30:53 +00003897 if (!Section.empty())
Daniel Dunbar30c65362009-03-09 20:09:19 +00003898 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003899 GV->setAlignment(Align.getQuantity());
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00003900 if (AddToUsed)
Rafael Espindola060062a2014-03-06 22:15:10 +00003901 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar30c65362009-03-09 20:09:19 +00003902 return GV;
3903}
3904
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003905llvm::GlobalVariable *
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003906CGObjCCommonMac::CreateCStringLiteral(StringRef Name, ObjCLabelType Type,
3907 bool ForceNonFragileABI,
3908 bool NullTerminate) {
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003909 StringRef Label;
3910 switch (Type) {
3911 case ObjCLabelType::ClassName: Label = "OBJC_CLASS_NAME_"; break;
3912 case ObjCLabelType::MethodVarName: Label = "OBJC_METH_VAR_NAME_"; break;
3913 case ObjCLabelType::MethodVarType: Label = "OBJC_METH_VAR_TYPE_"; break;
3914 case ObjCLabelType::PropertyName: Label = "OBJC_PROP_NAME_ATTR_"; break;
3915 }
3916
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003917 bool NonFragile = ForceNonFragileABI || isNonFragileABI();
3918
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003919 StringRef Section;
3920 switch (Type) {
3921 case ObjCLabelType::ClassName:
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003922 Section = NonFragile ? "__TEXT,__objc_classname,cstring_literals"
3923 : "__TEXT,__cstring,cstring_literals";
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003924 break;
3925 case ObjCLabelType::MethodVarName:
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003926 Section = NonFragile ? "__TEXT,__objc_methname,cstring_literals"
3927 : "__TEXT,__cstring,cstring_literals";
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003928 break;
3929 case ObjCLabelType::MethodVarType:
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003930 Section = NonFragile ? "__TEXT,__objc_methtype,cstring_literals"
3931 : "__TEXT,__cstring,cstring_literals";
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003932 break;
3933 case ObjCLabelType::PropertyName:
3934 Section = "__TEXT,__cstring,cstring_literals";
3935 break;
3936 }
3937
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003938 llvm::Constant *Value =
3939 llvm::ConstantDataArray::getString(VMContext, Name, NullTerminate);
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003940 llvm::GlobalVariable *GV =
Saleem Abdulrasool0c54dc82016-09-18 16:12:04 +00003941 new llvm::GlobalVariable(CGM.getModule(), Value->getType(),
3942 /*isConstant=*/true,
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003943 llvm::GlobalValue::PrivateLinkage, Value, Label);
Saleem Abdulrasool3f307512016-09-18 16:12:14 +00003944 if (CGM.getTriple().isOSBinFormatMachO())
3945 GV->setSection(Section);
3946 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003947 GV->setAlignment(CharUnits::One().getQuantity());
3948 CGM.addCompilerUsedGlobal(GV);
3949
3950 return GV;
3951}
3952
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003953llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00003954 // Abuse this interface function as a place to finalize.
3955 FinishModule();
Craig Topper8a13c412014-05-21 05:09:00 +00003956 return nullptr;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003957}
3958
Chris Lattnerd4808922009-03-22 21:03:39 +00003959llvm::Constant *CGObjCMac::GetPropertyGetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003960 return ObjCTypes.getGetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003961}
3962
Chris Lattnerd4808922009-03-22 21:03:39 +00003963llvm::Constant *CGObjCMac::GetPropertySetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003964 return ObjCTypes.getSetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003965}
3966
Ted Kremeneke65b0862012-03-06 20:05:56 +00003967llvm::Constant *CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
3968 bool copy) {
3969 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
3970}
3971
David Chisnall168b80f2010-12-26 22:13:16 +00003972llvm::Constant *CGObjCMac::GetGetStructFunction() {
3973 return ObjCTypes.getCopyStructFn();
3974}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003975
David Chisnall168b80f2010-12-26 22:13:16 +00003976llvm::Constant *CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003977 return ObjCTypes.getCopyStructFn();
3978}
3979
David Chisnall0d75e062012-12-17 18:54:24 +00003980llvm::Constant *CGObjCMac::GetCppAtomicObjectGetFunction() {
3981 return ObjCTypes.getCppAtomicObjectFunction();
3982}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003983
David Chisnall0d75e062012-12-17 18:54:24 +00003984llvm::Constant *CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00003985 return ObjCTypes.getCppAtomicObjectFunction();
3986}
3987
Chris Lattnerd4808922009-03-22 21:03:39 +00003988llvm::Constant *CGObjCMac::EnumerationMutationFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003989 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson3f35a262008-08-31 04:05:03 +00003990}
3991
John McCallbd309292010-07-06 01:34:17 +00003992void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
3993 return EmitTryOrSynchronizedStmt(CGF, S);
3994}
3995
3996void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
3997 const ObjCAtSynchronizedStmt &S) {
3998 return EmitTryOrSynchronizedStmt(CGF, S);
3999}
4000
John McCall65bea082010-07-21 06:59:36 +00004001namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00004002 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCall65bea082010-07-21 06:59:36 +00004003 const Stmt &S;
John McCall7f416cc2015-09-08 08:05:57 +00004004 Address SyncArgSlot;
4005 Address CallTryExitVar;
4006 Address ExceptionData;
John McCall65bea082010-07-21 06:59:36 +00004007 ObjCTypesHelper &ObjCTypes;
4008 PerformFragileFinally(const Stmt *S,
John McCall7f416cc2015-09-08 08:05:57 +00004009 Address SyncArgSlot,
4010 Address CallTryExitVar,
4011 Address ExceptionData,
John McCall65bea082010-07-21 06:59:36 +00004012 ObjCTypesHelper *ObjCTypes)
John McCall2dd7d442010-08-04 05:59:32 +00004013 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCall65bea082010-07-21 06:59:36 +00004014 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
4015
Craig Topper4f12f102014-03-12 06:41:41 +00004016 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall65bea082010-07-21 06:59:36 +00004017 // Check whether we need to call objc_exception_try_exit.
4018 // In optimized code, this branch will always be folded.
4019 llvm::BasicBlock *FinallyCallExit =
4020 CGF.createBasicBlock("finally.call_exit");
4021 llvm::BasicBlock *FinallyNoCallExit =
4022 CGF.createBasicBlock("finally.no_call_exit");
4023 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
4024 FinallyCallExit, FinallyNoCallExit);
4025
4026 CGF.EmitBlock(FinallyCallExit);
John McCall882987f2013-02-28 19:01:20 +00004027 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004028 ExceptionData.getPointer());
John McCall65bea082010-07-21 06:59:36 +00004029
4030 CGF.EmitBlock(FinallyNoCallExit);
4031
4032 if (isa<ObjCAtTryStmt>(S)) {
4033 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCallcebe0ca2010-08-11 00:16:14 +00004034 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall638d4f52013-04-03 00:56:07 +00004035 // Don't try to do the @finally if this is an EH cleanup.
4036 if (flags.isForEHCleanup()) return;
4037
John McCallcebe0ca2010-08-11 00:16:14 +00004038 // Save the current cleanup destination in case there's
4039 // control flow inside the finally statement.
4040 llvm::Value *CurCleanupDest =
4041 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
4042
John McCall65bea082010-07-21 06:59:36 +00004043 CGF.EmitStmt(FinallyStmt->getFinallyBody());
4044
John McCallcebe0ca2010-08-11 00:16:14 +00004045 if (CGF.HaveInsertPoint()) {
4046 CGF.Builder.CreateStore(CurCleanupDest,
4047 CGF.getNormalCleanupDestSlot());
4048 } else {
4049 // Currently, the end of the cleanup must always exist.
4050 CGF.EnsureInsertPoint();
4051 }
4052 }
John McCall65bea082010-07-21 06:59:36 +00004053 } else {
4054 // Emit objc_sync_exit(expr); as finally's sole statement for
4055 // @synchronized.
John McCall2dd7d442010-08-04 05:59:32 +00004056 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCall882987f2013-02-28 19:01:20 +00004057 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCall65bea082010-07-21 06:59:36 +00004058 }
4059 }
4060 };
John McCall42227ed2010-07-31 23:20:56 +00004061
4062 class FragileHazards {
4063 CodeGenFunction &CGF;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004064 SmallVector<llvm::Value*, 20> Locals;
John McCall42227ed2010-07-31 23:20:56 +00004065 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
4066
4067 llvm::InlineAsm *ReadHazard;
4068 llvm::InlineAsm *WriteHazard;
4069
4070 llvm::FunctionType *GetAsmFnType();
4071
4072 void collectLocals();
4073 void emitReadHazard(CGBuilderTy &Builder);
4074
4075 public:
4076 FragileHazards(CodeGenFunction &CGF);
John McCall2dd7d442010-08-04 05:59:32 +00004077
John McCall42227ed2010-07-31 23:20:56 +00004078 void emitWriteHazard();
John McCall2dd7d442010-08-04 05:59:32 +00004079 void emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004080 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00004081} // end anonymous namespace
John McCall42227ed2010-07-31 23:20:56 +00004082
4083/// Create the fragile-ABI read and write hazards based on the current
4084/// state of the function, which is presumed to be immediately prior
4085/// to a @try block. These hazards are used to maintain correct
4086/// semantics in the face of optimization and the fragile ABI's
4087/// cavalier use of setjmp/longjmp.
4088FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
4089 collectLocals();
4090
4091 if (Locals.empty()) return;
4092
4093 // Collect all the blocks in the function.
4094 for (llvm::Function::iterator
4095 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
4096 BlocksBeforeTry.insert(&*I);
4097
4098 llvm::FunctionType *AsmFnTy = GetAsmFnType();
4099
4100 // Create a read hazard for the allocas. This inhibits dead-store
4101 // optimizations and forces the values to memory. This hazard is
4102 // inserted before any 'throwing' calls in the protected scope to
4103 // reflect the possibility that the variables might be read from the
4104 // catch block if the call throws.
4105 {
4106 std::string Constraint;
4107 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
4108 if (I) Constraint += ',';
4109 Constraint += "*m";
4110 }
4111
4112 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
4113 }
4114
4115 // Create a write hazard for the allocas. This inhibits folding
4116 // loads across the hazard. This hazard is inserted at the
4117 // beginning of the catch path to reflect the possibility that the
4118 // variables might have been written within the protected scope.
4119 {
4120 std::string Constraint;
4121 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
4122 if (I) Constraint += ',';
4123 Constraint += "=*m";
4124 }
4125
4126 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
4127 }
4128}
4129
4130/// Emit a write hazard at the current location.
4131void FragileHazards::emitWriteHazard() {
4132 if (Locals.empty()) return;
4133
John McCall882987f2013-02-28 19:01:20 +00004134 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall42227ed2010-07-31 23:20:56 +00004135}
4136
John McCall42227ed2010-07-31 23:20:56 +00004137void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
4138 assert(!Locals.empty());
John McCall882987f2013-02-28 19:01:20 +00004139 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
4140 call->setDoesNotThrow();
4141 call->setCallingConv(CGF.getRuntimeCC());
John McCall42227ed2010-07-31 23:20:56 +00004142}
4143
4144/// Emit read hazards in all the protected blocks, i.e. all the blocks
4145/// which have been inserted since the beginning of the try.
John McCall2dd7d442010-08-04 05:59:32 +00004146void FragileHazards::emitHazardsInNewBlocks() {
John McCall42227ed2010-07-31 23:20:56 +00004147 if (Locals.empty()) return;
4148
John McCall7f416cc2015-09-08 08:05:57 +00004149 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall42227ed2010-07-31 23:20:56 +00004150
4151 // Iterate through all blocks, skipping those prior to the try.
4152 for (llvm::Function::iterator
4153 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
4154 llvm::BasicBlock &BB = *FI;
4155 if (BlocksBeforeTry.count(&BB)) continue;
4156
4157 // Walk through all the calls in the block.
4158 for (llvm::BasicBlock::iterator
4159 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
4160 llvm::Instruction &I = *BI;
4161
4162 // Ignore instructions that aren't non-intrinsic calls.
4163 // These are the only calls that can possibly call longjmp.
4164 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I)) continue;
4165 if (isa<llvm::IntrinsicInst>(I))
4166 continue;
4167
4168 // Ignore call sites marked nounwind. This may be questionable,
4169 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
4170 llvm::CallSite CS(&I);
4171 if (CS.doesNotThrow()) continue;
4172
John McCall2dd7d442010-08-04 05:59:32 +00004173 // Insert a read hazard before the call. This will ensure that
4174 // any writes to the locals are performed before making the
4175 // call. If the call throws, then this is sufficient to
4176 // guarantee correctness as long as it doesn't also write to any
4177 // locals.
John McCall42227ed2010-07-31 23:20:56 +00004178 Builder.SetInsertPoint(&BB, BI);
4179 emitReadHazard(Builder);
4180 }
4181 }
4182}
4183
John McCall7f416cc2015-09-08 08:05:57 +00004184static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
4185 if (V.isValid()) S.insert(V.getPointer());
4186}
4187
John McCall42227ed2010-07-31 23:20:56 +00004188void FragileHazards::collectLocals() {
4189 // Compute a set of allocas to ignore.
4190 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
4191 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
4192 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall42227ed2010-07-31 23:20:56 +00004193
4194 // Collect all the allocas currently in the function. This is
4195 // probably way too aggressive.
4196 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
4197 for (llvm::BasicBlock::iterator
4198 I = Entry.begin(), E = Entry.end(); I != E; ++I)
4199 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
4200 Locals.push_back(&*I);
4201}
4202
4203llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004204 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall9dc0db22011-05-15 01:53:33 +00004205 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
4206 tys[i] = Locals[i]->getType();
4207 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCall65bea082010-07-21 06:59:36 +00004208}
4209
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004210/*
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004211
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004212 Objective-C setjmp-longjmp (sjlj) Exception Handling
4213 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004214
John McCallbd309292010-07-06 01:34:17 +00004215 A catch buffer is a setjmp buffer plus:
4216 - a pointer to the exception that was caught
4217 - a pointer to the previous exception data buffer
4218 - two pointers of reserved storage
4219 Therefore catch buffers form a stack, with a pointer to the top
4220 of the stack kept in thread-local storage.
4221
4222 objc_exception_try_enter pushes a catch buffer onto the EH stack.
4223 objc_exception_try_exit pops the given catch buffer, which is
4224 required to be the top of the EH stack.
4225 objc_exception_throw pops the top of the EH stack, writes the
4226 thrown exception into the appropriate field, and longjmps
4227 to the setjmp buffer. It crashes the process (with a printf
4228 and an abort()) if there are no catch buffers on the stack.
4229 objc_exception_extract just reads the exception pointer out of the
4230 catch buffer.
4231
4232 There's no reason an implementation couldn't use a light-weight
4233 setjmp here --- something like __builtin_setjmp, but API-compatible
4234 with the heavyweight setjmp. This will be more important if we ever
4235 want to implement correct ObjC/C++ exception interactions for the
4236 fragile ABI.
4237
4238 Note that for this use of setjmp/longjmp to be correct, we may need
4239 to mark some local variables volatile: if a non-volatile local
4240 variable is modified between the setjmp and the longjmp, it has
4241 indeterminate value. For the purposes of LLVM IR, it may be
4242 sufficient to make loads and stores within the @try (to variables
4243 declared outside the @try) volatile. This is necessary for
4244 optimized correctness, but is not currently being done; this is
4245 being tracked as rdar://problem/8160285
4246
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004247 The basic framework for a @try-catch-finally is as follows:
4248 {
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004249 objc_exception_data d;
4250 id _rethrow = null;
Anders Carlssonda0e4562009-02-07 21:26:04 +00004251 bool _call_try_exit = true;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004252
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004253 objc_exception_try_enter(&d);
4254 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004255 ... try body ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004256 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004257 // exception path
4258 id _caught = objc_exception_extract(&d);
4259
4260 // enter new try scope for handlers
4261 if (!setjmp(d.jmp_buf)) {
4262 ... match exception and execute catch blocks ...
4263
4264 // fell off end, rethrow.
4265 _rethrow = _caught;
4266 ... jump-through-finally to finally_rethrow ...
4267 } else {
4268 // exception in catch block
4269 _rethrow = objc_exception_extract(&d);
4270 _call_try_exit = false;
4271 ... jump-through-finally to finally_rethrow ...
4272 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004273 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004274 ... jump-through-finally to finally_end ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004275
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004276 finally:
Anders Carlssonda0e4562009-02-07 21:26:04 +00004277 if (_call_try_exit)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004278 objc_exception_try_exit(&d);
Anders Carlssonda0e4562009-02-07 21:26:04 +00004279
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004280 ... finally block ....
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004281 ... dispatch to finally destination ...
4282
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004283 finally_rethrow:
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004284 objc_exception_throw(_rethrow);
4285
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004286 finally_end:
4287 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004288
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004289 This framework differs slightly from the one gcc uses, in that gcc
4290 uses _rethrow to determine if objc_exception_try_exit should be called
4291 and if the object should be rethrown. This breaks in the face of
4292 throwing nil and introduces unnecessary branches.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004293
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004294 We specialize this framework for a few particular circumstances:
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004295
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004296 - If there are no catch blocks, then we avoid emitting the second
4297 exception handling context.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004298
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004299 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
4300 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004301
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004302 - FIXME: If there is no @finally block we can do a few more
4303 simplifications.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004304
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004305 Rethrows and Jumps-Through-Finally
4306 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004307
John McCallbd309292010-07-06 01:34:17 +00004308 '@throw;' is supported by pushing the currently-caught exception
4309 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004310
John McCallbd309292010-07-06 01:34:17 +00004311 Branches through the @finally block are handled with an ordinary
4312 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
4313 exceptions are not compatible with C++ exceptions, and this is
4314 hardly the only place where this will go wrong.
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004315
John McCallbd309292010-07-06 01:34:17 +00004316 @synchronized(expr) { stmt; } is emitted as if it were:
4317 id synch_value = expr;
4318 objc_sync_enter(synch_value);
4319 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004320*/
4321
Fariborz Jahanianc2ad6dc2008-11-21 00:49:24 +00004322void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
4323 const Stmt &S) {
4324 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallbd309292010-07-06 01:34:17 +00004325
4326 // A destination for the fall-through edges of the catch handlers to
4327 // jump to.
4328 CodeGenFunction::JumpDest FinallyEnd =
4329 CGF.getJumpDestInCurrentScope("finally.end");
4330
4331 // A destination for the rethrow edge of the catch handlers to jump
4332 // to.
4333 CodeGenFunction::JumpDest FinallyRethrow =
4334 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004335
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004336 // For @synchronized, call objc_sync_enter(sync.expr). The
4337 // evaluation of the expression must occur before we enter the
John McCall2dd7d442010-08-04 05:59:32 +00004338 // @synchronized. We can't avoid a temp here because we need the
4339 // value to be preserved. If the backend ever does liveness
4340 // correctly after setjmp, this will be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00004341 Address SyncArgSlot = Address::invalid();
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004342 if (!isTry) {
John McCall2dd7d442010-08-04 05:59:32 +00004343 llvm::Value *SyncArg =
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004344 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
4345 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004346 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall2dd7d442010-08-04 05:59:32 +00004347
John McCall7f416cc2015-09-08 08:05:57 +00004348 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
4349 CGF.getPointerAlign(), "sync.arg");
John McCall2dd7d442010-08-04 05:59:32 +00004350 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004351 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004352
John McCall2dd7d442010-08-04 05:59:32 +00004353 // Allocate memory for the setjmp buffer. This needs to be kept
4354 // live throughout the try and catch blocks.
John McCall7f416cc2015-09-08 08:05:57 +00004355 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
4356 CGF.getPointerAlign(),
4357 "exceptiondata.ptr");
John McCall2dd7d442010-08-04 05:59:32 +00004358
John McCall42227ed2010-07-31 23:20:56 +00004359 // Create the fragile hazards. Note that this will not capture any
4360 // of the allocas required for exception processing, but will
4361 // capture the current basic block (which extends all the way to the
4362 // setjmp call) as "before the @try".
4363 FragileHazards Hazards(CGF);
4364
John McCallbd309292010-07-06 01:34:17 +00004365 // Create a flag indicating whether the cleanup needs to call
4366 // objc_exception_try_exit. This is true except when
4367 // - no catches match and we're branching through the cleanup
4368 // just to rethrow the exception, or
4369 // - a catch matched and we're falling out of the catch handler.
John McCall2dd7d442010-08-04 05:59:32 +00004370 // The setjmp-safety rule here is that we should always store to this
4371 // variable in a place that dominates the branch through the cleanup
4372 // without passing through any setjmps.
John McCall7f416cc2015-09-08 08:05:57 +00004373 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
4374 CharUnits::One(),
4375 "_call_try_exit");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004376
John McCall9916e3f2010-10-04 23:42:51 +00004377 // A slot containing the exception to rethrow. Only needed when we
4378 // have both a @catch and a @finally.
John McCall7f416cc2015-09-08 08:05:57 +00004379 Address PropagatingExnVar = Address::invalid();
John McCall9916e3f2010-10-04 23:42:51 +00004380
John McCallbd309292010-07-06 01:34:17 +00004381 // Push a normal cleanup to leave the try scope.
John McCall638d4f52013-04-03 00:56:07 +00004382 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall2dd7d442010-08-04 05:59:32 +00004383 SyncArgSlot,
John McCallcda666c2010-07-21 07:22:38 +00004384 CallTryExitVar,
4385 ExceptionData,
4386 &ObjCTypes);
John McCallbd309292010-07-06 01:34:17 +00004387
4388 // Enter a try block:
4389 // - Call objc_exception_try_enter to push ExceptionData on top of
4390 // the EH stack.
Nico Weber6307cf02015-02-26 20:43:00 +00004391 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004392 ExceptionData.getPointer());
John McCallbd309292010-07-06 01:34:17 +00004393
4394 // - Call setjmp on the exception data buffer.
4395 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
4396 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
David Blaikie6b2a8302015-04-03 17:47:16 +00004397 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
John McCall7f416cc2015-09-08 08:05:57 +00004398 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
4399 "setjmp_buffer");
Nico Weber6307cf02015-02-26 20:43:00 +00004400 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
4401 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004402 SetJmpResult->setCanReturnTwice();
John McCallbd309292010-07-06 01:34:17 +00004403
4404 // If setjmp returned 0, enter the protected block; otherwise,
4405 // branch to the handler.
Daniel Dunbar75283ff2008-11-11 02:29:29 +00004406 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
4407 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallbd309292010-07-06 01:34:17 +00004408 llvm::Value *DidCatch =
John McCallcebe0ca2010-08-11 00:16:14 +00004409 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4410 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004411
John McCallbd309292010-07-06 01:34:17 +00004412 // Emit the protected block.
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004413 CGF.EmitBlock(TryBlock);
John McCall2dd7d442010-08-04 05:59:32 +00004414 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004415 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallbd309292010-07-06 01:34:17 +00004416 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall2dd7d442010-08-04 05:59:32 +00004417
4418 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004419
John McCallbd309292010-07-06 01:34:17 +00004420 // Emit the exception handler block.
Daniel Dunbar7f086782008-09-27 23:30:04 +00004421 CGF.EmitBlock(TryHandler);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004422
John McCall42227ed2010-07-31 23:20:56 +00004423 // Don't optimize loads of the in-scope locals across this point.
4424 Hazards.emitWriteHazard();
4425
John McCallbd309292010-07-06 01:34:17 +00004426 // For a @synchronized (or a @try with no catches), just branch
4427 // through the cleanup to the rethrow block.
4428 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
4429 // Tell the cleanup not to re-pop the exit.
John McCall2dd7d442010-08-04 05:59:32 +00004430 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004431 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallbd309292010-07-06 01:34:17 +00004432
4433 // Otherwise, we have to match against the caught exceptions.
4434 } else {
John McCall2dd7d442010-08-04 05:59:32 +00004435 // Retrieve the exception object. We may emit multiple blocks but
4436 // nothing can cross this so the value is already in SSA form.
4437 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004438 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004439 ExceptionData.getPointer(), "caught");
John McCall2dd7d442010-08-04 05:59:32 +00004440
John McCallbd309292010-07-06 01:34:17 +00004441 // Push the exception to rethrow onto the EH value stack for the
4442 // benefit of any @throws in the handlers.
4443 CGF.ObjCEHValueStack.push_back(Caught);
4444
Douglas Gregor96c79492010-04-23 22:50:49 +00004445 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004446
Craig Topper8a13c412014-05-21 05:09:00 +00004447 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallbd309292010-07-06 01:34:17 +00004448
Craig Topper8a13c412014-05-21 05:09:00 +00004449 llvm::BasicBlock *CatchBlock = nullptr;
4450 llvm::BasicBlock *CatchHandler = nullptr;
John McCall2dd7d442010-08-04 05:59:32 +00004451 if (HasFinally) {
John McCall9916e3f2010-10-04 23:42:51 +00004452 // Save the currently-propagating exception before
4453 // objc_exception_try_enter clears the exception slot.
4454 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
John McCall7f416cc2015-09-08 08:05:57 +00004455 CGF.getPointerAlign(),
John McCall9916e3f2010-10-04 23:42:51 +00004456 "propagating_exception");
4457 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
4458
John McCall2dd7d442010-08-04 05:59:32 +00004459 // Enter a new exception try block (in case a @catch block
4460 // throws an exception).
John McCall882987f2013-02-28 19:01:20 +00004461 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004462 ExceptionData.getPointer());
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004463
John McCall2dd7d442010-08-04 05:59:32 +00004464 llvm::CallInst *SetJmpResult =
John McCall882987f2013-02-28 19:01:20 +00004465 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4466 SetJmpBuffer, "setjmp.result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004467 SetJmpResult->setCanReturnTwice();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004468
John McCall2dd7d442010-08-04 05:59:32 +00004469 llvm::Value *Threw =
4470 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4471
4472 CatchBlock = CGF.createBasicBlock("catch");
4473 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4474 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4475
4476 CGF.EmitBlock(CatchBlock);
4477 }
4478
4479 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004480
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004481 // Handle catch list. As a special case we check if everything is
4482 // matched and avoid generating code for falling off the end if
4483 // so.
4484 bool AllMatched = false;
Douglas Gregor96c79492010-04-23 22:50:49 +00004485 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4486 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004487
Douglas Gregor46a572b2010-04-26 16:46:50 +00004488 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00004489 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar523208f2008-09-27 07:36:24 +00004490
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004491 // catch(...) always matches.
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004492 if (!CatchParam) {
4493 AllMatched = true;
4494 } else {
John McCall9dd450b2009-09-21 23:43:11 +00004495 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004496
John McCallbd309292010-07-06 01:34:17 +00004497 // catch(id e) always matches under this ABI, since only
4498 // ObjC exceptions end up here in the first place.
Daniel Dunbar86919f42008-09-27 22:21:14 +00004499 // FIXME: For the time being we also match id<X>; this should
4500 // be rejected by Sema instead.
Eli Friedman55179ca2009-07-11 00:57:02 +00004501 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004502 AllMatched = true;
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004503 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004504
John McCallbd309292010-07-06 01:34:17 +00004505 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004506 if (AllMatched) {
John McCallbd309292010-07-06 01:34:17 +00004507 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4508
Anders Carlsson9396a892008-09-11 09:15:33 +00004509 if (CatchParam) {
John McCall1c9c3fd2010-10-15 04:57:14 +00004510 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004511 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallbd309292010-07-06 01:34:17 +00004512
4513 // These types work out because ConvertType(id) == i8*.
John McCall17f02752015-10-30 00:56:02 +00004514 EmitInitOfCatchParam(CGF, Caught, CatchParam);
Anders Carlsson9396a892008-09-11 09:15:33 +00004515 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004516
Anders Carlsson9396a892008-09-11 09:15:33 +00004517 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004518
4519 // The scope of the catch variable ends right here.
4520 CatchVarCleanups.ForceCleanup();
4521
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004522 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004523 break;
4524 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004525
Steve Naroff7cae42b2009-07-10 23:34:53 +00004526 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall96fa4842010-05-17 21:00:27 +00004527 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallbd309292010-07-06 01:34:17 +00004528
4529 // FIXME: @catch (Class c) ?
John McCall96fa4842010-05-17 21:00:27 +00004530 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4531 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004532
4533 // Check if the @catch block matches the exception object.
John McCall882987f2013-02-28 19:01:20 +00004534 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004535
John McCall882987f2013-02-28 19:01:20 +00004536 llvm::Value *matchArgs[] = { Class, Caught };
John McCallbd309292010-07-06 01:34:17 +00004537 llvm::CallInst *Match =
John McCall882987f2013-02-28 19:01:20 +00004538 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4539 matchArgs, "match");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004540
John McCallbd309292010-07-06 01:34:17 +00004541 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4542 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004543
4544 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbar7f086782008-09-27 23:30:04 +00004545 MatchedBlock, NextCatchBlock);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004546
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004547 // Emit the @catch block.
4548 CGF.EmitBlock(MatchedBlock);
John McCallbd309292010-07-06 01:34:17 +00004549
4550 // Collect any cleanups for the catch variable. The scope lasts until
4551 // the end of the catch body.
John McCall2dd7d442010-08-04 05:59:32 +00004552 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallbd309292010-07-06 01:34:17 +00004553
John McCall1c9c3fd2010-10-15 04:57:14 +00004554 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004555 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004556
John McCallbd309292010-07-06 01:34:17 +00004557 // Initialize the catch variable.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004558 llvm::Value *Tmp =
4559 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004560 CGF.ConvertType(CatchParam->getType()));
John McCall17f02752015-10-30 00:56:02 +00004561 EmitInitOfCatchParam(CGF, Tmp, CatchParam);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004562
Anders Carlsson9396a892008-09-11 09:15:33 +00004563 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004564
4565 // We're done with the catch variable.
4566 CatchVarCleanups.ForceCleanup();
4567
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004568 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004569
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004570 CGF.EmitBlock(NextCatchBlock);
4571 }
4572
John McCallbd309292010-07-06 01:34:17 +00004573 CGF.ObjCEHValueStack.pop_back();
4574
John McCall2dd7d442010-08-04 05:59:32 +00004575 // If nothing wanted anything to do with the caught exception,
4576 // kill the extract call.
4577 if (Caught->use_empty())
4578 Caught->eraseFromParent();
4579
4580 if (!AllMatched)
4581 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4582
4583 if (HasFinally) {
4584 // Emit the exception handler for the @catch blocks.
4585 CGF.EmitBlock(CatchHandler);
4586
4587 // In theory we might now need a write hazard, but actually it's
4588 // unnecessary because there's no local-accessing code between
4589 // the try's write hazard and here.
4590 //Hazards.emitWriteHazard();
4591
John McCall9916e3f2010-10-04 23:42:51 +00004592 // Extract the new exception and save it to the
4593 // propagating-exception slot.
John McCall7f416cc2015-09-08 08:05:57 +00004594 assert(PropagatingExnVar.isValid());
John McCall9916e3f2010-10-04 23:42:51 +00004595 llvm::CallInst *NewCaught =
John McCall882987f2013-02-28 19:01:20 +00004596 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004597 ExceptionData.getPointer(), "caught");
John McCall9916e3f2010-10-04 23:42:51 +00004598 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4599
John McCall2dd7d442010-08-04 05:59:32 +00004600 // Don't pop the catch handler; the throw already did.
4601 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004602 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004603 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004604 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004605
John McCall42227ed2010-07-31 23:20:56 +00004606 // Insert read hazards as required in the new blocks.
John McCall2dd7d442010-08-04 05:59:32 +00004607 Hazards.emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004608
John McCallbd309292010-07-06 01:34:17 +00004609 // Pop the cleanup.
John McCall2dd7d442010-08-04 05:59:32 +00004610 CGF.Builder.restoreIP(TryFallthroughIP);
4611 if (CGF.HaveInsertPoint())
4612 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallbd309292010-07-06 01:34:17 +00004613 CGF.PopCleanupBlock();
John McCall2dd7d442010-08-04 05:59:32 +00004614 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004615
John McCallbd309292010-07-06 01:34:17 +00004616 // Emit the rethrow block.
John McCall42227ed2010-07-31 23:20:56 +00004617 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallad5d61e2010-07-23 21:56:41 +00004618 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallbd309292010-07-06 01:34:17 +00004619 if (CGF.HaveInsertPoint()) {
John McCall9916e3f2010-10-04 23:42:51 +00004620 // If we have a propagating-exception variable, check it.
4621 llvm::Value *PropagatingExn;
John McCall7f416cc2015-09-08 08:05:57 +00004622 if (PropagatingExnVar.isValid()) {
John McCall9916e3f2010-10-04 23:42:51 +00004623 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall2dd7d442010-08-04 05:59:32 +00004624
John McCall9916e3f2010-10-04 23:42:51 +00004625 // Otherwise, just look in the buffer for the exception to throw.
4626 } else {
4627 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004628 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004629 ExceptionData.getPointer());
John McCall9916e3f2010-10-04 23:42:51 +00004630 PropagatingExn = Caught;
4631 }
4632
John McCall882987f2013-02-28 19:01:20 +00004633 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4634 PropagatingExn);
John McCallbd309292010-07-06 01:34:17 +00004635 CGF.Builder.CreateUnreachable();
Fariborz Jahaniane2caaaa2008-11-21 19:21:53 +00004636 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004637
John McCall42227ed2010-07-31 23:20:56 +00004638 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004639}
4640
4641void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004642 const ObjCAtThrowStmt &S,
4643 bool ClearInsertionPoint) {
Anders Carlssone005aa12008-09-09 16:16:55 +00004644 llvm::Value *ExceptionAsObject;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004645
Anders Carlssone005aa12008-09-09 16:16:55 +00004646 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00004647 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004648 ExceptionAsObject =
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004649 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlssone005aa12008-09-09 16:16:55 +00004650 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004651 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004652 "Unexpected rethrow outside @catch block.");
Anders Carlssonbf8a1be2009-02-07 21:37:21 +00004653 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlssone005aa12008-09-09 16:16:55 +00004654 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004655
John McCall882987f2013-02-28 19:01:20 +00004656 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallbd309292010-07-06 01:34:17 +00004657 ->setDoesNotReturn();
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004658 CGF.Builder.CreateUnreachable();
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004659
4660 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004661 if (ClearInsertionPoint)
4662 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004663}
4664
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004665/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004666/// object: objc_read_weak (id *src)
4667///
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004668llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004669 Address AddrWeakObj) {
4670 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004671 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4672 ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004673 llvm::Value *read_weak =
4674 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004675 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00004676 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004677 return read_weak;
4678}
4679
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004680/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4681/// objc_assign_weak (id src, id *dst)
4682///
4683void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004684 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004685 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004686 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004687 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004688 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004689 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4690 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004691 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4692 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004693 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4694 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004695 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004696 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4697 args, "weakassign");
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004698}
4699
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004700/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4701/// objc_assign_global (id src, id *dst)
4702///
4703void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004704 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00004705 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004706 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004707 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004708 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004709 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004710 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4711 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004712 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4713 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004714 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4715 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004716 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00004717 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00004718 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4719 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00004720 else
John McCall882987f2013-02-28 19:01:20 +00004721 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4722 args, "threadlocalassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004723}
4724
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004725/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004726/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004727///
4728void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004729 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004730 llvm::Value *ivarOffset) {
4731 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2192fe52011-07-18 04:24:23 +00004732 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004733 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004734 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004735 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004736 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4737 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004738 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4739 }
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004740 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4741 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004742 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00004743 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004744}
4745
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004746/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4747/// objc_assign_strongCast (id src, id *dst)
4748///
4749void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004750 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004751 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004752 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004753 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004754 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004755 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4756 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004757 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4758 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004759 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4760 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004761 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004762 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004763 args, "strongassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004764}
4765
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004766void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004767 Address DestPtr,
4768 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004769 llvm::Value *size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004770 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4771 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004772 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCall882987f2013-02-28 19:01:20 +00004773 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004774}
4775
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004776/// EmitObjCValueForIvar - Code Gen for ivar reference.
4777///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004778LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4779 QualType ObjectTy,
4780 llvm::Value *BaseValue,
4781 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004782 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004783 const ObjCInterfaceDecl *ID =
4784 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004785 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4786 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004787}
4788
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004789llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004790 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004791 const ObjCIvarDecl *Ivar) {
Eli Friedman8cbca202012-11-06 22:15:52 +00004792 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4793 return llvm::ConstantInt::get(
4794 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4795 Offset);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004796}
4797
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004798/* *** Private Interface *** */
4799
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00004800std::string CGObjCCommonMac::GetSectionName(StringRef Section,
4801 StringRef MachOAttributes) {
4802 switch (CGM.getTriple().getObjectFormat()) {
4803 default:
4804 llvm_unreachable("unexpected object file format");
4805 case llvm::Triple::MachO: {
4806 if (MachOAttributes.empty())
4807 return ("__DATA," + Section).str();
4808 return ("__DATA," + Section + "," + MachOAttributes).str();
4809 }
4810 case llvm::Triple::ELF:
4811 assert(Section.substr(0, 2) == "__" &&
4812 "expected the name to begin with __");
4813 return Section.substr(2).str();
4814 case llvm::Triple::COFF:
4815 assert(Section.substr(0, 2) == "__" &&
4816 "expected the name to begin with __");
4817 return ("." + Section.substr(2) + "$B").str();
4818 }
4819}
4820
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004821/// EmitImageInfo - Emit the image info marker used to encode some module
4822/// level information.
4823///
4824/// See: <rdr://4810609&4810587&4810587>
4825/// struct IMAGE_INFO {
4826/// unsigned version;
4827/// unsigned flags;
4828/// };
4829enum ImageInfoFlags {
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004830 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004831 eImageInfo_GarbageCollected = (1 << 1),
4832 eImageInfo_GCOnly = (1 << 2),
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004833 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbar75e909f2009-04-20 07:11:47 +00004834
Daniel Dunbar5e639272010-04-25 20:39:01 +00004835 // A flag indicating that the module has no instances of a @synthesize of a
4836 // superclass variable. <rdar://problem/6803242>
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004837 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Manman Ren96df0b32016-01-29 23:45:01 +00004838 eImageInfo_ImageIsSimulated = (1 << 5),
4839 eImageInfo_ClassProperties = (1 << 6)
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004840};
4841
Daniel Dunbar5e639272010-04-25 20:39:01 +00004842void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004843 unsigned version = 0; // Version is unused?
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00004844 std::string Section =
4845 (ObjCABI == 1)
4846 ? "__OBJC,__image_info,regular"
4847 : GetSectionName("__objc_imageinfo", "regular,no_dead_strip");
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004848
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004849 // Generate module-level named metadata to convey this information to the
4850 // linker and code-gen.
4851 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004852
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004853 // Add the ObjC ABI version to the module flags.
4854 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4855 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4856 version);
4857 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00004858 llvm::MDString::get(VMContext, Section));
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004859
David Blaikiebbafb8a2012-03-11 07:00:24 +00004860 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004861 // Non-GC overrides those files which specify GC.
4862 Mod.addModuleFlag(llvm::Module::Override,
4863 "Objective-C Garbage Collection", (uint32_t)0);
4864 } else {
4865 // Add the ObjC garbage collection value.
4866 Mod.addModuleFlag(llvm::Module::Error,
4867 "Objective-C Garbage Collection",
4868 eImageInfo_GarbageCollected);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004869
David Blaikiebbafb8a2012-03-11 07:00:24 +00004870 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004871 // Add the ObjC GC Only value.
4872 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4873 eImageInfo_GCOnly);
4874
4875 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004876 llvm::Metadata *Ops[2] = {
4877 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4878 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4879 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004880 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4881 llvm::MDNode::get(VMContext, Ops));
4882 }
4883 }
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004884
4885 // Indicate whether we're compiling this to run on a simulator.
Alex Lorenz6cdef0e2017-12-07 19:04:10 +00004886 if (CGM.getTarget().getTriple().isSimulatorEnvironment())
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004887 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4888 eImageInfo_ImageIsSimulated);
Manman Ren96df0b32016-01-29 23:45:01 +00004889
4890 // Indicate whether we are generating class properties.
4891 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Class Properties",
4892 eImageInfo_ClassProperties);
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004893}
4894
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004895// struct objc_module {
4896// unsigned long version;
4897// unsigned long size;
4898// const char *name;
4899// Symtab symtab;
4900// };
4901
4902// FIXME: Get from somewhere
4903static const int ModuleVersion = 7;
4904
4905void CGObjCMac::EmitModuleInfo() {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004906 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004907
John McCall176f8922016-11-30 02:39:18 +00004908 ConstantInitBuilder builder(CGM);
4909 auto values = builder.beginStruct(ObjCTypes.ModuleTy);
4910 values.addInt(ObjCTypes.LongTy, ModuleVersion);
4911 values.addInt(ObjCTypes.LongTy, Size);
4912 // This used to be the filename, now it is unused. <rdr://4327263>
4913 values.add(GetClassName(StringRef("")));
4914 values.add(EmitModuleSymbols());
4915 CreateMetadataVar("OBJC_MODULES", values,
John McCall7f416cc2015-09-08 08:05:57 +00004916 "__OBJC,__module_info,regular,no_dead_strip",
4917 CGM.getPointerAlign(), true);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004918}
4919
4920llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004921 unsigned NumClasses = DefinedClasses.size();
4922 unsigned NumCategories = DefinedCategories.size();
4923
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004924 // Return null if no symbols were defined.
4925 if (!NumClasses && !NumCategories)
Owen Anderson0b75f232009-07-31 20:28:54 +00004926 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004927
John McCall176f8922016-11-30 02:39:18 +00004928 ConstantInitBuilder builder(CGM);
4929 auto values = builder.beginStruct();
4930 values.addInt(ObjCTypes.LongTy, 0);
4931 values.addNullPointer(ObjCTypes.SelectorPtrTy);
4932 values.addInt(ObjCTypes.ShortTy, NumClasses);
4933 values.addInt(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004934
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004935 // The runtime expects exactly the list of defined classes followed
4936 // by the list of defined categories, in a single array.
John McCall176f8922016-11-30 02:39:18 +00004937 auto array = values.beginArray(ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004938 for (unsigned i=0; i<NumClasses; i++) {
4939 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
4940 assert(ID);
4941 if (ObjCImplementationDecl *IMP = ID->getImplementation())
4942 // We are implementing a weak imported interface. Give it external linkage
4943 if (ID->isWeakImported() && !IMP->isWeakImported())
4944 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
John McCall176f8922016-11-30 02:39:18 +00004945
4946 array.addBitCast(DefinedClasses[i], ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004947 }
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004948 for (unsigned i=0; i<NumCategories; i++)
John McCall176f8922016-11-30 02:39:18 +00004949 array.addBitCast(DefinedCategories[i], ObjCTypes.Int8PtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004950
John McCall176f8922016-11-30 02:39:18 +00004951 array.finishAndAddTo(values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004952
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004953 llvm::GlobalVariable *GV = CreateMetadataVar(
John McCall176f8922016-11-30 02:39:18 +00004954 "OBJC_SYMBOLS", values, "__OBJC,__symbols,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00004955 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00004956 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004957}
4958
John McCall882987f2013-02-28 19:01:20 +00004959llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
4960 IdentifierInfo *II) {
John McCall31168b02011-06-15 23:02:42 +00004961 LazySymbols.insert(II);
4962
4963 llvm::GlobalVariable *&Entry = ClassReferences[II];
4964
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004965 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004966 llvm::Constant *Casted =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004967 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCall31168b02011-06-15 23:02:42 +00004968 ObjCTypes.ClassPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004969 Entry = CreateMetadataVar(
4970 "OBJC_CLASS_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004971 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
4972 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004973 }
John McCall31168b02011-06-15 23:02:42 +00004974
John McCall7f416cc2015-09-08 08:05:57 +00004975 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004976}
4977
John McCall882987f2013-02-28 19:01:20 +00004978llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00004979 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00004980 // If the class has the objc_runtime_visible attribute, we need to
4981 // use the Objective-C runtime to get the class.
4982 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
4983 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
4984
Akira Hatanaka0c194462018-04-03 22:50:16 +00004985 IdentifierInfo *RuntimeName =
4986 &CGM.getContext().Idents.get(ID->getObjCRuntimeNameAsString());
4987 return EmitClassRefFromId(CGF, RuntimeName);
John McCall31168b02011-06-15 23:02:42 +00004988}
4989
John McCall882987f2013-02-28 19:01:20 +00004990llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00004991 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCall882987f2013-02-28 19:01:20 +00004992 return EmitClassRefFromId(CGF, II);
John McCall31168b02011-06-15 23:02:42 +00004993}
4994
John McCall7f416cc2015-09-08 08:05:57 +00004995llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
4996 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
4997}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004998
John McCall7f416cc2015-09-08 08:05:57 +00004999Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
5000 CharUnits Align = CGF.getPointerAlign();
5001
5002 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005003 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005004 llvm::Constant *Casted =
Owen Andersonade90fd2009-07-29 18:54:39 +00005005 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005006 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005007 Entry = CreateMetadataVar(
5008 "OBJC_SELECTOR_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00005009 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman5c205962013-02-05 23:08:45 +00005010 Entry->setExternallyInitialized(true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005011 }
5012
John McCall7f416cc2015-09-08 08:05:57 +00005013 return Address(Entry, Align);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005014}
5015
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005016llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
5017 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
5018 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005019 Entry = CreateCStringLiteral(RuntimeName, ObjCLabelType::ClassName);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005020 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005021}
5022
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00005023llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
5024 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
5025 I = MethodDefinitions.find(MD);
5026 if (I != MethodDefinitions.end())
5027 return I->second;
5028
Craig Topper8a13c412014-05-21 05:09:00 +00005029 return nullptr;
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00005030}
5031
Fariborz Jahanian01dff422009-03-05 19:17:31 +00005032/// GetIvarLayoutName - Returns a unique constant for the given
5033/// ivar layout bitmap.
5034llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005035 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Anderson0b75f232009-07-31 20:28:54 +00005036 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahanian01dff422009-03-05 19:17:31 +00005037}
5038
John McCall3fd13f062015-10-21 18:06:47 +00005039void IvarLayoutBuilder::visitRecord(const RecordType *RT,
5040 CharUnits offset) {
Daniel Dunbar15bd8882009-05-03 14:10:34 +00005041 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005042
John McCall3fd13f062015-10-21 18:06:47 +00005043 // If this is a union, remember that we had one, because it might mess
5044 // up the ordering of layout entries.
5045 if (RD->isUnion())
5046 IsDisordered = true;
5047
5048 const ASTRecordLayout *recLayout = nullptr;
5049 visitAggregate(RD->field_begin(), RD->field_end(), offset,
5050 [&](const FieldDecl *field) -> CharUnits {
5051 if (!recLayout)
5052 recLayout = &CGM.getContext().getASTRecordLayout(RD);
5053 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
5054 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
5055 });
Daniel Dunbar15bd8882009-05-03 14:10:34 +00005056}
5057
John McCall3fd13f062015-10-21 18:06:47 +00005058template <class Iterator, class GetOffsetFn>
5059void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
5060 CharUnits aggregateOffset,
5061 const GetOffsetFn &getOffset) {
5062 for (; begin != end; ++begin) {
5063 auto field = *begin;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005064
John McCall3fd13f062015-10-21 18:06:47 +00005065 // Skip over bitfields.
5066 if (field->isBitField()) {
5067 continue;
5068 }
5069
5070 // Compute the offset of the field within the aggregate.
5071 CharUnits fieldOffset = aggregateOffset + getOffset(field);
5072
5073 visitField(field, fieldOffset);
5074 }
5075}
5076
5077/// Collect layout information for the given fields into IvarsInfo.
5078void IvarLayoutBuilder::visitField(const FieldDecl *field,
5079 CharUnits fieldOffset) {
5080 QualType fieldType = field->getType();
5081
5082 // Drill down into arrays.
5083 uint64_t numElts = 1;
Volodymyr Sapsai636ed472017-10-27 00:56:23 +00005084 if (auto arrayType = CGM.getContext().getAsIncompleteArrayType(fieldType)) {
5085 numElts = 0;
5086 fieldType = arrayType->getElementType();
5087 }
5088 // Unlike incomplete arrays, constant arrays can be nested.
John McCall3fd13f062015-10-21 18:06:47 +00005089 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
5090 numElts *= arrayType->getSize().getZExtValue();
5091 fieldType = arrayType->getElementType();
5092 }
5093
5094 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
5095
5096 // If we ended up with a zero-sized array, we've done what we can do within
5097 // the limits of this layout encoding.
5098 if (numElts == 0) return;
5099
5100 // Recurse if the base element type is a record type.
5101 if (auto recType = fieldType->getAs<RecordType>()) {
5102 size_t oldEnd = IvarsInfo.size();
5103
5104 visitRecord(recType, fieldOffset);
5105
5106 // If we have an array, replicate the first entry's layout information.
5107 auto numEltEntries = IvarsInfo.size() - oldEnd;
5108 if (numElts != 1 && numEltEntries != 0) {
5109 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
5110 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
5111 // Copy the last numEltEntries onto the end of the array, adjusting
5112 // each for the element size.
5113 for (size_t i = 0; i != numEltEntries; ++i) {
5114 auto firstEntry = IvarsInfo[oldEnd + i];
5115 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
5116 firstEntry.SizeInWords));
5117 }
5118 }
5119 }
5120
Fariborz Jahanian524bb202009-03-10 16:22:08 +00005121 return;
Fariborz Jahanian3b0f8862009-03-11 00:07:04 +00005122 }
Daniel Dunbar15bd8882009-05-03 14:10:34 +00005123
John McCall3fd13f062015-10-21 18:06:47 +00005124 // Classify the element type.
5125 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005126
John McCall3fd13f062015-10-21 18:06:47 +00005127 // If it matches what we're looking for, add an entry.
5128 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
5129 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
5130 assert(CGM.getContext().getTypeSizeInChars(fieldType)
5131 == CGM.getPointerSize());
5132 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
5133 }
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00005134}
5135
John McCall3fd13f062015-10-21 18:06:47 +00005136/// buildBitmap - This routine does the horsework of taking the offsets of
5137/// strong/weak references and creating a bitmap. The bitmap is also
5138/// returned in the given buffer, suitable for being passed to \c dump().
5139llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
5140 llvm::SmallVectorImpl<unsigned char> &buffer) {
5141 // The bitmap is a series of skip/scan instructions, aligned to word
5142 // boundaries. The skip is performed first.
5143 const unsigned char MaxNibble = 0xF;
5144 const unsigned char SkipMask = 0xF0, SkipShift = 4;
5145 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005146
John McCall3fd13f062015-10-21 18:06:47 +00005147 assert(!IvarsInfo.empty() && "generating bitmap for no data");
5148
5149 // Sort the ivar info on byte position in case we encounterred a
5150 // union nested in the ivar list.
5151 if (IsDisordered) {
5152 // This isn't a stable sort, but our algorithm should handle it fine.
5153 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
5154 } else {
Craig Toppera3467052016-01-03 19:43:20 +00005155 assert(std::is_sorted(IvarsInfo.begin(), IvarsInfo.end()));
John McCall3fd13f062015-10-21 18:06:47 +00005156 }
5157 assert(IvarsInfo.back().Offset < InstanceEnd);
5158
5159 assert(buffer.empty());
5160
5161 // Skip the next N words.
5162 auto skip = [&](unsigned numWords) {
5163 assert(numWords > 0);
5164
5165 // Try to merge into the previous byte. Since scans happen second, we
5166 // can't do this if it includes a scan.
5167 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
5168 unsigned lastSkip = buffer.back() >> SkipShift;
5169 if (lastSkip < MaxNibble) {
5170 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
5171 numWords -= claimed;
5172 lastSkip += claimed;
5173 buffer.back() = (lastSkip << SkipShift);
5174 }
5175 }
5176
5177 while (numWords >= MaxNibble) {
5178 buffer.push_back(MaxNibble << SkipShift);
5179 numWords -= MaxNibble;
5180 }
5181 if (numWords) {
5182 buffer.push_back(numWords << SkipShift);
5183 }
5184 };
5185
5186 // Scan the next N words.
5187 auto scan = [&](unsigned numWords) {
5188 assert(numWords > 0);
5189
5190 // Try to merge into the previous byte. Since scans happen second, we can
5191 // do this even if it includes a skip.
5192 if (!buffer.empty()) {
5193 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
5194 if (lastScan < MaxNibble) {
5195 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
5196 numWords -= claimed;
5197 lastScan += claimed;
5198 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
5199 }
5200 }
5201
5202 while (numWords >= MaxNibble) {
5203 buffer.push_back(MaxNibble << ScanShift);
5204 numWords -= MaxNibble;
5205 }
5206 if (numWords) {
5207 buffer.push_back(numWords << ScanShift);
5208 }
5209 };
5210
5211 // One past the end of the last scan.
5212 unsigned endOfLastScanInWords = 0;
5213 const CharUnits WordSize = CGM.getPointerSize();
5214
5215 // Consider all the scan requests.
5216 for (auto &request : IvarsInfo) {
5217 CharUnits beginOfScan = request.Offset - InstanceBegin;
5218
5219 // Ignore scan requests that don't start at an even multiple of the
5220 // word size. We can't encode them.
5221 if ((beginOfScan % WordSize) != 0) continue;
5222
5223 // Ignore scan requests that start before the instance start.
5224 // This assumes that scans never span that boundary. The boundary
5225 // isn't the true start of the ivars, because in the fragile-ARC case
5226 // it's rounded up to word alignment, but the test above should leave
5227 // us ignoring that possibility.
5228 if (beginOfScan.isNegative()) {
5229 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
5230 continue;
5231 }
5232
5233 unsigned beginOfScanInWords = beginOfScan / WordSize;
5234 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
5235
5236 // If the scan starts some number of words after the last one ended,
5237 // skip forward.
5238 if (beginOfScanInWords > endOfLastScanInWords) {
5239 skip(beginOfScanInWords - endOfLastScanInWords);
5240
5241 // Otherwise, start scanning where the last left off.
5242 } else {
5243 beginOfScanInWords = endOfLastScanInWords;
5244
5245 // If that leaves us with nothing to scan, ignore this request.
5246 if (beginOfScanInWords >= endOfScanInWords) continue;
5247 }
5248
5249 // Scan to the end of the request.
5250 assert(beginOfScanInWords < endOfScanInWords);
5251 scan(endOfScanInWords - beginOfScanInWords);
5252 endOfLastScanInWords = endOfScanInWords;
5253 }
5254
John McCallf5ea0722015-10-29 23:36:14 +00005255 if (buffer.empty())
5256 return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
5257
John McCall3fd13f062015-10-21 18:06:47 +00005258 // For GC layouts, emit a skip to the end of the allocation so that we
5259 // have precise information about the entire thing. This isn't useful
5260 // or necessary for the ARC-style layout strings.
5261 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
5262 unsigned lastOffsetInWords =
5263 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
5264 if (lastOffsetInWords > endOfLastScanInWords) {
5265 skip(lastOffsetInWords - endOfLastScanInWords);
5266 }
5267 }
5268
5269 // Null terminate the string.
5270 buffer.push_back(0);
5271
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005272 auto *Entry = CGObjC.CreateCStringLiteral(
5273 reinterpret_cast<char *>(buffer.data()), ObjCLabelType::ClassName);
John McCall3fd13f062015-10-21 18:06:47 +00005274 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005275}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005276
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005277/// BuildIvarLayout - Builds ivar layout bitmap for the class
5278/// implementation for the __strong or __weak case.
5279/// The layout map displays which words in ivar list must be skipped
5280/// and which must be scanned by GC (see below). String is built of bytes.
5281/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
5282/// of words to skip and right nibble is count of words to scan. So, each
5283/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
5284/// represented by a 0x00 byte which also ends the string.
5285/// 1. when ForStrongLayout is true, following ivars are scanned:
5286/// - id, Class
5287/// - object *
5288/// - __strong anything
5289///
5290/// 2. When ForStrongLayout is false, following ivars are scanned:
5291/// - __weak anything
5292///
John McCall3fd13f062015-10-21 18:06:47 +00005293llvm::Constant *
5294CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
5295 CharUnits beginOffset, CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +00005296 bool ForStrongLayout, bool HasMRCWeakIvars) {
5297 // If this is MRC, and we're either building a strong layout or there
5298 // are no weak ivars, bail out early.
Chris Lattnerece04092012-02-07 00:39:47 +00005299 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005300 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
John McCall460ce582015-10-22 18:38:17 +00005301 !CGM.getLangOpts().ObjCAutoRefCount &&
5302 (ForStrongLayout || !HasMRCWeakIvars))
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005303 return llvm::Constant::getNullValue(PtrTy);
5304
Jordy Rosea91768e2011-07-22 02:08:32 +00005305 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
John McCall3fd13f062015-10-21 18:06:47 +00005306 SmallVector<const ObjCIvarDecl*, 32> ivars;
5307
5308 // GC layout strings include the complete object layout, possibly
5309 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
5310 // up.
5311 //
5312 // ARC layout strings only include the class's ivars. In non-fragile
John McCallf5ea0722015-10-29 23:36:14 +00005313 // runtimes, that means starting at InstanceStart, rounded up to word
5314 // alignment. In fragile runtimes, there's no InstanceStart, so it means
John McCalld80218f2015-11-19 02:27:55 +00005315 // starting at the offset of the first ivar, rounded up to word alignment.
John McCall460ce582015-10-22 18:38:17 +00005316 //
5317 // MRC weak layout strings follow the ARC style.
John McCall3fd13f062015-10-21 18:06:47 +00005318 CharUnits baseOffset;
John McCall460ce582015-10-22 18:38:17 +00005319 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Jordy Rosea91768e2011-07-22 02:08:32 +00005320 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005321 IVD; IVD = IVD->getNextIvar())
John McCall3fd13f062015-10-21 18:06:47 +00005322 ivars.push_back(IVD);
5323
5324 if (isNonFragileABI()) {
5325 baseOffset = beginOffset; // InstanceStart
John McCalld80218f2015-11-19 02:27:55 +00005326 } else if (!ivars.empty()) {
5327 baseOffset =
5328 CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivars[0]));
John McCall3fd13f062015-10-21 18:06:47 +00005329 } else {
5330 baseOffset = CharUnits::Zero();
5331 }
John McCallf5ea0722015-10-29 23:36:14 +00005332
Rui Ueyama83aa9792016-01-14 21:00:27 +00005333 baseOffset = baseOffset.alignTo(CGM.getPointerAlign());
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005334 }
5335 else {
John McCall3fd13f062015-10-21 18:06:47 +00005336 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005337
John McCall3fd13f062015-10-21 18:06:47 +00005338 baseOffset = CharUnits::Zero();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005339 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005340
John McCall3fd13f062015-10-21 18:06:47 +00005341 if (ivars.empty())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005342 return llvm::Constant::getNullValue(PtrTy);
5343
John McCall3fd13f062015-10-21 18:06:47 +00005344 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005345
John McCall3fd13f062015-10-21 18:06:47 +00005346 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
5347 [&](const ObjCIvarDecl *ivar) -> CharUnits {
5348 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
5349 });
5350
5351 if (!builder.hasBitmapData())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005352 return llvm::Constant::getNullValue(PtrTy);
John McCall3fd13f062015-10-21 18:06:47 +00005353
5354 llvm::SmallVector<unsigned char, 4> buffer;
5355 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005356
John McCallf5ea0722015-10-29 23:36:14 +00005357 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005358 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005359 ForStrongLayout ? "strong" : "weak",
Ben Langmuire013bdc2014-07-11 00:43:47 +00005360 OMD->getClassInterface()->getName().str().c_str());
John McCall3fd13f062015-10-21 18:06:47 +00005361 builder.dump(buffer);
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005362 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005363 return C;
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00005364}
5365
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005366llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005367 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
Chris Lattner3def9ae2012-02-06 22:16:34 +00005368 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005369 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005370 Entry = CreateCStringLiteral(Sel.getAsString(), ObjCLabelType::MethodVarName);
Owen Anderson170229f2009-07-14 23:10:40 +00005371 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005372}
5373
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005374// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005375llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005376 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
5377}
5378
Daniel Dunbarf5c18462009-04-20 06:54:31 +00005379llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005380 std::string TypeStr;
5381 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
5382
5383 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005384 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005385 Entry = CreateCStringLiteral(TypeStr, ObjCLabelType::MethodVarType);
Owen Anderson170229f2009-07-14 23:10:40 +00005386 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005387}
5388
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005389llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
5390 bool Extended) {
John McCall843dfcc2016-11-29 21:57:00 +00005391 std::string TypeStr =
5392 CGM.getContext().getObjCEncodingForMethodDecl(D, Extended);
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005393
5394 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbar3241fae2009-04-14 23:14:47 +00005395 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005396 Entry = CreateCStringLiteral(TypeStr, ObjCLabelType::MethodVarType);
Owen Anderson170229f2009-07-14 23:10:40 +00005397 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005398}
5399
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005400// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005401llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005402 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005403 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005404 Entry = CreateCStringLiteral(Ident->getName(), ObjCLabelType::PropertyName);
Owen Anderson170229f2009-07-14 23:10:40 +00005405 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005406}
5407
5408// FIXME: Merge into a single cstring creation function.
Daniel Dunbar4932b362008-08-28 04:38:10 +00005409// FIXME: This Decl should be more precise.
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005410llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005411CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
5412 const Decl *Container) {
John McCall843dfcc2016-11-29 21:57:00 +00005413 std::string TypeStr =
5414 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005415 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
5416}
5417
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005418void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005419 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005420 SmallVectorImpl<char> &Name) {
Daniel Dunbard2386812009-10-19 01:21:19 +00005421 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00005422 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbard2386812009-10-19 01:21:19 +00005423 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
5424 << '[' << CD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005425 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbard2386812009-10-19 01:21:19 +00005426 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramer2f569922012-02-07 11:57:45 +00005427 OS << '(' << *CID << ')';
Daniel Dunbard2386812009-10-19 01:21:19 +00005428 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbara94ecd22008-08-16 03:19:19 +00005429}
5430
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005431void CGObjCMac::FinishModule() {
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005432 EmitModuleInfo();
5433
Daniel Dunbarc475d422008-10-29 22:36:39 +00005434 // Emit the dummy bodies for any protocols which were referenced but
5435 // never defined.
John McCall176f8922016-11-30 02:39:18 +00005436 for (auto &entry : Protocols) {
5437 llvm::GlobalVariable *global = entry.second;
5438 if (global->hasInitializer())
Daniel Dunbarc475d422008-10-29 22:36:39 +00005439 continue;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005440
John McCall176f8922016-11-30 02:39:18 +00005441 ConstantInitBuilder builder(CGM);
5442 auto values = builder.beginStruct(ObjCTypes.ProtocolTy);
5443 values.addNullPointer(ObjCTypes.ProtocolExtensionPtrTy);
5444 values.add(GetClassName(entry.first->getName()));
5445 values.addNullPointer(ObjCTypes.ProtocolListPtrTy);
5446 values.addNullPointer(ObjCTypes.MethodDescriptionListPtrTy);
5447 values.addNullPointer(ObjCTypes.MethodDescriptionListPtrTy);
5448 values.finishAndSetAsInitializer(global);
5449 CGM.addCompilerUsedGlobal(global);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005450 }
5451
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005452 // Add assembler directives to add lazy undefined symbol references
5453 // for classes which are referenced but not defined. This is
5454 // important for correct linker interaction.
Daniel Dunbard027a922009-09-07 00:20:42 +00005455 //
5456 // FIXME: It would be nice if we had an LLVM construct for this.
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005457 if ((!LazySymbols.empty() || !DefinedSymbols.empty()) &&
5458 CGM.getTriple().isOSBinFormatMachO()) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005459 SmallString<256> Asm;
Daniel Dunbard027a922009-09-07 00:20:42 +00005460 Asm += CGM.getModule().getModuleInlineAsm();
5461 if (!Asm.empty() && Asm.back() != '\n')
5462 Asm += '\n';
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005463
Daniel Dunbard027a922009-09-07 00:20:42 +00005464 llvm::raw_svector_ostream OS(Asm);
Saleem Abdulrasool39217d42016-09-16 14:24:26 +00005465 for (const auto *Sym : DefinedSymbols)
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005466 OS << "\t.objc_class_name_" << Sym->getName() << "=0\n"
5467 << "\t.globl .objc_class_name_" << Sym->getName() << "\n";
Saleem Abdulrasool39217d42016-09-16 14:24:26 +00005468 for (const auto *Sym : LazySymbols)
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005469 OS << "\t.lazy_reference .objc_class_name_" << Sym->getName() << "\n";
5470 for (const auto &Category : DefinedCategoryNames)
5471 OS << "\t.objc_category_name_" << Category << "=0\n"
5472 << "\t.globl .objc_category_name_" << Category << "\n";
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005473
Daniel Dunbard027a922009-09-07 00:20:42 +00005474 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005475 }
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005476}
5477
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005478CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00005479 : CGObjCCommonMac(cgm), ObjCTypes(cgm), ObjCEmptyCacheVar(nullptr),
5480 ObjCEmptyVtableVar(nullptr) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005481 ObjCABI = 2;
5482}
5483
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005484/* *** */
5485
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005486ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Craig Topper8a13c412014-05-21 05:09:00 +00005487 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregora95f9aa2012-01-17 23:38:32 +00005488{
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005489 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5490 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005491
John McCall176f8922016-11-30 02:39:18 +00005492 ShortTy = cast<llvm::IntegerType>(Types.ConvertType(Ctx.ShortTy));
5493 IntTy = CGM.IntTy;
5494 LongTy = cast<llvm::IntegerType>(Types.ConvertType(Ctx.LongTy));
Chris Lattnerece04092012-02-07 00:39:47 +00005495 Int8PtrTy = CGM.Int8PtrTy;
5496 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005497
Tim Northover238b5082014-03-29 13:42:40 +00005498 // arm64 targets use "int" ivar offset variables. All others,
5499 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Tim Northover40956e62014-07-23 12:32:58 +00005500 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Tim Northover238b5082014-03-29 13:42:40 +00005501 IvarOffsetVarTy = IntTy;
5502 else
5503 IvarOffsetVarTy = LongTy;
5504
John McCall176f8922016-11-30 02:39:18 +00005505 ObjectPtrTy =
5506 cast<llvm::PointerType>(Types.ConvertType(Ctx.getObjCIdType()));
5507 PtrObjectPtrTy =
5508 llvm::PointerType::getUnqual(ObjectPtrTy);
5509 SelectorPtrTy =
5510 cast<llvm::PointerType>(Types.ConvertType(Ctx.getObjCSelType()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005511
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005512 // I'm not sure I like this. The implicit coordination is a bit
5513 // gross. We should solve this in a reasonable fashion because this
5514 // is a pretty common task (match some runtime data structure with
5515 // an LLVM data structure).
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005516
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005517 // FIXME: This is leaked.
5518 // FIXME: Merge with rewriter code?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005519
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005520 // struct _objc_super {
5521 // id self;
5522 // Class cls;
5523 // }
Abramo Bagnara6150c882010-05-11 21:36:43 +00005524 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005525 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005526 SourceLocation(), SourceLocation(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005527 &Ctx.Idents.get("_objc_super"));
Craig Topper8a13c412014-05-21 05:09:00 +00005528 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5529 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5530 false, ICIS_NoInit));
5531 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5532 nullptr, Ctx.getObjCClassType(), nullptr,
5533 nullptr, false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005534 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005535
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005536 SuperCTy = Ctx.getTagDeclType(RD);
5537 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005538
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005539 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005540 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5541
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005542 // struct _prop_t {
5543 // char *name;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005544 // char *attributes;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005545 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005546 PropertyTy = llvm::StructType::create("struct._prop_t", Int8PtrTy, Int8PtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005547
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005548 // struct _prop_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005549 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005550 // uint32_t count_of_properties;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005551 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005552 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005553 PropertyListTy = llvm::StructType::create(
5554 "struct._prop_list_t", IntTy, IntTy, llvm::ArrayType::get(PropertyTy, 0));
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005555 // struct _prop_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005556 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005557
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005558 // struct _objc_method {
5559 // SEL _cmd;
5560 // char *method_type;
5561 // char *_imp;
5562 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005563 MethodTy = llvm::StructType::create("struct._objc_method", SelectorPtrTy,
5564 Int8PtrTy, Int8PtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005565
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005566 // struct _objc_cache *
Chris Lattner5ec04a52011-08-12 17:43:31 +00005567 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005568 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005569}
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005570
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005571ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005572 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005573 // struct _objc_method_description {
5574 // SEL name;
5575 // char *types;
5576 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005577 MethodDescriptionTy = llvm::StructType::create(
5578 "struct._objc_method_description", SelectorPtrTy, Int8PtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005579
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005580 // struct _objc_method_description_list {
5581 // int count;
5582 // struct _objc_method_description[1];
5583 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005584 MethodDescriptionListTy =
5585 llvm::StructType::create("struct._objc_method_description_list", IntTy,
5586 llvm::ArrayType::get(MethodDescriptionTy, 0));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005587
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005588 // struct _objc_method_description_list *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005589 MethodDescriptionListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005590 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005591
Daniel Dunbarb036db82008-08-13 03:21:16 +00005592 // Protocol description structures
5593
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005594 // struct _objc_protocol_extension {
5595 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5596 // struct _objc_method_description_list *optional_instance_methods;
5597 // struct _objc_method_description_list *optional_class_methods;
5598 // struct _objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005599 // const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00005600 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005601 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005602 ProtocolExtensionTy = llvm::StructType::create(
5603 "struct._objc_protocol_extension", IntTy, MethodDescriptionListPtrTy,
5604 MethodDescriptionListPtrTy, PropertyListPtrTy, Int8PtrPtrTy,
5605 PropertyListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005606
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005607 // struct _objc_protocol_extension *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005608 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005609
Daniel Dunbarc475d422008-10-29 22:36:39 +00005610 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbarb036db82008-08-13 03:21:16 +00005611
Chris Lattnera5f58b02011-07-09 17:41:47 +00005612 ProtocolTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005613 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbarb036db82008-08-13 03:21:16 +00005614
Chris Lattnera5f58b02011-07-09 17:41:47 +00005615 ProtocolListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005616 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Serge Guelton1d993272017-05-09 19:31:30 +00005617 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy), LongTy,
5618 llvm::ArrayType::get(ProtocolTy, 0));
Daniel Dunbarb036db82008-08-13 03:21:16 +00005619
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005620 // struct _objc_protocol {
5621 // struct _objc_protocol_extension *isa;
5622 // char *protocol_name;
5623 // struct _objc_protocol **_objc_protocol_list;
5624 // struct _objc_method_description_list *instance_methods;
5625 // struct _objc_method_description_list *class_methods;
5626 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005627 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5628 llvm::PointerType::getUnqual(ProtocolListTy),
Serge Guelton1d993272017-05-09 19:31:30 +00005629 MethodDescriptionListPtrTy, MethodDescriptionListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005630
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005631 // struct _objc_protocol_list *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005632 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005633
Owen Anderson9793f0e2009-07-29 22:16:19 +00005634 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005635
5636 // Class description structures
5637
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005638 // struct _objc_ivar {
5639 // char *ivar_name;
5640 // char *ivar_type;
5641 // int ivar_offset;
5642 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005643 IvarTy = llvm::StructType::create("struct._objc_ivar", Int8PtrTy, Int8PtrTy,
5644 IntTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005645
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005646 // struct _objc_ivar_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005647 IvarListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005648 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005649 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005650
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005651 // struct _objc_method_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005652 MethodListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005653 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005654 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005655
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005656 // struct _objc_class_extension *
Serge Guelton1d993272017-05-09 19:31:30 +00005657 ClassExtensionTy = llvm::StructType::create(
5658 "struct._objc_class_extension", IntTy, Int8PtrTy, PropertyListPtrTy);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005659 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005660
Chris Lattner5ec04a52011-08-12 17:43:31 +00005661 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005662
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005663 // struct _objc_class {
5664 // Class isa;
5665 // Class super_class;
5666 // char *name;
5667 // long version;
5668 // long info;
5669 // long instance_size;
5670 // struct _objc_ivar_list *ivars;
5671 // struct _objc_method_list *methods;
5672 // struct _objc_cache *cache;
5673 // struct _objc_protocol_list *protocols;
5674 // char *ivar_layout;
5675 // struct _objc_class_ext *ext;
5676 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005677 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
Serge Guelton1d993272017-05-09 19:31:30 +00005678 llvm::PointerType::getUnqual(ClassTy), Int8PtrTy, LongTy,
5679 LongTy, LongTy, IvarListPtrTy, MethodListPtrTy, CachePtrTy,
5680 ProtocolListPtrTy, Int8PtrTy, ClassExtensionPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005681
Owen Anderson9793f0e2009-07-29 22:16:19 +00005682 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005683
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005684 // struct _objc_category {
5685 // char *category_name;
5686 // char *class_name;
5687 // struct _objc_method_list *instance_method;
5688 // struct _objc_method_list *class_method;
Manman Renb3736772016-01-25 22:37:47 +00005689 // struct _objc_protocol_list *protocols;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005690 // uint32_t size; // sizeof(struct _objc_category)
5691 // struct _objc_property_list *instance_properties;// category's @property
Manman Ren96df0b32016-01-29 23:45:01 +00005692 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005693 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005694 CategoryTy = llvm::StructType::create(
5695 "struct._objc_category", Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5696 MethodListPtrTy, ProtocolListPtrTy, IntTy, PropertyListPtrTy,
5697 PropertyListPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005698
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005699 // Global metadata structures
5700
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005701 // struct _objc_symtab {
5702 // long sel_ref_cnt;
5703 // SEL *refs;
5704 // short cls_def_cnt;
5705 // short cat_def_cnt;
5706 // char *defs[cls_def_cnt + cat_def_cnt];
5707 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005708 SymtabTy = llvm::StructType::create("struct._objc_symtab", LongTy,
5709 SelectorPtrTy, ShortTy, ShortTy,
5710 llvm::ArrayType::get(Int8PtrTy, 0));
Owen Anderson9793f0e2009-07-29 22:16:19 +00005711 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005712
Fariborz Jahanianeee54df2009-01-22 00:37:21 +00005713 // struct _objc_module {
5714 // long version;
5715 // long size; // sizeof(struct _objc_module)
5716 // char *name;
5717 // struct _objc_symtab* symtab;
5718 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005719 ModuleTy = llvm::StructType::create("struct._objc_module", LongTy, LongTy,
5720 Int8PtrTy, SymtabPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005721
Mike Stump18bb9282009-05-16 07:57:57 +00005722 // FIXME: This is the size of the setjmp buffer and should be target
5723 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson9ff22482008-09-09 10:10:21 +00005724 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005725
Anders Carlsson9ff22482008-09-09 10:10:21 +00005726 // Exceptions
Chris Lattnerece04092012-02-07 00:39:47 +00005727 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005728
Serge Guelton1d993272017-05-09 19:31:30 +00005729 ExceptionDataTy = llvm::StructType::create(
5730 "struct._objc_exception_data",
5731 llvm::ArrayType::get(CGM.Int32Ty, SetJmpBufferSize), StackPtrTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005732}
5733
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005734ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005735 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005736 // struct _method_list_t {
5737 // uint32_t entsize; // sizeof(struct _objc_method)
5738 // uint32_t method_count;
5739 // struct _objc_method method_list[method_count];
5740 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005741 MethodListnfABITy =
Serge Guelton1d993272017-05-09 19:31:30 +00005742 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
5743 llvm::ArrayType::get(MethodTy, 0));
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005744 // struct method_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005745 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005746
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005747 // struct _protocol_t {
5748 // id isa; // NULL
5749 // const char * const protocol_name;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005750 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005751 // const struct method_list_t * const instance_methods;
5752 // const struct method_list_t * const class_methods;
5753 // const struct method_list_t *optionalInstanceMethods;
5754 // const struct method_list_t *optionalClassMethods;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005755 // const struct _prop_list_t * properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005756 // const uint32_t size; // sizeof(struct _protocol_t)
5757 // const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005758 // const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005759 // const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00005760 // const struct _prop_list_t * class_properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005761 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005762
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005763 // Holder for struct _protocol_list_t *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005764 ProtocolListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005765 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005766
Serge Guelton1d993272017-05-09 19:31:30 +00005767 ProtocolnfABITy = llvm::StructType::create(
5768 "struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5769 llvm::PointerType::getUnqual(ProtocolListnfABITy), MethodListnfABIPtrTy,
5770 MethodListnfABIPtrTy, MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5771 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy, Int8PtrTy,
5772 PropertyListPtrTy);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005773
5774 // struct _protocol_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005775 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005776
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005777 // struct _protocol_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005778 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005779 // struct _protocol_t *[protocol_count];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005780 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005781 ProtocolListnfABITy->setBody(LongTy,
Serge Guelton1d993272017-05-09 19:31:30 +00005782 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005783
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005784 // struct _objc_protocol_list*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005785 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005786
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005787 // struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00005788 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005789 // char *name;
5790 // char *type;
5791 // uint32_t alignment;
5792 // uint32_t size;
5793 // }
Tim Northover238b5082014-03-29 13:42:40 +00005794 IvarnfABITy = llvm::StructType::create(
5795 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Serge Guelton1d993272017-05-09 19:31:30 +00005796 Int8PtrTy, Int8PtrTy, IntTy, IntTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005797
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005798 // struct _ivar_list_t {
5799 // uint32 entsize; // sizeof(struct _ivar_t)
5800 // uint32 count;
5801 // struct _iver_t list[count];
5802 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005803 IvarListnfABITy =
Serge Guelton1d993272017-05-09 19:31:30 +00005804 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
5805 llvm::ArrayType::get(IvarnfABITy, 0));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005806
Owen Anderson9793f0e2009-07-29 22:16:19 +00005807 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005808
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005809 // struct _class_ro_t {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005810 // uint32_t const flags;
5811 // uint32_t const instanceStart;
5812 // uint32_t const instanceSize;
5813 // uint32_t const reserved; // only when building for 64bit targets
5814 // const uint8_t * const ivarLayout;
5815 // const char *const name;
5816 // const struct _method_list_t * const baseMethods;
5817 // const struct _objc_protocol_list *const baseProtocols;
5818 // const struct _ivar_list_t *const ivars;
5819 // const uint8_t * const weakIvarLayout;
5820 // const struct _prop_list_t * const properties;
5821 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005822
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005823 // FIXME. Add 'reserved' field in 64bit abi mode!
Serge Guelton1d993272017-05-09 19:31:30 +00005824 ClassRonfABITy = llvm::StructType::create(
5825 "struct._class_ro_t", IntTy, IntTy, IntTy, Int8PtrTy, Int8PtrTy,
5826 MethodListnfABIPtrTy, ProtocolListnfABIPtrTy, IvarListnfABIPtrTy,
5827 Int8PtrTy, PropertyListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005828
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005829 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +00005830 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +00005831 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5832 ->getPointerTo();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005833
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005834 // struct _class_t {
5835 // struct _class_t *isa;
5836 // struct _class_t * const superclass;
5837 // void *cache;
5838 // IMP *vtable;
5839 // struct class_ro_t *ro;
5840 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005841
Chris Lattner5ec04a52011-08-12 17:43:31 +00005842 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005843 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
Serge Guelton1d993272017-05-09 19:31:30 +00005844 llvm::PointerType::getUnqual(ClassnfABITy), CachePtrTy,
Chris Lattnera5f58b02011-07-09 17:41:47 +00005845 llvm::PointerType::getUnqual(ImpnfABITy),
Serge Guelton1d993272017-05-09 19:31:30 +00005846 llvm::PointerType::getUnqual(ClassRonfABITy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005847
Fariborz Jahanian71394042009-01-23 23:53:38 +00005848 // LLVM for struct _class_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005849 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005850
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005851 // struct _category_t {
5852 // const char * const name;
5853 // struct _class_t *const cls;
5854 // const struct _method_list_t * const instance_methods;
5855 // const struct _method_list_t * const class_methods;
5856 // const struct _protocol_list_t * const protocols;
5857 // const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00005858 // const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00005859 // const uint32_t size;
Fariborz Jahanian5a63e4c2009-01-23 17:41:22 +00005860 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005861 CategorynfABITy = llvm::StructType::create(
5862 "struct._category_t", Int8PtrTy, ClassnfABIPtrTy, MethodListnfABIPtrTy,
5863 MethodListnfABIPtrTy, ProtocolListnfABIPtrTy, PropertyListPtrTy,
5864 PropertyListPtrTy, IntTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005865
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005866 // New types for nonfragile abi messaging.
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005867 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5868 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005869
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005870 // MessageRefTy - LLVM for:
5871 // struct _message_ref_t {
5872 // IMP messenger;
5873 // SEL name;
5874 // };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005875
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005876 // First the clang type for struct _message_ref_t
Abramo Bagnara6150c882010-05-11 21:36:43 +00005877 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005878 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005879 SourceLocation(), SourceLocation(),
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005880 &Ctx.Idents.get("_message_ref_t"));
Craig Topper8a13c412014-05-21 05:09:00 +00005881 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5882 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smith2b013182012-06-10 03:12:00 +00005883 ICIS_NoInit));
Craig Topper8a13c412014-05-21 05:09:00 +00005884 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5885 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5886 false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005887 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005888
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005889 MessageRefCTy = Ctx.getTagDeclType(RD);
5890 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5891 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005892
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005893 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005894 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005895
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005896 // SuperMessageRefTy - LLVM for:
5897 // struct _super_message_ref_t {
5898 // SUPER_IMP messenger;
5899 // SEL name;
5900 // };
Serge Guelton1d993272017-05-09 19:31:30 +00005901 SuperMessageRefTy = llvm::StructType::create("struct._super_message_ref_t",
5902 ImpnfABITy, SelectorPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005903
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005904 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005905 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005906
Daniel Dunbarb1559a42009-03-01 04:46:24 +00005907
5908 // struct objc_typeinfo {
5909 // const void** vtable; // objc_ehtype_vtable + 2
5910 // const char* name; // c++ typeinfo string
5911 // Class cls;
5912 // };
Serge Guelton1d993272017-05-09 19:31:30 +00005913 EHTypeTy = llvm::StructType::create("struct._objc_typeinfo",
5914 llvm::PointerType::getUnqual(Int8PtrTy),
5915 Int8PtrTy, ClassnfABIPtrTy);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005916 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005917}
5918
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005919llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanian71394042009-01-23 23:53:38 +00005920 FinishNonFragileABIModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005921
Craig Topper8a13c412014-05-21 05:09:00 +00005922 return nullptr;
Fariborz Jahanian71394042009-01-23 23:53:38 +00005923}
5924
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00005925void CGObjCNonFragileABIMac::AddModuleClassList(
5926 ArrayRef<llvm::GlobalValue *> Container, StringRef SymbolName,
5927 StringRef SectionName) {
Daniel Dunbar19573e72009-05-15 21:48:48 +00005928 unsigned NumClasses = Container.size();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005929
Daniel Dunbar19573e72009-05-15 21:48:48 +00005930 if (!NumClasses)
5931 return;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005932
Chris Lattner3def9ae2012-02-06 22:16:34 +00005933 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005934 for (unsigned i=0; i<NumClasses; i++)
Owen Andersonade90fd2009-07-29 18:54:39 +00005935 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar19573e72009-05-15 21:48:48 +00005936 ObjCTypes.Int8PtrTy);
Chris Lattner3def9ae2012-02-06 22:16:34 +00005937 llvm::Constant *Init =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005938 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00005939 Symbols.size()),
Daniel Dunbar19573e72009-05-15 21:48:48 +00005940 Symbols);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005941
Daniel Dunbar19573e72009-05-15 21:48:48 +00005942 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00005943 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005944 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar19573e72009-05-15 21:48:48 +00005945 Init,
Owen Andersonc10c8d32009-07-08 19:05:04 +00005946 SymbolName);
Micah Villmowdd31ca12012-10-08 16:25:52 +00005947 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar19573e72009-05-15 21:48:48 +00005948 GV->setSection(SectionName);
Rafael Espindola060062a2014-03-06 22:15:10 +00005949 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005950}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005951
Fariborz Jahanian71394042009-01-23 23:53:38 +00005952void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
5953 // nonfragile abi has no module definition.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005954
Daniel Dunbar19573e72009-05-15 21:48:48 +00005955 // Build list of all implemented class addresses in array
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005956 // L_OBJC_LABEL_CLASS_$.
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005957
5958 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
5959 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5960 assert(ID);
5961 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5962 // We are implementing a weak imported interface. Give it external linkage
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005963 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005964 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005965 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
5966 }
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005967 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005968
5969 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00005970 GetSectionName("__objc_classlist",
5971 "regular,no_dead_strip"));
Rafael Espindola554256c2014-02-26 22:25:45 +00005972
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005973 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00005974 GetSectionName("__objc_nlclslist",
5975 "regular,no_dead_strip"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005976
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005977 // Build list of all implemented category addresses in array
5978 // L_OBJC_LABEL_CATEGORY_$.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005979 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00005980 GetSectionName("__objc_catlist",
5981 "regular,no_dead_strip"));
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005982 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00005983 GetSectionName("__objc_nlcatlist",
5984 "regular,no_dead_strip"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005985
Daniel Dunbar5e639272010-04-25 20:39:01 +00005986 EmitImageInfo();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005987}
5988
John McCall9e8bb002011-05-14 03:10:52 +00005989/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
5990/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005991/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005992/// message dispatch call for all the rest.
John McCall9e8bb002011-05-14 03:10:52 +00005993bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
5994 // At various points we've experimented with using vtable-based
5995 // dispatch for all methods.
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005996 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005997 case CodeGenOptions::Legacy:
Fariborz Jahaniandfb39832010-04-19 17:53:30 +00005998 return false;
John McCall9e8bb002011-05-14 03:10:52 +00005999 case CodeGenOptions::NonLegacy:
6000 return true;
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00006001 case CodeGenOptions::Mixed:
6002 break;
6003 }
6004
6005 // If so, see whether this selector is in the white-list of things which must
6006 // use the new dispatch convention. We lazily build a dense set for this.
John McCall9e8bb002011-05-14 03:10:52 +00006007 if (VTableDispatchMethods.empty()) {
6008 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
6009 VTableDispatchMethods.insert(GetNullarySelector("class"));
6010 VTableDispatchMethods.insert(GetNullarySelector("self"));
6011 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
6012 VTableDispatchMethods.insert(GetNullarySelector("length"));
6013 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006014
John McCall9e8bb002011-05-14 03:10:52 +00006015 // These are vtable-based if GC is disabled.
6016 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00006017 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall9e8bb002011-05-14 03:10:52 +00006018 VTableDispatchMethods.insert(GetNullarySelector("retain"));
6019 VTableDispatchMethods.insert(GetNullarySelector("release"));
6020 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
6021 }
6022
6023 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
6024 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
6025 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
6026 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
6027 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
6028 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
6029 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
6030
6031 // These are vtable-based if GC is enabled.
6032 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00006033 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall9e8bb002011-05-14 03:10:52 +00006034 VTableDispatchMethods.insert(GetNullarySelector("hash"));
6035 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
6036
6037 // "countByEnumeratingWithState:objects:count"
6038 IdentifierInfo *KeyIdents[] = {
6039 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
6040 &CGM.getContext().Idents.get("objects"),
6041 &CGM.getContext().Idents.get("count")
6042 };
6043 VTableDispatchMethods.insert(
6044 CGM.getContext().Selectors.getSelector(3, KeyIdents));
6045 }
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006046 }
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00006047
John McCall9e8bb002011-05-14 03:10:52 +00006048 return VTableDispatchMethods.count(Sel);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006049}
6050
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006051/// BuildClassRoTInitializer - generate meta-data for:
6052/// struct _class_ro_t {
6053/// uint32_t const flags;
6054/// uint32_t const instanceStart;
6055/// uint32_t const instanceSize;
6056/// uint32_t const reserved; // only when building for 64bit targets
6057/// const uint8_t * const ivarLayout;
6058/// const char *const name;
6059/// const struct _method_list_t * const baseMethods;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006060/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006061/// const struct _ivar_list_t *const ivars;
6062/// const uint8_t * const weakIvarLayout;
6063/// const struct _prop_list_t * const properties;
6064/// }
6065///
6066llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006067 unsigned flags,
6068 unsigned InstanceStart,
6069 unsigned InstanceSize,
6070 const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006071 std::string ClassName = ID->getObjCRuntimeNameAsString();
John McCall31168b02011-06-15 23:02:42 +00006072
John McCall3fd13f062015-10-21 18:06:47 +00006073 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
6074 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
6075
John McCall460ce582015-10-22 18:38:17 +00006076 bool hasMRCWeak = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00006077 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallef19dbb2012-10-17 04:53:23 +00006078 flags |= NonFragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00006079 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
6080 flags |= NonFragileABI_Class_HasMRCWeakIvars;
John McCall31168b02011-06-15 23:02:42 +00006081
John McCall176f8922016-11-30 02:39:18 +00006082 ConstantInitBuilder builder(CGM);
6083 auto values = builder.beginStruct(ObjCTypes.ClassRonfABITy);
6084
6085 values.addInt(ObjCTypes.IntTy, flags);
6086 values.addInt(ObjCTypes.IntTy, InstanceStart);
6087 values.addInt(ObjCTypes.IntTy, InstanceSize);
6088 values.add((flags & NonFragileABI_Class_Meta)
6089 ? GetIvarLayoutName(nullptr, ObjCTypes)
6090 : BuildStrongIvarLayout(ID, beginInstance, endInstance));
6091 values.add(GetClassName(ID->getObjCRuntimeNameAsString()));
6092
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006093 // const struct _method_list_t * const baseMethods;
John McCall176f8922016-11-30 02:39:18 +00006094 SmallVector<const ObjCMethodDecl*, 16> methods;
John McCallef19dbb2012-10-17 04:53:23 +00006095 if (flags & NonFragileABI_Class_Meta) {
John McCall176f8922016-11-30 02:39:18 +00006096 for (const auto *MD : ID->class_methods())
6097 methods.push_back(MD);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006098 } else {
John McCall176f8922016-11-30 02:39:18 +00006099 for (const auto *MD : ID->instance_methods())
6100 methods.push_back(MD);
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006101
Aaron Ballmand85eff42014-03-14 15:02:45 +00006102 for (const auto *PID : ID->property_impls()) {
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00006103 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
6104 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006105
John McCall176f8922016-11-30 02:39:18 +00006106 if (auto MD = PD->getGetterMethodDecl())
6107 if (GetMethodDefinition(MD))
6108 methods.push_back(MD);
6109 if (auto MD = PD->getSetterMethodDecl())
6110 if (GetMethodDefinition(MD))
6111 methods.push_back(MD);
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00006112 }
6113 }
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006114 }
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006115
John McCall176f8922016-11-30 02:39:18 +00006116 values.add(emitMethodList(ID->getObjCRuntimeNameAsString(),
6117 (flags & NonFragileABI_Class_Meta)
6118 ? MethodListType::ClassMethods
6119 : MethodListType::InstanceMethods,
6120 methods));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006121
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006122 const ObjCInterfaceDecl *OID = ID->getClassInterface();
6123 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
John McCall176f8922016-11-30 02:39:18 +00006124 values.add(EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006125 + OID->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006126 OID->all_referenced_protocol_begin(),
6127 OID->all_referenced_protocol_end()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006128
John McCallef19dbb2012-10-17 04:53:23 +00006129 if (flags & NonFragileABI_Class_Meta) {
John McCall176f8922016-11-30 02:39:18 +00006130 values.addNullPointer(ObjCTypes.IvarListnfABIPtrTy);
6131 values.add(GetIvarLayoutName(nullptr, ObjCTypes));
6132 values.add(EmitPropertyList(
Manman Renad0e7912016-01-29 19:22:54 +00006133 "\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006134 ID, ID->getClassInterface(), ObjCTypes, true));
John McCallef19dbb2012-10-17 04:53:23 +00006135 } else {
John McCall176f8922016-11-30 02:39:18 +00006136 values.add(EmitIvarList(ID));
6137 values.add(BuildWeakIvarLayout(ID, beginInstance, endInstance, hasMRCWeak));
6138 values.add(EmitPropertyList(
Manman Renad0e7912016-01-29 19:22:54 +00006139 "\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006140 ID, ID->getClassInterface(), ObjCTypes, false));
John McCallef19dbb2012-10-17 04:53:23 +00006141 }
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006142
John McCall176f8922016-11-30 02:39:18 +00006143 llvm::SmallString<64> roLabel;
6144 llvm::raw_svector_ostream(roLabel)
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006145 << ((flags & NonFragileABI_Class_Meta) ? "\01l_OBJC_METACLASS_RO_$_"
6146 : "\01l_OBJC_CLASS_RO_$_")
6147 << ClassName;
6148
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006149 llvm::GlobalVariable *CLASS_RO_GV =
John McCall176f8922016-11-30 02:39:18 +00006150 values.finishAndCreateGlobal(roLabel, CGM.getPointerAlign(),
6151 /*constant*/ false,
6152 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006153 if (CGM.getTriple().isOSBinFormatMachO())
6154 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006155 return CLASS_RO_GV;
6156}
6157
John McCalldba63a72016-11-30 23:54:50 +00006158/// Build the metaclass object for a class.
6159///
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006160/// struct _class_t {
6161/// struct _class_t *isa;
6162/// struct _class_t * const superclass;
6163/// void *cache;
6164/// IMP *vtable;
6165/// struct class_ro_t *ro;
6166/// }
6167///
John McCalldba63a72016-11-30 23:54:50 +00006168llvm::GlobalVariable *
6169CGObjCNonFragileABIMac::BuildClassObject(const ObjCInterfaceDecl *CI,
6170 bool isMetaclass,
6171 llvm::Constant *IsAGV,
6172 llvm::Constant *SuperClassGV,
6173 llvm::Constant *ClassRoGV,
6174 bool HiddenVisibility) {
John McCall176f8922016-11-30 02:39:18 +00006175 ConstantInitBuilder builder(CGM);
6176 auto values = builder.beginStruct(ObjCTypes.ClassnfABITy);
6177 values.add(IsAGV);
6178 if (SuperClassGV) {
6179 values.add(SuperClassGV);
6180 } else {
6181 values.addNullPointer(ObjCTypes.ClassnfABIPtrTy);
6182 }
6183 values.add(ObjCEmptyCacheVar);
6184 values.add(ObjCEmptyVtableVar);
6185 values.add(ClassRoGV);
6186
John McCalldba63a72016-11-30 23:54:50 +00006187 llvm::GlobalVariable *GV =
6188 cast<llvm::GlobalVariable>(GetClassGlobal(CI, isMetaclass, ForDefinition));
John McCall176f8922016-11-30 02:39:18 +00006189 values.finishAndSetAsInitializer(GV);
6190
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006191 if (CGM.getTriple().isOSBinFormatMachO())
6192 GV->setSection("__DATA, __objc_data");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006193 GV->setAlignment(
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006194 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006195 if (!CGM.getTriple().isOSBinFormatCOFF())
6196 if (HiddenVisibility)
6197 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006198 return GV;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006199}
6200
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006201bool
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00006202CGObjCNonFragileABIMac::ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
Craig Topper8a13c412014-05-21 05:09:00 +00006203 return OD->getClassMethod(GetNullarySelector("load")) != nullptr;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006204}
6205
Daniel Dunbar961202372009-05-03 12:57:56 +00006206void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00006207 uint32_t &InstanceStart,
6208 uint32_t &InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006209 const ASTRecordLayout &RL =
Daniel Dunbar9252ee12009-05-04 21:26:30 +00006210 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006211
Daniel Dunbar9b042e02009-05-04 23:23:09 +00006212 // InstanceSize is really instance end.
Ken Dyckd5090c12011-02-11 02:20:09 +00006213 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar9b042e02009-05-04 23:23:09 +00006214
6215 // If there are no fields, the start is the same as the end.
6216 if (!RL.getFieldCount())
6217 InstanceStart = InstanceSize;
6218 else
Ken Dyckc5ca8762011-04-14 00:43:09 +00006219 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbar554fd792009-04-19 23:41:48 +00006220}
6221
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006222static llvm::GlobalValue::DLLStorageClassTypes getStorage(CodeGenModule &CGM,
6223 StringRef Name) {
6224 IdentifierInfo &II = CGM.getContext().Idents.get(Name);
6225 TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
6226 DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
6227
6228 const VarDecl *VD = nullptr;
6229 for (const auto &Result : DC->lookup(&II))
6230 if ((VD = dyn_cast<VarDecl>(Result)))
6231 break;
6232
6233 if (!VD)
6234 return llvm::GlobalValue::DLLImportStorageClass;
6235 if (VD->hasAttr<DLLExportAttr>())
6236 return llvm::GlobalValue::DLLExportStorageClass;
6237 if (VD->hasAttr<DLLImportAttr>())
6238 return llvm::GlobalValue::DLLImportStorageClass;
6239 return llvm::GlobalValue::DefaultStorageClass;
6240}
6241
Fariborz Jahanian71394042009-01-23 23:53:38 +00006242void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Fariborz Jahanian71394042009-01-23 23:53:38 +00006243 if (!ObjCEmptyCacheVar) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006244 ObjCEmptyCacheVar =
6245 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CacheTy, false,
6246 llvm::GlobalValue::ExternalLinkage, nullptr,
6247 "_objc_empty_cache");
6248 if (CGM.getTriple().isOSBinFormatCOFF())
6249 ObjCEmptyCacheVar->setDLLStorageClass(getStorage(CGM, "_objc_empty_cache"));
Craig Topper8a13c412014-05-21 05:09:00 +00006250
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00006251 // Only OS X with deployment version <10.9 use the empty vtable symbol
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006252 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00006253 if (Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 9))
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006254 ObjCEmptyVtableVar =
6255 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ImpnfABITy, false,
6256 llvm::GlobalValue::ExternalLinkage, nullptr,
6257 "_objc_empty_vtable");
John McCall176f8922016-11-30 02:39:18 +00006258 else
6259 ObjCEmptyVtableVar =
6260 llvm::ConstantPointerNull::get(ObjCTypes.ImpnfABITy->getPointerTo());
Fariborz Jahanian71394042009-01-23 23:53:38 +00006261 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006262
Daniel Dunbare3f5cfc2009-04-20 20:18:54 +00006263 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006264 uint32_t InstanceStart =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006265 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006266 uint32_t InstanceSize = InstanceStart;
John McCallef19dbb2012-10-17 04:53:23 +00006267 uint32_t flags = NonFragileABI_Class_Meta;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006268
John McCalldba63a72016-11-30 23:54:50 +00006269 llvm::Constant *SuperClassGV, *IsAGV;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006270
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006271 const auto *CI = ID->getClassInterface();
6272 assert(CI && "CGObjCNonFragileABIMac::GenerateClass - class is 0");
6273
John McCall0d54a172012-10-17 04:53:31 +00006274 // Build the flags for the metaclass.
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006275 bool classIsHidden = (CGM.getTriple().isOSBinFormatCOFF())
6276 ? !CI->hasAttr<DLLExportAttr>()
6277 : CI->getVisibility() == HiddenVisibility;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006278 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006279 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006280
6281 // FIXME: why is this flag set on the metaclass?
6282 // ObjC metaclasses have no fields and don't really get constructed.
6283 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006284 flags |= NonFragileABI_Class_HasCXXStructors;
John McCall0d54a172012-10-17 04:53:31 +00006285 if (!ID->hasNonZeroConstructors())
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006286 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
John McCall0d54a172012-10-17 04:53:31 +00006287 }
6288
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006289 if (!CI->getSuperClass()) {
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006290 // class is root
John McCallef19dbb2012-10-17 04:53:23 +00006291 flags |= NonFragileABI_Class_Root;
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006292
John McCalldba63a72016-11-30 23:54:50 +00006293 SuperClassGV = GetClassGlobal(CI, /*metaclass*/ false, NotForDefinition);
6294 IsAGV = GetClassGlobal(CI, /*metaclass*/ true, NotForDefinition);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006295 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006296 // Has a root. Current class is not a root.
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00006297 const ObjCInterfaceDecl *Root = ID->getClassInterface();
6298 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
6299 Root = Super;
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006300
6301 const auto *Super = CI->getSuperClass();
John McCalldba63a72016-11-30 23:54:50 +00006302 IsAGV = GetClassGlobal(Root, /*metaclass*/ true, NotForDefinition);
6303 SuperClassGV = GetClassGlobal(Super, /*metaclass*/ true, NotForDefinition);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006304 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006305
6306 llvm::GlobalVariable *CLASS_RO_GV =
6307 BuildClassRoTInitializer(flags, InstanceStart, InstanceSize, ID);
6308
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006309 llvm::GlobalVariable *MetaTClass =
John McCalldba63a72016-11-30 23:54:50 +00006310 BuildClassObject(CI, /*metaclass*/ true,
6311 IsAGV, SuperClassGV, CLASS_RO_GV, classIsHidden);
Rafael Espindolab7350042018-03-01 00:35:47 +00006312 CGM.setGVProperties(MetaTClass, CI);
Fariborz Jahanian67260552009-11-17 21:37:35 +00006313 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar15894b72009-04-07 05:48:37 +00006314
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006315 // Metadata for the class
John McCallef19dbb2012-10-17 04:53:23 +00006316 flags = 0;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006317 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006318 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006319
6320 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006321 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006322
John McCall0d54a172012-10-17 04:53:31 +00006323 // Set a flag to enable a runtime optimization when a class has
6324 // fields that require destruction but which don't require
6325 // anything except zero-initialization during construction. This
6326 // is most notably true of __strong and __weak types, but you can
6327 // also imagine there being C++ types with non-trivial default
6328 // constructors that merely set all fields to null.
6329 if (!ID->hasNonZeroConstructors())
6330 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6331 }
6332
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006333 if (hasObjCExceptionAttribute(CGM.getContext(), CI))
John McCallef19dbb2012-10-17 04:53:23 +00006334 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006335
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006336 if (!CI->getSuperClass()) {
John McCallef19dbb2012-10-17 04:53:23 +00006337 flags |= NonFragileABI_Class_Root;
Craig Topper8a13c412014-05-21 05:09:00 +00006338 SuperClassGV = nullptr;
Chris Lattnerb433b272009-04-19 06:02:28 +00006339 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006340 // Has a root. Current class is not a root.
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006341 const auto *Super = CI->getSuperClass();
John McCalldba63a72016-11-30 23:54:50 +00006342 SuperClassGV = GetClassGlobal(Super, /*metaclass*/ false, NotForDefinition);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006343 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006344
Daniel Dunbar961202372009-05-03 12:57:56 +00006345 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006346 CLASS_RO_GV =
6347 BuildClassRoTInitializer(flags, InstanceStart, InstanceSize, ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006348
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006349 llvm::GlobalVariable *ClassMD =
John McCalldba63a72016-11-30 23:54:50 +00006350 BuildClassObject(CI, /*metaclass*/ false,
6351 MetaTClass, SuperClassGV, CLASS_RO_GV, classIsHidden);
Rafael Espindolab7350042018-03-01 00:35:47 +00006352 CGM.setGVProperties(ClassMD, CI);
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006353 DefinedClasses.push_back(ClassMD);
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006354 ImplementedClasses.push_back(CI);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006355
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006356 // Determine if this class is also "non-lazy".
6357 if (ImplementationIsNonLazy(ID))
6358 DefinedNonLazyClasses.push_back(ClassMD);
6359
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006360 // Force the definition of the EHType if necessary.
John McCallef19dbb2012-10-17 04:53:23 +00006361 if (flags & NonFragileABI_Class_Exception)
John McCalldba63a72016-11-30 23:54:50 +00006362 (void) GetInterfaceEHType(CI, ForDefinition);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006363 // Make sure method definition entries are all clear for next implementation.
6364 MethodDefinitions.clear();
Fariborz Jahanian71394042009-01-23 23:53:38 +00006365}
6366
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006367/// GenerateProtocolRef - This routine is called to generate code for
6368/// a protocol reference expression; as in:
6369/// @code
6370/// @protocol(Proto1);
6371/// @endcode
6372/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
6373/// which will hold address of the protocol meta-data.
6374///
John McCall882987f2013-02-28 19:01:20 +00006375llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006376 const ObjCProtocolDecl *PD) {
6377
Fariborz Jahanian464423d2009-04-10 18:47:34 +00006378 // This routine is called for @protocol only. So, we must build definition
6379 // of protocol's meta-data (not a reference to it!)
6380 //
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006381 llvm::Constant *Init =
6382 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00006383 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006384
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006385 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006386 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006387
John McCall7f416cc2015-09-08 08:05:57 +00006388 CharUnits Align = CGF.getPointerAlign();
6389
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006390 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
6391 if (PTGV)
John McCall7f416cc2015-09-08 08:05:57 +00006392 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Saleem Abdulrasool9f83f3b2017-06-29 00:54:44 +00006393 PTGV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
6394 llvm::GlobalValue::WeakAnyLinkage, Init,
6395 ProtocolName);
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00006396 PTGV->setSection(GetSectionName("__objc_protorefs",
6397 "coalesced,no_dead_strip"));
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006398 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall7f416cc2015-09-08 08:05:57 +00006399 PTGV->setAlignment(Align.getQuantity());
Saleem Abdulrasool9f83f3b2017-06-29 00:54:44 +00006400 if (!CGM.getTriple().isOSBinFormatMachO())
6401 PTGV->setComdat(CGM.getModule().getOrInsertComdat(ProtocolName));
Saleem Abdulrasoolbe2b5cb2018-01-23 19:35:51 +00006402 CGM.addUsedGlobal(PTGV);
John McCall7f416cc2015-09-08 08:05:57 +00006403 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006404}
6405
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006406/// GenerateCategory - Build metadata for a category implementation.
6407/// struct _category_t {
6408/// const char * const name;
6409/// struct _class_t *const cls;
6410/// const struct _method_list_t * const instance_methods;
6411/// const struct _method_list_t * const class_methods;
6412/// const struct _protocol_list_t * const protocols;
6413/// const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00006414/// const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00006415/// const uint32_t size;
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006416/// }
6417///
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006418void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006419 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006420 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006421
6422 llvm::SmallString<64> ExtCatName(Prefix);
6423 ExtCatName += Interface->getObjCRuntimeNameAsString();
6424 ExtCatName += "_$_";
6425 ExtCatName += OCD->getNameAsString();
6426
John McCall176f8922016-11-30 02:39:18 +00006427 ConstantInitBuilder builder(CGM);
6428 auto values = builder.beginStruct(ObjCTypes.CategorynfABITy);
6429 values.add(GetClassName(OCD->getIdentifier()->getName()));
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006430 // meta-class entry symbol
John McCalldba63a72016-11-30 23:54:50 +00006431 values.add(GetClassGlobal(Interface, /*metaclass*/ false, NotForDefinition));
John McCall176f8922016-11-30 02:39:18 +00006432 std::string listName =
Saleem Abdulrasool209150a2016-10-24 21:25:57 +00006433 (Interface->getObjCRuntimeNameAsString() + "_$_" + OCD->getName()).str();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006434
John McCall176f8922016-11-30 02:39:18 +00006435 SmallVector<const ObjCMethodDecl *, 16> instanceMethods;
6436 SmallVector<const ObjCMethodDecl *, 8> classMethods;
6437 for (const auto *MD : OCD->methods()) {
6438 if (MD->isInstanceMethod()) {
6439 instanceMethods.push_back(MD);
6440 } else {
6441 classMethods.push_back(MD);
6442 }
6443 }
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006444
John McCall176f8922016-11-30 02:39:18 +00006445 values.add(emitMethodList(listName, MethodListType::CategoryInstanceMethods,
6446 instanceMethods));
6447 values.add(emitMethodList(listName, MethodListType::CategoryClassMethods,
6448 classMethods));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006449
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006450 const ObjCCategoryDecl *Category =
Fariborz Jahanian066347e2009-01-28 22:18:42 +00006451 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006452 if (Category) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006453 SmallString<256> ExtName;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006454 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006455 << OCD->getName();
John McCall176f8922016-11-30 02:39:18 +00006456 values.add(EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006457 + Interface->getObjCRuntimeNameAsString() + "_$_"
6458 + Category->getName(),
John McCall176f8922016-11-30 02:39:18 +00006459 Category->protocol_begin(),
6460 Category->protocol_end()));
6461 values.add(EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
6462 OCD, Category, ObjCTypes, false));
6463 values.add(EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
6464 OCD, Category, ObjCTypes, true));
Mike Stump658fe022009-07-30 22:28:39 +00006465 } else {
John McCall176f8922016-11-30 02:39:18 +00006466 values.addNullPointer(ObjCTypes.ProtocolListnfABIPtrTy);
6467 values.addNullPointer(ObjCTypes.PropertyListPtrTy);
6468 values.addNullPointer(ObjCTypes.PropertyListPtrTy);
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006469 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006470
Manman Ren42ff3902016-02-24 17:49:50 +00006471 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategorynfABITy);
John McCall176f8922016-11-30 02:39:18 +00006472 values.addInt(ObjCTypes.IntTy, Size);
Manman Ren42ff3902016-02-24 17:49:50 +00006473
John McCall176f8922016-11-30 02:39:18 +00006474 llvm::GlobalVariable *GCATV =
6475 values.finishAndCreateGlobal(ExtCatName.str(), CGM.getPointerAlign(),
6476 /*constant*/ false,
6477 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006478 if (CGM.getTriple().isOSBinFormatMachO())
6479 GCATV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006480 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006481 DefinedCategories.push_back(GCATV);
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006482
6483 // Determine if this category is also "non-lazy".
6484 if (ImplementationIsNonLazy(OCD))
6485 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006486 // method definition entries must be clear for next implementation.
6487 MethodDefinitions.clear();
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006488}
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006489
John McCall176f8922016-11-30 02:39:18 +00006490/// emitMethodConstant - Return a struct objc_method constant. If
6491/// forProtocol is true, the implementation will be null; otherwise,
6492/// the method must have a definition registered with the runtime.
6493///
6494/// struct _objc_method {
6495/// SEL _cmd;
6496/// char *method_type;
6497/// char *_imp;
6498/// }
6499void CGObjCNonFragileABIMac::emitMethodConstant(ConstantArrayBuilder &builder,
6500 const ObjCMethodDecl *MD,
6501 bool forProtocol) {
6502 auto method = builder.beginStruct(ObjCTypes.MethodTy);
6503 method.addBitCast(GetMethodVarName(MD->getSelector()),
6504 ObjCTypes.SelectorPtrTy);
6505 method.add(GetMethodVarType(MD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006506
John McCall176f8922016-11-30 02:39:18 +00006507 if (forProtocol) {
6508 // Protocol methods have no implementation. So, this entry is always NULL.
6509 method.addNullPointer(ObjCTypes.Int8PtrTy);
6510 } else {
6511 llvm::Function *fn = GetMethodDefinition(MD);
6512 assert(fn && "no definition for method?");
6513 method.addBitCast(fn, ObjCTypes.Int8PtrTy);
6514 }
6515
6516 method.finishAndAddTo(builder);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006517}
6518
John McCall176f8922016-11-30 02:39:18 +00006519/// Build meta-data for method declarations.
6520///
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006521/// struct _method_list_t {
6522/// uint32_t entsize; // sizeof(struct _objc_method)
6523/// uint32_t method_count;
6524/// struct _objc_method method_list[method_count];
6525/// }
6526///
Zachary Turner41a9ee92017-10-11 23:54:34 +00006527llvm::Constant *
6528CGObjCNonFragileABIMac::emitMethodList(Twine name, MethodListType kind,
6529 ArrayRef<const ObjCMethodDecl *> methods) {
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006530 // Return null for empty list.
John McCall176f8922016-11-30 02:39:18 +00006531 if (methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006532 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006533
John McCall176f8922016-11-30 02:39:18 +00006534 StringRef prefix;
6535 bool forProtocol;
6536 switch (kind) {
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006537 case MethodListType::CategoryInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006538 prefix = "\01l_OBJC_$_CATEGORY_INSTANCE_METHODS_";
6539 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006540 break;
6541 case MethodListType::CategoryClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006542 prefix = "\01l_OBJC_$_CATEGORY_CLASS_METHODS_";
6543 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006544 break;
6545 case MethodListType::InstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006546 prefix = "\01l_OBJC_$_INSTANCE_METHODS_";
6547 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006548 break;
6549 case MethodListType::ClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006550 prefix = "\01l_OBJC_$_CLASS_METHODS_";
6551 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006552 break;
6553
6554 case MethodListType::ProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006555 prefix = "\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_";
6556 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006557 break;
6558 case MethodListType::ProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006559 prefix = "\01l_OBJC_$_PROTOCOL_CLASS_METHODS_";
6560 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006561 break;
6562 case MethodListType::OptionalProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006563 prefix = "\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_";
6564 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006565 break;
6566 case MethodListType::OptionalProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006567 prefix = "\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_";
6568 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006569 break;
6570 }
6571
John McCall176f8922016-11-30 02:39:18 +00006572 ConstantInitBuilder builder(CGM);
6573 auto values = builder.beginStruct();
6574
6575 // sizeof(struct _objc_method)
6576 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
6577 values.addInt(ObjCTypes.IntTy, Size);
6578 // method_count
6579 values.addInt(ObjCTypes.IntTy, methods.size());
6580 auto methodArray = values.beginArray(ObjCTypes.MethodTy);
6581 for (auto MD : methods) {
6582 emitMethodConstant(methodArray, MD, forProtocol);
6583 }
6584 methodArray.finishAndAddTo(values);
6585
Zachary Turner41a9ee92017-10-11 23:54:34 +00006586 auto *GV = values.finishAndCreateGlobal(prefix + name, CGM.getPointerAlign(),
John McCall176f8922016-11-30 02:39:18 +00006587 /*constant*/ false,
6588 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006589 if (CGM.getTriple().isOSBinFormatMachO())
6590 GV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006591 CGM.addCompilerUsedGlobal(GV);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006592 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006593}
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006594
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006595/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6596/// the given ivar.
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006597llvm::GlobalVariable *
6598CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6599 const ObjCIvarDecl *Ivar) {
6600 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006601 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6602 Name += Container->getObjCRuntimeNameAsString();
6603 Name += ".";
6604 Name += Ivar->getName();
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006605 llvm::GlobalVariable *IvarOffsetGV = CGM.getModule().getGlobalVariable(Name);
6606 if (!IvarOffsetGV) {
6607 IvarOffsetGV =
6608 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.IvarOffsetVarTy,
6609 false, llvm::GlobalValue::ExternalLinkage,
6610 nullptr, Name.str());
6611 if (CGM.getTriple().isOSBinFormatCOFF()) {
6612 bool IsPrivateOrPackage =
6613 Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6614 Ivar->getAccessControl() == ObjCIvarDecl::Package;
6615
Saleem Abdulrasoolad75c7d2017-10-25 03:58:15 +00006616 const ObjCInterfaceDecl *ContainingID = Ivar->getContainingInterface();
6617
6618 if (ContainingID->hasAttr<DLLImportAttr>())
6619 IvarOffsetGV
6620 ->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
6621 else if (ContainingID->hasAttr<DLLExportAttr>() && !IsPrivateOrPackage)
6622 IvarOffsetGV
6623 ->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006624 }
6625 }
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006626 return IvarOffsetGV;
6627}
6628
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006629llvm::Constant *
6630CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6631 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00006632 unsigned long int Offset) {
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006633 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Tim Northover238b5082014-03-29 13:42:40 +00006634 IvarOffsetGV->setInitializer(
6635 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006636 IvarOffsetGV->setAlignment(
Tim Northover238b5082014-03-29 13:42:40 +00006637 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006638
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006639 if (!CGM.getTriple().isOSBinFormatCOFF()) {
6640 // FIXME: This matches gcc, but shouldn't the visibility be set on the use
6641 // as well (i.e., in ObjCIvarOffsetVariable).
6642 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6643 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
6644 ID->getVisibility() == HiddenVisibility)
6645 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
6646 else
6647 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
6648 }
6649
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006650 if (CGM.getTriple().isOSBinFormatMachO())
6651 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006652 return IvarOffsetGV;
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006653}
6654
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006655/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006656/// implementation. The return value has type
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006657/// IvarListnfABIPtrTy.
6658/// struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00006659/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006660/// char *name;
6661/// char *type;
6662/// uint32_t alignment;
6663/// uint32_t size;
6664/// }
6665/// struct _ivar_list_t {
6666/// uint32 entsize; // sizeof(struct _ivar_t)
6667/// uint32 count;
6668/// struct _iver_t list[count];
6669/// }
6670///
Daniel Dunbarf5c18462009-04-20 06:54:31 +00006671
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006672llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006673 const ObjCImplementationDecl *ID) {
6674
John McCall176f8922016-11-30 02:39:18 +00006675 ConstantInitBuilder builder(CGM);
6676 auto ivarList = builder.beginStruct();
6677 ivarList.addInt(ObjCTypes.IntTy,
6678 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy));
6679 auto ivarCountSlot = ivarList.addPlaceholder();
6680 auto ivars = ivarList.beginArray(ObjCTypes.IvarnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006681
Jordy Rosea91768e2011-07-22 02:08:32 +00006682 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006683 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006684
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006685 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006686
Jordy Rosea91768e2011-07-22 02:08:32 +00006687 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00006688 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00006689 // Ignore unnamed bit-fields.
6690 if (!IVD->getDeclName())
6691 continue;
John McCall176f8922016-11-30 02:39:18 +00006692
6693 auto ivar = ivars.beginStruct(ObjCTypes.IvarnfABITy);
6694 ivar.add(EmitIvarOffsetVar(ID->getClassInterface(), IVD,
6695 ComputeIvarBaseOffset(CGM, ID, IVD)));
6696 ivar.add(GetMethodVarName(IVD->getIdentifier()));
6697 ivar.add(GetMethodVarType(IVD));
Chris Lattner2192fe52011-07-18 04:24:23 +00006698 llvm::Type *FieldTy =
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006699 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmowdd31ca12012-10-08 16:25:52 +00006700 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006701 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006702 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006703 Align = llvm::Log2_32(Align);
John McCall176f8922016-11-30 02:39:18 +00006704 ivar.addInt(ObjCTypes.IntTy, Align);
Daniel Dunbarae032262009-04-20 00:33:43 +00006705 // NOTE. Size of a bitfield does not match gcc's, because of the
6706 // way bitfields are treated special in each. But I am told that
6707 // 'size' for bitfield ivars is ignored by the runtime so it does
6708 // not matter. If it matters, there is enough info to get the
6709 // bitfield right!
John McCall176f8922016-11-30 02:39:18 +00006710 ivar.addInt(ObjCTypes.IntTy, Size);
6711 ivar.finishAndAddTo(ivars);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006712 }
6713 // Return null for empty list.
John McCall176f8922016-11-30 02:39:18 +00006714 if (ivars.empty()) {
6715 ivars.abandon();
6716 ivarList.abandon();
Owen Anderson0b75f232009-07-31 20:28:54 +00006717 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
John McCall176f8922016-11-30 02:39:18 +00006718 }
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006719
John McCall176f8922016-11-30 02:39:18 +00006720 auto ivarCount = ivars.size();
6721 ivars.finishAndAddTo(ivarList);
6722 ivarList.fillPlaceholderWithInt(ivarCountSlot, ObjCTypes.IntTy, ivarCount);
6723
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006724 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6725 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00006726 ivarList.finishAndCreateGlobal(Prefix + OID->getObjCRuntimeNameAsString(),
6727 CGM.getPointerAlign(), /*constant*/ false,
6728 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006729 if (CGM.getTriple().isOSBinFormatMachO())
6730 GV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006731 CGM.addCompilerUsedGlobal(GV);
Owen Andersonade90fd2009-07-29 18:54:39 +00006732 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006733}
6734
6735llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006736 const ObjCProtocolDecl *PD) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006737 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006738
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006739 if (!Entry) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006740 // We use the initializer as a marker of whether this is a forward
6741 // reference or not. At module finalization we add the empty
6742 // contents for protocols which were referenced but never defined.
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006743 llvm::SmallString<64> Protocol;
6744 llvm::raw_svector_ostream(Protocol) << "\01l_OBJC_PROTOCOL_$_"
6745 << PD->getObjCRuntimeNameAsString();
6746
6747 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
6748 false, llvm::GlobalValue::ExternalLinkage,
6749 nullptr, Protocol);
6750 if (!CGM.getTriple().isOSBinFormatMachO())
6751 Entry->setComdat(CGM.getModule().getOrInsertComdat(Protocol));
6752 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006753
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006754 return Entry;
6755}
6756
6757/// GetOrEmitProtocol - Generate the protocol meta-data:
6758/// @code
6759/// struct _protocol_t {
6760/// id isa; // NULL
6761/// const char * const protocol_name;
6762/// const struct _protocol_list_t * protocol_list; // super protocols
6763/// const struct method_list_t * const instance_methods;
6764/// const struct method_list_t * const class_methods;
6765/// const struct method_list_t *optionalInstanceMethods;
6766/// const struct method_list_t *optionalClassMethods;
6767/// const struct _prop_list_t * properties;
6768/// const uint32_t size; // sizeof(struct _protocol_t)
6769/// const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006770/// const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006771/// const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00006772/// const struct _prop_list_t * class_properties;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006773/// }
6774/// @endcode
6775///
6776
6777llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006778 const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00006779 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006780
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006781 // Early exit if a defining object has already been generated.
6782 if (Entry && Entry->hasInitializer())
6783 return Entry;
6784
Douglas Gregora715bff2012-01-01 19:51:50 +00006785 // Use the protocol definition, if there is one.
6786 if (const ObjCProtocolDecl *Def = PD->getDefinition())
6787 PD = Def;
6788
John McCall176f8922016-11-30 02:39:18 +00006789 auto methodLists = ProtocolMethodLists::get(PD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006790
John McCall176f8922016-11-30 02:39:18 +00006791 ConstantInitBuilder builder(CGM);
6792 auto values = builder.beginStruct(ObjCTypes.ProtocolnfABITy);
Douglas Gregora9d84932011-05-27 01:19:52 +00006793
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006794 // isa is NULL
John McCall176f8922016-11-30 02:39:18 +00006795 values.addNullPointer(ObjCTypes.ObjectPtrTy);
6796 values.add(GetClassName(PD->getObjCRuntimeNameAsString()));
6797 values.add(EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_"
6798 + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006799 PD->protocol_begin(),
John McCall176f8922016-11-30 02:39:18 +00006800 PD->protocol_end()));
6801 values.add(methodLists.emitMethodList(this, PD,
6802 ProtocolMethodLists::RequiredInstanceMethods));
6803 values.add(methodLists.emitMethodList(this, PD,
6804 ProtocolMethodLists::RequiredClassMethods));
6805 values.add(methodLists.emitMethodList(this, PD,
6806 ProtocolMethodLists::OptionalInstanceMethods));
6807 values.add(methodLists.emitMethodList(this, PD,
6808 ProtocolMethodLists::OptionalClassMethods));
6809 values.add(EmitPropertyList(
6810 "\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6811 nullptr, PD, ObjCTypes, false));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006812 uint32_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006813 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
John McCall176f8922016-11-30 02:39:18 +00006814 values.addInt(ObjCTypes.IntTy, Size);
6815 values.addInt(ObjCTypes.IntTy, 0);
6816 values.add(EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006817 + PD->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006818 methodLists.emitExtendedTypesArray(this),
6819 ObjCTypes));
6820
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006821 // const char *demangledName;
John McCall176f8922016-11-30 02:39:18 +00006822 values.addNullPointer(ObjCTypes.Int8PtrTy);
Manman Rence7bff52016-01-29 23:46:55 +00006823
John McCall176f8922016-11-30 02:39:18 +00006824 values.add(EmitPropertyList(
Manman Rence7bff52016-01-29 23:46:55 +00006825 "\01l_OBJC_$_CLASS_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006826 nullptr, PD, ObjCTypes, true));
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006827
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006828 if (Entry) {
Rafael Espindola24615092014-09-12 20:14:20 +00006829 // Already created, fix the linkage and update the initializer.
6830 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
John McCall176f8922016-11-30 02:39:18 +00006831 values.finishAndSetAsInitializer(Entry);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006832 } else {
John McCall176f8922016-11-30 02:39:18 +00006833 llvm::SmallString<64> symbolName;
6834 llvm::raw_svector_ostream(symbolName)
6835 << "\01l_OBJC_PROTOCOL_$_" << PD->getObjCRuntimeNameAsString();
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006836
John McCall176f8922016-11-30 02:39:18 +00006837 Entry = values.finishAndCreateGlobal(symbolName, CGM.getPointerAlign(),
6838 /*constant*/ false,
6839 llvm::GlobalValue::WeakAnyLinkage);
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006840 if (!CGM.getTriple().isOSBinFormatMachO())
John McCall176f8922016-11-30 02:39:18 +00006841 Entry->setComdat(CGM.getModule().getOrInsertComdat(symbolName));
John McCallf9582a72012-03-30 21:29:05 +00006842
6843 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006844 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006845 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasoolbe2b5cb2018-01-23 19:35:51 +00006846 CGM.addUsedGlobal(Entry);
Chris Lattnerf56501c2009-07-17 23:57:13 +00006847
Fariborz Jahanian61cd4b52009-01-29 20:10:59 +00006848 // Use this protocol meta-data to build protocol list table in section
6849 // __DATA, __objc_protolist
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006850 llvm::SmallString<64> ProtocolRef;
6851 llvm::raw_svector_ostream(ProtocolRef) << "\01l_OBJC_LABEL_PROTOCOL_$_"
6852 << PD->getObjCRuntimeNameAsString();
6853
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006854 llvm::GlobalVariable *PTGV =
6855 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006856 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006857 ProtocolRef);
6858 if (!CGM.getTriple().isOSBinFormatMachO())
6859 PTGV->setComdat(CGM.getModule().getOrInsertComdat(ProtocolRef));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006860 PTGV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006861 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00006862 PTGV->setSection(GetSectionName("__objc_protolist",
6863 "coalesced,no_dead_strip"));
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006864 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasoolbe2b5cb2018-01-23 19:35:51 +00006865 CGM.addUsedGlobal(PTGV);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006866 return Entry;
6867}
6868
6869/// EmitProtocolList - Generate protocol list meta-data:
6870/// @code
6871/// struct _protocol_list_t {
6872/// long protocol_count; // Note, this is 32/64 bit
6873/// struct _protocol_t[protocol_count];
6874/// }
6875/// @endcode
6876///
Zachary Turner41a9ee92017-10-11 23:54:34 +00006877llvm::Constant *
6878CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
6879 ObjCProtocolDecl::protocol_iterator begin,
6880 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006881 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006882
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006883 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006884 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00006885 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006886
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006887 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006888 SmallString<256> TmpName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006889 Name.toVector(TmpName);
6890 llvm::GlobalVariable *GV =
6891 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006892 if (GV)
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006893 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006894
John McCall176f8922016-11-30 02:39:18 +00006895 ConstantInitBuilder builder(CGM);
6896 auto values = builder.beginStruct();
6897 auto countSlot = values.addPlaceholder();
6898
6899 // A null-terminated array of protocols.
6900 auto array = values.beginArray(ObjCTypes.ProtocolnfABIPtrTy);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006901 for (; begin != end; ++begin)
John McCall176f8922016-11-30 02:39:18 +00006902 array.add(GetProtocolRef(*begin)); // Implemented???
6903 auto count = array.size();
6904 array.addNullPointer(ObjCTypes.ProtocolnfABIPtrTy);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006905
John McCall176f8922016-11-30 02:39:18 +00006906 array.finishAndAddTo(values);
6907 values.fillPlaceholderWithInt(countSlot, ObjCTypes.LongTy, count);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006908
John McCall176f8922016-11-30 02:39:18 +00006909 GV = values.finishAndCreateGlobal(Name, CGM.getPointerAlign(),
6910 /*constant*/ false,
6911 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006912 if (CGM.getTriple().isOSBinFormatMachO())
6913 GV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006914 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006915 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006916 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006917}
6918
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006919/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6920/// This code gen. amounts to generating code for:
6921/// @code
6922/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6923/// @encode
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006924///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00006925LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall96fa4842010-05-17 21:00:27 +00006926 CodeGen::CodeGenFunction &CGF,
6927 QualType ObjectTy,
6928 llvm::Value *BaseValue,
6929 const ObjCIvarDecl *Ivar,
6930 unsigned CVRQualifiers) {
6931 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006932 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00006933 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006934 Offset);
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006935}
6936
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006937llvm::Value *CGObjCNonFragileABIMac::EmitIvarOffset(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006938 CodeGen::CodeGenFunction &CGF,
6939 const ObjCInterfaceDecl *Interface,
6940 const ObjCIvarDecl *Ivar) {
Tim Northover238b5082014-03-29 13:42:40 +00006941 llvm::Value *IvarOffsetValue = ObjCIvarOffsetVariable(Interface, Ivar);
John McCall7f416cc2015-09-08 08:05:57 +00006942 IvarOffsetValue = CGF.Builder.CreateAlignedLoad(IvarOffsetValue,
6943 CGF.getSizeAlign(), "ivar");
Tim Northover238b5082014-03-29 13:42:40 +00006944 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
6945 cast<llvm::LoadInst>(IvarOffsetValue)
6946 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
Craig Topper5fc8fc22014-08-27 06:28:36 +00006947 llvm::MDNode::get(VMContext, None));
Tim Northover238b5082014-03-29 13:42:40 +00006948
6949 // This could be 32bit int or 64bit integer depending on the architecture.
6950 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00006951 // as this is what caller always expects.
Tim Northover238b5082014-03-29 13:42:40 +00006952 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
6953 IvarOffsetValue = CGF.Builder.CreateIntCast(
6954 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
6955 return IvarOffsetValue;
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006956}
6957
John McCall234eac82011-05-13 23:16:18 +00006958static void appendSelectorForMessageRefTable(std::string &buffer,
6959 Selector selector) {
6960 if (selector.isUnarySelector()) {
6961 buffer += selector.getNameForSlot(0);
6962 return;
6963 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006964
John McCall234eac82011-05-13 23:16:18 +00006965 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
6966 buffer += selector.getNameForSlot(i);
6967 buffer += '_';
6968 }
6969}
6970
Eric Christopherd160c502016-01-29 01:35:53 +00006971/// Emit a "vtable" message send. We emit a weak hidden-visibility
John McCall9e8bb002011-05-14 03:10:52 +00006972/// struct, initially containing the selector pointer and a pointer to
6973/// a "fixup" variant of the appropriate objc_msgSend. To call, we
6974/// load and call the function pointer, passing the address of the
6975/// struct as the second parameter. The runtime determines whether
6976/// the selector is currently emitted using vtable dispatch; if so, it
6977/// substitutes a stub function which simply tail-calls through the
6978/// appropriate vtable slot, and if not, it substitues a stub function
6979/// which tail-calls objc_msgSend. Both stubs adjust the selector
6980/// argument to correctly point to the selector.
6981RValue
6982CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
6983 ReturnValueSlot returnSlot,
6984 QualType resultType,
6985 Selector selector,
6986 llvm::Value *arg0,
6987 QualType arg0Type,
6988 bool isSuper,
6989 const CallArgList &formalArgs,
6990 const ObjCMethodDecl *method) {
John McCall234eac82011-05-13 23:16:18 +00006991 // Compute the actual arguments.
6992 CallArgList args;
6993
John McCall9e8bb002011-05-14 03:10:52 +00006994 // First argument: the receiver / super-call structure.
John McCall234eac82011-05-13 23:16:18 +00006995 if (!isSuper)
John McCall9e8bb002011-05-14 03:10:52 +00006996 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
6997 args.add(RValue::get(arg0), arg0Type);
John McCall234eac82011-05-13 23:16:18 +00006998
John McCall9e8bb002011-05-14 03:10:52 +00006999 // Second argument: a pointer to the message ref structure. Leave
7000 // the actual argument value blank for now.
Craig Topper8a13c412014-05-21 05:09:00 +00007001 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCall234eac82011-05-13 23:16:18 +00007002
7003 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
7004
John McCalla729c622012-02-17 03:33:10 +00007005 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCall234eac82011-05-13 23:16:18 +00007006
John McCall5880fb82011-05-14 21:12:11 +00007007 NullReturnState nullReturn;
7008
John McCall9e8bb002011-05-14 03:10:52 +00007009 // Find the function to call and the mangled name for the message
7010 // ref structure. Using a different mangled name wouldn't actually
7011 // be a problem; it would just be a waste.
7012 //
7013 // The runtime currently never uses vtable dispatch for anything
7014 // except normal, non-super message-sends.
7015 // FIXME: don't use this for that.
Craig Topper8a13c412014-05-21 05:09:00 +00007016 llvm::Constant *fn = nullptr;
John McCall234eac82011-05-13 23:16:18 +00007017 std::string messageRefName("\01l_");
Tim Northovere77cc392014-03-29 13:28:05 +00007018 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall234eac82011-05-13 23:16:18 +00007019 if (isSuper) {
7020 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
7021 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007022 } else {
John McCall5880fb82011-05-14 21:12:11 +00007023 nullReturn.init(CGF, arg0);
John McCall234eac82011-05-13 23:16:18 +00007024 fn = ObjCTypes.getMessageSendStretFixupFn();
7025 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007026 }
John McCall234eac82011-05-13 23:16:18 +00007027 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
7028 fn = ObjCTypes.getMessageSendFpretFixupFn();
7029 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stump658fe022009-07-30 22:28:39 +00007030 } else {
John McCall234eac82011-05-13 23:16:18 +00007031 if (isSuper) {
7032 fn = ObjCTypes.getMessageSendSuper2FixupFn();
7033 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007034 } else {
John McCall234eac82011-05-13 23:16:18 +00007035 fn = ObjCTypes.getMessageSendFixupFn();
7036 messageRefName += "objc_msgSend_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007037 }
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00007038 }
John McCall234eac82011-05-13 23:16:18 +00007039 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
7040 messageRefName += '_';
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007041
John McCall234eac82011-05-13 23:16:18 +00007042 // Append the selector name, except use underscores anywhere we
7043 // would have used colons.
7044 appendSelectorForMessageRefTable(messageRefName, selector);
7045
7046 llvm::GlobalVariable *messageRef
7047 = CGM.getModule().getGlobalVariable(messageRefName);
7048 if (!messageRef) {
John McCall9e8bb002011-05-14 03:10:52 +00007049 // Build the message ref structure.
John McCall176f8922016-11-30 02:39:18 +00007050 ConstantInitBuilder builder(CGM);
7051 auto values = builder.beginStruct();
7052 values.add(fn);
7053 values.add(GetMethodVarName(selector));
7054 messageRef = values.finishAndCreateGlobal(messageRefName,
7055 CharUnits::fromQuantity(16),
7056 /*constant*/ false,
7057 llvm::GlobalValue::WeakAnyLinkage);
Rafael Espindola70efc5b2014-03-06 18:54:12 +00007058 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007059 messageRef->setSection(GetSectionName("__objc_msgrefs", "coalesced"));
John McCall234eac82011-05-13 23:16:18 +00007060 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00007061
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00007062 bool requiresnullCheck = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00007063 if (CGM.getLangOpts().ObjCAutoRefCount && method)
David Majnemer59f77922016-06-24 04:05:48 +00007064 for (const auto *ParamDecl : method->parameters()) {
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00007065 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
7066 if (!nullReturn.NullBB)
7067 nullReturn.init(CGF, arg0);
7068 requiresnullCheck = true;
7069 break;
7070 }
7071 }
7072
John McCall7f416cc2015-09-08 08:05:57 +00007073 Address mref =
7074 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
7075 CGF.getPointerAlign());
John McCall234eac82011-05-13 23:16:18 +00007076
John McCall9e8bb002011-05-14 03:10:52 +00007077 // Update the message ref argument.
Yaxun Liu5b330e82018-03-15 15:25:19 +00007078 args[1].setRValue(RValue::get(mref.getPointer()));
John McCall234eac82011-05-13 23:16:18 +00007079
7080 // Load the function to call from the message ref table.
John McCall7f416cc2015-09-08 08:05:57 +00007081 Address calleeAddr =
7082 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
John McCallb92ab1a2016-10-26 23:46:34 +00007083 llvm::Value *calleePtr = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCall234eac82011-05-13 23:16:18 +00007084
John McCallb92ab1a2016-10-26 23:46:34 +00007085 calleePtr = CGF.Builder.CreateBitCast(calleePtr, MSI.MessengerType);
7086 CGCallee callee(CGCalleeInfo(), calleePtr);
John McCall234eac82011-05-13 23:16:18 +00007087
John McCalla729c622012-02-17 03:33:10 +00007088 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Kuba Mracekbce5cea2017-06-30 16:28:15 +00007089 return nullReturn.complete(CGF, returnSlot, result, resultType, formalArgs,
Craig Topper8a13c412014-05-21 05:09:00 +00007090 requiresnullCheck ? method : nullptr);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00007091}
7092
7093/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007094CodeGen::RValue
7095CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00007096 ReturnValueSlot Return,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007097 QualType ResultType,
7098 Selector Sel,
7099 llvm::Value *Receiver,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007100 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00007101 const ObjCInterfaceDecl *Class,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007102 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00007103 return isVTableDispatchedSelector(Sel)
7104 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007105 Receiver, CGF.getContext().getObjCIdType(),
John McCall9e8bb002011-05-14 03:10:52 +00007106 false, CallArgs, Method)
7107 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00007108 EmitSelector(CGF, Sel),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007109 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00007110 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00007111}
7112
John McCalldba63a72016-11-30 23:54:50 +00007113llvm::Constant *
7114CGObjCNonFragileABIMac::GetClassGlobal(const ObjCInterfaceDecl *ID,
7115 bool metaclass,
7116 ForDefinition_t isForDefinition) {
7117 auto prefix =
7118 (metaclass ? getMetaclassSymbolPrefix() : getClassSymbolPrefix());
7119 return GetClassGlobal((prefix + ID->getObjCRuntimeNameAsString()).str(),
7120 isForDefinition,
7121 ID->isWeakImported(),
7122 !isForDefinition
7123 && CGM.getTriple().isOSBinFormatCOFF()
7124 && ID->hasAttr<DLLImportAttr>());
7125}
7126
7127llvm::Constant *
7128CGObjCNonFragileABIMac::GetClassGlobal(StringRef Name,
7129 ForDefinition_t IsForDefinition,
7130 bool Weak, bool DLLImport) {
Rafael Espindola554256c2014-02-26 22:25:45 +00007131 llvm::GlobalValue::LinkageTypes L =
7132 Weak ? llvm::GlobalValue::ExternalWeakLinkage
7133 : llvm::GlobalValue::ExternalLinkage;
7134
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00007135
John McCalldba63a72016-11-30 23:54:50 +00007136
7137 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
7138 if (!GV) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007139 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABITy,
Craig Topper8a13c412014-05-21 05:09:00 +00007140 false, L, nullptr, Name);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00007141
John McCalldba63a72016-11-30 23:54:50 +00007142 if (DLLImport)
7143 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
7144 }
7145
Rafael Espindola554256c2014-02-26 22:25:45 +00007146 assert(GV->getLinkage() == L);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00007147 return GV;
7148}
7149
John McCalldba63a72016-11-30 23:54:50 +00007150llvm::Value *
7151CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
7152 IdentifierInfo *II,
7153 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00007154 CharUnits Align = CGF.getPointerAlign();
John McCall31168b02011-06-15 23:02:42 +00007155 llvm::GlobalVariable *&Entry = ClassReferences[II];
7156
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007157 if (!Entry) {
John McCalldba63a72016-11-30 23:54:50 +00007158 llvm::Constant *ClassGV;
7159 if (ID) {
7160 ClassGV = GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition);
7161 } else {
7162 ClassGV = GetClassGlobal((getClassSymbolPrefix() + II->getName()).str(),
7163 NotForDefinition);
7164 }
7165
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007166 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
7167 false, llvm::GlobalValue::PrivateLinkage,
7168 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007169 Entry->setAlignment(Align.getQuantity());
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007170 Entry->setSection(GetSectionName("__objc_classrefs",
7171 "regular,no_dead_strip"));
Rafael Espindola060062a2014-03-06 22:15:10 +00007172 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007173 }
John McCall7f416cc2015-09-08 08:05:57 +00007174 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007175}
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007176
John McCall882987f2013-02-28 19:01:20 +00007177llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00007178 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00007179 // If the class has the objc_runtime_visible attribute, we need to
7180 // use the Objective-C runtime to get the class.
7181 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
7182 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
7183
John McCalldba63a72016-11-30 23:54:50 +00007184 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID);
John McCall31168b02011-06-15 23:02:42 +00007185}
7186
7187llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCall882987f2013-02-28 19:01:20 +00007188 CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00007189 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCalldba63a72016-11-30 23:54:50 +00007190 return EmitClassRefFromId(CGF, II, nullptr);
John McCall31168b02011-06-15 23:02:42 +00007191}
7192
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007193llvm::Value *
John McCall882987f2013-02-28 19:01:20 +00007194CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007195 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00007196 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007197 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007198
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007199 if (!Entry) {
John McCalldba63a72016-11-30 23:54:50 +00007200 auto ClassGV = GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007201 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
7202 false, llvm::GlobalValue::PrivateLinkage,
7203 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007204 Entry->setAlignment(Align.getQuantity());
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007205 Entry->setSection(GetSectionName("__objc_superrefs",
7206 "regular,no_dead_strip"));
Rafael Espindola060062a2014-03-06 22:15:10 +00007207 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007208 }
John McCall7f416cc2015-09-08 08:05:57 +00007209 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007210}
7211
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007212/// EmitMetaClassRef - Return a Value * of the address of _class_t
7213/// meta-data
7214///
John McCall882987f2013-02-28 19:01:20 +00007215llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00007216 const ObjCInterfaceDecl *ID,
7217 bool Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00007218 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007219 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Rafael Espindola21039aa2014-02-27 16:26:32 +00007220 if (!Entry) {
John McCalldba63a72016-11-30 23:54:50 +00007221 auto MetaClassGV = GetClassGlobal(ID, /*metaclass*/ true, NotForDefinition);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007222
Rafael Espindola21039aa2014-02-27 16:26:32 +00007223 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00007224 false, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007225 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007226 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007227
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007228 Entry->setSection(GetSectionName("__objc_superrefs",
7229 "regular,no_dead_strip"));
Rafael Espindola060062a2014-03-06 22:15:10 +00007230 CGM.addCompilerUsedGlobal(Entry);
Rafael Espindola21039aa2014-02-27 16:26:32 +00007231 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007232
John McCall7f416cc2015-09-08 08:05:57 +00007233 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007234}
7235
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007236/// GetClass - Return a reference to the class for the given interface
7237/// decl.
John McCall882987f2013-02-28 19:01:20 +00007238llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007239 const ObjCInterfaceDecl *ID) {
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00007240 if (ID->isWeakImported()) {
John McCalldba63a72016-11-30 23:54:50 +00007241 auto ClassGV = GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition);
Nick Lewycky9a441642014-02-27 00:36:00 +00007242 (void)ClassGV;
John McCalldba63a72016-11-30 23:54:50 +00007243 assert(!isa<llvm::GlobalVariable>(ClassGV) ||
7244 cast<llvm::GlobalVariable>(ClassGV)->hasExternalWeakLinkage());
Fariborz Jahanian95ace552009-11-17 22:42:00 +00007245 }
7246
John McCall882987f2013-02-28 19:01:20 +00007247 return EmitClassRef(CGF, ID);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007248}
7249
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007250/// Generates a message send where the super is the receiver. This is
7251/// a message send to self with special delivery semantics indicating
7252/// which class's method should be called.
7253CodeGen::RValue
7254CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00007255 ReturnValueSlot Return,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007256 QualType ResultType,
7257 Selector Sel,
7258 const ObjCInterfaceDecl *Class,
7259 bool isCategoryImpl,
7260 llvm::Value *Receiver,
7261 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007262 const CodeGen::CallArgList &CallArgs,
7263 const ObjCMethodDecl *Method) {
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007264 // ...
7265 // Create and init a super structure; this is a (receiver, class)
7266 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00007267 Address ObjCSuper =
7268 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
7269 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007270
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007271 llvm::Value *ReceiverAsObject =
7272 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007273 CGF.Builder.CreateStore(
7274 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00007275 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007276
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007277 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00007278 llvm::Value *Target;
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007279 if (IsClassMessage)
Fariborz Jahanian85b99da2014-08-28 17:05:17 +00007280 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007281 else
John McCall882987f2013-02-28 19:01:20 +00007282 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007283
Mike Stump18bb9282009-05-16 07:57:57 +00007284 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
7285 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00007286 llvm::Type *ClassTy =
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007287 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
7288 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007289 CGF.Builder.CreateStore(
John McCall7f416cc2015-09-08 08:05:57 +00007290 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007291
John McCall9e8bb002011-05-14 03:10:52 +00007292 return (isVTableDispatchedSelector(Sel))
7293 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
John McCall7f416cc2015-09-08 08:05:57 +00007294 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall9e8bb002011-05-14 03:10:52 +00007295 true, CallArgs, Method)
7296 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00007297 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00007298 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00007299 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007300}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007301
John McCall882987f2013-02-28 19:01:20 +00007302llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007303 Selector Sel) {
7304 Address Addr = EmitSelectorAddr(CGF, Sel);
7305
7306 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
7307 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
7308 llvm::MDNode::get(VMContext, None));
7309 return LI;
7310}
7311
7312Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
7313 Selector Sel) {
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007314 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007315
John McCall7f416cc2015-09-08 08:05:57 +00007316 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007317 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007318 llvm::Constant *Casted =
7319 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
7320 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007321 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
7322 false, llvm::GlobalValue::PrivateLinkage,
7323 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman5c205962013-02-05 23:08:45 +00007324 Entry->setExternallyInitialized(true);
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007325 Entry->setSection(GetSectionName("__objc_selrefs",
7326 "literal_pointers,no_dead_strip"));
John McCall7f416cc2015-09-08 08:05:57 +00007327 Entry->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00007328 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007329 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007330
John McCall7f416cc2015-09-08 08:05:57 +00007331 return Address(Entry, Align);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007332}
John McCall7f416cc2015-09-08 08:05:57 +00007333
Fariborz Jahanian06292952009-02-16 22:52:32 +00007334/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007335/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian06292952009-02-16 22:52:32 +00007336///
7337void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00007338 llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +00007339 Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007340 llvm::Value *ivarOffset) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007341 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007342 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007343 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007344 assert(Size <= 8 && "does not support size > 8");
7345 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7346 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007347 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7348 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007349 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7350 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007351 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00007352 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007353}
7354
7355/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
7356/// objc_assign_strongCast (id src, id *dst)
7357///
7358void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007359 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007360 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007361 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007362 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007363 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007364 assert(Size <= 8 && "does not support size > 8");
7365 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007366 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007367 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7368 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007369 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7370 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007371 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007372 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
7373 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007374}
7375
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007376void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007377 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007378 Address DestPtr,
7379 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00007380 llvm::Value *Size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007381 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
7382 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007383 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCall882987f2013-02-28 19:01:20 +00007384 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007385}
7386
Fariborz Jahanian06292952009-02-16 22:52:32 +00007387/// EmitObjCWeakRead - Code gen for loading value of a __weak
7388/// object: objc_read_weak (id *src)
7389///
7390llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007391 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007392 Address AddrWeakObj) {
7393 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007394 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007395 llvm::Value *read_weak =
7396 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00007397 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00007398 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007399 return read_weak;
7400}
7401
7402/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
7403/// objc_assign_weak (id src, id *dst)
7404///
7405void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007406 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007407 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007408 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007409 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007410 assert(Size <= 8 && "does not support size > 8");
7411 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7412 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007413 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7414 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007415 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7416 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007417 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007418 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
7419 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007420}
7421
7422/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
7423/// objc_assign_global (id src, id *dst)
7424///
7425void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007426 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00007427 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007428 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007429 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007430 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007431 assert(Size <= 8 && "does not support size > 8");
7432 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7433 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007434 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7435 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007436 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7437 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007438 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00007439 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00007440 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
7441 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00007442 else
John McCall882987f2013-02-28 19:01:20 +00007443 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
7444 args, "threadlocalassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007445}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007446
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007447void
John McCallbd309292010-07-06 01:34:17 +00007448CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
7449 const ObjCAtSynchronizedStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007450 EmitAtSynchronizedStmt(CGF, S,
7451 cast<llvm::Function>(ObjCTypes.getSyncEnterFn()),
7452 cast<llvm::Function>(ObjCTypes.getSyncExitFn()));
John McCallbd309292010-07-06 01:34:17 +00007453}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007454
John McCall2ca705e2010-07-24 00:37:23 +00007455llvm::Constant *
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00007456CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall2ca705e2010-07-24 00:37:23 +00007457 // There's a particular fixed type info for 'id'.
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007458 if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
7459 auto *IDEHType = CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007460 if (!IDEHType) {
John McCall2ca705e2010-07-24 00:37:23 +00007461 IDEHType =
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007462 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7463 llvm::GlobalValue::ExternalLinkage, nullptr,
7464 "OBJC_EHTYPE_id");
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007465 if (CGM.getTriple().isOSBinFormatCOFF())
7466 IDEHType->setDLLStorageClass(getStorage(CGM, "OBJC_EHTYPE_id"));
7467 }
John McCall2ca705e2010-07-24 00:37:23 +00007468 return IDEHType;
7469 }
7470
7471 // All other types should be Objective-C interface pointer types.
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007472 const ObjCObjectPointerType *PT = T->getAs<ObjCObjectPointerType>();
John McCall2ca705e2010-07-24 00:37:23 +00007473 assert(PT && "Invalid @catch type.");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007474
John McCall2ca705e2010-07-24 00:37:23 +00007475 const ObjCInterfaceType *IT = PT->getInterfaceType();
7476 assert(IT && "Invalid @catch type.");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007477
John McCalldba63a72016-11-30 23:54:50 +00007478 return GetInterfaceEHType(IT->getDecl(), NotForDefinition);
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007479}
John McCall2ca705e2010-07-24 00:37:23 +00007480
John McCallbd309292010-07-06 01:34:17 +00007481void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7482 const ObjCAtTryStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007483 EmitTryCatchStmt(CGF, S,
7484 cast<llvm::Function>(ObjCTypes.getObjCBeginCatchFn()),
7485 cast<llvm::Function>(ObjCTypes.getObjCEndCatchFn()),
7486 cast<llvm::Function>(ObjCTypes.getExceptionRethrowFn()));
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +00007487}
7488
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007489/// EmitThrowStmt - Generate code for a throw statement.
7490void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007491 const ObjCAtThrowStmt &S,
7492 bool ClearInsertionPoint) {
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007493 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00007494 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer76399eb2011-09-27 21:06:10 +00007495 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007496 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception)
John McCall17afe452010-10-16 08:21:07 +00007497 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007498 } else {
John McCall882987f2013-02-28 19:01:20 +00007499 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn())
John McCall17afe452010-10-16 08:21:07 +00007500 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007501 }
7502
John McCall17afe452010-10-16 08:21:07 +00007503 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007504 if (ClearInsertionPoint)
7505 CGF.Builder.ClearInsertionPoint();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007506}
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007507
John McCall2ca705e2010-07-24 00:37:23 +00007508llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007509CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
John McCalldba63a72016-11-30 23:54:50 +00007510 ForDefinition_t IsForDefinition) {
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007511 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007512 StringRef ClassName = ID->getObjCRuntimeNameAsString();
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007513
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007514 // If we don't need a definition, return the entry if found or check
7515 // if we use an external reference.
John McCalldba63a72016-11-30 23:54:50 +00007516 if (!IsForDefinition) {
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007517 if (Entry)
7518 return Entry;
Daniel Dunbard7beeea2009-04-07 06:43:45 +00007519
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007520 // If this type (or a super class) has the __objc_exception__
7521 // attribute, emit an external reference.
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007522 if (hasObjCExceptionAttribute(CGM.getContext(), ID)) {
7523 std::string EHTypeName = ("OBJC_EHTYPE_$_" + ClassName).str();
7524 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7525 false, llvm::GlobalValue::ExternalLinkage,
7526 nullptr, EHTypeName);
Rafael Espindolab7350042018-03-01 00:35:47 +00007527 CGM.setGVProperties(Entry, ID);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007528 return Entry;
7529 }
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007530 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007531
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007532 // Otherwise we need to either make a new entry or fill in the initializer.
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007533 assert((!Entry || !Entry->hasInitializer()) && "Duplicate EHType definition");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007534
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007535 std::string VTableName = "objc_ehtype_vtable";
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007536 auto *VTableGV = CGM.getModule().getGlobalVariable(VTableName);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007537 if (!VTableGV) {
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007538 VTableGV =
7539 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.Int8PtrTy, false,
7540 llvm::GlobalValue::ExternalLinkage, nullptr,
7541 VTableName);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007542 if (CGM.getTriple().isOSBinFormatCOFF())
7543 VTableGV->setDLLStorageClass(getStorage(CGM, VTableName));
7544 }
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007545
Chris Lattnerece04092012-02-07 00:39:47 +00007546 llvm::Value *VTableIdx = llvm::ConstantInt::get(CGM.Int32Ty, 2);
John McCall176f8922016-11-30 02:39:18 +00007547 ConstantInitBuilder builder(CGM);
7548 auto values = builder.beginStruct(ObjCTypes.EHTypeTy);
Ahmed Bougacha5d0199a2017-11-17 19:46:47 +00007549 values.add(
7550 llvm::ConstantExpr::getInBoundsGetElementPtr(VTableGV->getValueType(),
7551 VTableGV, VTableIdx));
John McCalldba63a72016-11-30 23:54:50 +00007552 values.add(GetClassName(ClassName));
7553 values.add(GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition));
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007554
John McCalldba63a72016-11-30 23:54:50 +00007555 llvm::GlobalValue::LinkageTypes L = IsForDefinition
Rafael Espindola554256c2014-02-26 22:25:45 +00007556 ? llvm::GlobalValue::ExternalLinkage
7557 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007558 if (Entry) {
John McCall176f8922016-11-30 02:39:18 +00007559 values.finishAndSetAsInitializer(Entry);
7560 Entry->setAlignment(CGM.getPointerAlign().getQuantity());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007561 } else {
John McCall176f8922016-11-30 02:39:18 +00007562 Entry = values.finishAndCreateGlobal("OBJC_EHTYPE_$_" + ClassName,
7563 CGM.getPointerAlign(),
7564 /*constant*/ false,
7565 L);
Rafael Espindolab7350042018-03-01 00:35:47 +00007566 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
7567 CGM.setGVProperties(Entry, ID);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007568 }
Rafael Espindola554256c2014-02-26 22:25:45 +00007569 assert(Entry->getLinkage() == L);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007570
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007571 if (!CGM.getTriple().isOSBinFormatCOFF())
7572 if (ID->getVisibility() == HiddenVisibility)
7573 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007574
John McCalldba63a72016-11-30 23:54:50 +00007575 if (IsForDefinition)
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00007576 if (CGM.getTriple().isOSBinFormatMachO())
7577 Entry->setSection("__DATA,__objc_const");
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007578
7579 return Entry;
7580}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007581
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00007582/* *** */
7583
Daniel Dunbarb036db82008-08-13 03:21:16 +00007584CodeGen::CGObjCRuntime *
7585CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00007586 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7587 case ObjCRuntime::FragileMacOSX:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007588 return new CGObjCMac(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00007589
7590 case ObjCRuntime::MacOSX:
7591 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00007592 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00007593 return new CGObjCNonFragileABIMac(CGM);
7594
David Chisnallb601c962012-07-03 20:49:52 +00007595 case ObjCRuntime::GNUstep:
7596 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +00007597 case ObjCRuntime::ObjFW:
John McCall5fb5df92012-06-20 06:18:46 +00007598 llvm_unreachable("these runtimes are not Mac runtimes");
7599 }
7600 llvm_unreachable("bad runtime");
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007601}