blob: 43b347ce353f05ecc82daa7bbdd073bc81b78548 [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);
108 llvm::Type *resultType =
Reid Kleckneree7cf842014-12-01 22:02:27 +0000109 llvm::StructType::get(longDoubleType, longDoubleType, nullptr);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000110
111 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(resultType,
112 params, true),
113 "objc_msgSend_fp2ret");
114 }
115
John McCall9dc0db22011-05-15 01:53:33 +0000116 /// id objc_msgSendSuper(struct objc_super *super, SEL op, ...)
117 ///
118 /// The messenger used for super calls, which have different dispatch
119 /// semantics. The class passed is the superclass of the current
120 /// class.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000121 llvm::Constant *getMessageSendSuperFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000122 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000123 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000124 params, true),
125 "objc_msgSendSuper");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000126 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000127
John McCall9dc0db22011-05-15 01:53:33 +0000128 /// id objc_msgSendSuper2(struct objc_super *super, SEL op, ...)
129 ///
130 /// A slightly different messenger used for super calls. The class
131 /// passed is the current class.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000132 llvm::Constant *getMessageSendSuperFn2() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000133 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000134 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000135 params, true),
136 "objc_msgSendSuper2");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000137 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000138
John McCall9dc0db22011-05-15 01:53:33 +0000139 /// void objc_msgSendSuper_stret(void *stretAddr, struct objc_super *super,
140 /// SEL op, ...)
141 ///
142 /// The messenger used for super calls which return an aggregate indirectly.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000143 llvm::Constant *getMessageSendSuperStretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000144 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000145 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000146 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000147 "objc_msgSendSuper_stret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000148 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000149
John McCall9dc0db22011-05-15 01:53:33 +0000150 /// void objc_msgSendSuper2_stret(void * stretAddr, struct objc_super *super,
151 /// SEL op, ...)
152 ///
153 /// objc_msgSendSuper_stret with the super2 semantics.
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000154 llvm::Constant *getMessageSendSuperStretFn2() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000155 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000156 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000157 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000158 "objc_msgSendSuper2_stret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000159 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000160
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000161 llvm::Constant *getMessageSendSuperFpretFn() const {
162 // There is no objc_msgSendSuper_fpret? How can that work?
163 return getMessageSendSuperFn();
164 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000165
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000166 llvm::Constant *getMessageSendSuperFpretFn2() const {
167 // There is no objc_msgSendSuper_fpret? How can that work?
168 return getMessageSendSuperFn2();
169 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000170
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000171protected:
172 CodeGen::CodeGenModule &CGM;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000173
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000174public:
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);
311 Params.push_back(Ctx.LongTy);
312 Params.push_back(Ctx.BoolTy);
313 Params.push_back(Ctx.BoolTy);
Chris Lattner2192fe52011-07-18 04:24:23 +0000314 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000315 Types.GetFunctionType(
316 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000317 return CGM.CreateRuntimeFunction(FTy, "objc_copyStruct");
318 }
319
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000320 /// This routine declares and returns address of:
321 /// void objc_copyCppObjectAtomic(
322 /// void *dest, const void *src,
323 /// void (*copyHelper) (void *dest, const void *source));
324 llvm::Constant *getCppAtomicObjectFunction() {
325 CodeGen::CodeGenTypes &Types = CGM.getTypes();
326 ASTContext &Ctx = CGM.getContext();
327 /// void objc_copyCppObjectAtomic(void *dest, const void *src, void *helper);
328 SmallVector<CanQualType,3> Params;
329 Params.push_back(Ctx.VoidPtrTy);
330 Params.push_back(Ctx.VoidPtrTy);
331 Params.push_back(Ctx.VoidPtrTy);
332 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000333 Types.GetFunctionType(
334 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000335 return CGM.CreateRuntimeFunction(FTy, "objc_copyCppObjectAtomic");
336 }
337
Chris Lattnerce8754e2009-04-22 02:44:54 +0000338 llvm::Constant *getEnumerationMutationFn() {
Daniel Dunbar9d82da42009-07-11 20:32:50 +0000339 CodeGen::CodeGenTypes &Types = CGM.getTypes();
340 ASTContext &Ctx = CGM.getContext();
Chris Lattnerce8754e2009-04-22 02:44:54 +0000341 // void objc_enumerationMutation (id)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000342 SmallVector<CanQualType,1> Params;
John McCall2da83a32010-02-26 00:48:12 +0000343 Params.push_back(Ctx.getCanonicalParamType(Ctx.getObjCIdType()));
Chris Lattner2192fe52011-07-18 04:24:23 +0000344 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000345 Types.GetFunctionType(
346 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000347 return CGM.CreateRuntimeFunction(FTy, "objc_enumerationMutation");
348 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000349
Douglas Gregor24ae22c2016-04-01 23:23:52 +0000350 llvm::Constant *getLookUpClassFn() {
351 CodeGen::CodeGenTypes &Types = CGM.getTypes();
352 ASTContext &Ctx = CGM.getContext();
353 // Class objc_lookUpClass (const char *)
354 SmallVector<CanQualType,1> Params;
355 Params.push_back(
356 Ctx.getCanonicalType(Ctx.getPointerType(Ctx.CharTy.withConst())));
357 llvm::FunctionType *FTy =
358 Types.GetFunctionType(Types.arrangeBuiltinFunctionDeclaration(
359 Ctx.getCanonicalType(Ctx.getObjCClassType()),
360 Params));
361 return CGM.CreateRuntimeFunction(FTy, "objc_lookUpClass");
362 }
363
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000364 /// GcReadWeakFn -- LLVM objc_read_weak (id *src) function.
Chris Lattnerce8754e2009-04-22 02:44:54 +0000365 llvm::Constant *getGcReadWeakFn() {
366 // id objc_read_weak (id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000367 llvm::Type *args[] = { ObjectPtrTy->getPointerTo() };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000368 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000369 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattnerce8754e2009-04-22 02:44:54 +0000370 return CGM.CreateRuntimeFunction(FTy, "objc_read_weak");
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000371 }
372
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000373 /// GcAssignWeakFn -- LLVM objc_assign_weak function.
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000374 llvm::Constant *getGcAssignWeakFn() {
375 // id objc_assign_weak (id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000376 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000377 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000378 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000379 return CGM.CreateRuntimeFunction(FTy, "objc_assign_weak");
380 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000381
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000382 /// GcAssignGlobalFn -- LLVM objc_assign_global function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000383 llvm::Constant *getGcAssignGlobalFn() {
384 // id objc_assign_global(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000385 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000386 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000387 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000388 return CGM.CreateRuntimeFunction(FTy, "objc_assign_global");
389 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000390
Fariborz Jahanian217af242010-07-20 20:30:03 +0000391 /// GcAssignThreadLocalFn -- LLVM objc_assign_threadlocal function.
392 llvm::Constant *getGcAssignThreadLocalFn() {
393 // id objc_assign_threadlocal(id src, id * dest)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000394 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Fariborz Jahanian217af242010-07-20 20:30:03 +0000395 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000396 llvm::FunctionType::get(ObjectPtrTy, args, false);
Fariborz Jahanian217af242010-07-20 20:30:03 +0000397 return CGM.CreateRuntimeFunction(FTy, "objc_assign_threadlocal");
398 }
399
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000400 /// GcAssignIvarFn -- LLVM objc_assign_ivar function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000401 llvm::Constant *getGcAssignIvarFn() {
Fariborz Jahanian7a95d722009-09-24 22:25:38 +0000402 // id objc_assign_ivar(id, id *, ptrdiff_t)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000403 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo(),
404 CGM.PtrDiffTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000405 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000406 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000407 return CGM.CreateRuntimeFunction(FTy, "objc_assign_ivar");
408 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000409
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000410 /// GcMemmoveCollectableFn -- LLVM objc_memmove_collectable function.
411 llvm::Constant *GcMemmoveCollectableFn() {
412 // void *objc_memmove_collectable(void *dst, const void *src, size_t size)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000413 llvm::Type *args[] = { Int8PtrTy, Int8PtrTy, LongTy };
John McCall9dc0db22011-05-15 01:53:33 +0000414 llvm::FunctionType *FTy = llvm::FunctionType::get(Int8PtrTy, args, false);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000415 return CGM.CreateRuntimeFunction(FTy, "objc_memmove_collectable");
416 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000417
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000418 /// GcAssignStrongCastFn -- LLVM objc_assign_strongCast function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000419 llvm::Constant *getGcAssignStrongCastFn() {
Fariborz Jahanian217af242010-07-20 20:30:03 +0000420 // id objc_assign_strongCast(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000421 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000422 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000423 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000424 return CGM.CreateRuntimeFunction(FTy, "objc_assign_strongCast");
425 }
Anders Carlsson9ab53d12009-02-16 22:59:18 +0000426
427 /// ExceptionThrowFn - LLVM objc_exception_throw function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000428 llvm::Constant *getExceptionThrowFn() {
429 // void objc_exception_throw(id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000430 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000431 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000432 llvm::FunctionType::get(CGM.VoidTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000433 return CGM.CreateRuntimeFunction(FTy, "objc_exception_throw");
434 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000435
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000436 /// ExceptionRethrowFn - LLVM objc_exception_rethrow function.
437 llvm::Constant *getExceptionRethrowFn() {
438 // void objc_exception_rethrow(void)
John McCall9dc0db22011-05-15 01:53:33 +0000439 llvm::FunctionType *FTy = llvm::FunctionType::get(CGM.VoidTy, false);
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000440 return CGM.CreateRuntimeFunction(FTy, "objc_exception_rethrow");
441 }
442
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000443 /// SyncEnterFn - LLVM object_sync_enter function.
Chris Lattnerdcceee72009-04-06 16:53:45 +0000444 llvm::Constant *getSyncEnterFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000445 // int objc_sync_enter (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000446 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattnerdcceee72009-04-06 16:53:45 +0000447 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000448 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattnerdcceee72009-04-06 16:53:45 +0000449 return CGM.CreateRuntimeFunction(FTy, "objc_sync_enter");
450 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000451
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000452 /// SyncExitFn - LLVM object_sync_exit function.
Chris Lattner0a696a422009-04-22 02:38:11 +0000453 llvm::Constant *getSyncExitFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000454 // int objc_sync_exit (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000455 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000456 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000457 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000458 return CGM.CreateRuntimeFunction(FTy, "objc_sync_exit");
459 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000460
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000461 llvm::Constant *getSendFn(bool IsSuper) const {
462 return IsSuper ? getMessageSendSuperFn() : getMessageSendFn();
463 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000464
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000465 llvm::Constant *getSendFn2(bool IsSuper) const {
466 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFn();
467 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000468
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000469 llvm::Constant *getSendStretFn(bool IsSuper) const {
470 return IsSuper ? getMessageSendSuperStretFn() : getMessageSendStretFn();
471 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000472
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000473 llvm::Constant *getSendStretFn2(bool IsSuper) const {
474 return IsSuper ? getMessageSendSuperStretFn2() : getMessageSendStretFn();
475 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000476
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000477 llvm::Constant *getSendFpretFn(bool IsSuper) const {
478 return IsSuper ? getMessageSendSuperFpretFn() : getMessageSendFpretFn();
479 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000480
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000481 llvm::Constant *getSendFpretFn2(bool IsSuper) const {
482 return IsSuper ? getMessageSendSuperFpretFn2() : getMessageSendFpretFn();
483 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000484
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000485 llvm::Constant *getSendFp2retFn(bool IsSuper) const {
486 return IsSuper ? getMessageSendSuperFn() : getMessageSendFp2retFn();
487 }
488
489 llvm::Constant *getSendFp2RetFn2(bool IsSuper) const {
490 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFp2retFn();
491 }
492
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000493 ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000494};
Daniel Dunbarf6397fe2008-08-23 04:28:29 +0000495
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000496/// ObjCTypesHelper - Helper class that encapsulates lazy
497/// construction of varies types used during ObjC generation.
498class ObjCTypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000499public:
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000500 /// SymtabTy - LLVM type for struct objc_symtab.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000501 llvm::StructType *SymtabTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000502 /// SymtabPtrTy - LLVM type for struct objc_symtab *.
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.
889 llvm::WeakVH ConstantStringClassRef;
890
891 /// \brief The LLVM type corresponding to NSConstantString.
892 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.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000984 llvm::Constant *EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000985 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.
992 llvm::Constant *EmitProtocolMethodTypes(Twine Name,
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +0000993 ArrayRef<llvm::Constant*> MethodTypes,
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000994 const ObjCCommonTypesHelper &ObjCTypes);
995
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
John McCall3fd13f062015-10-21 18:06:47 +00001007public:
Daniel Dunbar30c65362009-03-09 20:09:19 +00001008 /// CreateMetadataVar - Create a global variable with internal
1009 /// linkage for use by the Objective-C runtime.
1010 ///
1011 /// This is a convenience wrapper which not only creates the
1012 /// variable, but also sets the section and alignment and adds the
Chris Lattnerf56501c2009-07-17 23:57:13 +00001013 /// global to the "llvm.used" list.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001014 ///
1015 /// \param Name - The variable name.
1016 /// \param Init - The variable initializer; this is also used to
John McCall176f8922016-11-30 02:39:18 +00001017 /// define the type of the variable.
Alp Toker541d5072014-06-07 23:30:53 +00001018 /// \param Section - The section the variable should go into, or empty.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001019 /// \param Align - The alignment for the variable, or 0.
1020 /// \param AddToUsed - Whether the variable should be added to
John McCall176f8922016-11-30 02:39:18 +00001021 /// "llvm.used".
1022 llvm::GlobalVariable *CreateMetadataVar(Twine Name,
1023 ConstantStructBuilder &Init,
1024 StringRef Section, CharUnits Align,
1025 bool AddToUsed);
1026 llvm::GlobalVariable *CreateMetadataVar(Twine Name,
1027 llvm::Constant *Init,
John McCall7f416cc2015-09-08 08:05:57 +00001028 StringRef Section, CharUnits Align,
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001029 bool AddToUsed);
Daniel Dunbar30c65362009-03-09 20:09:19 +00001030
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00001031 llvm::GlobalVariable *CreateCStringLiteral(StringRef Name,
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00001032 ObjCLabelType LabelType,
1033 bool ForceNonFragileABI = false,
1034 bool NullTerminate = true);
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00001035
John McCall3fd13f062015-10-21 18:06:47 +00001036protected:
John McCall9e8bb002011-05-14 03:10:52 +00001037 CodeGen::RValue EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1038 ReturnValueSlot Return,
1039 QualType ResultType,
1040 llvm::Value *Sel,
1041 llvm::Value *Arg0,
1042 QualType Arg0Ty,
1043 bool IsSuper,
1044 const CallArgList &CallArgs,
1045 const ObjCMethodDecl *OMD,
John McCall1e3157b2015-09-10 22:27:50 +00001046 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001047 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbarf5c18462009-04-20 06:54:31 +00001048
Daniel Dunbar5e639272010-04-25 20:39:01 +00001049 /// EmitImageInfo - Emit the image info marker used to encode some module
1050 /// level information.
1051 void EmitImageInfo();
1052
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001053public:
Owen Andersonae86c192009-07-13 04:10:07 +00001054 CGObjCCommonMac(CodeGen::CodeGenModule &cgm) :
John McCalla729c622012-02-17 03:33:10 +00001055 CGObjCRuntime(cgm), VMContext(cgm.getLLVMContext()) { }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001056
John McCall3fd13f062015-10-21 18:06:47 +00001057 bool isNonFragileABI() const {
1058 return ObjCABI == 2;
1059 }
1060
John McCall7f416cc2015-09-08 08:05:57 +00001061 ConstantAddress GenerateConstantString(const StringLiteral *SL) override;
John McCallcd21d542016-11-30 23:15:55 +00001062 ConstantAddress GenerateConstantNSString(const StringLiteral *SL);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001063
Craig Topper4f12f102014-03-12 06:41:41 +00001064 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
Craig Topper8a13c412014-05-21 05:09:00 +00001065 const ObjCContainerDecl *CD=nullptr) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001066
1067 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001068
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001069 /// GetOrEmitProtocol - Get the protocol object for the given
1070 /// declaration, emitting it if necessary. The return value has type
1071 /// ProtocolPtrTy.
1072 virtual llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD)=0;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001073
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001074 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1075 /// object for the given declaration, emitting it if needed. These
1076 /// forward references will be filled in with empty bodies if no
1077 /// definition is seen. The return value has type ProtocolPtrTy.
1078 virtual llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD)=0;
John McCallcd21d542016-11-30 23:15:55 +00001079
1080 virtual llvm::Constant *getNSConstantStringClassRef() = 0;
1081
Craig Topper4f12f102014-03-12 06:41:41 +00001082 llvm::Constant *BuildGCBlockLayout(CodeGen::CodeGenModule &CGM,
1083 const CGBlockInfo &blockInfo) override;
1084 llvm::Constant *BuildRCBlockLayout(CodeGen::CodeGenModule &CGM,
1085 const CGBlockInfo &blockInfo) override;
1086
1087 llvm::Constant *BuildByrefLayout(CodeGen::CodeGenModule &CGM,
1088 QualType T) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001089};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001090
John McCall176f8922016-11-30 02:39:18 +00001091namespace {
1092
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00001093enum class MethodListType {
1094 CategoryInstanceMethods,
1095 CategoryClassMethods,
1096 InstanceMethods,
1097 ClassMethods,
1098 ProtocolInstanceMethods,
1099 ProtocolClassMethods,
1100 OptionalProtocolInstanceMethods,
1101 OptionalProtocolClassMethods,
1102};
1103
John McCall176f8922016-11-30 02:39:18 +00001104/// A convenience class for splitting the methods of a protocol into
1105/// the four interesting groups.
1106class ProtocolMethodLists {
1107public:
1108 enum Kind {
1109 RequiredInstanceMethods,
1110 RequiredClassMethods,
1111 OptionalInstanceMethods,
1112 OptionalClassMethods
1113 };
1114 enum {
1115 NumProtocolMethodLists = 4
1116 };
1117
1118 static MethodListType getMethodListKind(Kind kind) {
1119 switch (kind) {
1120 case RequiredInstanceMethods:
1121 return MethodListType::ProtocolInstanceMethods;
1122 case RequiredClassMethods:
1123 return MethodListType::ProtocolClassMethods;
1124 case OptionalInstanceMethods:
1125 return MethodListType::OptionalProtocolInstanceMethods;
1126 case OptionalClassMethods:
1127 return MethodListType::OptionalProtocolClassMethods;
1128 }
1129 llvm_unreachable("bad kind");
1130 }
1131
1132 SmallVector<const ObjCMethodDecl *, 4> Methods[NumProtocolMethodLists];
1133
1134 static ProtocolMethodLists get(const ObjCProtocolDecl *PD) {
1135 ProtocolMethodLists result;
1136
1137 for (auto MD : PD->methods()) {
1138 size_t index = (2 * size_t(MD->isOptional()))
1139 + (size_t(MD->isClassMethod()));
1140 result.Methods[index].push_back(MD);
1141 }
1142
1143 return result;
1144 }
1145
1146 template <class Self>
1147 SmallVector<llvm::Constant*, 8> emitExtendedTypesArray(Self *self) const {
1148 // In both ABIs, the method types list is parallel with the
1149 // concatenation of the methods arrays in the following order:
1150 // instance methods
1151 // class methods
1152 // optional instance methods
1153 // optional class methods
1154 SmallVector<llvm::Constant*, 8> result;
1155
1156 // Methods is already in the correct order for both ABIs.
1157 for (auto &list : Methods) {
1158 for (auto MD : list) {
1159 result.push_back(self->GetMethodVarType(MD, true));
1160 }
1161 }
1162
1163 return result;
1164 }
1165
1166 template <class Self>
1167 llvm::Constant *emitMethodList(Self *self, const ObjCProtocolDecl *PD,
1168 Kind kind) const {
1169 return self->emitMethodList(PD->getObjCRuntimeNameAsString(),
1170 getMethodListKind(kind), Methods[kind]);
1171 }
1172};
1173
1174} // end anonymous namespace
1175
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001176class CGObjCMac : public CGObjCCommonMac {
1177private:
John McCallc4ae1dd2016-11-30 04:18:19 +00001178 friend ProtocolMethodLists;
John McCall176f8922016-11-30 02:39:18 +00001179
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001180 ObjCTypesHelper ObjCTypes;
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001181
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001182 /// EmitModuleInfo - Another marker encoding module level
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001183 /// information.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001184 void EmitModuleInfo();
1185
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001186 /// EmitModuleSymols - Emit module symbols, the list of defined
1187 /// classes and categories. The result has type SymtabPtrTy.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001188 llvm::Constant *EmitModuleSymbols();
1189
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001190 /// FinishModule - Write out global data structures at the end of
1191 /// processing a translation unit.
1192 void FinishModule();
Daniel Dunbarb036db82008-08-13 03:21:16 +00001193
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001194 /// EmitClassExtension - Generate the class extension structure used
1195 /// to store the weak ivar layout and properties. The return value
1196 /// has type ClassExtensionPtrTy.
John McCall3fd13f062015-10-21 18:06:47 +00001197 llvm::Constant *EmitClassExtension(const ObjCImplementationDecl *ID,
John McCall460ce582015-10-22 18:38:17 +00001198 CharUnits instanceSize,
Manman Renad0e7912016-01-29 19:22:54 +00001199 bool hasMRCWeakIvars,
John McCall176f8922016-11-30 02:39:18 +00001200 bool isMetaclass);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001201
1202 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1203 /// for the given class.
John McCall882987f2013-02-28 19:01:20 +00001204 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001205 const ObjCInterfaceDecl *ID);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001206
John McCall882987f2013-02-28 19:01:20 +00001207 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00001208 IdentifierInfo *II);
Craig Topper4f12f102014-03-12 06:41:41 +00001209
1210 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
1211
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001212 /// EmitSuperClassRef - Emits reference to class's main metadata class.
1213 llvm::Value *EmitSuperClassRef(const ObjCInterfaceDecl *ID);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001214
1215 /// EmitIvarList - Emit the ivar list for the given
1216 /// implementation. If ForClass is true the list of class ivars
1217 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1218 /// interface ivars will be emitted. The return value has type
1219 /// IvarListPtrTy.
1220 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00001221 bool ForClass);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001222
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001223 /// EmitMetaClass - Emit a forward reference to the class structure
1224 /// for the metaclass of the given interface. The return value has
1225 /// type ClassPtrTy.
1226 llvm::Constant *EmitMetaClassRef(const ObjCInterfaceDecl *ID);
1227
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001228 /// EmitMetaClass - Emit a class structure for the metaclass of the
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001229 /// given implementation. The return value has type ClassPtrTy.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001230 llvm::Constant *EmitMetaClass(const ObjCImplementationDecl *ID,
1231 llvm::Constant *Protocols,
John McCall176f8922016-11-30 02:39:18 +00001232 ArrayRef<const ObjCMethodDecl *> Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001233
John McCall176f8922016-11-30 02:39:18 +00001234 void emitMethodConstant(ConstantArrayBuilder &builder,
1235 const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001236
John McCall176f8922016-11-30 02:39:18 +00001237 void emitMethodDescriptionConstant(ConstantArrayBuilder &builder,
1238 const ObjCMethodDecl *MD);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001239
1240 /// EmitMethodList - Emit the method list for the given
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001241 /// implementation. The return value has type MethodListPtrTy.
John McCall176f8922016-11-30 02:39:18 +00001242 llvm::Constant *emitMethodList(Twine Name, MethodListType MLT,
1243 ArrayRef<const ObjCMethodDecl *> Methods);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001244
Daniel Dunbarc475d422008-10-29 22:36:39 +00001245 /// GetOrEmitProtocol - Get the protocol object for the given
1246 /// declaration, emitting it if necessary. The return value has type
1247 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001248 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001249
1250 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1251 /// object for the given declaration, emitting it if needed. These
1252 /// forward references will be filled in with empty bodies if no
1253 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001254 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001255
Daniel Dunbarb036db82008-08-13 03:21:16 +00001256 /// EmitProtocolExtension - Generate the protocol extension
1257 /// structure used to store optional instance and class methods, and
1258 /// protocol properties. The return value has type
1259 /// ProtocolExtensionPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001260 llvm::Constant *
1261 EmitProtocolExtension(const ObjCProtocolDecl *PD,
John McCall176f8922016-11-30 02:39:18 +00001262 const ProtocolMethodLists &methodLists);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001263
1264 /// EmitProtocolList - Generate the list of referenced
1265 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001266 llvm::Constant *EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00001267 ObjCProtocolDecl::protocol_iterator begin,
1268 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001269
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001270 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1271 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001272 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1273 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001274
1275public:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001276 CGObjCMac(CodeGen::CodeGenModule &cgm);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001277
John McCallcd21d542016-11-30 23:15:55 +00001278 llvm::Constant *getNSConstantStringClassRef() override;
1279
Craig Topper4f12f102014-03-12 06:41:41 +00001280 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001281
Craig Topper4f12f102014-03-12 06:41:41 +00001282 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1283 ReturnValueSlot Return,
1284 QualType ResultType,
1285 Selector Sel, llvm::Value *Receiver,
1286 const CallArgList &CallArgs,
1287 const ObjCInterfaceDecl *Class,
1288 const ObjCMethodDecl *Method) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001289
Craig Topper4f12f102014-03-12 06:41:41 +00001290 CodeGen::RValue
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001291 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001292 ReturnValueSlot Return, QualType ResultType,
1293 Selector Sel, const ObjCInterfaceDecl *Class,
1294 bool isCategoryImpl, llvm::Value *Receiver,
1295 bool IsClassMessage, const CallArgList &CallArgs,
1296 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001297
Craig Topper4f12f102014-03-12 06:41:41 +00001298 llvm::Value *GetClass(CodeGenFunction &CGF,
1299 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001300
John McCall7f416cc2015-09-08 08:05:57 +00001301 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
1302 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001303
1304 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1305 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001306 llvm::Value *GetSelector(CodeGenFunction &CGF,
1307 const ObjCMethodDecl *Method) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001308
Craig Topper4f12f102014-03-12 06:41:41 +00001309 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001310
Craig Topper4f12f102014-03-12 06:41:41 +00001311 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001312
Craig Topper4f12f102014-03-12 06:41:41 +00001313 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001314
Craig Topper4f12f102014-03-12 06:41:41 +00001315 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001316
Craig Topper4f12f102014-03-12 06:41:41 +00001317 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1318 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001319
Craig Topper4f12f102014-03-12 06:41:41 +00001320 llvm::Constant *GetPropertyGetFunction() override;
1321 llvm::Constant *GetPropertySetFunction() override;
1322 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1323 bool copy) override;
1324 llvm::Constant *GetGetStructFunction() override;
1325 llvm::Constant *GetSetStructFunction() override;
1326 llvm::Constant *GetCppAtomicObjectGetFunction() override;
1327 llvm::Constant *GetCppAtomicObjectSetFunction() override;
1328 llvm::Constant *EnumerationMutationFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001329
Craig Topper4f12f102014-03-12 06:41:41 +00001330 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1331 const ObjCAtTryStmt &S) override;
1332 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1333 const ObjCAtSynchronizedStmt &S) override;
John McCallbd309292010-07-06 01:34:17 +00001334 void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, const Stmt &S);
Craig Topper4f12f102014-03-12 06:41:41 +00001335 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1336 bool ClearInsertionPoint=true) override;
1337 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001338 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001339 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001340 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001341 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001342 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001343 bool threadlocal = false) override;
1344 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001345 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001346 llvm::Value *ivarOffset) override;
1347 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001348 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001349 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001350 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001351 llvm::Value *size) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001352
Craig Topper4f12f102014-03-12 06:41:41 +00001353 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1354 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1355 unsigned CVRQualifiers) override;
1356 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1357 const ObjCInterfaceDecl *Interface,
1358 const ObjCIvarDecl *Ivar) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001359};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001360
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001361class CGObjCNonFragileABIMac : public CGObjCCommonMac {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001362private:
John McCallc4ae1dd2016-11-30 04:18:19 +00001363 friend ProtocolMethodLists;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001364 ObjCNonFragileABITypesHelper ObjCTypes;
Fariborz Jahanian71394042009-01-23 23:53:38 +00001365 llvm::GlobalVariable* ObjCEmptyCacheVar;
John McCall176f8922016-11-30 02:39:18 +00001366 llvm::Constant* ObjCEmptyVtableVar;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001367
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001368 /// SuperClassReferences - uniqued super class references.
1369 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> SuperClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001370
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001371 /// MetaClassReferences - uniqued meta class references.
1372 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> MetaClassReferences;
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001373
1374 /// EHTypeReferences - uniqued class ehtype references.
1375 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> EHTypeReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001376
John McCall9e8bb002011-05-14 03:10:52 +00001377 /// VTableDispatchMethods - List of methods for which we generate
1378 /// vtable-based message dispatch.
1379 llvm::DenseSet<Selector> VTableDispatchMethods;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001380
Fariborz Jahanian67260552009-11-17 21:37:35 +00001381 /// DefinedMetaClasses - List of defined meta-classes.
1382 std::vector<llvm::GlobalValue*> DefinedMetaClasses;
1383
John McCall9e8bb002011-05-14 03:10:52 +00001384 /// isVTableDispatchedSelector - Returns true if SEL is a
1385 /// vtable-based selector.
1386 bool isVTableDispatchedSelector(Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001387
Fariborz Jahanian71394042009-01-23 23:53:38 +00001388 /// FinishNonFragileABIModule - Write out global data structures at the end of
1389 /// processing a translation unit.
1390 void FinishNonFragileABIModule();
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001391
Daniel Dunbar19573e72009-05-15 21:48:48 +00001392 /// AddModuleClassList - Add the given list of class pointers to the
1393 /// module with the provided symbol and section names.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001394 void AddModuleClassList(ArrayRef<llvm::GlobalValue *> Container,
1395 StringRef SymbolName, StringRef SectionName);
Daniel Dunbar19573e72009-05-15 21:48:48 +00001396
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001397 llvm::GlobalVariable * BuildClassRoTInitializer(unsigned flags,
1398 unsigned InstanceStart,
1399 unsigned InstanceSize,
1400 const ObjCImplementationDecl *ID);
John McCalldba63a72016-11-30 23:54:50 +00001401 llvm::GlobalVariable *BuildClassObject(const ObjCInterfaceDecl *CI,
1402 bool isMetaclass,
1403 llvm::Constant *IsAGV,
1404 llvm::Constant *SuperClassGV,
1405 llvm::Constant *ClassRoGV,
1406 bool HiddenVisibility);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001407
John McCall176f8922016-11-30 02:39:18 +00001408 void emitMethodConstant(ConstantArrayBuilder &builder,
1409 const ObjCMethodDecl *MD,
1410 bool forProtocol);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001411
John McCall176f8922016-11-30 02:39:18 +00001412 /// Emit the method list for the given implementation. The return value
1413 /// has type MethodListnfABITy.
1414 llvm::Constant *emitMethodList(Twine Name, MethodListType MLT,
1415 ArrayRef<const ObjCMethodDecl *> Methods);
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00001416
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00001417 /// EmitIvarList - Emit the ivar list for the given
1418 /// implementation. If ForClass is true the list of class ivars
1419 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1420 /// interface ivars will be emitted. The return value has type
1421 /// IvarListnfABIPtrTy.
1422 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001423
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001424 llvm::Constant *EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00001425 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00001426 unsigned long int offset);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001427
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001428 /// GetOrEmitProtocol - Get the protocol object for the given
1429 /// declaration, emitting it if necessary. The return value has type
1430 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001431 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001432
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001433 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1434 /// object for the given declaration, emitting it if needed. These
1435 /// forward references will be filled in with empty bodies if no
1436 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001437 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001438
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001439 /// EmitProtocolList - Generate the list of referenced
1440 /// protocols. The return value has type ProtocolListPtrTy.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001441 llvm::Constant *EmitProtocolList(Twine Name,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001442 ObjCProtocolDecl::protocol_iterator begin,
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00001443 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001444
John McCall9e8bb002011-05-14 03:10:52 +00001445 CodeGen::RValue EmitVTableMessageSend(CodeGen::CodeGenFunction &CGF,
1446 ReturnValueSlot Return,
1447 QualType ResultType,
1448 Selector Sel,
1449 llvm::Value *Receiver,
1450 QualType Arg0Ty,
1451 bool IsSuper,
1452 const CallArgList &CallArgs,
1453 const ObjCMethodDecl *Method);
Fariborz Jahanian7bd3d1c2011-05-17 22:21:16 +00001454
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00001455 /// GetClassGlobal - Return the global variable for the Objective-C
1456 /// class of the given name.
John McCalldba63a72016-11-30 23:54:50 +00001457 llvm::Constant *GetClassGlobal(StringRef Name,
1458 ForDefinition_t IsForDefinition,
1459 bool Weak = false, bool DLLImport = false);
1460 llvm::Constant *GetClassGlobal(const ObjCInterfaceDecl *ID,
1461 bool isMetaclass,
1462 ForDefinition_t isForDefinition);
Rafael Espindola554256c2014-02-26 22:25:45 +00001463
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00001464 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001465 /// for the given class reference.
John McCall882987f2013-02-28 19:01:20 +00001466 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001467 const ObjCInterfaceDecl *ID);
John McCall31168b02011-06-15 23:02:42 +00001468
John McCall882987f2013-02-28 19:01:20 +00001469 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCalldba63a72016-11-30 23:54:50 +00001470 IdentifierInfo *II,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001471 const ObjCInterfaceDecl *ID);
Craig Topper4f12f102014-03-12 06:41:41 +00001472
1473 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001474
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001475 /// EmitSuperClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1476 /// for the given super class reference.
John McCall882987f2013-02-28 19:01:20 +00001477 llvm::Value *EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001478 const ObjCInterfaceDecl *ID);
1479
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001480 /// EmitMetaClassRef - Return a Value * of the address of _class_t
1481 /// meta-data
John McCall882987f2013-02-28 19:01:20 +00001482 llvm::Value *EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00001483 const ObjCInterfaceDecl *ID, bool Weak);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001484
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001485 /// ObjCIvarOffsetVariable - Returns the ivar offset variable for
1486 /// the given ivar.
1487 ///
Daniel Dunbara1060522009-04-19 00:31:15 +00001488 llvm::GlobalVariable * ObjCIvarOffsetVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001489 const ObjCInterfaceDecl *ID,
1490 const ObjCIvarDecl *Ivar);
1491
Fariborz Jahanian74b77222009-02-11 20:51:17 +00001492 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1493 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001494 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1495 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001496
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001497 /// GetInterfaceEHType - Get the cached ehtype for the given Objective-C
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001498 /// interface. The return value has type EHTypePtrTy.
John McCall2ca705e2010-07-24 00:37:23 +00001499 llvm::Constant *GetInterfaceEHType(const ObjCInterfaceDecl *ID,
John McCalldba63a72016-11-30 23:54:50 +00001500 ForDefinition_t IsForDefinition);
Daniel Dunbar15894b72009-04-07 05:48:37 +00001501
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001502 StringRef getMetaclassSymbolPrefix() const { return "OBJC_METACLASS_$_"; }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001503
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001504 StringRef getClassSymbolPrefix() const { return "OBJC_CLASS_$_"; }
Daniel Dunbar15894b72009-04-07 05:48:37 +00001505
Daniel Dunbar961202372009-05-03 12:57:56 +00001506 void GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00001507 uint32_t &InstanceStart,
1508 uint32_t &InstanceSize);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001509
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001510 // Shamelessly stolen from Analysis/CFRefCount.cpp
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001511 Selector GetNullarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001512 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1513 return CGM.getContext().Selectors.getSelector(0, &II);
1514 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001515
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001516 Selector GetUnarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001517 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1518 return CGM.getContext().Selectors.getSelector(1, &II);
1519 }
Daniel Dunbar554fd792009-04-19 23:41:48 +00001520
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001521 /// ImplementationIsNonLazy - Check whether the given category or
1522 /// class implementation is "non-lazy".
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00001523 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001524
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001525 bool IsIvarOffsetKnownIdempotent(const CodeGen::CodeGenFunction &CGF,
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001526 const ObjCIvarDecl *IV) {
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001527 // Annotate the load as an invariant load iff inside an instance method
1528 // and ivar belongs to instance method's class and one of its super class.
1529 // This check is needed because the ivar offset is a lazily
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001530 // initialised value that may depend on objc_msgSend to perform a fixup on
1531 // the first message dispatch.
1532 //
1533 // An additional opportunity to mark the load as invariant arises when the
1534 // base of the ivar access is a parameter to an Objective C method.
1535 // However, because the parameters are not available in the current
1536 // interface, we cannot perform this check.
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001537 if (const ObjCMethodDecl *MD =
1538 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurFuncDecl))
Fariborz Jahanian7a583022014-03-04 22:57:32 +00001539 if (MD->isInstanceMethod())
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001540 if (const ObjCInterfaceDecl *ID = MD->getClassInterface())
1541 return IV->getContainingInterface()->isSuperClassOf(ID);
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001542 return false;
1543 }
1544
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001545public:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001546 CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm);
John McCallcd21d542016-11-30 23:15:55 +00001547
1548 llvm::Constant *getNSConstantStringClassRef() override;
1549
Craig Topper4f12f102014-03-12 06:41:41 +00001550 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001551
Craig Topper4f12f102014-03-12 06:41:41 +00001552 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1553 ReturnValueSlot Return,
1554 QualType ResultType, Selector Sel,
1555 llvm::Value *Receiver,
1556 const CallArgList &CallArgs,
1557 const ObjCInterfaceDecl *Class,
1558 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001559
Craig Topper4f12f102014-03-12 06:41:41 +00001560 CodeGen::RValue
Fariborz Jahanian71394042009-01-23 23:53:38 +00001561 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001562 ReturnValueSlot Return, QualType ResultType,
1563 Selector Sel, const ObjCInterfaceDecl *Class,
1564 bool isCategoryImpl, llvm::Value *Receiver,
1565 bool IsClassMessage, const CallArgList &CallArgs,
1566 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001567
Craig Topper4f12f102014-03-12 06:41:41 +00001568 llvm::Value *GetClass(CodeGenFunction &CGF,
1569 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001570
John McCall7f416cc2015-09-08 08:05:57 +00001571 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override
1572 { return EmitSelector(CGF, Sel); }
1573 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override
1574 { return EmitSelectorAddr(CGF, Sel); }
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001575
1576 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1577 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001578 llvm::Value *GetSelector(CodeGenFunction &CGF,
1579 const ObjCMethodDecl *Method) override
John McCall882987f2013-02-28 19:01:20 +00001580 { return EmitSelector(CGF, Method->getSelector()); }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001581
Craig Topper4f12f102014-03-12 06:41:41 +00001582 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001583
Craig Topper4f12f102014-03-12 06:41:41 +00001584 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
David Chisnall92d436b2012-01-31 18:59:20 +00001585
Craig Topper4f12f102014-03-12 06:41:41 +00001586 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001587
Craig Topper4f12f102014-03-12 06:41:41 +00001588 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1589 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001590
Craig Topper4f12f102014-03-12 06:41:41 +00001591 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001592
Craig Topper4f12f102014-03-12 06:41:41 +00001593 llvm::Constant *GetPropertyGetFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001594 return ObjCTypes.getGetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001595 }
Craig Topper4f12f102014-03-12 06:41:41 +00001596 llvm::Constant *GetPropertySetFunction() override {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001597 return ObjCTypes.getSetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001598 }
Craig Topper4f12f102014-03-12 06:41:41 +00001599
1600 llvm::Constant *GetOptimizedPropertySetFunction(bool atomic,
1601 bool copy) override {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001602 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
1603 }
Craig Topper4f12f102014-03-12 06:41:41 +00001604
1605 llvm::Constant *GetSetStructFunction() override {
David Chisnall168b80f2010-12-26 22:13:16 +00001606 return ObjCTypes.getCopyStructFn();
1607 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001608
Craig Topper4f12f102014-03-12 06:41:41 +00001609 llvm::Constant *GetGetStructFunction() override {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00001610 return ObjCTypes.getCopyStructFn();
1611 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001612
Craig Topper4f12f102014-03-12 06:41:41 +00001613 llvm::Constant *GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +00001614 return ObjCTypes.getCppAtomicObjectFunction();
1615 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001616
Craig Topper4f12f102014-03-12 06:41:41 +00001617 llvm::Constant *GetCppAtomicObjectGetFunction() override {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00001618 return ObjCTypes.getCppAtomicObjectFunction();
1619 }
Craig Topper4f12f102014-03-12 06:41:41 +00001620
1621 llvm::Constant *EnumerationMutationFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001622 return ObjCTypes.getEnumerationMutationFn();
Daniel Dunbard73ea8162009-02-16 18:48:45 +00001623 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001624
Craig Topper4f12f102014-03-12 06:41:41 +00001625 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1626 const ObjCAtTryStmt &S) override;
1627 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1628 const ObjCAtSynchronizedStmt &S) override;
1629 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1630 bool ClearInsertionPoint=true) override;
1631 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001632 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001633 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001634 llvm::Value *src, Address edst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001635 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001636 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001637 bool threadlocal = false) override;
1638 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001639 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001640 llvm::Value *ivarOffset) override;
1641 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001642 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001643 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001644 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001645 llvm::Value *size) override;
1646 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1647 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1648 unsigned CVRQualifiers) override;
1649 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1650 const ObjCInterfaceDecl *Interface,
1651 const ObjCIvarDecl *Ivar) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001652};
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001653
1654/// A helper class for performing the null-initialization of a return
1655/// value.
1656struct NullReturnState {
1657 llvm::BasicBlock *NullBB;
Craig Topper8a13c412014-05-21 05:09:00 +00001658 NullReturnState() : NullBB(nullptr) {}
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001659
John McCall3d1e2c92013-02-12 05:53:35 +00001660 /// Perform a null-check of the given receiver.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001661 void init(CodeGenFunction &CGF, llvm::Value *receiver) {
John McCall3d1e2c92013-02-12 05:53:35 +00001662 // Make blocks for the null-receiver and call edges.
1663 NullBB = CGF.createBasicBlock("msgSend.null-receiver");
1664 llvm::BasicBlock *callBB = CGF.createBasicBlock("msgSend.call");
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001665
1666 // Check for a null receiver and, if there is one, jump to the
John McCall3d1e2c92013-02-12 05:53:35 +00001667 // null-receiver block. There's no point in trying to avoid it:
1668 // we're always going to put *something* there, because otherwise
1669 // we shouldn't have done this null-check in the first place.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001670 llvm::Value *isNull = CGF.Builder.CreateIsNull(receiver);
1671 CGF.Builder.CreateCondBr(isNull, NullBB, callBB);
1672
1673 // Otherwise, start performing the call.
1674 CGF.EmitBlock(callBB);
1675 }
1676
John McCall3d1e2c92013-02-12 05:53:35 +00001677 /// Complete the null-return operation. It is valid to call this
1678 /// regardless of whether 'init' has been called.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001679 RValue complete(CodeGenFunction &CGF, RValue result, QualType resultType,
1680 const CallArgList &CallArgs,
1681 const ObjCMethodDecl *Method) {
John McCall3d1e2c92013-02-12 05:53:35 +00001682 // If we never had to do a null-check, just use the raw result.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001683 if (!NullBB) return result;
John McCall3d1e2c92013-02-12 05:53:35 +00001684
1685 // The continuation block. This will be left null if we don't have an
1686 // IP, which can happen if the method we're calling is marked noreturn.
Craig Topper8a13c412014-05-21 05:09:00 +00001687 llvm::BasicBlock *contBB = nullptr;
1688
John McCall3d1e2c92013-02-12 05:53:35 +00001689 // Finish the call path.
1690 llvm::BasicBlock *callBB = CGF.Builder.GetInsertBlock();
1691 if (callBB) {
1692 contBB = CGF.createBasicBlock("msgSend.cont");
1693 CGF.Builder.CreateBr(contBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001694 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001695
John McCall3d1e2c92013-02-12 05:53:35 +00001696 // Okay, start emitting the null-receiver block.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001697 CGF.EmitBlock(NullBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001698
John McCall3d1e2c92013-02-12 05:53:35 +00001699 // Release any consumed arguments we've got.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001700 if (Method) {
1701 CallArgList::const_iterator I = CallArgs.begin();
1702 for (ObjCMethodDecl::param_const_iterator i = Method->param_begin(),
1703 e = Method->param_end(); i != e; ++i, ++I) {
1704 const ParmVarDecl *ParamDecl = (*i);
1705 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
1706 RValue RV = I->RV;
1707 assert(RV.isScalar() &&
1708 "NullReturnState::complete - arg not on object");
John McCallcdda29c2013-03-13 03:10:54 +00001709 CGF.EmitARCRelease(RV.getScalarVal(), ARCImpreciseLifetime);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001710 }
1711 }
1712 }
John McCall3d1e2c92013-02-12 05:53:35 +00001713
1714 // The phi code below assumes that we haven't needed any control flow yet.
1715 assert(CGF.Builder.GetInsertBlock() == NullBB);
1716
1717 // If we've got a void return, just jump to the continuation block.
1718 if (result.isScalar() && resultType->isVoidType()) {
1719 // No jumps required if the message-send was noreturn.
1720 if (contBB) CGF.EmitBlock(contBB);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001721 return result;
1722 }
1723
John McCall3d1e2c92013-02-12 05:53:35 +00001724 // If we've got a scalar return, build a phi.
1725 if (result.isScalar()) {
1726 // Derive the null-initialization value.
1727 llvm::Constant *null = CGF.CGM.EmitNullConstant(resultType);
1728
1729 // If no join is necessary, just flow out.
1730 if (!contBB) return RValue::get(null);
1731
1732 // Otherwise, build a phi.
1733 CGF.EmitBlock(contBB);
1734 llvm::PHINode *phi = CGF.Builder.CreatePHI(null->getType(), 2);
1735 phi->addIncoming(result.getScalarVal(), callBB);
1736 phi->addIncoming(null, NullBB);
1737 return RValue::get(phi);
1738 }
1739
1740 // If we've got an aggregate return, null the buffer out.
1741 // FIXME: maybe we should be doing things differently for all the
1742 // cases where the ABI has us returning (1) non-agg values in
1743 // memory or (2) agg values in registers.
1744 if (result.isAggregate()) {
1745 assert(result.isAggregate() && "null init of non-aggregate result?");
John McCall7f416cc2015-09-08 08:05:57 +00001746 CGF.EmitNullInitialization(result.getAggregateAddress(), resultType);
John McCall3d1e2c92013-02-12 05:53:35 +00001747 if (contBB) CGF.EmitBlock(contBB);
1748 return result;
1749 }
1750
1751 // Complex types.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001752 CGF.EmitBlock(contBB);
John McCall3d1e2c92013-02-12 05:53:35 +00001753 CodeGenFunction::ComplexPairTy callResult = result.getComplexVal();
1754
1755 // Find the scalar type and its zero value.
1756 llvm::Type *scalarTy = callResult.first->getType();
1757 llvm::Constant *scalarZero = llvm::Constant::getNullValue(scalarTy);
1758
1759 // Build phis for both coordinates.
1760 llvm::PHINode *real = CGF.Builder.CreatePHI(scalarTy, 2);
1761 real->addIncoming(callResult.first, callBB);
1762 real->addIncoming(scalarZero, NullBB);
1763 llvm::PHINode *imag = CGF.Builder.CreatePHI(scalarTy, 2);
1764 imag->addIncoming(callResult.second, callBB);
1765 imag->addIncoming(scalarZero, NullBB);
1766 return RValue::getComplex(real, imag);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001767 }
1768};
1769
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001770} // end anonymous namespace
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001771
1772/* *** Helper Functions *** */
1773
1774/// getConstantGEP() - Help routine to construct simple GEPs.
Owen Anderson170229f2009-07-14 23:10:40 +00001775static llvm::Constant *getConstantGEP(llvm::LLVMContext &VMContext,
David Blaikiee3b172a2015-04-02 18:55:21 +00001776 llvm::GlobalVariable *C, unsigned idx0,
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001777 unsigned idx1) {
1778 llvm::Value *Idxs[] = {
Owen Anderson41a75022009-08-13 21:57:51 +00001779 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx0),
1780 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx1)
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001781 };
David Blaikiee3b172a2015-04-02 18:55:21 +00001782 return llvm::ConstantExpr::getGetElementPtr(C->getValueType(), C, Idxs);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001783}
1784
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001785/// hasObjCExceptionAttribute - Return true if this class or any super
1786/// class has the __objc_exception__ attribute.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001787static bool hasObjCExceptionAttribute(ASTContext &Context,
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001788 const ObjCInterfaceDecl *OID) {
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001789 if (OID->hasAttr<ObjCExceptionAttr>())
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001790 return true;
1791 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001792 return hasObjCExceptionAttribute(Context, Super);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001793 return false;
1794}
1795
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001796/* *** CGObjCMac Public Interface *** */
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001797
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001798CGObjCMac::CGObjCMac(CodeGen::CodeGenModule &cgm) : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00001799 ObjCTypes(cgm) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001800 ObjCABI = 1;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001801 EmitImageInfo();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001802}
1803
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001804/// GetClass - Return a reference to the class for the given interface
1805/// decl.
John McCall882987f2013-02-28 19:01:20 +00001806llvm::Value *CGObjCMac::GetClass(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001807 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00001808 return EmitClassRef(CGF, ID);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001809}
1810
1811/// GetSelector - Return the pointer to the unique'd string for this selector.
John McCall7f416cc2015-09-08 08:05:57 +00001812llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1813 return EmitSelector(CGF, Sel);
1814}
1815Address CGObjCMac::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1816 return EmitSelectorAddr(CGF, Sel);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001817}
John McCall882987f2013-02-28 19:01:20 +00001818llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, const ObjCMethodDecl
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001819 *Method) {
John McCall882987f2013-02-28 19:01:20 +00001820 return EmitSelector(CGF, Method->getSelector());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001821}
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001822
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001823llvm::Constant *CGObjCMac::GetEHType(QualType T) {
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001824 if (T->isObjCIdType() ||
1825 T->isObjCQualifiedIdType()) {
1826 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001827 CGM.getContext().getObjCIdRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001828 }
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001829 if (T->isObjCClassType() ||
1830 T->isObjCQualifiedClassType()) {
1831 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001832 CGM.getContext().getObjCClassRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001833 }
1834 if (T->isObjCObjectPointerType())
1835 return CGM.GetAddrOfRTTIDescriptor(T, /*ForEH=*/true);
1836
John McCall2ca705e2010-07-24 00:37:23 +00001837 llvm_unreachable("asking for catch type for ObjC type in fragile runtime");
John McCall2ca705e2010-07-24 00:37:23 +00001838}
1839
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001840/// Generate a constant CFString object.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001841/*
1842 struct __builtin_CFString {
1843 const int *isa; // point to __CFConstantStringClassReference
1844 int flags;
1845 const char *str;
1846 long length;
1847 };
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001848*/
1849
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001850/// or Generate a constant NSString object.
1851/*
1852 struct __builtin_NSString {
1853 const int *isa; // point to __NSConstantStringClassReference
1854 const char *str;
1855 unsigned int length;
1856 };
1857*/
1858
John McCallcd21d542016-11-30 23:15:55 +00001859ConstantAddress
1860CGObjCCommonMac::GenerateConstantString(const StringLiteral *SL) {
1861 return (!CGM.getLangOpts().NoConstantCFStrings
1862 ? CGM.GetAddrOfConstantCFString(SL)
1863 : GenerateConstantNSString(SL));
1864}
1865
1866static llvm::StringMapEntry<llvm::GlobalVariable *> &
1867GetConstantStringEntry(llvm::StringMap<llvm::GlobalVariable *> &Map,
1868 const StringLiteral *Literal, unsigned &StringLength) {
1869 StringRef String = Literal->getString();
1870 StringLength = String.size();
1871 return *Map.insert(std::make_pair(String, nullptr)).first;
1872}
1873
1874llvm::Constant *CGObjCMac::getNSConstantStringClassRef() {
1875 if (llvm::Value *V = ConstantStringClassRef)
1876 return cast<llvm::Constant>(V);
1877
1878 auto &StringClass = CGM.getLangOpts().ObjCConstantStringClass;
1879 std::string str =
1880 StringClass.empty() ? "_NSConstantStringClassReference"
1881 : "_" + StringClass + "ClassReference";
1882
1883 llvm::Type *PTy = llvm::ArrayType::get(CGM.IntTy, 0);
1884 auto GV = CGM.CreateRuntimeVariable(PTy, str);
1885 auto V = llvm::ConstantExpr::getBitCast(GV, CGM.IntTy->getPointerTo());
1886 ConstantStringClassRef = V;
1887 return V;
1888}
1889
1890llvm::Constant *CGObjCNonFragileABIMac::getNSConstantStringClassRef() {
1891 if (llvm::Value *V = ConstantStringClassRef)
1892 return cast<llvm::Constant>(V);
1893
1894 auto &StringClass = CGM.getLangOpts().ObjCConstantStringClass;
1895 std::string str =
1896 StringClass.empty() ? "OBJC_CLASS_$_NSConstantString"
1897 : "OBJC_CLASS_$_" + StringClass;
John McCalldba63a72016-11-30 23:54:50 +00001898 auto GV = GetClassGlobal(str, NotForDefinition);
John McCallcd21d542016-11-30 23:15:55 +00001899
1900 // Make sure the result is of the correct type.
1901 auto V = llvm::ConstantExpr::getBitCast(GV, CGM.IntTy->getPointerTo());
1902
1903 ConstantStringClassRef = V;
1904 return V;
1905}
1906
1907ConstantAddress
1908CGObjCCommonMac::GenerateConstantNSString(const StringLiteral *Literal) {
1909 unsigned StringLength = 0;
1910 llvm::StringMapEntry<llvm::GlobalVariable *> &Entry =
1911 GetConstantStringEntry(NSConstantStringMap, Literal, StringLength);
1912
1913 if (auto *C = Entry.second)
1914 return ConstantAddress(C, CharUnits::fromQuantity(C->getAlignment()));
1915
1916 // If we don't already have it, get _NSConstantStringClassReference.
1917 llvm::Constant *Class = getNSConstantStringClassRef();
1918
1919 // If we don't already have it, construct the type for a constant NSString.
1920 if (!NSConstantStringType) {
1921 NSConstantStringType =
1922 llvm::StructType::create({
1923 CGM.Int32Ty->getPointerTo(),
1924 CGM.Int8PtrTy,
1925 CGM.IntTy
1926 }, "struct.__builtin_NSString");
1927 }
1928
1929 ConstantInitBuilder Builder(CGM);
1930 auto Fields = Builder.beginStruct(NSConstantStringType);
1931
1932 // Class pointer.
1933 Fields.add(Class);
1934
1935 // String pointer.
1936 llvm::Constant *C =
1937 llvm::ConstantDataArray::getString(VMContext, Entry.first());
1938
1939 llvm::GlobalValue::LinkageTypes Linkage = llvm::GlobalValue::PrivateLinkage;
1940 bool isConstant = !CGM.getLangOpts().WritableStrings;
1941
1942 auto *GV = new llvm::GlobalVariable(CGM.getModule(), C->getType(), isConstant,
1943 Linkage, C, ".str");
1944 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1945 // Don't enforce the target's minimum global alignment, since the only use
1946 // of the string is via this class initializer.
1947 GV->setAlignment(1);
1948 Fields.addBitCast(GV, CGM.Int8PtrTy);
1949
1950 // String length.
1951 Fields.addInt(CGM.IntTy, StringLength);
1952
1953 // The struct.
1954 CharUnits Alignment = CGM.getPointerAlign();
1955 GV = Fields.finishAndCreateGlobal("_unnamed_nsstring_", Alignment,
1956 /*constant*/ true,
1957 llvm::GlobalVariable::PrivateLinkage);
1958 const char *NSStringSection = "__OBJC,__cstring_object,regular,no_dead_strip";
1959 const char *NSStringNonFragileABISection =
1960 "__DATA,__objc_stringobj,regular,no_dead_strip";
1961 // FIXME. Fix section.
1962 GV->setSection(CGM.getLangOpts().ObjCRuntime.isNonFragile()
1963 ? NSStringNonFragileABISection
1964 : NSStringSection);
1965 Entry.second = GV;
1966
1967 return ConstantAddress(GV, Alignment);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001968}
1969
Ted Kremeneke65b0862012-03-06 20:05:56 +00001970enum {
1971 kCFTaggedObjectID_Integer = (1 << 1) + 1
1972};
1973
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001974/// Generates a message send where the super is the receiver. This is
1975/// a message send to self with special delivery semantics indicating
1976/// which class's method should be called.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001977CodeGen::RValue
1978CGObjCMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001979 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001980 QualType ResultType,
1981 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001982 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001983 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001984 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00001985 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00001986 const CodeGen::CallArgList &CallArgs,
1987 const ObjCMethodDecl *Method) {
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001988 // Create and init a super structure; this is a (receiver, class)
1989 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00001990 Address ObjCSuper =
1991 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
1992 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001993 llvm::Value *ReceiverAsObject =
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001994 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00001995 CGF.Builder.CreateStore(
1996 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00001997 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00001998
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001999 // If this is a class message the metaclass is passed as the target.
2000 llvm::Value *Target;
2001 if (IsClassMessage) {
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00002002 if (isCategoryImpl) {
2003 // Message sent to 'super' in a class method defined in a category
2004 // implementation requires an odd treatment.
2005 // If we are in a class method, we must retrieve the
2006 // _metaclass_ for the current class, pointed at by
2007 // the class's "isa" pointer. The following assumes that
2008 // isa" is the first ivar in a class (which it must be).
John McCall882987f2013-02-28 19:01:20 +00002009 Target = EmitClassRef(CGF, Class->getSuperClass());
David Blaikie1ed728c2015-04-05 22:45:47 +00002010 Target = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, Target, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002011 Target = CGF.Builder.CreateAlignedLoad(Target, CGF.getPointerAlign());
Mike Stump658fe022009-07-30 22:28:39 +00002012 } else {
David Blaikie1ed728c2015-04-05 22:45:47 +00002013 llvm::Constant *MetaClassPtr = EmitMetaClassRef(Class);
2014 llvm::Value *SuperPtr =
2015 CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, MetaClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00002016 llvm::Value *Super =
2017 CGF.Builder.CreateAlignedLoad(SuperPtr, CGF.getPointerAlign());
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00002018 Target = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002019 }
David Blaikie1ed728c2015-04-05 22:45:47 +00002020 } else if (isCategoryImpl)
John McCall882987f2013-02-28 19:01:20 +00002021 Target = EmitClassRef(CGF, Class->getSuperClass());
Fariborz Jahanianda2efb02009-11-14 02:18:31 +00002022 else {
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00002023 llvm::Value *ClassPtr = EmitSuperClassRef(Class);
David Blaikie1ed728c2015-04-05 22:45:47 +00002024 ClassPtr = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, ClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00002025 Target = CGF.Builder.CreateAlignedLoad(ClassPtr, CGF.getPointerAlign());
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002026 }
Mike Stump18bb9282009-05-16 07:57:57 +00002027 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
2028 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00002029 llvm::Type *ClassTy =
Daniel Dunbarc722b852008-08-30 03:02:31 +00002030 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
Daniel Dunbarc475d422008-10-29 22:36:39 +00002031 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
John McCall7f416cc2015-09-08 08:05:57 +00002032 CGF.Builder.CreateStore(Target,
2033 CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
John McCall9e8bb002011-05-14 03:10:52 +00002034 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00002035 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00002036 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00002037 true, CallArgs, Method, Class, ObjCTypes);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002038}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002039
2040/// Generate code for a message send expression.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00002041CodeGen::RValue CGObjCMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00002042 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002043 QualType ResultType,
2044 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002045 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002046 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00002047 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002048 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00002049 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00002050 EmitSelector(CGF, Sel),
John McCall9e8bb002011-05-14 03:10:52 +00002051 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00002052 false, CallArgs, Method, Class, ObjCTypes);
2053}
2054
2055static bool isWeakLinkedClass(const ObjCInterfaceDecl *ID) {
2056 do {
2057 if (ID->isWeakImported())
2058 return true;
2059 } while ((ID = ID->getSuperClass()));
2060
2061 return false;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00002062}
2063
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00002064CodeGen::RValue
John McCall9e8bb002011-05-14 03:10:52 +00002065CGObjCCommonMac::EmitMessageSend(CodeGen::CodeGenFunction &CGF,
2066 ReturnValueSlot Return,
2067 QualType ResultType,
2068 llvm::Value *Sel,
2069 llvm::Value *Arg0,
2070 QualType Arg0Ty,
2071 bool IsSuper,
2072 const CallArgList &CallArgs,
2073 const ObjCMethodDecl *Method,
John McCall1e3157b2015-09-10 22:27:50 +00002074 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00002075 const ObjCCommonTypesHelper &ObjCTypes) {
Daniel Dunbarc722b852008-08-30 03:02:31 +00002076 CallArgList ActualArgs;
Fariborz Jahanian969bc682009-04-24 21:07:43 +00002077 if (!IsSuper)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00002078 Arg0 = CGF.Builder.CreateBitCast(Arg0, ObjCTypes.ObjectPtrTy);
Eli Friedman43dca6a2011-05-02 17:57:46 +00002079 ActualArgs.add(RValue::get(Arg0), Arg0Ty);
2080 ActualArgs.add(RValue::get(Sel), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00002081 ActualArgs.addFrom(CallArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002082
John McCalla729c622012-02-17 03:33:10 +00002083 // If we're calling a method, use the formal signature.
2084 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002085
Anders Carlsson280e61f12010-06-21 20:59:55 +00002086 if (Method)
Alp Toker314cc812014-01-25 16:55:45 +00002087 assert(CGM.getContext().getCanonicalType(Method->getReturnType()) ==
2088 CGM.getContext().getCanonicalType(ResultType) &&
Anders Carlsson280e61f12010-06-21 20:59:55 +00002089 "Result type mismatch!");
2090
John McCall1e3157b2015-09-10 22:27:50 +00002091 bool ReceiverCanBeNull = true;
2092
2093 // Super dispatch assumes that self is non-null; even the messenger
2094 // doesn't have a null check internally.
2095 if (IsSuper) {
2096 ReceiverCanBeNull = false;
2097
2098 // If this is a direct dispatch of a class method, check whether the class,
2099 // or anything in its hierarchy, was weak-linked.
2100 } else if (ClassReceiver && Method && Method->isClassMethod()) {
2101 ReceiverCanBeNull = isWeakLinkedClass(ClassReceiver);
2102
2103 // If we're emitting a method, and self is const (meaning just ARC, for now),
2104 // and the receiver is a load of self, then self is a valid object.
2105 } else if (auto CurMethod =
2106 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl)) {
2107 auto Self = CurMethod->getSelfDecl();
2108 if (Self->getType().isConstQualified()) {
2109 if (auto LI = dyn_cast<llvm::LoadInst>(Arg0->stripPointerCasts())) {
2110 llvm::Value *SelfAddr = CGF.GetAddrOfLocalVar(Self).getPointer();
2111 if (SelfAddr == LI->getPointerOperand()) {
2112 ReceiverCanBeNull = false;
2113 }
2114 }
2115 }
2116 }
2117
John McCall5880fb82011-05-14 21:12:11 +00002118 NullReturnState nullReturn;
2119
Craig Topper8a13c412014-05-21 05:09:00 +00002120 llvm::Constant *Fn = nullptr;
Tim Northovere77cc392014-03-29 13:28:05 +00002121 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall1e3157b2015-09-10 22:27:50 +00002122 if (ReceiverCanBeNull) nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00002123 Fn = (ObjCABI == 2) ? ObjCTypes.getSendStretFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002124 : ObjCTypes.getSendStretFn(IsSuper);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00002125 } else if (CGM.ReturnTypeUsesFPRet(ResultType)) {
2126 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFpretFn2(IsSuper)
2127 : ObjCTypes.getSendFpretFn(IsSuper);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00002128 } else if (CGM.ReturnTypeUsesFP2Ret(ResultType)) {
2129 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFp2RetFn2(IsSuper)
2130 : ObjCTypes.getSendFp2retFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00002131 } else {
Tim Northovere77cc392014-03-29 13:28:05 +00002132 // arm64 uses objc_msgSend for stret methods and yet null receiver check
2133 // must be made for it.
Ahmed Bougachaa3df87b2015-10-02 22:41:59 +00002134 if (ReceiverCanBeNull && CGM.ReturnTypeUsesSRet(MSI.CallInfo))
Tim Northovere77cc392014-03-29 13:28:05 +00002135 nullReturn.init(CGF, Arg0);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00002136 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002137 : ObjCTypes.getSendFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00002138 }
John McCall1e3157b2015-09-10 22:27:50 +00002139
2140 // Emit a null-check if there's a consumed argument other than the receiver.
2141 bool RequiresNullCheck = false;
2142 if (ReceiverCanBeNull && CGM.getLangOpts().ObjCAutoRefCount && Method) {
David Majnemer59f77922016-06-24 04:05:48 +00002143 for (const auto *ParamDecl : Method->parameters()) {
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00002144 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
2145 if (!nullReturn.NullBB)
2146 nullReturn.init(CGF, Arg0);
John McCall1e3157b2015-09-10 22:27:50 +00002147 RequiresNullCheck = true;
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00002148 break;
2149 }
2150 }
John McCall1e3157b2015-09-10 22:27:50 +00002151 }
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00002152
John McCall1e3157b2015-09-10 22:27:50 +00002153 llvm::Instruction *CallSite;
John McCalla729c622012-02-17 03:33:10 +00002154 Fn = llvm::ConstantExpr::getBitCast(Fn, MSI.MessengerType);
John McCallb92ab1a2016-10-26 23:46:34 +00002155 CGCallee Callee = CGCallee::forDirect(Fn);
2156 RValue rvalue = CGF.EmitCall(MSI.CallInfo, Callee, Return, ActualArgs,
2157 &CallSite);
John McCall1e3157b2015-09-10 22:27:50 +00002158
2159 // Mark the call as noreturn if the method is marked noreturn and the
2160 // receiver cannot be null.
2161 if (Method && Method->hasAttr<NoReturnAttr>() && !ReceiverCanBeNull) {
2162 llvm::CallSite(CallSite).setDoesNotReturn();
2163 }
2164
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00002165 return nullReturn.complete(CGF, rvalue, ResultType, CallArgs,
John McCall1e3157b2015-09-10 22:27:50 +00002166 RequiresNullCheck ? Method : nullptr);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002167}
2168
John McCall3fd13f062015-10-21 18:06:47 +00002169static Qualifiers::GC GetGCAttrTypeForType(ASTContext &Ctx, QualType FQT,
2170 bool pointee = false) {
2171 // Note that GC qualification applies recursively to C pointer types
2172 // that aren't otherwise decorated. This is weird, but it's probably
2173 // an intentional workaround to the unreliable placement of GC qualifiers.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002174 if (FQT.isObjCGCStrong())
2175 return Qualifiers::Strong;
John McCall3fd13f062015-10-21 18:06:47 +00002176
2177 if (FQT.isObjCGCWeak())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002178 return Qualifiers::Weak;
John McCall3fd13f062015-10-21 18:06:47 +00002179
2180 if (auto ownership = FQT.getObjCLifetime()) {
2181 // Ownership does not apply recursively to C pointer types.
2182 if (pointee) return Qualifiers::GCNone;
2183 switch (ownership) {
2184 case Qualifiers::OCL_Weak: return Qualifiers::Weak;
2185 case Qualifiers::OCL_Strong: return Qualifiers::Strong;
2186 case Qualifiers::OCL_ExplicitNone: return Qualifiers::GCNone;
2187 case Qualifiers::OCL_Autoreleasing: llvm_unreachable("autoreleasing ivar?");
2188 case Qualifiers::OCL_None: llvm_unreachable("known nonzero");
2189 }
2190 llvm_unreachable("bad objc ownership");
2191 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002192
John McCall3fd13f062015-10-21 18:06:47 +00002193 // Treat unqualified retainable pointers as strong.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002194 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
2195 return Qualifiers::Strong;
2196
John McCall3fd13f062015-10-21 18:06:47 +00002197 // Walk into C pointer types, but only in GC.
2198 if (Ctx.getLangOpts().getGC() != LangOptions::NonGC) {
2199 if (const PointerType *PT = FQT->getAs<PointerType>())
2200 return GetGCAttrTypeForType(Ctx, PT->getPointeeType(), /*pointee*/ true);
2201 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002202
2203 return Qualifiers::GCNone;
2204}
2205
John McCall3fd13f062015-10-21 18:06:47 +00002206namespace {
2207 struct IvarInfo {
2208 CharUnits Offset;
2209 uint64_t SizeInWords;
2210 IvarInfo(CharUnits offset, uint64_t sizeInWords)
2211 : Offset(offset), SizeInWords(sizeInWords) {}
2212
2213 // Allow sorting based on byte pos.
2214 bool operator<(const IvarInfo &other) const {
2215 return Offset < other.Offset;
2216 }
2217 };
2218
2219 /// A helper class for building GC layout strings.
2220 class IvarLayoutBuilder {
2221 CodeGenModule &CGM;
2222
2223 /// The start of the layout. Offsets will be relative to this value,
2224 /// and entries less than this value will be silently discarded.
2225 CharUnits InstanceBegin;
2226
2227 /// The end of the layout. Offsets will never exceed this value.
2228 CharUnits InstanceEnd;
2229
2230 /// Whether we're generating the strong layout or the weak layout.
2231 bool ForStrongLayout;
2232
2233 /// Whether the offsets in IvarsInfo might be out-of-order.
2234 bool IsDisordered = false;
2235
2236 llvm::SmallVector<IvarInfo, 8> IvarsInfo;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002237
John McCall3fd13f062015-10-21 18:06:47 +00002238 public:
2239 IvarLayoutBuilder(CodeGenModule &CGM, CharUnits instanceBegin,
2240 CharUnits instanceEnd, bool forStrongLayout)
2241 : CGM(CGM), InstanceBegin(instanceBegin), InstanceEnd(instanceEnd),
2242 ForStrongLayout(forStrongLayout) {
2243 }
2244
2245 void visitRecord(const RecordType *RT, CharUnits offset);
2246
2247 template <class Iterator, class GetOffsetFn>
2248 void visitAggregate(Iterator begin, Iterator end,
2249 CharUnits aggrOffset,
2250 const GetOffsetFn &getOffset);
2251
2252 void visitField(const FieldDecl *field, CharUnits offset);
2253
2254 /// Add the layout of a block implementation.
2255 void visitBlock(const CGBlockInfo &blockInfo);
2256
2257 /// Is there any information for an interesting bitmap?
2258 bool hasBitmapData() const { return !IvarsInfo.empty(); }
2259
2260 llvm::Constant *buildBitmap(CGObjCCommonMac &CGObjC,
2261 llvm::SmallVectorImpl<unsigned char> &buffer);
2262
2263 static void dump(ArrayRef<unsigned char> buffer) {
2264 const unsigned char *s = buffer.data();
2265 for (unsigned i = 0, e = buffer.size(); i < e; i++)
2266 if (!(s[i] & 0xf0))
2267 printf("0x0%x%s", s[i], s[i] != 0 ? ", " : "");
2268 else
2269 printf("0x%x%s", s[i], s[i] != 0 ? ", " : "");
2270 printf("\n");
2271 }
2272 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002273} // end anonymous namespace
John McCall3fd13f062015-10-21 18:06:47 +00002274
John McCall351762c2011-02-07 10:33:21 +00002275llvm::Constant *CGObjCCommonMac::BuildGCBlockLayout(CodeGenModule &CGM,
2276 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002277
Chris Lattnerece04092012-02-07 00:39:47 +00002278 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
John McCall460ce582015-10-22 18:38:17 +00002279 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
John McCall351762c2011-02-07 10:33:21 +00002280 return nullPtr;
2281
John McCall3fd13f062015-10-21 18:06:47 +00002282 IvarLayoutBuilder builder(CGM, CharUnits::Zero(), blockInfo.BlockSize,
2283 /*for strong layout*/ true);
2284
2285 builder.visitBlock(blockInfo);
2286
2287 if (!builder.hasBitmapData())
2288 return nullPtr;
2289
2290 llvm::SmallVector<unsigned char, 32> buffer;
2291 llvm::Constant *C = builder.buildBitmap(*this, buffer);
John McCallf5ea0722015-10-29 23:36:14 +00002292 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
John McCall3fd13f062015-10-21 18:06:47 +00002293 printf("\n block variable layout for block: ");
2294 builder.dump(buffer);
2295 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002296
John McCall3fd13f062015-10-21 18:06:47 +00002297 return C;
2298}
2299
2300void IvarLayoutBuilder::visitBlock(const CGBlockInfo &blockInfo) {
Fariborz Jahaniancfddabf2010-09-09 00:21:45 +00002301 // __isa is the first field in block descriptor and must assume by runtime's
2302 // convention that it is GC'able.
John McCall3fd13f062015-10-21 18:06:47 +00002303 IvarsInfo.push_back(IvarInfo(CharUnits::Zero(), 1));
John McCall351762c2011-02-07 10:33:21 +00002304
2305 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2306
John McCall351762c2011-02-07 10:33:21 +00002307 // Ignore the optional 'this' capture: C++ objects are not assumed
2308 // to be GC'ed.
2309
John McCall3fd13f062015-10-21 18:06:47 +00002310 CharUnits lastFieldOffset;
2311
John McCall351762c2011-02-07 10:33:21 +00002312 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002313 for (const auto &CI : blockDecl->captures()) {
2314 const VarDecl *variable = CI.getVariable();
John McCall351762c2011-02-07 10:33:21 +00002315 QualType type = variable->getType();
2316
2317 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2318
2319 // Ignore constant captures.
2320 if (capture.isConstant()) continue;
2321
John McCall3fd13f062015-10-21 18:06:47 +00002322 CharUnits fieldOffset = capture.getOffset();
2323
2324 // Block fields are not necessarily ordered; if we detect that we're
2325 // adding them out-of-order, make sure we sort later.
2326 if (fieldOffset < lastFieldOffset)
2327 IsDisordered = true;
2328 lastFieldOffset = fieldOffset;
John McCall351762c2011-02-07 10:33:21 +00002329
2330 // __block variables are passed by their descriptor address.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002331 if (CI.isByRef()) {
John McCall3fd13f062015-10-21 18:06:47 +00002332 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
Fariborz Jahanian933c6722010-09-11 01:27:29 +00002333 continue;
John McCall351762c2011-02-07 10:33:21 +00002334 }
2335
2336 assert(!type->isArrayType() && "array variable should not be caught");
2337 if (const RecordType *record = type->getAs<RecordType>()) {
John McCall3fd13f062015-10-21 18:06:47 +00002338 visitRecord(record, fieldOffset);
Fariborz Jahanian903aba32010-08-05 21:00:25 +00002339 continue;
2340 }
Fariborz Jahanianf95e3582010-08-06 16:28:55 +00002341
John McCall351762c2011-02-07 10:33:21 +00002342 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), type);
John McCall351762c2011-02-07 10:33:21 +00002343
John McCall3fd13f062015-10-21 18:06:47 +00002344 if (GCAttr == Qualifiers::Strong) {
2345 assert(CGM.getContext().getTypeSize(type)
2346 == CGM.getTarget().getPointerWidth(0));
2347 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
2348 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002349 }
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00002350}
2351
Fariborz Jahanian2c96d302012-11-04 18:19:40 +00002352/// getBlockCaptureLifetime - This routine returns life time of the captured
2353/// block variable for the purpose of block layout meta-data generation. FQT is
2354/// the type of the variable captured in the block.
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002355Qualifiers::ObjCLifetime CGObjCCommonMac::getBlockCaptureLifetime(QualType FQT,
2356 bool ByrefLayout) {
John McCall460ce582015-10-22 18:38:17 +00002357 // If it has an ownership qualifier, we're done.
2358 if (auto lifetime = FQT.getObjCLifetime())
2359 return lifetime;
2360
2361 // If it doesn't, and this is ARC, it has no ownership.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002362 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall460ce582015-10-22 18:38:17 +00002363 return Qualifiers::OCL_None;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002364
John McCall460ce582015-10-22 18:38:17 +00002365 // In MRC, retainable pointers are owned by non-__block variables.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002366 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002367 return ByrefLayout ? Qualifiers::OCL_ExplicitNone : Qualifiers::OCL_Strong;
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002368
2369 return Qualifiers::OCL_None;
2370}
2371
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002372void CGObjCCommonMac::UpdateRunSkipBlockVars(bool IsByref,
2373 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002374 CharUnits FieldOffset,
2375 CharUnits FieldSize) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002376 // __block variables are passed by their descriptor address.
2377 if (IsByref)
2378 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_BYREF, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002379 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002380 else if (LifeTime == Qualifiers::OCL_Strong)
2381 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_STRONG, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002382 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002383 else if (LifeTime == Qualifiers::OCL_Weak)
2384 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_WEAK, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002385 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002386 else if (LifeTime == Qualifiers::OCL_ExplicitNone)
2387 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_UNRETAINED, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002388 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002389 else
2390 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_NON_OBJECT_BYTES,
2391 FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002392 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002393}
2394
2395void CGObjCCommonMac::BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
2396 const RecordDecl *RD,
2397 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002398 CharUnits BytePos, bool &HasUnion,
2399 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002400 bool IsUnion = (RD && RD->isUnion());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002401 CharUnits MaxUnionSize = CharUnits::Zero();
Craig Topper8a13c412014-05-21 05:09:00 +00002402 const FieldDecl *MaxField = nullptr;
2403 const FieldDecl *LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002404 CharUnits MaxFieldOffset = CharUnits::Zero();
2405 CharUnits LastBitfieldOrUnnamedOffset = CharUnits::Zero();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002406
2407 if (RecFields.empty())
2408 return;
John McCallc8e01702013-04-16 22:48:15 +00002409 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002410
2411 for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
2412 const FieldDecl *Field = RecFields[i];
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002413 // Note that 'i' here is actually the field index inside RD of Field,
2414 // although this dependency is hidden.
2415 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002416 CharUnits FieldOffset =
2417 CGM.getContext().toCharUnitsFromBits(RL.getFieldOffset(i));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002418
2419 // Skip over unnamed or bitfields
2420 if (!Field->getIdentifier() || Field->isBitField()) {
2421 LastFieldBitfieldOrUnnamed = Field;
2422 LastBitfieldOrUnnamedOffset = FieldOffset;
2423 continue;
2424 }
Craig Topper8a13c412014-05-21 05:09:00 +00002425
2426 LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002427 QualType FQT = Field->getType();
2428 if (FQT->isRecordType() || FQT->isUnionType()) {
2429 if (FQT->isUnionType())
2430 HasUnion = true;
2431
2432 BuildRCBlockVarRecordLayout(FQT->getAs<RecordType>(),
2433 BytePos + FieldOffset, HasUnion);
2434 continue;
2435 }
2436
2437 if (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2438 const ConstantArrayType *CArray =
2439 dyn_cast_or_null<ConstantArrayType>(Array);
2440 uint64_t ElCount = CArray->getSize().getZExtValue();
2441 assert(CArray && "only array with known element size is supported");
2442 FQT = CArray->getElementType();
2443 while (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2444 const ConstantArrayType *CArray =
2445 dyn_cast_or_null<ConstantArrayType>(Array);
2446 ElCount *= CArray->getSize().getZExtValue();
2447 FQT = CArray->getElementType();
2448 }
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002449 if (FQT->isRecordType() && ElCount) {
2450 int OldIndex = RunSkipBlockVars.size() - 1;
2451 const RecordType *RT = FQT->getAs<RecordType>();
2452 BuildRCBlockVarRecordLayout(RT, BytePos + FieldOffset,
2453 HasUnion);
2454
2455 // Replicate layout information for each array element. Note that
2456 // one element is already done.
2457 uint64_t ElIx = 1;
2458 for (int FirstIndex = RunSkipBlockVars.size() - 1 ;ElIx < ElCount; ElIx++) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002459 CharUnits Size = CGM.getContext().getTypeSizeInChars(RT);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002460 for (int i = OldIndex+1; i <= FirstIndex; ++i)
2461 RunSkipBlockVars.push_back(
2462 RUN_SKIP(RunSkipBlockVars[i].opcode,
2463 RunSkipBlockVars[i].block_var_bytepos + Size*ElIx,
2464 RunSkipBlockVars[i].block_var_size));
2465 }
2466 continue;
2467 }
2468 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002469 CharUnits FieldSize = CGM.getContext().getTypeSizeInChars(Field->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002470 if (IsUnion) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002471 CharUnits UnionIvarSize = FieldSize;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002472 if (UnionIvarSize > MaxUnionSize) {
2473 MaxUnionSize = UnionIvarSize;
2474 MaxField = Field;
2475 MaxFieldOffset = FieldOffset;
2476 }
2477 } else {
2478 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002479 getBlockCaptureLifetime(FQT, ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002480 BytePos + FieldOffset,
2481 FieldSize);
2482 }
2483 }
2484
2485 if (LastFieldBitfieldOrUnnamed) {
2486 if (LastFieldBitfieldOrUnnamed->isBitField()) {
2487 // Last field was a bitfield. Must update the info.
2488 uint64_t BitFieldSize
2489 = LastFieldBitfieldOrUnnamed->getBitWidthValue(CGM.getContext());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002490 unsigned UnsSize = (BitFieldSize / ByteSizeInBits) +
Eli Friedman8cbca202012-11-06 22:15:52 +00002491 ((BitFieldSize % ByteSizeInBits) != 0);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002492 CharUnits Size = CharUnits::fromQuantity(UnsSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002493 Size += LastBitfieldOrUnnamedOffset;
2494 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002495 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2496 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002497 BytePos + LastBitfieldOrUnnamedOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002498 Size);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002499 } else {
2500 assert(!LastFieldBitfieldOrUnnamed->getIdentifier() &&"Expected unnamed");
2501 // Last field was unnamed. Must update skip info.
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002502 CharUnits FieldSize
2503 = CGM.getContext().getTypeSizeInChars(LastFieldBitfieldOrUnnamed->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002504 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002505 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2506 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002507 BytePos + LastBitfieldOrUnnamedOffset,
2508 FieldSize);
2509 }
2510 }
2511
2512 if (MaxField)
2513 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002514 getBlockCaptureLifetime(MaxField->getType(), ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002515 BytePos + MaxFieldOffset,
2516 MaxUnionSize);
2517}
2518
2519void CGObjCCommonMac::BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002520 CharUnits BytePos,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002521 bool &HasUnion,
2522 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002523 const RecordDecl *RD = RT->getDecl();
Aaron Ballman62e47c42014-03-10 13:43:55 +00002524 SmallVector<const FieldDecl*, 16> Fields(RD->fields());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002525 llvm::Type *Ty = CGM.getTypes().ConvertType(QualType(RT, 0));
2526 const llvm::StructLayout *RecLayout =
2527 CGM.getDataLayout().getStructLayout(cast<llvm::StructType>(Ty));
2528
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002529 BuildRCRecordLayout(RecLayout, RD, Fields, BytePos, HasUnion, ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002530}
2531
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002532/// InlineLayoutInstruction - This routine produce an inline instruction for the
2533/// block variable layout if it can. If not, it returns 0. Rules are as follow:
2534/// If ((uintptr_t) layout) < (1 << 12), the layout is inline. In the 64bit world,
2535/// an inline layout of value 0x0000000000000xyz is interpreted as follows:
2536/// x captured object pointers of BLOCK_LAYOUT_STRONG. Followed by
2537/// y captured object of BLOCK_LAYOUT_BYREF. Followed by
2538/// z captured object of BLOCK_LAYOUT_WEAK. If any of the above is missing, zero
2539/// replaces it. For example, 0x00000x00 means x BLOCK_LAYOUT_STRONG and no
2540/// BLOCK_LAYOUT_BYREF and no BLOCK_LAYOUT_WEAK objects are captured.
2541uint64_t CGObjCCommonMac::InlineLayoutInstruction(
2542 SmallVectorImpl<unsigned char> &Layout) {
2543 uint64_t Result = 0;
2544 if (Layout.size() <= 3) {
2545 unsigned size = Layout.size();
2546 unsigned strong_word_count = 0, byref_word_count=0, weak_word_count=0;
2547 unsigned char inst;
2548 enum BLOCK_LAYOUT_OPCODE opcode ;
2549 switch (size) {
2550 case 3:
2551 inst = Layout[0];
2552 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2553 if (opcode == BLOCK_LAYOUT_STRONG)
2554 strong_word_count = (inst & 0xF)+1;
2555 else
2556 return 0;
2557 inst = Layout[1];
2558 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2559 if (opcode == BLOCK_LAYOUT_BYREF)
2560 byref_word_count = (inst & 0xF)+1;
2561 else
2562 return 0;
2563 inst = Layout[2];
2564 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2565 if (opcode == BLOCK_LAYOUT_WEAK)
2566 weak_word_count = (inst & 0xF)+1;
2567 else
2568 return 0;
2569 break;
2570
2571 case 2:
2572 inst = Layout[0];
2573 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2574 if (opcode == BLOCK_LAYOUT_STRONG) {
2575 strong_word_count = (inst & 0xF)+1;
2576 inst = Layout[1];
2577 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2578 if (opcode == BLOCK_LAYOUT_BYREF)
2579 byref_word_count = (inst & 0xF)+1;
2580 else if (opcode == BLOCK_LAYOUT_WEAK)
2581 weak_word_count = (inst & 0xF)+1;
2582 else
2583 return 0;
2584 }
2585 else if (opcode == BLOCK_LAYOUT_BYREF) {
2586 byref_word_count = (inst & 0xF)+1;
2587 inst = Layout[1];
2588 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2589 if (opcode == BLOCK_LAYOUT_WEAK)
2590 weak_word_count = (inst & 0xF)+1;
2591 else
2592 return 0;
2593 }
2594 else
2595 return 0;
2596 break;
2597
2598 case 1:
2599 inst = Layout[0];
2600 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2601 if (opcode == BLOCK_LAYOUT_STRONG)
2602 strong_word_count = (inst & 0xF)+1;
2603 else if (opcode == BLOCK_LAYOUT_BYREF)
2604 byref_word_count = (inst & 0xF)+1;
2605 else if (opcode == BLOCK_LAYOUT_WEAK)
2606 weak_word_count = (inst & 0xF)+1;
2607 else
2608 return 0;
2609 break;
2610
2611 default:
2612 return 0;
2613 }
2614
2615 // Cannot inline when any of the word counts is 15. Because this is one less
2616 // than the actual work count (so 15 means 16 actual word counts),
2617 // and we can only display 0 thru 15 word counts.
2618 if (strong_word_count == 16 || byref_word_count == 16 || weak_word_count == 16)
2619 return 0;
2620
2621 unsigned count =
2622 (strong_word_count != 0) + (byref_word_count != 0) + (weak_word_count != 0);
2623
2624 if (size == count) {
2625 if (strong_word_count)
2626 Result = strong_word_count;
2627 Result <<= 4;
2628 if (byref_word_count)
2629 Result += byref_word_count;
2630 Result <<= 4;
2631 if (weak_word_count)
2632 Result += weak_word_count;
2633 }
2634 }
2635 return Result;
2636}
2637
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002638llvm::Constant *CGObjCCommonMac::getBitmapBlockLayout(bool ComputeByrefLayout) {
2639 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2640 if (RunSkipBlockVars.empty())
2641 return nullPtr;
John McCallc8e01702013-04-16 22:48:15 +00002642 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2643 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002644 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2645
2646 // Sort on byte position; captures might not be allocated in order,
2647 // and unions can do funny things.
2648 llvm::array_pod_sort(RunSkipBlockVars.begin(), RunSkipBlockVars.end());
2649 SmallVector<unsigned char, 16> Layout;
2650
2651 unsigned size = RunSkipBlockVars.size();
2652 for (unsigned i = 0; i < size; i++) {
2653 enum BLOCK_LAYOUT_OPCODE opcode = RunSkipBlockVars[i].opcode;
2654 CharUnits start_byte_pos = RunSkipBlockVars[i].block_var_bytepos;
2655 CharUnits end_byte_pos = start_byte_pos;
2656 unsigned j = i+1;
2657 while (j < size) {
2658 if (opcode == RunSkipBlockVars[j].opcode) {
2659 end_byte_pos = RunSkipBlockVars[j++].block_var_bytepos;
2660 i++;
2661 }
2662 else
2663 break;
2664 }
2665 CharUnits size_in_bytes =
2666 end_byte_pos - start_byte_pos + RunSkipBlockVars[j-1].block_var_size;
2667 if (j < size) {
2668 CharUnits gap =
2669 RunSkipBlockVars[j].block_var_bytepos -
2670 RunSkipBlockVars[j-1].block_var_bytepos - RunSkipBlockVars[j-1].block_var_size;
2671 size_in_bytes += gap;
2672 }
2673 CharUnits residue_in_bytes = CharUnits::Zero();
2674 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES) {
2675 residue_in_bytes = size_in_bytes % WordSizeInBytes;
2676 size_in_bytes -= residue_in_bytes;
2677 opcode = BLOCK_LAYOUT_NON_OBJECT_WORDS;
2678 }
2679
2680 unsigned size_in_words = size_in_bytes.getQuantity() / WordSizeInBytes;
2681 while (size_in_words >= 16) {
2682 // Note that value in imm. is one less that the actual
2683 // value. So, 0xf means 16 words follow!
2684 unsigned char inst = (opcode << 4) | 0xf;
2685 Layout.push_back(inst);
2686 size_in_words -= 16;
2687 }
2688 if (size_in_words > 0) {
2689 // Note that value in imm. is one less that the actual
2690 // value. So, we subtract 1 away!
2691 unsigned char inst = (opcode << 4) | (size_in_words-1);
2692 Layout.push_back(inst);
2693 }
2694 if (residue_in_bytes > CharUnits::Zero()) {
2695 unsigned char inst =
2696 (BLOCK_LAYOUT_NON_OBJECT_BYTES << 4) | (residue_in_bytes.getQuantity()-1);
2697 Layout.push_back(inst);
2698 }
2699 }
2700
John McCall7f416cc2015-09-08 08:05:57 +00002701 while (!Layout.empty()) {
2702 unsigned char inst = Layout.back();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002703 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2704 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES || opcode == BLOCK_LAYOUT_NON_OBJECT_WORDS)
2705 Layout.pop_back();
2706 else
2707 break;
2708 }
2709
2710 uint64_t Result = InlineLayoutInstruction(Layout);
2711 if (Result != 0) {
2712 // Block variable layout instruction has been inlined.
2713 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2714 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002715 printf("\n Inline BYREF variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002716 else
John McCall7f416cc2015-09-08 08:05:57 +00002717 printf("\n Inline block variable layout: ");
2718 printf("0x0%" PRIx64 "", Result);
2719 if (auto numStrong = (Result & 0xF00) >> 8)
2720 printf(", BL_STRONG:%d", (int) numStrong);
2721 if (auto numByref = (Result & 0x0F0) >> 4)
2722 printf(", BL_BYREF:%d", (int) numByref);
2723 if (auto numWeak = (Result & 0x00F) >> 0)
2724 printf(", BL_WEAK:%d", (int) numWeak);
2725 printf(", BL_OPERATOR:0\n");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002726 }
Vedant Kumar3ed0df02015-12-21 19:43:25 +00002727 return llvm::ConstantInt::get(CGM.IntPtrTy, Result);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002728 }
2729
2730 unsigned char inst = (BLOCK_LAYOUT_OPERATOR << 4) | 0;
2731 Layout.push_back(inst);
2732 std::string BitMap;
2733 for (unsigned i = 0, e = Layout.size(); i != e; i++)
2734 BitMap += Layout[i];
2735
2736 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2737 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002738 printf("\n Byref variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002739 else
John McCall7f416cc2015-09-08 08:05:57 +00002740 printf("\n Block variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002741 for (unsigned i = 0, e = BitMap.size(); i != e; i++) {
2742 unsigned char inst = BitMap[i];
2743 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2744 unsigned delta = 1;
2745 switch (opcode) {
2746 case BLOCK_LAYOUT_OPERATOR:
2747 printf("BL_OPERATOR:");
2748 delta = 0;
2749 break;
2750 case BLOCK_LAYOUT_NON_OBJECT_BYTES:
2751 printf("BL_NON_OBJECT_BYTES:");
2752 break;
2753 case BLOCK_LAYOUT_NON_OBJECT_WORDS:
2754 printf("BL_NON_OBJECT_WORD:");
2755 break;
2756 case BLOCK_LAYOUT_STRONG:
2757 printf("BL_STRONG:");
2758 break;
2759 case BLOCK_LAYOUT_BYREF:
2760 printf("BL_BYREF:");
2761 break;
2762 case BLOCK_LAYOUT_WEAK:
2763 printf("BL_WEAK:");
2764 break;
2765 case BLOCK_LAYOUT_UNRETAINED:
2766 printf("BL_UNRETAINED:");
2767 break;
2768 }
2769 // Actual value of word count is one more that what is in the imm.
2770 // field of the instruction
2771 printf("%d", (inst & 0xf) + delta);
2772 if (i < e-1)
2773 printf(", ");
2774 else
2775 printf("\n");
2776 }
2777 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002778
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00002779 auto *Entry = CreateCStringLiteral(BitMap, ObjCLabelType::ClassName,
2780 /*ForceNonFragileABI=*/true,
2781 /*NullTerminate=*/false);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002782 return getConstantGEP(VMContext, Entry, 0, 0);
2783}
2784
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002785llvm::Constant *CGObjCCommonMac::BuildRCBlockLayout(CodeGenModule &CGM,
2786 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002787 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2788
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002789 RunSkipBlockVars.clear();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002790 bool hasUnion = false;
2791
John McCallc8e01702013-04-16 22:48:15 +00002792 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2793 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002794 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
2795
2796 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2797
2798 // Calculate the basic layout of the block structure.
2799 const llvm::StructLayout *layout =
2800 CGM.getDataLayout().getStructLayout(blockInfo.StructureType);
2801
2802 // Ignore the optional 'this' capture: C++ objects are not assumed
2803 // to be GC'ed.
Fariborz Jahanian4cf177e2012-12-04 17:20:57 +00002804 if (blockInfo.BlockHeaderForcedGapSize != CharUnits::Zero())
2805 UpdateRunSkipBlockVars(false, Qualifiers::OCL_None,
2806 blockInfo.BlockHeaderForcedGapOffset,
2807 blockInfo.BlockHeaderForcedGapSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002808 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002809 for (const auto &CI : blockDecl->captures()) {
2810 const VarDecl *variable = CI.getVariable();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002811 QualType type = variable->getType();
2812
2813 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2814
2815 // Ignore constant captures.
2816 if (capture.isConstant()) continue;
2817
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002818 CharUnits fieldOffset =
2819 CharUnits::fromQuantity(layout->getElementOffset(capture.getIndex()));
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002820
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002821 assert(!type->isArrayType() && "array variable should not be caught");
Aaron Ballman9371dd22014-03-14 18:34:04 +00002822 if (!CI.isByRef())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002823 if (const RecordType *record = type->getAs<RecordType>()) {
2824 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion);
2825 continue;
2826 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002827 CharUnits fieldSize;
Aaron Ballman9371dd22014-03-14 18:34:04 +00002828 if (CI.isByRef())
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002829 fieldSize = CharUnits::fromQuantity(WordSizeInBytes);
2830 else
2831 fieldSize = CGM.getContext().getTypeSizeInChars(type);
Aaron Ballman9371dd22014-03-14 18:34:04 +00002832 UpdateRunSkipBlockVars(CI.isByRef(), getBlockCaptureLifetime(type, false),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002833 fieldOffset, fieldSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002834 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002835 return getBitmapBlockLayout(false);
2836}
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002837
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002838llvm::Constant *CGObjCCommonMac::BuildByrefLayout(CodeGen::CodeGenModule &CGM,
2839 QualType T) {
2840 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2841 assert(!T->isArrayType() && "__block array variable should not be caught");
2842 CharUnits fieldOffset;
2843 RunSkipBlockVars.clear();
2844 bool hasUnion = false;
2845 if (const RecordType *record = T->getAs<RecordType>()) {
2846 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion, true /*ByrefLayout */);
2847 llvm::Constant *Result = getBitmapBlockLayout(true);
Vedant Kumar2f5bb1152015-12-21 20:21:15 +00002848 if (isa<llvm::ConstantInt>(Result))
2849 Result = llvm::ConstantExpr::getIntToPtr(Result, CGM.Int8PtrTy);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002850 return Result;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002851 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002852 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2853 return nullPtr;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002854}
2855
John McCall882987f2013-02-28 19:01:20 +00002856llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00002857 const ObjCProtocolDecl *PD) {
Daniel Dunbar7050c552008-09-04 04:33:15 +00002858 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002859 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar7050c552008-09-04 04:33:15 +00002860 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2861
Owen Andersonade90fd2009-07-29 18:54:39 +00002862 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00002863 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002864}
2865
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002866void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stump18bb9282009-05-16 07:57:57 +00002867 // FIXME: We shouldn't need this, the protocol decl should contain enough
2868 // information to tell us whether this was a declaration or a definition.
Daniel Dunbarc475d422008-10-29 22:36:39 +00002869 DefinedProtocols.insert(PD->getIdentifier());
2870
2871 // If we have generated a forward reference to this protocol, emit
2872 // it now. Otherwise do nothing, the protocol objects are lazily
2873 // emitted.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002874 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbarc475d422008-10-29 22:36:39 +00002875 GetOrEmitProtocol(PD);
2876}
2877
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002878llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002879 if (DefinedProtocols.count(PD->getIdentifier()))
2880 return GetOrEmitProtocol(PD);
Douglas Gregora9d84932011-05-27 01:19:52 +00002881
Daniel Dunbarc475d422008-10-29 22:36:39 +00002882 return GetOrEmitProtocolRef(PD);
2883}
2884
Douglas Gregor24ae22c2016-04-01 23:23:52 +00002885llvm::Value *CGObjCCommonMac::EmitClassRefViaRuntime(
2886 CodeGenFunction &CGF,
2887 const ObjCInterfaceDecl *ID,
2888 ObjCCommonTypesHelper &ObjCTypes) {
2889 llvm::Constant *lookUpClassFn = ObjCTypes.getLookUpClassFn();
2890
2891 llvm::Value *className =
2892 CGF.CGM.GetAddrOfConstantCString(ID->getObjCRuntimeNameAsString())
2893 .getPointer();
2894 ASTContext &ctx = CGF.CGM.getContext();
2895 className =
2896 CGF.Builder.CreateBitCast(className,
2897 CGF.ConvertType(
2898 ctx.getPointerType(ctx.CharTy.withConst())));
2899 llvm::CallInst *call = CGF.Builder.CreateCall(lookUpClassFn, className);
2900 call->setDoesNotThrow();
2901 return call;
2902}
2903
Daniel Dunbarb036db82008-08-13 03:21:16 +00002904/*
Rafael Espindolaf9e1e5e2014-02-20 14:09:04 +00002905// Objective-C 1.0 extensions
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002906struct _objc_protocol {
2907struct _objc_protocol_extension *isa;
2908char *protocol_name;
2909struct _objc_protocol_list *protocol_list;
2910struct _objc__method_prototype_list *instance_methods;
2911struct _objc__method_prototype_list *class_methods
2912};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002913
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002914See EmitProtocolExtension().
Daniel Dunbarb036db82008-08-13 03:21:16 +00002915*/
Daniel Dunbarc475d422008-10-29 22:36:39 +00002916llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00002917 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbarc475d422008-10-29 22:36:39 +00002918
2919 // Early exit if a defining object has already been generated.
2920 if (Entry && Entry->hasInitializer())
2921 return Entry;
2922
Douglas Gregora715bff2012-01-01 19:51:50 +00002923 // Use the protocol definition, if there is one.
2924 if (const ObjCProtocolDecl *Def = PD->getDefinition())
2925 PD = Def;
2926
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002927 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002928 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00002929 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2930
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002931 // Construct method lists.
John McCall176f8922016-11-30 02:39:18 +00002932 auto methodLists = ProtocolMethodLists::get(PD);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002933
John McCall176f8922016-11-30 02:39:18 +00002934 ConstantInitBuilder builder(CGM);
2935 auto values = builder.beginStruct(ObjCTypes.ProtocolTy);
2936 values.add(EmitProtocolExtension(PD, methodLists));
2937 values.add(GetClassName(PD->getObjCRuntimeNameAsString()));
2938 values.add(EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
2939 PD->protocol_begin(), PD->protocol_end()));
2940 values.add(methodLists.emitMethodList(this, PD,
2941 ProtocolMethodLists::RequiredInstanceMethods));
2942 values.add(methodLists.emitMethodList(this, PD,
2943 ProtocolMethodLists::RequiredClassMethods));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002944
Daniel Dunbarb036db82008-08-13 03:21:16 +00002945 if (Entry) {
Rafael Espindola5d117f32014-03-06 01:10:46 +00002946 // Already created, update the initializer.
Rafael Espindolab3262952014-05-09 00:43:37 +00002947 assert(Entry->hasPrivateLinkage());
John McCall176f8922016-11-30 02:39:18 +00002948 values.finishAndSetAsInitializer(Entry);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002949 } else {
John McCall176f8922016-11-30 02:39:18 +00002950 Entry = values.finishAndCreateGlobal("OBJC_PROTOCOL_" + PD->getName(),
2951 CGM.getPointerAlign(),
2952 /*constant*/ false,
2953 llvm::GlobalValue::PrivateLinkage);
Daniel Dunbarb036db82008-08-13 03:21:16 +00002954 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
John McCallf9582a72012-03-30 21:29:05 +00002955
2956 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002957 }
Rafael Espindola060062a2014-03-06 22:15:10 +00002958 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbarc475d422008-10-29 22:36:39 +00002959
2960 return Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002961}
2962
Daniel Dunbarc475d422008-10-29 22:36:39 +00002963llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00002964 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
2965
2966 if (!Entry) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002967 // We use the initializer as a marker of whether this is a forward
2968 // reference or not. At module finalization we add the empty
2969 // contents for protocols which were referenced but never defined.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002970 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
2971 false, llvm::GlobalValue::PrivateLinkage,
2972 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00002973 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00002974 // FIXME: Is this necessary? Why only for protocol?
2975 Entry->setAlignment(4);
2976 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002977
Daniel Dunbarb036db82008-08-13 03:21:16 +00002978 return Entry;
2979}
2980
2981/*
2982 struct _objc_protocol_extension {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002983 uint32_t size;
2984 struct objc_method_description_list *optional_instance_methods;
2985 struct objc_method_description_list *optional_class_methods;
2986 struct objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00002987 const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00002988 struct objc_property_list *class_properties;
Daniel Dunbarb036db82008-08-13 03:21:16 +00002989 };
2990*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00002991llvm::Constant *
2992CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
John McCall176f8922016-11-30 02:39:18 +00002993 const ProtocolMethodLists &methodLists) {
2994 auto optInstanceMethods =
2995 methodLists.emitMethodList(this, PD,
2996 ProtocolMethodLists::OptionalInstanceMethods);
2997 auto optClassMethods =
2998 methodLists.emitMethodList(this, PD,
2999 ProtocolMethodLists::OptionalClassMethods);
3000
3001 auto extendedMethodTypes =
3002 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
3003 methodLists.emitExtendedTypesArray(this),
3004 ObjCTypes);
3005
3006 auto instanceProperties =
3007 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
3008 ObjCTypes, false);
3009 auto classProperties =
3010 EmitPropertyList("OBJC_$_CLASS_PROP_PROTO_LIST_" + PD->getName(), nullptr,
3011 PD, ObjCTypes, true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003012
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003013 // Return null if no extension bits are used.
John McCall176f8922016-11-30 02:39:18 +00003014 if (optInstanceMethods->isNullValue() &&
3015 optClassMethods->isNullValue() &&
3016 extendedMethodTypes->isNullValue() &&
3017 instanceProperties->isNullValue() &&
3018 classProperties->isNullValue()) {
Owen Anderson0b75f232009-07-31 20:28:54 +00003019 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
John McCall176f8922016-11-30 02:39:18 +00003020 }
Daniel Dunbarb036db82008-08-13 03:21:16 +00003021
John McCall176f8922016-11-30 02:39:18 +00003022 uint64_t size =
3023 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
3024
3025 ConstantInitBuilder builder(CGM);
3026 auto values = builder.beginStruct(ObjCTypes.ProtocolExtensionTy);
3027 values.addInt(ObjCTypes.IntTy, size);
3028 values.add(optInstanceMethods);
3029 values.add(optClassMethods);
3030 values.add(instanceProperties);
3031 values.add(extendedMethodTypes);
3032 values.add(classProperties);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003033
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003034 // No special section, but goes in llvm.used
John McCall176f8922016-11-30 02:39:18 +00003035 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), values,
John McCall7f416cc2015-09-08 08:05:57 +00003036 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003037}
3038
3039/*
3040 struct objc_protocol_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00003041 struct objc_protocol_list *next;
3042 long count;
3043 Protocol *list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00003044 };
3045*/
Daniel Dunbardec75f82008-08-21 21:57:41 +00003046llvm::Constant *
John McCall176f8922016-11-30 02:39:18 +00003047CGObjCMac::EmitProtocolList(Twine name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00003048 ObjCProtocolDecl::protocol_iterator begin,
3049 ObjCProtocolDecl::protocol_iterator end) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00003050 // Just return null for empty protocol lists
John McCall176f8922016-11-30 02:39:18 +00003051 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00003052 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003053
John McCall176f8922016-11-30 02:39:18 +00003054 ConstantInitBuilder builder(CGM);
3055 auto values = builder.beginStruct();
Daniel Dunbarb036db82008-08-13 03:21:16 +00003056
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003057 // This field is only used by the runtime.
John McCall176f8922016-11-30 02:39:18 +00003058 values.addNullPointer(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003059
John McCall176f8922016-11-30 02:39:18 +00003060 // Reserve a slot for the count.
3061 auto countSlot = values.addPlaceholder();
3062
3063 auto refsArray = values.beginArray(ObjCTypes.ProtocolPtrTy);
3064 for (; begin != end; ++begin) {
3065 refsArray.add(GetProtocolRef(*begin));
3066 }
3067 auto count = refsArray.size();
3068
3069 // This list is null terminated.
3070 refsArray.addNullPointer(ObjCTypes.ProtocolPtrTy);
3071
3072 refsArray.finishAndAddTo(values);
3073 values.fillPlaceholderWithInt(countSlot, ObjCTypes.LongTy, count);
3074
3075 StringRef section;
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003076 if (CGM.getTriple().isOSBinFormatMachO())
John McCall176f8922016-11-30 02:39:18 +00003077 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003078
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003079 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00003080 CreateMetadataVar(name, values, section, CGM.getPointerAlign(), false);
Owen Andersonade90fd2009-07-29 18:54:39 +00003081 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003082}
3083
John McCall176f8922016-11-30 02:39:18 +00003084static void
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003085PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
John McCall176f8922016-11-30 02:39:18 +00003086 SmallVectorImpl<const ObjCPropertyDecl *> &Properties,
Aaron Ballmandc4bea42014-03-13 18:47:37 +00003087 const ObjCProtocolDecl *Proto,
Manman Renad0e7912016-01-29 19:22:54 +00003088 bool IsClassProperty) {
Aaron Ballman0f6e64d2014-03-13 22:58:06 +00003089 for (const auto *P : Proto->protocols())
John McCall176f8922016-11-30 02:39:18 +00003090 PushProtocolProperties(PropertySet, Properties, P, IsClassProperty);
Manman Renad0e7912016-01-29 19:22:54 +00003091
3092 for (const auto *PD : Proto->properties()) {
3093 if (IsClassProperty != PD->isClassProperty())
3094 continue;
David Blaikie82e95a32014-11-19 07:49:47 +00003095 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00003096 continue;
John McCall176f8922016-11-30 02:39:18 +00003097 Properties.push_back(PD);
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00003098 }
3099}
3100
Daniel Dunbarb036db82008-08-13 03:21:16 +00003101/*
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003102 struct _objc_property {
Bill Wendlinga515b582012-02-09 22:16:49 +00003103 const char * const name;
3104 const char * const attributes;
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003105 };
3106
3107 struct _objc_property_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00003108 uint32_t entsize; // sizeof (struct _objc_property)
3109 uint32_t prop_count;
3110 struct _objc_property[prop_count];
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003111 };
3112*/
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003113llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003114 const Decl *Container,
3115 const ObjCContainerDecl *OCD,
Manman Renad0e7912016-01-29 19:22:54 +00003116 const ObjCCommonTypesHelper &ObjCTypes,
3117 bool IsClassProperty) {
Manman Ren01b705e2016-04-19 19:05:03 +00003118 if (IsClassProperty) {
3119 // Make this entry NULL for OS X with deployment target < 10.11, for iOS
3120 // with deployment target < 9.0.
3121 const llvm::Triple &Triple = CGM.getTarget().getTriple();
3122 if ((Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 11)) ||
3123 (Triple.isiOS() && Triple.isOSVersionLT(9)))
3124 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
3125 }
3126
John McCall176f8922016-11-30 02:39:18 +00003127 SmallVector<const ObjCPropertyDecl *, 16> Properties;
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00003128 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weber08c93332015-12-03 17:44:51 +00003129
Nico Weber08c93332015-12-03 17:44:51 +00003130 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
3131 for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
Manman Renad0e7912016-01-29 19:22:54 +00003132 for (auto *PD : ClassExt->properties()) {
3133 if (IsClassProperty != PD->isClassProperty())
3134 continue;
Nico Weber08c93332015-12-03 17:44:51 +00003135 PropertySet.insert(PD->getIdentifier());
John McCall176f8922016-11-30 02:39:18 +00003136 Properties.push_back(PD);
Nico Weber08c93332015-12-03 17:44:51 +00003137 }
Manman Renad0e7912016-01-29 19:22:54 +00003138
3139 for (const auto *PD : OCD->properties()) {
3140 if (IsClassProperty != PD->isClassProperty())
3141 continue;
Nico Weber08c93332015-12-03 17:44:51 +00003142 // Don't emit duplicate metadata for properties that were already in a
3143 // class extension.
3144 if (!PropertySet.insert(PD->getIdentifier()).second)
3145 continue;
John McCall176f8922016-11-30 02:39:18 +00003146 Properties.push_back(PD);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003147 }
Nico Weber08c93332015-12-03 17:44:51 +00003148
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003149 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Aaron Ballmana9f49e32014-03-13 20:55:22 +00003150 for (const auto *P : OID->all_referenced_protocols())
John McCall176f8922016-11-30 02:39:18 +00003151 PushProtocolProperties(PropertySet, Properties, P, IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003152 }
3153 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Aaron Ballman19a41762014-03-14 12:55:57 +00003154 for (const auto *P : CD->protocols())
John McCall176f8922016-11-30 02:39:18 +00003155 PushProtocolProperties(PropertySet, Properties, P, IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003156 }
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003157
3158 // Return null for empty list.
3159 if (Properties.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003160 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003161
John McCall176f8922016-11-30 02:39:18 +00003162 unsigned propertySize =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003163 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
John McCall176f8922016-11-30 02:39:18 +00003164
3165 ConstantInitBuilder builder(CGM);
3166 auto values = builder.beginStruct();
3167 values.addInt(ObjCTypes.IntTy, propertySize);
3168 values.addInt(ObjCTypes.IntTy, Properties.size());
3169 auto propertiesArray = values.beginArray(ObjCTypes.PropertyTy);
3170 for (auto PD : Properties) {
3171 auto property = propertiesArray.beginStruct(ObjCTypes.PropertyTy);
3172 property.add(GetPropertyName(PD->getIdentifier()));
3173 property.add(GetPropertyTypeString(PD, Container));
3174 property.finishAndAddTo(propertiesArray);
3175 }
3176 propertiesArray.finishAndAddTo(values);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003177
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003178 StringRef Section;
3179 if (CGM.getTriple().isOSBinFormatMachO())
3180 Section = (ObjCABI == 2) ? "__DATA, __objc_const"
3181 : "__OBJC,__property,regular,no_dead_strip";
3182
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003183 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00003184 CreateMetadataVar(Name, values, Section, CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003185 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003186}
3187
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003188llvm::Constant *
3189CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
3190 ArrayRef<llvm::Constant*> MethodTypes,
3191 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003192 // Return null for empty list.
3193 if (MethodTypes.empty())
3194 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
3195
3196 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
3197 MethodTypes.size());
3198 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
3199
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003200 StringRef Section;
3201 if (CGM.getTriple().isOSBinFormatMachO() && ObjCABI == 2)
3202 Section = "__DATA, __objc_const";
3203
3204 llvm::GlobalVariable *GV =
3205 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003206 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
3207}
3208
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003209/*
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003210 struct _objc_category {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003211 char *category_name;
3212 char *class_name;
3213 struct _objc_method_list *instance_methods;
3214 struct _objc_method_list *class_methods;
3215 struct _objc_protocol_list *protocols;
3216 uint32_t size; // <rdar://4585769>
3217 struct _objc_property_list *instance_properties;
Manman Ren96df0b32016-01-29 23:45:01 +00003218 struct _objc_property_list *class_properties;
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003219 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003220*/
Daniel Dunbar92992502008-08-15 22:20:32 +00003221void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00003222 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003223
Mike Stump18bb9282009-05-16 07:57:57 +00003224 // FIXME: This is poor design, the OCD should have a pointer to the category
3225 // decl. Additionally, note that Category can be null for the @implementation
3226 // w/o an @interface case. Sema should just create one for us as it does for
3227 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003228 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003229 const ObjCCategoryDecl *Category =
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003230 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003231
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003232 SmallString<256> ExtName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003233 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3234 << OCD->getName();
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003235
John McCall176f8922016-11-30 02:39:18 +00003236 ConstantInitBuilder Builder(CGM);
3237 auto Values = Builder.beginStruct(ObjCTypes.CategoryTy);
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003238
John McCall176f8922016-11-30 02:39:18 +00003239 enum {
3240 InstanceMethods,
3241 ClassMethods,
3242 NumMethodLists
3243 };
3244 SmallVector<const ObjCMethodDecl *, 16> Methods[NumMethodLists];
3245 for (const auto *MD : OCD->methods()) {
3246 Methods[unsigned(MD->isClassMethod())].push_back(MD);
3247 }
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003248
John McCall176f8922016-11-30 02:39:18 +00003249 Values.add(GetClassName(OCD->getName()));
3250 Values.add(GetClassName(Interface->getObjCRuntimeNameAsString()));
Fariborz Jahaniane55f8662009-04-29 20:40:05 +00003251 LazySymbols.insert(Interface->getIdentifier());
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003252
John McCall176f8922016-11-30 02:39:18 +00003253 Values.add(emitMethodList(ExtName, MethodListType::CategoryInstanceMethods,
3254 Methods[InstanceMethods]));
3255 Values.add(emitMethodList(ExtName, MethodListType::CategoryClassMethods,
3256 Methods[ClassMethods]));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003257 if (Category) {
John McCall176f8922016-11-30 02:39:18 +00003258 Values.add(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003259 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
John McCall176f8922016-11-30 02:39:18 +00003260 Category->protocol_begin(), Category->protocol_end()));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003261 } else {
John McCall176f8922016-11-30 02:39:18 +00003262 Values.addNullPointer(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003263 }
John McCall176f8922016-11-30 02:39:18 +00003264 Values.addInt(ObjCTypes.IntTy, Size);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003265
3266 // If there is no category @interface then there can be no properties.
3267 if (Category) {
John McCall176f8922016-11-30 02:39:18 +00003268 Values.add(EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
3269 OCD, Category, ObjCTypes, false));
3270 Values.add(EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
3271 OCD, Category, ObjCTypes, true));
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003272 } else {
John McCall176f8922016-11-30 02:39:18 +00003273 Values.addNullPointer(ObjCTypes.PropertyListPtrTy);
3274 Values.addNullPointer(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003275 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003276
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003277 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00003278 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Values,
John McCall7f416cc2015-09-08 08:05:57 +00003279 "__OBJC,__category,regular,no_dead_strip",
3280 CGM.getPointerAlign(), true);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003281 DefinedCategories.push_back(GV);
Justin Lebar5e83dfe2016-10-21 21:45:01 +00003282 DefinedCategoryNames.insert(llvm::CachedHashString(ExtName));
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003283 // method definition entries must be clear for next implementation.
3284 MethodDefinitions.clear();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003285}
3286
John McCallef19dbb2012-10-17 04:53:23 +00003287enum FragileClassFlags {
John McCall460ce582015-10-22 18:38:17 +00003288 /// Apparently: is not a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003289 FragileABI_Class_Factory = 0x00001,
John McCall460ce582015-10-22 18:38:17 +00003290
3291 /// Is a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003292 FragileABI_Class_Meta = 0x00002,
John McCall460ce582015-10-22 18:38:17 +00003293
3294 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003295 FragileABI_Class_HasCXXStructors = 0x02000,
John McCall460ce582015-10-22 18:38:17 +00003296
3297 /// Has hidden visibility.
John McCall09ec1ec2015-10-21 22:06:03 +00003298 FragileABI_Class_Hidden = 0x20000,
John McCall460ce582015-10-22 18:38:17 +00003299
3300 /// Class implementation was compiled under ARC.
3301 FragileABI_Class_CompiledByARC = 0x04000000,
3302
3303 /// Class implementation was compiled under MRC and has MRC weak ivars.
3304 /// Exclusive with CompiledByARC.
3305 FragileABI_Class_HasMRCWeakIvars = 0x08000000,
John McCallef19dbb2012-10-17 04:53:23 +00003306};
3307
3308enum NonFragileClassFlags {
3309 /// Is a meta-class.
3310 NonFragileABI_Class_Meta = 0x00001,
3311
3312 /// Is a root class.
3313 NonFragileABI_Class_Root = 0x00002,
3314
John McCall460ce582015-10-22 18:38:17 +00003315 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003316 NonFragileABI_Class_HasCXXStructors = 0x00004,
3317
3318 /// Has hidden visibility.
3319 NonFragileABI_Class_Hidden = 0x00010,
3320
3321 /// Has the exception attribute.
3322 NonFragileABI_Class_Exception = 0x00020,
3323
3324 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3325 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3326
3327 /// Class implementation was compiled under ARC.
John McCall0d54a172012-10-17 04:53:31 +00003328 NonFragileABI_Class_CompiledByARC = 0x00080,
3329
3330 /// Class has non-trivial destructors, but zero-initialization is okay.
John McCall460ce582015-10-22 18:38:17 +00003331 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100,
3332
3333 /// Class implementation was compiled under MRC and has MRC weak ivars.
3334 /// Exclusive with CompiledByARC.
3335 NonFragileABI_Class_HasMRCWeakIvars = 0x00200,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003336};
3337
John McCall460ce582015-10-22 18:38:17 +00003338static bool hasWeakMember(QualType type) {
3339 if (type.getObjCLifetime() == Qualifiers::OCL_Weak) {
3340 return true;
3341 }
3342
3343 if (auto recType = type->getAs<RecordType>()) {
3344 for (auto field : recType->getDecl()->fields()) {
3345 if (hasWeakMember(field->getType()))
3346 return true;
3347 }
3348 }
3349
3350 return false;
3351}
3352
3353/// For compatibility, we only want to set the "HasMRCWeakIvars" flag
3354/// (and actually fill in a layout string) if we really do have any
3355/// __weak ivars.
3356static bool hasMRCWeakIvars(CodeGenModule &CGM,
3357 const ObjCImplementationDecl *ID) {
3358 if (!CGM.getLangOpts().ObjCWeak) return false;
3359 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
3360
3361 for (const ObjCIvarDecl *ivar =
3362 ID->getClassInterface()->all_declared_ivar_begin();
3363 ivar; ivar = ivar->getNextIvar()) {
3364 if (hasWeakMember(ivar->getType()))
3365 return true;
3366 }
3367
3368 return false;
3369}
3370
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003371/*
3372 struct _objc_class {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003373 Class isa;
3374 Class super_class;
3375 const char *name;
3376 long version;
3377 long info;
3378 long instance_size;
3379 struct _objc_ivar_list *ivars;
3380 struct _objc_method_list *methods;
3381 struct _objc_cache *cache;
3382 struct _objc_protocol_list *protocols;
3383 // Objective-C 1.0 extensions (<rdr://4585769>)
3384 const char *ivar_layout;
3385 struct _objc_class_ext *ext;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003386 };
3387
3388 See EmitClassExtension();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003389*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003390void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003391 DefinedSymbols.insert(ID->getIdentifier());
3392
Chris Lattner86d7d912008-11-24 03:54:41 +00003393 std::string ClassName = ID->getNameAsString();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003394 // FIXME: Gross
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003395 ObjCInterfaceDecl *Interface =
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003396 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003397 llvm::Constant *Protocols =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003398 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3399 Interface->all_referenced_protocol_begin(),
3400 Interface->all_referenced_protocol_end());
John McCallef19dbb2012-10-17 04:53:23 +00003401 unsigned Flags = FragileABI_Class_Factory;
John McCall0d54a172012-10-17 04:53:31 +00003402 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCallef19dbb2012-10-17 04:53:23 +00003403 Flags |= FragileABI_Class_HasCXXStructors;
John McCall09ec1ec2015-10-21 22:06:03 +00003404
John McCall460ce582015-10-22 18:38:17 +00003405 bool hasMRCWeak = false;
3406
John McCall09ec1ec2015-10-21 22:06:03 +00003407 if (CGM.getLangOpts().ObjCAutoRefCount)
3408 Flags |= FragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00003409 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
3410 Flags |= FragileABI_Class_HasMRCWeakIvars;
John McCall09ec1ec2015-10-21 22:06:03 +00003411
John McCall3fd13f062015-10-21 18:06:47 +00003412 CharUnits Size =
3413 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003414
3415 // FIXME: Set CXX-structors flag.
John McCall457a04e2010-10-22 21:05:15 +00003416 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003417 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003418
John McCall176f8922016-11-30 02:39:18 +00003419 enum {
3420 InstanceMethods,
3421 ClassMethods,
3422 NumMethodLists
3423 };
3424 SmallVector<const ObjCMethodDecl *, 16> Methods[NumMethodLists];
3425 for (const auto *MD : ID->methods()) {
3426 Methods[unsigned(MD->isClassMethod())].push_back(MD);
3427 }
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003428
Aaron Ballmand85eff42014-03-14 15:02:45 +00003429 for (const auto *PID : ID->property_impls()) {
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003430 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3431 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3432
3433 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
John McCall176f8922016-11-30 02:39:18 +00003434 if (GetMethodDefinition(MD))
3435 Methods[InstanceMethods].push_back(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003436 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
John McCall176f8922016-11-30 02:39:18 +00003437 if (GetMethodDefinition(MD))
3438 Methods[InstanceMethods].push_back(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003439 }
3440 }
3441
John McCall176f8922016-11-30 02:39:18 +00003442 ConstantInitBuilder builder(CGM);
3443 auto values = builder.beginStruct(ObjCTypes.ClassTy);
3444 values.add(EmitMetaClass(ID, Protocols, Methods[ClassMethods]));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003445 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003446 // Record a reference to the super class.
3447 LazySymbols.insert(Super->getIdentifier());
3448
John McCall176f8922016-11-30 02:39:18 +00003449 values.addBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
3450 ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003451 } else {
John McCall176f8922016-11-30 02:39:18 +00003452 values.addNullPointer(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003453 }
John McCall176f8922016-11-30 02:39:18 +00003454 values.add(GetClassName(ID->getObjCRuntimeNameAsString()));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003455 // Version is always 0.
John McCall176f8922016-11-30 02:39:18 +00003456 values.addInt(ObjCTypes.LongTy, 0);
3457 values.addInt(ObjCTypes.LongTy, Flags);
3458 values.addInt(ObjCTypes.LongTy, Size.getQuantity());
3459 values.add(EmitIvarList(ID, false));
3460 values.add(emitMethodList(ID->getName(), MethodListType::InstanceMethods,
3461 Methods[InstanceMethods]));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003462 // cache is always NULL.
John McCall176f8922016-11-30 02:39:18 +00003463 values.addNullPointer(ObjCTypes.CachePtrTy);
3464 values.add(Protocols);
3465 values.add(BuildStrongIvarLayout(ID, CharUnits::Zero(), Size));
3466 values.add(EmitClassExtension(ID, Size, hasMRCWeak,
3467 /*isMetaclass*/ false));
3468
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003469 std::string Name("OBJC_CLASS_");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003470 Name += ClassName;
3471 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3472 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003473 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003474 if (GV) {
3475 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3476 "Forward metaclass reference has incorrect type.");
John McCall176f8922016-11-30 02:39:18 +00003477 values.finishAndSetAsInitializer(GV);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003478 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003479 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00003480 CGM.addCompilerUsedGlobal(GV);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003481 } else
John McCall176f8922016-11-30 02:39:18 +00003482 GV = CreateMetadataVar(Name, values, Section, CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003483 DefinedClasses.push_back(GV);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00003484 ImplementedClasses.push_back(Interface);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003485 // method definition entries must be clear for next implementation.
3486 MethodDefinitions.clear();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003487}
3488
3489llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3490 llvm::Constant *Protocols,
John McCall176f8922016-11-30 02:39:18 +00003491 ArrayRef<const ObjCMethodDecl*> Methods) {
John McCallef19dbb2012-10-17 04:53:23 +00003492 unsigned Flags = FragileABI_Class_Meta;
Micah Villmowdd31ca12012-10-08 16:25:52 +00003493 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003494
John McCall457a04e2010-10-22 21:05:15 +00003495 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003496 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003497
John McCall176f8922016-11-30 02:39:18 +00003498 ConstantInitBuilder builder(CGM);
3499 auto values = builder.beginStruct(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003500 // The isa for the metaclass is the root of the hierarchy.
3501 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3502 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3503 Root = Super;
John McCall176f8922016-11-30 02:39:18 +00003504 values.addBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
3505 ObjCTypes.ClassPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003506 // The super class for the metaclass is emitted as the name of the
3507 // super class. The runtime fixes this up to point to the
3508 // *metaclass* for the super class.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003509 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
John McCall176f8922016-11-30 02:39:18 +00003510 values.addBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
3511 ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003512 } else {
John McCall176f8922016-11-30 02:39:18 +00003513 values.addNullPointer(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003514 }
John McCall176f8922016-11-30 02:39:18 +00003515 values.add(GetClassName(ID->getObjCRuntimeNameAsString()));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003516 // Version is always 0.
John McCall176f8922016-11-30 02:39:18 +00003517 values.addInt(ObjCTypes.LongTy, 0);
3518 values.addInt(ObjCTypes.LongTy, Flags);
3519 values.addInt(ObjCTypes.LongTy, Size);
3520 values.add(EmitIvarList(ID, true));
3521 values.add(emitMethodList(ID->getName(), MethodListType::ClassMethods,
3522 Methods));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003523 // cache is always NULL.
John McCall176f8922016-11-30 02:39:18 +00003524 values.addNullPointer(ObjCTypes.CachePtrTy);
3525 values.add(Protocols);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003526 // ivar_layout for metaclass is always NULL.
John McCall176f8922016-11-30 02:39:18 +00003527 values.addNullPointer(ObjCTypes.Int8PtrTy);
Manman Renad0e7912016-01-29 19:22:54 +00003528 // The class extension is used to store class properties for metaclasses.
John McCall176f8922016-11-30 02:39:18 +00003529 values.add(EmitClassExtension(ID, CharUnits::Zero(), false/*hasMRCWeak*/,
3530 /*isMetaclass*/true));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003531
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003532 std::string Name("OBJC_METACLASS_");
Benjamin Kramer1bbcbd02012-07-31 11:45:39 +00003533 Name += ID->getName();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003534
3535 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003536 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003537 if (GV) {
3538 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3539 "Forward metaclass reference has incorrect type.");
John McCall176f8922016-11-30 02:39:18 +00003540 values.finishAndSetAsInitializer(GV);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003541 } else {
John McCall176f8922016-11-30 02:39:18 +00003542 GV = values.finishAndCreateGlobal(Name, CGM.getPointerAlign(),
3543 /*constant*/ false,
3544 llvm::GlobalValue::PrivateLinkage);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003545 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003546 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00003547 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003548
3549 return GV;
3550}
3551
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003552llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003553 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003554
Mike Stump18bb9282009-05-16 07:57:57 +00003555 // FIXME: Should we look these up somewhere other than the module. Its a bit
3556 // silly since we only generate these while processing an implementation, so
3557 // exactly one pointer would work if know when we entered/exitted an
3558 // implementation block.
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003559
3560 // Check for an existing forward reference.
Fariborz Jahanian475831b2009-01-07 20:11:22 +00003561 // Previously, metaclass with internal linkage may have been defined.
3562 // pass 'true' as 2nd argument so it is returned.
Rafael Espindola21039aa2014-02-27 16:26:32 +00003563 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3564 if (!GV)
3565 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003566 llvm::GlobalValue::PrivateLinkage, nullptr,
3567 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003568
3569 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3570 "Forward metaclass reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003571 return GV;
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003572}
3573
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003574llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003575 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Rafael Espindola21039aa2014-02-27 16:26:32 +00003576 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3577
3578 if (!GV)
3579 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003580 llvm::GlobalValue::PrivateLinkage, nullptr,
3581 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003582
3583 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3584 "Forward class metadata reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003585 return GV;
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003586}
3587
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003588/*
John McCall3fd13f062015-10-21 18:06:47 +00003589 Emit a "class extension", which in this specific context means extra
3590 data that doesn't fit in the normal fragile-ABI class structure, and
3591 has nothing to do with the language concept of a class extension.
3592
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003593 struct objc_class_ext {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003594 uint32_t size;
3595 const char *weak_ivar_layout;
3596 struct _objc_property_list *properties;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003597 };
3598*/
3599llvm::Constant *
John McCall3fd13f062015-10-21 18:06:47 +00003600CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
Manman Renad0e7912016-01-29 19:22:54 +00003601 CharUnits InstanceSize, bool hasMRCWeakIvars,
John McCall176f8922016-11-30 02:39:18 +00003602 bool isMetaclass) {
3603 // Weak ivar layout.
3604 llvm::Constant *layout;
3605 if (isMetaclass) {
3606 layout = llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
3607 } else {
3608 layout = BuildWeakIvarLayout(ID, CharUnits::Zero(), InstanceSize,
3609 hasMRCWeakIvars);
3610 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003611
John McCall176f8922016-11-30 02:39:18 +00003612 // Properties.
3613 llvm::Constant *propertyList =
3614 EmitPropertyList((isMetaclass ? Twine("\01l_OBJC_$_CLASS_PROP_LIST_")
3615 : Twine("\01l_OBJC_$_PROP_LIST_"))
3616 + ID->getName(),
3617 ID, ID->getClassInterface(), ObjCTypes, isMetaclass);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003618
3619 // Return null if no extension bits are used.
John McCall176f8922016-11-30 02:39:18 +00003620 if (layout->isNullValue() && propertyList->isNullValue()) {
Owen Anderson0b75f232009-07-31 20:28:54 +00003621 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
John McCall176f8922016-11-30 02:39:18 +00003622 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003623
John McCall176f8922016-11-30 02:39:18 +00003624 uint64_t size =
3625 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
3626
3627 ConstantInitBuilder builder(CGM);
3628 auto values = builder.beginStruct(ObjCTypes.ClassExtensionTy);
3629 values.addInt(ObjCTypes.IntTy, size);
3630 values.add(layout);
3631 values.add(propertyList);
3632
3633 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), values,
John McCall7f416cc2015-09-08 08:05:57 +00003634 "__OBJC,__class_ext,regular,no_dead_strip",
3635 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003636}
3637
3638/*
3639 struct objc_ivar {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003640 char *ivar_name;
3641 char *ivar_type;
3642 int ivar_offset;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003643 };
3644
3645 struct objc_ivar_list {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003646 int ivar_count;
3647 struct objc_ivar list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003648 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003649*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003650llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003651 bool ForClass) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003652 // When emitting the root class GCC emits ivar entries for the
3653 // actual class structure. It is not clear if we need to follow this
3654 // behavior; for now lets try and get away with not doing it. If so,
3655 // the cleanest solution would be to make up an ObjCInterfaceDecl
3656 // for the class.
3657 if (ForClass)
Owen Anderson0b75f232009-07-31 20:28:54 +00003658 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003659
Jordy Rosea91768e2011-07-22 02:08:32 +00003660 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003661
John McCall176f8922016-11-30 02:39:18 +00003662 ConstantInitBuilder builder(CGM);
3663 auto ivarList = builder.beginStruct();
3664 auto countSlot = ivarList.addPlaceholder();
3665 auto ivars = ivarList.beginArray(ObjCTypes.IvarTy);
3666
Jordy Rosea91768e2011-07-22 02:08:32 +00003667 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00003668 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00003669 // Ignore unnamed bit-fields.
3670 if (!IVD->getDeclName())
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003671 continue;
John McCall176f8922016-11-30 02:39:18 +00003672
3673 auto ivar = ivars.beginStruct(ObjCTypes.IvarTy);
3674 ivar.add(GetMethodVarName(IVD->getIdentifier()));
3675 ivar.add(GetMethodVarType(IVD));
3676 ivar.addInt(ObjCTypes.IntTy, ComputeIvarBaseOffset(CGM, OID, IVD));
3677 ivar.finishAndAddTo(ivars);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003678 }
3679
3680 // Return null for empty list.
John McCall176f8922016-11-30 02:39:18 +00003681 auto count = ivars.size();
3682 if (count == 0) {
3683 ivars.abandon();
3684 ivarList.abandon();
Owen Anderson0b75f232009-07-31 20:28:54 +00003685 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
John McCall176f8922016-11-30 02:39:18 +00003686 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003687
John McCall176f8922016-11-30 02:39:18 +00003688 ivars.finishAndAddTo(ivarList);
3689 ivarList.fillPlaceholderWithInt(countSlot, ObjCTypes.IntTy, count);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003690
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003691 llvm::GlobalVariable *GV;
3692 if (ForClass)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003693 GV =
John McCall176f8922016-11-30 02:39:18 +00003694 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), ivarList,
John McCall7f416cc2015-09-08 08:05:57 +00003695 "__OBJC,__class_vars,regular,no_dead_strip",
3696 CGM.getPointerAlign(), true);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003697 else
John McCall176f8922016-11-30 02:39:18 +00003698 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), ivarList,
John McCall7f416cc2015-09-08 08:05:57 +00003699 "__OBJC,__instance_vars,regular,no_dead_strip",
3700 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003701 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003702}
3703
John McCall176f8922016-11-30 02:39:18 +00003704/// Build a struct objc_method_description constant for the given method.
3705///
3706/// struct objc_method_description {
3707/// SEL method_name;
3708/// char *method_types;
3709/// };
3710void CGObjCMac::emitMethodDescriptionConstant(ConstantArrayBuilder &builder,
3711 const ObjCMethodDecl *MD) {
3712 auto description = builder.beginStruct(ObjCTypes.MethodDescriptionTy);
3713 description.addBitCast(GetMethodVarName(MD->getSelector()),
3714 ObjCTypes.SelectorPtrTy);
3715 description.add(GetMethodVarType(MD));
3716 description.finishAndAddTo(builder);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003717}
3718
John McCall176f8922016-11-30 02:39:18 +00003719/// Build a struct objc_method constant for the given method.
3720///
3721/// struct objc_method {
3722/// SEL method_name;
3723/// char *method_types;
3724/// void *method;
3725/// };
3726void CGObjCMac::emitMethodConstant(ConstantArrayBuilder &builder,
3727 const ObjCMethodDecl *MD) {
3728 llvm::Function *fn = GetMethodDefinition(MD);
3729 assert(fn && "no definition registered for method");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003730
John McCall176f8922016-11-30 02:39:18 +00003731 auto method = builder.beginStruct(ObjCTypes.MethodTy);
3732 method.addBitCast(GetMethodVarName(MD->getSelector()),
3733 ObjCTypes.SelectorPtrTy);
3734 method.add(GetMethodVarType(MD));
3735 method.addBitCast(fn, ObjCTypes.Int8PtrTy);
3736 method.finishAndAddTo(builder);
3737}
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003738
John McCall176f8922016-11-30 02:39:18 +00003739/// Build a struct objc_method_list or struct objc_method_description_list,
3740/// as appropriate.
3741///
3742/// struct objc_method_list {
3743/// struct objc_method_list *obsolete;
3744/// int count;
3745/// struct objc_method methods_list[count];
3746/// };
3747///
3748/// struct objc_method_description_list {
3749/// int count;
3750/// struct objc_method_description list[count];
3751/// };
3752llvm::Constant *CGObjCMac::emitMethodList(Twine name, MethodListType MLT,
3753 ArrayRef<const ObjCMethodDecl *> methods) {
3754 StringRef prefix;
3755 StringRef section;
3756 bool forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003757 switch (MLT) {
3758 case MethodListType::CategoryInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003759 prefix = "OBJC_CATEGORY_INSTANCE_METHODS_";
3760 section = "__OBJC,__cat_inst_meth,regular,no_dead_strip";
3761 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003762 break;
3763 case MethodListType::CategoryClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003764 prefix = "OBJC_CATEGORY_CLASS_METHODS_";
3765 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
3766 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003767 break;
3768 case MethodListType::InstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003769 prefix = "OBJC_INSTANCE_METHODS_";
3770 section = "__OBJC,__inst_meth,regular,no_dead_strip";
3771 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003772 break;
3773 case MethodListType::ClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003774 prefix = "OBJC_CLASS_METHODS_";
3775 section = "__OBJC,__cls_meth,regular,no_dead_strip";
3776 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003777 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003778 case MethodListType::ProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003779 prefix = "OBJC_PROTOCOL_INSTANCE_METHODS_";
3780 section = "__OBJC,__cat_inst_meth,regular,no_dead_strip";
3781 forProtocol = true;
3782 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003783 case MethodListType::ProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003784 prefix = "OBJC_PROTOCOL_CLASS_METHODS_";
3785 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
3786 forProtocol = true;
3787 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003788 case MethodListType::OptionalProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003789 prefix = "OBJC_PROTOCOL_INSTANCE_METHODS_OPT_";
3790 section = "__OBJC,__cat_inst_meth,regular,no_dead_strip";
3791 forProtocol = true;
3792 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003793 case MethodListType::OptionalProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003794 prefix = "OBJC_PROTOCOL_CLASS_METHODS_OPT_";
3795 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
3796 forProtocol = true;
3797 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003798 }
3799
John McCall176f8922016-11-30 02:39:18 +00003800 // Return null for empty list.
3801 if (methods.empty())
3802 return llvm::Constant::getNullValue(forProtocol
3803 ? ObjCTypes.MethodDescriptionListPtrTy
3804 : ObjCTypes.MethodListPtrTy);
3805
3806 // For protocols, this is an objc_method_description_list, which has
3807 // a slightly different structure.
3808 if (forProtocol) {
3809 ConstantInitBuilder builder(CGM);
3810 auto values = builder.beginStruct();
3811 values.addInt(ObjCTypes.IntTy, methods.size());
3812 auto methodArray = values.beginArray(ObjCTypes.MethodDescriptionTy);
3813 for (auto MD : methods) {
3814 emitMethodDescriptionConstant(methodArray, MD);
3815 }
3816 methodArray.finishAndAddTo(values);
3817
3818 llvm::GlobalVariable *GV = CreateMetadataVar(prefix + name, values, section,
3819 CGM.getPointerAlign(), true);
3820 return llvm::ConstantExpr::getBitCast(GV,
3821 ObjCTypes.MethodDescriptionListPtrTy);
3822 }
3823
3824 // Otherwise, it's an objc_method_list.
3825 ConstantInitBuilder builder(CGM);
3826 auto values = builder.beginStruct();
3827 values.addNullPointer(ObjCTypes.Int8PtrTy);
3828 values.addInt(ObjCTypes.IntTy, methods.size());
3829 auto methodArray = values.beginArray(ObjCTypes.MethodTy);
3830 for (auto MD : methods) {
3831 emitMethodConstant(methodArray, MD);
3832 }
3833 methodArray.finishAndAddTo(values);
3834
3835 llvm::GlobalVariable *GV = CreateMetadataVar(prefix + name, values, section,
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003836 CGM.getPointerAlign(), true);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003837 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003838}
3839
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00003840llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003841 const ObjCContainerDecl *CD) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003842 SmallString<256> Name;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003843 GetNameForMethod(OMD, CD, Name);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003844
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003845 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003846 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003847 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003848 llvm::Function *Method =
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00003849 llvm::Function::Create(MethodTy,
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003850 llvm::GlobalValue::InternalLinkage,
Daniel Dunbard2386812009-10-19 01:21:19 +00003851 Name.str(),
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003852 &CGM.getModule());
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003853 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003854
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003855 return Method;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003856}
3857
Alp Toker541d5072014-06-07 23:30:53 +00003858llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
John McCall176f8922016-11-30 02:39:18 +00003859 ConstantStructBuilder &Init,
3860 StringRef Section,
3861 CharUnits Align,
3862 bool AddToUsed) {
3863 llvm::GlobalVariable *GV =
3864 Init.finishAndCreateGlobal(Name, Align, /*constant*/ false,
3865 llvm::GlobalValue::PrivateLinkage);
3866 if (!Section.empty())
3867 GV->setSection(Section);
3868 if (AddToUsed)
3869 CGM.addCompilerUsedGlobal(GV);
3870 return GV;
3871}
3872
3873llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
Alp Toker541d5072014-06-07 23:30:53 +00003874 llvm::Constant *Init,
3875 StringRef Section,
John McCall7f416cc2015-09-08 08:05:57 +00003876 CharUnits Align,
Alp Toker541d5072014-06-07 23:30:53 +00003877 bool AddToUsed) {
Chris Lattner2192fe52011-07-18 04:24:23 +00003878 llvm::Type *Ty = Init->getType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003879 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00003880 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003881 llvm::GlobalValue::PrivateLinkage, Init, Name);
Alp Toker541d5072014-06-07 23:30:53 +00003882 if (!Section.empty())
Daniel Dunbar30c65362009-03-09 20:09:19 +00003883 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003884 GV->setAlignment(Align.getQuantity());
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00003885 if (AddToUsed)
Rafael Espindola060062a2014-03-06 22:15:10 +00003886 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar30c65362009-03-09 20:09:19 +00003887 return GV;
3888}
3889
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003890llvm::GlobalVariable *
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003891CGObjCCommonMac::CreateCStringLiteral(StringRef Name, ObjCLabelType Type,
3892 bool ForceNonFragileABI,
3893 bool NullTerminate) {
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003894 StringRef Label;
3895 switch (Type) {
3896 case ObjCLabelType::ClassName: Label = "OBJC_CLASS_NAME_"; break;
3897 case ObjCLabelType::MethodVarName: Label = "OBJC_METH_VAR_NAME_"; break;
3898 case ObjCLabelType::MethodVarType: Label = "OBJC_METH_VAR_TYPE_"; break;
3899 case ObjCLabelType::PropertyName: Label = "OBJC_PROP_NAME_ATTR_"; break;
3900 }
3901
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003902 bool NonFragile = ForceNonFragileABI || isNonFragileABI();
3903
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003904 StringRef Section;
3905 switch (Type) {
3906 case ObjCLabelType::ClassName:
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003907 Section = NonFragile ? "__TEXT,__objc_classname,cstring_literals"
3908 : "__TEXT,__cstring,cstring_literals";
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003909 break;
3910 case ObjCLabelType::MethodVarName:
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003911 Section = NonFragile ? "__TEXT,__objc_methname,cstring_literals"
3912 : "__TEXT,__cstring,cstring_literals";
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003913 break;
3914 case ObjCLabelType::MethodVarType:
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003915 Section = NonFragile ? "__TEXT,__objc_methtype,cstring_literals"
3916 : "__TEXT,__cstring,cstring_literals";
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003917 break;
3918 case ObjCLabelType::PropertyName:
3919 Section = "__TEXT,__cstring,cstring_literals";
3920 break;
3921 }
3922
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003923 llvm::Constant *Value =
3924 llvm::ConstantDataArray::getString(VMContext, Name, NullTerminate);
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003925 llvm::GlobalVariable *GV =
Saleem Abdulrasool0c54dc82016-09-18 16:12:04 +00003926 new llvm::GlobalVariable(CGM.getModule(), Value->getType(),
3927 /*isConstant=*/true,
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003928 llvm::GlobalValue::PrivateLinkage, Value, Label);
Saleem Abdulrasool3f307512016-09-18 16:12:14 +00003929 if (CGM.getTriple().isOSBinFormatMachO())
3930 GV->setSection(Section);
3931 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003932 GV->setAlignment(CharUnits::One().getQuantity());
3933 CGM.addCompilerUsedGlobal(GV);
3934
3935 return GV;
3936}
3937
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003938llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00003939 // Abuse this interface function as a place to finalize.
3940 FinishModule();
Craig Topper8a13c412014-05-21 05:09:00 +00003941 return nullptr;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003942}
3943
Chris Lattnerd4808922009-03-22 21:03:39 +00003944llvm::Constant *CGObjCMac::GetPropertyGetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003945 return ObjCTypes.getGetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003946}
3947
Chris Lattnerd4808922009-03-22 21:03:39 +00003948llvm::Constant *CGObjCMac::GetPropertySetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003949 return ObjCTypes.getSetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00003950}
3951
Ted Kremeneke65b0862012-03-06 20:05:56 +00003952llvm::Constant *CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
3953 bool copy) {
3954 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
3955}
3956
David Chisnall168b80f2010-12-26 22:13:16 +00003957llvm::Constant *CGObjCMac::GetGetStructFunction() {
3958 return ObjCTypes.getCopyStructFn();
3959}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003960
David Chisnall168b80f2010-12-26 22:13:16 +00003961llvm::Constant *CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00003962 return ObjCTypes.getCopyStructFn();
3963}
3964
David Chisnall0d75e062012-12-17 18:54:24 +00003965llvm::Constant *CGObjCMac::GetCppAtomicObjectGetFunction() {
3966 return ObjCTypes.getCppAtomicObjectFunction();
3967}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00003968
David Chisnall0d75e062012-12-17 18:54:24 +00003969llvm::Constant *CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00003970 return ObjCTypes.getCppAtomicObjectFunction();
3971}
3972
Chris Lattnerd4808922009-03-22 21:03:39 +00003973llvm::Constant *CGObjCMac::EnumerationMutationFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00003974 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson3f35a262008-08-31 04:05:03 +00003975}
3976
John McCallbd309292010-07-06 01:34:17 +00003977void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
3978 return EmitTryOrSynchronizedStmt(CGF, S);
3979}
3980
3981void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
3982 const ObjCAtSynchronizedStmt &S) {
3983 return EmitTryOrSynchronizedStmt(CGF, S);
3984}
3985
John McCall65bea082010-07-21 06:59:36 +00003986namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00003987 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCall65bea082010-07-21 06:59:36 +00003988 const Stmt &S;
John McCall7f416cc2015-09-08 08:05:57 +00003989 Address SyncArgSlot;
3990 Address CallTryExitVar;
3991 Address ExceptionData;
John McCall65bea082010-07-21 06:59:36 +00003992 ObjCTypesHelper &ObjCTypes;
3993 PerformFragileFinally(const Stmt *S,
John McCall7f416cc2015-09-08 08:05:57 +00003994 Address SyncArgSlot,
3995 Address CallTryExitVar,
3996 Address ExceptionData,
John McCall65bea082010-07-21 06:59:36 +00003997 ObjCTypesHelper *ObjCTypes)
John McCall2dd7d442010-08-04 05:59:32 +00003998 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCall65bea082010-07-21 06:59:36 +00003999 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
4000
Craig Topper4f12f102014-03-12 06:41:41 +00004001 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall65bea082010-07-21 06:59:36 +00004002 // Check whether we need to call objc_exception_try_exit.
4003 // In optimized code, this branch will always be folded.
4004 llvm::BasicBlock *FinallyCallExit =
4005 CGF.createBasicBlock("finally.call_exit");
4006 llvm::BasicBlock *FinallyNoCallExit =
4007 CGF.createBasicBlock("finally.no_call_exit");
4008 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
4009 FinallyCallExit, FinallyNoCallExit);
4010
4011 CGF.EmitBlock(FinallyCallExit);
John McCall882987f2013-02-28 19:01:20 +00004012 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004013 ExceptionData.getPointer());
John McCall65bea082010-07-21 06:59:36 +00004014
4015 CGF.EmitBlock(FinallyNoCallExit);
4016
4017 if (isa<ObjCAtTryStmt>(S)) {
4018 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCallcebe0ca2010-08-11 00:16:14 +00004019 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall638d4f52013-04-03 00:56:07 +00004020 // Don't try to do the @finally if this is an EH cleanup.
4021 if (flags.isForEHCleanup()) return;
4022
John McCallcebe0ca2010-08-11 00:16:14 +00004023 // Save the current cleanup destination in case there's
4024 // control flow inside the finally statement.
4025 llvm::Value *CurCleanupDest =
4026 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
4027
John McCall65bea082010-07-21 06:59:36 +00004028 CGF.EmitStmt(FinallyStmt->getFinallyBody());
4029
John McCallcebe0ca2010-08-11 00:16:14 +00004030 if (CGF.HaveInsertPoint()) {
4031 CGF.Builder.CreateStore(CurCleanupDest,
4032 CGF.getNormalCleanupDestSlot());
4033 } else {
4034 // Currently, the end of the cleanup must always exist.
4035 CGF.EnsureInsertPoint();
4036 }
4037 }
John McCall65bea082010-07-21 06:59:36 +00004038 } else {
4039 // Emit objc_sync_exit(expr); as finally's sole statement for
4040 // @synchronized.
John McCall2dd7d442010-08-04 05:59:32 +00004041 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCall882987f2013-02-28 19:01:20 +00004042 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCall65bea082010-07-21 06:59:36 +00004043 }
4044 }
4045 };
John McCall42227ed2010-07-31 23:20:56 +00004046
4047 class FragileHazards {
4048 CodeGenFunction &CGF;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004049 SmallVector<llvm::Value*, 20> Locals;
John McCall42227ed2010-07-31 23:20:56 +00004050 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
4051
4052 llvm::InlineAsm *ReadHazard;
4053 llvm::InlineAsm *WriteHazard;
4054
4055 llvm::FunctionType *GetAsmFnType();
4056
4057 void collectLocals();
4058 void emitReadHazard(CGBuilderTy &Builder);
4059
4060 public:
4061 FragileHazards(CodeGenFunction &CGF);
John McCall2dd7d442010-08-04 05:59:32 +00004062
John McCall42227ed2010-07-31 23:20:56 +00004063 void emitWriteHazard();
John McCall2dd7d442010-08-04 05:59:32 +00004064 void emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004065 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00004066} // end anonymous namespace
John McCall42227ed2010-07-31 23:20:56 +00004067
4068/// Create the fragile-ABI read and write hazards based on the current
4069/// state of the function, which is presumed to be immediately prior
4070/// to a @try block. These hazards are used to maintain correct
4071/// semantics in the face of optimization and the fragile ABI's
4072/// cavalier use of setjmp/longjmp.
4073FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
4074 collectLocals();
4075
4076 if (Locals.empty()) return;
4077
4078 // Collect all the blocks in the function.
4079 for (llvm::Function::iterator
4080 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
4081 BlocksBeforeTry.insert(&*I);
4082
4083 llvm::FunctionType *AsmFnTy = GetAsmFnType();
4084
4085 // Create a read hazard for the allocas. This inhibits dead-store
4086 // optimizations and forces the values to memory. This hazard is
4087 // inserted before any 'throwing' calls in the protected scope to
4088 // reflect the possibility that the variables might be read from the
4089 // catch block if the call throws.
4090 {
4091 std::string Constraint;
4092 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
4093 if (I) Constraint += ',';
4094 Constraint += "*m";
4095 }
4096
4097 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
4098 }
4099
4100 // Create a write hazard for the allocas. This inhibits folding
4101 // loads across the hazard. This hazard is inserted at the
4102 // beginning of the catch path to reflect the possibility that the
4103 // variables might have been written within the protected scope.
4104 {
4105 std::string Constraint;
4106 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
4107 if (I) Constraint += ',';
4108 Constraint += "=*m";
4109 }
4110
4111 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
4112 }
4113}
4114
4115/// Emit a write hazard at the current location.
4116void FragileHazards::emitWriteHazard() {
4117 if (Locals.empty()) return;
4118
John McCall882987f2013-02-28 19:01:20 +00004119 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall42227ed2010-07-31 23:20:56 +00004120}
4121
John McCall42227ed2010-07-31 23:20:56 +00004122void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
4123 assert(!Locals.empty());
John McCall882987f2013-02-28 19:01:20 +00004124 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
4125 call->setDoesNotThrow();
4126 call->setCallingConv(CGF.getRuntimeCC());
John McCall42227ed2010-07-31 23:20:56 +00004127}
4128
4129/// Emit read hazards in all the protected blocks, i.e. all the blocks
4130/// which have been inserted since the beginning of the try.
John McCall2dd7d442010-08-04 05:59:32 +00004131void FragileHazards::emitHazardsInNewBlocks() {
John McCall42227ed2010-07-31 23:20:56 +00004132 if (Locals.empty()) return;
4133
John McCall7f416cc2015-09-08 08:05:57 +00004134 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall42227ed2010-07-31 23:20:56 +00004135
4136 // Iterate through all blocks, skipping those prior to the try.
4137 for (llvm::Function::iterator
4138 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
4139 llvm::BasicBlock &BB = *FI;
4140 if (BlocksBeforeTry.count(&BB)) continue;
4141
4142 // Walk through all the calls in the block.
4143 for (llvm::BasicBlock::iterator
4144 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
4145 llvm::Instruction &I = *BI;
4146
4147 // Ignore instructions that aren't non-intrinsic calls.
4148 // These are the only calls that can possibly call longjmp.
4149 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I)) continue;
4150 if (isa<llvm::IntrinsicInst>(I))
4151 continue;
4152
4153 // Ignore call sites marked nounwind. This may be questionable,
4154 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
4155 llvm::CallSite CS(&I);
4156 if (CS.doesNotThrow()) continue;
4157
John McCall2dd7d442010-08-04 05:59:32 +00004158 // Insert a read hazard before the call. This will ensure that
4159 // any writes to the locals are performed before making the
4160 // call. If the call throws, then this is sufficient to
4161 // guarantee correctness as long as it doesn't also write to any
4162 // locals.
John McCall42227ed2010-07-31 23:20:56 +00004163 Builder.SetInsertPoint(&BB, BI);
4164 emitReadHazard(Builder);
4165 }
4166 }
4167}
4168
4169static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, llvm::Value *V) {
4170 if (V) S.insert(V);
4171}
4172
John McCall7f416cc2015-09-08 08:05:57 +00004173static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
4174 if (V.isValid()) S.insert(V.getPointer());
4175}
4176
John McCall42227ed2010-07-31 23:20:56 +00004177void FragileHazards::collectLocals() {
4178 // Compute a set of allocas to ignore.
4179 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
4180 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
4181 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall42227ed2010-07-31 23:20:56 +00004182
4183 // Collect all the allocas currently in the function. This is
4184 // probably way too aggressive.
4185 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
4186 for (llvm::BasicBlock::iterator
4187 I = Entry.begin(), E = Entry.end(); I != E; ++I)
4188 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
4189 Locals.push_back(&*I);
4190}
4191
4192llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004193 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall9dc0db22011-05-15 01:53:33 +00004194 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
4195 tys[i] = Locals[i]->getType();
4196 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCall65bea082010-07-21 06:59:36 +00004197}
4198
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004199/*
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004200
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004201 Objective-C setjmp-longjmp (sjlj) Exception Handling
4202 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004203
John McCallbd309292010-07-06 01:34:17 +00004204 A catch buffer is a setjmp buffer plus:
4205 - a pointer to the exception that was caught
4206 - a pointer to the previous exception data buffer
4207 - two pointers of reserved storage
4208 Therefore catch buffers form a stack, with a pointer to the top
4209 of the stack kept in thread-local storage.
4210
4211 objc_exception_try_enter pushes a catch buffer onto the EH stack.
4212 objc_exception_try_exit pops the given catch buffer, which is
4213 required to be the top of the EH stack.
4214 objc_exception_throw pops the top of the EH stack, writes the
4215 thrown exception into the appropriate field, and longjmps
4216 to the setjmp buffer. It crashes the process (with a printf
4217 and an abort()) if there are no catch buffers on the stack.
4218 objc_exception_extract just reads the exception pointer out of the
4219 catch buffer.
4220
4221 There's no reason an implementation couldn't use a light-weight
4222 setjmp here --- something like __builtin_setjmp, but API-compatible
4223 with the heavyweight setjmp. This will be more important if we ever
4224 want to implement correct ObjC/C++ exception interactions for the
4225 fragile ABI.
4226
4227 Note that for this use of setjmp/longjmp to be correct, we may need
4228 to mark some local variables volatile: if a non-volatile local
4229 variable is modified between the setjmp and the longjmp, it has
4230 indeterminate value. For the purposes of LLVM IR, it may be
4231 sufficient to make loads and stores within the @try (to variables
4232 declared outside the @try) volatile. This is necessary for
4233 optimized correctness, but is not currently being done; this is
4234 being tracked as rdar://problem/8160285
4235
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004236 The basic framework for a @try-catch-finally is as follows:
4237 {
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004238 objc_exception_data d;
4239 id _rethrow = null;
Anders Carlssonda0e4562009-02-07 21:26:04 +00004240 bool _call_try_exit = true;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004241
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004242 objc_exception_try_enter(&d);
4243 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004244 ... try body ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004245 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004246 // exception path
4247 id _caught = objc_exception_extract(&d);
4248
4249 // enter new try scope for handlers
4250 if (!setjmp(d.jmp_buf)) {
4251 ... match exception and execute catch blocks ...
4252
4253 // fell off end, rethrow.
4254 _rethrow = _caught;
4255 ... jump-through-finally to finally_rethrow ...
4256 } else {
4257 // exception in catch block
4258 _rethrow = objc_exception_extract(&d);
4259 _call_try_exit = false;
4260 ... jump-through-finally to finally_rethrow ...
4261 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004262 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004263 ... jump-through-finally to finally_end ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004264
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004265 finally:
Anders Carlssonda0e4562009-02-07 21:26:04 +00004266 if (_call_try_exit)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004267 objc_exception_try_exit(&d);
Anders Carlssonda0e4562009-02-07 21:26:04 +00004268
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004269 ... finally block ....
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004270 ... dispatch to finally destination ...
4271
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004272 finally_rethrow:
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004273 objc_exception_throw(_rethrow);
4274
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004275 finally_end:
4276 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004277
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004278 This framework differs slightly from the one gcc uses, in that gcc
4279 uses _rethrow to determine if objc_exception_try_exit should be called
4280 and if the object should be rethrown. This breaks in the face of
4281 throwing nil and introduces unnecessary branches.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004282
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004283 We specialize this framework for a few particular circumstances:
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004284
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004285 - If there are no catch blocks, then we avoid emitting the second
4286 exception handling context.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004287
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004288 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
4289 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004290
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004291 - FIXME: If there is no @finally block we can do a few more
4292 simplifications.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004293
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004294 Rethrows and Jumps-Through-Finally
4295 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004296
John McCallbd309292010-07-06 01:34:17 +00004297 '@throw;' is supported by pushing the currently-caught exception
4298 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004299
John McCallbd309292010-07-06 01:34:17 +00004300 Branches through the @finally block are handled with an ordinary
4301 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
4302 exceptions are not compatible with C++ exceptions, and this is
4303 hardly the only place where this will go wrong.
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004304
John McCallbd309292010-07-06 01:34:17 +00004305 @synchronized(expr) { stmt; } is emitted as if it were:
4306 id synch_value = expr;
4307 objc_sync_enter(synch_value);
4308 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004309*/
4310
Fariborz Jahanianc2ad6dc2008-11-21 00:49:24 +00004311void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
4312 const Stmt &S) {
4313 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallbd309292010-07-06 01:34:17 +00004314
4315 // A destination for the fall-through edges of the catch handlers to
4316 // jump to.
4317 CodeGenFunction::JumpDest FinallyEnd =
4318 CGF.getJumpDestInCurrentScope("finally.end");
4319
4320 // A destination for the rethrow edge of the catch handlers to jump
4321 // to.
4322 CodeGenFunction::JumpDest FinallyRethrow =
4323 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004324
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004325 // For @synchronized, call objc_sync_enter(sync.expr). The
4326 // evaluation of the expression must occur before we enter the
John McCall2dd7d442010-08-04 05:59:32 +00004327 // @synchronized. We can't avoid a temp here because we need the
4328 // value to be preserved. If the backend ever does liveness
4329 // correctly after setjmp, this will be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00004330 Address SyncArgSlot = Address::invalid();
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004331 if (!isTry) {
John McCall2dd7d442010-08-04 05:59:32 +00004332 llvm::Value *SyncArg =
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004333 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
4334 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004335 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall2dd7d442010-08-04 05:59:32 +00004336
John McCall7f416cc2015-09-08 08:05:57 +00004337 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
4338 CGF.getPointerAlign(), "sync.arg");
John McCall2dd7d442010-08-04 05:59:32 +00004339 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004340 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004341
John McCall2dd7d442010-08-04 05:59:32 +00004342 // Allocate memory for the setjmp buffer. This needs to be kept
4343 // live throughout the try and catch blocks.
John McCall7f416cc2015-09-08 08:05:57 +00004344 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
4345 CGF.getPointerAlign(),
4346 "exceptiondata.ptr");
John McCall2dd7d442010-08-04 05:59:32 +00004347
John McCall42227ed2010-07-31 23:20:56 +00004348 // Create the fragile hazards. Note that this will not capture any
4349 // of the allocas required for exception processing, but will
4350 // capture the current basic block (which extends all the way to the
4351 // setjmp call) as "before the @try".
4352 FragileHazards Hazards(CGF);
4353
John McCallbd309292010-07-06 01:34:17 +00004354 // Create a flag indicating whether the cleanup needs to call
4355 // objc_exception_try_exit. This is true except when
4356 // - no catches match and we're branching through the cleanup
4357 // just to rethrow the exception, or
4358 // - a catch matched and we're falling out of the catch handler.
John McCall2dd7d442010-08-04 05:59:32 +00004359 // The setjmp-safety rule here is that we should always store to this
4360 // variable in a place that dominates the branch through the cleanup
4361 // without passing through any setjmps.
John McCall7f416cc2015-09-08 08:05:57 +00004362 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
4363 CharUnits::One(),
4364 "_call_try_exit");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004365
John McCall9916e3f2010-10-04 23:42:51 +00004366 // A slot containing the exception to rethrow. Only needed when we
4367 // have both a @catch and a @finally.
John McCall7f416cc2015-09-08 08:05:57 +00004368 Address PropagatingExnVar = Address::invalid();
John McCall9916e3f2010-10-04 23:42:51 +00004369
John McCallbd309292010-07-06 01:34:17 +00004370 // Push a normal cleanup to leave the try scope.
John McCall638d4f52013-04-03 00:56:07 +00004371 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall2dd7d442010-08-04 05:59:32 +00004372 SyncArgSlot,
John McCallcda666c2010-07-21 07:22:38 +00004373 CallTryExitVar,
4374 ExceptionData,
4375 &ObjCTypes);
John McCallbd309292010-07-06 01:34:17 +00004376
4377 // Enter a try block:
4378 // - Call objc_exception_try_enter to push ExceptionData on top of
4379 // the EH stack.
Nico Weber6307cf02015-02-26 20:43:00 +00004380 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004381 ExceptionData.getPointer());
John McCallbd309292010-07-06 01:34:17 +00004382
4383 // - Call setjmp on the exception data buffer.
4384 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
4385 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
David Blaikie6b2a8302015-04-03 17:47:16 +00004386 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
John McCall7f416cc2015-09-08 08:05:57 +00004387 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
4388 "setjmp_buffer");
Nico Weber6307cf02015-02-26 20:43:00 +00004389 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
4390 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004391 SetJmpResult->setCanReturnTwice();
John McCallbd309292010-07-06 01:34:17 +00004392
4393 // If setjmp returned 0, enter the protected block; otherwise,
4394 // branch to the handler.
Daniel Dunbar75283ff2008-11-11 02:29:29 +00004395 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
4396 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallbd309292010-07-06 01:34:17 +00004397 llvm::Value *DidCatch =
John McCallcebe0ca2010-08-11 00:16:14 +00004398 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4399 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004400
John McCallbd309292010-07-06 01:34:17 +00004401 // Emit the protected block.
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004402 CGF.EmitBlock(TryBlock);
John McCall2dd7d442010-08-04 05:59:32 +00004403 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004404 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallbd309292010-07-06 01:34:17 +00004405 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall2dd7d442010-08-04 05:59:32 +00004406
4407 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004408
John McCallbd309292010-07-06 01:34:17 +00004409 // Emit the exception handler block.
Daniel Dunbar7f086782008-09-27 23:30:04 +00004410 CGF.EmitBlock(TryHandler);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004411
John McCall42227ed2010-07-31 23:20:56 +00004412 // Don't optimize loads of the in-scope locals across this point.
4413 Hazards.emitWriteHazard();
4414
John McCallbd309292010-07-06 01:34:17 +00004415 // For a @synchronized (or a @try with no catches), just branch
4416 // through the cleanup to the rethrow block.
4417 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
4418 // Tell the cleanup not to re-pop the exit.
John McCall2dd7d442010-08-04 05:59:32 +00004419 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004420 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallbd309292010-07-06 01:34:17 +00004421
4422 // Otherwise, we have to match against the caught exceptions.
4423 } else {
John McCall2dd7d442010-08-04 05:59:32 +00004424 // Retrieve the exception object. We may emit multiple blocks but
4425 // nothing can cross this so the value is already in SSA form.
4426 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004427 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004428 ExceptionData.getPointer(), "caught");
John McCall2dd7d442010-08-04 05:59:32 +00004429
John McCallbd309292010-07-06 01:34:17 +00004430 // Push the exception to rethrow onto the EH value stack for the
4431 // benefit of any @throws in the handlers.
4432 CGF.ObjCEHValueStack.push_back(Caught);
4433
Douglas Gregor96c79492010-04-23 22:50:49 +00004434 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004435
Craig Topper8a13c412014-05-21 05:09:00 +00004436 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallbd309292010-07-06 01:34:17 +00004437
Craig Topper8a13c412014-05-21 05:09:00 +00004438 llvm::BasicBlock *CatchBlock = nullptr;
4439 llvm::BasicBlock *CatchHandler = nullptr;
John McCall2dd7d442010-08-04 05:59:32 +00004440 if (HasFinally) {
John McCall9916e3f2010-10-04 23:42:51 +00004441 // Save the currently-propagating exception before
4442 // objc_exception_try_enter clears the exception slot.
4443 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
John McCall7f416cc2015-09-08 08:05:57 +00004444 CGF.getPointerAlign(),
John McCall9916e3f2010-10-04 23:42:51 +00004445 "propagating_exception");
4446 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
4447
John McCall2dd7d442010-08-04 05:59:32 +00004448 // Enter a new exception try block (in case a @catch block
4449 // throws an exception).
John McCall882987f2013-02-28 19:01:20 +00004450 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004451 ExceptionData.getPointer());
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004452
John McCall2dd7d442010-08-04 05:59:32 +00004453 llvm::CallInst *SetJmpResult =
John McCall882987f2013-02-28 19:01:20 +00004454 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4455 SetJmpBuffer, "setjmp.result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004456 SetJmpResult->setCanReturnTwice();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004457
John McCall2dd7d442010-08-04 05:59:32 +00004458 llvm::Value *Threw =
4459 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4460
4461 CatchBlock = CGF.createBasicBlock("catch");
4462 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4463 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4464
4465 CGF.EmitBlock(CatchBlock);
4466 }
4467
4468 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004469
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004470 // Handle catch list. As a special case we check if everything is
4471 // matched and avoid generating code for falling off the end if
4472 // so.
4473 bool AllMatched = false;
Douglas Gregor96c79492010-04-23 22:50:49 +00004474 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4475 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004476
Douglas Gregor46a572b2010-04-26 16:46:50 +00004477 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00004478 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar523208f2008-09-27 07:36:24 +00004479
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004480 // catch(...) always matches.
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004481 if (!CatchParam) {
4482 AllMatched = true;
4483 } else {
John McCall9dd450b2009-09-21 23:43:11 +00004484 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004485
John McCallbd309292010-07-06 01:34:17 +00004486 // catch(id e) always matches under this ABI, since only
4487 // ObjC exceptions end up here in the first place.
Daniel Dunbar86919f42008-09-27 22:21:14 +00004488 // FIXME: For the time being we also match id<X>; this should
4489 // be rejected by Sema instead.
Eli Friedman55179ca2009-07-11 00:57:02 +00004490 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004491 AllMatched = true;
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004492 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004493
John McCallbd309292010-07-06 01:34:17 +00004494 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004495 if (AllMatched) {
John McCallbd309292010-07-06 01:34:17 +00004496 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4497
Anders Carlsson9396a892008-09-11 09:15:33 +00004498 if (CatchParam) {
John McCall1c9c3fd2010-10-15 04:57:14 +00004499 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004500 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallbd309292010-07-06 01:34:17 +00004501
4502 // These types work out because ConvertType(id) == i8*.
John McCall17f02752015-10-30 00:56:02 +00004503 EmitInitOfCatchParam(CGF, Caught, CatchParam);
Anders Carlsson9396a892008-09-11 09:15:33 +00004504 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004505
Anders Carlsson9396a892008-09-11 09:15:33 +00004506 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004507
4508 // The scope of the catch variable ends right here.
4509 CatchVarCleanups.ForceCleanup();
4510
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004511 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004512 break;
4513 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004514
Steve Naroff7cae42b2009-07-10 23:34:53 +00004515 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall96fa4842010-05-17 21:00:27 +00004516 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallbd309292010-07-06 01:34:17 +00004517
4518 // FIXME: @catch (Class c) ?
John McCall96fa4842010-05-17 21:00:27 +00004519 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4520 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004521
4522 // Check if the @catch block matches the exception object.
John McCall882987f2013-02-28 19:01:20 +00004523 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004524
John McCall882987f2013-02-28 19:01:20 +00004525 llvm::Value *matchArgs[] = { Class, Caught };
John McCallbd309292010-07-06 01:34:17 +00004526 llvm::CallInst *Match =
John McCall882987f2013-02-28 19:01:20 +00004527 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4528 matchArgs, "match");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004529
John McCallbd309292010-07-06 01:34:17 +00004530 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4531 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004532
4533 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbar7f086782008-09-27 23:30:04 +00004534 MatchedBlock, NextCatchBlock);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004535
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004536 // Emit the @catch block.
4537 CGF.EmitBlock(MatchedBlock);
John McCallbd309292010-07-06 01:34:17 +00004538
4539 // Collect any cleanups for the catch variable. The scope lasts until
4540 // the end of the catch body.
John McCall2dd7d442010-08-04 05:59:32 +00004541 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallbd309292010-07-06 01:34:17 +00004542
John McCall1c9c3fd2010-10-15 04:57:14 +00004543 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004544 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004545
John McCallbd309292010-07-06 01:34:17 +00004546 // Initialize the catch variable.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004547 llvm::Value *Tmp =
4548 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004549 CGF.ConvertType(CatchParam->getType()));
John McCall17f02752015-10-30 00:56:02 +00004550 EmitInitOfCatchParam(CGF, Tmp, CatchParam);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004551
Anders Carlsson9396a892008-09-11 09:15:33 +00004552 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004553
4554 // We're done with the catch variable.
4555 CatchVarCleanups.ForceCleanup();
4556
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004557 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004558
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004559 CGF.EmitBlock(NextCatchBlock);
4560 }
4561
John McCallbd309292010-07-06 01:34:17 +00004562 CGF.ObjCEHValueStack.pop_back();
4563
John McCall2dd7d442010-08-04 05:59:32 +00004564 // If nothing wanted anything to do with the caught exception,
4565 // kill the extract call.
4566 if (Caught->use_empty())
4567 Caught->eraseFromParent();
4568
4569 if (!AllMatched)
4570 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4571
4572 if (HasFinally) {
4573 // Emit the exception handler for the @catch blocks.
4574 CGF.EmitBlock(CatchHandler);
4575
4576 // In theory we might now need a write hazard, but actually it's
4577 // unnecessary because there's no local-accessing code between
4578 // the try's write hazard and here.
4579 //Hazards.emitWriteHazard();
4580
John McCall9916e3f2010-10-04 23:42:51 +00004581 // Extract the new exception and save it to the
4582 // propagating-exception slot.
John McCall7f416cc2015-09-08 08:05:57 +00004583 assert(PropagatingExnVar.isValid());
John McCall9916e3f2010-10-04 23:42:51 +00004584 llvm::CallInst *NewCaught =
John McCall882987f2013-02-28 19:01:20 +00004585 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004586 ExceptionData.getPointer(), "caught");
John McCall9916e3f2010-10-04 23:42:51 +00004587 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4588
John McCall2dd7d442010-08-04 05:59:32 +00004589 // Don't pop the catch handler; the throw already did.
4590 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004591 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004592 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004593 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004594
John McCall42227ed2010-07-31 23:20:56 +00004595 // Insert read hazards as required in the new blocks.
John McCall2dd7d442010-08-04 05:59:32 +00004596 Hazards.emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004597
John McCallbd309292010-07-06 01:34:17 +00004598 // Pop the cleanup.
John McCall2dd7d442010-08-04 05:59:32 +00004599 CGF.Builder.restoreIP(TryFallthroughIP);
4600 if (CGF.HaveInsertPoint())
4601 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallbd309292010-07-06 01:34:17 +00004602 CGF.PopCleanupBlock();
John McCall2dd7d442010-08-04 05:59:32 +00004603 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004604
John McCallbd309292010-07-06 01:34:17 +00004605 // Emit the rethrow block.
John McCall42227ed2010-07-31 23:20:56 +00004606 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallad5d61e2010-07-23 21:56:41 +00004607 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallbd309292010-07-06 01:34:17 +00004608 if (CGF.HaveInsertPoint()) {
John McCall9916e3f2010-10-04 23:42:51 +00004609 // If we have a propagating-exception variable, check it.
4610 llvm::Value *PropagatingExn;
John McCall7f416cc2015-09-08 08:05:57 +00004611 if (PropagatingExnVar.isValid()) {
John McCall9916e3f2010-10-04 23:42:51 +00004612 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall2dd7d442010-08-04 05:59:32 +00004613
John McCall9916e3f2010-10-04 23:42:51 +00004614 // Otherwise, just look in the buffer for the exception to throw.
4615 } else {
4616 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004617 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004618 ExceptionData.getPointer());
John McCall9916e3f2010-10-04 23:42:51 +00004619 PropagatingExn = Caught;
4620 }
4621
John McCall882987f2013-02-28 19:01:20 +00004622 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4623 PropagatingExn);
John McCallbd309292010-07-06 01:34:17 +00004624 CGF.Builder.CreateUnreachable();
Fariborz Jahaniane2caaaa2008-11-21 19:21:53 +00004625 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004626
John McCall42227ed2010-07-31 23:20:56 +00004627 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004628}
4629
4630void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004631 const ObjCAtThrowStmt &S,
4632 bool ClearInsertionPoint) {
Anders Carlssone005aa12008-09-09 16:16:55 +00004633 llvm::Value *ExceptionAsObject;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004634
Anders Carlssone005aa12008-09-09 16:16:55 +00004635 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00004636 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004637 ExceptionAsObject =
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004638 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlssone005aa12008-09-09 16:16:55 +00004639 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004640 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004641 "Unexpected rethrow outside @catch block.");
Anders Carlssonbf8a1be2009-02-07 21:37:21 +00004642 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlssone005aa12008-09-09 16:16:55 +00004643 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004644
John McCall882987f2013-02-28 19:01:20 +00004645 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallbd309292010-07-06 01:34:17 +00004646 ->setDoesNotReturn();
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004647 CGF.Builder.CreateUnreachable();
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004648
4649 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004650 if (ClearInsertionPoint)
4651 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004652}
4653
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004654/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004655/// object: objc_read_weak (id *src)
4656///
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004657llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004658 Address AddrWeakObj) {
4659 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004660 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4661 ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004662 llvm::Value *read_weak =
4663 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004664 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00004665 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004666 return read_weak;
4667}
4668
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004669/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4670/// objc_assign_weak (id src, id *dst)
4671///
4672void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004673 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004674 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004675 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004676 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004677 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004678 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4679 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004680 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4681 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004682 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4683 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004684 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004685 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4686 args, "weakassign");
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004687}
4688
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004689/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4690/// objc_assign_global (id src, id *dst)
4691///
4692void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004693 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00004694 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004695 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004696 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004697 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004698 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004699 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4700 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004701 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4702 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004703 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4704 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004705 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00004706 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00004707 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4708 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00004709 else
John McCall882987f2013-02-28 19:01:20 +00004710 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4711 args, "threadlocalassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004712}
4713
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004714/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004715/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004716///
4717void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004718 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004719 llvm::Value *ivarOffset) {
4720 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2192fe52011-07-18 04:24:23 +00004721 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004722 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004723 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004724 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004725 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4726 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004727 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4728 }
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004729 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4730 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004731 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00004732 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004733}
4734
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004735/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4736/// objc_assign_strongCast (id src, id *dst)
4737///
4738void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004739 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004740 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004741 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004742 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004743 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004744 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4745 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004746 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4747 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004748 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4749 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004750 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004751 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004752 args, "strongassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004753}
4754
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004755void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004756 Address DestPtr,
4757 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004758 llvm::Value *size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004759 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4760 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004761 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCall882987f2013-02-28 19:01:20 +00004762 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004763}
4764
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004765/// EmitObjCValueForIvar - Code Gen for ivar reference.
4766///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004767LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4768 QualType ObjectTy,
4769 llvm::Value *BaseValue,
4770 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004771 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004772 const ObjCInterfaceDecl *ID =
4773 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004774 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4775 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004776}
4777
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004778llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004779 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004780 const ObjCIvarDecl *Ivar) {
Eli Friedman8cbca202012-11-06 22:15:52 +00004781 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4782 return llvm::ConstantInt::get(
4783 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4784 Offset);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004785}
4786
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004787/* *** Private Interface *** */
4788
4789/// EmitImageInfo - Emit the image info marker used to encode some module
4790/// level information.
4791///
4792/// See: <rdr://4810609&4810587&4810587>
4793/// struct IMAGE_INFO {
4794/// unsigned version;
4795/// unsigned flags;
4796/// };
4797enum ImageInfoFlags {
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004798 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004799 eImageInfo_GarbageCollected = (1 << 1),
4800 eImageInfo_GCOnly = (1 << 2),
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004801 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbar75e909f2009-04-20 07:11:47 +00004802
Daniel Dunbar5e639272010-04-25 20:39:01 +00004803 // A flag indicating that the module has no instances of a @synthesize of a
4804 // superclass variable. <rdar://problem/6803242>
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004805 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Manman Ren96df0b32016-01-29 23:45:01 +00004806 eImageInfo_ImageIsSimulated = (1 << 5),
4807 eImageInfo_ClassProperties = (1 << 6)
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004808};
4809
Daniel Dunbar5e639272010-04-25 20:39:01 +00004810void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004811 unsigned version = 0; // Version is unused?
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004812 const char *Section = (ObjCABI == 1) ?
4813 "__OBJC, __image_info,regular" :
4814 "__DATA, __objc_imageinfo, regular, no_dead_strip";
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004815
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004816 // Generate module-level named metadata to convey this information to the
4817 // linker and code-gen.
4818 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004819
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004820 // Add the ObjC ABI version to the module flags.
4821 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4822 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4823 version);
4824 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
4825 llvm::MDString::get(VMContext,Section));
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004826
David Blaikiebbafb8a2012-03-11 07:00:24 +00004827 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004828 // Non-GC overrides those files which specify GC.
4829 Mod.addModuleFlag(llvm::Module::Override,
4830 "Objective-C Garbage Collection", (uint32_t)0);
4831 } else {
4832 // Add the ObjC garbage collection value.
4833 Mod.addModuleFlag(llvm::Module::Error,
4834 "Objective-C Garbage Collection",
4835 eImageInfo_GarbageCollected);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004836
David Blaikiebbafb8a2012-03-11 07:00:24 +00004837 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004838 // Add the ObjC GC Only value.
4839 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4840 eImageInfo_GCOnly);
4841
4842 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004843 llvm::Metadata *Ops[2] = {
4844 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4845 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4846 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004847 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4848 llvm::MDNode::get(VMContext, Ops));
4849 }
4850 }
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004851
4852 // Indicate whether we're compiling this to run on a simulator.
4853 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Tim Northover756447a2015-10-30 16:30:36 +00004854 if ((Triple.isiOS() || Triple.isWatchOS()) &&
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004855 (Triple.getArch() == llvm::Triple::x86 ||
4856 Triple.getArch() == llvm::Triple::x86_64))
4857 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4858 eImageInfo_ImageIsSimulated);
Manman Ren96df0b32016-01-29 23:45:01 +00004859
4860 // Indicate whether we are generating class properties.
4861 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Class Properties",
4862 eImageInfo_ClassProperties);
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004863}
4864
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004865// struct objc_module {
4866// unsigned long version;
4867// unsigned long size;
4868// const char *name;
4869// Symtab symtab;
4870// };
4871
4872// FIXME: Get from somewhere
4873static const int ModuleVersion = 7;
4874
4875void CGObjCMac::EmitModuleInfo() {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004876 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004877
John McCall176f8922016-11-30 02:39:18 +00004878 ConstantInitBuilder builder(CGM);
4879 auto values = builder.beginStruct(ObjCTypes.ModuleTy);
4880 values.addInt(ObjCTypes.LongTy, ModuleVersion);
4881 values.addInt(ObjCTypes.LongTy, Size);
4882 // This used to be the filename, now it is unused. <rdr://4327263>
4883 values.add(GetClassName(StringRef("")));
4884 values.add(EmitModuleSymbols());
4885 CreateMetadataVar("OBJC_MODULES", values,
John McCall7f416cc2015-09-08 08:05:57 +00004886 "__OBJC,__module_info,regular,no_dead_strip",
4887 CGM.getPointerAlign(), true);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004888}
4889
4890llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004891 unsigned NumClasses = DefinedClasses.size();
4892 unsigned NumCategories = DefinedCategories.size();
4893
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004894 // Return null if no symbols were defined.
4895 if (!NumClasses && !NumCategories)
Owen Anderson0b75f232009-07-31 20:28:54 +00004896 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004897
John McCall176f8922016-11-30 02:39:18 +00004898 ConstantInitBuilder builder(CGM);
4899 auto values = builder.beginStruct();
4900 values.addInt(ObjCTypes.LongTy, 0);
4901 values.addNullPointer(ObjCTypes.SelectorPtrTy);
4902 values.addInt(ObjCTypes.ShortTy, NumClasses);
4903 values.addInt(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004904
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004905 // The runtime expects exactly the list of defined classes followed
4906 // by the list of defined categories, in a single array.
John McCall176f8922016-11-30 02:39:18 +00004907 auto array = values.beginArray(ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004908 for (unsigned i=0; i<NumClasses; i++) {
4909 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
4910 assert(ID);
4911 if (ObjCImplementationDecl *IMP = ID->getImplementation())
4912 // We are implementing a weak imported interface. Give it external linkage
4913 if (ID->isWeakImported() && !IMP->isWeakImported())
4914 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
John McCall176f8922016-11-30 02:39:18 +00004915
4916 array.addBitCast(DefinedClasses[i], ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00004917 }
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004918 for (unsigned i=0; i<NumCategories; i++)
John McCall176f8922016-11-30 02:39:18 +00004919 array.addBitCast(DefinedCategories[i], ObjCTypes.Int8PtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004920
John McCall176f8922016-11-30 02:39:18 +00004921 array.finishAndAddTo(values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004922
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004923 llvm::GlobalVariable *GV = CreateMetadataVar(
John McCall176f8922016-11-30 02:39:18 +00004924 "OBJC_SYMBOLS", values, "__OBJC,__symbols,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00004925 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00004926 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004927}
4928
John McCall882987f2013-02-28 19:01:20 +00004929llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
4930 IdentifierInfo *II) {
John McCall31168b02011-06-15 23:02:42 +00004931 LazySymbols.insert(II);
4932
4933 llvm::GlobalVariable *&Entry = ClassReferences[II];
4934
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004935 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004936 llvm::Constant *Casted =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004937 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCall31168b02011-06-15 23:02:42 +00004938 ObjCTypes.ClassPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004939 Entry = CreateMetadataVar(
4940 "OBJC_CLASS_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004941 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
4942 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004943 }
John McCall31168b02011-06-15 23:02:42 +00004944
John McCall7f416cc2015-09-08 08:05:57 +00004945 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004946}
4947
John McCall882987f2013-02-28 19:01:20 +00004948llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00004949 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00004950 // If the class has the objc_runtime_visible attribute, we need to
4951 // use the Objective-C runtime to get the class.
4952 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
4953 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
4954
John McCall882987f2013-02-28 19:01:20 +00004955 return EmitClassRefFromId(CGF, ID->getIdentifier());
John McCall31168b02011-06-15 23:02:42 +00004956}
4957
John McCall882987f2013-02-28 19:01:20 +00004958llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00004959 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCall882987f2013-02-28 19:01:20 +00004960 return EmitClassRefFromId(CGF, II);
John McCall31168b02011-06-15 23:02:42 +00004961}
4962
John McCall7f416cc2015-09-08 08:05:57 +00004963llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
4964 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
4965}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004966
John McCall7f416cc2015-09-08 08:05:57 +00004967Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
4968 CharUnits Align = CGF.getPointerAlign();
4969
4970 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004971 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004972 llvm::Constant *Casted =
Owen Andersonade90fd2009-07-29 18:54:39 +00004973 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004974 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00004975 Entry = CreateMetadataVar(
4976 "OBJC_SELECTOR_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00004977 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman5c205962013-02-05 23:08:45 +00004978 Entry->setExternallyInitialized(true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004979 }
4980
John McCall7f416cc2015-09-08 08:05:57 +00004981 return Address(Entry, Align);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00004982}
4983
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004984llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
4985 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
4986 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00004987 Entry = CreateCStringLiteral(RuntimeName, ObjCLabelType::ClassName);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00004988 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004989}
4990
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004991llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
4992 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
4993 I = MethodDefinitions.find(MD);
4994 if (I != MethodDefinitions.end())
4995 return I->second;
4996
Craig Topper8a13c412014-05-21 05:09:00 +00004997 return nullptr;
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00004998}
4999
Fariborz Jahanian01dff422009-03-05 19:17:31 +00005000/// GetIvarLayoutName - Returns a unique constant for the given
5001/// ivar layout bitmap.
5002llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005003 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Anderson0b75f232009-07-31 20:28:54 +00005004 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahanian01dff422009-03-05 19:17:31 +00005005}
5006
John McCall3fd13f062015-10-21 18:06:47 +00005007void IvarLayoutBuilder::visitRecord(const RecordType *RT,
5008 CharUnits offset) {
Daniel Dunbar15bd8882009-05-03 14:10:34 +00005009 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005010
John McCall3fd13f062015-10-21 18:06:47 +00005011 // If this is a union, remember that we had one, because it might mess
5012 // up the ordering of layout entries.
5013 if (RD->isUnion())
5014 IsDisordered = true;
5015
5016 const ASTRecordLayout *recLayout = nullptr;
5017 visitAggregate(RD->field_begin(), RD->field_end(), offset,
5018 [&](const FieldDecl *field) -> CharUnits {
5019 if (!recLayout)
5020 recLayout = &CGM.getContext().getASTRecordLayout(RD);
5021 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
5022 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
5023 });
Daniel Dunbar15bd8882009-05-03 14:10:34 +00005024}
5025
John McCall3fd13f062015-10-21 18:06:47 +00005026template <class Iterator, class GetOffsetFn>
5027void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
5028 CharUnits aggregateOffset,
5029 const GetOffsetFn &getOffset) {
5030 for (; begin != end; ++begin) {
5031 auto field = *begin;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005032
John McCall3fd13f062015-10-21 18:06:47 +00005033 // Skip over bitfields.
5034 if (field->isBitField()) {
5035 continue;
5036 }
5037
5038 // Compute the offset of the field within the aggregate.
5039 CharUnits fieldOffset = aggregateOffset + getOffset(field);
5040
5041 visitField(field, fieldOffset);
5042 }
5043}
5044
5045/// Collect layout information for the given fields into IvarsInfo.
5046void IvarLayoutBuilder::visitField(const FieldDecl *field,
5047 CharUnits fieldOffset) {
5048 QualType fieldType = field->getType();
5049
5050 // Drill down into arrays.
5051 uint64_t numElts = 1;
5052 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
5053 numElts *= arrayType->getSize().getZExtValue();
5054 fieldType = arrayType->getElementType();
5055 }
5056
5057 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
5058
5059 // If we ended up with a zero-sized array, we've done what we can do within
5060 // the limits of this layout encoding.
5061 if (numElts == 0) return;
5062
5063 // Recurse if the base element type is a record type.
5064 if (auto recType = fieldType->getAs<RecordType>()) {
5065 size_t oldEnd = IvarsInfo.size();
5066
5067 visitRecord(recType, fieldOffset);
5068
5069 // If we have an array, replicate the first entry's layout information.
5070 auto numEltEntries = IvarsInfo.size() - oldEnd;
5071 if (numElts != 1 && numEltEntries != 0) {
5072 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
5073 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
5074 // Copy the last numEltEntries onto the end of the array, adjusting
5075 // each for the element size.
5076 for (size_t i = 0; i != numEltEntries; ++i) {
5077 auto firstEntry = IvarsInfo[oldEnd + i];
5078 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
5079 firstEntry.SizeInWords));
5080 }
5081 }
5082 }
5083
Fariborz Jahanian524bb202009-03-10 16:22:08 +00005084 return;
Fariborz Jahanian3b0f8862009-03-11 00:07:04 +00005085 }
Daniel Dunbar15bd8882009-05-03 14:10:34 +00005086
John McCall3fd13f062015-10-21 18:06:47 +00005087 // Classify the element type.
5088 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005089
John McCall3fd13f062015-10-21 18:06:47 +00005090 // If it matches what we're looking for, add an entry.
5091 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
5092 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
5093 assert(CGM.getContext().getTypeSizeInChars(fieldType)
5094 == CGM.getPointerSize());
5095 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
5096 }
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00005097}
5098
John McCall3fd13f062015-10-21 18:06:47 +00005099/// buildBitmap - This routine does the horsework of taking the offsets of
5100/// strong/weak references and creating a bitmap. The bitmap is also
5101/// returned in the given buffer, suitable for being passed to \c dump().
5102llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
5103 llvm::SmallVectorImpl<unsigned char> &buffer) {
5104 // The bitmap is a series of skip/scan instructions, aligned to word
5105 // boundaries. The skip is performed first.
5106 const unsigned char MaxNibble = 0xF;
5107 const unsigned char SkipMask = 0xF0, SkipShift = 4;
5108 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005109
John McCall3fd13f062015-10-21 18:06:47 +00005110 assert(!IvarsInfo.empty() && "generating bitmap for no data");
5111
5112 // Sort the ivar info on byte position in case we encounterred a
5113 // union nested in the ivar list.
5114 if (IsDisordered) {
5115 // This isn't a stable sort, but our algorithm should handle it fine.
5116 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
5117 } else {
Craig Toppera3467052016-01-03 19:43:20 +00005118 assert(std::is_sorted(IvarsInfo.begin(), IvarsInfo.end()));
John McCall3fd13f062015-10-21 18:06:47 +00005119 }
5120 assert(IvarsInfo.back().Offset < InstanceEnd);
5121
5122 assert(buffer.empty());
5123
5124 // Skip the next N words.
5125 auto skip = [&](unsigned numWords) {
5126 assert(numWords > 0);
5127
5128 // Try to merge into the previous byte. Since scans happen second, we
5129 // can't do this if it includes a scan.
5130 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
5131 unsigned lastSkip = buffer.back() >> SkipShift;
5132 if (lastSkip < MaxNibble) {
5133 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
5134 numWords -= claimed;
5135 lastSkip += claimed;
5136 buffer.back() = (lastSkip << SkipShift);
5137 }
5138 }
5139
5140 while (numWords >= MaxNibble) {
5141 buffer.push_back(MaxNibble << SkipShift);
5142 numWords -= MaxNibble;
5143 }
5144 if (numWords) {
5145 buffer.push_back(numWords << SkipShift);
5146 }
5147 };
5148
5149 // Scan the next N words.
5150 auto scan = [&](unsigned numWords) {
5151 assert(numWords > 0);
5152
5153 // Try to merge into the previous byte. Since scans happen second, we can
5154 // do this even if it includes a skip.
5155 if (!buffer.empty()) {
5156 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
5157 if (lastScan < MaxNibble) {
5158 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
5159 numWords -= claimed;
5160 lastScan += claimed;
5161 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
5162 }
5163 }
5164
5165 while (numWords >= MaxNibble) {
5166 buffer.push_back(MaxNibble << ScanShift);
5167 numWords -= MaxNibble;
5168 }
5169 if (numWords) {
5170 buffer.push_back(numWords << ScanShift);
5171 }
5172 };
5173
5174 // One past the end of the last scan.
5175 unsigned endOfLastScanInWords = 0;
5176 const CharUnits WordSize = CGM.getPointerSize();
5177
5178 // Consider all the scan requests.
5179 for (auto &request : IvarsInfo) {
5180 CharUnits beginOfScan = request.Offset - InstanceBegin;
5181
5182 // Ignore scan requests that don't start at an even multiple of the
5183 // word size. We can't encode them.
5184 if ((beginOfScan % WordSize) != 0) continue;
5185
5186 // Ignore scan requests that start before the instance start.
5187 // This assumes that scans never span that boundary. The boundary
5188 // isn't the true start of the ivars, because in the fragile-ARC case
5189 // it's rounded up to word alignment, but the test above should leave
5190 // us ignoring that possibility.
5191 if (beginOfScan.isNegative()) {
5192 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
5193 continue;
5194 }
5195
5196 unsigned beginOfScanInWords = beginOfScan / WordSize;
5197 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
5198
5199 // If the scan starts some number of words after the last one ended,
5200 // skip forward.
5201 if (beginOfScanInWords > endOfLastScanInWords) {
5202 skip(beginOfScanInWords - endOfLastScanInWords);
5203
5204 // Otherwise, start scanning where the last left off.
5205 } else {
5206 beginOfScanInWords = endOfLastScanInWords;
5207
5208 // If that leaves us with nothing to scan, ignore this request.
5209 if (beginOfScanInWords >= endOfScanInWords) continue;
5210 }
5211
5212 // Scan to the end of the request.
5213 assert(beginOfScanInWords < endOfScanInWords);
5214 scan(endOfScanInWords - beginOfScanInWords);
5215 endOfLastScanInWords = endOfScanInWords;
5216 }
5217
John McCallf5ea0722015-10-29 23:36:14 +00005218 if (buffer.empty())
5219 return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
5220
John McCall3fd13f062015-10-21 18:06:47 +00005221 // For GC layouts, emit a skip to the end of the allocation so that we
5222 // have precise information about the entire thing. This isn't useful
5223 // or necessary for the ARC-style layout strings.
5224 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
5225 unsigned lastOffsetInWords =
5226 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
5227 if (lastOffsetInWords > endOfLastScanInWords) {
5228 skip(lastOffsetInWords - endOfLastScanInWords);
5229 }
5230 }
5231
5232 // Null terminate the string.
5233 buffer.push_back(0);
5234
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005235 auto *Entry = CGObjC.CreateCStringLiteral(
5236 reinterpret_cast<char *>(buffer.data()), ObjCLabelType::ClassName);
John McCall3fd13f062015-10-21 18:06:47 +00005237 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005238}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005239
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005240/// BuildIvarLayout - Builds ivar layout bitmap for the class
5241/// implementation for the __strong or __weak case.
5242/// The layout map displays which words in ivar list must be skipped
5243/// and which must be scanned by GC (see below). String is built of bytes.
5244/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
5245/// of words to skip and right nibble is count of words to scan. So, each
5246/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
5247/// represented by a 0x00 byte which also ends the string.
5248/// 1. when ForStrongLayout is true, following ivars are scanned:
5249/// - id, Class
5250/// - object *
5251/// - __strong anything
5252///
5253/// 2. When ForStrongLayout is false, following ivars are scanned:
5254/// - __weak anything
5255///
John McCall3fd13f062015-10-21 18:06:47 +00005256llvm::Constant *
5257CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
5258 CharUnits beginOffset, CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +00005259 bool ForStrongLayout, bool HasMRCWeakIvars) {
5260 // If this is MRC, and we're either building a strong layout or there
5261 // are no weak ivars, bail out early.
Chris Lattnerece04092012-02-07 00:39:47 +00005262 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005263 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
John McCall460ce582015-10-22 18:38:17 +00005264 !CGM.getLangOpts().ObjCAutoRefCount &&
5265 (ForStrongLayout || !HasMRCWeakIvars))
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005266 return llvm::Constant::getNullValue(PtrTy);
5267
Jordy Rosea91768e2011-07-22 02:08:32 +00005268 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
John McCall3fd13f062015-10-21 18:06:47 +00005269 SmallVector<const ObjCIvarDecl*, 32> ivars;
5270
5271 // GC layout strings include the complete object layout, possibly
5272 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
5273 // up.
5274 //
5275 // ARC layout strings only include the class's ivars. In non-fragile
John McCallf5ea0722015-10-29 23:36:14 +00005276 // runtimes, that means starting at InstanceStart, rounded up to word
5277 // alignment. In fragile runtimes, there's no InstanceStart, so it means
John McCalld80218f2015-11-19 02:27:55 +00005278 // starting at the offset of the first ivar, rounded up to word alignment.
John McCall460ce582015-10-22 18:38:17 +00005279 //
5280 // MRC weak layout strings follow the ARC style.
John McCall3fd13f062015-10-21 18:06:47 +00005281 CharUnits baseOffset;
John McCall460ce582015-10-22 18:38:17 +00005282 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Jordy Rosea91768e2011-07-22 02:08:32 +00005283 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005284 IVD; IVD = IVD->getNextIvar())
John McCall3fd13f062015-10-21 18:06:47 +00005285 ivars.push_back(IVD);
5286
5287 if (isNonFragileABI()) {
5288 baseOffset = beginOffset; // InstanceStart
John McCalld80218f2015-11-19 02:27:55 +00005289 } else if (!ivars.empty()) {
5290 baseOffset =
5291 CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivars[0]));
John McCall3fd13f062015-10-21 18:06:47 +00005292 } else {
5293 baseOffset = CharUnits::Zero();
5294 }
John McCallf5ea0722015-10-29 23:36:14 +00005295
Rui Ueyama83aa9792016-01-14 21:00:27 +00005296 baseOffset = baseOffset.alignTo(CGM.getPointerAlign());
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005297 }
5298 else {
John McCall3fd13f062015-10-21 18:06:47 +00005299 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005300
John McCall3fd13f062015-10-21 18:06:47 +00005301 baseOffset = CharUnits::Zero();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005302 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005303
John McCall3fd13f062015-10-21 18:06:47 +00005304 if (ivars.empty())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005305 return llvm::Constant::getNullValue(PtrTy);
5306
John McCall3fd13f062015-10-21 18:06:47 +00005307 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005308
John McCall3fd13f062015-10-21 18:06:47 +00005309 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
5310 [&](const ObjCIvarDecl *ivar) -> CharUnits {
5311 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
5312 });
5313
5314 if (!builder.hasBitmapData())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005315 return llvm::Constant::getNullValue(PtrTy);
John McCall3fd13f062015-10-21 18:06:47 +00005316
5317 llvm::SmallVector<unsigned char, 4> buffer;
5318 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005319
John McCallf5ea0722015-10-29 23:36:14 +00005320 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005321 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005322 ForStrongLayout ? "strong" : "weak",
Ben Langmuire013bdc2014-07-11 00:43:47 +00005323 OMD->getClassInterface()->getName().str().c_str());
John McCall3fd13f062015-10-21 18:06:47 +00005324 builder.dump(buffer);
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005325 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005326 return C;
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00005327}
5328
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005329llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005330 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
Chris Lattner3def9ae2012-02-06 22:16:34 +00005331 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005332 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005333 Entry = CreateCStringLiteral(Sel.getAsString(), ObjCLabelType::MethodVarName);
Owen Anderson170229f2009-07-14 23:10:40 +00005334 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005335}
5336
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005337// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005338llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005339 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
5340}
5341
Daniel Dunbarf5c18462009-04-20 06:54:31 +00005342llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005343 std::string TypeStr;
5344 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
5345
5346 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005347 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005348 Entry = CreateCStringLiteral(TypeStr, ObjCLabelType::MethodVarType);
Owen Anderson170229f2009-07-14 23:10:40 +00005349 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005350}
5351
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005352llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
5353 bool Extended) {
John McCall843dfcc2016-11-29 21:57:00 +00005354 std::string TypeStr =
5355 CGM.getContext().getObjCEncodingForMethodDecl(D, Extended);
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005356
5357 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbar3241fae2009-04-14 23:14:47 +00005358 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005359 Entry = CreateCStringLiteral(TypeStr, ObjCLabelType::MethodVarType);
Owen Anderson170229f2009-07-14 23:10:40 +00005360 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005361}
5362
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005363// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005364llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005365 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005366 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005367 Entry = CreateCStringLiteral(Ident->getName(), ObjCLabelType::PropertyName);
Owen Anderson170229f2009-07-14 23:10:40 +00005368 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005369}
5370
5371// FIXME: Merge into a single cstring creation function.
Daniel Dunbar4932b362008-08-28 04:38:10 +00005372// FIXME: This Decl should be more precise.
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005373llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005374CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
5375 const Decl *Container) {
John McCall843dfcc2016-11-29 21:57:00 +00005376 std::string TypeStr =
5377 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005378 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
5379}
5380
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005381void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005382 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005383 SmallVectorImpl<char> &Name) {
Daniel Dunbard2386812009-10-19 01:21:19 +00005384 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00005385 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbard2386812009-10-19 01:21:19 +00005386 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
5387 << '[' << CD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005388 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbard2386812009-10-19 01:21:19 +00005389 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramer2f569922012-02-07 11:57:45 +00005390 OS << '(' << *CID << ')';
Daniel Dunbard2386812009-10-19 01:21:19 +00005391 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbara94ecd22008-08-16 03:19:19 +00005392}
5393
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005394void CGObjCMac::FinishModule() {
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005395 EmitModuleInfo();
5396
Daniel Dunbarc475d422008-10-29 22:36:39 +00005397 // Emit the dummy bodies for any protocols which were referenced but
5398 // never defined.
John McCall176f8922016-11-30 02:39:18 +00005399 for (auto &entry : Protocols) {
5400 llvm::GlobalVariable *global = entry.second;
5401 if (global->hasInitializer())
Daniel Dunbarc475d422008-10-29 22:36:39 +00005402 continue;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005403
John McCall176f8922016-11-30 02:39:18 +00005404 ConstantInitBuilder builder(CGM);
5405 auto values = builder.beginStruct(ObjCTypes.ProtocolTy);
5406 values.addNullPointer(ObjCTypes.ProtocolExtensionPtrTy);
5407 values.add(GetClassName(entry.first->getName()));
5408 values.addNullPointer(ObjCTypes.ProtocolListPtrTy);
5409 values.addNullPointer(ObjCTypes.MethodDescriptionListPtrTy);
5410 values.addNullPointer(ObjCTypes.MethodDescriptionListPtrTy);
5411 values.finishAndSetAsInitializer(global);
5412 CGM.addCompilerUsedGlobal(global);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005413 }
5414
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005415 // Add assembler directives to add lazy undefined symbol references
5416 // for classes which are referenced but not defined. This is
5417 // important for correct linker interaction.
Daniel Dunbard027a922009-09-07 00:20:42 +00005418 //
5419 // FIXME: It would be nice if we had an LLVM construct for this.
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005420 if ((!LazySymbols.empty() || !DefinedSymbols.empty()) &&
5421 CGM.getTriple().isOSBinFormatMachO()) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005422 SmallString<256> Asm;
Daniel Dunbard027a922009-09-07 00:20:42 +00005423 Asm += CGM.getModule().getModuleInlineAsm();
5424 if (!Asm.empty() && Asm.back() != '\n')
5425 Asm += '\n';
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005426
Daniel Dunbard027a922009-09-07 00:20:42 +00005427 llvm::raw_svector_ostream OS(Asm);
Saleem Abdulrasool39217d42016-09-16 14:24:26 +00005428 for (const auto *Sym : DefinedSymbols)
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005429 OS << "\t.objc_class_name_" << Sym->getName() << "=0\n"
5430 << "\t.globl .objc_class_name_" << Sym->getName() << "\n";
Saleem Abdulrasool39217d42016-09-16 14:24:26 +00005431 for (const auto *Sym : LazySymbols)
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005432 OS << "\t.lazy_reference .objc_class_name_" << Sym->getName() << "\n";
5433 for (const auto &Category : DefinedCategoryNames)
5434 OS << "\t.objc_category_name_" << Category << "=0\n"
5435 << "\t.globl .objc_category_name_" << Category << "\n";
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005436
Daniel Dunbard027a922009-09-07 00:20:42 +00005437 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005438 }
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005439}
5440
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005441CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00005442 : CGObjCCommonMac(cgm), ObjCTypes(cgm), ObjCEmptyCacheVar(nullptr),
5443 ObjCEmptyVtableVar(nullptr) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005444 ObjCABI = 2;
5445}
5446
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005447/* *** */
5448
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005449ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Craig Topper8a13c412014-05-21 05:09:00 +00005450 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregora95f9aa2012-01-17 23:38:32 +00005451{
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005452 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5453 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005454
John McCall176f8922016-11-30 02:39:18 +00005455 ShortTy = cast<llvm::IntegerType>(Types.ConvertType(Ctx.ShortTy));
5456 IntTy = CGM.IntTy;
5457 LongTy = cast<llvm::IntegerType>(Types.ConvertType(Ctx.LongTy));
Chris Lattnerece04092012-02-07 00:39:47 +00005458 Int8PtrTy = CGM.Int8PtrTy;
5459 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005460
Tim Northover238b5082014-03-29 13:42:40 +00005461 // arm64 targets use "int" ivar offset variables. All others,
5462 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Tim Northover40956e62014-07-23 12:32:58 +00005463 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Tim Northover238b5082014-03-29 13:42:40 +00005464 IvarOffsetVarTy = IntTy;
5465 else
5466 IvarOffsetVarTy = LongTy;
5467
John McCall176f8922016-11-30 02:39:18 +00005468 ObjectPtrTy =
5469 cast<llvm::PointerType>(Types.ConvertType(Ctx.getObjCIdType()));
5470 PtrObjectPtrTy =
5471 llvm::PointerType::getUnqual(ObjectPtrTy);
5472 SelectorPtrTy =
5473 cast<llvm::PointerType>(Types.ConvertType(Ctx.getObjCSelType()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005474
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005475 // I'm not sure I like this. The implicit coordination is a bit
5476 // gross. We should solve this in a reasonable fashion because this
5477 // is a pretty common task (match some runtime data structure with
5478 // an LLVM data structure).
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005479
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005480 // FIXME: This is leaked.
5481 // FIXME: Merge with rewriter code?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005482
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005483 // struct _objc_super {
5484 // id self;
5485 // Class cls;
5486 // }
Abramo Bagnara6150c882010-05-11 21:36:43 +00005487 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005488 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005489 SourceLocation(), SourceLocation(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005490 &Ctx.Idents.get("_objc_super"));
Craig Topper8a13c412014-05-21 05:09:00 +00005491 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5492 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5493 false, ICIS_NoInit));
5494 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5495 nullptr, Ctx.getObjCClassType(), nullptr,
5496 nullptr, false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005497 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005498
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005499 SuperCTy = Ctx.getTagDeclType(RD);
5500 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005501
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005502 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005503 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5504
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005505 // struct _prop_t {
5506 // char *name;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005507 // char *attributes;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005508 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005509 PropertyTy = llvm::StructType::create("struct._prop_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005510 Int8PtrTy, Int8PtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005511
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005512 // struct _prop_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005513 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005514 // uint32_t count_of_properties;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005515 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005516 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005517 PropertyListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005518 llvm::StructType::create("struct._prop_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005519 llvm::ArrayType::get(PropertyTy, 0), nullptr);
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005520 // struct _prop_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005521 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005522
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005523 // struct _objc_method {
5524 // SEL _cmd;
5525 // char *method_type;
5526 // char *_imp;
5527 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005528 MethodTy = llvm::StructType::create("struct._objc_method",
5529 SelectorPtrTy, Int8PtrTy, Int8PtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005530 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005531
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005532 // struct _objc_cache *
Chris Lattner5ec04a52011-08-12 17:43:31 +00005533 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005534 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005535}
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005536
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005537ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005538 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005539 // struct _objc_method_description {
5540 // SEL name;
5541 // char *types;
5542 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005543 MethodDescriptionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005544 llvm::StructType::create("struct._objc_method_description",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005545 SelectorPtrTy, Int8PtrTy, nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005546
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005547 // struct _objc_method_description_list {
5548 // int count;
5549 // struct _objc_method_description[1];
5550 // }
Reid Kleckneree7cf842014-12-01 22:02:27 +00005551 MethodDescriptionListTy = llvm::StructType::create(
5552 "struct._objc_method_description_list", IntTy,
5553 llvm::ArrayType::get(MethodDescriptionTy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005554
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005555 // struct _objc_method_description_list *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005556 MethodDescriptionListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005557 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005558
Daniel Dunbarb036db82008-08-13 03:21:16 +00005559 // Protocol description structures
5560
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005561 // struct _objc_protocol_extension {
5562 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5563 // struct _objc_method_description_list *optional_instance_methods;
5564 // struct _objc_method_description_list *optional_class_methods;
5565 // struct _objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005566 // const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00005567 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005568 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005569 ProtocolExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005570 llvm::StructType::create("struct._objc_protocol_extension",
5571 IntTy, MethodDescriptionListPtrTy,
5572 MethodDescriptionListPtrTy, PropertyListPtrTy,
Manman Rence7bff52016-01-29 23:46:55 +00005573 Int8PtrPtrTy, PropertyListPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005574
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005575 // struct _objc_protocol_extension *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005576 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005577
Daniel Dunbarc475d422008-10-29 22:36:39 +00005578 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbarb036db82008-08-13 03:21:16 +00005579
Chris Lattnera5f58b02011-07-09 17:41:47 +00005580 ProtocolTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005581 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbarb036db82008-08-13 03:21:16 +00005582
Chris Lattnera5f58b02011-07-09 17:41:47 +00005583 ProtocolListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005584 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005585 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy),
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005586 LongTy,
Chris Lattnera5f58b02011-07-09 17:41:47 +00005587 llvm::ArrayType::get(ProtocolTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005588 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005589
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005590 // struct _objc_protocol {
5591 // struct _objc_protocol_extension *isa;
5592 // char *protocol_name;
5593 // struct _objc_protocol **_objc_protocol_list;
5594 // struct _objc_method_description_list *instance_methods;
5595 // struct _objc_method_description_list *class_methods;
5596 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005597 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5598 llvm::PointerType::getUnqual(ProtocolListTy),
5599 MethodDescriptionListPtrTy,
5600 MethodDescriptionListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005601 nullptr);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005602
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005603 // struct _objc_protocol_list *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005604 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005605
Owen Anderson9793f0e2009-07-29 22:16:19 +00005606 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005607
5608 // Class description structures
5609
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005610 // struct _objc_ivar {
5611 // char *ivar_name;
5612 // char *ivar_type;
5613 // int ivar_offset;
5614 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005615 IvarTy = llvm::StructType::create("struct._objc_ivar",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005616 Int8PtrTy, Int8PtrTy, IntTy, nullptr);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005617
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005618 // struct _objc_ivar_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005619 IvarListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005620 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005621 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005622
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005623 // struct _objc_method_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005624 MethodListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005625 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005626 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005627
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005628 // struct _objc_class_extension *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005629 ClassExtensionTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005630 llvm::StructType::create("struct._objc_class_extension",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005631 IntTy, Int8PtrTy, PropertyListPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005632 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005633
Chris Lattner5ec04a52011-08-12 17:43:31 +00005634 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005635
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005636 // struct _objc_class {
5637 // Class isa;
5638 // Class super_class;
5639 // char *name;
5640 // long version;
5641 // long info;
5642 // long instance_size;
5643 // struct _objc_ivar_list *ivars;
5644 // struct _objc_method_list *methods;
5645 // struct _objc_cache *cache;
5646 // struct _objc_protocol_list *protocols;
5647 // char *ivar_layout;
5648 // struct _objc_class_ext *ext;
5649 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005650 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
5651 llvm::PointerType::getUnqual(ClassTy),
5652 Int8PtrTy,
5653 LongTy,
5654 LongTy,
5655 LongTy,
5656 IvarListPtrTy,
5657 MethodListPtrTy,
5658 CachePtrTy,
5659 ProtocolListPtrTy,
5660 Int8PtrTy,
5661 ClassExtensionPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005662 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005663
Owen Anderson9793f0e2009-07-29 22:16:19 +00005664 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005665
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005666 // struct _objc_category {
5667 // char *category_name;
5668 // char *class_name;
5669 // struct _objc_method_list *instance_method;
5670 // struct _objc_method_list *class_method;
Manman Renb3736772016-01-25 22:37:47 +00005671 // struct _objc_protocol_list *protocols;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005672 // uint32_t size; // sizeof(struct _objc_category)
5673 // struct _objc_property_list *instance_properties;// category's @property
Manman Ren96df0b32016-01-29 23:45:01 +00005674 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005675 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005676 CategoryTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005677 llvm::StructType::create("struct._objc_category",
5678 Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5679 MethodListPtrTy, ProtocolListPtrTy,
Manman Ren96df0b32016-01-29 23:45:01 +00005680 IntTy, PropertyListPtrTy, PropertyListPtrTy,
5681 nullptr);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005682
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005683 // Global metadata structures
5684
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005685 // struct _objc_symtab {
5686 // long sel_ref_cnt;
5687 // SEL *refs;
5688 // short cls_def_cnt;
5689 // short cat_def_cnt;
5690 // char *defs[cls_def_cnt + cat_def_cnt];
5691 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005692 SymtabTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005693 llvm::StructType::create("struct._objc_symtab",
5694 LongTy, SelectorPtrTy, ShortTy, ShortTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005695 llvm::ArrayType::get(Int8PtrTy, 0), nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005696 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005697
Fariborz Jahanianeee54df2009-01-22 00:37:21 +00005698 // struct _objc_module {
5699 // long version;
5700 // long size; // sizeof(struct _objc_module)
5701 // char *name;
5702 // struct _objc_symtab* symtab;
5703 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005704 ModuleTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005705 llvm::StructType::create("struct._objc_module",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005706 LongTy, LongTy, Int8PtrTy, SymtabPtrTy, nullptr);
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00005707
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005708
Mike Stump18bb9282009-05-16 07:57:57 +00005709 // FIXME: This is the size of the setjmp buffer and should be target
5710 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson9ff22482008-09-09 10:10:21 +00005711 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005712
Anders Carlsson9ff22482008-09-09 10:10:21 +00005713 // Exceptions
Chris Lattnerece04092012-02-07 00:39:47 +00005714 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005715
5716 ExceptionDataTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005717 llvm::StructType::create("struct._objc_exception_data",
Chris Lattnerece04092012-02-07 00:39:47 +00005718 llvm::ArrayType::get(CGM.Int32Ty,SetJmpBufferSize),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005719 StackPtrTy, nullptr);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005720}
5721
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005722ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005723 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005724 // struct _method_list_t {
5725 // uint32_t entsize; // sizeof(struct _objc_method)
5726 // uint32_t method_count;
5727 // struct _objc_method method_list[method_count];
5728 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005729 MethodListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005730 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005731 llvm::ArrayType::get(MethodTy, 0), nullptr);
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005732 // struct method_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005733 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005734
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005735 // struct _protocol_t {
5736 // id isa; // NULL
5737 // const char * const protocol_name;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005738 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005739 // const struct method_list_t * const instance_methods;
5740 // const struct method_list_t * const class_methods;
5741 // const struct method_list_t *optionalInstanceMethods;
5742 // const struct method_list_t *optionalClassMethods;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005743 // const struct _prop_list_t * properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005744 // const uint32_t size; // sizeof(struct _protocol_t)
5745 // const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005746 // const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005747 // const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00005748 // const struct _prop_list_t * class_properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005749 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005750
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005751 // Holder for struct _protocol_list_t *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005752 ProtocolListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005753 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005754
Chris Lattnera5f58b02011-07-09 17:41:47 +00005755 ProtocolnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005756 llvm::StructType::create("struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5757 llvm::PointerType::getUnqual(ProtocolListnfABITy),
5758 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5759 MethodListnfABIPtrTy, MethodListnfABIPtrTy,
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005760 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy,
Manman Rence7bff52016-01-29 23:46:55 +00005761 Int8PtrTy, PropertyListPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005762 nullptr);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005763
5764 // struct _protocol_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005765 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005766
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005767 // struct _protocol_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005768 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005769 // struct _protocol_t *[protocol_count];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005770 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005771 ProtocolListnfABITy->setBody(LongTy,
5772 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005773 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005774
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005775 // struct _objc_protocol_list*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005776 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005777
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005778 // struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00005779 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005780 // char *name;
5781 // char *type;
5782 // uint32_t alignment;
5783 // uint32_t size;
5784 // }
Tim Northover238b5082014-03-29 13:42:40 +00005785 IvarnfABITy = llvm::StructType::create(
5786 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005787 Int8PtrTy, Int8PtrTy, IntTy, IntTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005788
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005789 // struct _ivar_list_t {
5790 // uint32 entsize; // sizeof(struct _ivar_t)
5791 // uint32 count;
5792 // struct _iver_t list[count];
5793 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005794 IvarListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005795 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005796 llvm::ArrayType::get(IvarnfABITy, 0), nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005797
Owen Anderson9793f0e2009-07-29 22:16:19 +00005798 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005799
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005800 // struct _class_ro_t {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005801 // uint32_t const flags;
5802 // uint32_t const instanceStart;
5803 // uint32_t const instanceSize;
5804 // uint32_t const reserved; // only when building for 64bit targets
5805 // const uint8_t * const ivarLayout;
5806 // const char *const name;
5807 // const struct _method_list_t * const baseMethods;
5808 // const struct _objc_protocol_list *const baseProtocols;
5809 // const struct _ivar_list_t *const ivars;
5810 // const uint8_t * const weakIvarLayout;
5811 // const struct _prop_list_t * const properties;
5812 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005813
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005814 // FIXME. Add 'reserved' field in 64bit abi mode!
Chris Lattner5ec04a52011-08-12 17:43:31 +00005815 ClassRonfABITy = llvm::StructType::create("struct._class_ro_t",
5816 IntTy, IntTy, IntTy, Int8PtrTy,
5817 Int8PtrTy, MethodListnfABIPtrTy,
5818 ProtocolListnfABIPtrTy,
5819 IvarListnfABIPtrTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005820 Int8PtrTy, PropertyListPtrTy,
5821 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005822
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005823 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +00005824 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +00005825 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5826 ->getPointerTo();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005827
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005828 // struct _class_t {
5829 // struct _class_t *isa;
5830 // struct _class_t * const superclass;
5831 // void *cache;
5832 // IMP *vtable;
5833 // struct class_ro_t *ro;
5834 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005835
Chris Lattner5ec04a52011-08-12 17:43:31 +00005836 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005837 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
5838 llvm::PointerType::getUnqual(ClassnfABITy),
5839 CachePtrTy,
5840 llvm::PointerType::getUnqual(ImpnfABITy),
5841 llvm::PointerType::getUnqual(ClassRonfABITy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005842 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005843
Fariborz Jahanian71394042009-01-23 23:53:38 +00005844 // LLVM for struct _class_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005845 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005846
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005847 // struct _category_t {
5848 // const char * const name;
5849 // struct _class_t *const cls;
5850 // const struct _method_list_t * const instance_methods;
5851 // const struct _method_list_t * const class_methods;
5852 // const struct _protocol_list_t * const protocols;
5853 // const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00005854 // const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00005855 // const uint32_t size;
Fariborz Jahanian5a63e4c2009-01-23 17:41:22 +00005856 // }
Chris Lattner5ec04a52011-08-12 17:43:31 +00005857 CategorynfABITy = llvm::StructType::create("struct._category_t",
5858 Int8PtrTy, ClassnfABIPtrTy,
5859 MethodListnfABIPtrTy,
5860 MethodListnfABIPtrTy,
5861 ProtocolListnfABIPtrTy,
5862 PropertyListPtrTy,
Manman Ren96df0b32016-01-29 23:45:01 +00005863 PropertyListPtrTy,
Manman Ren42ff3902016-02-24 17:49:50 +00005864 IntTy,
Reid Kleckneree7cf842014-12-01 22:02:27 +00005865 nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005866
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005867 // New types for nonfragile abi messaging.
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005868 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5869 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005870
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005871 // MessageRefTy - LLVM for:
5872 // struct _message_ref_t {
5873 // IMP messenger;
5874 // SEL name;
5875 // };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005876
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005877 // First the clang type for struct _message_ref_t
Abramo Bagnara6150c882010-05-11 21:36:43 +00005878 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005879 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005880 SourceLocation(), SourceLocation(),
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005881 &Ctx.Idents.get("_message_ref_t"));
Craig Topper8a13c412014-05-21 05:09:00 +00005882 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5883 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smith2b013182012-06-10 03:12:00 +00005884 ICIS_NoInit));
Craig Topper8a13c412014-05-21 05:09:00 +00005885 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5886 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5887 false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005888 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005889
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005890 MessageRefCTy = Ctx.getTagDeclType(RD);
5891 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5892 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005893
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005894 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005895 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005896
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005897 // SuperMessageRefTy - LLVM for:
5898 // struct _super_message_ref_t {
5899 // SUPER_IMP messenger;
5900 // SEL name;
5901 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005902 SuperMessageRefTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005903 llvm::StructType::create("struct._super_message_ref_t",
Reid Kleckneree7cf842014-12-01 22:02:27 +00005904 ImpnfABITy, SelectorPtrTy, nullptr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005905
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005906 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005907 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00005908
Daniel Dunbarb1559a42009-03-01 04:46:24 +00005909
5910 // struct objc_typeinfo {
5911 // const void** vtable; // objc_ehtype_vtable + 2
5912 // const char* name; // c++ typeinfo string
5913 // Class cls;
5914 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005915 EHTypeTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005916 llvm::StructType::create("struct._objc_typeinfo",
5917 llvm::PointerType::getUnqual(Int8PtrTy),
Reid Kleckneree7cf842014-12-01 22:02:27 +00005918 Int8PtrTy, ClassnfABIPtrTy, nullptr);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005919 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005920}
5921
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005922llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanian71394042009-01-23 23:53:38 +00005923 FinishNonFragileABIModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005924
Craig Topper8a13c412014-05-21 05:09:00 +00005925 return nullptr;
Fariborz Jahanian71394042009-01-23 23:53:38 +00005926}
5927
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00005928void CGObjCNonFragileABIMac::AddModuleClassList(
5929 ArrayRef<llvm::GlobalValue *> Container, StringRef SymbolName,
5930 StringRef SectionName) {
Daniel Dunbar19573e72009-05-15 21:48:48 +00005931 unsigned NumClasses = Container.size();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005932
Daniel Dunbar19573e72009-05-15 21:48:48 +00005933 if (!NumClasses)
5934 return;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005935
Chris Lattner3def9ae2012-02-06 22:16:34 +00005936 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005937 for (unsigned i=0; i<NumClasses; i++)
Owen Andersonade90fd2009-07-29 18:54:39 +00005938 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar19573e72009-05-15 21:48:48 +00005939 ObjCTypes.Int8PtrTy);
Chris Lattner3def9ae2012-02-06 22:16:34 +00005940 llvm::Constant *Init =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005941 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00005942 Symbols.size()),
Daniel Dunbar19573e72009-05-15 21:48:48 +00005943 Symbols);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005944
Daniel Dunbar19573e72009-05-15 21:48:48 +00005945 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00005946 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00005947 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar19573e72009-05-15 21:48:48 +00005948 Init,
Owen Andersonc10c8d32009-07-08 19:05:04 +00005949 SymbolName);
Micah Villmowdd31ca12012-10-08 16:25:52 +00005950 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar19573e72009-05-15 21:48:48 +00005951 GV->setSection(SectionName);
Rafael Espindola060062a2014-03-06 22:15:10 +00005952 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005953}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005954
Fariborz Jahanian71394042009-01-23 23:53:38 +00005955void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
5956 // nonfragile abi has no module definition.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005957
Daniel Dunbar19573e72009-05-15 21:48:48 +00005958 // Build list of all implemented class addresses in array
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005959 // L_OBJC_LABEL_CLASS_$.
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005960
5961 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
5962 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5963 assert(ID);
5964 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5965 // We are implementing a weak imported interface. Give it external linkage
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005966 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005967 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00005968 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
5969 }
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005970 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005971
5972 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005973 "__DATA, __objc_classlist, regular, no_dead_strip");
Rafael Espindola554256c2014-02-26 22:25:45 +00005974
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005975 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005976 "__DATA, __objc_nlclslist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005977
Fariborz Jahanian279abd32009-01-30 20:55:31 +00005978 // Build list of all implemented category addresses in array
5979 // L_OBJC_LABEL_CATEGORY_$.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005980 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Daniel Dunbar19573e72009-05-15 21:48:48 +00005981 "__DATA, __objc_catlist, regular, no_dead_strip");
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005982 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Daniel Dunbar9a017d72009-05-15 22:33:15 +00005983 "__DATA, __objc_nlcatlist, regular, no_dead_strip");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005984
Daniel Dunbar5e639272010-04-25 20:39:01 +00005985 EmitImageInfo();
Fariborz Jahanian71394042009-01-23 23:53:38 +00005986}
5987
John McCall9e8bb002011-05-14 03:10:52 +00005988/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
5989/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005990/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00005991/// message dispatch call for all the rest.
John McCall9e8bb002011-05-14 03:10:52 +00005992bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
5993 // At various points we've experimented with using vtable-based
5994 // dispatch for all methods.
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005995 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00005996 case CodeGenOptions::Legacy:
Fariborz Jahaniandfb39832010-04-19 17:53:30 +00005997 return false;
John McCall9e8bb002011-05-14 03:10:52 +00005998 case CodeGenOptions::NonLegacy:
5999 return true;
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00006000 case CodeGenOptions::Mixed:
6001 break;
6002 }
6003
6004 // If so, see whether this selector is in the white-list of things which must
6005 // use the new dispatch convention. We lazily build a dense set for this.
John McCall9e8bb002011-05-14 03:10:52 +00006006 if (VTableDispatchMethods.empty()) {
6007 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
6008 VTableDispatchMethods.insert(GetNullarySelector("class"));
6009 VTableDispatchMethods.insert(GetNullarySelector("self"));
6010 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
6011 VTableDispatchMethods.insert(GetNullarySelector("length"));
6012 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006013
John McCall9e8bb002011-05-14 03:10:52 +00006014 // These are vtable-based if GC is disabled.
6015 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00006016 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall9e8bb002011-05-14 03:10:52 +00006017 VTableDispatchMethods.insert(GetNullarySelector("retain"));
6018 VTableDispatchMethods.insert(GetNullarySelector("release"));
6019 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
6020 }
6021
6022 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
6023 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
6024 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
6025 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
6026 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
6027 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
6028 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
6029
6030 // These are vtable-based if GC is enabled.
6031 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00006032 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall9e8bb002011-05-14 03:10:52 +00006033 VTableDispatchMethods.insert(GetNullarySelector("hash"));
6034 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
6035
6036 // "countByEnumeratingWithState:objects:count"
6037 IdentifierInfo *KeyIdents[] = {
6038 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
6039 &CGM.getContext().Idents.get("objects"),
6040 &CGM.getContext().Idents.get("count")
6041 };
6042 VTableDispatchMethods.insert(
6043 CGM.getContext().Selectors.getSelector(3, KeyIdents));
6044 }
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006045 }
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00006046
John McCall9e8bb002011-05-14 03:10:52 +00006047 return VTableDispatchMethods.count(Sel);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006048}
6049
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006050/// BuildClassRoTInitializer - generate meta-data for:
6051/// struct _class_ro_t {
6052/// uint32_t const flags;
6053/// uint32_t const instanceStart;
6054/// uint32_t const instanceSize;
6055/// uint32_t const reserved; // only when building for 64bit targets
6056/// const uint8_t * const ivarLayout;
6057/// const char *const name;
6058/// const struct _method_list_t * const baseMethods;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006059/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006060/// const struct _ivar_list_t *const ivars;
6061/// const uint8_t * const weakIvarLayout;
6062/// const struct _prop_list_t * const properties;
6063/// }
6064///
6065llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006066 unsigned flags,
6067 unsigned InstanceStart,
6068 unsigned InstanceSize,
6069 const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006070 std::string ClassName = ID->getObjCRuntimeNameAsString();
John McCall31168b02011-06-15 23:02:42 +00006071
John McCall3fd13f062015-10-21 18:06:47 +00006072 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
6073 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
6074
John McCall460ce582015-10-22 18:38:17 +00006075 bool hasMRCWeak = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00006076 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallef19dbb2012-10-17 04:53:23 +00006077 flags |= NonFragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00006078 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
6079 flags |= NonFragileABI_Class_HasMRCWeakIvars;
John McCall31168b02011-06-15 23:02:42 +00006080
John McCall176f8922016-11-30 02:39:18 +00006081 ConstantInitBuilder builder(CGM);
6082 auto values = builder.beginStruct(ObjCTypes.ClassRonfABITy);
6083
6084 values.addInt(ObjCTypes.IntTy, flags);
6085 values.addInt(ObjCTypes.IntTy, InstanceStart);
6086 values.addInt(ObjCTypes.IntTy, InstanceSize);
6087 values.add((flags & NonFragileABI_Class_Meta)
6088 ? GetIvarLayoutName(nullptr, ObjCTypes)
6089 : BuildStrongIvarLayout(ID, beginInstance, endInstance));
6090 values.add(GetClassName(ID->getObjCRuntimeNameAsString()));
6091
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006092 // const struct _method_list_t * const baseMethods;
John McCall176f8922016-11-30 02:39:18 +00006093 SmallVector<const ObjCMethodDecl*, 16> methods;
John McCallef19dbb2012-10-17 04:53:23 +00006094 if (flags & NonFragileABI_Class_Meta) {
John McCall176f8922016-11-30 02:39:18 +00006095 for (const auto *MD : ID->class_methods())
6096 methods.push_back(MD);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006097 } else {
John McCall176f8922016-11-30 02:39:18 +00006098 for (const auto *MD : ID->instance_methods())
6099 methods.push_back(MD);
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006100
Aaron Ballmand85eff42014-03-14 15:02:45 +00006101 for (const auto *PID : ID->property_impls()) {
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00006102 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
6103 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006104
John McCall176f8922016-11-30 02:39:18 +00006105 if (auto MD = PD->getGetterMethodDecl())
6106 if (GetMethodDefinition(MD))
6107 methods.push_back(MD);
6108 if (auto MD = PD->getSetterMethodDecl())
6109 if (GetMethodDefinition(MD))
6110 methods.push_back(MD);
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00006111 }
6112 }
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006113 }
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006114
John McCall176f8922016-11-30 02:39:18 +00006115 values.add(emitMethodList(ID->getObjCRuntimeNameAsString(),
6116 (flags & NonFragileABI_Class_Meta)
6117 ? MethodListType::ClassMethods
6118 : MethodListType::InstanceMethods,
6119 methods));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006120
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006121 const ObjCInterfaceDecl *OID = ID->getClassInterface();
6122 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
John McCall176f8922016-11-30 02:39:18 +00006123 values.add(EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006124 + OID->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006125 OID->all_referenced_protocol_begin(),
6126 OID->all_referenced_protocol_end()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006127
John McCallef19dbb2012-10-17 04:53:23 +00006128 if (flags & NonFragileABI_Class_Meta) {
John McCall176f8922016-11-30 02:39:18 +00006129 values.addNullPointer(ObjCTypes.IvarListnfABIPtrTy);
6130 values.add(GetIvarLayoutName(nullptr, ObjCTypes));
6131 values.add(EmitPropertyList(
Manman Renad0e7912016-01-29 19:22:54 +00006132 "\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006133 ID, ID->getClassInterface(), ObjCTypes, true));
John McCallef19dbb2012-10-17 04:53:23 +00006134 } else {
John McCall176f8922016-11-30 02:39:18 +00006135 values.add(EmitIvarList(ID));
6136 values.add(BuildWeakIvarLayout(ID, beginInstance, endInstance, hasMRCWeak));
6137 values.add(EmitPropertyList(
Manman Renad0e7912016-01-29 19:22:54 +00006138 "\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006139 ID, ID->getClassInterface(), ObjCTypes, false));
John McCallef19dbb2012-10-17 04:53:23 +00006140 }
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006141
John McCall176f8922016-11-30 02:39:18 +00006142 llvm::SmallString<64> roLabel;
6143 llvm::raw_svector_ostream(roLabel)
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006144 << ((flags & NonFragileABI_Class_Meta) ? "\01l_OBJC_METACLASS_RO_$_"
6145 : "\01l_OBJC_CLASS_RO_$_")
6146 << ClassName;
6147
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006148 llvm::GlobalVariable *CLASS_RO_GV =
John McCall176f8922016-11-30 02:39:18 +00006149 values.finishAndCreateGlobal(roLabel, CGM.getPointerAlign(),
6150 /*constant*/ false,
6151 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006152 if (CGM.getTriple().isOSBinFormatMachO())
6153 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006154 return CLASS_RO_GV;
6155}
6156
John McCalldba63a72016-11-30 23:54:50 +00006157/// Build the metaclass object for a class.
6158///
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006159/// struct _class_t {
6160/// struct _class_t *isa;
6161/// struct _class_t * const superclass;
6162/// void *cache;
6163/// IMP *vtable;
6164/// struct class_ro_t *ro;
6165/// }
6166///
John McCalldba63a72016-11-30 23:54:50 +00006167llvm::GlobalVariable *
6168CGObjCNonFragileABIMac::BuildClassObject(const ObjCInterfaceDecl *CI,
6169 bool isMetaclass,
6170 llvm::Constant *IsAGV,
6171 llvm::Constant *SuperClassGV,
6172 llvm::Constant *ClassRoGV,
6173 bool HiddenVisibility) {
John McCall176f8922016-11-30 02:39:18 +00006174 ConstantInitBuilder builder(CGM);
6175 auto values = builder.beginStruct(ObjCTypes.ClassnfABITy);
6176 values.add(IsAGV);
6177 if (SuperClassGV) {
6178 values.add(SuperClassGV);
6179 } else {
6180 values.addNullPointer(ObjCTypes.ClassnfABIPtrTy);
6181 }
6182 values.add(ObjCEmptyCacheVar);
6183 values.add(ObjCEmptyVtableVar);
6184 values.add(ClassRoGV);
6185
John McCalldba63a72016-11-30 23:54:50 +00006186 llvm::GlobalVariable *GV =
6187 cast<llvm::GlobalVariable>(GetClassGlobal(CI, isMetaclass, ForDefinition));
John McCall176f8922016-11-30 02:39:18 +00006188 values.finishAndSetAsInitializer(GV);
6189
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006190 if (CGM.getTriple().isOSBinFormatMachO())
6191 GV->setSection("__DATA, __objc_data");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006192 GV->setAlignment(
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006193 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006194 if (!CGM.getTriple().isOSBinFormatCOFF())
6195 if (HiddenVisibility)
6196 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006197 return GV;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006198}
6199
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006200bool
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00006201CGObjCNonFragileABIMac::ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
Craig Topper8a13c412014-05-21 05:09:00 +00006202 return OD->getClassMethod(GetNullarySelector("load")) != nullptr;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006203}
6204
Daniel Dunbar961202372009-05-03 12:57:56 +00006205void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00006206 uint32_t &InstanceStart,
6207 uint32_t &InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006208 const ASTRecordLayout &RL =
Daniel Dunbar9252ee12009-05-04 21:26:30 +00006209 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006210
Daniel Dunbar9b042e02009-05-04 23:23:09 +00006211 // InstanceSize is really instance end.
Ken Dyckd5090c12011-02-11 02:20:09 +00006212 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar9b042e02009-05-04 23:23:09 +00006213
6214 // If there are no fields, the start is the same as the end.
6215 if (!RL.getFieldCount())
6216 InstanceStart = InstanceSize;
6217 else
Ken Dyckc5ca8762011-04-14 00:43:09 +00006218 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbar554fd792009-04-19 23:41:48 +00006219}
6220
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006221static llvm::GlobalValue::DLLStorageClassTypes getStorage(CodeGenModule &CGM,
6222 StringRef Name) {
6223 IdentifierInfo &II = CGM.getContext().Idents.get(Name);
6224 TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
6225 DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
6226
6227 const VarDecl *VD = nullptr;
6228 for (const auto &Result : DC->lookup(&II))
6229 if ((VD = dyn_cast<VarDecl>(Result)))
6230 break;
6231
6232 if (!VD)
6233 return llvm::GlobalValue::DLLImportStorageClass;
6234 if (VD->hasAttr<DLLExportAttr>())
6235 return llvm::GlobalValue::DLLExportStorageClass;
6236 if (VD->hasAttr<DLLImportAttr>())
6237 return llvm::GlobalValue::DLLImportStorageClass;
6238 return llvm::GlobalValue::DefaultStorageClass;
6239}
6240
Fariborz Jahanian71394042009-01-23 23:53:38 +00006241void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Fariborz Jahanian71394042009-01-23 23:53:38 +00006242 if (!ObjCEmptyCacheVar) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006243 ObjCEmptyCacheVar =
6244 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CacheTy, false,
6245 llvm::GlobalValue::ExternalLinkage, nullptr,
6246 "_objc_empty_cache");
6247 if (CGM.getTriple().isOSBinFormatCOFF())
6248 ObjCEmptyCacheVar->setDLLStorageClass(getStorage(CGM, "_objc_empty_cache"));
Craig Topper8a13c412014-05-21 05:09:00 +00006249
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00006250 // Only OS X with deployment version <10.9 use the empty vtable symbol
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006251 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00006252 if (Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 9))
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006253 ObjCEmptyVtableVar =
6254 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ImpnfABITy, false,
6255 llvm::GlobalValue::ExternalLinkage, nullptr,
6256 "_objc_empty_vtable");
John McCall176f8922016-11-30 02:39:18 +00006257 else
6258 ObjCEmptyVtableVar =
6259 llvm::ConstantPointerNull::get(ObjCTypes.ImpnfABITy->getPointerTo());
Fariborz Jahanian71394042009-01-23 23:53:38 +00006260 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006261
Daniel Dunbare3f5cfc2009-04-20 20:18:54 +00006262 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006263 uint32_t InstanceStart =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006264 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006265 uint32_t InstanceSize = InstanceStart;
John McCallef19dbb2012-10-17 04:53:23 +00006266 uint32_t flags = NonFragileABI_Class_Meta;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006267
John McCalldba63a72016-11-30 23:54:50 +00006268 llvm::Constant *SuperClassGV, *IsAGV;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006269
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006270 const auto *CI = ID->getClassInterface();
6271 assert(CI && "CGObjCNonFragileABIMac::GenerateClass - class is 0");
6272
John McCall0d54a172012-10-17 04:53:31 +00006273 // Build the flags for the metaclass.
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006274 bool classIsHidden = (CGM.getTriple().isOSBinFormatCOFF())
6275 ? !CI->hasAttr<DLLExportAttr>()
6276 : CI->getVisibility() == HiddenVisibility;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006277 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006278 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006279
6280 // FIXME: why is this flag set on the metaclass?
6281 // ObjC metaclasses have no fields and don't really get constructed.
6282 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006283 flags |= NonFragileABI_Class_HasCXXStructors;
John McCall0d54a172012-10-17 04:53:31 +00006284 if (!ID->hasNonZeroConstructors())
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006285 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
John McCall0d54a172012-10-17 04:53:31 +00006286 }
6287
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006288 if (!CI->getSuperClass()) {
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006289 // class is root
John McCallef19dbb2012-10-17 04:53:23 +00006290 flags |= NonFragileABI_Class_Root;
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006291
John McCalldba63a72016-11-30 23:54:50 +00006292 SuperClassGV = GetClassGlobal(CI, /*metaclass*/ false, NotForDefinition);
6293 IsAGV = GetClassGlobal(CI, /*metaclass*/ true, NotForDefinition);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006294 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006295 // Has a root. Current class is not a root.
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00006296 const ObjCInterfaceDecl *Root = ID->getClassInterface();
6297 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
6298 Root = Super;
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006299
6300 const auto *Super = CI->getSuperClass();
John McCalldba63a72016-11-30 23:54:50 +00006301 IsAGV = GetClassGlobal(Root, /*metaclass*/ true, NotForDefinition);
6302 SuperClassGV = GetClassGlobal(Super, /*metaclass*/ true, NotForDefinition);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006303 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006304
6305 llvm::GlobalVariable *CLASS_RO_GV =
6306 BuildClassRoTInitializer(flags, InstanceStart, InstanceSize, ID);
6307
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006308 llvm::GlobalVariable *MetaTClass =
John McCalldba63a72016-11-30 23:54:50 +00006309 BuildClassObject(CI, /*metaclass*/ true,
6310 IsAGV, SuperClassGV, CLASS_RO_GV, classIsHidden);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006311 if (CGM.getTriple().isOSBinFormatCOFF())
6312 if (CI->hasAttr<DLLExportAttr>())
6313 MetaTClass->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
Fariborz Jahanian67260552009-11-17 21:37:35 +00006314 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar15894b72009-04-07 05:48:37 +00006315
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006316 // Metadata for the class
John McCallef19dbb2012-10-17 04:53:23 +00006317 flags = 0;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006318 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006319 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006320
6321 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006322 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006323
John McCall0d54a172012-10-17 04:53:31 +00006324 // Set a flag to enable a runtime optimization when a class has
6325 // fields that require destruction but which don't require
6326 // anything except zero-initialization during construction. This
6327 // is most notably true of __strong and __weak types, but you can
6328 // also imagine there being C++ types with non-trivial default
6329 // constructors that merely set all fields to null.
6330 if (!ID->hasNonZeroConstructors())
6331 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6332 }
6333
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006334 if (hasObjCExceptionAttribute(CGM.getContext(), CI))
John McCallef19dbb2012-10-17 04:53:23 +00006335 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006336
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006337 if (!CI->getSuperClass()) {
John McCallef19dbb2012-10-17 04:53:23 +00006338 flags |= NonFragileABI_Class_Root;
Craig Topper8a13c412014-05-21 05:09:00 +00006339 SuperClassGV = nullptr;
Chris Lattnerb433b272009-04-19 06:02:28 +00006340 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006341 // Has a root. Current class is not a root.
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006342 const auto *Super = CI->getSuperClass();
John McCalldba63a72016-11-30 23:54:50 +00006343 SuperClassGV = GetClassGlobal(Super, /*metaclass*/ false, NotForDefinition);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006344 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006345
Daniel Dunbar961202372009-05-03 12:57:56 +00006346 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006347 CLASS_RO_GV =
6348 BuildClassRoTInitializer(flags, InstanceStart, InstanceSize, ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006349
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006350 llvm::GlobalVariable *ClassMD =
John McCalldba63a72016-11-30 23:54:50 +00006351 BuildClassObject(CI, /*metaclass*/ false,
6352 MetaTClass, SuperClassGV, CLASS_RO_GV, classIsHidden);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006353 if (CGM.getTriple().isOSBinFormatCOFF())
6354 if (CI->hasAttr<DLLExportAttr>())
6355 ClassMD->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006356 DefinedClasses.push_back(ClassMD);
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006357 ImplementedClasses.push_back(CI);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006358
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006359 // Determine if this class is also "non-lazy".
6360 if (ImplementationIsNonLazy(ID))
6361 DefinedNonLazyClasses.push_back(ClassMD);
6362
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006363 // Force the definition of the EHType if necessary.
John McCallef19dbb2012-10-17 04:53:23 +00006364 if (flags & NonFragileABI_Class_Exception)
John McCalldba63a72016-11-30 23:54:50 +00006365 (void) GetInterfaceEHType(CI, ForDefinition);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006366 // Make sure method definition entries are all clear for next implementation.
6367 MethodDefinitions.clear();
Fariborz Jahanian71394042009-01-23 23:53:38 +00006368}
6369
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006370/// GenerateProtocolRef - This routine is called to generate code for
6371/// a protocol reference expression; as in:
6372/// @code
6373/// @protocol(Proto1);
6374/// @endcode
6375/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
6376/// which will hold address of the protocol meta-data.
6377///
John McCall882987f2013-02-28 19:01:20 +00006378llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006379 const ObjCProtocolDecl *PD) {
6380
Fariborz Jahanian464423d2009-04-10 18:47:34 +00006381 // This routine is called for @protocol only. So, we must build definition
6382 // of protocol's meta-data (not a reference to it!)
6383 //
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006384 llvm::Constant *Init =
6385 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00006386 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006387
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006388 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006389 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006390
John McCall7f416cc2015-09-08 08:05:57 +00006391 CharUnits Align = CGF.getPointerAlign();
6392
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006393 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
6394 if (PTGV)
John McCall7f416cc2015-09-08 08:05:57 +00006395 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006396 PTGV = new llvm::GlobalVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006397 CGM.getModule(),
6398 Init->getType(), false,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006399 llvm::GlobalValue::WeakAnyLinkage,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006400 Init,
6401 ProtocolName);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006402 PTGV->setSection("__DATA, __objc_protorefs, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006403 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall7f416cc2015-09-08 08:05:57 +00006404 PTGV->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00006405 CGM.addCompilerUsedGlobal(PTGV);
John McCall7f416cc2015-09-08 08:05:57 +00006406 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006407}
6408
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006409/// GenerateCategory - Build metadata for a category implementation.
6410/// struct _category_t {
6411/// const char * const name;
6412/// struct _class_t *const cls;
6413/// const struct _method_list_t * const instance_methods;
6414/// const struct _method_list_t * const class_methods;
6415/// const struct _protocol_list_t * const protocols;
6416/// const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00006417/// const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00006418/// const uint32_t size;
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006419/// }
6420///
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006421void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006422 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006423 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006424
6425 llvm::SmallString<64> ExtCatName(Prefix);
6426 ExtCatName += Interface->getObjCRuntimeNameAsString();
6427 ExtCatName += "_$_";
6428 ExtCatName += OCD->getNameAsString();
6429
John McCall176f8922016-11-30 02:39:18 +00006430 ConstantInitBuilder builder(CGM);
6431 auto values = builder.beginStruct(ObjCTypes.CategorynfABITy);
6432 values.add(GetClassName(OCD->getIdentifier()->getName()));
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006433 // meta-class entry symbol
John McCalldba63a72016-11-30 23:54:50 +00006434 values.add(GetClassGlobal(Interface, /*metaclass*/ false, NotForDefinition));
John McCall176f8922016-11-30 02:39:18 +00006435 std::string listName =
Saleem Abdulrasool209150a2016-10-24 21:25:57 +00006436 (Interface->getObjCRuntimeNameAsString() + "_$_" + OCD->getName()).str();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006437
John McCall176f8922016-11-30 02:39:18 +00006438 SmallVector<const ObjCMethodDecl *, 16> instanceMethods;
6439 SmallVector<const ObjCMethodDecl *, 8> classMethods;
6440 for (const auto *MD : OCD->methods()) {
6441 if (MD->isInstanceMethod()) {
6442 instanceMethods.push_back(MD);
6443 } else {
6444 classMethods.push_back(MD);
6445 }
6446 }
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006447
John McCall176f8922016-11-30 02:39:18 +00006448 values.add(emitMethodList(listName, MethodListType::CategoryInstanceMethods,
6449 instanceMethods));
6450 values.add(emitMethodList(listName, MethodListType::CategoryClassMethods,
6451 classMethods));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006452
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006453 const ObjCCategoryDecl *Category =
Fariborz Jahanian066347e2009-01-28 22:18:42 +00006454 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006455 if (Category) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006456 SmallString<256> ExtName;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006457 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006458 << OCD->getName();
John McCall176f8922016-11-30 02:39:18 +00006459 values.add(EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006460 + Interface->getObjCRuntimeNameAsString() + "_$_"
6461 + Category->getName(),
John McCall176f8922016-11-30 02:39:18 +00006462 Category->protocol_begin(),
6463 Category->protocol_end()));
6464 values.add(EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
6465 OCD, Category, ObjCTypes, false));
6466 values.add(EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
6467 OCD, Category, ObjCTypes, true));
Mike Stump658fe022009-07-30 22:28:39 +00006468 } else {
John McCall176f8922016-11-30 02:39:18 +00006469 values.addNullPointer(ObjCTypes.ProtocolListnfABIPtrTy);
6470 values.addNullPointer(ObjCTypes.PropertyListPtrTy);
6471 values.addNullPointer(ObjCTypes.PropertyListPtrTy);
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006472 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006473
Manman Ren42ff3902016-02-24 17:49:50 +00006474 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategorynfABITy);
John McCall176f8922016-11-30 02:39:18 +00006475 values.addInt(ObjCTypes.IntTy, Size);
Manman Ren42ff3902016-02-24 17:49:50 +00006476
John McCall176f8922016-11-30 02:39:18 +00006477 llvm::GlobalVariable *GCATV =
6478 values.finishAndCreateGlobal(ExtCatName.str(), CGM.getPointerAlign(),
6479 /*constant*/ false,
6480 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006481 if (CGM.getTriple().isOSBinFormatMachO())
6482 GCATV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006483 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006484 DefinedCategories.push_back(GCATV);
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006485
6486 // Determine if this category is also "non-lazy".
6487 if (ImplementationIsNonLazy(OCD))
6488 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006489 // method definition entries must be clear for next implementation.
6490 MethodDefinitions.clear();
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006491}
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006492
John McCall176f8922016-11-30 02:39:18 +00006493/// emitMethodConstant - Return a struct objc_method constant. If
6494/// forProtocol is true, the implementation will be null; otherwise,
6495/// the method must have a definition registered with the runtime.
6496///
6497/// struct _objc_method {
6498/// SEL _cmd;
6499/// char *method_type;
6500/// char *_imp;
6501/// }
6502void CGObjCNonFragileABIMac::emitMethodConstant(ConstantArrayBuilder &builder,
6503 const ObjCMethodDecl *MD,
6504 bool forProtocol) {
6505 auto method = builder.beginStruct(ObjCTypes.MethodTy);
6506 method.addBitCast(GetMethodVarName(MD->getSelector()),
6507 ObjCTypes.SelectorPtrTy);
6508 method.add(GetMethodVarType(MD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006509
John McCall176f8922016-11-30 02:39:18 +00006510 if (forProtocol) {
6511 // Protocol methods have no implementation. So, this entry is always NULL.
6512 method.addNullPointer(ObjCTypes.Int8PtrTy);
6513 } else {
6514 llvm::Function *fn = GetMethodDefinition(MD);
6515 assert(fn && "no definition for method?");
6516 method.addBitCast(fn, ObjCTypes.Int8PtrTy);
6517 }
6518
6519 method.finishAndAddTo(builder);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006520}
6521
John McCall176f8922016-11-30 02:39:18 +00006522/// Build meta-data for method declarations.
6523///
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006524/// struct _method_list_t {
6525/// uint32_t entsize; // sizeof(struct _objc_method)
6526/// uint32_t method_count;
6527/// struct _objc_method method_list[method_count];
6528/// }
6529///
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00006530llvm::Constant *
John McCall176f8922016-11-30 02:39:18 +00006531CGObjCNonFragileABIMac::emitMethodList(Twine name, MethodListType kind,
6532 ArrayRef<const ObjCMethodDecl *> methods) {
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006533 // Return null for empty list.
John McCall176f8922016-11-30 02:39:18 +00006534 if (methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006535 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006536
John McCall176f8922016-11-30 02:39:18 +00006537 StringRef prefix;
6538 bool forProtocol;
6539 switch (kind) {
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006540 case MethodListType::CategoryInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006541 prefix = "\01l_OBJC_$_CATEGORY_INSTANCE_METHODS_";
6542 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006543 break;
6544 case MethodListType::CategoryClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006545 prefix = "\01l_OBJC_$_CATEGORY_CLASS_METHODS_";
6546 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006547 break;
6548 case MethodListType::InstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006549 prefix = "\01l_OBJC_$_INSTANCE_METHODS_";
6550 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006551 break;
6552 case MethodListType::ClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006553 prefix = "\01l_OBJC_$_CLASS_METHODS_";
6554 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006555 break;
6556
6557 case MethodListType::ProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006558 prefix = "\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_";
6559 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006560 break;
6561 case MethodListType::ProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006562 prefix = "\01l_OBJC_$_PROTOCOL_CLASS_METHODS_";
6563 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006564 break;
6565 case MethodListType::OptionalProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006566 prefix = "\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_";
6567 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006568 break;
6569 case MethodListType::OptionalProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006570 prefix = "\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_";
6571 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006572 break;
6573 }
6574
John McCall176f8922016-11-30 02:39:18 +00006575 ConstantInitBuilder builder(CGM);
6576 auto values = builder.beginStruct();
6577
6578 // sizeof(struct _objc_method)
6579 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
6580 values.addInt(ObjCTypes.IntTy, Size);
6581 // method_count
6582 values.addInt(ObjCTypes.IntTy, methods.size());
6583 auto methodArray = values.beginArray(ObjCTypes.MethodTy);
6584 for (auto MD : methods) {
6585 emitMethodConstant(methodArray, MD, forProtocol);
6586 }
6587 methodArray.finishAndAddTo(values);
6588
6589 auto *GV = values.finishAndCreateGlobal(prefix + name, CGM.getPointerAlign(),
6590 /*constant*/ false,
6591 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006592 if (CGM.getTriple().isOSBinFormatMachO())
6593 GV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006594 CGM.addCompilerUsedGlobal(GV);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006595 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006596}
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006597
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006598/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6599/// the given ivar.
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006600llvm::GlobalVariable *
6601CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6602 const ObjCIvarDecl *Ivar) {
6603 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006604 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6605 Name += Container->getObjCRuntimeNameAsString();
6606 Name += ".";
6607 Name += Ivar->getName();
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006608 llvm::GlobalVariable *IvarOffsetGV = CGM.getModule().getGlobalVariable(Name);
6609 if (!IvarOffsetGV) {
6610 IvarOffsetGV =
6611 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.IvarOffsetVarTy,
6612 false, llvm::GlobalValue::ExternalLinkage,
6613 nullptr, Name.str());
6614 if (CGM.getTriple().isOSBinFormatCOFF()) {
6615 bool IsPrivateOrPackage =
6616 Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6617 Ivar->getAccessControl() == ObjCIvarDecl::Package;
6618
6619 if (ID->hasAttr<DLLExportAttr>() && !IsPrivateOrPackage)
6620 IvarOffsetGV->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
6621 else if (ID->hasAttr<DLLImportAttr>())
6622 IvarOffsetGV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
6623 }
6624 }
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006625 return IvarOffsetGV;
6626}
6627
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006628llvm::Constant *
6629CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6630 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00006631 unsigned long int Offset) {
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006632 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Tim Northover238b5082014-03-29 13:42:40 +00006633 IvarOffsetGV->setInitializer(
6634 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006635 IvarOffsetGV->setAlignment(
Tim Northover238b5082014-03-29 13:42:40 +00006636 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006637
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006638 if (!CGM.getTriple().isOSBinFormatCOFF()) {
6639 // FIXME: This matches gcc, but shouldn't the visibility be set on the use
6640 // as well (i.e., in ObjCIvarOffsetVariable).
6641 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6642 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
6643 ID->getVisibility() == HiddenVisibility)
6644 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
6645 else
6646 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
6647 }
6648
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006649 if (CGM.getTriple().isOSBinFormatMachO())
6650 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006651 return IvarOffsetGV;
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006652}
6653
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006654/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006655/// implementation. The return value has type
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006656/// IvarListnfABIPtrTy.
6657/// struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00006658/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006659/// char *name;
6660/// char *type;
6661/// uint32_t alignment;
6662/// uint32_t size;
6663/// }
6664/// struct _ivar_list_t {
6665/// uint32 entsize; // sizeof(struct _ivar_t)
6666/// uint32 count;
6667/// struct _iver_t list[count];
6668/// }
6669///
Daniel Dunbarf5c18462009-04-20 06:54:31 +00006670
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006671llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006672 const ObjCImplementationDecl *ID) {
6673
John McCall176f8922016-11-30 02:39:18 +00006674 ConstantInitBuilder builder(CGM);
6675 auto ivarList = builder.beginStruct();
6676 ivarList.addInt(ObjCTypes.IntTy,
6677 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy));
6678 auto ivarCountSlot = ivarList.addPlaceholder();
6679 auto ivars = ivarList.beginArray(ObjCTypes.IvarnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006680
Jordy Rosea91768e2011-07-22 02:08:32 +00006681 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006682 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006683
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006684 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006685
Jordy Rosea91768e2011-07-22 02:08:32 +00006686 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00006687 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00006688 // Ignore unnamed bit-fields.
6689 if (!IVD->getDeclName())
6690 continue;
John McCall176f8922016-11-30 02:39:18 +00006691
6692 auto ivar = ivars.beginStruct(ObjCTypes.IvarnfABITy);
6693 ivar.add(EmitIvarOffsetVar(ID->getClassInterface(), IVD,
6694 ComputeIvarBaseOffset(CGM, ID, IVD)));
6695 ivar.add(GetMethodVarName(IVD->getIdentifier()));
6696 ivar.add(GetMethodVarType(IVD));
Chris Lattner2192fe52011-07-18 04:24:23 +00006697 llvm::Type *FieldTy =
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006698 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmowdd31ca12012-10-08 16:25:52 +00006699 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006700 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006701 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006702 Align = llvm::Log2_32(Align);
John McCall176f8922016-11-30 02:39:18 +00006703 ivar.addInt(ObjCTypes.IntTy, Align);
Daniel Dunbarae032262009-04-20 00:33:43 +00006704 // NOTE. Size of a bitfield does not match gcc's, because of the
6705 // way bitfields are treated special in each. But I am told that
6706 // 'size' for bitfield ivars is ignored by the runtime so it does
6707 // not matter. If it matters, there is enough info to get the
6708 // bitfield right!
John McCall176f8922016-11-30 02:39:18 +00006709 ivar.addInt(ObjCTypes.IntTy, Size);
6710 ivar.finishAndAddTo(ivars);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006711 }
6712 // Return null for empty list.
John McCall176f8922016-11-30 02:39:18 +00006713 if (ivars.empty()) {
6714 ivars.abandon();
6715 ivarList.abandon();
Owen Anderson0b75f232009-07-31 20:28:54 +00006716 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
John McCall176f8922016-11-30 02:39:18 +00006717 }
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006718
John McCall176f8922016-11-30 02:39:18 +00006719 auto ivarCount = ivars.size();
6720 ivars.finishAndAddTo(ivarList);
6721 ivarList.fillPlaceholderWithInt(ivarCountSlot, ObjCTypes.IntTy, ivarCount);
6722
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006723 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6724 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00006725 ivarList.finishAndCreateGlobal(Prefix + OID->getObjCRuntimeNameAsString(),
6726 CGM.getPointerAlign(), /*constant*/ false,
6727 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006728 if (CGM.getTriple().isOSBinFormatMachO())
6729 GV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006730 CGM.addCompilerUsedGlobal(GV);
Owen Andersonade90fd2009-07-29 18:54:39 +00006731 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006732}
6733
6734llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006735 const ObjCProtocolDecl *PD) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006736 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006737
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006738 if (!Entry) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006739 // We use the initializer as a marker of whether this is a forward
6740 // reference or not. At module finalization we add the empty
6741 // contents for protocols which were referenced but never defined.
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006742 llvm::SmallString<64> Protocol;
6743 llvm::raw_svector_ostream(Protocol) << "\01l_OBJC_PROTOCOL_$_"
6744 << PD->getObjCRuntimeNameAsString();
6745
6746 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
6747 false, llvm::GlobalValue::ExternalLinkage,
6748 nullptr, Protocol);
6749 if (!CGM.getTriple().isOSBinFormatMachO())
6750 Entry->setComdat(CGM.getModule().getOrInsertComdat(Protocol));
6751 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006752
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006753 return Entry;
6754}
6755
6756/// GetOrEmitProtocol - Generate the protocol meta-data:
6757/// @code
6758/// struct _protocol_t {
6759/// id isa; // NULL
6760/// const char * const protocol_name;
6761/// const struct _protocol_list_t * protocol_list; // super protocols
6762/// const struct method_list_t * const instance_methods;
6763/// const struct method_list_t * const class_methods;
6764/// const struct method_list_t *optionalInstanceMethods;
6765/// const struct method_list_t *optionalClassMethods;
6766/// const struct _prop_list_t * properties;
6767/// const uint32_t size; // sizeof(struct _protocol_t)
6768/// const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006769/// const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006770/// const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00006771/// const struct _prop_list_t * class_properties;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006772/// }
6773/// @endcode
6774///
6775
6776llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006777 const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00006778 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006779
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006780 // Early exit if a defining object has already been generated.
6781 if (Entry && Entry->hasInitializer())
6782 return Entry;
6783
Douglas Gregora715bff2012-01-01 19:51:50 +00006784 // Use the protocol definition, if there is one.
6785 if (const ObjCProtocolDecl *Def = PD->getDefinition())
6786 PD = Def;
6787
John McCall176f8922016-11-30 02:39:18 +00006788 auto methodLists = ProtocolMethodLists::get(PD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006789
John McCall176f8922016-11-30 02:39:18 +00006790 ConstantInitBuilder builder(CGM);
6791 auto values = builder.beginStruct(ObjCTypes.ProtocolnfABITy);
Douglas Gregora9d84932011-05-27 01:19:52 +00006792
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006793 // isa is NULL
John McCall176f8922016-11-30 02:39:18 +00006794 values.addNullPointer(ObjCTypes.ObjectPtrTy);
6795 values.add(GetClassName(PD->getObjCRuntimeNameAsString()));
6796 values.add(EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_"
6797 + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006798 PD->protocol_begin(),
John McCall176f8922016-11-30 02:39:18 +00006799 PD->protocol_end()));
6800 values.add(methodLists.emitMethodList(this, PD,
6801 ProtocolMethodLists::RequiredInstanceMethods));
6802 values.add(methodLists.emitMethodList(this, PD,
6803 ProtocolMethodLists::RequiredClassMethods));
6804 values.add(methodLists.emitMethodList(this, PD,
6805 ProtocolMethodLists::OptionalInstanceMethods));
6806 values.add(methodLists.emitMethodList(this, PD,
6807 ProtocolMethodLists::OptionalClassMethods));
6808 values.add(EmitPropertyList(
6809 "\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6810 nullptr, PD, ObjCTypes, false));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006811 uint32_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006812 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
John McCall176f8922016-11-30 02:39:18 +00006813 values.addInt(ObjCTypes.IntTy, Size);
6814 values.addInt(ObjCTypes.IntTy, 0);
6815 values.add(EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006816 + PD->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006817 methodLists.emitExtendedTypesArray(this),
6818 ObjCTypes));
6819
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006820 // const char *demangledName;
John McCall176f8922016-11-30 02:39:18 +00006821 values.addNullPointer(ObjCTypes.Int8PtrTy);
Manman Rence7bff52016-01-29 23:46:55 +00006822
John McCall176f8922016-11-30 02:39:18 +00006823 values.add(EmitPropertyList(
Manman Rence7bff52016-01-29 23:46:55 +00006824 "\01l_OBJC_$_CLASS_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006825 nullptr, PD, ObjCTypes, true));
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006826
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006827 if (Entry) {
Rafael Espindola24615092014-09-12 20:14:20 +00006828 // Already created, fix the linkage and update the initializer.
6829 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
John McCall176f8922016-11-30 02:39:18 +00006830 values.finishAndSetAsInitializer(Entry);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006831 } else {
John McCall176f8922016-11-30 02:39:18 +00006832 llvm::SmallString<64> symbolName;
6833 llvm::raw_svector_ostream(symbolName)
6834 << "\01l_OBJC_PROTOCOL_$_" << PD->getObjCRuntimeNameAsString();
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006835
John McCall176f8922016-11-30 02:39:18 +00006836 Entry = values.finishAndCreateGlobal(symbolName, CGM.getPointerAlign(),
6837 /*constant*/ false,
6838 llvm::GlobalValue::WeakAnyLinkage);
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006839 if (!CGM.getTriple().isOSBinFormatMachO())
John McCall176f8922016-11-30 02:39:18 +00006840 Entry->setComdat(CGM.getModule().getOrInsertComdat(symbolName));
John McCallf9582a72012-03-30 21:29:05 +00006841
6842 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006843 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006844 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006845 CGM.addCompilerUsedGlobal(Entry);
Chris Lattnerf56501c2009-07-17 23:57:13 +00006846
Fariborz Jahanian61cd4b52009-01-29 20:10:59 +00006847 // Use this protocol meta-data to build protocol list table in section
6848 // __DATA, __objc_protolist
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006849 llvm::SmallString<64> ProtocolRef;
6850 llvm::raw_svector_ostream(ProtocolRef) << "\01l_OBJC_LABEL_PROTOCOL_$_"
6851 << PD->getObjCRuntimeNameAsString();
6852
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006853 llvm::GlobalVariable *PTGV =
6854 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006855 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006856 ProtocolRef);
6857 if (!CGM.getTriple().isOSBinFormatMachO())
6858 PTGV->setComdat(CGM.getModule().getOrInsertComdat(ProtocolRef));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006859 PTGV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006860 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006861 if (CGM.getTriple().isOSBinFormatMachO())
6862 PTGV->setSection("__DATA, __objc_protolist, coalesced, no_dead_strip");
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006863 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Rafael Espindola060062a2014-03-06 22:15:10 +00006864 CGM.addCompilerUsedGlobal(PTGV);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006865 return Entry;
6866}
6867
6868/// EmitProtocolList - Generate protocol list meta-data:
6869/// @code
6870/// struct _protocol_list_t {
6871/// long protocol_count; // Note, this is 32/64 bit
6872/// struct _protocol_t[protocol_count];
6873/// }
6874/// @endcode
6875///
6876llvm::Constant *
Chris Lattner0e62c1c2011-07-23 10:55:15 +00006877CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006878 ObjCProtocolDecl::protocol_iterator begin,
6879 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006880 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006881
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006882 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006883 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00006884 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006885
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006886 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006887 SmallString<256> TmpName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006888 Name.toVector(TmpName);
6889 llvm::GlobalVariable *GV =
6890 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006891 if (GV)
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006892 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006893
John McCall176f8922016-11-30 02:39:18 +00006894 ConstantInitBuilder builder(CGM);
6895 auto values = builder.beginStruct();
6896 auto countSlot = values.addPlaceholder();
6897
6898 // A null-terminated array of protocols.
6899 auto array = values.beginArray(ObjCTypes.ProtocolnfABIPtrTy);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006900 for (; begin != end; ++begin)
John McCall176f8922016-11-30 02:39:18 +00006901 array.add(GetProtocolRef(*begin)); // Implemented???
6902 auto count = array.size();
6903 array.addNullPointer(ObjCTypes.ProtocolnfABIPtrTy);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006904
John McCall176f8922016-11-30 02:39:18 +00006905 array.finishAndAddTo(values);
6906 values.fillPlaceholderWithInt(countSlot, ObjCTypes.LongTy, count);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006907
John McCall176f8922016-11-30 02:39:18 +00006908 GV = values.finishAndCreateGlobal(Name, CGM.getPointerAlign(),
6909 /*constant*/ false,
6910 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006911 if (CGM.getTriple().isOSBinFormatMachO())
6912 GV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006913 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006914 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006915 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006916}
6917
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006918/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6919/// This code gen. amounts to generating code for:
6920/// @code
6921/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6922/// @encode
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006923///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00006924LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall96fa4842010-05-17 21:00:27 +00006925 CodeGen::CodeGenFunction &CGF,
6926 QualType ObjectTy,
6927 llvm::Value *BaseValue,
6928 const ObjCIvarDecl *Ivar,
6929 unsigned CVRQualifiers) {
6930 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006931 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00006932 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00006933 Offset);
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006934}
6935
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006936llvm::Value *CGObjCNonFragileABIMac::EmitIvarOffset(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006937 CodeGen::CodeGenFunction &CGF,
6938 const ObjCInterfaceDecl *Interface,
6939 const ObjCIvarDecl *Ivar) {
Tim Northover238b5082014-03-29 13:42:40 +00006940 llvm::Value *IvarOffsetValue = ObjCIvarOffsetVariable(Interface, Ivar);
John McCall7f416cc2015-09-08 08:05:57 +00006941 IvarOffsetValue = CGF.Builder.CreateAlignedLoad(IvarOffsetValue,
6942 CGF.getSizeAlign(), "ivar");
Tim Northover238b5082014-03-29 13:42:40 +00006943 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
6944 cast<llvm::LoadInst>(IvarOffsetValue)
6945 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
Craig Topper5fc8fc22014-08-27 06:28:36 +00006946 llvm::MDNode::get(VMContext, None));
Tim Northover238b5082014-03-29 13:42:40 +00006947
6948 // This could be 32bit int or 64bit integer depending on the architecture.
6949 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
6950 // as this is what caller always expectes.
6951 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
6952 IvarOffsetValue = CGF.Builder.CreateIntCast(
6953 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
6954 return IvarOffsetValue;
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00006955}
6956
John McCall234eac82011-05-13 23:16:18 +00006957static void appendSelectorForMessageRefTable(std::string &buffer,
6958 Selector selector) {
6959 if (selector.isUnarySelector()) {
6960 buffer += selector.getNameForSlot(0);
6961 return;
6962 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006963
John McCall234eac82011-05-13 23:16:18 +00006964 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
6965 buffer += selector.getNameForSlot(i);
6966 buffer += '_';
6967 }
6968}
6969
Eric Christopherd160c502016-01-29 01:35:53 +00006970/// Emit a "vtable" message send. We emit a weak hidden-visibility
John McCall9e8bb002011-05-14 03:10:52 +00006971/// struct, initially containing the selector pointer and a pointer to
6972/// a "fixup" variant of the appropriate objc_msgSend. To call, we
6973/// load and call the function pointer, passing the address of the
6974/// struct as the second parameter. The runtime determines whether
6975/// the selector is currently emitted using vtable dispatch; if so, it
6976/// substitutes a stub function which simply tail-calls through the
6977/// appropriate vtable slot, and if not, it substitues a stub function
6978/// which tail-calls objc_msgSend. Both stubs adjust the selector
6979/// argument to correctly point to the selector.
6980RValue
6981CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
6982 ReturnValueSlot returnSlot,
6983 QualType resultType,
6984 Selector selector,
6985 llvm::Value *arg0,
6986 QualType arg0Type,
6987 bool isSuper,
6988 const CallArgList &formalArgs,
6989 const ObjCMethodDecl *method) {
John McCall234eac82011-05-13 23:16:18 +00006990 // Compute the actual arguments.
6991 CallArgList args;
6992
John McCall9e8bb002011-05-14 03:10:52 +00006993 // First argument: the receiver / super-call structure.
John McCall234eac82011-05-13 23:16:18 +00006994 if (!isSuper)
John McCall9e8bb002011-05-14 03:10:52 +00006995 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
6996 args.add(RValue::get(arg0), arg0Type);
John McCall234eac82011-05-13 23:16:18 +00006997
John McCall9e8bb002011-05-14 03:10:52 +00006998 // Second argument: a pointer to the message ref structure. Leave
6999 // the actual argument value blank for now.
Craig Topper8a13c412014-05-21 05:09:00 +00007000 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCall234eac82011-05-13 23:16:18 +00007001
7002 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
7003
John McCalla729c622012-02-17 03:33:10 +00007004 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCall234eac82011-05-13 23:16:18 +00007005
John McCall5880fb82011-05-14 21:12:11 +00007006 NullReturnState nullReturn;
7007
John McCall9e8bb002011-05-14 03:10:52 +00007008 // Find the function to call and the mangled name for the message
7009 // ref structure. Using a different mangled name wouldn't actually
7010 // be a problem; it would just be a waste.
7011 //
7012 // The runtime currently never uses vtable dispatch for anything
7013 // except normal, non-super message-sends.
7014 // FIXME: don't use this for that.
Craig Topper8a13c412014-05-21 05:09:00 +00007015 llvm::Constant *fn = nullptr;
John McCall234eac82011-05-13 23:16:18 +00007016 std::string messageRefName("\01l_");
Tim Northovere77cc392014-03-29 13:28:05 +00007017 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall234eac82011-05-13 23:16:18 +00007018 if (isSuper) {
7019 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
7020 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007021 } else {
John McCall5880fb82011-05-14 21:12:11 +00007022 nullReturn.init(CGF, arg0);
John McCall234eac82011-05-13 23:16:18 +00007023 fn = ObjCTypes.getMessageSendStretFixupFn();
7024 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007025 }
John McCall234eac82011-05-13 23:16:18 +00007026 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
7027 fn = ObjCTypes.getMessageSendFpretFixupFn();
7028 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stump658fe022009-07-30 22:28:39 +00007029 } else {
John McCall234eac82011-05-13 23:16:18 +00007030 if (isSuper) {
7031 fn = ObjCTypes.getMessageSendSuper2FixupFn();
7032 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007033 } else {
John McCall234eac82011-05-13 23:16:18 +00007034 fn = ObjCTypes.getMessageSendFixupFn();
7035 messageRefName += "objc_msgSend_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007036 }
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00007037 }
John McCall234eac82011-05-13 23:16:18 +00007038 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
7039 messageRefName += '_';
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007040
John McCall234eac82011-05-13 23:16:18 +00007041 // Append the selector name, except use underscores anywhere we
7042 // would have used colons.
7043 appendSelectorForMessageRefTable(messageRefName, selector);
7044
7045 llvm::GlobalVariable *messageRef
7046 = CGM.getModule().getGlobalVariable(messageRefName);
7047 if (!messageRef) {
John McCall9e8bb002011-05-14 03:10:52 +00007048 // Build the message ref structure.
John McCall176f8922016-11-30 02:39:18 +00007049 ConstantInitBuilder builder(CGM);
7050 auto values = builder.beginStruct();
7051 values.add(fn);
7052 values.add(GetMethodVarName(selector));
7053 messageRef = values.finishAndCreateGlobal(messageRefName,
7054 CharUnits::fromQuantity(16),
7055 /*constant*/ false,
7056 llvm::GlobalValue::WeakAnyLinkage);
Rafael Espindola70efc5b2014-03-06 18:54:12 +00007057 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall234eac82011-05-13 23:16:18 +00007058 messageRef->setSection("__DATA, __objc_msgrefs, coalesced");
7059 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00007060
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00007061 bool requiresnullCheck = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00007062 if (CGM.getLangOpts().ObjCAutoRefCount && method)
David Majnemer59f77922016-06-24 04:05:48 +00007063 for (const auto *ParamDecl : method->parameters()) {
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00007064 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
7065 if (!nullReturn.NullBB)
7066 nullReturn.init(CGF, arg0);
7067 requiresnullCheck = true;
7068 break;
7069 }
7070 }
7071
John McCall7f416cc2015-09-08 08:05:57 +00007072 Address mref =
7073 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
7074 CGF.getPointerAlign());
John McCall234eac82011-05-13 23:16:18 +00007075
John McCall9e8bb002011-05-14 03:10:52 +00007076 // Update the message ref argument.
John McCall7f416cc2015-09-08 08:05:57 +00007077 args[1].RV = RValue::get(mref.getPointer());
John McCall234eac82011-05-13 23:16:18 +00007078
7079 // Load the function to call from the message ref table.
John McCall7f416cc2015-09-08 08:05:57 +00007080 Address calleeAddr =
7081 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
John McCallb92ab1a2016-10-26 23:46:34 +00007082 llvm::Value *calleePtr = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCall234eac82011-05-13 23:16:18 +00007083
John McCallb92ab1a2016-10-26 23:46:34 +00007084 calleePtr = CGF.Builder.CreateBitCast(calleePtr, MSI.MessengerType);
7085 CGCallee callee(CGCalleeInfo(), calleePtr);
John McCall234eac82011-05-13 23:16:18 +00007086
John McCalla729c622012-02-17 03:33:10 +00007087 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Craig Topper8a13c412014-05-21 05:09:00 +00007088 return nullReturn.complete(CGF, result, resultType, formalArgs,
7089 requiresnullCheck ? method : nullptr);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00007090}
7091
7092/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007093CodeGen::RValue
7094CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00007095 ReturnValueSlot Return,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007096 QualType ResultType,
7097 Selector Sel,
7098 llvm::Value *Receiver,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007099 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00007100 const ObjCInterfaceDecl *Class,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007101 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00007102 return isVTableDispatchedSelector(Sel)
7103 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007104 Receiver, CGF.getContext().getObjCIdType(),
John McCall9e8bb002011-05-14 03:10:52 +00007105 false, CallArgs, Method)
7106 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00007107 EmitSelector(CGF, Sel),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007108 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00007109 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00007110}
7111
John McCalldba63a72016-11-30 23:54:50 +00007112llvm::Constant *
7113CGObjCNonFragileABIMac::GetClassGlobal(const ObjCInterfaceDecl *ID,
7114 bool metaclass,
7115 ForDefinition_t isForDefinition) {
7116 auto prefix =
7117 (metaclass ? getMetaclassSymbolPrefix() : getClassSymbolPrefix());
7118 return GetClassGlobal((prefix + ID->getObjCRuntimeNameAsString()).str(),
7119 isForDefinition,
7120 ID->isWeakImported(),
7121 !isForDefinition
7122 && CGM.getTriple().isOSBinFormatCOFF()
7123 && ID->hasAttr<DLLImportAttr>());
7124}
7125
7126llvm::Constant *
7127CGObjCNonFragileABIMac::GetClassGlobal(StringRef Name,
7128 ForDefinition_t IsForDefinition,
7129 bool Weak, bool DLLImport) {
Rafael Espindola554256c2014-02-26 22:25:45 +00007130 llvm::GlobalValue::LinkageTypes L =
7131 Weak ? llvm::GlobalValue::ExternalWeakLinkage
7132 : llvm::GlobalValue::ExternalLinkage;
7133
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00007134
John McCalldba63a72016-11-30 23:54:50 +00007135
7136 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
7137 if (!GV) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007138 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABITy,
Craig Topper8a13c412014-05-21 05:09:00 +00007139 false, L, nullptr, Name);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00007140
John McCalldba63a72016-11-30 23:54:50 +00007141 if (DLLImport)
7142 GV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
7143 }
7144
Rafael Espindola554256c2014-02-26 22:25:45 +00007145 assert(GV->getLinkage() == L);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00007146 return GV;
7147}
7148
John McCalldba63a72016-11-30 23:54:50 +00007149llvm::Value *
7150CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
7151 IdentifierInfo *II,
7152 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00007153 CharUnits Align = CGF.getPointerAlign();
John McCall31168b02011-06-15 23:02:42 +00007154 llvm::GlobalVariable *&Entry = ClassReferences[II];
7155
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007156 if (!Entry) {
John McCalldba63a72016-11-30 23:54:50 +00007157 llvm::Constant *ClassGV;
7158 if (ID) {
7159 ClassGV = GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition);
7160 } else {
7161 ClassGV = GetClassGlobal((getClassSymbolPrefix() + II->getName()).str(),
7162 NotForDefinition);
7163 }
7164
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007165 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
7166 false, llvm::GlobalValue::PrivateLinkage,
7167 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007168 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007169 Entry->setSection("__DATA, __objc_classrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00007170 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007171 }
John McCall7f416cc2015-09-08 08:05:57 +00007172 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007173}
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007174
John McCall882987f2013-02-28 19:01:20 +00007175llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00007176 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00007177 // If the class has the objc_runtime_visible attribute, we need to
7178 // use the Objective-C runtime to get the class.
7179 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
7180 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
7181
John McCalldba63a72016-11-30 23:54:50 +00007182 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID);
John McCall31168b02011-06-15 23:02:42 +00007183}
7184
7185llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCall882987f2013-02-28 19:01:20 +00007186 CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00007187 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCalldba63a72016-11-30 23:54:50 +00007188 return EmitClassRefFromId(CGF, II, nullptr);
John McCall31168b02011-06-15 23:02:42 +00007189}
7190
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007191llvm::Value *
John McCall882987f2013-02-28 19:01:20 +00007192CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007193 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00007194 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007195 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007196
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007197 if (!Entry) {
John McCalldba63a72016-11-30 23:54:50 +00007198 auto ClassGV = GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007199 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
7200 false, llvm::GlobalValue::PrivateLinkage,
7201 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007202 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007203 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00007204 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007205 }
John McCall7f416cc2015-09-08 08:05:57 +00007206 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007207}
7208
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007209/// EmitMetaClassRef - Return a Value * of the address of _class_t
7210/// meta-data
7211///
John McCall882987f2013-02-28 19:01:20 +00007212llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00007213 const ObjCInterfaceDecl *ID,
7214 bool Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00007215 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007216 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Rafael Espindola21039aa2014-02-27 16:26:32 +00007217 if (!Entry) {
John McCalldba63a72016-11-30 23:54:50 +00007218 auto MetaClassGV = GetClassGlobal(ID, /*metaclass*/ true, NotForDefinition);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007219
Rafael Espindola21039aa2014-02-27 16:26:32 +00007220 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00007221 false, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007222 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007223 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007224
Rafael Espindola21039aa2014-02-27 16:26:32 +00007225 Entry->setSection("__DATA, __objc_superrefs, regular, no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00007226 CGM.addCompilerUsedGlobal(Entry);
Rafael Espindola21039aa2014-02-27 16:26:32 +00007227 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007228
John McCall7f416cc2015-09-08 08:05:57 +00007229 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007230}
7231
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007232/// GetClass - Return a reference to the class for the given interface
7233/// decl.
John McCall882987f2013-02-28 19:01:20 +00007234llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007235 const ObjCInterfaceDecl *ID) {
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00007236 if (ID->isWeakImported()) {
John McCalldba63a72016-11-30 23:54:50 +00007237 auto ClassGV = GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition);
Nick Lewycky9a441642014-02-27 00:36:00 +00007238 (void)ClassGV;
John McCalldba63a72016-11-30 23:54:50 +00007239 assert(!isa<llvm::GlobalVariable>(ClassGV) ||
7240 cast<llvm::GlobalVariable>(ClassGV)->hasExternalWeakLinkage());
Fariborz Jahanian95ace552009-11-17 22:42:00 +00007241 }
7242
John McCall882987f2013-02-28 19:01:20 +00007243 return EmitClassRef(CGF, ID);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007244}
7245
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007246/// Generates a message send where the super is the receiver. This is
7247/// a message send to self with special delivery semantics indicating
7248/// which class's method should be called.
7249CodeGen::RValue
7250CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00007251 ReturnValueSlot Return,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007252 QualType ResultType,
7253 Selector Sel,
7254 const ObjCInterfaceDecl *Class,
7255 bool isCategoryImpl,
7256 llvm::Value *Receiver,
7257 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007258 const CodeGen::CallArgList &CallArgs,
7259 const ObjCMethodDecl *Method) {
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007260 // ...
7261 // Create and init a super structure; this is a (receiver, class)
7262 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00007263 Address ObjCSuper =
7264 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
7265 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007266
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007267 llvm::Value *ReceiverAsObject =
7268 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007269 CGF.Builder.CreateStore(
7270 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00007271 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007272
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007273 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00007274 llvm::Value *Target;
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007275 if (IsClassMessage)
Fariborz Jahanian85b99da2014-08-28 17:05:17 +00007276 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007277 else
John McCall882987f2013-02-28 19:01:20 +00007278 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007279
Mike Stump18bb9282009-05-16 07:57:57 +00007280 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
7281 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00007282 llvm::Type *ClassTy =
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007283 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
7284 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007285 CGF.Builder.CreateStore(
John McCall7f416cc2015-09-08 08:05:57 +00007286 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007287
John McCall9e8bb002011-05-14 03:10:52 +00007288 return (isVTableDispatchedSelector(Sel))
7289 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
John McCall7f416cc2015-09-08 08:05:57 +00007290 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall9e8bb002011-05-14 03:10:52 +00007291 true, CallArgs, Method)
7292 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00007293 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00007294 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00007295 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007296}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007297
John McCall882987f2013-02-28 19:01:20 +00007298llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007299 Selector Sel) {
7300 Address Addr = EmitSelectorAddr(CGF, Sel);
7301
7302 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
7303 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
7304 llvm::MDNode::get(VMContext, None));
7305 return LI;
7306}
7307
7308Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
7309 Selector Sel) {
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007310 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007311
John McCall7f416cc2015-09-08 08:05:57 +00007312 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007313 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007314 llvm::Constant *Casted =
7315 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
7316 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007317 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
7318 false, llvm::GlobalValue::PrivateLinkage,
7319 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman5c205962013-02-05 23:08:45 +00007320 Entry->setExternallyInitialized(true);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00007321 Entry->setSection("__DATA, __objc_selrefs, literal_pointers, no_dead_strip");
John McCall7f416cc2015-09-08 08:05:57 +00007322 Entry->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00007323 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007324 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007325
John McCall7f416cc2015-09-08 08:05:57 +00007326 return Address(Entry, Align);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007327}
John McCall7f416cc2015-09-08 08:05:57 +00007328
Fariborz Jahanian06292952009-02-16 22:52:32 +00007329/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007330/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian06292952009-02-16 22:52:32 +00007331///
7332void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00007333 llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +00007334 Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007335 llvm::Value *ivarOffset) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007336 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007337 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007338 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007339 assert(Size <= 8 && "does not support size > 8");
7340 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7341 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007342 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7343 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007344 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7345 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007346 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00007347 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007348}
7349
7350/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
7351/// objc_assign_strongCast (id src, id *dst)
7352///
7353void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007354 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007355 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007356 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007357 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007358 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007359 assert(Size <= 8 && "does not support size > 8");
7360 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007361 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007362 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7363 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007364 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7365 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007366 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007367 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
7368 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007369}
7370
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007371void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007372 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007373 Address DestPtr,
7374 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00007375 llvm::Value *Size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007376 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
7377 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007378 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCall882987f2013-02-28 19:01:20 +00007379 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007380}
7381
Fariborz Jahanian06292952009-02-16 22:52:32 +00007382/// EmitObjCWeakRead - Code gen for loading value of a __weak
7383/// object: objc_read_weak (id *src)
7384///
7385llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007386 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007387 Address AddrWeakObj) {
7388 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007389 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007390 llvm::Value *read_weak =
7391 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00007392 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00007393 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007394 return read_weak;
7395}
7396
7397/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
7398/// objc_assign_weak (id src, id *dst)
7399///
7400void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007401 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007402 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007403 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007404 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007405 assert(Size <= 8 && "does not support size > 8");
7406 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7407 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007408 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7409 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007410 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7411 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007412 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007413 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
7414 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007415}
7416
7417/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
7418/// objc_assign_global (id src, id *dst)
7419///
7420void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007421 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00007422 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007423 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007424 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007425 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007426 assert(Size <= 8 && "does not support size > 8");
7427 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7428 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007429 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7430 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007431 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7432 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007433 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00007434 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00007435 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
7436 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00007437 else
John McCall882987f2013-02-28 19:01:20 +00007438 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
7439 args, "threadlocalassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007440}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007441
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007442void
John McCallbd309292010-07-06 01:34:17 +00007443CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
7444 const ObjCAtSynchronizedStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007445 EmitAtSynchronizedStmt(CGF, S,
7446 cast<llvm::Function>(ObjCTypes.getSyncEnterFn()),
7447 cast<llvm::Function>(ObjCTypes.getSyncExitFn()));
John McCallbd309292010-07-06 01:34:17 +00007448}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007449
John McCall2ca705e2010-07-24 00:37:23 +00007450llvm::Constant *
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00007451CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall2ca705e2010-07-24 00:37:23 +00007452 // There's a particular fixed type info for 'id'.
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007453 if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
7454 auto *IDEHType = CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007455 if (!IDEHType) {
John McCall2ca705e2010-07-24 00:37:23 +00007456 IDEHType =
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007457 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7458 llvm::GlobalValue::ExternalLinkage, nullptr,
7459 "OBJC_EHTYPE_id");
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007460 if (CGM.getTriple().isOSBinFormatCOFF())
7461 IDEHType->setDLLStorageClass(getStorage(CGM, "OBJC_EHTYPE_id"));
7462 }
John McCall2ca705e2010-07-24 00:37:23 +00007463 return IDEHType;
7464 }
7465
7466 // All other types should be Objective-C interface pointer types.
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007467 const ObjCObjectPointerType *PT = T->getAs<ObjCObjectPointerType>();
John McCall2ca705e2010-07-24 00:37:23 +00007468 assert(PT && "Invalid @catch type.");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007469
John McCall2ca705e2010-07-24 00:37:23 +00007470 const ObjCInterfaceType *IT = PT->getInterfaceType();
7471 assert(IT && "Invalid @catch type.");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007472
John McCalldba63a72016-11-30 23:54:50 +00007473 return GetInterfaceEHType(IT->getDecl(), NotForDefinition);
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007474}
John McCall2ca705e2010-07-24 00:37:23 +00007475
John McCallbd309292010-07-06 01:34:17 +00007476void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7477 const ObjCAtTryStmt &S) {
David Chisnall3e575602011-03-25 17:46:35 +00007478 EmitTryCatchStmt(CGF, S,
7479 cast<llvm::Function>(ObjCTypes.getObjCBeginCatchFn()),
7480 cast<llvm::Function>(ObjCTypes.getObjCEndCatchFn()),
7481 cast<llvm::Function>(ObjCTypes.getExceptionRethrowFn()));
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +00007482}
7483
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007484/// EmitThrowStmt - Generate code for a throw statement.
7485void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007486 const ObjCAtThrowStmt &S,
7487 bool ClearInsertionPoint) {
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007488 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00007489 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer76399eb2011-09-27 21:06:10 +00007490 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007491 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception)
John McCall17afe452010-10-16 08:21:07 +00007492 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007493 } else {
John McCall882987f2013-02-28 19:01:20 +00007494 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn())
John McCall17afe452010-10-16 08:21:07 +00007495 .setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007496 }
7497
John McCall17afe452010-10-16 08:21:07 +00007498 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007499 if (ClearInsertionPoint)
7500 CGF.Builder.ClearInsertionPoint();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007501}
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007502
John McCall2ca705e2010-07-24 00:37:23 +00007503llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007504CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
John McCalldba63a72016-11-30 23:54:50 +00007505 ForDefinition_t IsForDefinition) {
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007506 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007507 StringRef ClassName = ID->getObjCRuntimeNameAsString();
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007508
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007509 // If we don't need a definition, return the entry if found or check
7510 // if we use an external reference.
John McCalldba63a72016-11-30 23:54:50 +00007511 if (!IsForDefinition) {
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007512 if (Entry)
7513 return Entry;
Daniel Dunbard7beeea2009-04-07 06:43:45 +00007514
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007515 // If this type (or a super class) has the __objc_exception__
7516 // attribute, emit an external reference.
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007517 if (hasObjCExceptionAttribute(CGM.getContext(), ID)) {
7518 std::string EHTypeName = ("OBJC_EHTYPE_$_" + ClassName).str();
7519 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7520 false, llvm::GlobalValue::ExternalLinkage,
7521 nullptr, EHTypeName);
7522 if (CGM.getTriple().isOSBinFormatCOFF()) {
7523 if (ID->hasAttr<DLLExportAttr>())
7524 Entry->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
7525 else if (ID->hasAttr<DLLImportAttr>())
7526 Entry->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
7527 }
7528 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);
7549 values.add(llvm::ConstantExpr::getGetElementPtr(VTableGV->getValueType(),
7550 VTableGV, VTableIdx));
John McCalldba63a72016-11-30 23:54:50 +00007551 values.add(GetClassName(ClassName));
7552 values.add(GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition));
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007553
John McCalldba63a72016-11-30 23:54:50 +00007554 llvm::GlobalValue::LinkageTypes L = IsForDefinition
Rafael Espindola554256c2014-02-26 22:25:45 +00007555 ? llvm::GlobalValue::ExternalLinkage
7556 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007557 if (Entry) {
John McCall176f8922016-11-30 02:39:18 +00007558 values.finishAndSetAsInitializer(Entry);
7559 Entry->setAlignment(CGM.getPointerAlign().getQuantity());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007560 } else {
John McCall176f8922016-11-30 02:39:18 +00007561 Entry = values.finishAndCreateGlobal("OBJC_EHTYPE_$_" + ClassName,
7562 CGM.getPointerAlign(),
7563 /*constant*/ false,
7564 L);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007565 if (CGM.getTriple().isOSBinFormatCOFF())
7566 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
7567 if (ID->hasAttr<DLLExportAttr>())
7568 Entry->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007569 }
Rafael Espindola554256c2014-02-26 22:25:45 +00007570 assert(Entry->getLinkage() == L);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007571
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007572 if (!CGM.getTriple().isOSBinFormatCOFF())
7573 if (ID->getVisibility() == HiddenVisibility)
7574 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007575
John McCalldba63a72016-11-30 23:54:50 +00007576 if (IsForDefinition)
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00007577 if (CGM.getTriple().isOSBinFormatMachO())
7578 Entry->setSection("__DATA,__objc_const");
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007579
7580 return Entry;
7581}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007582
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00007583/* *** */
7584
Daniel Dunbarb036db82008-08-13 03:21:16 +00007585CodeGen::CGObjCRuntime *
7586CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00007587 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7588 case ObjCRuntime::FragileMacOSX:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007589 return new CGObjCMac(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00007590
7591 case ObjCRuntime::MacOSX:
7592 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00007593 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00007594 return new CGObjCNonFragileABIMac(CGM);
7595
David Chisnallb601c962012-07-03 20:49:52 +00007596 case ObjCRuntime::GNUstep:
7597 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +00007598 case ObjCRuntime::ObjFW:
John McCall5fb5df92012-06-20 06:18:46 +00007599 llvm_unreachable("these runtimes are not Mac runtimes");
7600 }
7601 llvm_unreachable("bad runtime");
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007602}