blob: 520d860d4a0d6b04f0bbb07a3e702f99b483435d [file] [log] [blame]
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001//===------- CGObjCMac.cpp - Interface to Apple Objective-C Runtime -------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Daniel Dunbar303e2c22008-08-11 02:45:11 +00006//
7//===----------------------------------------------------------------------===//
8//
Chris Lattner57540c52011-04-15 05:22:18 +00009// This provides Objective-C code generation targeting the Apple runtime.
Daniel Dunbar303e2c22008-08-11 02:45:11 +000010//
11//===----------------------------------------------------------------------===//
12
John McCallad7c5c12011-02-08 08:22:06 +000013#include "CGBlocks.h"
John McCalled1ae862011-01-28 11:13:47 +000014#include "CGCleanup.h"
Justin Lebar5e83dfe2016-10-21 21:45:01 +000015#include "CGObjCRuntime.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000016#include "CGRecordLayout.h"
17#include "CodeGenFunction.h"
18#include "CodeGenModule.h"
John McCall5ad74072017-03-02 20:04:19 +000019#include "clang/CodeGen/ConstantInitBuilder.h"
Daniel Dunbar8b8683f2008-08-12 00:12:39 +000020#include "clang/AST/ASTContext.h"
Daniel Dunbar221fa942008-08-11 04:54:23 +000021#include "clang/AST/Decl.h"
Daniel Dunbarb036db82008-08-13 03:21:16 +000022#include "clang/AST/DeclObjC.h"
Anders Carlsson15b73de2009-07-18 19:43:29 +000023#include "clang/AST/RecordLayout.h"
Chris Lattnerf0b64d72009-04-26 01:32:48 +000024#include "clang/AST/StmtObjC.h"
Richard Trieu63688182018-12-11 03:18:39 +000025#include "clang/Basic/CodeGenOptions.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"
Justin Lebar5e83dfe2016-10-21 21:45:01 +000028#include "llvm/ADT/CachedHashString.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "llvm/ADT/DenseSet.h"
30#include "llvm/ADT/SetVector.h"
31#include "llvm/ADT/SmallPtrSet.h"
32#include "llvm/ADT/SmallString.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000033#include "llvm/IR/DataLayout.h"
34#include "llvm/IR/InlineAsm.h"
35#include "llvm/IR/IntrinsicInst.h"
36#include "llvm/IR/LLVMContext.h"
37#include "llvm/IR/Module.h"
Akira Hatanaka2ec36f02018-08-17 15:46:07 +000038#include "llvm/Support/ScopedPrinter.h"
Daniel Dunbard027a922009-09-07 00:20:42 +000039#include "llvm/Support/raw_ostream.h"
Torok Edwindb714922009-08-24 13:25:12 +000040#include <cstdio>
Daniel Dunbar303e2c22008-08-11 02:45:11 +000041
42using namespace clang;
Daniel Dunbar41cf9de2008-09-09 01:06:48 +000043using namespace CodeGen;
Daniel Dunbar303e2c22008-08-11 02:45:11 +000044
45namespace {
Daniel Dunbar8b8683f2008-08-12 00:12:39 +000046
Daniel Dunbar59e476b2009-08-03 17:06:42 +000047// FIXME: We should find a nicer way to make the labels for metadata, string
48// concatenation is lame.
Daniel Dunbarb036db82008-08-13 03:21:16 +000049
Fariborz Jahanian279eda62009-01-21 22:04:16 +000050class ObjCCommonTypesHelper {
Owen Anderson170229f2009-07-14 23:10:40 +000051protected:
52 llvm::LLVMContext &VMContext;
Daniel Dunbar59e476b2009-08-03 17:06:42 +000053
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000054private:
John McCall9dc0db22011-05-15 01:53:33 +000055 // The types of these functions don't really matter because we
56 // should always bitcast before calling them.
57
58 /// id objc_msgSend (id, SEL, ...)
Fangrui Song6907ce22018-07-30 19:24:48 +000059 ///
John McCall9dc0db22011-05-15 01:53:33 +000060 /// The default messenger, used for sends whose ABI is unchanged from
61 /// the all-integer/pointer case.
James Y Knight9871db02019-02-05 16:42:33 +000062 llvm::FunctionCallee getMessageSendFn() const {
John McCall31168b02011-06-15 23:02:42 +000063 // Add the non-lazy-bind attribute, since objc_msgSend is likely to
64 // be called a lot.
Chris Lattnera5f58b02011-07-09 17:41:47 +000065 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
Reid Klecknerde864822017-03-21 16:57:30 +000066 return CGM.CreateRuntimeFunction(
67 llvm::FunctionType::get(ObjectPtrTy, params, true), "objc_msgSend",
68 llvm::AttributeList::get(CGM.getLLVMContext(),
69 llvm::AttributeList::FunctionIndex,
70 llvm::Attribute::NonLazyBind));
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000071 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +000072
John McCall9dc0db22011-05-15 01:53:33 +000073 /// void objc_msgSend_stret (id, SEL, ...)
74 ///
75 /// The messenger used when the return value is an aggregate returned
76 /// by indirect reference in the first argument, and therefore the
77 /// self and selector parameters are shifted over by one.
James Y Knight9871db02019-02-05 16:42:33 +000078 llvm::FunctionCallee getMessageSendStretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +000079 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +000080 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy,
81 params, true),
82 "objc_msgSend_stret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000083 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +000084
John McCall9dc0db22011-05-15 01:53:33 +000085 /// [double | long double] objc_msgSend_fpret(id self, SEL op, ...)
86 ///
87 /// The messenger used when the return value is returned on the x87
88 /// floating-point stack; without a special entrypoint, the nil case
89 /// would be unbalanced.
James Y Knight9871db02019-02-05 16:42:33 +000090 llvm::FunctionCallee getMessageSendFpretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +000091 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
Chris Lattnerece04092012-02-07 00:39:47 +000092 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.DoubleTy,
93 params, true),
John McCall9dc0db22011-05-15 01:53:33 +000094 "objc_msgSend_fpret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +000095 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +000096
Anders Carlsson2f1a6c32011-10-31 16:27:11 +000097 /// _Complex long double objc_msgSend_fp2ret(id self, SEL op, ...)
98 ///
99 /// The messenger used when the return value is returned in two values on the
100 /// x87 floating point stack; without a special entrypoint, the nil case
101 /// would be unbalanced. Only used on 64-bit X86.
James Y Knight9871db02019-02-05 16:42:33 +0000102 llvm::FunctionCallee getMessageSendFp2retFn() const {
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000103 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
104 llvm::Type *longDoubleType = llvm::Type::getX86_FP80Ty(VMContext);
Serge Guelton1d993272017-05-09 19:31:30 +0000105 llvm::Type *resultType =
106 llvm::StructType::get(longDoubleType, longDoubleType);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000107
108 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(resultType,
109 params, true),
110 "objc_msgSend_fp2ret");
111 }
112
John McCall9dc0db22011-05-15 01:53:33 +0000113 /// id objc_msgSendSuper(struct objc_super *super, SEL op, ...)
114 ///
115 /// The messenger used for super calls, which have different dispatch
116 /// semantics. The class passed is the superclass of the current
117 /// class.
James Y Knight9871db02019-02-05 16:42:33 +0000118 llvm::FunctionCallee getMessageSendSuperFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000119 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000120 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000121 params, true),
122 "objc_msgSendSuper");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000123 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000124
John McCall9dc0db22011-05-15 01:53:33 +0000125 /// id objc_msgSendSuper2(struct objc_super *super, SEL op, ...)
126 ///
127 /// A slightly different messenger used for super calls. The class
128 /// passed is the current class.
James Y Knight9871db02019-02-05 16:42:33 +0000129 llvm::FunctionCallee getMessageSendSuperFn2() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000130 llvm::Type *params[] = { SuperPtrTy, SelectorPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000131 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000132 params, true),
133 "objc_msgSendSuper2");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000134 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000135
John McCall9dc0db22011-05-15 01:53:33 +0000136 /// void objc_msgSendSuper_stret(void *stretAddr, struct objc_super *super,
137 /// SEL op, ...)
138 ///
139 /// The messenger used for super calls which return an aggregate indirectly.
James Y Knight9871db02019-02-05 16:42:33 +0000140 llvm::FunctionCallee getMessageSendSuperStretFn() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000141 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000142 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000143 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000144 "objc_msgSendSuper_stret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000145 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000146
John McCall9dc0db22011-05-15 01:53:33 +0000147 /// void objc_msgSendSuper2_stret(void * stretAddr, struct objc_super *super,
148 /// SEL op, ...)
149 ///
150 /// objc_msgSendSuper_stret with the super2 semantics.
James Y Knight9871db02019-02-05 16:42:33 +0000151 llvm::FunctionCallee getMessageSendSuperStretFn2() const {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000152 llvm::Type *params[] = { Int8PtrTy, SuperPtrTy, SelectorPtrTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000153 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000154 llvm::FunctionType::get(CGM.VoidTy, params, true),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000155 "objc_msgSendSuper2_stret");
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000156 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000157
James Y Knight9871db02019-02-05 16:42:33 +0000158 llvm::FunctionCallee getMessageSendSuperFpretFn() const {
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000159 // There is no objc_msgSendSuper_fpret? How can that work?
160 return getMessageSendSuperFn();
161 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000162
James Y Knight9871db02019-02-05 16:42:33 +0000163 llvm::FunctionCallee getMessageSendSuperFpretFn2() const {
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000164 // There is no objc_msgSendSuper_fpret? How can that work?
165 return getMessageSendSuperFn2();
166 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000167
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000168protected:
169 CodeGen::CodeGenModule &CGM;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000170
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000171public:
John McCall176f8922016-11-30 02:39:18 +0000172 llvm::IntegerType *ShortTy, *IntTy, *LongTy;
173 llvm::PointerType *Int8PtrTy, *Int8PtrPtrTy;
Tim Northover238b5082014-03-29 13:42:40 +0000174 llvm::Type *IvarOffsetVarTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000175
Daniel Dunbar5d715592008-08-12 05:28:47 +0000176 /// ObjectPtrTy - LLVM type for object handles (typeof(id))
John McCall176f8922016-11-30 02:39:18 +0000177 llvm::PointerType *ObjectPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000178
Fariborz Jahanian406b1172008-11-18 20:18:11 +0000179 /// PtrObjectPtrTy - LLVM type for id *
John McCall176f8922016-11-30 02:39:18 +0000180 llvm::PointerType *PtrObjectPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000181
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000182 /// SelectorPtrTy - LLVM type for selector handles (typeof(SEL))
John McCall176f8922016-11-30 02:39:18 +0000183 llvm::PointerType *SelectorPtrTy;
Fangrui Song6907ce22018-07-30 19:24:48 +0000184
Douglas Gregor020de322012-01-17 18:36:30 +0000185private:
Daniel Dunbarb036db82008-08-13 03:21:16 +0000186 /// ProtocolPtrTy - LLVM type for external protocol handles
187 /// (typeof(Protocol))
Chris Lattnera5f58b02011-07-09 17:41:47 +0000188 llvm::Type *ExternalProtocolPtrTy;
Fangrui Song6907ce22018-07-30 19:24:48 +0000189
Douglas Gregor020de322012-01-17 18:36:30 +0000190public:
191 llvm::Type *getExternalProtocolPtrTy() {
192 if (!ExternalProtocolPtrTy) {
193 // FIXME: It would be nice to unify this with the opaque type, so that the
194 // IR comes out a bit cleaner.
195 CodeGen::CodeGenTypes &Types = CGM.getTypes();
196 ASTContext &Ctx = CGM.getContext();
197 llvm::Type *T = Types.ConvertType(Ctx.getObjCProtoType());
198 ExternalProtocolPtrTy = llvm::PointerType::getUnqual(T);
199 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000200
Douglas Gregor020de322012-01-17 18:36:30 +0000201 return ExternalProtocolPtrTy;
202 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000203
Daniel Dunbarc722b852008-08-30 03:02:31 +0000204 // SuperCTy - clang type for struct objc_super.
205 QualType SuperCTy;
206 // SuperPtrCTy - clang type for struct objc_super *.
207 QualType SuperPtrCTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000208
Daniel Dunbarf6397fe2008-08-23 04:28:29 +0000209 /// SuperTy - LLVM type for struct objc_super.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000210 llvm::StructType *SuperTy;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +0000211 /// SuperPtrTy - LLVM type for struct objc_super *.
John McCall176f8922016-11-30 02:39:18 +0000212 llvm::PointerType *SuperPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000213
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000214 /// PropertyTy - LLVM type for struct objc_property (struct _prop_t
215 /// in GCC parlance).
Chris Lattnera5f58b02011-07-09 17:41:47 +0000216 llvm::StructType *PropertyTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000217
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000218 /// PropertyListTy - LLVM type for struct objc_property_list
219 /// (_prop_list_t in GCC parlance).
Chris Lattnera5f58b02011-07-09 17:41:47 +0000220 llvm::StructType *PropertyListTy;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000221 /// PropertyListPtrTy - LLVM type for struct objc_property_list*.
John McCall176f8922016-11-30 02:39:18 +0000222 llvm::PointerType *PropertyListPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000223
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000224 // MethodTy - LLVM type for struct objc_method.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000225 llvm::StructType *MethodTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000226
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000227 /// CacheTy - LLVM type for struct objc_cache.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000228 llvm::Type *CacheTy;
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000229 /// CachePtrTy - LLVM type for struct objc_cache *.
John McCall176f8922016-11-30 02:39:18 +0000230 llvm::PointerType *CachePtrTy;
Fangrui Song6907ce22018-07-30 19:24:48 +0000231
James Y Knight9871db02019-02-05 16:42:33 +0000232 llvm::FunctionCallee getGetPropertyFn() {
Chris Lattnerce8754e2009-04-22 02:44:54 +0000233 CodeGen::CodeGenTypes &Types = CGM.getTypes();
234 ASTContext &Ctx = CGM.getContext();
235 // id objc_getProperty (id, SEL, ptrdiff_t, bool)
John McCall2da83a32010-02-26 00:48:12 +0000236 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
237 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Benjamin Kramer30934732016-07-02 11:41:41 +0000238 CanQualType Params[] = {
239 IdType, SelType,
240 Ctx.getPointerDiffType()->getCanonicalTypeUnqualified(), Ctx.BoolTy};
Chris Lattner2192fe52011-07-18 04:24:23 +0000241 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000242 Types.GetFunctionType(
243 Types.arrangeBuiltinFunctionDeclaration(IdType, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000244 return CGM.CreateRuntimeFunction(FTy, "objc_getProperty");
245 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000246
James Y Knight9871db02019-02-05 16:42:33 +0000247 llvm::FunctionCallee getSetPropertyFn() {
Chris Lattnerce8754e2009-04-22 02:44:54 +0000248 CodeGen::CodeGenTypes &Types = CGM.getTypes();
249 ASTContext &Ctx = CGM.getContext();
250 // void objc_setProperty (id, SEL, ptrdiff_t, id, bool, bool)
John McCall2da83a32010-02-26 00:48:12 +0000251 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
252 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
Benjamin Kramer30934732016-07-02 11:41:41 +0000253 CanQualType Params[] = {
254 IdType,
255 SelType,
256 Ctx.getPointerDiffType()->getCanonicalTypeUnqualified(),
257 IdType,
258 Ctx.BoolTy,
259 Ctx.BoolTy};
Chris Lattner2192fe52011-07-18 04:24:23 +0000260 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000261 Types.GetFunctionType(
262 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000263 return CGM.CreateRuntimeFunction(FTy, "objc_setProperty");
264 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000265
James Y Knight9871db02019-02-05 16:42:33 +0000266 llvm::FunctionCallee getOptimizedSetPropertyFn(bool atomic, bool copy) {
Ted Kremeneke65b0862012-03-06 20:05:56 +0000267 CodeGen::CodeGenTypes &Types = CGM.getTypes();
268 ASTContext &Ctx = CGM.getContext();
Fangrui Song6907ce22018-07-30 19:24:48 +0000269 // void objc_setProperty_atomic(id self, SEL _cmd,
Ted Kremeneke65b0862012-03-06 20:05:56 +0000270 // id newValue, ptrdiff_t offset);
Fangrui Song6907ce22018-07-30 19:24:48 +0000271 // void objc_setProperty_nonatomic(id self, SEL _cmd,
Ted Kremeneke65b0862012-03-06 20:05:56 +0000272 // id newValue, ptrdiff_t offset);
Fangrui Song6907ce22018-07-30 19:24:48 +0000273 // void objc_setProperty_atomic_copy(id self, SEL _cmd,
Ted Kremeneke65b0862012-03-06 20:05:56 +0000274 // id newValue, ptrdiff_t offset);
Fangrui Song6907ce22018-07-30 19:24:48 +0000275 // void objc_setProperty_nonatomic_copy(id self, SEL _cmd,
Ted Kremeneke65b0862012-03-06 20:05:56 +0000276 // id newValue, ptrdiff_t offset);
Fangrui Song6907ce22018-07-30 19:24:48 +0000277
Ted Kremeneke65b0862012-03-06 20:05:56 +0000278 SmallVector<CanQualType,4> Params;
279 CanQualType IdType = Ctx.getCanonicalParamType(Ctx.getObjCIdType());
280 CanQualType SelType = Ctx.getCanonicalParamType(Ctx.getObjCSelType());
281 Params.push_back(IdType);
282 Params.push_back(SelType);
283 Params.push_back(IdType);
284 Params.push_back(Ctx.getPointerDiffType()->getCanonicalTypeUnqualified());
285 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000286 Types.GetFunctionType(
287 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Ted Kremeneke65b0862012-03-06 20:05:56 +0000288 const char *name;
289 if (atomic && copy)
290 name = "objc_setProperty_atomic_copy";
291 else if (atomic && !copy)
292 name = "objc_setProperty_atomic";
293 else if (!atomic && copy)
294 name = "objc_setProperty_nonatomic_copy";
295 else
296 name = "objc_setProperty_nonatomic";
Fangrui Song6907ce22018-07-30 19:24:48 +0000297
Ted Kremeneke65b0862012-03-06 20:05:56 +0000298 return CGM.CreateRuntimeFunction(FTy, name);
299 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000300
James Y Knight9871db02019-02-05 16:42:33 +0000301 llvm::FunctionCallee getCopyStructFn() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000302 CodeGen::CodeGenTypes &Types = CGM.getTypes();
303 ASTContext &Ctx = CGM.getContext();
304 // void objc_copyStruct (void *, const void *, size_t, bool, bool)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000305 SmallVector<CanQualType,5> Params;
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000306 Params.push_back(Ctx.VoidPtrTy);
307 Params.push_back(Ctx.VoidPtrTy);
Saleem Abdulrasool91d9bfc2017-06-17 17:30:31 +0000308 Params.push_back(Ctx.getSizeType());
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000309 Params.push_back(Ctx.BoolTy);
310 Params.push_back(Ctx.BoolTy);
Chris Lattner2192fe52011-07-18 04:24:23 +0000311 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000312 Types.GetFunctionType(
313 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +0000314 return CGM.CreateRuntimeFunction(FTy, "objc_copyStruct");
315 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000316
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000317 /// This routine declares and returns address of:
318 /// void objc_copyCppObjectAtomic(
Fangrui Song6907ce22018-07-30 19:24:48 +0000319 /// void *dest, const void *src,
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000320 /// void (*copyHelper) (void *dest, const void *source));
James Y Knight9871db02019-02-05 16:42:33 +0000321 llvm::FunctionCallee getCppAtomicObjectFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000322 CodeGen::CodeGenTypes &Types = CGM.getTypes();
323 ASTContext &Ctx = CGM.getContext();
324 /// void objc_copyCppObjectAtomic(void *dest, const void *src, void *helper);
325 SmallVector<CanQualType,3> Params;
326 Params.push_back(Ctx.VoidPtrTy);
327 Params.push_back(Ctx.VoidPtrTy);
328 Params.push_back(Ctx.VoidPtrTy);
329 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000330 Types.GetFunctionType(
331 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +0000332 return CGM.CreateRuntimeFunction(FTy, "objc_copyCppObjectAtomic");
333 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000334
James Y Knight9871db02019-02-05 16:42:33 +0000335 llvm::FunctionCallee getEnumerationMutationFn() {
Daniel Dunbar9d82da42009-07-11 20:32:50 +0000336 CodeGen::CodeGenTypes &Types = CGM.getTypes();
337 ASTContext &Ctx = CGM.getContext();
Chris Lattnerce8754e2009-04-22 02:44:54 +0000338 // void objc_enumerationMutation (id)
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000339 SmallVector<CanQualType,1> Params;
John McCall2da83a32010-02-26 00:48:12 +0000340 Params.push_back(Ctx.getCanonicalParamType(Ctx.getObjCIdType()));
Chris Lattner2192fe52011-07-18 04:24:23 +0000341 llvm::FunctionType *FTy =
John McCallc56a8b32016-03-11 04:30:31 +0000342 Types.GetFunctionType(
343 Types.arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Params));
Chris Lattnerce8754e2009-04-22 02:44:54 +0000344 return CGM.CreateRuntimeFunction(FTy, "objc_enumerationMutation");
345 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000346
James Y Knight9871db02019-02-05 16:42:33 +0000347 llvm::FunctionCallee getLookUpClassFn() {
Douglas Gregor24ae22c2016-04-01 23:23:52 +0000348 CodeGen::CodeGenTypes &Types = CGM.getTypes();
349 ASTContext &Ctx = CGM.getContext();
350 // Class objc_lookUpClass (const char *)
351 SmallVector<CanQualType,1> Params;
352 Params.push_back(
353 Ctx.getCanonicalType(Ctx.getPointerType(Ctx.CharTy.withConst())));
354 llvm::FunctionType *FTy =
355 Types.GetFunctionType(Types.arrangeBuiltinFunctionDeclaration(
356 Ctx.getCanonicalType(Ctx.getObjCClassType()),
357 Params));
358 return CGM.CreateRuntimeFunction(FTy, "objc_lookUpClass");
359 }
360
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000361 /// GcReadWeakFn -- LLVM objc_read_weak (id *src) function.
James Y Knight9871db02019-02-05 16:42:33 +0000362 llvm::FunctionCallee getGcReadWeakFn() {
Chris Lattnerce8754e2009-04-22 02:44:54 +0000363 // id objc_read_weak (id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000364 llvm::Type *args[] = { ObjectPtrTy->getPointerTo() };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000365 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000366 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattnerce8754e2009-04-22 02:44:54 +0000367 return CGM.CreateRuntimeFunction(FTy, "objc_read_weak");
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000368 }
369
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000370 /// GcAssignWeakFn -- LLVM objc_assign_weak function.
James Y Knight9871db02019-02-05 16:42:33 +0000371 llvm::FunctionCallee getGcAssignWeakFn() {
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000372 // id objc_assign_weak (id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000373 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000374 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000375 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner6fdd57c2009-04-17 22:12:36 +0000376 return CGM.CreateRuntimeFunction(FTy, "objc_assign_weak");
377 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000378
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000379 /// GcAssignGlobalFn -- LLVM objc_assign_global function.
James Y Knight9871db02019-02-05 16:42:33 +0000380 llvm::FunctionCallee getGcAssignGlobalFn() {
Chris Lattner0a696a422009-04-22 02:38:11 +0000381 // id objc_assign_global(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000382 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000383 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000384 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000385 return CGM.CreateRuntimeFunction(FTy, "objc_assign_global");
386 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000387
Fariborz Jahanian217af242010-07-20 20:30:03 +0000388 /// GcAssignThreadLocalFn -- LLVM objc_assign_threadlocal function.
James Y Knight9871db02019-02-05 16:42:33 +0000389 llvm::FunctionCallee getGcAssignThreadLocalFn() {
Fariborz Jahanian217af242010-07-20 20:30:03 +0000390 // id objc_assign_threadlocal(id src, id * dest)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000391 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Fariborz Jahanian217af242010-07-20 20:30:03 +0000392 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000393 llvm::FunctionType::get(ObjectPtrTy, args, false);
Fariborz Jahanian217af242010-07-20 20:30:03 +0000394 return CGM.CreateRuntimeFunction(FTy, "objc_assign_threadlocal");
395 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000396
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000397 /// GcAssignIvarFn -- LLVM objc_assign_ivar function.
James Y Knight9871db02019-02-05 16:42:33 +0000398 llvm::FunctionCallee getGcAssignIvarFn() {
Fariborz Jahanian7a95d722009-09-24 22:25:38 +0000399 // id objc_assign_ivar(id, id *, ptrdiff_t)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000400 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo(),
401 CGM.PtrDiffTy };
Owen Anderson170229f2009-07-14 23:10:40 +0000402 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000403 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000404 return CGM.CreateRuntimeFunction(FTy, "objc_assign_ivar");
405 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000406
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000407 /// GcMemmoveCollectableFn -- LLVM objc_memmove_collectable function.
James Y Knight9871db02019-02-05 16:42:33 +0000408 llvm::FunctionCallee GcMemmoveCollectableFn() {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000409 // void *objc_memmove_collectable(void *dst, const void *src, size_t size)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000410 llvm::Type *args[] = { Int8PtrTy, Int8PtrTy, LongTy };
John McCall9dc0db22011-05-15 01:53:33 +0000411 llvm::FunctionType *FTy = llvm::FunctionType::get(Int8PtrTy, args, false);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +0000412 return CGM.CreateRuntimeFunction(FTy, "objc_memmove_collectable");
413 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000414
Fariborz Jahanianeee54df2009-01-22 00:37:21 +0000415 /// GcAssignStrongCastFn -- LLVM objc_assign_strongCast function.
James Y Knight9871db02019-02-05 16:42:33 +0000416 llvm::FunctionCallee getGcAssignStrongCastFn() {
Fariborz Jahanian217af242010-07-20 20:30:03 +0000417 // id objc_assign_strongCast(id, id *)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000418 llvm::Type *args[] = { ObjectPtrTy, ObjectPtrTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000419 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000420 llvm::FunctionType::get(ObjectPtrTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000421 return CGM.CreateRuntimeFunction(FTy, "objc_assign_strongCast");
422 }
Anders Carlsson9ab53d12009-02-16 22:59:18 +0000423
424 /// ExceptionThrowFn - LLVM objc_exception_throw function.
James Y Knight9871db02019-02-05 16:42:33 +0000425 llvm::FunctionCallee getExceptionThrowFn() {
Chris Lattner0a696a422009-04-22 02:38:11 +0000426 // void objc_exception_throw(id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000427 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000428 llvm::FunctionType *FTy =
John McCall9dc0db22011-05-15 01:53:33 +0000429 llvm::FunctionType::get(CGM.VoidTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000430 return CGM.CreateRuntimeFunction(FTy, "objc_exception_throw");
431 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000432
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000433 /// ExceptionRethrowFn - LLVM objc_exception_rethrow function.
James Y Knight9871db02019-02-05 16:42:33 +0000434 llvm::FunctionCallee getExceptionRethrowFn() {
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000435 // void objc_exception_rethrow(void)
John McCall9dc0db22011-05-15 01:53:33 +0000436 llvm::FunctionType *FTy = llvm::FunctionType::get(CGM.VoidTy, false);
Fariborz Jahanian3336de12010-05-28 17:34:43 +0000437 return CGM.CreateRuntimeFunction(FTy, "objc_exception_rethrow");
438 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000439
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000440 /// SyncEnterFn - LLVM object_sync_enter function.
James Y Knight9871db02019-02-05 16:42:33 +0000441 llvm::FunctionCallee getSyncEnterFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000442 // int objc_sync_enter (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000443 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattnerdcceee72009-04-06 16:53:45 +0000444 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000445 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattnerdcceee72009-04-06 16:53:45 +0000446 return CGM.CreateRuntimeFunction(FTy, "objc_sync_enter");
447 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000448
Daniel Dunbar94ceb612009-02-24 01:43:46 +0000449 /// SyncExitFn - LLVM object_sync_exit function.
James Y Knight9871db02019-02-05 16:42:33 +0000450 llvm::FunctionCallee getSyncExitFn() {
Aaron Ballman9c004462012-09-06 16:44:16 +0000451 // int objc_sync_exit (id)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000452 llvm::Type *args[] = { ObjectPtrTy };
Chris Lattner0a696a422009-04-22 02:38:11 +0000453 llvm::FunctionType *FTy =
Aaron Ballman9c004462012-09-06 16:44:16 +0000454 llvm::FunctionType::get(CGM.IntTy, args, false);
Chris Lattner0a696a422009-04-22 02:38:11 +0000455 return CGM.CreateRuntimeFunction(FTy, "objc_sync_exit");
456 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000457
James Y Knight9871db02019-02-05 16:42:33 +0000458 llvm::FunctionCallee getSendFn(bool IsSuper) const {
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000459 return IsSuper ? getMessageSendSuperFn() : getMessageSendFn();
460 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000461
James Y Knight9871db02019-02-05 16:42:33 +0000462 llvm::FunctionCallee getSendFn2(bool IsSuper) const {
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000463 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFn();
464 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000465
James Y Knight9871db02019-02-05 16:42:33 +0000466 llvm::FunctionCallee getSendStretFn(bool IsSuper) const {
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000467 return IsSuper ? getMessageSendSuperStretFn() : getMessageSendStretFn();
468 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000469
James Y Knight9871db02019-02-05 16:42:33 +0000470 llvm::FunctionCallee getSendStretFn2(bool IsSuper) const {
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000471 return IsSuper ? getMessageSendSuperStretFn2() : getMessageSendStretFn();
472 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000473
James Y Knight9871db02019-02-05 16:42:33 +0000474 llvm::FunctionCallee getSendFpretFn(bool IsSuper) const {
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000475 return IsSuper ? getMessageSendSuperFpretFn() : getMessageSendFpretFn();
476 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000477
James Y Knight9871db02019-02-05 16:42:33 +0000478 llvm::FunctionCallee getSendFpretFn2(bool IsSuper) const {
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +0000479 return IsSuper ? getMessageSendSuperFpretFn2() : getMessageSendFpretFn();
480 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000481
James Y Knight9871db02019-02-05 16:42:33 +0000482 llvm::FunctionCallee getSendFp2retFn(bool IsSuper) const {
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000483 return IsSuper ? getMessageSendSuperFn() : getMessageSendFp2retFn();
484 }
485
James Y Knight9871db02019-02-05 16:42:33 +0000486 llvm::FunctionCallee getSendFp2RetFn2(bool IsSuper) const {
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000487 return IsSuper ? getMessageSendSuperFn2() : getMessageSendFp2retFn();
488 }
489
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000490 ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000491};
Daniel Dunbarf6397fe2008-08-23 04:28:29 +0000492
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000493/// ObjCTypesHelper - Helper class that encapsulates lazy
494/// construction of varies types used during ObjC generation.
495class ObjCTypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000496public:
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000497 /// SymtabTy - LLVM type for struct objc_symtab.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000498 llvm::StructType *SymtabTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000499 /// SymtabPtrTy - LLVM type for struct objc_symtab *.
John McCall176f8922016-11-30 02:39:18 +0000500 llvm::PointerType *SymtabPtrTy;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000501 /// ModuleTy - LLVM type for struct objc_module.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000502 llvm::StructType *ModuleTy;
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000503
Daniel Dunbarb036db82008-08-13 03:21:16 +0000504 /// ProtocolTy - LLVM type for struct objc_protocol.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000505 llvm::StructType *ProtocolTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000506 /// ProtocolPtrTy - LLVM type for struct objc_protocol *.
John McCall176f8922016-11-30 02:39:18 +0000507 llvm::PointerType *ProtocolPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000508 /// ProtocolExtensionTy - LLVM type for struct
509 /// objc_protocol_extension.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000510 llvm::StructType *ProtocolExtensionTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000511 /// ProtocolExtensionTy - LLVM type for struct
512 /// objc_protocol_extension *.
John McCall176f8922016-11-30 02:39:18 +0000513 llvm::PointerType *ProtocolExtensionPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000514 /// MethodDescriptionTy - LLVM type for struct
515 /// objc_method_description.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000516 llvm::StructType *MethodDescriptionTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000517 /// MethodDescriptionListTy - LLVM type for struct
518 /// objc_method_description_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000519 llvm::StructType *MethodDescriptionListTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000520 /// MethodDescriptionListPtrTy - LLVM type for struct
521 /// objc_method_description_list *.
John McCall176f8922016-11-30 02:39:18 +0000522 llvm::PointerType *MethodDescriptionListPtrTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000523 /// ProtocolListTy - LLVM type for struct objc_property_list.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000524 llvm::StructType *ProtocolListTy;
Daniel Dunbarb036db82008-08-13 03:21:16 +0000525 /// ProtocolListPtrTy - LLVM type for struct objc_property_list*.
John McCall176f8922016-11-30 02:39:18 +0000526 llvm::PointerType *ProtocolListPtrTy;
Daniel Dunbar938a77f2008-08-22 20:34:54 +0000527 /// CategoryTy - LLVM type for struct objc_category.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000528 llvm::StructType *CategoryTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000529 /// ClassTy - LLVM type for struct objc_class.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000530 llvm::StructType *ClassTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000531 /// ClassPtrTy - LLVM type for struct objc_class *.
John McCall176f8922016-11-30 02:39:18 +0000532 llvm::PointerType *ClassPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000533 /// ClassExtensionTy - LLVM type for struct objc_class_ext.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000534 llvm::StructType *ClassExtensionTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000535 /// ClassExtensionPtrTy - LLVM type for struct objc_class_ext *.
John McCall176f8922016-11-30 02:39:18 +0000536 llvm::PointerType *ClassExtensionPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000537 // IvarTy - LLVM type for struct objc_ivar.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000538 llvm::StructType *IvarTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000539 /// IvarListTy - LLVM type for struct objc_ivar_list.
John McCall176f8922016-11-30 02:39:18 +0000540 llvm::StructType *IvarListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000541 /// IvarListPtrTy - LLVM type for struct objc_ivar_list *.
John McCall176f8922016-11-30 02:39:18 +0000542 llvm::PointerType *IvarListPtrTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000543 /// MethodListTy - LLVM type for struct objc_method_list.
John McCall176f8922016-11-30 02:39:18 +0000544 llvm::StructType *MethodListTy;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000545 /// MethodListPtrTy - LLVM type for struct objc_method_list *.
John McCall176f8922016-11-30 02:39:18 +0000546 llvm::PointerType *MethodListPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000547
Anders Carlsson9ff22482008-09-09 10:10:21 +0000548 /// ExceptionDataTy - LLVM type for struct _objc_exception_data.
John McCall176f8922016-11-30 02:39:18 +0000549 llvm::StructType *ExceptionDataTy;
Fangrui Song6907ce22018-07-30 19:24:48 +0000550
Anders Carlsson9ff22482008-09-09 10:10:21 +0000551 /// ExceptionTryEnterFn - LLVM objc_exception_try_enter function.
James Y Knight9871db02019-02-05 16:42:33 +0000552 llvm::FunctionCallee getExceptionTryEnterFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000553 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000554 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000555 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000556 "objc_exception_try_enter");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000557 }
Anders Carlsson9ff22482008-09-09 10:10:21 +0000558
559 /// ExceptionTryExitFn - LLVM objc_exception_try_exit function.
James Y Knight9871db02019-02-05 16:42:33 +0000560 llvm::FunctionCallee getExceptionTryExitFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000561 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson170229f2009-07-14 23:10:40 +0000562 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000563 llvm::FunctionType::get(CGM.VoidTy, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000564 "objc_exception_try_exit");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000565 }
Anders Carlsson9ff22482008-09-09 10:10:21 +0000566
567 /// ExceptionExtractFn - LLVM objc_exception_extract function.
James Y Knight9871db02019-02-05 16:42:33 +0000568 llvm::FunctionCallee getExceptionExtractFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000569 llvm::Type *params[] = { ExceptionDataTy->getPointerTo() };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000570 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000571 params, false),
Chris Lattnerc6406db2009-04-22 02:26:14 +0000572 "objc_exception_extract");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000573 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000574
Anders Carlsson9ff22482008-09-09 10:10:21 +0000575 /// ExceptionMatchFn - LLVM objc_exception_match function.
James Y Knight9871db02019-02-05 16:42:33 +0000576 llvm::FunctionCallee getExceptionMatchFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000577 llvm::Type *params[] = { ClassPtrTy, ObjectPtrTy };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000578 return CGM.CreateRuntimeFunction(
John McCall9dc0db22011-05-15 01:53:33 +0000579 llvm::FunctionType::get(CGM.Int32Ty, params, false),
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000580 "objc_exception_match");
Chris Lattnerc6406db2009-04-22 02:26:14 +0000581 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000582
Anders Carlsson9ff22482008-09-09 10:10:21 +0000583 /// SetJmpFn - LLVM _setjmp function.
James Y Knight9871db02019-02-05 16:42:33 +0000584 llvm::FunctionCallee getSetJmpFn() {
John McCall9dc0db22011-05-15 01:53:33 +0000585 // This is specifically the prototype for x86.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000586 llvm::Type *params[] = { CGM.Int32Ty->getPointerTo() };
Reid Klecknerde864822017-03-21 16:57:30 +0000587 return CGM.CreateRuntimeFunction(
588 llvm::FunctionType::get(CGM.Int32Ty, params, false), "_setjmp",
589 llvm::AttributeList::get(CGM.getLLVMContext(),
590 llvm::AttributeList::FunctionIndex,
591 llvm::Attribute::NonLazyBind));
Chris Lattnerc6406db2009-04-22 02:26:14 +0000592 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000593
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000594public:
595 ObjCTypesHelper(CodeGen::CodeGenModule &cgm);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000596};
597
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000598/// ObjCNonFragileABITypesHelper - will have all types needed by objective-c's
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000599/// modern abi
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000600class ObjCNonFragileABITypesHelper : public ObjCCommonTypesHelper {
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000601public:
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000602 // MethodListnfABITy - LLVM for struct _method_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000603 llvm::StructType *MethodListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000604
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000605 // MethodListnfABIPtrTy - LLVM for struct _method_list_t*
John McCall176f8922016-11-30 02:39:18 +0000606 llvm::PointerType *MethodListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000607
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000608 // ProtocolnfABITy = LLVM for struct _protocol_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000609 llvm::StructType *ProtocolnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000610
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000611 // ProtocolnfABIPtrTy = LLVM for struct _protocol_t*
John McCall176f8922016-11-30 02:39:18 +0000612 llvm::PointerType *ProtocolnfABIPtrTy;
Daniel Dunbar8de90f02009-02-15 07:36:20 +0000613
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000614 // ProtocolListnfABITy - LLVM for struct _objc_protocol_list
Chris Lattnera5f58b02011-07-09 17:41:47 +0000615 llvm::StructType *ProtocolListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000616
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000617 // ProtocolListnfABIPtrTy - LLVM for struct _objc_protocol_list*
John McCall176f8922016-11-30 02:39:18 +0000618 llvm::PointerType *ProtocolListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000619
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000620 // ClassnfABITy - LLVM for struct _class_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000621 llvm::StructType *ClassnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000622
Fariborz Jahanian71394042009-01-23 23:53:38 +0000623 // ClassnfABIPtrTy - LLVM for struct _class_t*
John McCall176f8922016-11-30 02:39:18 +0000624 llvm::PointerType *ClassnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000625
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000626 // IvarnfABITy - LLVM for struct _ivar_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000627 llvm::StructType *IvarnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000628
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000629 // IvarListnfABITy - LLVM for struct _ivar_list_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000630 llvm::StructType *IvarListnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000631
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000632 // IvarListnfABIPtrTy = LLVM for struct _ivar_list_t*
John McCall176f8922016-11-30 02:39:18 +0000633 llvm::PointerType *IvarListnfABIPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000634
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000635 // ClassRonfABITy - LLVM for struct _class_ro_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000636 llvm::StructType *ClassRonfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000637
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000638 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
John McCall176f8922016-11-30 02:39:18 +0000639 llvm::PointerType *ImpnfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000640
Fariborz Jahanian0232c052009-01-23 01:46:23 +0000641 // CategorynfABITy - LLVM for struct _category_t
Chris Lattnera5f58b02011-07-09 17:41:47 +0000642 llvm::StructType *CategorynfABITy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000643
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000644 // New types for nonfragile abi messaging.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000645
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000646 // MessageRefTy - LLVM for:
647 // struct _message_ref_t {
648 // IMP messenger;
649 // SEL name;
650 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000651 llvm::StructType *MessageRefTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000652 // MessageRefCTy - clang type for struct _message_ref_t
653 QualType MessageRefCTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000654
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000655 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Chris Lattnera5f58b02011-07-09 17:41:47 +0000656 llvm::Type *MessageRefPtrTy;
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +0000657 // MessageRefCPtrTy - clang type for struct _message_ref_t*
658 QualType MessageRefCPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000659
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000660 // SuperMessageRefTy - LLVM for:
661 // struct _super_message_ref_t {
662 // SUPER_IMP messenger;
663 // SEL name;
664 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +0000665 llvm::StructType *SuperMessageRefTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000666
Fariborz Jahanian82c72e12009-02-03 23:49:23 +0000667 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
John McCall176f8922016-11-30 02:39:18 +0000668 llvm::PointerType *SuperMessageRefPtrTy;
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +0000669
James Y Knight9871db02019-02-05 16:42:33 +0000670 llvm::FunctionCallee getMessageSendFixupFn() {
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000671 // id objc_msgSend_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000672 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000673 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000674 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000675 "objc_msgSend_fixup");
676 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000677
James Y Knight9871db02019-02-05 16:42:33 +0000678 llvm::FunctionCallee getMessageSendFpretFixupFn() {
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000679 // id objc_msgSend_fpret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000680 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000681 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000682 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000683 "objc_msgSend_fpret_fixup");
684 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000685
James Y Knight9871db02019-02-05 16:42:33 +0000686 llvm::FunctionCallee getMessageSendStretFixupFn() {
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000687 // id objc_msgSend_stret_fixup(id, struct message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000688 llvm::Type *params[] = { ObjectPtrTy, MessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000689 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000690 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000691 "objc_msgSend_stret_fixup");
692 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000693
James Y Knight9871db02019-02-05 16:42:33 +0000694 llvm::FunctionCallee getMessageSendSuper2FixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000695 // id objc_msgSendSuper2_fixup (struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000696 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000697 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000698 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000699 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000700 "objc_msgSendSuper2_fixup");
701 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000702
James Y Knight9871db02019-02-05 16:42:33 +0000703 llvm::FunctionCallee getMessageSendSuper2StretFixupFn() {
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000704 // id objc_msgSendSuper2_stret_fixup(struct objc_super *,
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000705 // struct _super_message_ref_t*, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +0000706 llvm::Type *params[] = { SuperPtrTy, SuperMessageRefPtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000707 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(ObjectPtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000708 params, true),
Chris Lattner2dfdb3e2009-04-22 02:53:24 +0000709 "objc_msgSendSuper2_stret_fixup");
710 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000711
James Y Knight9871db02019-02-05 16:42:33 +0000712 llvm::FunctionCallee getObjCEndCatchFn() {
John McCall9dc0db22011-05-15 01:53:33 +0000713 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(CGM.VoidTy, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000714 "objc_end_catch");
Chris Lattnera7c00b42009-04-22 02:15:23 +0000715 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000716
James Y Knight9871db02019-02-05 16:42:33 +0000717 llvm::FunctionCallee getObjCBeginCatchFn() {
Chris Lattnera5f58b02011-07-09 17:41:47 +0000718 llvm::Type *params[] = { Int8PtrTy };
Owen Anderson9793f0e2009-07-29 22:16:19 +0000719 return CGM.CreateRuntimeFunction(llvm::FunctionType::get(Int8PtrTy,
John McCall9dc0db22011-05-15 01:53:33 +0000720 params, false),
Chris Lattnera7c00b42009-04-22 02:15:23 +0000721 "objc_begin_catch");
722 }
Daniel Dunbarb1559a42009-03-01 04:46:24 +0000723
Chris Lattnera5f58b02011-07-09 17:41:47 +0000724 llvm::StructType *EHTypeTy;
725 llvm::Type *EHTypePtrTy;
Fangrui Song6907ce22018-07-30 19:24:48 +0000726
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +0000727 ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm);
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000728};
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000729
Saleem Abdulrasool271106c2016-09-16 23:41:13 +0000730enum class ObjCLabelType {
731 ClassName,
732 MethodVarName,
733 MethodVarType,
734 PropertyName,
735};
736
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000737class CGObjCCommonMac : public CodeGen::CGObjCRuntime {
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000738public:
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000739 class SKIP_SCAN {
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000740 public:
741 unsigned skip;
742 unsigned scan;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000743 SKIP_SCAN(unsigned _skip = 0, unsigned _scan = 0)
Daniel Dunbar7b89ace2009-05-03 13:44:42 +0000744 : skip(_skip), scan(_scan) {}
Fariborz Jahaniancbaf73c2009-03-11 20:59:05 +0000745 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000746
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000747 /// opcode for captured block variables layout 'instructions'.
748 /// In the following descriptions, 'I' is the value of the immediate field.
749 /// (field following the opcode).
750 ///
751 enum BLOCK_LAYOUT_OPCODE {
752 /// An operator which affects how the following layout should be
753 /// interpreted.
754 /// I == 0: Halt interpretation and treat everything else as
755 /// a non-pointer. Note that this instruction is equal
756 /// to '\0'.
757 /// I != 0: Currently unused.
758 BLOCK_LAYOUT_OPERATOR = 0,
Fangrui Song6907ce22018-07-30 19:24:48 +0000759
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000760 /// The next I+1 bytes do not contain a value of object pointer type.
761 /// Note that this can leave the stream unaligned, meaning that
762 /// subsequent word-size instructions do not begin at a multiple of
763 /// the pointer size.
764 BLOCK_LAYOUT_NON_OBJECT_BYTES = 1,
Fangrui Song6907ce22018-07-30 19:24:48 +0000765
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000766 /// The next I+1 words do not contain a value of object pointer type.
767 /// This is simply an optimized version of BLOCK_LAYOUT_BYTES for
768 /// when the required skip quantity is a multiple of the pointer size.
769 BLOCK_LAYOUT_NON_OBJECT_WORDS = 2,
Fangrui Song6907ce22018-07-30 19:24:48 +0000770
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000771 /// The next I+1 words are __strong pointers to Objective-C
772 /// objects or blocks.
773 BLOCK_LAYOUT_STRONG = 3,
Fangrui Song6907ce22018-07-30 19:24:48 +0000774
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000775 /// The next I+1 words are pointers to __block variables.
776 BLOCK_LAYOUT_BYREF = 4,
Fangrui Song6907ce22018-07-30 19:24:48 +0000777
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000778 /// The next I+1 words are __weak pointers to Objective-C
779 /// objects or blocks.
780 BLOCK_LAYOUT_WEAK = 5,
Fangrui Song6907ce22018-07-30 19:24:48 +0000781
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000782 /// The next I+1 words are __unsafe_unretained pointers to
783 /// Objective-C objects or blocks.
784 BLOCK_LAYOUT_UNRETAINED = 6
Fangrui Song6907ce22018-07-30 19:24:48 +0000785
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000786 /// The next I+1 words are block or object pointers with some
787 /// as-yet-unspecified ownership semantics. If we add more
788 /// flavors of ownership semantics, values will be taken from
789 /// this range.
790 ///
791 /// This is included so that older tools can at least continue
792 /// processing the layout past such things.
793 //BLOCK_LAYOUT_OWNERSHIP_UNKNOWN = 7..10,
Fangrui Song6907ce22018-07-30 19:24:48 +0000794
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000795 /// All other opcodes are reserved. Halt interpretation and
796 /// treat everything else as opaque.
797 };
Fangrui Song6907ce22018-07-30 19:24:48 +0000798
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000799 class RUN_SKIP {
800 public:
801 enum BLOCK_LAYOUT_OPCODE opcode;
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000802 CharUnits block_var_bytepos;
803 CharUnits block_var_size;
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000804 RUN_SKIP(enum BLOCK_LAYOUT_OPCODE Opcode = BLOCK_LAYOUT_OPERATOR,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000805 CharUnits BytePos = CharUnits::Zero(),
806 CharUnits Size = CharUnits::Zero())
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +0000807 : opcode(Opcode), block_var_bytepos(BytePos), block_var_size(Size) {}
Fangrui Song6907ce22018-07-30 19:24:48 +0000808
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000809 // Allow sorting based on byte pos.
810 bool operator<(const RUN_SKIP &b) const {
811 return block_var_bytepos < b.block_var_bytepos;
812 }
813 };
Fangrui Song6907ce22018-07-30 19:24:48 +0000814
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000815protected:
Owen Andersonae86c192009-07-13 04:10:07 +0000816 llvm::LLVMContext &VMContext;
Fariborz Jahanian279eda62009-01-21 22:04:16 +0000817 // FIXME! May not be needing this after all.
Daniel Dunbar8b8683f2008-08-12 00:12:39 +0000818 unsigned ObjCABI;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000819
Fariborz Jahanian196f9382012-10-25 21:15:04 +0000820 // arc/mrr layout of captured block literal variables.
821 SmallVector<RUN_SKIP, 16> RunSkipBlockVars;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000822
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000823 /// LazySymbols - Symbols to generate a lazy reference for. See
824 /// DefinedSymbols and FinishModule().
Daniel Dunbard027a922009-09-07 00:20:42 +0000825 llvm::SetVector<IdentifierInfo*> LazySymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000826
Daniel Dunbarc61d0e92008-08-25 06:02:07 +0000827 /// DefinedSymbols - External symbols which are defined by this
828 /// module. The symbols in this list and LazySymbols are used to add
829 /// special linker symbols which ensure that Objective-C modules are
830 /// linked properly.
Daniel Dunbard027a922009-09-07 00:20:42 +0000831 llvm::SetVector<IdentifierInfo*> DefinedSymbols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000832
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +0000833 /// ClassNames - uniqued class names.
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000834 llvm::StringMap<llvm::GlobalVariable*> ClassNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000835
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000836 /// MethodVarNames - uniqued method variable names.
837 llvm::DenseMap<Selector, llvm::GlobalVariable*> MethodVarNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000838
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000839 /// DefinedCategoryNames - list of category names in form Class_Category.
Justin Lebar5e83dfe2016-10-21 21:45:01 +0000840 llvm::SmallSetVector<llvm::CachedHashString, 16> DefinedCategoryNames;
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +0000841
Daniel Dunbarb036db82008-08-13 03:21:16 +0000842 /// MethodVarTypes - uniqued method type signatures. We have to use
843 /// a StringMap here because have no other unique reference.
844 llvm::StringMap<llvm::GlobalVariable*> MethodVarTypes;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000845
Daniel Dunbar3c76cb52008-08-26 21:51:14 +0000846 /// MethodDefinitions - map of methods which have been defined in
847 /// this translation unit.
848 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*> MethodDefinitions;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000849
Daniel Dunbar80a840b2008-08-23 00:19:03 +0000850 /// PropertyNames - uniqued method variable names.
851 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> PropertyNames;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000852
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000853 /// ClassReferences - uniqued class references.
854 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> ClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000855
Daniel Dunbarcb515c82008-08-12 03:39:23 +0000856 /// SelectorReferences - uniqued selector references.
857 llvm::DenseMap<Selector, llvm::GlobalVariable*> SelectorReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000858
Daniel Dunbarb036db82008-08-13 03:21:16 +0000859 /// Protocols - Protocols for which an objc_protocol structure has
860 /// been emitted. Forward declarations are handled by creating an
861 /// empty structure whose initializer is filled in when/if defined.
862 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> Protocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000863
Daniel Dunbarc475d422008-10-29 22:36:39 +0000864 /// DefinedProtocols - Protocols which have actually been
865 /// defined. We should not need this, see FIXME in GenerateProtocol.
866 llvm::DenseSet<IdentifierInfo*> DefinedProtocols;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000867
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000868 /// DefinedClasses - List of defined classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000869 SmallVector<llvm::GlobalValue*, 16> DefinedClasses;
Fangrui Song6907ce22018-07-30 19:24:48 +0000870
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +0000871 /// ImplementedClasses - List of @implemented classes.
872 SmallVector<const ObjCInterfaceDecl*, 16> ImplementedClasses;
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000873
874 /// DefinedNonLazyClasses - List of defined "non-lazy" classes.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000875 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyClasses;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000876
Daniel Dunbar22d82ed2008-08-21 04:36:09 +0000877 /// DefinedCategories - List of defined categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000878 SmallVector<llvm::GlobalValue*, 16> DefinedCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000879
Daniel Dunbar9a017d72009-05-15 22:33:15 +0000880 /// DefinedNonLazyCategories - List of defined "non-lazy" categories.
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000881 SmallVector<llvm::GlobalValue*, 16> DefinedNonLazyCategories;
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000882
John McCallcd21d542016-11-30 23:15:55 +0000883 /// Cached reference to the class for constant strings. This value has type
884 /// int * but is actually an Obj-C class pointer.
Sanjoy Dase369bd92017-05-01 17:08:00 +0000885 llvm::WeakTrackingVH ConstantStringClassRef;
John McCallcd21d542016-11-30 23:15:55 +0000886
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000887 /// The LLVM type corresponding to NSConstantString.
John McCallcd21d542016-11-30 23:15:55 +0000888 llvm::StructType *NSConstantStringType = nullptr;
889
890 llvm::StringMap<llvm::GlobalVariable *> NSConstantStringMap;
891
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000892 /// GetNameForMethod - Return a name for the given method.
893 /// \param[out] NameOut - The return value.
894 void GetNameForMethod(const ObjCMethodDecl *OMD,
895 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000896 SmallVectorImpl<char> &NameOut);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000897
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000898 /// GetMethodVarName - Return a unique constant for the given
899 /// selector's name. The return value has type char *.
900 llvm::Constant *GetMethodVarName(Selector Sel);
901 llvm::Constant *GetMethodVarName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000902
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000903 /// GetMethodVarType - Return a unique constant for the given
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000904 /// method's type encoding string. The return value has type char *.
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000905
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000906 // FIXME: This is a horrible name.
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000907 llvm::Constant *GetMethodVarType(const ObjCMethodDecl *D,
908 bool Extended = false);
Daniel Dunbarf5c18462009-04-20 06:54:31 +0000909 llvm::Constant *GetMethodVarType(const FieldDecl *D);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000910
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000911 /// GetPropertyName - Return a unique constant for the given
912 /// name. The return value has type char *.
913 llvm::Constant *GetPropertyName(IdentifierInfo *Ident);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000914
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +0000915 // FIXME: This can be dropped once string functions are unified.
916 llvm::Constant *GetPropertyTypeString(const ObjCPropertyDecl *PD,
917 const Decl *Container);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000918
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +0000919 /// GetClassName - Return a unique constant for the given selector's
Fariborz Jahanian451b92a2014-07-16 16:16:04 +0000920 /// runtime name (which may change via use of objc_runtime_name attribute on
921 /// class or protocol definition. The return value has type char *.
922 llvm::Constant *GetClassName(StringRef RuntimeName);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000923
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +0000924 llvm::Function *GetMethodDefinition(const ObjCMethodDecl *MD);
925
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +0000926 /// BuildIvarLayout - Builds ivar layout bitmap for the class
927 /// implementation for the __strong or __weak case.
928 ///
John McCall460ce582015-10-22 18:38:17 +0000929 /// \param hasMRCWeakIvars - Whether we are compiling in MRC and there
930 /// are any weak ivars defined directly in the class. Meaningless unless
931 /// building a weak layout. Does not guarantee that the layout will
932 /// actually have any entries, because the ivar might be under-aligned.
Fariborz Jahanian1bf72882009-03-12 22:50:49 +0000933 llvm::Constant *BuildIvarLayout(const ObjCImplementationDecl *OI,
John McCall3fd13f062015-10-21 18:06:47 +0000934 CharUnits beginOffset,
935 CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +0000936 bool forStrongLayout,
937 bool hasMRCWeakIvars);
938
939 llvm::Constant *BuildStrongIvarLayout(const ObjCImplementationDecl *OI,
940 CharUnits beginOffset,
941 CharUnits endOffset) {
942 return BuildIvarLayout(OI, beginOffset, endOffset, true, false);
943 }
944
945 llvm::Constant *BuildWeakIvarLayout(const ObjCImplementationDecl *OI,
946 CharUnits beginOffset,
947 CharUnits endOffset,
948 bool hasMRCWeakIvars) {
949 return BuildIvarLayout(OI, beginOffset, endOffset, false, hasMRCWeakIvars);
950 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000951
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000952 Qualifiers::ObjCLifetime getBlockCaptureLifetime(QualType QT, bool ByrefLayout);
Fangrui Song6907ce22018-07-30 19:24:48 +0000953
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000954 void UpdateRunSkipBlockVars(bool IsByref,
955 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +0000956 CharUnits FieldOffset,
957 CharUnits FieldSize);
Fangrui Song6907ce22018-07-30 19:24:48 +0000958
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000959 void BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000960 CharUnits BytePos, bool &HasUnion,
961 bool ByrefLayout=false);
Fangrui Song6907ce22018-07-30 19:24:48 +0000962
Fariborz Jahanian39319c42012-10-30 20:05:29 +0000963 void BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
964 const RecordDecl *RD,
965 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000966 CharUnits BytePos, bool &HasUnion,
967 bool ByrefLayout);
Fangrui Song6907ce22018-07-30 19:24:48 +0000968
Fariborz Jahanian23290b02012-11-01 18:32:55 +0000969 uint64_t InlineLayoutInstruction(SmallVectorImpl<unsigned char> &Layout);
Fangrui Song6907ce22018-07-30 19:24:48 +0000970
Fariborz Jahaniana9d44642012-11-14 17:15:51 +0000971 llvm::Constant *getBitmapBlockLayout(bool ComputeByrefLayout);
Fangrui Song6907ce22018-07-30 19:24:48 +0000972
Fariborz Jahanian01dff422009-03-05 19:17:31 +0000973 /// GetIvarLayoutName - Returns a unique constant for the given
974 /// ivar layout bitmap.
975 llvm::Constant *GetIvarLayoutName(IdentifierInfo *Ident,
976 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000977
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000978 /// EmitPropertyList - Emit the given property list. The return
979 /// value has type PropertyListPtrTy.
Zachary Turner41a9ee92017-10-11 23:54:34 +0000980 llvm::Constant *EmitPropertyList(Twine Name,
981 const Decl *Container,
Fariborz Jahanian066347e2009-01-28 22:18:42 +0000982 const ObjCContainerDecl *OCD,
Manman Renad0e7912016-01-29 19:22:54 +0000983 const ObjCCommonTypesHelper &ObjCTypes,
984 bool IsClassProperty);
Daniel Dunbar59e476b2009-08-03 17:06:42 +0000985
Fangrui Song6907ce22018-07-30 19:24:48 +0000986 /// EmitProtocolMethodTypes - Generate the array of extended method type
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000987 /// strings. The return value has type Int8PtrPtrTy.
Fangrui Song6907ce22018-07-30 19:24:48 +0000988 llvm::Constant *EmitProtocolMethodTypes(Twine Name,
Zachary Turner41a9ee92017-10-11 23:54:34 +0000989 ArrayRef<llvm::Constant*> MethodTypes,
990 const ObjCCommonTypesHelper &ObjCTypes);
Bob Wilson5f4e3a72011-11-30 01:57:58 +0000991
Fariborz Jahanian56b3b772009-01-29 19:24:30 +0000992 /// GetProtocolRef - Return a reference to the internal protocol
993 /// description, creating an empty one if it has not been
994 /// defined. The return value has type ProtocolPtrTy.
995 llvm::Constant *GetProtocolRef(const ObjCProtocolDecl *PD);
Fariborz Jahanian67726212009-03-08 20:18:37 +0000996
Douglas Gregor24ae22c2016-04-01 23:23:52 +0000997 /// Return a reference to the given Class using runtime calls rather than
998 /// by a symbol reference.
999 llvm::Value *EmitClassRefViaRuntime(CodeGenFunction &CGF,
1000 const ObjCInterfaceDecl *ID,
1001 ObjCCommonTypesHelper &ObjCTypes);
1002
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00001003 std::string GetSectionName(StringRef Section, StringRef MachOAttributes);
1004
John McCall3fd13f062015-10-21 18:06:47 +00001005public:
Daniel Dunbar30c65362009-03-09 20:09:19 +00001006 /// CreateMetadataVar - Create a global variable with internal
1007 /// linkage for use by the Objective-C runtime.
1008 ///
1009 /// This is a convenience wrapper which not only creates the
1010 /// variable, but also sets the section and alignment and adds the
Chris Lattnerf56501c2009-07-17 23:57:13 +00001011 /// global to the "llvm.used" list.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001012 ///
1013 /// \param Name - The variable name.
1014 /// \param Init - The variable initializer; this is also used to
John McCall176f8922016-11-30 02:39:18 +00001015 /// define the type of the variable.
Alp Toker541d5072014-06-07 23:30:53 +00001016 /// \param Section - The section the variable should go into, or empty.
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001017 /// \param Align - The alignment for the variable, or 0.
1018 /// \param AddToUsed - Whether the variable should be added to
John McCall176f8922016-11-30 02:39:18 +00001019 /// "llvm.used".
Zachary Turner41a9ee92017-10-11 23:54:34 +00001020 llvm::GlobalVariable *CreateMetadataVar(Twine Name,
John McCall176f8922016-11-30 02:39:18 +00001021 ConstantStructBuilder &Init,
1022 StringRef Section, CharUnits Align,
1023 bool AddToUsed);
Zachary Turner41a9ee92017-10-11 23:54:34 +00001024 llvm::GlobalVariable *CreateMetadataVar(Twine Name,
John McCall176f8922016-11-30 02:39:18 +00001025 llvm::Constant *Init,
John McCall7f416cc2015-09-08 08:05:57 +00001026 StringRef Section, CharUnits Align,
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00001027 bool AddToUsed);
Daniel Dunbar30c65362009-03-09 20:09:19 +00001028
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00001029 llvm::GlobalVariable *CreateCStringLiteral(StringRef Name,
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00001030 ObjCLabelType LabelType,
1031 bool ForceNonFragileABI = false,
1032 bool NullTerminate = true);
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00001033
John McCall3fd13f062015-10-21 18:06:47 +00001034protected:
John McCall9e8bb002011-05-14 03:10:52 +00001035 CodeGen::RValue EmitMessageSend(CodeGen::CodeGenFunction &CGF,
1036 ReturnValueSlot Return,
1037 QualType ResultType,
1038 llvm::Value *Sel,
1039 llvm::Value *Arg0,
1040 QualType Arg0Ty,
1041 bool IsSuper,
1042 const CallArgList &CallArgs,
1043 const ObjCMethodDecl *OMD,
John McCall1e3157b2015-09-10 22:27:50 +00001044 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00001045 const ObjCCommonTypesHelper &ObjCTypes);
Daniel Dunbarf5c18462009-04-20 06:54:31 +00001046
Daniel Dunbar5e639272010-04-25 20:39:01 +00001047 /// EmitImageInfo - Emit the image info marker used to encode some module
1048 /// level information.
1049 void EmitImageInfo();
1050
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001051public:
Owen Andersonae86c192009-07-13 04:10:07 +00001052 CGObjCCommonMac(CodeGen::CodeGenModule &cgm) :
John McCalla729c622012-02-17 03:33:10 +00001053 CGObjCRuntime(cgm), VMContext(cgm.getLLVMContext()) { }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001054
John McCall3fd13f062015-10-21 18:06:47 +00001055 bool isNonFragileABI() const {
1056 return ObjCABI == 2;
1057 }
1058
John McCall7f416cc2015-09-08 08:05:57 +00001059 ConstantAddress GenerateConstantString(const StringLiteral *SL) override;
John McCallcd21d542016-11-30 23:15:55 +00001060 ConstantAddress GenerateConstantNSString(const StringLiteral *SL);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001061
Craig Topper4f12f102014-03-12 06:41:41 +00001062 llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
Craig Topper8a13c412014-05-21 05:09:00 +00001063 const ObjCContainerDecl *CD=nullptr) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001064
1065 void GenerateProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001066
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001067 /// GetOrEmitProtocol - Get the protocol object for the given
1068 /// declaration, emitting it if necessary. The return value has type
1069 /// ProtocolPtrTy.
1070 virtual llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD)=0;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001071
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001072 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1073 /// object for the given declaration, emitting it if needed. These
1074 /// forward references will be filled in with empty bodies if no
1075 /// definition is seen. The return value has type ProtocolPtrTy.
1076 virtual llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD)=0;
John McCallcd21d542016-11-30 23:15:55 +00001077
1078 virtual llvm::Constant *getNSConstantStringClassRef() = 0;
1079
Craig Topper4f12f102014-03-12 06:41:41 +00001080 llvm::Constant *BuildGCBlockLayout(CodeGen::CodeGenModule &CGM,
1081 const CGBlockInfo &blockInfo) override;
1082 llvm::Constant *BuildRCBlockLayout(CodeGen::CodeGenModule &CGM,
1083 const CGBlockInfo &blockInfo) override;
Akira Hatanaka2ec36f02018-08-17 15:46:07 +00001084 std::string getRCBlockLayoutStr(CodeGen::CodeGenModule &CGM,
1085 const CGBlockInfo &blockInfo) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001086
1087 llvm::Constant *BuildByrefLayout(CodeGen::CodeGenModule &CGM,
1088 QualType T) override;
Akira Hatanaka2ec36f02018-08-17 15:46:07 +00001089
1090private:
1091 void fillRunSkipBlockVars(CodeGenModule &CGM, const CGBlockInfo &blockInfo);
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001092};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001093
John McCall176f8922016-11-30 02:39:18 +00001094namespace {
1095
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00001096enum class MethodListType {
1097 CategoryInstanceMethods,
1098 CategoryClassMethods,
1099 InstanceMethods,
1100 ClassMethods,
1101 ProtocolInstanceMethods,
1102 ProtocolClassMethods,
1103 OptionalProtocolInstanceMethods,
1104 OptionalProtocolClassMethods,
1105};
1106
John McCall176f8922016-11-30 02:39:18 +00001107/// A convenience class for splitting the methods of a protocol into
1108/// the four interesting groups.
1109class ProtocolMethodLists {
1110public:
1111 enum Kind {
1112 RequiredInstanceMethods,
1113 RequiredClassMethods,
1114 OptionalInstanceMethods,
1115 OptionalClassMethods
1116 };
1117 enum {
1118 NumProtocolMethodLists = 4
1119 };
1120
1121 static MethodListType getMethodListKind(Kind kind) {
1122 switch (kind) {
1123 case RequiredInstanceMethods:
1124 return MethodListType::ProtocolInstanceMethods;
1125 case RequiredClassMethods:
1126 return MethodListType::ProtocolClassMethods;
1127 case OptionalInstanceMethods:
1128 return MethodListType::OptionalProtocolInstanceMethods;
1129 case OptionalClassMethods:
1130 return MethodListType::OptionalProtocolClassMethods;
1131 }
1132 llvm_unreachable("bad kind");
1133 }
1134
1135 SmallVector<const ObjCMethodDecl *, 4> Methods[NumProtocolMethodLists];
1136
1137 static ProtocolMethodLists get(const ObjCProtocolDecl *PD) {
1138 ProtocolMethodLists result;
1139
1140 for (auto MD : PD->methods()) {
1141 size_t index = (2 * size_t(MD->isOptional()))
1142 + (size_t(MD->isClassMethod()));
1143 result.Methods[index].push_back(MD);
1144 }
1145
1146 return result;
1147 }
1148
1149 template <class Self>
1150 SmallVector<llvm::Constant*, 8> emitExtendedTypesArray(Self *self) const {
1151 // In both ABIs, the method types list is parallel with the
1152 // concatenation of the methods arrays in the following order:
1153 // instance methods
1154 // class methods
1155 // optional instance methods
1156 // optional class methods
1157 SmallVector<llvm::Constant*, 8> result;
1158
1159 // Methods is already in the correct order for both ABIs.
1160 for (auto &list : Methods) {
1161 for (auto MD : list) {
1162 result.push_back(self->GetMethodVarType(MD, true));
1163 }
1164 }
1165
1166 return result;
1167 }
1168
1169 template <class Self>
1170 llvm::Constant *emitMethodList(Self *self, const ObjCProtocolDecl *PD,
1171 Kind kind) const {
1172 return self->emitMethodList(PD->getObjCRuntimeNameAsString(),
1173 getMethodListKind(kind), Methods[kind]);
1174 }
1175};
1176
1177} // end anonymous namespace
1178
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001179class CGObjCMac : public CGObjCCommonMac {
1180private:
John McCallc4ae1dd2016-11-30 04:18:19 +00001181 friend ProtocolMethodLists;
John McCall176f8922016-11-30 02:39:18 +00001182
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001183 ObjCTypesHelper ObjCTypes;
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001184
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001185 /// EmitModuleInfo - Another marker encoding module level
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001186 /// information.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001187 void EmitModuleInfo();
1188
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001189 /// EmitModuleSymols - Emit module symbols, the list of defined
1190 /// classes and categories. The result has type SymtabPtrTy.
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00001191 llvm::Constant *EmitModuleSymbols();
1192
Daniel Dunbar3ad53482008-08-11 21:35:06 +00001193 /// FinishModule - Write out global data structures at the end of
1194 /// processing a translation unit.
1195 void FinishModule();
Daniel Dunbarb036db82008-08-13 03:21:16 +00001196
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001197 /// EmitClassExtension - Generate the class extension structure used
1198 /// to store the weak ivar layout and properties. The return value
1199 /// has type ClassExtensionPtrTy.
John McCall3fd13f062015-10-21 18:06:47 +00001200 llvm::Constant *EmitClassExtension(const ObjCImplementationDecl *ID,
John McCall460ce582015-10-22 18:38:17 +00001201 CharUnits instanceSize,
Manman Renad0e7912016-01-29 19:22:54 +00001202 bool hasMRCWeakIvars,
John McCall176f8922016-11-30 02:39:18 +00001203 bool isMetaclass);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001204
1205 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1206 /// for the given class.
John McCall882987f2013-02-28 19:01:20 +00001207 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001208 const ObjCInterfaceDecl *ID);
Fangrui Song6907ce22018-07-30 19:24:48 +00001209
John McCall882987f2013-02-28 19:01:20 +00001210 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00001211 IdentifierInfo *II);
Craig Topper4f12f102014-03-12 06:41:41 +00001212
1213 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
1214
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00001215 /// EmitSuperClassRef - Emits reference to class's main metadata class.
1216 llvm::Value *EmitSuperClassRef(const ObjCInterfaceDecl *ID);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001217
1218 /// EmitIvarList - Emit the ivar list for the given
1219 /// implementation. If ForClass is true the list of class ivars
1220 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1221 /// interface ivars will be emitted. The return value has type
1222 /// IvarListPtrTy.
1223 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00001224 bool ForClass);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001225
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001226 /// EmitMetaClass - Emit a forward reference to the class structure
1227 /// for the metaclass of the given interface. The return value has
1228 /// type ClassPtrTy.
1229 llvm::Constant *EmitMetaClassRef(const ObjCInterfaceDecl *ID);
1230
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001231 /// EmitMetaClass - Emit a class structure for the metaclass of the
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001232 /// given implementation. The return value has type ClassPtrTy.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001233 llvm::Constant *EmitMetaClass(const ObjCImplementationDecl *ID,
1234 llvm::Constant *Protocols,
John McCall176f8922016-11-30 02:39:18 +00001235 ArrayRef<const ObjCMethodDecl *> Methods);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001236
John McCall176f8922016-11-30 02:39:18 +00001237 void emitMethodConstant(ConstantArrayBuilder &builder,
1238 const ObjCMethodDecl *MD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001239
John McCall176f8922016-11-30 02:39:18 +00001240 void emitMethodDescriptionConstant(ConstantArrayBuilder &builder,
1241 const ObjCMethodDecl *MD);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001242
1243 /// EmitMethodList - Emit the method list for the given
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001244 /// implementation. The return value has type MethodListPtrTy.
Zachary Turner41a9ee92017-10-11 23:54:34 +00001245 llvm::Constant *emitMethodList(Twine Name, MethodListType MLT,
John McCall176f8922016-11-30 02:39:18 +00001246 ArrayRef<const ObjCMethodDecl *> Methods);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001247
Daniel Dunbarc475d422008-10-29 22:36:39 +00001248 /// GetOrEmitProtocol - Get the protocol object for the given
1249 /// declaration, emitting it if necessary. The return value has type
1250 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001251 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001252
1253 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1254 /// object for the given declaration, emitting it if needed. These
1255 /// forward references will be filled in with empty bodies if no
1256 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001257 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbarc475d422008-10-29 22:36:39 +00001258
Daniel Dunbarb036db82008-08-13 03:21:16 +00001259 /// EmitProtocolExtension - Generate the protocol extension
1260 /// structure used to store optional instance and class methods, and
1261 /// protocol properties. The return value has type
1262 /// ProtocolExtensionPtrTy.
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00001263 llvm::Constant *
1264 EmitProtocolExtension(const ObjCProtocolDecl *PD,
John McCall176f8922016-11-30 02:39:18 +00001265 const ProtocolMethodLists &methodLists);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001266
1267 /// EmitProtocolList - Generate the list of referenced
1268 /// protocols. The return value has type ProtocolListPtrTy.
Zachary Turner41a9ee92017-10-11 23:54:34 +00001269 llvm::Constant *EmitProtocolList(Twine Name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00001270 ObjCProtocolDecl::protocol_iterator begin,
1271 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbarb036db82008-08-13 03:21:16 +00001272
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001273 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1274 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001275 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1276 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001277
1278public:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001279 CGObjCMac(CodeGen::CodeGenModule &cgm);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001280
John McCallcd21d542016-11-30 23:15:55 +00001281 llvm::Constant *getNSConstantStringClassRef() override;
1282
Craig Topper4f12f102014-03-12 06:41:41 +00001283 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001284
Craig Topper4f12f102014-03-12 06:41:41 +00001285 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1286 ReturnValueSlot Return,
1287 QualType ResultType,
1288 Selector Sel, llvm::Value *Receiver,
1289 const CallArgList &CallArgs,
1290 const ObjCInterfaceDecl *Class,
1291 const ObjCMethodDecl *Method) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001292
Craig Topper4f12f102014-03-12 06:41:41 +00001293 CodeGen::RValue
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001294 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001295 ReturnValueSlot Return, QualType ResultType,
1296 Selector Sel, const ObjCInterfaceDecl *Class,
1297 bool isCategoryImpl, llvm::Value *Receiver,
1298 bool IsClassMessage, const CallArgList &CallArgs,
1299 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001300
Craig Topper4f12f102014-03-12 06:41:41 +00001301 llvm::Value *GetClass(CodeGenFunction &CGF,
1302 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001303
John McCall7f416cc2015-09-08 08:05:57 +00001304 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
1305 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001306
1307 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1308 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001309 llvm::Value *GetSelector(CodeGenFunction &CGF,
1310 const ObjCMethodDecl *Method) override;
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001311
Craig Topper4f12f102014-03-12 06:41:41 +00001312 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001313
Craig Topper4f12f102014-03-12 06:41:41 +00001314 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001315
Craig Topper4f12f102014-03-12 06:41:41 +00001316 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001317
Craig Topper4f12f102014-03-12 06:41:41 +00001318 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001319
Craig Topper4f12f102014-03-12 06:41:41 +00001320 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1321 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001322
James Y Knight9871db02019-02-05 16:42:33 +00001323 llvm::FunctionCallee GetPropertyGetFunction() override;
1324 llvm::FunctionCallee GetPropertySetFunction() override;
1325 llvm::FunctionCallee GetOptimizedPropertySetFunction(bool atomic,
1326 bool copy) override;
1327 llvm::FunctionCallee GetGetStructFunction() override;
1328 llvm::FunctionCallee GetSetStructFunction() override;
1329 llvm::FunctionCallee GetCppAtomicObjectGetFunction() override;
1330 llvm::FunctionCallee GetCppAtomicObjectSetFunction() override;
1331 llvm::FunctionCallee EnumerationMutationFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001332
Craig Topper4f12f102014-03-12 06:41:41 +00001333 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1334 const ObjCAtTryStmt &S) override;
1335 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1336 const ObjCAtSynchronizedStmt &S) override;
John McCallbd309292010-07-06 01:34:17 +00001337 void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF, const Stmt &S);
Craig Topper4f12f102014-03-12 06:41:41 +00001338 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1339 bool ClearInsertionPoint=true) override;
1340 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001341 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001342 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001343 llvm::Value *src, Address dst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001344 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001345 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001346 bool threadlocal = false) override;
1347 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001348 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001349 llvm::Value *ivarOffset) override;
1350 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001351 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001352 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001353 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001354 llvm::Value *size) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001355
Craig Topper4f12f102014-03-12 06:41:41 +00001356 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1357 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1358 unsigned CVRQualifiers) override;
1359 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1360 const ObjCInterfaceDecl *Interface,
1361 const ObjCIvarDecl *Ivar) override;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001362};
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001363
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001364class CGObjCNonFragileABIMac : public CGObjCCommonMac {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001365private:
John McCallc4ae1dd2016-11-30 04:18:19 +00001366 friend ProtocolMethodLists;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001367 ObjCNonFragileABITypesHelper ObjCTypes;
Fariborz Jahanian71394042009-01-23 23:53:38 +00001368 llvm::GlobalVariable* ObjCEmptyCacheVar;
John McCall176f8922016-11-30 02:39:18 +00001369 llvm::Constant* ObjCEmptyVtableVar;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001370
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001371 /// SuperClassReferences - uniqued super class references.
1372 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> SuperClassReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001373
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001374 /// MetaClassReferences - uniqued meta class references.
1375 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> MetaClassReferences;
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001376
1377 /// EHTypeReferences - uniqued class ehtype references.
1378 llvm::DenseMap<IdentifierInfo*, llvm::GlobalVariable*> EHTypeReferences;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001379
John McCall9e8bb002011-05-14 03:10:52 +00001380 /// VTableDispatchMethods - List of methods for which we generate
1381 /// vtable-based message dispatch.
1382 llvm::DenseSet<Selector> VTableDispatchMethods;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001383
Fariborz Jahanian67260552009-11-17 21:37:35 +00001384 /// DefinedMetaClasses - List of defined meta-classes.
1385 std::vector<llvm::GlobalValue*> DefinedMetaClasses;
Fangrui Song6907ce22018-07-30 19:24:48 +00001386
John McCall9e8bb002011-05-14 03:10:52 +00001387 /// isVTableDispatchedSelector - Returns true if SEL is a
1388 /// vtable-based selector.
1389 bool isVTableDispatchedSelector(Selector Sel);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001390
Fariborz Jahanian71394042009-01-23 23:53:38 +00001391 /// FinishNonFragileABIModule - Write out global data structures at the end of
1392 /// processing a translation unit.
1393 void FinishNonFragileABIModule();
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001394
Daniel Dunbar19573e72009-05-15 21:48:48 +00001395 /// AddModuleClassList - Add the given list of class pointers to the
1396 /// module with the provided symbol and section names.
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001397 void AddModuleClassList(ArrayRef<llvm::GlobalValue *> Container,
1398 StringRef SymbolName, StringRef SectionName);
Daniel Dunbar19573e72009-05-15 21:48:48 +00001399
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001400 llvm::GlobalVariable * BuildClassRoTInitializer(unsigned flags,
1401 unsigned InstanceStart,
1402 unsigned InstanceSize,
1403 const ObjCImplementationDecl *ID);
John McCalldba63a72016-11-30 23:54:50 +00001404 llvm::GlobalVariable *BuildClassObject(const ObjCInterfaceDecl *CI,
1405 bool isMetaclass,
1406 llvm::Constant *IsAGV,
1407 llvm::Constant *SuperClassGV,
1408 llvm::Constant *ClassRoGV,
1409 bool HiddenVisibility);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001410
John McCall176f8922016-11-30 02:39:18 +00001411 void emitMethodConstant(ConstantArrayBuilder &builder,
1412 const ObjCMethodDecl *MD,
1413 bool forProtocol);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001414
John McCall176f8922016-11-30 02:39:18 +00001415 /// Emit the method list for the given implementation. The return value
1416 /// has type MethodListnfABITy.
Zachary Turner41a9ee92017-10-11 23:54:34 +00001417 llvm::Constant *emitMethodList(Twine Name, MethodListType MLT,
John McCall176f8922016-11-30 02:39:18 +00001418 ArrayRef<const ObjCMethodDecl *> Methods);
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00001419
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00001420 /// EmitIvarList - Emit the ivar list for the given
1421 /// implementation. If ForClass is true the list of class ivars
1422 /// (i.e. metaclass ivars) is emitted, otherwise the list of
1423 /// interface ivars will be emitted. The return value has type
1424 /// IvarListnfABIPtrTy.
1425 llvm::Constant *EmitIvarList(const ObjCImplementationDecl *ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001426
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001427 llvm::Constant *EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
Fariborz Jahanian3d3426f2009-01-28 01:36:42 +00001428 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00001429 unsigned long int offset);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001430
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001431 /// GetOrEmitProtocol - Get the protocol object for the given
1432 /// declaration, emitting it if necessary. The return value has type
1433 /// ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001434 llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001435
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001436 /// GetOrEmitProtocolRef - Get a forward reference to the protocol
1437 /// object for the given declaration, emitting it if needed. These
1438 /// forward references will be filled in with empty bodies if no
1439 /// definition is seen. The return value has type ProtocolPtrTy.
Craig Topper4f12f102014-03-12 06:41:41 +00001440 llvm::Constant *GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001441
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001442 /// EmitProtocolList - Generate the list of referenced
1443 /// protocols. The return value has type ProtocolListPtrTy.
Zachary Turner41a9ee92017-10-11 23:54:34 +00001444 llvm::Constant *EmitProtocolList(Twine Name,
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00001445 ObjCProtocolDecl::protocol_iterator begin,
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00001446 ObjCProtocolDecl::protocol_iterator end);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001447
John McCall9e8bb002011-05-14 03:10:52 +00001448 CodeGen::RValue EmitVTableMessageSend(CodeGen::CodeGenFunction &CGF,
1449 ReturnValueSlot Return,
1450 QualType ResultType,
1451 Selector Sel,
1452 llvm::Value *Receiver,
1453 QualType Arg0Ty,
1454 bool IsSuper,
1455 const CallArgList &CallArgs,
1456 const ObjCMethodDecl *Method);
Fangrui Song6907ce22018-07-30 19:24:48 +00001457
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00001458 /// GetClassGlobal - Return the global variable for the Objective-C
1459 /// class of the given name.
John McCalldba63a72016-11-30 23:54:50 +00001460 llvm::Constant *GetClassGlobal(StringRef Name,
1461 ForDefinition_t IsForDefinition,
1462 bool Weak = false, bool DLLImport = false);
1463 llvm::Constant *GetClassGlobal(const ObjCInterfaceDecl *ID,
1464 bool isMetaclass,
1465 ForDefinition_t isForDefinition);
Rafael Espindola554256c2014-02-26 22:25:45 +00001466
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00001467 /// EmitClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001468 /// for the given class reference.
John McCall882987f2013-02-28 19:01:20 +00001469 llvm::Value *EmitClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001470 const ObjCInterfaceDecl *ID);
Fangrui Song6907ce22018-07-30 19:24:48 +00001471
John McCall882987f2013-02-28 19:01:20 +00001472 llvm::Value *EmitClassRefFromId(CodeGenFunction &CGF,
John McCalldba63a72016-11-30 23:54:50 +00001473 IdentifierInfo *II,
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00001474 const ObjCInterfaceDecl *ID);
Craig Topper4f12f102014-03-12 06:41:41 +00001475
1476 llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001477
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00001478 /// EmitSuperClassRef - Return a Value*, of type ObjCTypes.ClassPtrTy,
1479 /// for the given super class reference.
John McCall882987f2013-02-28 19:01:20 +00001480 llvm::Value *EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001481 const ObjCInterfaceDecl *ID);
1482
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001483 /// EmitMetaClassRef - Return a Value * of the address of _class_t
1484 /// meta-data
John McCall882987f2013-02-28 19:01:20 +00001485 llvm::Value *EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00001486 const ObjCInterfaceDecl *ID, bool Weak);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00001487
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00001488 /// ObjCIvarOffsetVariable - Returns the ivar offset variable for
1489 /// the given ivar.
1490 ///
Daniel Dunbara1060522009-04-19 00:31:15 +00001491 llvm::GlobalVariable * ObjCIvarOffsetVariable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001492 const ObjCInterfaceDecl *ID,
1493 const ObjCIvarDecl *Ivar);
1494
Fariborz Jahanian74b77222009-02-11 20:51:17 +00001495 /// EmitSelector - Return a Value*, of type ObjCTypes.SelectorPtrTy,
1496 /// for the given selector.
John McCall7f416cc2015-09-08 08:05:57 +00001497 llvm::Value *EmitSelector(CodeGenFunction &CGF, Selector Sel);
1498 Address EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel);
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001499
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001500 /// GetInterfaceEHType - Get the cached ehtype for the given Objective-C
Daniel Dunbarb1559a42009-03-01 04:46:24 +00001501 /// interface. The return value has type EHTypePtrTy.
John McCall2ca705e2010-07-24 00:37:23 +00001502 llvm::Constant *GetInterfaceEHType(const ObjCInterfaceDecl *ID,
John McCalldba63a72016-11-30 23:54:50 +00001503 ForDefinition_t IsForDefinition);
Daniel Dunbar15894b72009-04-07 05:48:37 +00001504
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001505 StringRef getMetaclassSymbolPrefix() const { return "OBJC_METACLASS_$_"; }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001506
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00001507 StringRef getClassSymbolPrefix() const { return "OBJC_CLASS_$_"; }
Daniel Dunbar15894b72009-04-07 05:48:37 +00001508
Daniel Dunbar961202372009-05-03 12:57:56 +00001509 void GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00001510 uint32_t &InstanceStart,
1511 uint32_t &InstanceSize);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001512
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001513 // Shamelessly stolen from Analysis/CFRefCount.cpp
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001514 Selector GetNullarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001515 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1516 return CGM.getContext().Selectors.getSelector(0, &II);
1517 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001518
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001519 Selector GetUnarySelector(const char* name) const {
Fariborz Jahaniane4128642009-05-12 20:06:41 +00001520 IdentifierInfo* II = &CGM.getContext().Idents.get(name);
1521 return CGM.getContext().Selectors.getSelector(1, &II);
1522 }
Daniel Dunbar554fd792009-04-19 23:41:48 +00001523
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001524 /// ImplementationIsNonLazy - Check whether the given category or
1525 /// class implementation is "non-lazy".
Fariborz Jahaniana6bed832009-05-21 01:03:45 +00001526 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const;
Daniel Dunbar9a017d72009-05-15 22:33:15 +00001527
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001528 bool IsIvarOffsetKnownIdempotent(const CodeGen::CodeGenFunction &CGF,
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001529 const ObjCIvarDecl *IV) {
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001530 // Annotate the load as an invariant load iff inside an instance method
1531 // and ivar belongs to instance method's class and one of its super class.
1532 // This check is needed because the ivar offset is a lazily
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001533 // initialised value that may depend on objc_msgSend to perform a fixup on
1534 // the first message dispatch.
1535 //
1536 // An additional opportunity to mark the load as invariant arises when the
1537 // base of the ivar access is a parameter to an Objective C method.
1538 // However, because the parameters are not available in the current
1539 // interface, we cannot perform this check.
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001540 if (const ObjCMethodDecl *MD =
1541 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurFuncDecl))
Fariborz Jahanian7a583022014-03-04 22:57:32 +00001542 if (MD->isInstanceMethod())
Fariborz Jahaniandafffbe2014-03-04 18:34:52 +00001543 if (const ObjCInterfaceDecl *ID = MD->getClassInterface())
1544 return IV->getContainingInterface()->isSuperClassOf(ID);
Saleem Abdulrasool5f25bc32013-02-17 04:03:34 +00001545 return false;
1546 }
1547
Erik Pilkington2ff012d2019-01-17 18:18:53 +00001548 bool isClassLayoutKnownStatically(const ObjCInterfaceDecl *ID) {
1549 // NSObject is a fixed size. If we can see the @implementation of a class
1550 // which inherits from NSObject then we know that all it's offsets also must
1551 // be fixed. FIXME: Can we do this if see a chain of super classes with
1552 // implementations leading to NSObject?
1553 return ID->getImplementation() && ID->getSuperClass() &&
1554 ID->getSuperClass()->getName() == "NSObject";
1555 }
1556
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001557public:
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00001558 CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm);
John McCallcd21d542016-11-30 23:15:55 +00001559
1560 llvm::Constant *getNSConstantStringClassRef() override;
1561
Craig Topper4f12f102014-03-12 06:41:41 +00001562 llvm::Function *ModuleInitFunction() override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001563
Craig Topper4f12f102014-03-12 06:41:41 +00001564 CodeGen::RValue GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
1565 ReturnValueSlot Return,
1566 QualType ResultType, Selector Sel,
1567 llvm::Value *Receiver,
1568 const CallArgList &CallArgs,
1569 const ObjCInterfaceDecl *Class,
1570 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001571
Craig Topper4f12f102014-03-12 06:41:41 +00001572 CodeGen::RValue
Fariborz Jahanian71394042009-01-23 23:53:38 +00001573 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Craig Topper4f12f102014-03-12 06:41:41 +00001574 ReturnValueSlot Return, QualType ResultType,
1575 Selector Sel, const ObjCInterfaceDecl *Class,
1576 bool isCategoryImpl, llvm::Value *Receiver,
1577 bool IsClassMessage, const CallArgList &CallArgs,
1578 const ObjCMethodDecl *Method) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001579
Craig Topper4f12f102014-03-12 06:41:41 +00001580 llvm::Value *GetClass(CodeGenFunction &CGF,
1581 const ObjCInterfaceDecl *ID) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001582
John McCall7f416cc2015-09-08 08:05:57 +00001583 llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override
1584 { return EmitSelector(CGF, Sel); }
1585 Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override
1586 { return EmitSelectorAddr(CGF, Sel); }
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001587
1588 /// The NeXT/Apple runtimes do not support typed selectors; just emit an
1589 /// untyped one.
Craig Topper4f12f102014-03-12 06:41:41 +00001590 llvm::Value *GetSelector(CodeGenFunction &CGF,
1591 const ObjCMethodDecl *Method) override
John McCall882987f2013-02-28 19:01:20 +00001592 { return EmitSelector(CGF, Method->getSelector()); }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001593
Craig Topper4f12f102014-03-12 06:41:41 +00001594 void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001595
Craig Topper4f12f102014-03-12 06:41:41 +00001596 void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
David Chisnall92d436b2012-01-31 18:59:20 +00001597
Craig Topper4f12f102014-03-12 06:41:41 +00001598 void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override {}
David Chisnall92d436b2012-01-31 18:59:20 +00001599
Craig Topper4f12f102014-03-12 06:41:41 +00001600 llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
1601 const ObjCProtocolDecl *PD) override;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001602
Craig Topper4f12f102014-03-12 06:41:41 +00001603 llvm::Constant *GetEHType(QualType T) override;
John McCall2ca705e2010-07-24 00:37:23 +00001604
James Y Knight9871db02019-02-05 16:42:33 +00001605 llvm::FunctionCallee GetPropertyGetFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001606 return ObjCTypes.getGetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001607 }
James Y Knight9871db02019-02-05 16:42:33 +00001608 llvm::FunctionCallee GetPropertySetFunction() override {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001609 return ObjCTypes.getSetPropertyFn();
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00001610 }
Craig Topper4f12f102014-03-12 06:41:41 +00001611
James Y Knight9871db02019-02-05 16:42:33 +00001612 llvm::FunctionCallee GetOptimizedPropertySetFunction(bool atomic,
1613 bool copy) override {
Ted Kremeneke65b0862012-03-06 20:05:56 +00001614 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
1615 }
Craig Topper4f12f102014-03-12 06:41:41 +00001616
James Y Knight9871db02019-02-05 16:42:33 +00001617 llvm::FunctionCallee GetSetStructFunction() override {
David Chisnall168b80f2010-12-26 22:13:16 +00001618 return ObjCTypes.getCopyStructFn();
1619 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001620
James Y Knight9871db02019-02-05 16:42:33 +00001621 llvm::FunctionCallee GetGetStructFunction() override {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00001622 return ObjCTypes.getCopyStructFn();
1623 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001624
James Y Knight9871db02019-02-05 16:42:33 +00001625 llvm::FunctionCallee GetCppAtomicObjectSetFunction() override {
David Chisnall0d75e062012-12-17 18:54:24 +00001626 return ObjCTypes.getCppAtomicObjectFunction();
1627 }
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00001628
James Y Knight9871db02019-02-05 16:42:33 +00001629 llvm::FunctionCallee GetCppAtomicObjectGetFunction() override {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00001630 return ObjCTypes.getCppAtomicObjectFunction();
1631 }
Craig Topper4f12f102014-03-12 06:41:41 +00001632
James Y Knight9871db02019-02-05 16:42:33 +00001633 llvm::FunctionCallee EnumerationMutationFunction() override {
Chris Lattnerce8754e2009-04-22 02:44:54 +00001634 return ObjCTypes.getEnumerationMutationFn();
Daniel Dunbard73ea8162009-02-16 18:48:45 +00001635 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001636
Craig Topper4f12f102014-03-12 06:41:41 +00001637 void EmitTryStmt(CodeGen::CodeGenFunction &CGF,
1638 const ObjCAtTryStmt &S) override;
1639 void EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
1640 const ObjCAtSynchronizedStmt &S) override;
1641 void EmitThrowStmt(CodeGen::CodeGenFunction &CGF, const ObjCAtThrowStmt &S,
1642 bool ClearInsertionPoint=true) override;
1643 llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001644 Address AddrWeakObj) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001645 void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001646 llvm::Value *src, Address edst) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001647 void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001648 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001649 bool threadlocal = false) override;
1650 void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001651 llvm::Value *src, Address dest,
Craig Topper4f12f102014-03-12 06:41:41 +00001652 llvm::Value *ivarOffset) override;
1653 void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001654 llvm::Value *src, Address dest) override;
Craig Topper4f12f102014-03-12 06:41:41 +00001655 void EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00001656 Address dest, Address src,
Craig Topper4f12f102014-03-12 06:41:41 +00001657 llvm::Value *size) override;
1658 LValue EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF, QualType ObjectTy,
1659 llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
1660 unsigned CVRQualifiers) override;
1661 llvm::Value *EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
1662 const ObjCInterfaceDecl *Interface,
1663 const ObjCIvarDecl *Ivar) override;
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001664};
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001665
1666/// A helper class for performing the null-initialization of a return
1667/// value.
1668struct NullReturnState {
1669 llvm::BasicBlock *NullBB;
Craig Topper8a13c412014-05-21 05:09:00 +00001670 NullReturnState() : NullBB(nullptr) {}
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001671
John McCall3d1e2c92013-02-12 05:53:35 +00001672 /// Perform a null-check of the given receiver.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001673 void init(CodeGenFunction &CGF, llvm::Value *receiver) {
John McCall3d1e2c92013-02-12 05:53:35 +00001674 // Make blocks for the null-receiver and call edges.
1675 NullBB = CGF.createBasicBlock("msgSend.null-receiver");
1676 llvm::BasicBlock *callBB = CGF.createBasicBlock("msgSend.call");
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001677
1678 // Check for a null receiver and, if there is one, jump to the
John McCall3d1e2c92013-02-12 05:53:35 +00001679 // null-receiver block. There's no point in trying to avoid it:
1680 // we're always going to put *something* there, because otherwise
1681 // we shouldn't have done this null-check in the first place.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001682 llvm::Value *isNull = CGF.Builder.CreateIsNull(receiver);
1683 CGF.Builder.CreateCondBr(isNull, NullBB, callBB);
1684
1685 // Otherwise, start performing the call.
1686 CGF.EmitBlock(callBB);
1687 }
1688
John McCall3d1e2c92013-02-12 05:53:35 +00001689 /// Complete the null-return operation. It is valid to call this
1690 /// regardless of whether 'init' has been called.
Kuba Mracekbce5cea2017-06-30 16:28:15 +00001691 RValue complete(CodeGenFunction &CGF,
1692 ReturnValueSlot returnSlot,
1693 RValue result,
1694 QualType resultType,
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001695 const CallArgList &CallArgs,
1696 const ObjCMethodDecl *Method) {
John McCall3d1e2c92013-02-12 05:53:35 +00001697 // If we never had to do a null-check, just use the raw result.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001698 if (!NullBB) return result;
John McCall3d1e2c92013-02-12 05:53:35 +00001699
1700 // The continuation block. This will be left null if we don't have an
1701 // IP, which can happen if the method we're calling is marked noreturn.
Craig Topper8a13c412014-05-21 05:09:00 +00001702 llvm::BasicBlock *contBB = nullptr;
1703
John McCall3d1e2c92013-02-12 05:53:35 +00001704 // Finish the call path.
1705 llvm::BasicBlock *callBB = CGF.Builder.GetInsertBlock();
1706 if (callBB) {
1707 contBB = CGF.createBasicBlock("msgSend.cont");
1708 CGF.Builder.CreateBr(contBB);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001709 }
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001710
John McCall3d1e2c92013-02-12 05:53:35 +00001711 // Okay, start emitting the null-receiver block.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001712 CGF.EmitBlock(NullBB);
Fangrui Song6907ce22018-07-30 19:24:48 +00001713
John McCall3d1e2c92013-02-12 05:53:35 +00001714 // Release any consumed arguments we've got.
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001715 if (Method) {
1716 CallArgList::const_iterator I = CallArgs.begin();
1717 for (ObjCMethodDecl::param_const_iterator i = Method->param_begin(),
1718 e = Method->param_end(); i != e; ++i, ++I) {
1719 const ParmVarDecl *ParamDecl = (*i);
1720 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
Yaxun Liu5b330e82018-03-15 15:25:19 +00001721 RValue RV = I->getRValue(CGF);
Fangrui Song6907ce22018-07-30 19:24:48 +00001722 assert(RV.isScalar() &&
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001723 "NullReturnState::complete - arg not on object");
John McCallcdda29c2013-03-13 03:10:54 +00001724 CGF.EmitARCRelease(RV.getScalarVal(), ARCImpreciseLifetime);
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00001725 }
1726 }
1727 }
John McCall3d1e2c92013-02-12 05:53:35 +00001728
1729 // The phi code below assumes that we haven't needed any control flow yet.
1730 assert(CGF.Builder.GetInsertBlock() == NullBB);
1731
1732 // If we've got a void return, just jump to the continuation block.
1733 if (result.isScalar() && resultType->isVoidType()) {
1734 // No jumps required if the message-send was noreturn.
1735 if (contBB) CGF.EmitBlock(contBB);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001736 return result;
1737 }
1738
John McCall3d1e2c92013-02-12 05:53:35 +00001739 // If we've got a scalar return, build a phi.
1740 if (result.isScalar()) {
1741 // Derive the null-initialization value.
1742 llvm::Constant *null = CGF.CGM.EmitNullConstant(resultType);
1743
1744 // If no join is necessary, just flow out.
1745 if (!contBB) return RValue::get(null);
1746
1747 // Otherwise, build a phi.
1748 CGF.EmitBlock(contBB);
1749 llvm::PHINode *phi = CGF.Builder.CreatePHI(null->getType(), 2);
1750 phi->addIncoming(result.getScalarVal(), callBB);
1751 phi->addIncoming(null, NullBB);
1752 return RValue::get(phi);
1753 }
1754
1755 // If we've got an aggregate return, null the buffer out.
1756 // FIXME: maybe we should be doing things differently for all the
1757 // cases where the ABI has us returning (1) non-agg values in
1758 // memory or (2) agg values in registers.
1759 if (result.isAggregate()) {
1760 assert(result.isAggregate() && "null init of non-aggregate result?");
Kuba Mracekbce5cea2017-06-30 16:28:15 +00001761 if (!returnSlot.isUnused())
1762 CGF.EmitNullInitialization(result.getAggregateAddress(), resultType);
John McCall3d1e2c92013-02-12 05:53:35 +00001763 if (contBB) CGF.EmitBlock(contBB);
1764 return result;
1765 }
1766
1767 // Complex types.
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001768 CGF.EmitBlock(contBB);
John McCall3d1e2c92013-02-12 05:53:35 +00001769 CodeGenFunction::ComplexPairTy callResult = result.getComplexVal();
1770
1771 // Find the scalar type and its zero value.
1772 llvm::Type *scalarTy = callResult.first->getType();
1773 llvm::Constant *scalarZero = llvm::Constant::getNullValue(scalarTy);
1774
1775 // Build phis for both coordinates.
1776 llvm::PHINode *real = CGF.Builder.CreatePHI(scalarTy, 2);
1777 real->addIncoming(callResult.first, callBB);
1778 real->addIncoming(scalarZero, NullBB);
1779 llvm::PHINode *imag = CGF.Builder.CreatePHI(scalarTy, 2);
1780 imag->addIncoming(callResult.second, callBB);
1781 imag->addIncoming(scalarZero, NullBB);
1782 return RValue::getComplex(real, imag);
Fariborz Jahanian715fdd52012-01-29 20:27:13 +00001783 }
1784};
1785
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001786} // end anonymous namespace
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001787
1788/* *** Helper Functions *** */
1789
1790/// getConstantGEP() - Help routine to construct simple GEPs.
Owen Anderson170229f2009-07-14 23:10:40 +00001791static llvm::Constant *getConstantGEP(llvm::LLVMContext &VMContext,
David Blaikiee3b172a2015-04-02 18:55:21 +00001792 llvm::GlobalVariable *C, unsigned idx0,
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001793 unsigned idx1) {
1794 llvm::Value *Idxs[] = {
Owen Anderson41a75022009-08-13 21:57:51 +00001795 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx0),
1796 llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), idx1)
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001797 };
David Blaikiee3b172a2015-04-02 18:55:21 +00001798 return llvm::ConstantExpr::getGetElementPtr(C->getValueType(), C, Idxs);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001799}
1800
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001801/// hasObjCExceptionAttribute - Return true if this class or any super
1802/// class has the __objc_exception__ attribute.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001803static bool hasObjCExceptionAttribute(ASTContext &Context,
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001804 const ObjCInterfaceDecl *OID) {
Argyrios Kyrtzidisb4b64ca2009-06-30 02:34:44 +00001805 if (OID->hasAttr<ObjCExceptionAttr>())
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001806 return true;
1807 if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
Douglas Gregor78bd61f2009-06-18 16:11:24 +00001808 return hasObjCExceptionAttribute(Context, Super);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00001809 return false;
1810}
1811
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001812/* *** CGObjCMac Public Interface *** */
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001813
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001814CGObjCMac::CGObjCMac(CodeGen::CodeGenModule &cgm) : CGObjCCommonMac(cgm),
Mike Stump11289f42009-09-09 15:08:12 +00001815 ObjCTypes(cgm) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00001816 ObjCABI = 1;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001817 EmitImageInfo();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001818}
1819
Daniel Dunbar7c6d3a72008-08-16 00:25:02 +00001820/// GetClass - Return a reference to the class for the given interface
1821/// decl.
John McCall882987f2013-02-28 19:01:20 +00001822llvm::Value *CGObjCMac::GetClass(CodeGenFunction &CGF,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00001823 const ObjCInterfaceDecl *ID) {
John McCall882987f2013-02-28 19:01:20 +00001824 return EmitClassRef(CGF, ID);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001825}
1826
1827/// GetSelector - Return the pointer to the unique'd string for this selector.
John McCall7f416cc2015-09-08 08:05:57 +00001828llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, Selector Sel) {
1829 return EmitSelector(CGF, Sel);
1830}
1831Address CGObjCMac::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
1832 return EmitSelectorAddr(CGF, Sel);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001833}
John McCall882987f2013-02-28 19:01:20 +00001834llvm::Value *CGObjCMac::GetSelector(CodeGenFunction &CGF, const ObjCMethodDecl
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001835 *Method) {
John McCall882987f2013-02-28 19:01:20 +00001836 return EmitSelector(CGF, Method->getSelector());
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00001837}
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001838
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001839llvm::Constant *CGObjCMac::GetEHType(QualType T) {
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001840 if (T->isObjCIdType() ||
1841 T->isObjCQualifiedIdType()) {
1842 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001843 CGM.getContext().getObjCIdRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian0a3cfcc2011-06-22 20:21:51 +00001844 }
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001845 if (T->isObjCClassType() ||
1846 T->isObjCQualifiedClassType()) {
1847 return CGM.GetAddrOfRTTIDescriptor(
Douglas Gregor97673472011-08-11 20:58:55 +00001848 CGM.getContext().getObjCClassRedefinitionType(), /*ForEH=*/true);
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00001849 }
1850 if (T->isObjCObjectPointerType())
1851 return CGM.GetAddrOfRTTIDescriptor(T, /*ForEH=*/true);
Fangrui Song6907ce22018-07-30 19:24:48 +00001852
John McCall2ca705e2010-07-24 00:37:23 +00001853 llvm_unreachable("asking for catch type for ObjC type in fragile runtime");
John McCall2ca705e2010-07-24 00:37:23 +00001854}
1855
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001856/// Generate a constant CFString object.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00001857/*
1858 struct __builtin_CFString {
1859 const int *isa; // point to __CFConstantStringClassReference
1860 int flags;
1861 const char *str;
1862 long length;
1863 };
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00001864*/
1865
Fariborz Jahanian63408e82010-04-22 20:26:39 +00001866/// or Generate a constant NSString object.
1867/*
1868 struct __builtin_NSString {
1869 const int *isa; // point to __NSConstantStringClassReference
1870 const char *str;
1871 unsigned int length;
1872 };
1873*/
1874
John McCallcd21d542016-11-30 23:15:55 +00001875ConstantAddress
1876CGObjCCommonMac::GenerateConstantString(const StringLiteral *SL) {
1877 return (!CGM.getLangOpts().NoConstantCFStrings
1878 ? CGM.GetAddrOfConstantCFString(SL)
1879 : GenerateConstantNSString(SL));
1880}
1881
1882static llvm::StringMapEntry<llvm::GlobalVariable *> &
1883GetConstantStringEntry(llvm::StringMap<llvm::GlobalVariable *> &Map,
1884 const StringLiteral *Literal, unsigned &StringLength) {
1885 StringRef String = Literal->getString();
1886 StringLength = String.size();
1887 return *Map.insert(std::make_pair(String, nullptr)).first;
1888}
1889
1890llvm::Constant *CGObjCMac::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() ? "_NSConstantStringClassReference"
1897 : "_" + StringClass + "ClassReference";
1898
1899 llvm::Type *PTy = llvm::ArrayType::get(CGM.IntTy, 0);
1900 auto GV = CGM.CreateRuntimeVariable(PTy, str);
1901 auto V = llvm::ConstantExpr::getBitCast(GV, CGM.IntTy->getPointerTo());
1902 ConstantStringClassRef = V;
1903 return V;
1904}
1905
1906llvm::Constant *CGObjCNonFragileABIMac::getNSConstantStringClassRef() {
1907 if (llvm::Value *V = ConstantStringClassRef)
1908 return cast<llvm::Constant>(V);
1909
1910 auto &StringClass = CGM.getLangOpts().ObjCConstantStringClass;
Fangrui Song6907ce22018-07-30 19:24:48 +00001911 std::string str =
1912 StringClass.empty() ? "OBJC_CLASS_$_NSConstantString"
John McCallcd21d542016-11-30 23:15:55 +00001913 : "OBJC_CLASS_$_" + StringClass;
John McCalldba63a72016-11-30 23:54:50 +00001914 auto GV = GetClassGlobal(str, NotForDefinition);
John McCallcd21d542016-11-30 23:15:55 +00001915
1916 // Make sure the result is of the correct type.
1917 auto V = llvm::ConstantExpr::getBitCast(GV, CGM.IntTy->getPointerTo());
1918
1919 ConstantStringClassRef = V;
1920 return V;
1921}
1922
1923ConstantAddress
1924CGObjCCommonMac::GenerateConstantNSString(const StringLiteral *Literal) {
1925 unsigned StringLength = 0;
1926 llvm::StringMapEntry<llvm::GlobalVariable *> &Entry =
1927 GetConstantStringEntry(NSConstantStringMap, Literal, StringLength);
1928
1929 if (auto *C = Entry.second)
1930 return ConstantAddress(C, CharUnits::fromQuantity(C->getAlignment()));
1931
1932 // If we don't already have it, get _NSConstantStringClassReference.
1933 llvm::Constant *Class = getNSConstantStringClassRef();
1934
1935 // If we don't already have it, construct the type for a constant NSString.
1936 if (!NSConstantStringType) {
1937 NSConstantStringType =
1938 llvm::StructType::create({
1939 CGM.Int32Ty->getPointerTo(),
1940 CGM.Int8PtrTy,
1941 CGM.IntTy
1942 }, "struct.__builtin_NSString");
1943 }
1944
1945 ConstantInitBuilder Builder(CGM);
1946 auto Fields = Builder.beginStruct(NSConstantStringType);
1947
1948 // Class pointer.
1949 Fields.add(Class);
1950
1951 // String pointer.
1952 llvm::Constant *C =
1953 llvm::ConstantDataArray::getString(VMContext, Entry.first());
1954
1955 llvm::GlobalValue::LinkageTypes Linkage = llvm::GlobalValue::PrivateLinkage;
1956 bool isConstant = !CGM.getLangOpts().WritableStrings;
1957
1958 auto *GV = new llvm::GlobalVariable(CGM.getModule(), C->getType(), isConstant,
1959 Linkage, C, ".str");
1960 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
1961 // Don't enforce the target's minimum global alignment, since the only use
1962 // of the string is via this class initializer.
1963 GV->setAlignment(1);
1964 Fields.addBitCast(GV, CGM.Int8PtrTy);
1965
1966 // String length.
1967 Fields.addInt(CGM.IntTy, StringLength);
1968
1969 // The struct.
1970 CharUnits Alignment = CGM.getPointerAlign();
1971 GV = Fields.finishAndCreateGlobal("_unnamed_nsstring_", Alignment,
1972 /*constant*/ true,
1973 llvm::GlobalVariable::PrivateLinkage);
1974 const char *NSStringSection = "__OBJC,__cstring_object,regular,no_dead_strip";
1975 const char *NSStringNonFragileABISection =
1976 "__DATA,__objc_stringobj,regular,no_dead_strip";
1977 // FIXME. Fix section.
1978 GV->setSection(CGM.getLangOpts().ObjCRuntime.isNonFragile()
1979 ? NSStringNonFragileABISection
1980 : NSStringSection);
1981 Entry.second = GV;
1982
1983 return ConstantAddress(GV, Alignment);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001984}
1985
Ted Kremeneke65b0862012-03-06 20:05:56 +00001986enum {
1987 kCFTaggedObjectID_Integer = (1 << 1) + 1
1988};
1989
Daniel Dunbar303e2c22008-08-11 02:45:11 +00001990/// Generates a message send where the super is the receiver. This is
1991/// a message send to self with special delivery semantics indicating
1992/// which class's method should be called.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00001993CodeGen::RValue
1994CGObjCMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00001995 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001996 QualType ResultType,
1997 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00001998 const ObjCInterfaceDecl *Class,
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00001999 bool isCategoryImpl,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002000 llvm::Value *Receiver,
Daniel Dunbarc722b852008-08-30 03:02:31 +00002001 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00002002 const CodeGen::CallArgList &CallArgs,
2003 const ObjCMethodDecl *Method) {
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00002004 // Create and init a super structure; this is a (receiver, class)
2005 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00002006 Address ObjCSuper =
2007 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
2008 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002009 llvm::Value *ReceiverAsObject =
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00002010 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00002011 CGF.Builder.CreateStore(
2012 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00002013 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbarf6397fe2008-08-23 04:28:29 +00002014
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002015 // If this is a class message the metaclass is passed as the target.
2016 llvm::Value *Target;
2017 if (IsClassMessage) {
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00002018 if (isCategoryImpl) {
2019 // Message sent to 'super' in a class method defined in a category
2020 // implementation requires an odd treatment.
2021 // If we are in a class method, we must retrieve the
2022 // _metaclass_ for the current class, pointed at by
2023 // the class's "isa" pointer. The following assumes that
2024 // isa" is the first ivar in a class (which it must be).
John McCall882987f2013-02-28 19:01:20 +00002025 Target = EmitClassRef(CGF, Class->getSuperClass());
David Blaikie1ed728c2015-04-05 22:45:47 +00002026 Target = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, Target, 0);
John McCall7f416cc2015-09-08 08:05:57 +00002027 Target = CGF.Builder.CreateAlignedLoad(Target, CGF.getPointerAlign());
Mike Stump658fe022009-07-30 22:28:39 +00002028 } else {
David Blaikie1ed728c2015-04-05 22:45:47 +00002029 llvm::Constant *MetaClassPtr = EmitMetaClassRef(Class);
2030 llvm::Value *SuperPtr =
2031 CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, MetaClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00002032 llvm::Value *Super =
2033 CGF.Builder.CreateAlignedLoad(SuperPtr, CGF.getPointerAlign());
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00002034 Target = Super;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002035 }
David Blaikie1ed728c2015-04-05 22:45:47 +00002036 } else if (isCategoryImpl)
John McCall882987f2013-02-28 19:01:20 +00002037 Target = EmitClassRef(CGF, Class->getSuperClass());
Fariborz Jahanianda2efb02009-11-14 02:18:31 +00002038 else {
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00002039 llvm::Value *ClassPtr = EmitSuperClassRef(Class);
David Blaikie1ed728c2015-04-05 22:45:47 +00002040 ClassPtr = CGF.Builder.CreateStructGEP(ObjCTypes.ClassTy, ClassPtr, 1);
John McCall7f416cc2015-09-08 08:05:57 +00002041 Target = CGF.Builder.CreateAlignedLoad(ClassPtr, CGF.getPointerAlign());
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002042 }
Mike Stump18bb9282009-05-16 07:57:57 +00002043 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
2044 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00002045 llvm::Type *ClassTy =
Daniel Dunbarc722b852008-08-30 03:02:31 +00002046 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
Daniel Dunbarc475d422008-10-29 22:36:39 +00002047 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
John McCall7f416cc2015-09-08 08:05:57 +00002048 CGF.Builder.CreateStore(Target,
2049 CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
John McCall9e8bb002011-05-14 03:10:52 +00002050 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00002051 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00002052 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00002053 true, CallArgs, Method, Class, ObjCTypes);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002054}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002055
2056/// Generate code for a message send expression.
Daniel Dunbar97db84c2008-08-23 03:46:30 +00002057CodeGen::RValue CGObjCMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00002058 ReturnValueSlot Return,
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00002059 QualType ResultType,
2060 Selector Sel,
Daniel Dunbarca8531a2008-08-25 08:19:24 +00002061 llvm::Value *Receiver,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002062 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00002063 const ObjCInterfaceDecl *Class,
Fariborz Jahanianf3648b82009-05-05 21:36:57 +00002064 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00002065 return EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00002066 EmitSelector(CGF, Sel),
John McCall9e8bb002011-05-14 03:10:52 +00002067 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00002068 false, CallArgs, Method, Class, ObjCTypes);
2069}
2070
2071static bool isWeakLinkedClass(const ObjCInterfaceDecl *ID) {
2072 do {
2073 if (ID->isWeakImported())
2074 return true;
2075 } while ((ID = ID->getSuperClass()));
2076
2077 return false;
Daniel Dunbar97ff50d2008-08-23 09:25:55 +00002078}
2079
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00002080CodeGen::RValue
John McCall9e8bb002011-05-14 03:10:52 +00002081CGObjCCommonMac::EmitMessageSend(CodeGen::CodeGenFunction &CGF,
2082 ReturnValueSlot Return,
2083 QualType ResultType,
2084 llvm::Value *Sel,
2085 llvm::Value *Arg0,
2086 QualType Arg0Ty,
2087 bool IsSuper,
2088 const CallArgList &CallArgs,
2089 const ObjCMethodDecl *Method,
John McCall1e3157b2015-09-10 22:27:50 +00002090 const ObjCInterfaceDecl *ClassReceiver,
John McCall9e8bb002011-05-14 03:10:52 +00002091 const ObjCCommonTypesHelper &ObjCTypes) {
Daniel Dunbarc722b852008-08-30 03:02:31 +00002092 CallArgList ActualArgs;
Fariborz Jahanian969bc682009-04-24 21:07:43 +00002093 if (!IsSuper)
Benjamin Kramer76399eb2011-09-27 21:06:10 +00002094 Arg0 = CGF.Builder.CreateBitCast(Arg0, ObjCTypes.ObjectPtrTy);
Eli Friedman43dca6a2011-05-02 17:57:46 +00002095 ActualArgs.add(RValue::get(Arg0), Arg0Ty);
2096 ActualArgs.add(RValue::get(Sel), CGF.getContext().getObjCSelType());
John McCall31168b02011-06-15 23:02:42 +00002097 ActualArgs.addFrom(CallArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002098
John McCalla729c622012-02-17 03:33:10 +00002099 // If we're calling a method, use the formal signature.
2100 MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002101
Anders Carlsson280e61f12010-06-21 20:59:55 +00002102 if (Method)
Alp Toker314cc812014-01-25 16:55:45 +00002103 assert(CGM.getContext().getCanonicalType(Method->getReturnType()) ==
2104 CGM.getContext().getCanonicalType(ResultType) &&
Anders Carlsson280e61f12010-06-21 20:59:55 +00002105 "Result type mismatch!");
2106
John McCall1e3157b2015-09-10 22:27:50 +00002107 bool ReceiverCanBeNull = true;
2108
2109 // Super dispatch assumes that self is non-null; even the messenger
2110 // doesn't have a null check internally.
2111 if (IsSuper) {
2112 ReceiverCanBeNull = false;
2113
2114 // If this is a direct dispatch of a class method, check whether the class,
2115 // or anything in its hierarchy, was weak-linked.
2116 } else if (ClassReceiver && Method && Method->isClassMethod()) {
2117 ReceiverCanBeNull = isWeakLinkedClass(ClassReceiver);
2118
2119 // If we're emitting a method, and self is const (meaning just ARC, for now),
2120 // and the receiver is a load of self, then self is a valid object.
2121 } else if (auto CurMethod =
2122 dyn_cast_or_null<ObjCMethodDecl>(CGF.CurCodeDecl)) {
2123 auto Self = CurMethod->getSelfDecl();
2124 if (Self->getType().isConstQualified()) {
2125 if (auto LI = dyn_cast<llvm::LoadInst>(Arg0->stripPointerCasts())) {
2126 llvm::Value *SelfAddr = CGF.GetAddrOfLocalVar(Self).getPointer();
2127 if (SelfAddr == LI->getPointerOperand()) {
2128 ReceiverCanBeNull = false;
2129 }
2130 }
2131 }
2132 }
2133
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002134 bool RequiresNullCheck = false;
John McCall5880fb82011-05-14 21:12:11 +00002135
James Y Knight9871db02019-02-05 16:42:33 +00002136 llvm::FunctionCallee Fn = nullptr;
Tim Northovere77cc392014-03-29 13:28:05 +00002137 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002138 if (ReceiverCanBeNull) RequiresNullCheck = true;
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00002139 Fn = (ObjCABI == 2) ? ObjCTypes.getSendStretFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002140 : ObjCTypes.getSendStretFn(IsSuper);
Daniel Dunbar6f2e8392010-07-14 23:39:36 +00002141 } else if (CGM.ReturnTypeUsesFPRet(ResultType)) {
2142 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFpretFn2(IsSuper)
2143 : ObjCTypes.getSendFpretFn(IsSuper);
Anders Carlsson2f1a6c32011-10-31 16:27:11 +00002144 } else if (CGM.ReturnTypeUsesFP2Ret(ResultType)) {
2145 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFp2RetFn2(IsSuper)
2146 : ObjCTypes.getSendFp2retFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00002147 } else {
Tim Northovere77cc392014-03-29 13:28:05 +00002148 // arm64 uses objc_msgSend for stret methods and yet null receiver check
2149 // must be made for it.
Ahmed Bougachaa3df87b2015-10-02 22:41:59 +00002150 if (ReceiverCanBeNull && CGM.ReturnTypeUsesSRet(MSI.CallInfo))
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002151 RequiresNullCheck = true;
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00002152 Fn = (ObjCABI == 2) ? ObjCTypes.getSendFn2(IsSuper)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002153 : ObjCTypes.getSendFn(IsSuper);
Daniel Dunbar3c683f5b2008-10-17 03:24:53 +00002154 }
John McCall1e3157b2015-09-10 22:27:50 +00002155
James Y Knight9871db02019-02-05 16:42:33 +00002156 // Cast function to proper signature
2157 llvm::Constant *BitcastFn = cast<llvm::Constant>(
2158 CGF.Builder.CreateBitCast(Fn.getCallee(), MSI.MessengerType));
2159
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002160 // We don't need to emit a null check to zero out an indirect result if the
2161 // result is ignored.
2162 if (Return.isUnused())
2163 RequiresNullCheck = false;
2164
John McCall1e3157b2015-09-10 22:27:50 +00002165 // Emit a null-check if there's a consumed argument other than the receiver.
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002166 if (!RequiresNullCheck && CGM.getLangOpts().ObjCAutoRefCount && Method) {
David Majnemer59f77922016-06-24 04:05:48 +00002167 for (const auto *ParamDecl : Method->parameters()) {
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00002168 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
John McCall1e3157b2015-09-10 22:27:50 +00002169 RequiresNullCheck = true;
Fariborz Jahanianf2bda692012-01-30 21:40:37 +00002170 break;
2171 }
2172 }
John McCall1e3157b2015-09-10 22:27:50 +00002173 }
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002174
2175 NullReturnState nullReturn;
2176 if (RequiresNullCheck) {
2177 nullReturn.init(CGF, Arg0);
2178 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002179
James Y Knight3933add2019-01-30 02:54:28 +00002180 llvm::CallBase *CallSite;
James Y Knight9871db02019-02-05 16:42:33 +00002181 CGCallee Callee = CGCallee::forDirect(BitcastFn);
John McCallb92ab1a2016-10-26 23:46:34 +00002182 RValue rvalue = CGF.EmitCall(MSI.CallInfo, Callee, Return, ActualArgs,
2183 &CallSite);
John McCall1e3157b2015-09-10 22:27:50 +00002184
2185 // Mark the call as noreturn if the method is marked noreturn and the
2186 // receiver cannot be null.
2187 if (Method && Method->hasAttr<NoReturnAttr>() && !ReceiverCanBeNull) {
James Y Knight3933add2019-01-30 02:54:28 +00002188 CallSite->setDoesNotReturn();
John McCall1e3157b2015-09-10 22:27:50 +00002189 }
2190
Kuba Mracekbce5cea2017-06-30 16:28:15 +00002191 return nullReturn.complete(CGF, Return, rvalue, ResultType, CallArgs,
John McCall1e3157b2015-09-10 22:27:50 +00002192 RequiresNullCheck ? Method : nullptr);
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002193}
2194
John McCall3fd13f062015-10-21 18:06:47 +00002195static Qualifiers::GC GetGCAttrTypeForType(ASTContext &Ctx, QualType FQT,
2196 bool pointee = false) {
2197 // Note that GC qualification applies recursively to C pointer types
2198 // that aren't otherwise decorated. This is weird, but it's probably
2199 // an intentional workaround to the unreliable placement of GC qualifiers.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002200 if (FQT.isObjCGCStrong())
2201 return Qualifiers::Strong;
John McCall3fd13f062015-10-21 18:06:47 +00002202
2203 if (FQT.isObjCGCWeak())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002204 return Qualifiers::Weak;
John McCall3fd13f062015-10-21 18:06:47 +00002205
2206 if (auto ownership = FQT.getObjCLifetime()) {
2207 // Ownership does not apply recursively to C pointer types.
2208 if (pointee) return Qualifiers::GCNone;
2209 switch (ownership) {
2210 case Qualifiers::OCL_Weak: return Qualifiers::Weak;
2211 case Qualifiers::OCL_Strong: return Qualifiers::Strong;
2212 case Qualifiers::OCL_ExplicitNone: return Qualifiers::GCNone;
2213 case Qualifiers::OCL_Autoreleasing: llvm_unreachable("autoreleasing ivar?");
2214 case Qualifiers::OCL_None: llvm_unreachable("known nonzero");
2215 }
2216 llvm_unreachable("bad objc ownership");
2217 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002218
John McCall3fd13f062015-10-21 18:06:47 +00002219 // Treat unqualified retainable pointers as strong.
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002220 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
2221 return Qualifiers::Strong;
Fangrui Song6907ce22018-07-30 19:24:48 +00002222
John McCall3fd13f062015-10-21 18:06:47 +00002223 // Walk into C pointer types, but only in GC.
2224 if (Ctx.getLangOpts().getGC() != LangOptions::NonGC) {
2225 if (const PointerType *PT = FQT->getAs<PointerType>())
2226 return GetGCAttrTypeForType(Ctx, PT->getPointeeType(), /*pointee*/ true);
2227 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002228
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002229 return Qualifiers::GCNone;
2230}
2231
John McCall3fd13f062015-10-21 18:06:47 +00002232namespace {
2233 struct IvarInfo {
2234 CharUnits Offset;
2235 uint64_t SizeInWords;
2236 IvarInfo(CharUnits offset, uint64_t sizeInWords)
2237 : Offset(offset), SizeInWords(sizeInWords) {}
2238
2239 // Allow sorting based on byte pos.
2240 bool operator<(const IvarInfo &other) const {
2241 return Offset < other.Offset;
2242 }
2243 };
2244
2245 /// A helper class for building GC layout strings.
2246 class IvarLayoutBuilder {
2247 CodeGenModule &CGM;
2248
2249 /// The start of the layout. Offsets will be relative to this value,
2250 /// and entries less than this value will be silently discarded.
2251 CharUnits InstanceBegin;
2252
2253 /// The end of the layout. Offsets will never exceed this value.
2254 CharUnits InstanceEnd;
2255
2256 /// Whether we're generating the strong layout or the weak layout.
2257 bool ForStrongLayout;
2258
2259 /// Whether the offsets in IvarsInfo might be out-of-order.
2260 bool IsDisordered = false;
2261
2262 llvm::SmallVector<IvarInfo, 8> IvarsInfo;
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002263
John McCall3fd13f062015-10-21 18:06:47 +00002264 public:
2265 IvarLayoutBuilder(CodeGenModule &CGM, CharUnits instanceBegin,
2266 CharUnits instanceEnd, bool forStrongLayout)
2267 : CGM(CGM), InstanceBegin(instanceBegin), InstanceEnd(instanceEnd),
2268 ForStrongLayout(forStrongLayout) {
2269 }
2270
2271 void visitRecord(const RecordType *RT, CharUnits offset);
2272
2273 template <class Iterator, class GetOffsetFn>
Fangrui Song6907ce22018-07-30 19:24:48 +00002274 void visitAggregate(Iterator begin, Iterator end,
John McCall3fd13f062015-10-21 18:06:47 +00002275 CharUnits aggrOffset,
2276 const GetOffsetFn &getOffset);
2277
2278 void visitField(const FieldDecl *field, CharUnits offset);
2279
2280 /// Add the layout of a block implementation.
2281 void visitBlock(const CGBlockInfo &blockInfo);
2282
2283 /// Is there any information for an interesting bitmap?
2284 bool hasBitmapData() const { return !IvarsInfo.empty(); }
2285
2286 llvm::Constant *buildBitmap(CGObjCCommonMac &CGObjC,
2287 llvm::SmallVectorImpl<unsigned char> &buffer);
2288
2289 static void dump(ArrayRef<unsigned char> buffer) {
2290 const unsigned char *s = buffer.data();
2291 for (unsigned i = 0, e = buffer.size(); i < e; i++)
2292 if (!(s[i] & 0xf0))
2293 printf("0x0%x%s", s[i], s[i] != 0 ? ", " : "");
2294 else
2295 printf("0x%x%s", s[i], s[i] != 0 ? ", " : "");
2296 printf("\n");
2297 }
2298 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00002299} // end anonymous namespace
John McCall3fd13f062015-10-21 18:06:47 +00002300
John McCall351762c2011-02-07 10:33:21 +00002301llvm::Constant *CGObjCCommonMac::BuildGCBlockLayout(CodeGenModule &CGM,
2302 const CGBlockInfo &blockInfo) {
Fangrui Song6907ce22018-07-30 19:24:48 +00002303
Chris Lattnerece04092012-02-07 00:39:47 +00002304 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
John McCall460ce582015-10-22 18:38:17 +00002305 if (CGM.getLangOpts().getGC() == LangOptions::NonGC)
John McCall351762c2011-02-07 10:33:21 +00002306 return nullPtr;
2307
John McCall3fd13f062015-10-21 18:06:47 +00002308 IvarLayoutBuilder builder(CGM, CharUnits::Zero(), blockInfo.BlockSize,
2309 /*for strong layout*/ true);
2310
2311 builder.visitBlock(blockInfo);
2312
2313 if (!builder.hasBitmapData())
2314 return nullPtr;
2315
2316 llvm::SmallVector<unsigned char, 32> buffer;
2317 llvm::Constant *C = builder.buildBitmap(*this, buffer);
John McCallf5ea0722015-10-29 23:36:14 +00002318 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
John McCall3fd13f062015-10-21 18:06:47 +00002319 printf("\n block variable layout for block: ");
2320 builder.dump(buffer);
2321 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002322
John McCall3fd13f062015-10-21 18:06:47 +00002323 return C;
2324}
2325
2326void IvarLayoutBuilder::visitBlock(const CGBlockInfo &blockInfo) {
Fariborz Jahaniancfddabf2010-09-09 00:21:45 +00002327 // __isa is the first field in block descriptor and must assume by runtime's
2328 // convention that it is GC'able.
John McCall3fd13f062015-10-21 18:06:47 +00002329 IvarsInfo.push_back(IvarInfo(CharUnits::Zero(), 1));
John McCall351762c2011-02-07 10:33:21 +00002330
2331 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
2332
John McCall351762c2011-02-07 10:33:21 +00002333 // Ignore the optional 'this' capture: C++ objects are not assumed
2334 // to be GC'ed.
2335
John McCall3fd13f062015-10-21 18:06:47 +00002336 CharUnits lastFieldOffset;
2337
John McCall351762c2011-02-07 10:33:21 +00002338 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002339 for (const auto &CI : blockDecl->captures()) {
2340 const VarDecl *variable = CI.getVariable();
John McCall351762c2011-02-07 10:33:21 +00002341 QualType type = variable->getType();
2342
2343 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
2344
2345 // Ignore constant captures.
2346 if (capture.isConstant()) continue;
2347
John McCall3fd13f062015-10-21 18:06:47 +00002348 CharUnits fieldOffset = capture.getOffset();
2349
2350 // Block fields are not necessarily ordered; if we detect that we're
2351 // adding them out-of-order, make sure we sort later.
2352 if (fieldOffset < lastFieldOffset)
2353 IsDisordered = true;
2354 lastFieldOffset = fieldOffset;
John McCall351762c2011-02-07 10:33:21 +00002355
2356 // __block variables are passed by their descriptor address.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002357 if (CI.isByRef()) {
John McCall3fd13f062015-10-21 18:06:47 +00002358 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
Fariborz Jahanian933c6722010-09-11 01:27:29 +00002359 continue;
John McCall351762c2011-02-07 10:33:21 +00002360 }
2361
2362 assert(!type->isArrayType() && "array variable should not be caught");
2363 if (const RecordType *record = type->getAs<RecordType>()) {
John McCall3fd13f062015-10-21 18:06:47 +00002364 visitRecord(record, fieldOffset);
Fariborz Jahanian903aba32010-08-05 21:00:25 +00002365 continue;
2366 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002367
John McCall351762c2011-02-07 10:33:21 +00002368 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), type);
John McCall351762c2011-02-07 10:33:21 +00002369
John McCall3fd13f062015-10-21 18:06:47 +00002370 if (GCAttr == Qualifiers::Strong) {
2371 assert(CGM.getContext().getTypeSize(type)
2372 == CGM.getTarget().getPointerWidth(0));
2373 IvarsInfo.push_back(IvarInfo(fieldOffset, /*size in words*/ 1));
2374 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00002375 }
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00002376}
2377
Fariborz Jahanian2c96d302012-11-04 18:19:40 +00002378/// getBlockCaptureLifetime - This routine returns life time of the captured
2379/// block variable for the purpose of block layout meta-data generation. FQT is
2380/// the type of the variable captured in the block.
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002381Qualifiers::ObjCLifetime CGObjCCommonMac::getBlockCaptureLifetime(QualType FQT,
2382 bool ByrefLayout) {
John McCall460ce582015-10-22 18:38:17 +00002383 // If it has an ownership qualifier, we're done.
2384 if (auto lifetime = FQT.getObjCLifetime())
2385 return lifetime;
2386
2387 // If it doesn't, and this is ARC, it has no ownership.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002388 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCall460ce582015-10-22 18:38:17 +00002389 return Qualifiers::OCL_None;
Fangrui Song6907ce22018-07-30 19:24:48 +00002390
John McCall460ce582015-10-22 18:38:17 +00002391 // In MRC, retainable pointers are owned by non-__block variables.
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002392 if (FQT->isObjCObjectPointerType() || FQT->isBlockPointerType())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002393 return ByrefLayout ? Qualifiers::OCL_ExplicitNone : Qualifiers::OCL_Strong;
Fangrui Song6907ce22018-07-30 19:24:48 +00002394
Fariborz Jahanian2dd78192012-11-02 22:51:18 +00002395 return Qualifiers::OCL_None;
2396}
2397
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002398void CGObjCCommonMac::UpdateRunSkipBlockVars(bool IsByref,
2399 Qualifiers::ObjCLifetime LifeTime,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002400 CharUnits FieldOffset,
2401 CharUnits FieldSize) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002402 // __block variables are passed by their descriptor address.
2403 if (IsByref)
2404 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_BYREF, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002405 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002406 else if (LifeTime == Qualifiers::OCL_Strong)
2407 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_STRONG, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002408 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002409 else if (LifeTime == Qualifiers::OCL_Weak)
2410 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_WEAK, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002411 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002412 else if (LifeTime == Qualifiers::OCL_ExplicitNone)
2413 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_UNRETAINED, FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002414 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002415 else
2416 RunSkipBlockVars.push_back(RUN_SKIP(BLOCK_LAYOUT_NON_OBJECT_BYTES,
2417 FieldOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002418 FieldSize));
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002419}
2420
2421void CGObjCCommonMac::BuildRCRecordLayout(const llvm::StructLayout *RecLayout,
2422 const RecordDecl *RD,
2423 ArrayRef<const FieldDecl*> RecFields,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002424 CharUnits BytePos, bool &HasUnion,
2425 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002426 bool IsUnion = (RD && RD->isUnion());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002427 CharUnits MaxUnionSize = CharUnits::Zero();
Craig Topper8a13c412014-05-21 05:09:00 +00002428 const FieldDecl *MaxField = nullptr;
2429 const FieldDecl *LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002430 CharUnits MaxFieldOffset = CharUnits::Zero();
2431 CharUnits LastBitfieldOrUnnamedOffset = CharUnits::Zero();
Fangrui Song6907ce22018-07-30 19:24:48 +00002432
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002433 if (RecFields.empty())
2434 return;
John McCallc8e01702013-04-16 22:48:15 +00002435 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fangrui Song6907ce22018-07-30 19:24:48 +00002436
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002437 for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
2438 const FieldDecl *Field = RecFields[i];
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002439 // Note that 'i' here is actually the field index inside RD of Field,
2440 // although this dependency is hidden.
2441 const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002442 CharUnits FieldOffset =
2443 CGM.getContext().toCharUnitsFromBits(RL.getFieldOffset(i));
Fangrui Song6907ce22018-07-30 19:24:48 +00002444
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002445 // Skip over unnamed or bitfields
2446 if (!Field->getIdentifier() || Field->isBitField()) {
2447 LastFieldBitfieldOrUnnamed = Field;
2448 LastBitfieldOrUnnamedOffset = FieldOffset;
2449 continue;
2450 }
Craig Topper8a13c412014-05-21 05:09:00 +00002451
2452 LastFieldBitfieldOrUnnamed = nullptr;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002453 QualType FQT = Field->getType();
2454 if (FQT->isRecordType() || FQT->isUnionType()) {
2455 if (FQT->isUnionType())
2456 HasUnion = true;
Fangrui Song6907ce22018-07-30 19:24:48 +00002457
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002458 BuildRCBlockVarRecordLayout(FQT->getAs<RecordType>(),
2459 BytePos + FieldOffset, HasUnion);
2460 continue;
2461 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002462
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002463 if (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2464 const ConstantArrayType *CArray =
2465 dyn_cast_or_null<ConstantArrayType>(Array);
2466 uint64_t ElCount = CArray->getSize().getZExtValue();
2467 assert(CArray && "only array with known element size is supported");
2468 FQT = CArray->getElementType();
2469 while (const ArrayType *Array = CGM.getContext().getAsArrayType(FQT)) {
2470 const ConstantArrayType *CArray =
2471 dyn_cast_or_null<ConstantArrayType>(Array);
2472 ElCount *= CArray->getSize().getZExtValue();
2473 FQT = CArray->getElementType();
2474 }
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002475 if (FQT->isRecordType() && ElCount) {
2476 int OldIndex = RunSkipBlockVars.size() - 1;
2477 const RecordType *RT = FQT->getAs<RecordType>();
2478 BuildRCBlockVarRecordLayout(RT, BytePos + FieldOffset,
2479 HasUnion);
Fangrui Song6907ce22018-07-30 19:24:48 +00002480
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002481 // Replicate layout information for each array element. Note that
2482 // one element is already done.
2483 uint64_t ElIx = 1;
2484 for (int FirstIndex = RunSkipBlockVars.size() - 1 ;ElIx < ElCount; ElIx++) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002485 CharUnits Size = CGM.getContext().getTypeSizeInChars(RT);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002486 for (int i = OldIndex+1; i <= FirstIndex; ++i)
2487 RunSkipBlockVars.push_back(
2488 RUN_SKIP(RunSkipBlockVars[i].opcode,
2489 RunSkipBlockVars[i].block_var_bytepos + Size*ElIx,
2490 RunSkipBlockVars[i].block_var_size));
2491 }
2492 continue;
2493 }
2494 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002495 CharUnits FieldSize = CGM.getContext().getTypeSizeInChars(Field->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002496 if (IsUnion) {
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002497 CharUnits UnionIvarSize = FieldSize;
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002498 if (UnionIvarSize > MaxUnionSize) {
2499 MaxUnionSize = UnionIvarSize;
2500 MaxField = Field;
2501 MaxFieldOffset = FieldOffset;
2502 }
2503 } else {
2504 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002505 getBlockCaptureLifetime(FQT, ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002506 BytePos + FieldOffset,
2507 FieldSize);
2508 }
2509 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002510
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002511 if (LastFieldBitfieldOrUnnamed) {
2512 if (LastFieldBitfieldOrUnnamed->isBitField()) {
2513 // Last field was a bitfield. Must update the info.
2514 uint64_t BitFieldSize
2515 = LastFieldBitfieldOrUnnamed->getBitWidthValue(CGM.getContext());
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002516 unsigned UnsSize = (BitFieldSize / ByteSizeInBits) +
Eli Friedman8cbca202012-11-06 22:15:52 +00002517 ((BitFieldSize % ByteSizeInBits) != 0);
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002518 CharUnits Size = CharUnits::fromQuantity(UnsSize);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002519 Size += LastBitfieldOrUnnamedOffset;
2520 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002521 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2522 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002523 BytePos + LastBitfieldOrUnnamedOffset,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002524 Size);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002525 } else {
2526 assert(!LastFieldBitfieldOrUnnamed->getIdentifier() &&"Expected unnamed");
2527 // Last field was unnamed. Must update skip info.
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002528 CharUnits FieldSize
2529 = CGM.getContext().getTypeSizeInChars(LastFieldBitfieldOrUnnamed->getType());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002530 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002531 getBlockCaptureLifetime(LastFieldBitfieldOrUnnamed->getType(),
2532 ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002533 BytePos + LastBitfieldOrUnnamedOffset,
2534 FieldSize);
2535 }
2536 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002537
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002538 if (MaxField)
2539 UpdateRunSkipBlockVars(false,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002540 getBlockCaptureLifetime(MaxField->getType(), ByrefLayout),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002541 BytePos + MaxFieldOffset,
2542 MaxUnionSize);
2543}
2544
2545void CGObjCCommonMac::BuildRCBlockVarRecordLayout(const RecordType *RT,
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002546 CharUnits BytePos,
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002547 bool &HasUnion,
2548 bool ByrefLayout) {
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002549 const RecordDecl *RD = RT->getDecl();
Aaron Ballman62e47c42014-03-10 13:43:55 +00002550 SmallVector<const FieldDecl*, 16> Fields(RD->fields());
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002551 llvm::Type *Ty = CGM.getTypes().ConvertType(QualType(RT, 0));
2552 const llvm::StructLayout *RecLayout =
2553 CGM.getDataLayout().getStructLayout(cast<llvm::StructType>(Ty));
Fangrui Song6907ce22018-07-30 19:24:48 +00002554
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002555 BuildRCRecordLayout(RecLayout, RD, Fields, BytePos, HasUnion, ByrefLayout);
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002556}
2557
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002558/// InlineLayoutInstruction - This routine produce an inline instruction for the
2559/// block variable layout if it can. If not, it returns 0. Rules are as follow:
2560/// If ((uintptr_t) layout) < (1 << 12), the layout is inline. In the 64bit world,
2561/// an inline layout of value 0x0000000000000xyz is interpreted as follows:
2562/// x captured object pointers of BLOCK_LAYOUT_STRONG. Followed by
2563/// y captured object of BLOCK_LAYOUT_BYREF. Followed by
2564/// z captured object of BLOCK_LAYOUT_WEAK. If any of the above is missing, zero
2565/// replaces it. For example, 0x00000x00 means x BLOCK_LAYOUT_STRONG and no
2566/// BLOCK_LAYOUT_BYREF and no BLOCK_LAYOUT_WEAK objects are captured.
2567uint64_t CGObjCCommonMac::InlineLayoutInstruction(
2568 SmallVectorImpl<unsigned char> &Layout) {
2569 uint64_t Result = 0;
2570 if (Layout.size() <= 3) {
2571 unsigned size = Layout.size();
2572 unsigned strong_word_count = 0, byref_word_count=0, weak_word_count=0;
2573 unsigned char inst;
2574 enum BLOCK_LAYOUT_OPCODE opcode ;
2575 switch (size) {
2576 case 3:
2577 inst = Layout[0];
2578 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2579 if (opcode == BLOCK_LAYOUT_STRONG)
2580 strong_word_count = (inst & 0xF)+1;
2581 else
2582 return 0;
2583 inst = Layout[1];
2584 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2585 if (opcode == BLOCK_LAYOUT_BYREF)
2586 byref_word_count = (inst & 0xF)+1;
2587 else
2588 return 0;
2589 inst = Layout[2];
2590 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2591 if (opcode == BLOCK_LAYOUT_WEAK)
2592 weak_word_count = (inst & 0xF)+1;
2593 else
2594 return 0;
2595 break;
Fangrui Song6907ce22018-07-30 19:24:48 +00002596
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002597 case 2:
2598 inst = Layout[0];
2599 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2600 if (opcode == BLOCK_LAYOUT_STRONG) {
2601 strong_word_count = (inst & 0xF)+1;
2602 inst = Layout[1];
2603 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2604 if (opcode == BLOCK_LAYOUT_BYREF)
2605 byref_word_count = (inst & 0xF)+1;
2606 else if (opcode == BLOCK_LAYOUT_WEAK)
2607 weak_word_count = (inst & 0xF)+1;
2608 else
2609 return 0;
2610 }
2611 else if (opcode == BLOCK_LAYOUT_BYREF) {
2612 byref_word_count = (inst & 0xF)+1;
2613 inst = Layout[1];
2614 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2615 if (opcode == BLOCK_LAYOUT_WEAK)
2616 weak_word_count = (inst & 0xF)+1;
2617 else
2618 return 0;
2619 }
2620 else
2621 return 0;
2622 break;
Fangrui Song6907ce22018-07-30 19:24:48 +00002623
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002624 case 1:
2625 inst = Layout[0];
2626 opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2627 if (opcode == BLOCK_LAYOUT_STRONG)
2628 strong_word_count = (inst & 0xF)+1;
2629 else if (opcode == BLOCK_LAYOUT_BYREF)
2630 byref_word_count = (inst & 0xF)+1;
2631 else if (opcode == BLOCK_LAYOUT_WEAK)
2632 weak_word_count = (inst & 0xF)+1;
2633 else
2634 return 0;
2635 break;
Fangrui Song6907ce22018-07-30 19:24:48 +00002636
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002637 default:
2638 return 0;
2639 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002640
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002641 // Cannot inline when any of the word counts is 15. Because this is one less
2642 // than the actual work count (so 15 means 16 actual word counts),
2643 // and we can only display 0 thru 15 word counts.
2644 if (strong_word_count == 16 || byref_word_count == 16 || weak_word_count == 16)
2645 return 0;
Fangrui Song6907ce22018-07-30 19:24:48 +00002646
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002647 unsigned count =
2648 (strong_word_count != 0) + (byref_word_count != 0) + (weak_word_count != 0);
Fangrui Song6907ce22018-07-30 19:24:48 +00002649
Fariborz Jahanian23290b02012-11-01 18:32:55 +00002650 if (size == count) {
2651 if (strong_word_count)
2652 Result = strong_word_count;
2653 Result <<= 4;
2654 if (byref_word_count)
2655 Result += byref_word_count;
2656 Result <<= 4;
2657 if (weak_word_count)
2658 Result += weak_word_count;
2659 }
2660 }
2661 return Result;
2662}
2663
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002664llvm::Constant *CGObjCCommonMac::getBitmapBlockLayout(bool ComputeByrefLayout) {
2665 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2666 if (RunSkipBlockVars.empty())
2667 return nullPtr;
John McCallc8e01702013-04-16 22:48:15 +00002668 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2669 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002670 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
Fangrui Song6907ce22018-07-30 19:24:48 +00002671
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002672 // Sort on byte position; captures might not be allocated in order,
2673 // and unions can do funny things.
2674 llvm::array_pod_sort(RunSkipBlockVars.begin(), RunSkipBlockVars.end());
2675 SmallVector<unsigned char, 16> Layout;
Fangrui Song6907ce22018-07-30 19:24:48 +00002676
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002677 unsigned size = RunSkipBlockVars.size();
2678 for (unsigned i = 0; i < size; i++) {
2679 enum BLOCK_LAYOUT_OPCODE opcode = RunSkipBlockVars[i].opcode;
2680 CharUnits start_byte_pos = RunSkipBlockVars[i].block_var_bytepos;
2681 CharUnits end_byte_pos = start_byte_pos;
2682 unsigned j = i+1;
2683 while (j < size) {
2684 if (opcode == RunSkipBlockVars[j].opcode) {
2685 end_byte_pos = RunSkipBlockVars[j++].block_var_bytepos;
2686 i++;
2687 }
2688 else
2689 break;
2690 }
2691 CharUnits size_in_bytes =
2692 end_byte_pos - start_byte_pos + RunSkipBlockVars[j-1].block_var_size;
2693 if (j < size) {
2694 CharUnits gap =
2695 RunSkipBlockVars[j].block_var_bytepos -
2696 RunSkipBlockVars[j-1].block_var_bytepos - RunSkipBlockVars[j-1].block_var_size;
2697 size_in_bytes += gap;
2698 }
2699 CharUnits residue_in_bytes = CharUnits::Zero();
2700 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES) {
2701 residue_in_bytes = size_in_bytes % WordSizeInBytes;
2702 size_in_bytes -= residue_in_bytes;
2703 opcode = BLOCK_LAYOUT_NON_OBJECT_WORDS;
2704 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002705
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002706 unsigned size_in_words = size_in_bytes.getQuantity() / WordSizeInBytes;
2707 while (size_in_words >= 16) {
2708 // Note that value in imm. is one less that the actual
2709 // value. So, 0xf means 16 words follow!
2710 unsigned char inst = (opcode << 4) | 0xf;
2711 Layout.push_back(inst);
2712 size_in_words -= 16;
2713 }
2714 if (size_in_words > 0) {
2715 // Note that value in imm. is one less that the actual
2716 // value. So, we subtract 1 away!
2717 unsigned char inst = (opcode << 4) | (size_in_words-1);
2718 Layout.push_back(inst);
2719 }
2720 if (residue_in_bytes > CharUnits::Zero()) {
2721 unsigned char inst =
2722 (BLOCK_LAYOUT_NON_OBJECT_BYTES << 4) | (residue_in_bytes.getQuantity()-1);
2723 Layout.push_back(inst);
2724 }
2725 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002726
John McCall7f416cc2015-09-08 08:05:57 +00002727 while (!Layout.empty()) {
2728 unsigned char inst = Layout.back();
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002729 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2730 if (opcode == BLOCK_LAYOUT_NON_OBJECT_BYTES || opcode == BLOCK_LAYOUT_NON_OBJECT_WORDS)
2731 Layout.pop_back();
2732 else
2733 break;
2734 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002735
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002736 uint64_t Result = InlineLayoutInstruction(Layout);
2737 if (Result != 0) {
2738 // Block variable layout instruction has been inlined.
2739 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2740 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002741 printf("\n Inline BYREF variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002742 else
John McCall7f416cc2015-09-08 08:05:57 +00002743 printf("\n Inline block variable layout: ");
2744 printf("0x0%" PRIx64 "", Result);
2745 if (auto numStrong = (Result & 0xF00) >> 8)
2746 printf(", BL_STRONG:%d", (int) numStrong);
2747 if (auto numByref = (Result & 0x0F0) >> 4)
2748 printf(", BL_BYREF:%d", (int) numByref);
2749 if (auto numWeak = (Result & 0x00F) >> 0)
2750 printf(", BL_WEAK:%d", (int) numWeak);
2751 printf(", BL_OPERATOR:0\n");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002752 }
Vedant Kumar3ed0df02015-12-21 19:43:25 +00002753 return llvm::ConstantInt::get(CGM.IntPtrTy, Result);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002754 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002755
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002756 unsigned char inst = (BLOCK_LAYOUT_OPERATOR << 4) | 0;
2757 Layout.push_back(inst);
2758 std::string BitMap;
2759 for (unsigned i = 0, e = Layout.size(); i != e; i++)
2760 BitMap += Layout[i];
Fangrui Song6907ce22018-07-30 19:24:48 +00002761
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002762 if (CGM.getLangOpts().ObjCGCBitmapPrint) {
2763 if (ComputeByrefLayout)
John McCall7f416cc2015-09-08 08:05:57 +00002764 printf("\n Byref variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002765 else
John McCall7f416cc2015-09-08 08:05:57 +00002766 printf("\n Block variable layout: ");
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002767 for (unsigned i = 0, e = BitMap.size(); i != e; i++) {
2768 unsigned char inst = BitMap[i];
2769 enum BLOCK_LAYOUT_OPCODE opcode = (enum BLOCK_LAYOUT_OPCODE) (inst >> 4);
2770 unsigned delta = 1;
2771 switch (opcode) {
2772 case BLOCK_LAYOUT_OPERATOR:
2773 printf("BL_OPERATOR:");
2774 delta = 0;
2775 break;
2776 case BLOCK_LAYOUT_NON_OBJECT_BYTES:
2777 printf("BL_NON_OBJECT_BYTES:");
2778 break;
2779 case BLOCK_LAYOUT_NON_OBJECT_WORDS:
2780 printf("BL_NON_OBJECT_WORD:");
2781 break;
2782 case BLOCK_LAYOUT_STRONG:
2783 printf("BL_STRONG:");
2784 break;
2785 case BLOCK_LAYOUT_BYREF:
2786 printf("BL_BYREF:");
2787 break;
2788 case BLOCK_LAYOUT_WEAK:
2789 printf("BL_WEAK:");
2790 break;
2791 case BLOCK_LAYOUT_UNRETAINED:
2792 printf("BL_UNRETAINED:");
2793 break;
2794 }
2795 // Actual value of word count is one more that what is in the imm.
2796 // field of the instruction
2797 printf("%d", (inst & 0xf) + delta);
2798 if (i < e-1)
2799 printf(", ");
2800 else
2801 printf("\n");
2802 }
2803 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00002804
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00002805 auto *Entry = CreateCStringLiteral(BitMap, ObjCLabelType::ClassName,
2806 /*ForceNonFragileABI=*/true,
2807 /*NullTerminate=*/false);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002808 return getConstantGEP(VMContext, Entry, 0, 0);
2809}
2810
Akira Hatanaka2ec36f02018-08-17 15:46:07 +00002811static std::string getBlockLayoutInfoString(
2812 const SmallVectorImpl<CGObjCCommonMac::RUN_SKIP> &RunSkipBlockVars,
2813 bool HasCopyDisposeHelpers) {
2814 std::string Str;
2815 for (const CGObjCCommonMac::RUN_SKIP &R : RunSkipBlockVars) {
2816 if (R.opcode == CGObjCCommonMac::BLOCK_LAYOUT_UNRETAINED) {
2817 // Copy/dispose helpers don't have any information about
2818 // __unsafe_unretained captures, so unconditionally concatenate a string.
2819 Str += "u";
2820 } else if (HasCopyDisposeHelpers) {
2821 // Information about __strong, __weak, or byref captures has already been
2822 // encoded into the names of the copy/dispose helpers. We have to add a
2823 // string here only when the copy/dispose helpers aren't generated (which
2824 // happens when the block is non-escaping).
2825 continue;
2826 } else {
2827 switch (R.opcode) {
2828 case CGObjCCommonMac::BLOCK_LAYOUT_STRONG:
2829 Str += "s";
2830 break;
2831 case CGObjCCommonMac::BLOCK_LAYOUT_BYREF:
2832 Str += "r";
2833 break;
2834 case CGObjCCommonMac::BLOCK_LAYOUT_WEAK:
2835 Str += "w";
2836 break;
2837 default:
2838 continue;
2839 }
2840 }
2841 Str += llvm::to_string(R.block_var_bytepos.getQuantity());
2842 Str += "l" + llvm::to_string(R.block_var_size.getQuantity());
2843 }
2844 return Str;
2845}
2846
2847void CGObjCCommonMac::fillRunSkipBlockVars(CodeGenModule &CGM,
2848 const CGBlockInfo &blockInfo) {
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002849 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
Fangrui Song6907ce22018-07-30 19:24:48 +00002850
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002851 RunSkipBlockVars.clear();
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002852 bool hasUnion = false;
Fangrui Song6907ce22018-07-30 19:24:48 +00002853
John McCallc8e01702013-04-16 22:48:15 +00002854 unsigned WordSizeInBits = CGM.getTarget().getPointerWidth(0);
2855 unsigned ByteSizeInBits = CGM.getTarget().getCharWidth();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002856 unsigned WordSizeInBytes = WordSizeInBits/ByteSizeInBits;
Fangrui Song6907ce22018-07-30 19:24:48 +00002857
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002858 const BlockDecl *blockDecl = blockInfo.getBlockDecl();
Fangrui Song6907ce22018-07-30 19:24:48 +00002859
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002860 // Calculate the basic layout of the block structure.
2861 const llvm::StructLayout *layout =
2862 CGM.getDataLayout().getStructLayout(blockInfo.StructureType);
Fangrui Song6907ce22018-07-30 19:24:48 +00002863
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002864 // Ignore the optional 'this' capture: C++ objects are not assumed
2865 // to be GC'ed.
Fariborz Jahanian4cf177e2012-12-04 17:20:57 +00002866 if (blockInfo.BlockHeaderForcedGapSize != CharUnits::Zero())
2867 UpdateRunSkipBlockVars(false, Qualifiers::OCL_None,
2868 blockInfo.BlockHeaderForcedGapOffset,
2869 blockInfo.BlockHeaderForcedGapSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002870 // Walk the captured variables.
Aaron Ballman9371dd22014-03-14 18:34:04 +00002871 for (const auto &CI : blockDecl->captures()) {
2872 const VarDecl *variable = CI.getVariable();
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002873 QualType type = variable->getType();
Fangrui Song6907ce22018-07-30 19:24:48 +00002874
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002875 const CGBlockInfo::Capture &capture = blockInfo.getCapture(variable);
Fangrui Song6907ce22018-07-30 19:24:48 +00002876
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002877 // Ignore constant captures.
2878 if (capture.isConstant()) continue;
Fangrui Song6907ce22018-07-30 19:24:48 +00002879
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002880 CharUnits fieldOffset =
2881 CharUnits::fromQuantity(layout->getElementOffset(capture.getIndex()));
Fangrui Song6907ce22018-07-30 19:24:48 +00002882
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002883 assert(!type->isArrayType() && "array variable should not be caught");
Aaron Ballman9371dd22014-03-14 18:34:04 +00002884 if (!CI.isByRef())
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002885 if (const RecordType *record = type->getAs<RecordType>()) {
2886 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion);
2887 continue;
2888 }
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002889 CharUnits fieldSize;
Aaron Ballman9371dd22014-03-14 18:34:04 +00002890 if (CI.isByRef())
Fariborz Jahanian7778d612012-11-07 20:00:32 +00002891 fieldSize = CharUnits::fromQuantity(WordSizeInBytes);
2892 else
2893 fieldSize = CGM.getContext().getTypeSizeInChars(type);
Aaron Ballman9371dd22014-03-14 18:34:04 +00002894 UpdateRunSkipBlockVars(CI.isByRef(), getBlockCaptureLifetime(type, false),
Fariborz Jahanian39319c42012-10-30 20:05:29 +00002895 fieldOffset, fieldSize);
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002896 }
Akira Hatanaka2ec36f02018-08-17 15:46:07 +00002897}
2898
2899llvm::Constant *
2900CGObjCCommonMac::BuildRCBlockLayout(CodeGenModule &CGM,
2901 const CGBlockInfo &blockInfo) {
2902 fillRunSkipBlockVars(CGM, blockInfo);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002903 return getBitmapBlockLayout(false);
2904}
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002905
Akira Hatanaka2ec36f02018-08-17 15:46:07 +00002906std::string CGObjCCommonMac::getRCBlockLayoutStr(CodeGenModule &CGM,
2907 const CGBlockInfo &blockInfo) {
2908 fillRunSkipBlockVars(CGM, blockInfo);
2909 return getBlockLayoutInfoString(RunSkipBlockVars,
2910 blockInfo.needsCopyDisposeHelpers());
2911}
2912
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002913llvm::Constant *CGObjCCommonMac::BuildByrefLayout(CodeGen::CodeGenModule &CGM,
2914 QualType T) {
2915 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
2916 assert(!T->isArrayType() && "__block array variable should not be caught");
2917 CharUnits fieldOffset;
2918 RunSkipBlockVars.clear();
2919 bool hasUnion = false;
2920 if (const RecordType *record = T->getAs<RecordType>()) {
2921 BuildRCBlockVarRecordLayout(record, fieldOffset, hasUnion, true /*ByrefLayout */);
2922 llvm::Constant *Result = getBitmapBlockLayout(true);
Vedant Kumar2f5bb1152015-12-21 20:21:15 +00002923 if (isa<llvm::ConstantInt>(Result))
2924 Result = llvm::ConstantExpr::getIntToPtr(Result, CGM.Int8PtrTy);
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002925 return Result;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002926 }
Fariborz Jahaniana9d44642012-11-14 17:15:51 +00002927 llvm::Constant *nullPtr = llvm::Constant::getNullValue(CGM.Int8PtrTy);
2928 return nullPtr;
Fariborz Jahanian0c58ce92012-10-27 21:10:38 +00002929}
2930
John McCall882987f2013-02-28 19:01:20 +00002931llvm::Value *CGObjCMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar89da6ad2008-08-13 00:59:25 +00002932 const ObjCProtocolDecl *PD) {
Daniel Dunbar7050c552008-09-04 04:33:15 +00002933 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00002934 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbar7050c552008-09-04 04:33:15 +00002935 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
2936
Owen Andersonade90fd2009-07-29 18:54:39 +00002937 return llvm::ConstantExpr::getBitCast(GetProtocolRef(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00002938 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar303e2c22008-08-11 02:45:11 +00002939}
2940
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002941void CGObjCCommonMac::GenerateProtocol(const ObjCProtocolDecl *PD) {
Mike Stump18bb9282009-05-16 07:57:57 +00002942 // FIXME: We shouldn't need this, the protocol decl should contain enough
2943 // information to tell us whether this was a declaration or a definition.
Daniel Dunbarc475d422008-10-29 22:36:39 +00002944 DefinedProtocols.insert(PD->getIdentifier());
2945
2946 // If we have generated a forward reference to this protocol, emit
2947 // it now. Otherwise do nothing, the protocol objects are lazily
2948 // emitted.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002949 if (Protocols.count(PD->getIdentifier()))
Daniel Dunbarc475d422008-10-29 22:36:39 +00002950 GetOrEmitProtocol(PD);
2951}
2952
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00002953llvm::Constant *CGObjCCommonMac::GetProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00002954 if (DefinedProtocols.count(PD->getIdentifier()))
2955 return GetOrEmitProtocol(PD);
Fangrui Song6907ce22018-07-30 19:24:48 +00002956
Daniel Dunbarc475d422008-10-29 22:36:39 +00002957 return GetOrEmitProtocolRef(PD);
2958}
2959
Douglas Gregor24ae22c2016-04-01 23:23:52 +00002960llvm::Value *CGObjCCommonMac::EmitClassRefViaRuntime(
2961 CodeGenFunction &CGF,
2962 const ObjCInterfaceDecl *ID,
2963 ObjCCommonTypesHelper &ObjCTypes) {
James Y Knight9871db02019-02-05 16:42:33 +00002964 llvm::FunctionCallee lookUpClassFn = ObjCTypes.getLookUpClassFn();
Douglas Gregor24ae22c2016-04-01 23:23:52 +00002965
2966 llvm::Value *className =
2967 CGF.CGM.GetAddrOfConstantCString(ID->getObjCRuntimeNameAsString())
2968 .getPointer();
2969 ASTContext &ctx = CGF.CGM.getContext();
2970 className =
2971 CGF.Builder.CreateBitCast(className,
2972 CGF.ConvertType(
2973 ctx.getPointerType(ctx.CharTy.withConst())));
2974 llvm::CallInst *call = CGF.Builder.CreateCall(lookUpClassFn, className);
2975 call->setDoesNotThrow();
2976 return call;
2977}
2978
Daniel Dunbarb036db82008-08-13 03:21:16 +00002979/*
Rafael Espindolaf9e1e5e2014-02-20 14:09:04 +00002980// Objective-C 1.0 extensions
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002981struct _objc_protocol {
2982struct _objc_protocol_extension *isa;
2983char *protocol_name;
2984struct _objc_protocol_list *protocol_list;
2985struct _objc__method_prototype_list *instance_methods;
2986struct _objc__method_prototype_list *class_methods
2987};
Daniel Dunbarb036db82008-08-13 03:21:16 +00002988
Daniel Dunbar59e476b2009-08-03 17:06:42 +00002989See EmitProtocolExtension().
Daniel Dunbarb036db82008-08-13 03:21:16 +00002990*/
Daniel Dunbarc475d422008-10-29 22:36:39 +00002991llvm::Constant *CGObjCMac::GetOrEmitProtocol(const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00002992 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbarc475d422008-10-29 22:36:39 +00002993
2994 // Early exit if a defining object has already been generated.
2995 if (Entry && Entry->hasInitializer())
2996 return Entry;
2997
Douglas Gregora715bff2012-01-01 19:51:50 +00002998 // Use the protocol definition, if there is one.
2999 if (const ObjCProtocolDecl *Def = PD->getDefinition())
3000 PD = Def;
3001
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003002 // FIXME: I don't understand why gcc generates this, or where it is
Mike Stump18bb9282009-05-16 07:57:57 +00003003 // resolved. Investigate. Its also wasteful to look this up over and over.
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003004 LazySymbols.insert(&CGM.getContext().Idents.get("Protocol"));
3005
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003006 // Construct method lists.
John McCall176f8922016-11-30 02:39:18 +00003007 auto methodLists = ProtocolMethodLists::get(PD);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003008
John McCall176f8922016-11-30 02:39:18 +00003009 ConstantInitBuilder builder(CGM);
3010 auto values = builder.beginStruct(ObjCTypes.ProtocolTy);
3011 values.add(EmitProtocolExtension(PD, methodLists));
3012 values.add(GetClassName(PD->getObjCRuntimeNameAsString()));
3013 values.add(EmitProtocolList("OBJC_PROTOCOL_REFS_" + PD->getName(),
3014 PD->protocol_begin(), PD->protocol_end()));
3015 values.add(methodLists.emitMethodList(this, PD,
3016 ProtocolMethodLists::RequiredInstanceMethods));
3017 values.add(methodLists.emitMethodList(this, PD,
3018 ProtocolMethodLists::RequiredClassMethods));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003019
Daniel Dunbarb036db82008-08-13 03:21:16 +00003020 if (Entry) {
Rafael Espindola5d117f32014-03-06 01:10:46 +00003021 // Already created, update the initializer.
Rafael Espindolab3262952014-05-09 00:43:37 +00003022 assert(Entry->hasPrivateLinkage());
John McCall176f8922016-11-30 02:39:18 +00003023 values.finishAndSetAsInitializer(Entry);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003024 } else {
John McCall176f8922016-11-30 02:39:18 +00003025 Entry = values.finishAndCreateGlobal("OBJC_PROTOCOL_" + PD->getName(),
3026 CGM.getPointerAlign(),
3027 /*constant*/ false,
3028 llvm::GlobalValue::PrivateLinkage);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003029 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
John McCallf9582a72012-03-30 21:29:05 +00003030
3031 Protocols[PD->getIdentifier()] = Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00003032 }
Rafael Espindola060062a2014-03-06 22:15:10 +00003033 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbarc475d422008-10-29 22:36:39 +00003034
3035 return Entry;
Daniel Dunbarb036db82008-08-13 03:21:16 +00003036}
3037
Daniel Dunbarc475d422008-10-29 22:36:39 +00003038llvm::Constant *CGObjCMac::GetOrEmitProtocolRef(const ObjCProtocolDecl *PD) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00003039 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
3040
3041 if (!Entry) {
Daniel Dunbarc475d422008-10-29 22:36:39 +00003042 // We use the initializer as a marker of whether this is a forward
3043 // reference or not. At module finalization we add the empty
3044 // contents for protocols which were referenced but never defined.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003045 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolTy,
3046 false, llvm::GlobalValue::PrivateLinkage,
3047 nullptr, "OBJC_PROTOCOL_" + PD->getName());
Daniel Dunbarb036db82008-08-13 03:21:16 +00003048 Entry->setSection("__OBJC,__protocol,regular,no_dead_strip");
Daniel Dunbarb036db82008-08-13 03:21:16 +00003049 // FIXME: Is this necessary? Why only for protocol?
3050 Entry->setAlignment(4);
3051 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003052
Daniel Dunbarb036db82008-08-13 03:21:16 +00003053 return Entry;
3054}
3055
3056/*
3057 struct _objc_protocol_extension {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003058 uint32_t size;
3059 struct objc_method_description_list *optional_instance_methods;
3060 struct objc_method_description_list *optional_class_methods;
3061 struct objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003062 const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00003063 struct objc_property_list *class_properties;
Daniel Dunbarb036db82008-08-13 03:21:16 +00003064 };
3065*/
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003066llvm::Constant *
3067CGObjCMac::EmitProtocolExtension(const ObjCProtocolDecl *PD,
John McCall176f8922016-11-30 02:39:18 +00003068 const ProtocolMethodLists &methodLists) {
3069 auto optInstanceMethods =
3070 methodLists.emitMethodList(this, PD,
3071 ProtocolMethodLists::OptionalInstanceMethods);
3072 auto optClassMethods =
3073 methodLists.emitMethodList(this, PD,
3074 ProtocolMethodLists::OptionalClassMethods);
3075
3076 auto extendedMethodTypes =
3077 EmitProtocolMethodTypes("OBJC_PROTOCOL_METHOD_TYPES_" + PD->getName(),
3078 methodLists.emitExtendedTypesArray(this),
3079 ObjCTypes);
3080
3081 auto instanceProperties =
3082 EmitPropertyList("OBJC_$_PROP_PROTO_LIST_" + PD->getName(), nullptr, PD,
3083 ObjCTypes, false);
3084 auto classProperties =
3085 EmitPropertyList("OBJC_$_CLASS_PROP_PROTO_LIST_" + PD->getName(), nullptr,
3086 PD, ObjCTypes, true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003087
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003088 // Return null if no extension bits are used.
John McCall176f8922016-11-30 02:39:18 +00003089 if (optInstanceMethods->isNullValue() &&
3090 optClassMethods->isNullValue() &&
3091 extendedMethodTypes->isNullValue() &&
3092 instanceProperties->isNullValue() &&
3093 classProperties->isNullValue()) {
Owen Anderson0b75f232009-07-31 20:28:54 +00003094 return llvm::Constant::getNullValue(ObjCTypes.ProtocolExtensionPtrTy);
John McCall176f8922016-11-30 02:39:18 +00003095 }
Daniel Dunbarb036db82008-08-13 03:21:16 +00003096
John McCall176f8922016-11-30 02:39:18 +00003097 uint64_t size =
3098 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolExtensionTy);
3099
3100 ConstantInitBuilder builder(CGM);
3101 auto values = builder.beginStruct(ObjCTypes.ProtocolExtensionTy);
3102 values.addInt(ObjCTypes.IntTy, size);
3103 values.add(optInstanceMethods);
3104 values.add(optClassMethods);
3105 values.add(instanceProperties);
3106 values.add(extendedMethodTypes);
3107 values.add(classProperties);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003108
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003109 // No special section, but goes in llvm.used
John McCall176f8922016-11-30 02:39:18 +00003110 return CreateMetadataVar("\01l_OBJC_PROTOCOLEXT_" + PD->getName(), values,
John McCall7f416cc2015-09-08 08:05:57 +00003111 StringRef(), CGM.getPointerAlign(), true);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003112}
3113
3114/*
3115 struct objc_protocol_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00003116 struct objc_protocol_list *next;
3117 long count;
3118 Protocol *list[];
Daniel Dunbarb036db82008-08-13 03:21:16 +00003119 };
3120*/
Daniel Dunbardec75f82008-08-21 21:57:41 +00003121llvm::Constant *
Zachary Turner41a9ee92017-10-11 23:54:34 +00003122CGObjCMac::EmitProtocolList(Twine name,
Daniel Dunbardec75f82008-08-21 21:57:41 +00003123 ObjCProtocolDecl::protocol_iterator begin,
3124 ObjCProtocolDecl::protocol_iterator end) {
Daniel Dunbarb036db82008-08-13 03:21:16 +00003125 // Just return null for empty protocol lists
John McCall176f8922016-11-30 02:39:18 +00003126 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00003127 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003128
John McCall176f8922016-11-30 02:39:18 +00003129 ConstantInitBuilder builder(CGM);
3130 auto values = builder.beginStruct();
Daniel Dunbarb036db82008-08-13 03:21:16 +00003131
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003132 // This field is only used by the runtime.
John McCall176f8922016-11-30 02:39:18 +00003133 values.addNullPointer(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003134
John McCall176f8922016-11-30 02:39:18 +00003135 // Reserve a slot for the count.
3136 auto countSlot = values.addPlaceholder();
3137
3138 auto refsArray = values.beginArray(ObjCTypes.ProtocolPtrTy);
3139 for (; begin != end; ++begin) {
3140 refsArray.add(GetProtocolRef(*begin));
3141 }
3142 auto count = refsArray.size();
3143
3144 // This list is null terminated.
3145 refsArray.addNullPointer(ObjCTypes.ProtocolPtrTy);
3146
3147 refsArray.finishAndAddTo(values);
3148 values.fillPlaceholderWithInt(countSlot, ObjCTypes.LongTy, count);
3149
3150 StringRef section;
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003151 if (CGM.getTriple().isOSBinFormatMachO())
John McCall176f8922016-11-30 02:39:18 +00003152 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003153
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003154 llvm::GlobalVariable *GV =
Zachary Turner41a9ee92017-10-11 23:54:34 +00003155 CreateMetadataVar(name, values, section, CGM.getPointerAlign(), false);
Owen Andersonade90fd2009-07-29 18:54:39 +00003156 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00003157}
3158
Fangrui Song6907ce22018-07-30 19:24:48 +00003159static void
Bill Wendlingcb5b5ff2012-02-07 09:25:09 +00003160PushProtocolProperties(llvm::SmallPtrSet<const IdentifierInfo*,16> &PropertySet,
John McCall176f8922016-11-30 02:39:18 +00003161 SmallVectorImpl<const ObjCPropertyDecl *> &Properties,
Aaron Ballmandc4bea42014-03-13 18:47:37 +00003162 const ObjCProtocolDecl *Proto,
Manman Renad0e7912016-01-29 19:22:54 +00003163 bool IsClassProperty) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003164 for (const auto *P : Proto->protocols())
John McCall176f8922016-11-30 02:39:18 +00003165 PushProtocolProperties(PropertySet, Properties, P, IsClassProperty);
Manman Renad0e7912016-01-29 19:22:54 +00003166
3167 for (const auto *PD : Proto->properties()) {
3168 if (IsClassProperty != PD->isClassProperty())
3169 continue;
David Blaikie82e95a32014-11-19 07:49:47 +00003170 if (!PropertySet.insert(PD->getIdentifier()).second)
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00003171 continue;
John McCall176f8922016-11-30 02:39:18 +00003172 Properties.push_back(PD);
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00003173 }
3174}
3175
Daniel Dunbarb036db82008-08-13 03:21:16 +00003176/*
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003177 struct _objc_property {
Bill Wendlinga515b582012-02-09 22:16:49 +00003178 const char * const name;
3179 const char * const attributes;
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003180 };
3181
3182 struct _objc_property_list {
Bill Wendlinga515b582012-02-09 22:16:49 +00003183 uint32_t entsize; // sizeof (struct _objc_property)
3184 uint32_t prop_count;
3185 struct _objc_property[prop_count];
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003186 };
3187*/
Zachary Turner41a9ee92017-10-11 23:54:34 +00003188llvm::Constant *CGObjCCommonMac::EmitPropertyList(Twine Name,
3189 const Decl *Container,
3190 const ObjCContainerDecl *OCD,
3191 const ObjCCommonTypesHelper &ObjCTypes,
3192 bool IsClassProperty) {
Manman Ren01b705e2016-04-19 19:05:03 +00003193 if (IsClassProperty) {
3194 // Make this entry NULL for OS X with deployment target < 10.11, for iOS
3195 // with deployment target < 9.0.
3196 const llvm::Triple &Triple = CGM.getTarget().getTriple();
3197 if ((Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 11)) ||
3198 (Triple.isiOS() && Triple.isOSVersionLT(9)))
3199 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
3200 }
3201
John McCall176f8922016-11-30 02:39:18 +00003202 SmallVector<const ObjCPropertyDecl *, 16> Properties;
Fariborz Jahanian751c1e72009-12-12 21:26:21 +00003203 llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
Nico Weber08c93332015-12-03 17:44:51 +00003204
Nico Weber08c93332015-12-03 17:44:51 +00003205 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
3206 for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
Manman Renad0e7912016-01-29 19:22:54 +00003207 for (auto *PD : ClassExt->properties()) {
3208 if (IsClassProperty != PD->isClassProperty())
3209 continue;
Nico Weber08c93332015-12-03 17:44:51 +00003210 PropertySet.insert(PD->getIdentifier());
John McCall176f8922016-11-30 02:39:18 +00003211 Properties.push_back(PD);
Nico Weber08c93332015-12-03 17:44:51 +00003212 }
Manman Renad0e7912016-01-29 19:22:54 +00003213
3214 for (const auto *PD : OCD->properties()) {
3215 if (IsClassProperty != PD->isClassProperty())
3216 continue;
Nico Weber08c93332015-12-03 17:44:51 +00003217 // Don't emit duplicate metadata for properties that were already in a
3218 // class extension.
3219 if (!PropertySet.insert(PD->getIdentifier()).second)
3220 continue;
John McCall176f8922016-11-30 02:39:18 +00003221 Properties.push_back(PD);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003222 }
Nico Weber08c93332015-12-03 17:44:51 +00003223
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003224 if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD)) {
Aaron Ballmana9f49e32014-03-13 20:55:22 +00003225 for (const auto *P : OID->all_referenced_protocols())
John McCall176f8922016-11-30 02:39:18 +00003226 PushProtocolProperties(PropertySet, Properties, P, IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003227 }
3228 else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD)) {
Aaron Ballman19a41762014-03-14 12:55:57 +00003229 for (const auto *P : CD->protocols())
John McCall176f8922016-11-30 02:39:18 +00003230 PushProtocolProperties(PropertySet, Properties, P, IsClassProperty);
Fariborz Jahanian7966aff2010-06-22 16:33:55 +00003231 }
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003232
3233 // Return null for empty list.
3234 if (Properties.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00003235 return llvm::Constant::getNullValue(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003236
John McCall176f8922016-11-30 02:39:18 +00003237 unsigned propertySize =
Micah Villmowdd31ca12012-10-08 16:25:52 +00003238 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.PropertyTy);
John McCall176f8922016-11-30 02:39:18 +00003239
3240 ConstantInitBuilder builder(CGM);
3241 auto values = builder.beginStruct();
3242 values.addInt(ObjCTypes.IntTy, propertySize);
3243 values.addInt(ObjCTypes.IntTy, Properties.size());
3244 auto propertiesArray = values.beginArray(ObjCTypes.PropertyTy);
3245 for (auto PD : Properties) {
3246 auto property = propertiesArray.beginStruct(ObjCTypes.PropertyTy);
3247 property.add(GetPropertyName(PD->getIdentifier()));
3248 property.add(GetPropertyTypeString(PD, Container));
3249 property.finishAndAddTo(propertiesArray);
3250 }
3251 propertiesArray.finishAndAddTo(values);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003252
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003253 StringRef Section;
3254 if (CGM.getTriple().isOSBinFormatMachO())
3255 Section = (ObjCABI == 2) ? "__DATA, __objc_const"
3256 : "__OBJC,__property,regular,no_dead_strip";
3257
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003258 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00003259 CreateMetadataVar(Name, values, Section, CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003260 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.PropertyListPtrTy);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003261}
3262
Zachary Turner41a9ee92017-10-11 23:54:34 +00003263llvm::Constant *
3264CGObjCCommonMac::EmitProtocolMethodTypes(Twine Name,
3265 ArrayRef<llvm::Constant*> MethodTypes,
3266 const ObjCCommonTypesHelper &ObjCTypes) {
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003267 // Return null for empty list.
3268 if (MethodTypes.empty())
3269 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrPtrTy);
3270
3271 llvm::ArrayType *AT = llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
3272 MethodTypes.size());
3273 llvm::Constant *Init = llvm::ConstantArray::get(AT, MethodTypes);
3274
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00003275 StringRef Section;
3276 if (CGM.getTriple().isOSBinFormatMachO() && ObjCABI == 2)
3277 Section = "__DATA, __objc_const";
3278
3279 llvm::GlobalVariable *GV =
3280 CreateMetadataVar(Name, Init, Section, CGM.getPointerAlign(), true);
Bob Wilson5f4e3a72011-11-30 01:57:58 +00003281 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.Int8PtrPtrTy);
3282}
3283
Daniel Dunbar80a840b2008-08-23 00:19:03 +00003284/*
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003285 struct _objc_category {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003286 char *category_name;
3287 char *class_name;
3288 struct _objc_method_list *instance_methods;
3289 struct _objc_method_list *class_methods;
3290 struct _objc_protocol_list *protocols;
3291 uint32_t size; // <rdar://4585769>
3292 struct _objc_property_list *instance_properties;
Manman Ren96df0b32016-01-29 23:45:01 +00003293 struct _objc_property_list *class_properties;
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003294 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003295*/
Daniel Dunbar92992502008-08-15 22:20:32 +00003296void CGObjCMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00003297 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategoryTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003298
Mike Stump18bb9282009-05-16 07:57:57 +00003299 // FIXME: This is poor design, the OCD should have a pointer to the category
3300 // decl. Additionally, note that Category can be null for the @implementation
3301 // w/o an @interface case. Sema should just create one for us as it does for
3302 // @implementation so everyone else can live life under a clear blue sky.
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003303 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003304 const ObjCCategoryDecl *Category =
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003305 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003306
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003307 SmallString<256> ExtName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00003308 llvm::raw_svector_ostream(ExtName) << Interface->getName() << '_'
3309 << OCD->getName();
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003310
John McCall176f8922016-11-30 02:39:18 +00003311 ConstantInitBuilder Builder(CGM);
3312 auto Values = Builder.beginStruct(ObjCTypes.CategoryTy);
Aaron Ballmanf26acce2014-03-13 19:50:17 +00003313
John McCall176f8922016-11-30 02:39:18 +00003314 enum {
3315 InstanceMethods,
3316 ClassMethods,
3317 NumMethodLists
3318 };
3319 SmallVector<const ObjCMethodDecl *, 16> Methods[NumMethodLists];
3320 for (const auto *MD : OCD->methods()) {
3321 Methods[unsigned(MD->isClassMethod())].push_back(MD);
3322 }
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003323
John McCall176f8922016-11-30 02:39:18 +00003324 Values.add(GetClassName(OCD->getName()));
3325 Values.add(GetClassName(Interface->getObjCRuntimeNameAsString()));
Fariborz Jahaniane55f8662009-04-29 20:40:05 +00003326 LazySymbols.insert(Interface->getIdentifier());
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003327
John McCall176f8922016-11-30 02:39:18 +00003328 Values.add(emitMethodList(ExtName, MethodListType::CategoryInstanceMethods,
3329 Methods[InstanceMethods]));
3330 Values.add(emitMethodList(ExtName, MethodListType::CategoryClassMethods,
3331 Methods[ClassMethods]));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003332 if (Category) {
John McCall176f8922016-11-30 02:39:18 +00003333 Values.add(
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003334 EmitProtocolList("OBJC_CATEGORY_PROTOCOLS_" + ExtName.str(),
John McCall176f8922016-11-30 02:39:18 +00003335 Category->protocol_begin(), Category->protocol_end()));
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003336 } else {
John McCall176f8922016-11-30 02:39:18 +00003337 Values.addNullPointer(ObjCTypes.ProtocolListPtrTy);
Daniel Dunbareb1f9a22008-08-27 02:31:56 +00003338 }
John McCall176f8922016-11-30 02:39:18 +00003339 Values.addInt(ObjCTypes.IntTy, Size);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003340
3341 // If there is no category @interface then there can be no properties.
3342 if (Category) {
John McCall176f8922016-11-30 02:39:18 +00003343 Values.add(EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
3344 OCD, Category, ObjCTypes, false));
3345 Values.add(EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
3346 OCD, Category, ObjCTypes, true));
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003347 } else {
John McCall176f8922016-11-30 02:39:18 +00003348 Values.addNullPointer(ObjCTypes.PropertyListPtrTy);
3349 Values.addNullPointer(ObjCTypes.PropertyListPtrTy);
Daniel Dunbar28e76ca2008-08-26 23:03:11 +00003350 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003351
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003352 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00003353 CreateMetadataVar("OBJC_CATEGORY_" + ExtName.str(), Values,
John McCall7f416cc2015-09-08 08:05:57 +00003354 "__OBJC,__category,regular,no_dead_strip",
3355 CGM.getPointerAlign(), true);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003356 DefinedCategories.push_back(GV);
Justin Lebar5e83dfe2016-10-21 21:45:01 +00003357 DefinedCategoryNames.insert(llvm::CachedHashString(ExtName));
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003358 // method definition entries must be clear for next implementation.
3359 MethodDefinitions.clear();
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003360}
3361
John McCallef19dbb2012-10-17 04:53:23 +00003362enum FragileClassFlags {
John McCall460ce582015-10-22 18:38:17 +00003363 /// Apparently: is not a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003364 FragileABI_Class_Factory = 0x00001,
John McCall460ce582015-10-22 18:38:17 +00003365
3366 /// Is a meta-class.
John McCallef19dbb2012-10-17 04:53:23 +00003367 FragileABI_Class_Meta = 0x00002,
John McCall460ce582015-10-22 18:38:17 +00003368
3369 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003370 FragileABI_Class_HasCXXStructors = 0x02000,
John McCall460ce582015-10-22 18:38:17 +00003371
3372 /// Has hidden visibility.
John McCall09ec1ec2015-10-21 22:06:03 +00003373 FragileABI_Class_Hidden = 0x20000,
John McCall460ce582015-10-22 18:38:17 +00003374
3375 /// Class implementation was compiled under ARC.
3376 FragileABI_Class_CompiledByARC = 0x04000000,
3377
3378 /// Class implementation was compiled under MRC and has MRC weak ivars.
3379 /// Exclusive with CompiledByARC.
3380 FragileABI_Class_HasMRCWeakIvars = 0x08000000,
John McCallef19dbb2012-10-17 04:53:23 +00003381};
3382
3383enum NonFragileClassFlags {
3384 /// Is a meta-class.
3385 NonFragileABI_Class_Meta = 0x00001,
3386
3387 /// Is a root class.
3388 NonFragileABI_Class_Root = 0x00002,
3389
John McCall460ce582015-10-22 18:38:17 +00003390 /// Has a non-trivial constructor or destructor.
John McCallef19dbb2012-10-17 04:53:23 +00003391 NonFragileABI_Class_HasCXXStructors = 0x00004,
3392
3393 /// Has hidden visibility.
3394 NonFragileABI_Class_Hidden = 0x00010,
3395
3396 /// Has the exception attribute.
3397 NonFragileABI_Class_Exception = 0x00020,
3398
3399 /// (Obsolete) ARC-specific: this class has a .release_ivars method
3400 NonFragileABI_Class_HasIvarReleaser = 0x00040,
3401
3402 /// Class implementation was compiled under ARC.
John McCall0d54a172012-10-17 04:53:31 +00003403 NonFragileABI_Class_CompiledByARC = 0x00080,
3404
3405 /// Class has non-trivial destructors, but zero-initialization is okay.
John McCall460ce582015-10-22 18:38:17 +00003406 NonFragileABI_Class_HasCXXDestructorOnly = 0x00100,
3407
3408 /// Class implementation was compiled under MRC and has MRC weak ivars.
3409 /// Exclusive with CompiledByARC.
3410 NonFragileABI_Class_HasMRCWeakIvars = 0x00200,
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003411};
3412
John McCall460ce582015-10-22 18:38:17 +00003413static bool hasWeakMember(QualType type) {
3414 if (type.getObjCLifetime() == Qualifiers::OCL_Weak) {
3415 return true;
3416 }
3417
3418 if (auto recType = type->getAs<RecordType>()) {
3419 for (auto field : recType->getDecl()->fields()) {
3420 if (hasWeakMember(field->getType()))
3421 return true;
3422 }
3423 }
3424
3425 return false;
3426}
3427
3428/// For compatibility, we only want to set the "HasMRCWeakIvars" flag
3429/// (and actually fill in a layout string) if we really do have any
3430/// __weak ivars.
3431static bool hasMRCWeakIvars(CodeGenModule &CGM,
3432 const ObjCImplementationDecl *ID) {
3433 if (!CGM.getLangOpts().ObjCWeak) return false;
3434 assert(CGM.getLangOpts().getGC() == LangOptions::NonGC);
3435
3436 for (const ObjCIvarDecl *ivar =
3437 ID->getClassInterface()->all_declared_ivar_begin();
3438 ivar; ivar = ivar->getNextIvar()) {
3439 if (hasWeakMember(ivar->getType()))
3440 return true;
3441 }
3442
3443 return false;
3444}
3445
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003446/*
3447 struct _objc_class {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003448 Class isa;
3449 Class super_class;
3450 const char *name;
3451 long version;
3452 long info;
3453 long instance_size;
3454 struct _objc_ivar_list *ivars;
3455 struct _objc_method_list *methods;
3456 struct _objc_cache *cache;
3457 struct _objc_protocol_list *protocols;
3458 // Objective-C 1.0 extensions (<rdr://4585769>)
3459 const char *ivar_layout;
3460 struct _objc_class_ext *ext;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003461 };
3462
3463 See EmitClassExtension();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003464*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003465void CGObjCMac::GenerateClass(const ObjCImplementationDecl *ID) {
Akira Hatanaka0c194462018-04-03 22:50:16 +00003466 IdentifierInfo *RuntimeName =
3467 &CGM.getContext().Idents.get(ID->getObjCRuntimeNameAsString());
3468 DefinedSymbols.insert(RuntimeName);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003469
Chris Lattner86d7d912008-11-24 03:54:41 +00003470 std::string ClassName = ID->getNameAsString();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003471 // FIXME: Gross
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003472 ObjCInterfaceDecl *Interface =
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003473 const_cast<ObjCInterfaceDecl*>(ID->getClassInterface());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003474 llvm::Constant *Protocols =
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003475 EmitProtocolList("OBJC_CLASS_PROTOCOLS_" + ID->getName(),
3476 Interface->all_referenced_protocol_begin(),
3477 Interface->all_referenced_protocol_end());
John McCallef19dbb2012-10-17 04:53:23 +00003478 unsigned Flags = FragileABI_Class_Factory;
John McCall0d54a172012-10-17 04:53:31 +00003479 if (ID->hasNonZeroConstructors() || ID->hasDestructors())
John McCallef19dbb2012-10-17 04:53:23 +00003480 Flags |= FragileABI_Class_HasCXXStructors;
John McCall09ec1ec2015-10-21 22:06:03 +00003481
John McCall460ce582015-10-22 18:38:17 +00003482 bool hasMRCWeak = false;
3483
John McCall09ec1ec2015-10-21 22:06:03 +00003484 if (CGM.getLangOpts().ObjCAutoRefCount)
3485 Flags |= FragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00003486 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
3487 Flags |= FragileABI_Class_HasMRCWeakIvars;
John McCall09ec1ec2015-10-21 22:06:03 +00003488
John McCall3fd13f062015-10-21 18:06:47 +00003489 CharUnits Size =
3490 CGM.getContext().getASTObjCImplementationLayout(ID).getSize();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003491
3492 // FIXME: Set CXX-structors flag.
John McCall457a04e2010-10-22 21:05:15 +00003493 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003494 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003495
John McCall176f8922016-11-30 02:39:18 +00003496 enum {
3497 InstanceMethods,
3498 ClassMethods,
3499 NumMethodLists
3500 };
3501 SmallVector<const ObjCMethodDecl *, 16> Methods[NumMethodLists];
3502 for (const auto *MD : ID->methods()) {
3503 Methods[unsigned(MD->isClassMethod())].push_back(MD);
3504 }
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003505
Aaron Ballmand85eff42014-03-14 15:02:45 +00003506 for (const auto *PID : ID->property_impls()) {
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003507 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
3508 ObjCPropertyDecl *PD = PID->getPropertyDecl();
3509
3510 if (ObjCMethodDecl *MD = PD->getGetterMethodDecl())
John McCall176f8922016-11-30 02:39:18 +00003511 if (GetMethodDefinition(MD))
3512 Methods[InstanceMethods].push_back(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003513 if (ObjCMethodDecl *MD = PD->getSetterMethodDecl())
John McCall176f8922016-11-30 02:39:18 +00003514 if (GetMethodDefinition(MD))
3515 Methods[InstanceMethods].push_back(MD);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003516 }
3517 }
3518
John McCall176f8922016-11-30 02:39:18 +00003519 ConstantInitBuilder builder(CGM);
3520 auto values = builder.beginStruct(ObjCTypes.ClassTy);
3521 values.add(EmitMetaClass(ID, Protocols, Methods[ClassMethods]));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003522 if (ObjCInterfaceDecl *Super = Interface->getSuperClass()) {
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00003523 // Record a reference to the super class.
3524 LazySymbols.insert(Super->getIdentifier());
3525
John McCall176f8922016-11-30 02:39:18 +00003526 values.addBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
3527 ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003528 } else {
John McCall176f8922016-11-30 02:39:18 +00003529 values.addNullPointer(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003530 }
John McCall176f8922016-11-30 02:39:18 +00003531 values.add(GetClassName(ID->getObjCRuntimeNameAsString()));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003532 // Version is always 0.
John McCall176f8922016-11-30 02:39:18 +00003533 values.addInt(ObjCTypes.LongTy, 0);
3534 values.addInt(ObjCTypes.LongTy, Flags);
3535 values.addInt(ObjCTypes.LongTy, Size.getQuantity());
3536 values.add(EmitIvarList(ID, false));
3537 values.add(emitMethodList(ID->getName(), MethodListType::InstanceMethods,
3538 Methods[InstanceMethods]));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003539 // cache is always NULL.
John McCall176f8922016-11-30 02:39:18 +00003540 values.addNullPointer(ObjCTypes.CachePtrTy);
3541 values.add(Protocols);
3542 values.add(BuildStrongIvarLayout(ID, CharUnits::Zero(), Size));
3543 values.add(EmitClassExtension(ID, Size, hasMRCWeak,
3544 /*isMetaclass*/ false));
3545
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003546 std::string Name("OBJC_CLASS_");
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003547 Name += ClassName;
3548 const char *Section = "__OBJC,__class,regular,no_dead_strip";
3549 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003550 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003551 if (GV) {
3552 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3553 "Forward metaclass reference has incorrect type.");
John McCall176f8922016-11-30 02:39:18 +00003554 values.finishAndSetAsInitializer(GV);
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003555 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003556 GV->setAlignment(CGM.getPointerAlign().getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00003557 CGM.addCompilerUsedGlobal(GV);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003558 } else
John McCall176f8922016-11-30 02:39:18 +00003559 GV = CreateMetadataVar(Name, values, Section, CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003560 DefinedClasses.push_back(GV);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00003561 ImplementedClasses.push_back(Interface);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00003562 // method definition entries must be clear for next implementation.
3563 MethodDefinitions.clear();
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003564}
3565
3566llvm::Constant *CGObjCMac::EmitMetaClass(const ObjCImplementationDecl *ID,
3567 llvm::Constant *Protocols,
John McCall176f8922016-11-30 02:39:18 +00003568 ArrayRef<const ObjCMethodDecl*> Methods) {
John McCallef19dbb2012-10-17 04:53:23 +00003569 unsigned Flags = FragileABI_Class_Meta;
Micah Villmowdd31ca12012-10-08 16:25:52 +00003570 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003571
John McCall457a04e2010-10-22 21:05:15 +00003572 if (ID->getClassInterface()->getVisibility() == HiddenVisibility)
John McCallef19dbb2012-10-17 04:53:23 +00003573 Flags |= FragileABI_Class_Hidden;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003574
John McCall176f8922016-11-30 02:39:18 +00003575 ConstantInitBuilder builder(CGM);
3576 auto values = builder.beginStruct(ObjCTypes.ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003577 // The isa for the metaclass is the root of the hierarchy.
3578 const ObjCInterfaceDecl *Root = ID->getClassInterface();
3579 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
3580 Root = Super;
John McCall176f8922016-11-30 02:39:18 +00003581 values.addBitCast(GetClassName(Root->getObjCRuntimeNameAsString()),
3582 ObjCTypes.ClassPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00003583 // The super class for the metaclass is emitted as the name of the
3584 // super class. The runtime fixes this up to point to the
3585 // *metaclass* for the super class.
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003586 if (ObjCInterfaceDecl *Super = ID->getClassInterface()->getSuperClass()) {
John McCall176f8922016-11-30 02:39:18 +00003587 values.addBitCast(GetClassName(Super->getObjCRuntimeNameAsString()),
3588 ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003589 } else {
John McCall176f8922016-11-30 02:39:18 +00003590 values.addNullPointer(ObjCTypes.ClassPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003591 }
John McCall176f8922016-11-30 02:39:18 +00003592 values.add(GetClassName(ID->getObjCRuntimeNameAsString()));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003593 // Version is always 0.
John McCall176f8922016-11-30 02:39:18 +00003594 values.addInt(ObjCTypes.LongTy, 0);
3595 values.addInt(ObjCTypes.LongTy, Flags);
3596 values.addInt(ObjCTypes.LongTy, Size);
3597 values.add(EmitIvarList(ID, true));
3598 values.add(emitMethodList(ID->getName(), MethodListType::ClassMethods,
3599 Methods));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003600 // cache is always NULL.
John McCall176f8922016-11-30 02:39:18 +00003601 values.addNullPointer(ObjCTypes.CachePtrTy);
3602 values.add(Protocols);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003603 // ivar_layout for metaclass is always NULL.
John McCall176f8922016-11-30 02:39:18 +00003604 values.addNullPointer(ObjCTypes.Int8PtrTy);
Manman Renad0e7912016-01-29 19:22:54 +00003605 // The class extension is used to store class properties for metaclasses.
John McCall176f8922016-11-30 02:39:18 +00003606 values.add(EmitClassExtension(ID, CharUnits::Zero(), false/*hasMRCWeak*/,
3607 /*isMetaclass*/true));
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003608
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003609 std::string Name("OBJC_METACLASS_");
Benjamin Kramer1bbcbd02012-07-31 11:45:39 +00003610 Name += ID->getName();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003611
3612 // Check for a forward reference.
Rafael Espindola554256c2014-02-26 22:25:45 +00003613 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003614 if (GV) {
3615 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3616 "Forward metaclass reference has incorrect type.");
John McCall176f8922016-11-30 02:39:18 +00003617 values.finishAndSetAsInitializer(GV);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003618 } else {
John McCall176f8922016-11-30 02:39:18 +00003619 GV = values.finishAndCreateGlobal(Name, CGM.getPointerAlign(),
3620 /*constant*/ false,
3621 llvm::GlobalValue::PrivateLinkage);
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003622 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003623 GV->setSection("__OBJC,__meta_class,regular,no_dead_strip");
Rafael Espindola060062a2014-03-06 22:15:10 +00003624 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003625
3626 return GV;
3627}
3628
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003629llvm::Constant *CGObjCMac::EmitMetaClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003630 std::string Name = "OBJC_METACLASS_" + ID->getNameAsString();
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003631
Mike Stump18bb9282009-05-16 07:57:57 +00003632 // FIXME: Should we look these up somewhere other than the module. Its a bit
3633 // silly since we only generate these while processing an implementation, so
3634 // exactly one pointer would work if know when we entered/exitted an
3635 // implementation block.
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003636
3637 // Check for an existing forward reference.
Fariborz Jahanian475831b2009-01-07 20:11:22 +00003638 // Previously, metaclass with internal linkage may have been defined.
3639 // pass 'true' as 2nd argument so it is returned.
Rafael Espindola21039aa2014-02-27 16:26:32 +00003640 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3641 if (!GV)
3642 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003643 llvm::GlobalValue::PrivateLinkage, nullptr,
3644 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003645
3646 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3647 "Forward metaclass reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003648 return GV;
Daniel Dunbarca8531a2008-08-25 08:19:24 +00003649}
3650
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003651llvm::Value *CGObjCMac::EmitSuperClassRef(const ObjCInterfaceDecl *ID) {
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003652 std::string Name = "OBJC_CLASS_" + ID->getNameAsString();
Rafael Espindola21039aa2014-02-27 16:26:32 +00003653 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name, true);
3654
3655 if (!GV)
3656 GV = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassTy, false,
Craig Topper8a13c412014-05-21 05:09:00 +00003657 llvm::GlobalValue::PrivateLinkage, nullptr,
3658 Name);
Rafael Espindola21039aa2014-02-27 16:26:32 +00003659
3660 assert(GV->getType()->getElementType() == ObjCTypes.ClassTy &&
3661 "Forward class metadata reference has incorrect type.");
Rafael Espindola21039aa2014-02-27 16:26:32 +00003662 return GV;
Fariborz Jahanianeb80c982009-11-12 20:14:24 +00003663}
3664
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003665/*
John McCall3fd13f062015-10-21 18:06:47 +00003666 Emit a "class extension", which in this specific context means extra
3667 data that doesn't fit in the normal fragile-ABI class structure, and
3668 has nothing to do with the language concept of a class extension.
3669
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003670 struct objc_class_ext {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003671 uint32_t size;
3672 const char *weak_ivar_layout;
3673 struct _objc_property_list *properties;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003674 };
3675*/
3676llvm::Constant *
John McCall3fd13f062015-10-21 18:06:47 +00003677CGObjCMac::EmitClassExtension(const ObjCImplementationDecl *ID,
Manman Renad0e7912016-01-29 19:22:54 +00003678 CharUnits InstanceSize, bool hasMRCWeakIvars,
John McCall176f8922016-11-30 02:39:18 +00003679 bool isMetaclass) {
3680 // Weak ivar layout.
3681 llvm::Constant *layout;
3682 if (isMetaclass) {
3683 layout = llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
3684 } else {
3685 layout = BuildWeakIvarLayout(ID, CharUnits::Zero(), InstanceSize,
3686 hasMRCWeakIvars);
3687 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003688
John McCall176f8922016-11-30 02:39:18 +00003689 // Properties.
3690 llvm::Constant *propertyList =
3691 EmitPropertyList((isMetaclass ? Twine("\01l_OBJC_$_CLASS_PROP_LIST_")
3692 : Twine("\01l_OBJC_$_PROP_LIST_"))
3693 + ID->getName(),
3694 ID, ID->getClassInterface(), ObjCTypes, isMetaclass);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003695
3696 // Return null if no extension bits are used.
John McCall176f8922016-11-30 02:39:18 +00003697 if (layout->isNullValue() && propertyList->isNullValue()) {
Owen Anderson0b75f232009-07-31 20:28:54 +00003698 return llvm::Constant::getNullValue(ObjCTypes.ClassExtensionPtrTy);
John McCall176f8922016-11-30 02:39:18 +00003699 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003700
John McCall176f8922016-11-30 02:39:18 +00003701 uint64_t size =
3702 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassExtensionTy);
3703
3704 ConstantInitBuilder builder(CGM);
3705 auto values = builder.beginStruct(ObjCTypes.ClassExtensionTy);
3706 values.addInt(ObjCTypes.IntTy, size);
3707 values.add(layout);
3708 values.add(propertyList);
3709
3710 return CreateMetadataVar("OBJC_CLASSEXT_" + ID->getName(), values,
John McCall7f416cc2015-09-08 08:05:57 +00003711 "__OBJC,__class_ext,regular,no_dead_strip",
3712 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003713}
3714
3715/*
3716 struct objc_ivar {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003717 char *ivar_name;
3718 char *ivar_type;
3719 int ivar_offset;
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003720 };
3721
3722 struct objc_ivar_list {
Bill Wendlingf1a3fca2012-02-22 09:30:11 +00003723 int ivar_count;
3724 struct objc_ivar list[count];
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003725 };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003726*/
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003727llvm::Constant *CGObjCMac::EmitIvarList(const ObjCImplementationDecl *ID,
Fariborz Jahanianb042a592009-01-28 19:12:34 +00003728 bool ForClass) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003729 // When emitting the root class GCC emits ivar entries for the
3730 // actual class structure. It is not clear if we need to follow this
3731 // behavior; for now lets try and get away with not doing it. If so,
3732 // the cleanest solution would be to make up an ObjCInterfaceDecl
3733 // for the class.
3734 if (ForClass)
Owen Anderson0b75f232009-07-31 20:28:54 +00003735 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003736
Jordy Rosea91768e2011-07-22 02:08:32 +00003737 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003738
John McCall176f8922016-11-30 02:39:18 +00003739 ConstantInitBuilder builder(CGM);
3740 auto ivarList = builder.beginStruct();
3741 auto countSlot = ivarList.addPlaceholder();
3742 auto ivars = ivarList.beginArray(ObjCTypes.IvarTy);
3743
Fangrui Song6907ce22018-07-30 19:24:48 +00003744 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00003745 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00003746 // Ignore unnamed bit-fields.
3747 if (!IVD->getDeclName())
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003748 continue;
John McCall176f8922016-11-30 02:39:18 +00003749
3750 auto ivar = ivars.beginStruct(ObjCTypes.IvarTy);
3751 ivar.add(GetMethodVarName(IVD->getIdentifier()));
3752 ivar.add(GetMethodVarType(IVD));
3753 ivar.addInt(ObjCTypes.IntTy, ComputeIvarBaseOffset(CGM, OID, IVD));
3754 ivar.finishAndAddTo(ivars);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003755 }
3756
3757 // Return null for empty list.
John McCall176f8922016-11-30 02:39:18 +00003758 auto count = ivars.size();
3759 if (count == 0) {
3760 ivars.abandon();
3761 ivarList.abandon();
Owen Anderson0b75f232009-07-31 20:28:54 +00003762 return llvm::Constant::getNullValue(ObjCTypes.IvarListPtrTy);
John McCall176f8922016-11-30 02:39:18 +00003763 }
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003764
John McCall176f8922016-11-30 02:39:18 +00003765 ivars.finishAndAddTo(ivarList);
3766 ivarList.fillPlaceholderWithInt(countSlot, ObjCTypes.IntTy, count);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003767
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003768 llvm::GlobalVariable *GV;
3769 if (ForClass)
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00003770 GV =
John McCall176f8922016-11-30 02:39:18 +00003771 CreateMetadataVar("OBJC_CLASS_VARIABLES_" + ID->getName(), ivarList,
John McCall7f416cc2015-09-08 08:05:57 +00003772 "__OBJC,__class_vars,regular,no_dead_strip",
3773 CGM.getPointerAlign(), true);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00003774 else
John McCall176f8922016-11-30 02:39:18 +00003775 GV = CreateMetadataVar("OBJC_INSTANCE_VARIABLES_" + ID->getName(), ivarList,
John McCall7f416cc2015-09-08 08:05:57 +00003776 "__OBJC,__instance_vars,regular,no_dead_strip",
3777 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00003778 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003779}
3780
John McCall176f8922016-11-30 02:39:18 +00003781/// Build a struct objc_method_description constant for the given method.
3782///
3783/// struct objc_method_description {
3784/// SEL method_name;
3785/// char *method_types;
3786/// };
3787void CGObjCMac::emitMethodDescriptionConstant(ConstantArrayBuilder &builder,
3788 const ObjCMethodDecl *MD) {
3789 auto description = builder.beginStruct(ObjCTypes.MethodDescriptionTy);
3790 description.addBitCast(GetMethodVarName(MD->getSelector()),
3791 ObjCTypes.SelectorPtrTy);
3792 description.add(GetMethodVarType(MD));
3793 description.finishAndAddTo(builder);
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003794}
3795
John McCall176f8922016-11-30 02:39:18 +00003796/// Build a struct objc_method constant for the given method.
3797///
3798/// struct objc_method {
3799/// SEL method_name;
3800/// char *method_types;
3801/// void *method;
3802/// };
3803void CGObjCMac::emitMethodConstant(ConstantArrayBuilder &builder,
3804 const ObjCMethodDecl *MD) {
3805 llvm::Function *fn = GetMethodDefinition(MD);
3806 assert(fn && "no definition registered for method");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003807
John McCall176f8922016-11-30 02:39:18 +00003808 auto method = builder.beginStruct(ObjCTypes.MethodTy);
3809 method.addBitCast(GetMethodVarName(MD->getSelector()),
3810 ObjCTypes.SelectorPtrTy);
3811 method.add(GetMethodVarType(MD));
3812 method.addBitCast(fn, ObjCTypes.Int8PtrTy);
3813 method.finishAndAddTo(builder);
3814}
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00003815
John McCall176f8922016-11-30 02:39:18 +00003816/// Build a struct objc_method_list or struct objc_method_description_list,
3817/// as appropriate.
3818///
3819/// struct objc_method_list {
3820/// struct objc_method_list *obsolete;
3821/// int count;
3822/// struct objc_method methods_list[count];
3823/// };
3824///
3825/// struct objc_method_description_list {
3826/// int count;
3827/// struct objc_method_description list[count];
3828/// };
Zachary Turner41a9ee92017-10-11 23:54:34 +00003829llvm::Constant *CGObjCMac::emitMethodList(Twine name, MethodListType MLT,
3830 ArrayRef<const ObjCMethodDecl *> methods) {
John McCall176f8922016-11-30 02:39:18 +00003831 StringRef prefix;
3832 StringRef section;
3833 bool forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003834 switch (MLT) {
3835 case MethodListType::CategoryInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003836 prefix = "OBJC_CATEGORY_INSTANCE_METHODS_";
3837 section = "__OBJC,__cat_inst_meth,regular,no_dead_strip";
3838 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003839 break;
3840 case MethodListType::CategoryClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003841 prefix = "OBJC_CATEGORY_CLASS_METHODS_";
3842 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
3843 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003844 break;
3845 case MethodListType::InstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003846 prefix = "OBJC_INSTANCE_METHODS_";
3847 section = "__OBJC,__inst_meth,regular,no_dead_strip";
3848 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003849 break;
3850 case MethodListType::ClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003851 prefix = "OBJC_CLASS_METHODS_";
3852 section = "__OBJC,__cls_meth,regular,no_dead_strip";
3853 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003854 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003855 case MethodListType::ProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003856 prefix = "OBJC_PROTOCOL_INSTANCE_METHODS_";
3857 section = "__OBJC,__cat_inst_meth,regular,no_dead_strip";
3858 forProtocol = true;
3859 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003860 case MethodListType::ProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003861 prefix = "OBJC_PROTOCOL_CLASS_METHODS_";
3862 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
3863 forProtocol = true;
3864 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003865 case MethodListType::OptionalProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00003866 prefix = "OBJC_PROTOCOL_INSTANCE_METHODS_OPT_";
3867 section = "__OBJC,__cat_inst_meth,regular,no_dead_strip";
3868 forProtocol = true;
3869 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003870 case MethodListType::OptionalProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00003871 prefix = "OBJC_PROTOCOL_CLASS_METHODS_OPT_";
3872 section = "__OBJC,__cat_cls_meth,regular,no_dead_strip";
3873 forProtocol = true;
3874 break;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003875 }
3876
John McCall176f8922016-11-30 02:39:18 +00003877 // Return null for empty list.
3878 if (methods.empty())
3879 return llvm::Constant::getNullValue(forProtocol
3880 ? ObjCTypes.MethodDescriptionListPtrTy
3881 : ObjCTypes.MethodListPtrTy);
3882
3883 // For protocols, this is an objc_method_description_list, which has
3884 // a slightly different structure.
3885 if (forProtocol) {
3886 ConstantInitBuilder builder(CGM);
3887 auto values = builder.beginStruct();
3888 values.addInt(ObjCTypes.IntTy, methods.size());
3889 auto methodArray = values.beginArray(ObjCTypes.MethodDescriptionTy);
3890 for (auto MD : methods) {
3891 emitMethodDescriptionConstant(methodArray, MD);
3892 }
3893 methodArray.finishAndAddTo(values);
3894
Zachary Turner41a9ee92017-10-11 23:54:34 +00003895 llvm::GlobalVariable *GV = CreateMetadataVar(prefix + name, values, section,
John McCall176f8922016-11-30 02:39:18 +00003896 CGM.getPointerAlign(), true);
3897 return llvm::ConstantExpr::getBitCast(GV,
3898 ObjCTypes.MethodDescriptionListPtrTy);
3899 }
3900
3901 // Otherwise, it's an objc_method_list.
3902 ConstantInitBuilder builder(CGM);
3903 auto values = builder.beginStruct();
3904 values.addNullPointer(ObjCTypes.Int8PtrTy);
3905 values.addInt(ObjCTypes.IntTy, methods.size());
3906 auto methodArray = values.beginArray(ObjCTypes.MethodTy);
3907 for (auto MD : methods) {
3908 emitMethodConstant(methodArray, MD);
3909 }
3910 methodArray.finishAndAddTo(values);
3911
Zachary Turner41a9ee92017-10-11 23:54:34 +00003912 llvm::GlobalVariable *GV = CreateMetadataVar(prefix + name, values, section,
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00003913 CGM.getPointerAlign(), true);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00003914 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListPtrTy);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003915}
3916
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00003917llvm::Function *CGObjCCommonMac::GenerateMethod(const ObjCMethodDecl *OMD,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003918 const ObjCContainerDecl *CD) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003919 SmallString<256> Name;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00003920 GetNameForMethod(OMD, CD, Name);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003921
Daniel Dunbarbf8c24a2009-02-02 23:23:47 +00003922 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2192fe52011-07-18 04:24:23 +00003923 llvm::FunctionType *MethodTy =
John McCalla729c622012-02-17 03:33:10 +00003924 Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003925 llvm::Function *Method =
Daniel Dunbar7a95ca32008-09-10 04:01:49 +00003926 llvm::Function::Create(MethodTy,
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003927 llvm::GlobalValue::InternalLinkage,
Daniel Dunbard2386812009-10-19 01:21:19 +00003928 Name.str(),
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003929 &CGM.getModule());
Daniel Dunbar3c76cb52008-08-26 21:51:14 +00003930 MethodDefinitions.insert(std::make_pair(OMD, Method));
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003931
Daniel Dunbara94ecd22008-08-16 03:19:19 +00003932 return Method;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00003933}
3934
Zachary Turner41a9ee92017-10-11 23:54:34 +00003935llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
3936 ConstantStructBuilder &Init,
3937 StringRef Section,
3938 CharUnits Align,
3939 bool AddToUsed) {
John McCall176f8922016-11-30 02:39:18 +00003940 llvm::GlobalVariable *GV =
3941 Init.finishAndCreateGlobal(Name, Align, /*constant*/ false,
3942 llvm::GlobalValue::PrivateLinkage);
3943 if (!Section.empty())
3944 GV->setSection(Section);
3945 if (AddToUsed)
3946 CGM.addCompilerUsedGlobal(GV);
3947 return GV;
3948}
3949
Zachary Turner41a9ee92017-10-11 23:54:34 +00003950llvm::GlobalVariable *CGObjCCommonMac::CreateMetadataVar(Twine Name,
Alp Toker541d5072014-06-07 23:30:53 +00003951 llvm::Constant *Init,
3952 StringRef Section,
John McCall7f416cc2015-09-08 08:05:57 +00003953 CharUnits Align,
Alp Toker541d5072014-06-07 23:30:53 +00003954 bool AddToUsed) {
Chris Lattner2192fe52011-07-18 04:24:23 +00003955 llvm::Type *Ty = Init->getType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00003956 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00003957 new llvm::GlobalVariable(CGM.getModule(), Ty, false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00003958 llvm::GlobalValue::PrivateLinkage, Init, Name);
Alp Toker541d5072014-06-07 23:30:53 +00003959 if (!Section.empty())
Daniel Dunbar30c65362009-03-09 20:09:19 +00003960 GV->setSection(Section);
John McCall7f416cc2015-09-08 08:05:57 +00003961 GV->setAlignment(Align.getQuantity());
Daniel Dunbar463cc8a2009-03-09 20:50:13 +00003962 if (AddToUsed)
Rafael Espindola060062a2014-03-06 22:15:10 +00003963 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar30c65362009-03-09 20:09:19 +00003964 return GV;
3965}
3966
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003967llvm::GlobalVariable *
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003968CGObjCCommonMac::CreateCStringLiteral(StringRef Name, ObjCLabelType Type,
3969 bool ForceNonFragileABI,
3970 bool NullTerminate) {
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003971 StringRef Label;
3972 switch (Type) {
3973 case ObjCLabelType::ClassName: Label = "OBJC_CLASS_NAME_"; break;
3974 case ObjCLabelType::MethodVarName: Label = "OBJC_METH_VAR_NAME_"; break;
3975 case ObjCLabelType::MethodVarType: Label = "OBJC_METH_VAR_TYPE_"; break;
3976 case ObjCLabelType::PropertyName: Label = "OBJC_PROP_NAME_ATTR_"; break;
3977 }
3978
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003979 bool NonFragile = ForceNonFragileABI || isNonFragileABI();
3980
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003981 StringRef Section;
3982 switch (Type) {
3983 case ObjCLabelType::ClassName:
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003984 Section = NonFragile ? "__TEXT,__objc_classname,cstring_literals"
3985 : "__TEXT,__cstring,cstring_literals";
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003986 break;
3987 case ObjCLabelType::MethodVarName:
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003988 Section = NonFragile ? "__TEXT,__objc_methname,cstring_literals"
3989 : "__TEXT,__cstring,cstring_literals";
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003990 break;
3991 case ObjCLabelType::MethodVarType:
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00003992 Section = NonFragile ? "__TEXT,__objc_methtype,cstring_literals"
3993 : "__TEXT,__cstring,cstring_literals";
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00003994 break;
3995 case ObjCLabelType::PropertyName:
3996 Section = "__TEXT,__cstring,cstring_literals";
3997 break;
3998 }
3999
Saleem Abdulrasool82f6add2016-09-20 18:38:54 +00004000 llvm::Constant *Value =
4001 llvm::ConstantDataArray::getString(VMContext, Name, NullTerminate);
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00004002 llvm::GlobalVariable *GV =
Saleem Abdulrasool0c54dc82016-09-18 16:12:04 +00004003 new llvm::GlobalVariable(CGM.getModule(), Value->getType(),
4004 /*isConstant=*/true,
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00004005 llvm::GlobalValue::PrivateLinkage, Value, Label);
Saleem Abdulrasool3f307512016-09-18 16:12:14 +00004006 if (CGM.getTriple().isOSBinFormatMachO())
4007 GV->setSection(Section);
4008 GV->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00004009 GV->setAlignment(CharUnits::One().getQuantity());
4010 CGM.addCompilerUsedGlobal(GV);
4011
4012 return GV;
4013}
4014
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004015llvm::Function *CGObjCMac::ModuleInitFunction() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004016 // Abuse this interface function as a place to finalize.
4017 FinishModule();
Craig Topper8a13c412014-05-21 05:09:00 +00004018 return nullptr;
Daniel Dunbar303e2c22008-08-11 02:45:11 +00004019}
4020
James Y Knight9871db02019-02-05 16:42:33 +00004021llvm::FunctionCallee CGObjCMac::GetPropertyGetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00004022 return ObjCTypes.getGetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00004023}
4024
James Y Knight9871db02019-02-05 16:42:33 +00004025llvm::FunctionCallee CGObjCMac::GetPropertySetFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00004026 return ObjCTypes.getSetPropertyFn();
Daniel Dunbara91c3e02008-09-24 03:38:44 +00004027}
4028
James Y Knight9871db02019-02-05 16:42:33 +00004029llvm::FunctionCallee CGObjCMac::GetOptimizedPropertySetFunction(bool atomic,
4030 bool copy) {
Ted Kremeneke65b0862012-03-06 20:05:56 +00004031 return ObjCTypes.getOptimizedSetPropertyFn(atomic, copy);
4032}
4033
James Y Knight9871db02019-02-05 16:42:33 +00004034llvm::FunctionCallee CGObjCMac::GetGetStructFunction() {
David Chisnall168b80f2010-12-26 22:13:16 +00004035 return ObjCTypes.getCopyStructFn();
4036}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00004037
James Y Knight9871db02019-02-05 16:42:33 +00004038llvm::FunctionCallee CGObjCMac::GetSetStructFunction() {
Fariborz Jahanian5a8c2032010-04-12 18:18:10 +00004039 return ObjCTypes.getCopyStructFn();
4040}
4041
James Y Knight9871db02019-02-05 16:42:33 +00004042llvm::FunctionCallee CGObjCMac::GetCppAtomicObjectGetFunction() {
David Chisnall0d75e062012-12-17 18:54:24 +00004043 return ObjCTypes.getCppAtomicObjectFunction();
4044}
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00004045
James Y Knight9871db02019-02-05 16:42:33 +00004046llvm::FunctionCallee CGObjCMac::GetCppAtomicObjectSetFunction() {
Fariborz Jahanian1e1b5492012-01-06 18:07:23 +00004047 return ObjCTypes.getCppAtomicObjectFunction();
4048}
4049
James Y Knight9871db02019-02-05 16:42:33 +00004050llvm::FunctionCallee CGObjCMac::EnumerationMutationFunction() {
Chris Lattnerce8754e2009-04-22 02:44:54 +00004051 return ObjCTypes.getEnumerationMutationFn();
Anders Carlsson3f35a262008-08-31 04:05:03 +00004052}
4053
John McCallbd309292010-07-06 01:34:17 +00004054void CGObjCMac::EmitTryStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S) {
4055 return EmitTryOrSynchronizedStmt(CGF, S);
4056}
4057
4058void CGObjCMac::EmitSynchronizedStmt(CodeGenFunction &CGF,
4059 const ObjCAtSynchronizedStmt &S) {
4060 return EmitTryOrSynchronizedStmt(CGF, S);
4061}
4062
John McCall65bea082010-07-21 06:59:36 +00004063namespace {
David Blaikie7e70d682015-08-18 22:40:54 +00004064 struct PerformFragileFinally final : EHScopeStack::Cleanup {
John McCall65bea082010-07-21 06:59:36 +00004065 const Stmt &S;
John McCall7f416cc2015-09-08 08:05:57 +00004066 Address SyncArgSlot;
4067 Address CallTryExitVar;
4068 Address ExceptionData;
John McCall65bea082010-07-21 06:59:36 +00004069 ObjCTypesHelper &ObjCTypes;
4070 PerformFragileFinally(const Stmt *S,
John McCall7f416cc2015-09-08 08:05:57 +00004071 Address SyncArgSlot,
4072 Address CallTryExitVar,
4073 Address ExceptionData,
John McCall65bea082010-07-21 06:59:36 +00004074 ObjCTypesHelper *ObjCTypes)
John McCall2dd7d442010-08-04 05:59:32 +00004075 : S(*S), SyncArgSlot(SyncArgSlot), CallTryExitVar(CallTryExitVar),
John McCall65bea082010-07-21 06:59:36 +00004076 ExceptionData(ExceptionData), ObjCTypes(*ObjCTypes) {}
4077
Craig Topper4f12f102014-03-12 06:41:41 +00004078 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall65bea082010-07-21 06:59:36 +00004079 // Check whether we need to call objc_exception_try_exit.
4080 // In optimized code, this branch will always be folded.
4081 llvm::BasicBlock *FinallyCallExit =
4082 CGF.createBasicBlock("finally.call_exit");
4083 llvm::BasicBlock *FinallyNoCallExit =
4084 CGF.createBasicBlock("finally.no_call_exit");
4085 CGF.Builder.CreateCondBr(CGF.Builder.CreateLoad(CallTryExitVar),
4086 FinallyCallExit, FinallyNoCallExit);
4087
4088 CGF.EmitBlock(FinallyCallExit);
John McCall882987f2013-02-28 19:01:20 +00004089 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryExitFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004090 ExceptionData.getPointer());
John McCall65bea082010-07-21 06:59:36 +00004091
4092 CGF.EmitBlock(FinallyNoCallExit);
4093
4094 if (isa<ObjCAtTryStmt>(S)) {
4095 if (const ObjCAtFinallyStmt* FinallyStmt =
John McCallcebe0ca2010-08-11 00:16:14 +00004096 cast<ObjCAtTryStmt>(S).getFinallyStmt()) {
John McCall638d4f52013-04-03 00:56:07 +00004097 // Don't try to do the @finally if this is an EH cleanup.
4098 if (flags.isForEHCleanup()) return;
4099
John McCallcebe0ca2010-08-11 00:16:14 +00004100 // Save the current cleanup destination in case there's
4101 // control flow inside the finally statement.
4102 llvm::Value *CurCleanupDest =
4103 CGF.Builder.CreateLoad(CGF.getNormalCleanupDestSlot());
4104
John McCall65bea082010-07-21 06:59:36 +00004105 CGF.EmitStmt(FinallyStmt->getFinallyBody());
4106
John McCallcebe0ca2010-08-11 00:16:14 +00004107 if (CGF.HaveInsertPoint()) {
4108 CGF.Builder.CreateStore(CurCleanupDest,
4109 CGF.getNormalCleanupDestSlot());
4110 } else {
4111 // Currently, the end of the cleanup must always exist.
4112 CGF.EnsureInsertPoint();
4113 }
4114 }
John McCall65bea082010-07-21 06:59:36 +00004115 } else {
4116 // Emit objc_sync_exit(expr); as finally's sole statement for
4117 // @synchronized.
John McCall2dd7d442010-08-04 05:59:32 +00004118 llvm::Value *SyncArg = CGF.Builder.CreateLoad(SyncArgSlot);
John McCall882987f2013-02-28 19:01:20 +00004119 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncExitFn(), SyncArg);
John McCall65bea082010-07-21 06:59:36 +00004120 }
4121 }
4122 };
John McCall42227ed2010-07-31 23:20:56 +00004123
4124 class FragileHazards {
4125 CodeGenFunction &CGF;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004126 SmallVector<llvm::Value*, 20> Locals;
John McCall42227ed2010-07-31 23:20:56 +00004127 llvm::DenseSet<llvm::BasicBlock*> BlocksBeforeTry;
4128
4129 llvm::InlineAsm *ReadHazard;
4130 llvm::InlineAsm *WriteHazard;
4131
4132 llvm::FunctionType *GetAsmFnType();
4133
4134 void collectLocals();
4135 void emitReadHazard(CGBuilderTy &Builder);
4136
4137 public:
4138 FragileHazards(CodeGenFunction &CGF);
John McCall2dd7d442010-08-04 05:59:32 +00004139
John McCall42227ed2010-07-31 23:20:56 +00004140 void emitWriteHazard();
John McCall2dd7d442010-08-04 05:59:32 +00004141 void emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004142 };
Eugene Zelenko0a4f3f42016-02-10 19:11:58 +00004143} // end anonymous namespace
John McCall42227ed2010-07-31 23:20:56 +00004144
4145/// Create the fragile-ABI read and write hazards based on the current
4146/// state of the function, which is presumed to be immediately prior
4147/// to a @try block. These hazards are used to maintain correct
4148/// semantics in the face of optimization and the fragile ABI's
4149/// cavalier use of setjmp/longjmp.
4150FragileHazards::FragileHazards(CodeGenFunction &CGF) : CGF(CGF) {
4151 collectLocals();
4152
4153 if (Locals.empty()) return;
4154
4155 // Collect all the blocks in the function.
4156 for (llvm::Function::iterator
4157 I = CGF.CurFn->begin(), E = CGF.CurFn->end(); I != E; ++I)
4158 BlocksBeforeTry.insert(&*I);
4159
4160 llvm::FunctionType *AsmFnTy = GetAsmFnType();
4161
4162 // Create a read hazard for the allocas. This inhibits dead-store
4163 // optimizations and forces the values to memory. This hazard is
4164 // inserted before any 'throwing' calls in the protected scope to
4165 // reflect the possibility that the variables might be read from the
4166 // catch block if the call throws.
4167 {
4168 std::string Constraint;
4169 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
4170 if (I) Constraint += ',';
4171 Constraint += "*m";
4172 }
4173
4174 ReadHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
4175 }
4176
4177 // Create a write hazard for the allocas. This inhibits folding
4178 // loads across the hazard. This hazard is inserted at the
4179 // beginning of the catch path to reflect the possibility that the
4180 // variables might have been written within the protected scope.
4181 {
4182 std::string Constraint;
4183 for (unsigned I = 0, E = Locals.size(); I != E; ++I) {
4184 if (I) Constraint += ',';
4185 Constraint += "=*m";
4186 }
4187
4188 WriteHazard = llvm::InlineAsm::get(AsmFnTy, "", Constraint, true, false);
4189 }
4190}
4191
4192/// Emit a write hazard at the current location.
4193void FragileHazards::emitWriteHazard() {
4194 if (Locals.empty()) return;
4195
John McCall882987f2013-02-28 19:01:20 +00004196 CGF.EmitNounwindRuntimeCall(WriteHazard, Locals);
John McCall42227ed2010-07-31 23:20:56 +00004197}
4198
John McCall42227ed2010-07-31 23:20:56 +00004199void FragileHazards::emitReadHazard(CGBuilderTy &Builder) {
4200 assert(!Locals.empty());
John McCall882987f2013-02-28 19:01:20 +00004201 llvm::CallInst *call = Builder.CreateCall(ReadHazard, Locals);
4202 call->setDoesNotThrow();
4203 call->setCallingConv(CGF.getRuntimeCC());
John McCall42227ed2010-07-31 23:20:56 +00004204}
4205
4206/// Emit read hazards in all the protected blocks, i.e. all the blocks
4207/// which have been inserted since the beginning of the try.
John McCall2dd7d442010-08-04 05:59:32 +00004208void FragileHazards::emitHazardsInNewBlocks() {
John McCall42227ed2010-07-31 23:20:56 +00004209 if (Locals.empty()) return;
4210
John McCall7f416cc2015-09-08 08:05:57 +00004211 CGBuilderTy Builder(CGF, CGF.getLLVMContext());
John McCall42227ed2010-07-31 23:20:56 +00004212
4213 // Iterate through all blocks, skipping those prior to the try.
4214 for (llvm::Function::iterator
4215 FI = CGF.CurFn->begin(), FE = CGF.CurFn->end(); FI != FE; ++FI) {
4216 llvm::BasicBlock &BB = *FI;
4217 if (BlocksBeforeTry.count(&BB)) continue;
4218
4219 // Walk through all the calls in the block.
4220 for (llvm::BasicBlock::iterator
4221 BI = BB.begin(), BE = BB.end(); BI != BE; ++BI) {
4222 llvm::Instruction &I = *BI;
4223
4224 // Ignore instructions that aren't non-intrinsic calls.
4225 // These are the only calls that can possibly call longjmp.
James Y Knight3933add2019-01-30 02:54:28 +00004226 if (!isa<llvm::CallInst>(I) && !isa<llvm::InvokeInst>(I))
4227 continue;
John McCall42227ed2010-07-31 23:20:56 +00004228 if (isa<llvm::IntrinsicInst>(I))
4229 continue;
4230
4231 // Ignore call sites marked nounwind. This may be questionable,
4232 // since 'nounwind' doesn't necessarily mean 'does not call longjmp'.
James Y Knight3933add2019-01-30 02:54:28 +00004233 if (cast<llvm::CallBase>(I).doesNotThrow())
4234 continue;
John McCall42227ed2010-07-31 23:20:56 +00004235
John McCall2dd7d442010-08-04 05:59:32 +00004236 // Insert a read hazard before the call. This will ensure that
4237 // any writes to the locals are performed before making the
4238 // call. If the call throws, then this is sufficient to
4239 // guarantee correctness as long as it doesn't also write to any
4240 // locals.
John McCall42227ed2010-07-31 23:20:56 +00004241 Builder.SetInsertPoint(&BB, BI);
4242 emitReadHazard(Builder);
4243 }
4244 }
4245}
4246
John McCall7f416cc2015-09-08 08:05:57 +00004247static void addIfPresent(llvm::DenseSet<llvm::Value*> &S, Address V) {
4248 if (V.isValid()) S.insert(V.getPointer());
4249}
4250
John McCall42227ed2010-07-31 23:20:56 +00004251void FragileHazards::collectLocals() {
4252 // Compute a set of allocas to ignore.
4253 llvm::DenseSet<llvm::Value*> AllocasToIgnore;
4254 addIfPresent(AllocasToIgnore, CGF.ReturnValue);
4255 addIfPresent(AllocasToIgnore, CGF.NormalCleanupDest);
John McCall42227ed2010-07-31 23:20:56 +00004256
4257 // Collect all the allocas currently in the function. This is
4258 // probably way too aggressive.
4259 llvm::BasicBlock &Entry = CGF.CurFn->getEntryBlock();
4260 for (llvm::BasicBlock::iterator
4261 I = Entry.begin(), E = Entry.end(); I != E; ++I)
4262 if (isa<llvm::AllocaInst>(*I) && !AllocasToIgnore.count(&*I))
4263 Locals.push_back(&*I);
4264}
4265
4266llvm::FunctionType *FragileHazards::GetAsmFnType() {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004267 SmallVector<llvm::Type *, 16> tys(Locals.size());
John McCall9dc0db22011-05-15 01:53:33 +00004268 for (unsigned i = 0, e = Locals.size(); i != e; ++i)
4269 tys[i] = Locals[i]->getType();
4270 return llvm::FunctionType::get(CGF.VoidTy, tys, false);
John McCall65bea082010-07-21 06:59:36 +00004271}
4272
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004273/*
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004274
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004275 Objective-C setjmp-longjmp (sjlj) Exception Handling
4276 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004277
John McCallbd309292010-07-06 01:34:17 +00004278 A catch buffer is a setjmp buffer plus:
4279 - a pointer to the exception that was caught
4280 - a pointer to the previous exception data buffer
4281 - two pointers of reserved storage
4282 Therefore catch buffers form a stack, with a pointer to the top
4283 of the stack kept in thread-local storage.
4284
4285 objc_exception_try_enter pushes a catch buffer onto the EH stack.
4286 objc_exception_try_exit pops the given catch buffer, which is
4287 required to be the top of the EH stack.
4288 objc_exception_throw pops the top of the EH stack, writes the
4289 thrown exception into the appropriate field, and longjmps
4290 to the setjmp buffer. It crashes the process (with a printf
4291 and an abort()) if there are no catch buffers on the stack.
4292 objc_exception_extract just reads the exception pointer out of the
4293 catch buffer.
4294
4295 There's no reason an implementation couldn't use a light-weight
4296 setjmp here --- something like __builtin_setjmp, but API-compatible
4297 with the heavyweight setjmp. This will be more important if we ever
4298 want to implement correct ObjC/C++ exception interactions for the
4299 fragile ABI.
4300
4301 Note that for this use of setjmp/longjmp to be correct, we may need
4302 to mark some local variables volatile: if a non-volatile local
4303 variable is modified between the setjmp and the longjmp, it has
4304 indeterminate value. For the purposes of LLVM IR, it may be
4305 sufficient to make loads and stores within the @try (to variables
4306 declared outside the @try) volatile. This is necessary for
4307 optimized correctness, but is not currently being done; this is
4308 being tracked as rdar://problem/8160285
4309
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004310 The basic framework for a @try-catch-finally is as follows:
4311 {
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004312 objc_exception_data d;
4313 id _rethrow = null;
Anders Carlssonda0e4562009-02-07 21:26:04 +00004314 bool _call_try_exit = true;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004315
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004316 objc_exception_try_enter(&d);
4317 if (!setjmp(d.jmp_buf)) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004318 ... try body ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004319 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004320 // exception path
4321 id _caught = objc_exception_extract(&d);
4322
4323 // enter new try scope for handlers
4324 if (!setjmp(d.jmp_buf)) {
4325 ... match exception and execute catch blocks ...
4326
4327 // fell off end, rethrow.
4328 _rethrow = _caught;
4329 ... jump-through-finally to finally_rethrow ...
4330 } else {
4331 // exception in catch block
4332 _rethrow = objc_exception_extract(&d);
4333 _call_try_exit = false;
4334 ... jump-through-finally to finally_rethrow ...
4335 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004336 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004337 ... jump-through-finally to finally_end ...
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004338
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004339 finally:
Anders Carlssonda0e4562009-02-07 21:26:04 +00004340 if (_call_try_exit)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004341 objc_exception_try_exit(&d);
Anders Carlssonda0e4562009-02-07 21:26:04 +00004342
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004343 ... finally block ....
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004344 ... dispatch to finally destination ...
4345
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004346 finally_rethrow:
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004347 objc_exception_throw(_rethrow);
4348
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004349 finally_end:
4350 }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004351
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004352 This framework differs slightly from the one gcc uses, in that gcc
4353 uses _rethrow to determine if objc_exception_try_exit should be called
4354 and if the object should be rethrown. This breaks in the face of
4355 throwing nil and introduces unnecessary branches.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004356
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004357 We specialize this framework for a few particular circumstances:
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004358
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004359 - If there are no catch blocks, then we avoid emitting the second
4360 exception handling context.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004361
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004362 - If there is a catch-all catch block (i.e. @catch(...) or @catch(id
4363 e)) we avoid emitting the code to rethrow an uncaught exception.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004364
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004365 - FIXME: If there is no @finally block we can do a few more
4366 simplifications.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004367
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004368 Rethrows and Jumps-Through-Finally
4369 --
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004370
John McCallbd309292010-07-06 01:34:17 +00004371 '@throw;' is supported by pushing the currently-caught exception
4372 onto ObjCEHStack while the @catch blocks are emitted.
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004373
John McCallbd309292010-07-06 01:34:17 +00004374 Branches through the @finally block are handled with an ordinary
4375 normal cleanup. We do not register an EH cleanup; fragile-ABI ObjC
4376 exceptions are not compatible with C++ exceptions, and this is
4377 hardly the only place where this will go wrong.
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004378
John McCallbd309292010-07-06 01:34:17 +00004379 @synchronized(expr) { stmt; } is emitted as if it were:
4380 id synch_value = expr;
4381 objc_sync_enter(synch_value);
4382 @try { stmt; } @finally { objc_sync_exit(synch_value); }
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004383*/
4384
Fariborz Jahanianc2ad6dc2008-11-21 00:49:24 +00004385void CGObjCMac::EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
4386 const Stmt &S) {
4387 bool isTry = isa<ObjCAtTryStmt>(S);
John McCallbd309292010-07-06 01:34:17 +00004388
4389 // A destination for the fall-through edges of the catch handlers to
4390 // jump to.
4391 CodeGenFunction::JumpDest FinallyEnd =
4392 CGF.getJumpDestInCurrentScope("finally.end");
4393
4394 // A destination for the rethrow edge of the catch handlers to jump
4395 // to.
4396 CodeGenFunction::JumpDest FinallyRethrow =
4397 CGF.getJumpDestInCurrentScope("finally.rethrow");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004398
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004399 // For @synchronized, call objc_sync_enter(sync.expr). The
4400 // evaluation of the expression must occur before we enter the
John McCall2dd7d442010-08-04 05:59:32 +00004401 // @synchronized. We can't avoid a temp here because we need the
4402 // value to be preserved. If the backend ever does liveness
4403 // correctly after setjmp, this will be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00004404 Address SyncArgSlot = Address::invalid();
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004405 if (!isTry) {
John McCall2dd7d442010-08-04 05:59:32 +00004406 llvm::Value *SyncArg =
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004407 CGF.EmitScalarExpr(cast<ObjCAtSynchronizedStmt>(S).getSynchExpr());
4408 SyncArg = CGF.Builder.CreateBitCast(SyncArg, ObjCTypes.ObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004409 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSyncEnterFn(), SyncArg);
John McCall2dd7d442010-08-04 05:59:32 +00004410
John McCall7f416cc2015-09-08 08:05:57 +00004411 SyncArgSlot = CGF.CreateTempAlloca(SyncArg->getType(),
4412 CGF.getPointerAlign(), "sync.arg");
John McCall2dd7d442010-08-04 05:59:32 +00004413 CGF.Builder.CreateStore(SyncArg, SyncArgSlot);
Daniel Dunbar94ceb612009-02-24 01:43:46 +00004414 }
Daniel Dunbar2efd5382008-09-30 01:06:03 +00004415
John McCall2dd7d442010-08-04 05:59:32 +00004416 // Allocate memory for the setjmp buffer. This needs to be kept
4417 // live throughout the try and catch blocks.
John McCall7f416cc2015-09-08 08:05:57 +00004418 Address ExceptionData = CGF.CreateTempAlloca(ObjCTypes.ExceptionDataTy,
4419 CGF.getPointerAlign(),
4420 "exceptiondata.ptr");
John McCall2dd7d442010-08-04 05:59:32 +00004421
John McCall42227ed2010-07-31 23:20:56 +00004422 // Create the fragile hazards. Note that this will not capture any
4423 // of the allocas required for exception processing, but will
4424 // capture the current basic block (which extends all the way to the
4425 // setjmp call) as "before the @try".
4426 FragileHazards Hazards(CGF);
4427
John McCallbd309292010-07-06 01:34:17 +00004428 // Create a flag indicating whether the cleanup needs to call
4429 // objc_exception_try_exit. This is true except when
4430 // - no catches match and we're branching through the cleanup
4431 // just to rethrow the exception, or
4432 // - a catch matched and we're falling out of the catch handler.
John McCall2dd7d442010-08-04 05:59:32 +00004433 // The setjmp-safety rule here is that we should always store to this
4434 // variable in a place that dominates the branch through the cleanup
4435 // without passing through any setjmps.
John McCall7f416cc2015-09-08 08:05:57 +00004436 Address CallTryExitVar = CGF.CreateTempAlloca(CGF.Builder.getInt1Ty(),
4437 CharUnits::One(),
4438 "_call_try_exit");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004439
John McCall9916e3f2010-10-04 23:42:51 +00004440 // A slot containing the exception to rethrow. Only needed when we
4441 // have both a @catch and a @finally.
John McCall7f416cc2015-09-08 08:05:57 +00004442 Address PropagatingExnVar = Address::invalid();
John McCall9916e3f2010-10-04 23:42:51 +00004443
John McCallbd309292010-07-06 01:34:17 +00004444 // Push a normal cleanup to leave the try scope.
John McCall638d4f52013-04-03 00:56:07 +00004445 CGF.EHStack.pushCleanup<PerformFragileFinally>(NormalAndEHCleanup, &S,
John McCall2dd7d442010-08-04 05:59:32 +00004446 SyncArgSlot,
John McCallcda666c2010-07-21 07:22:38 +00004447 CallTryExitVar,
4448 ExceptionData,
4449 &ObjCTypes);
John McCallbd309292010-07-06 01:34:17 +00004450
4451 // Enter a try block:
4452 // - Call objc_exception_try_enter to push ExceptionData on top of
4453 // the EH stack.
Nico Weber6307cf02015-02-26 20:43:00 +00004454 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004455 ExceptionData.getPointer());
John McCallbd309292010-07-06 01:34:17 +00004456
4457 // - Call setjmp on the exception data buffer.
4458 llvm::Constant *Zero = llvm::ConstantInt::get(CGF.Builder.getInt32Ty(), 0);
4459 llvm::Value *GEPIndexes[] = { Zero, Zero, Zero };
David Blaikie6b2a8302015-04-03 17:47:16 +00004460 llvm::Value *SetJmpBuffer = CGF.Builder.CreateGEP(
John McCall7f416cc2015-09-08 08:05:57 +00004461 ObjCTypes.ExceptionDataTy, ExceptionData.getPointer(), GEPIndexes,
4462 "setjmp_buffer");
Nico Weber6307cf02015-02-26 20:43:00 +00004463 llvm::CallInst *SetJmpResult = CGF.EmitNounwindRuntimeCall(
4464 ObjCTypes.getSetJmpFn(), SetJmpBuffer, "setjmp_result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004465 SetJmpResult->setCanReturnTwice();
John McCallbd309292010-07-06 01:34:17 +00004466
4467 // If setjmp returned 0, enter the protected block; otherwise,
4468 // branch to the handler.
Daniel Dunbar75283ff2008-11-11 02:29:29 +00004469 llvm::BasicBlock *TryBlock = CGF.createBasicBlock("try");
4470 llvm::BasicBlock *TryHandler = CGF.createBasicBlock("try.handler");
John McCallbd309292010-07-06 01:34:17 +00004471 llvm::Value *DidCatch =
John McCallcebe0ca2010-08-11 00:16:14 +00004472 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4473 CGF.Builder.CreateCondBr(DidCatch, TryHandler, TryBlock);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004474
John McCallbd309292010-07-06 01:34:17 +00004475 // Emit the protected block.
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004476 CGF.EmitBlock(TryBlock);
John McCall2dd7d442010-08-04 05:59:32 +00004477 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004478 CGF.EmitStmt(isTry ? cast<ObjCAtTryStmt>(S).getTryBody()
John McCallbd309292010-07-06 01:34:17 +00004479 : cast<ObjCAtSynchronizedStmt>(S).getSynchBody());
John McCall2dd7d442010-08-04 05:59:32 +00004480
4481 CGBuilderTy::InsertPoint TryFallthroughIP = CGF.Builder.saveAndClearIP();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004482
John McCallbd309292010-07-06 01:34:17 +00004483 // Emit the exception handler block.
Daniel Dunbar7f086782008-09-27 23:30:04 +00004484 CGF.EmitBlock(TryHandler);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004485
John McCall42227ed2010-07-31 23:20:56 +00004486 // Don't optimize loads of the in-scope locals across this point.
4487 Hazards.emitWriteHazard();
4488
John McCallbd309292010-07-06 01:34:17 +00004489 // For a @synchronized (or a @try with no catches), just branch
4490 // through the cleanup to the rethrow block.
4491 if (!isTry || !cast<ObjCAtTryStmt>(S).getNumCatchStmts()) {
4492 // Tell the cleanup not to re-pop the exit.
John McCall2dd7d442010-08-04 05:59:32 +00004493 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004494 CGF.EmitBranchThroughCleanup(FinallyRethrow);
John McCallbd309292010-07-06 01:34:17 +00004495
4496 // Otherwise, we have to match against the caught exceptions.
4497 } else {
John McCall2dd7d442010-08-04 05:59:32 +00004498 // Retrieve the exception object. We may emit multiple blocks but
4499 // nothing can cross this so the value is already in SSA form.
4500 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004501 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004502 ExceptionData.getPointer(), "caught");
John McCall2dd7d442010-08-04 05:59:32 +00004503
John McCallbd309292010-07-06 01:34:17 +00004504 // Push the exception to rethrow onto the EH value stack for the
4505 // benefit of any @throws in the handlers.
4506 CGF.ObjCEHValueStack.push_back(Caught);
4507
Douglas Gregor96c79492010-04-23 22:50:49 +00004508 const ObjCAtTryStmt* AtTryStmt = cast<ObjCAtTryStmt>(&S);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004509
Craig Topper8a13c412014-05-21 05:09:00 +00004510 bool HasFinally = (AtTryStmt->getFinallyStmt() != nullptr);
John McCallbd309292010-07-06 01:34:17 +00004511
Craig Topper8a13c412014-05-21 05:09:00 +00004512 llvm::BasicBlock *CatchBlock = nullptr;
4513 llvm::BasicBlock *CatchHandler = nullptr;
John McCall2dd7d442010-08-04 05:59:32 +00004514 if (HasFinally) {
John McCall9916e3f2010-10-04 23:42:51 +00004515 // Save the currently-propagating exception before
4516 // objc_exception_try_enter clears the exception slot.
4517 PropagatingExnVar = CGF.CreateTempAlloca(Caught->getType(),
John McCall7f416cc2015-09-08 08:05:57 +00004518 CGF.getPointerAlign(),
John McCall9916e3f2010-10-04 23:42:51 +00004519 "propagating_exception");
4520 CGF.Builder.CreateStore(Caught, PropagatingExnVar);
4521
John McCall2dd7d442010-08-04 05:59:32 +00004522 // Enter a new exception try block (in case a @catch block
4523 // throws an exception).
John McCall882987f2013-02-28 19:01:20 +00004524 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionTryEnterFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004525 ExceptionData.getPointer());
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004526
John McCall2dd7d442010-08-04 05:59:32 +00004527 llvm::CallInst *SetJmpResult =
John McCall882987f2013-02-28 19:01:20 +00004528 CGF.EmitNounwindRuntimeCall(ObjCTypes.getSetJmpFn(),
4529 SetJmpBuffer, "setjmp.result");
Bill Wendlingbd26cf92011-12-19 23:53:28 +00004530 SetJmpResult->setCanReturnTwice();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004531
John McCall2dd7d442010-08-04 05:59:32 +00004532 llvm::Value *Threw =
4533 CGF.Builder.CreateIsNotNull(SetJmpResult, "did_catch_exception");
4534
4535 CatchBlock = CGF.createBasicBlock("catch");
4536 CatchHandler = CGF.createBasicBlock("catch_for_catch");
4537 CGF.Builder.CreateCondBr(Threw, CatchHandler, CatchBlock);
4538
4539 CGF.EmitBlock(CatchBlock);
4540 }
4541
4542 CGF.Builder.CreateStore(CGF.Builder.getInt1(HasFinally), CallTryExitVar);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004543
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004544 // Handle catch list. As a special case we check if everything is
4545 // matched and avoid generating code for falling off the end if
4546 // so.
4547 bool AllMatched = false;
Douglas Gregor96c79492010-04-23 22:50:49 +00004548 for (unsigned I = 0, N = AtTryStmt->getNumCatchStmts(); I != N; ++I) {
4549 const ObjCAtCatchStmt *CatchStmt = AtTryStmt->getCatchStmt(I);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004550
Douglas Gregor46a572b2010-04-26 16:46:50 +00004551 const VarDecl *CatchParam = CatchStmt->getCatchParamDecl();
Craig Topper8a13c412014-05-21 05:09:00 +00004552 const ObjCObjectPointerType *OPT = nullptr;
Daniel Dunbar523208f2008-09-27 07:36:24 +00004553
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004554 // catch(...) always matches.
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004555 if (!CatchParam) {
4556 AllMatched = true;
4557 } else {
John McCall9dd450b2009-09-21 23:43:11 +00004558 OPT = CatchParam->getType()->getAs<ObjCObjectPointerType>();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004559
John McCallbd309292010-07-06 01:34:17 +00004560 // catch(id e) always matches under this ABI, since only
4561 // ObjC exceptions end up here in the first place.
Daniel Dunbar86919f42008-09-27 22:21:14 +00004562 // FIXME: For the time being we also match id<X>; this should
4563 // be rejected by Sema instead.
Eli Friedman55179ca2009-07-11 00:57:02 +00004564 if (OPT && (OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()))
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004565 AllMatched = true;
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004566 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004567
John McCallbd309292010-07-06 01:34:17 +00004568 // If this is a catch-all, we don't need to test anything.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004569 if (AllMatched) {
John McCallbd309292010-07-06 01:34:17 +00004570 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
4571
Anders Carlsson9396a892008-09-11 09:15:33 +00004572 if (CatchParam) {
John McCall1c9c3fd2010-10-15 04:57:14 +00004573 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004574 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
John McCallbd309292010-07-06 01:34:17 +00004575
4576 // These types work out because ConvertType(id) == i8*.
John McCall17f02752015-10-30 00:56:02 +00004577 EmitInitOfCatchParam(CGF, Caught, CatchParam);
Anders Carlsson9396a892008-09-11 09:15:33 +00004578 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004579
Anders Carlsson9396a892008-09-11 09:15:33 +00004580 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004581
4582 // The scope of the catch variable ends right here.
4583 CatchVarCleanups.ForceCleanup();
4584
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004585 CGF.EmitBranchThroughCleanup(FinallyEnd);
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004586 break;
4587 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004588
Steve Naroff7cae42b2009-07-10 23:34:53 +00004589 assert(OPT && "Unexpected non-object pointer type in @catch");
John McCall96fa4842010-05-17 21:00:27 +00004590 const ObjCObjectType *ObjTy = OPT->getObjectType();
John McCallbd309292010-07-06 01:34:17 +00004591
4592 // FIXME: @catch (Class c) ?
John McCall96fa4842010-05-17 21:00:27 +00004593 ObjCInterfaceDecl *IDecl = ObjTy->getInterface();
4594 assert(IDecl && "Catch parameter must have Objective-C type!");
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004595
4596 // Check if the @catch block matches the exception object.
John McCall882987f2013-02-28 19:01:20 +00004597 llvm::Value *Class = EmitClassRef(CGF, IDecl);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004598
John McCall882987f2013-02-28 19:01:20 +00004599 llvm::Value *matchArgs[] = { Class, Caught };
John McCallbd309292010-07-06 01:34:17 +00004600 llvm::CallInst *Match =
John McCall882987f2013-02-28 19:01:20 +00004601 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionMatchFn(),
4602 matchArgs, "match");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004603
John McCallbd309292010-07-06 01:34:17 +00004604 llvm::BasicBlock *MatchedBlock = CGF.createBasicBlock("match");
4605 llvm::BasicBlock *NextCatchBlock = CGF.createBasicBlock("catch.next");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004606
4607 CGF.Builder.CreateCondBr(CGF.Builder.CreateIsNotNull(Match, "matched"),
Daniel Dunbar7f086782008-09-27 23:30:04 +00004608 MatchedBlock, NextCatchBlock);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004609
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004610 // Emit the @catch block.
4611 CGF.EmitBlock(MatchedBlock);
John McCallbd309292010-07-06 01:34:17 +00004612
4613 // Collect any cleanups for the catch variable. The scope lasts until
4614 // the end of the catch body.
John McCall2dd7d442010-08-04 05:59:32 +00004615 CodeGenFunction::RunCleanupsScope CatchVarCleanups(CGF);
John McCallbd309292010-07-06 01:34:17 +00004616
John McCall1c9c3fd2010-10-15 04:57:14 +00004617 CGF.EmitAutoVarDecl(*CatchParam);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004618 assert(CGF.HaveInsertPoint() && "DeclStmt destroyed insert point?");
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004619
John McCallbd309292010-07-06 01:34:17 +00004620 // Initialize the catch variable.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004621 llvm::Value *Tmp =
4622 CGF.Builder.CreateBitCast(Caught,
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004623 CGF.ConvertType(CatchParam->getType()));
John McCall17f02752015-10-30 00:56:02 +00004624 EmitInitOfCatchParam(CGF, Tmp, CatchParam);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004625
Anders Carlsson9396a892008-09-11 09:15:33 +00004626 CGF.EmitStmt(CatchStmt->getCatchBody());
John McCallbd309292010-07-06 01:34:17 +00004627
4628 // We're done with the catch variable.
4629 CatchVarCleanups.ForceCleanup();
4630
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004631 CGF.EmitBranchThroughCleanup(FinallyEnd);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004632
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004633 CGF.EmitBlock(NextCatchBlock);
4634 }
4635
John McCallbd309292010-07-06 01:34:17 +00004636 CGF.ObjCEHValueStack.pop_back();
4637
John McCall2dd7d442010-08-04 05:59:32 +00004638 // If nothing wanted anything to do with the caught exception,
4639 // kill the extract call.
4640 if (Caught->use_empty())
4641 Caught->eraseFromParent();
4642
4643 if (!AllMatched)
4644 CGF.EmitBranchThroughCleanup(FinallyRethrow);
4645
4646 if (HasFinally) {
4647 // Emit the exception handler for the @catch blocks.
4648 CGF.EmitBlock(CatchHandler);
4649
4650 // In theory we might now need a write hazard, but actually it's
4651 // unnecessary because there's no local-accessing code between
4652 // the try's write hazard and here.
4653 //Hazards.emitWriteHazard();
4654
John McCall9916e3f2010-10-04 23:42:51 +00004655 // Extract the new exception and save it to the
4656 // propagating-exception slot.
John McCall7f416cc2015-09-08 08:05:57 +00004657 assert(PropagatingExnVar.isValid());
John McCall9916e3f2010-10-04 23:42:51 +00004658 llvm::CallInst *NewCaught =
John McCall882987f2013-02-28 19:01:20 +00004659 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004660 ExceptionData.getPointer(), "caught");
John McCall9916e3f2010-10-04 23:42:51 +00004661 CGF.Builder.CreateStore(NewCaught, PropagatingExnVar);
4662
John McCall2dd7d442010-08-04 05:59:32 +00004663 // Don't pop the catch handler; the throw already did.
4664 CGF.Builder.CreateStore(CGF.Builder.getFalse(), CallTryExitVar);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004665 CGF.EmitBranchThroughCleanup(FinallyRethrow);
Daniel Dunbarb22ff592008-09-27 07:03:52 +00004666 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004667 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004668
John McCall42227ed2010-07-31 23:20:56 +00004669 // Insert read hazards as required in the new blocks.
John McCall2dd7d442010-08-04 05:59:32 +00004670 Hazards.emitHazardsInNewBlocks();
John McCall42227ed2010-07-31 23:20:56 +00004671
John McCallbd309292010-07-06 01:34:17 +00004672 // Pop the cleanup.
John McCall2dd7d442010-08-04 05:59:32 +00004673 CGF.Builder.restoreIP(TryFallthroughIP);
4674 if (CGF.HaveInsertPoint())
4675 CGF.Builder.CreateStore(CGF.Builder.getTrue(), CallTryExitVar);
John McCallbd309292010-07-06 01:34:17 +00004676 CGF.PopCleanupBlock();
John McCall2dd7d442010-08-04 05:59:32 +00004677 CGF.EmitBlock(FinallyEnd.getBlock(), true);
Anders Carlssonbfee7e92009-02-09 20:38:58 +00004678
John McCallbd309292010-07-06 01:34:17 +00004679 // Emit the rethrow block.
John McCall42227ed2010-07-31 23:20:56 +00004680 CGBuilderTy::InsertPoint SavedIP = CGF.Builder.saveAndClearIP();
John McCallad5d61e2010-07-23 21:56:41 +00004681 CGF.EmitBlock(FinallyRethrow.getBlock(), true);
John McCallbd309292010-07-06 01:34:17 +00004682 if (CGF.HaveInsertPoint()) {
John McCall9916e3f2010-10-04 23:42:51 +00004683 // If we have a propagating-exception variable, check it.
4684 llvm::Value *PropagatingExn;
John McCall7f416cc2015-09-08 08:05:57 +00004685 if (PropagatingExnVar.isValid()) {
John McCall9916e3f2010-10-04 23:42:51 +00004686 PropagatingExn = CGF.Builder.CreateLoad(PropagatingExnVar);
John McCall2dd7d442010-08-04 05:59:32 +00004687
John McCall9916e3f2010-10-04 23:42:51 +00004688 // Otherwise, just look in the buffer for the exception to throw.
4689 } else {
4690 llvm::CallInst *Caught =
John McCall882987f2013-02-28 19:01:20 +00004691 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionExtractFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004692 ExceptionData.getPointer());
John McCall9916e3f2010-10-04 23:42:51 +00004693 PropagatingExn = Caught;
4694 }
4695
John McCall882987f2013-02-28 19:01:20 +00004696 CGF.EmitNounwindRuntimeCall(ObjCTypes.getExceptionThrowFn(),
4697 PropagatingExn);
John McCallbd309292010-07-06 01:34:17 +00004698 CGF.Builder.CreateUnreachable();
Fariborz Jahaniane2caaaa2008-11-21 19:21:53 +00004699 }
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004700
John McCall42227ed2010-07-31 23:20:56 +00004701 CGF.Builder.restoreIP(SavedIP);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004702}
4703
4704void CGObjCMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004705 const ObjCAtThrowStmt &S,
4706 bool ClearInsertionPoint) {
Anders Carlssone005aa12008-09-09 16:16:55 +00004707 llvm::Value *ExceptionAsObject;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004708
Anders Carlssone005aa12008-09-09 16:16:55 +00004709 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00004710 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004711 ExceptionAsObject =
Benjamin Kramer76399eb2011-09-27 21:06:10 +00004712 CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
Anders Carlssone005aa12008-09-09 16:16:55 +00004713 } else {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004714 assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +00004715 "Unexpected rethrow outside @catch block.");
Anders Carlssonbf8a1be2009-02-07 21:37:21 +00004716 ExceptionAsObject = CGF.ObjCEHValueStack.back();
Anders Carlssone005aa12008-09-09 16:16:55 +00004717 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004718
John McCall882987f2013-02-28 19:01:20 +00004719 CGF.EmitRuntimeCall(ObjCTypes.getExceptionThrowFn(), ExceptionAsObject)
John McCallbd309292010-07-06 01:34:17 +00004720 ->setDoesNotReturn();
Anders Carlsson4f1c7c32008-09-09 17:59:25 +00004721 CGF.Builder.CreateUnreachable();
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00004722
4723 // Clear the insertion point to indicate we are in unreachable code.
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00004724 if (ClearInsertionPoint)
4725 CGF.Builder.ClearInsertionPoint();
Anders Carlsson1963b0c2008-09-09 10:04:29 +00004726}
4727
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004728/// EmitObjCWeakRead - Code gen for loading value of a __weak
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004729/// object: objc_read_weak (id *src)
4730///
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004731llvm::Value * CGObjCMac::EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004732 Address AddrWeakObj) {
4733 llvm::Type* DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004734 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj,
4735 ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00004736 llvm::Value *read_weak =
4737 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004738 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00004739 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanianf5125d12008-11-18 21:45:40 +00004740 return read_weak;
4741}
4742
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004743/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
4744/// objc_assign_weak (id src, id *dst)
4745///
4746void CGObjCMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004747 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004748 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004749 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004750 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004751 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004752 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4753 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004754 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4755 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004756 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4757 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004758 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004759 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
4760 args, "weakassign");
Fariborz Jahanian83f45b552008-11-18 22:37:34 +00004761}
4762
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004763/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
4764/// objc_assign_global (id src, id *dst)
4765///
4766void CGObjCMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004767 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00004768 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004769 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004770 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004771 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004772 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004773 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4774 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004775 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4776 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004777 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4778 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004779 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00004780 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00004781 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
4782 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00004783 else
John McCall882987f2013-02-28 19:01:20 +00004784 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
4785 args, "threadlocalassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004786}
4787
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004788/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004789/// objc_assign_ivar (id src, id *dst, ptrdiff_t ivaroffset)
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004790///
4791void CGObjCMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004792 llvm::Value *src, Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00004793 llvm::Value *ivarOffset) {
4794 assert(ivarOffset && "EmitObjCIvarAssign - ivarOffset is NULL");
Chris Lattner2192fe52011-07-18 04:24:23 +00004795 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004796 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004797 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004798 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004799 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4800 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004801 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4802 }
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004803 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4804 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004805 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00004806 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahaniane881b532008-11-20 19:23:36 +00004807}
4808
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004809/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
4810/// objc_assign_strongCast (id src, id *dst)
4811///
4812void CGObjCMac::EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004813 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00004814 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004815 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004816 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00004817 assert(Size <= 8 && "does not support size > 8");
John McCall176f8922016-11-30 02:39:18 +00004818 src = (Size == 4) ? CGF.Builder.CreateBitCast(src, CGM.Int32Ty)
4819 : CGF.Builder.CreateBitCast(src, CGM.Int64Ty);
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00004820 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
4821 }
Fariborz Jahanian50a12702008-11-19 17:34:06 +00004822 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
4823 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004824 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00004825 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
John McCall7f416cc2015-09-08 08:05:57 +00004826 args, "strongassign");
Fariborz Jahaniand7db9642008-11-19 00:59:10 +00004827}
4828
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004829void CGObjCMac::EmitGCMemmoveCollectable(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00004830 Address DestPtr,
4831 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00004832 llvm::Value *size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004833 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
4834 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00004835 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), size };
John McCall882987f2013-02-28 19:01:20 +00004836 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00004837}
4838
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004839/// EmitObjCValueForIvar - Code Gen for ivar reference.
4840///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004841LValue CGObjCMac::EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
4842 QualType ObjectTy,
4843 llvm::Value *BaseValue,
4844 const ObjCIvarDecl *Ivar,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00004845 unsigned CVRQualifiers) {
John McCall8b07ec22010-05-15 11:32:37 +00004846 const ObjCInterfaceDecl *ID =
4847 ObjectTy->getAs<ObjCObjectType>()->getInterface();
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00004848 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
4849 EmitIvarOffset(CGF, ID, Ivar));
Fariborz Jahanian9f84b782009-02-02 20:02:29 +00004850}
4851
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004852llvm::Value *CGObjCMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar722f4242009-04-22 05:08:15 +00004853 const ObjCInterfaceDecl *Interface,
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004854 const ObjCIvarDecl *Ivar) {
Eli Friedman8cbca202012-11-06 22:15:52 +00004855 uint64_t Offset = ComputeIvarBaseOffset(CGM, Interface, Ivar);
4856 return llvm::ConstantInt::get(
4857 CGM.getTypes().ConvertType(CGM.getContext().LongTy),
4858 Offset);
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00004859}
4860
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004861/* *** Private Interface *** */
4862
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00004863std::string CGObjCCommonMac::GetSectionName(StringRef Section,
4864 StringRef MachOAttributes) {
4865 switch (CGM.getTriple().getObjectFormat()) {
4866 default:
4867 llvm_unreachable("unexpected object file format");
4868 case llvm::Triple::MachO: {
4869 if (MachOAttributes.empty())
4870 return ("__DATA," + Section).str();
4871 return ("__DATA," + Section + "," + MachOAttributes).str();
4872 }
4873 case llvm::Triple::ELF:
4874 assert(Section.substr(0, 2) == "__" &&
4875 "expected the name to begin with __");
4876 return Section.substr(2).str();
4877 case llvm::Triple::COFF:
4878 assert(Section.substr(0, 2) == "__" &&
4879 "expected the name to begin with __");
4880 return ("." + Section.substr(2) + "$B").str();
4881 }
4882}
4883
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004884/// EmitImageInfo - Emit the image info marker used to encode some module
4885/// level information.
4886///
4887/// See: <rdr://4810609&4810587&4810587>
4888/// struct IMAGE_INFO {
4889/// unsigned version;
4890/// unsigned flags;
4891/// };
4892enum ImageInfoFlags {
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004893 eImageInfo_FixAndContinue = (1 << 0), // This flag is no longer set by clang.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004894 eImageInfo_GarbageCollected = (1 << 1),
4895 eImageInfo_GCOnly = (1 << 2),
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004896 eImageInfo_OptimizedByDyld = (1 << 3), // This flag is set by the dyld shared cache.
Daniel Dunbar75e909f2009-04-20 07:11:47 +00004897
Daniel Dunbar5e639272010-04-25 20:39:01 +00004898 // A flag indicating that the module has no instances of a @synthesize of a
4899 // superclass variable. <rdar://problem/6803242>
Fariborz Jahanian39c17a82014-01-14 22:01:08 +00004900 eImageInfo_CorrectedSynthesize = (1 << 4), // This flag is no longer set by clang.
Manman Ren96df0b32016-01-29 23:45:01 +00004901 eImageInfo_ImageIsSimulated = (1 << 5),
4902 eImageInfo_ClassProperties = (1 << 6)
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004903};
4904
Daniel Dunbar5e639272010-04-25 20:39:01 +00004905void CGObjCCommonMac::EmitImageInfo() {
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004906 unsigned version = 0; // Version is unused?
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00004907 std::string Section =
4908 (ObjCABI == 1)
4909 ? "__OBJC,__image_info,regular"
4910 : GetSectionName("__objc_imageinfo", "regular,no_dead_strip");
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004911
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004912 // Generate module-level named metadata to convey this information to the
4913 // linker and code-gen.
4914 llvm::Module &Mod = CGM.getModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004915
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004916 // Add the ObjC ABI version to the module flags.
4917 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Version", ObjCABI);
4918 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Version",
4919 version);
4920 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Image Info Section",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00004921 llvm::MDString::get(VMContext, Section));
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004922
David Blaikiebbafb8a2012-03-11 07:00:24 +00004923 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004924 // Non-GC overrides those files which specify GC.
4925 Mod.addModuleFlag(llvm::Module::Override,
4926 "Objective-C Garbage Collection", (uint32_t)0);
4927 } else {
4928 // Add the ObjC garbage collection value.
4929 Mod.addModuleFlag(llvm::Module::Error,
4930 "Objective-C Garbage Collection",
4931 eImageInfo_GarbageCollected);
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00004932
David Blaikiebbafb8a2012-03-11 07:00:24 +00004933 if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004934 // Add the ObjC GC Only value.
4935 Mod.addModuleFlag(llvm::Module::Error, "Objective-C GC Only",
4936 eImageInfo_GCOnly);
4937
4938 // Require that GC be specified and set to eImageInfo_GarbageCollected.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +00004939 llvm::Metadata *Ops[2] = {
4940 llvm::MDString::get(VMContext, "Objective-C Garbage Collection"),
4941 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
4942 llvm::Type::getInt32Ty(VMContext), eImageInfo_GarbageCollected))};
Bill Wendlingb6f795e2012-02-16 01:13:30 +00004943 Mod.addModuleFlag(llvm::Module::Require, "Objective-C GC Only",
4944 llvm::MDNode::get(VMContext, Ops));
4945 }
4946 }
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004947
4948 // Indicate whether we're compiling this to run on a simulator.
Alex Lorenz6cdef0e2017-12-07 19:04:10 +00004949 if (CGM.getTarget().getTriple().isSimulatorEnvironment())
Bill Wendling1e60a2c2012-04-24 11:04:57 +00004950 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Is Simulated",
4951 eImageInfo_ImageIsSimulated);
Manman Ren96df0b32016-01-29 23:45:01 +00004952
4953 // Indicate whether we are generating class properties.
4954 Mod.addModuleFlag(llvm::Module::Error, "Objective-C Class Properties",
4955 eImageInfo_ClassProperties);
Daniel Dunbar3ad53482008-08-11 21:35:06 +00004956}
4957
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004958// struct objc_module {
4959// unsigned long version;
4960// unsigned long size;
4961// const char *name;
4962// Symtab symtab;
4963// };
4964
4965// FIXME: Get from somewhere
4966static const int ModuleVersion = 7;
4967
4968void CGObjCMac::EmitModuleInfo() {
Micah Villmowdd31ca12012-10-08 16:25:52 +00004969 uint64_t Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ModuleTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00004970
John McCall176f8922016-11-30 02:39:18 +00004971 ConstantInitBuilder builder(CGM);
4972 auto values = builder.beginStruct(ObjCTypes.ModuleTy);
4973 values.addInt(ObjCTypes.LongTy, ModuleVersion);
4974 values.addInt(ObjCTypes.LongTy, Size);
4975 // This used to be the filename, now it is unused. <rdr://4327263>
4976 values.add(GetClassName(StringRef("")));
4977 values.add(EmitModuleSymbols());
4978 CreateMetadataVar("OBJC_MODULES", values,
John McCall7f416cc2015-09-08 08:05:57 +00004979 "__OBJC,__module_info,regular,no_dead_strip",
4980 CGM.getPointerAlign(), true);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00004981}
4982
4983llvm::Constant *CGObjCMac::EmitModuleSymbols() {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004984 unsigned NumClasses = DefinedClasses.size();
4985 unsigned NumCategories = DefinedCategories.size();
4986
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004987 // Return null if no symbols were defined.
4988 if (!NumClasses && !NumCategories)
Owen Anderson0b75f232009-07-31 20:28:54 +00004989 return llvm::Constant::getNullValue(ObjCTypes.SymtabPtrTy);
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00004990
John McCall176f8922016-11-30 02:39:18 +00004991 ConstantInitBuilder builder(CGM);
4992 auto values = builder.beginStruct();
4993 values.addInt(ObjCTypes.LongTy, 0);
4994 values.addNullPointer(ObjCTypes.SelectorPtrTy);
4995 values.addInt(ObjCTypes.ShortTy, NumClasses);
4996 values.addInt(ObjCTypes.ShortTy, NumCategories);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00004997
Daniel Dunbar938a77f2008-08-22 20:34:54 +00004998 // The runtime expects exactly the list of defined classes followed
4999 // by the list of defined categories, in a single array.
John McCall176f8922016-11-30 02:39:18 +00005000 auto array = values.beginArray(ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005001 for (unsigned i=0; i<NumClasses; i++) {
5002 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
5003 assert(ID);
5004 if (ObjCImplementationDecl *IMP = ID->getImplementation())
5005 // We are implementing a weak imported interface. Give it external linkage
5006 if (ID->isWeakImported() && !IMP->isWeakImported())
5007 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
John McCall176f8922016-11-30 02:39:18 +00005008
5009 array.addBitCast(DefinedClasses[i], ObjCTypes.Int8PtrTy);
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00005010 }
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005011 for (unsigned i=0; i<NumCategories; i++)
John McCall176f8922016-11-30 02:39:18 +00005012 array.addBitCast(DefinedCategories[i], ObjCTypes.Int8PtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005013
John McCall176f8922016-11-30 02:39:18 +00005014 array.finishAndAddTo(values);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005015
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005016 llvm::GlobalVariable *GV = CreateMetadataVar(
John McCall176f8922016-11-30 02:39:18 +00005017 "OBJC_SYMBOLS", values, "__OBJC,__symbols,regular,no_dead_strip",
John McCall7f416cc2015-09-08 08:05:57 +00005018 CGM.getPointerAlign(), true);
Owen Andersonade90fd2009-07-29 18:54:39 +00005019 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.SymtabPtrTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005020}
5021
John McCall882987f2013-02-28 19:01:20 +00005022llvm::Value *CGObjCMac::EmitClassRefFromId(CodeGenFunction &CGF,
5023 IdentifierInfo *II) {
John McCall31168b02011-06-15 23:02:42 +00005024 LazySymbols.insert(II);
Fangrui Song6907ce22018-07-30 19:24:48 +00005025
John McCall31168b02011-06-15 23:02:42 +00005026 llvm::GlobalVariable *&Entry = ClassReferences[II];
Fangrui Song6907ce22018-07-30 19:24:48 +00005027
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005028 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005029 llvm::Constant *Casted =
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005030 llvm::ConstantExpr::getBitCast(GetClassName(II->getName()),
John McCall31168b02011-06-15 23:02:42 +00005031 ObjCTypes.ClassPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005032 Entry = CreateMetadataVar(
5033 "OBJC_CLASS_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00005034 "__OBJC,__cls_refs,literal_pointers,no_dead_strip",
5035 CGM.getPointerAlign(), true);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005036 }
Fangrui Song6907ce22018-07-30 19:24:48 +00005037
John McCall7f416cc2015-09-08 08:05:57 +00005038 return CGF.Builder.CreateAlignedLoad(Entry, CGF.getPointerAlign());
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005039}
5040
John McCall882987f2013-02-28 19:01:20 +00005041llvm::Value *CGObjCMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00005042 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00005043 // If the class has the objc_runtime_visible attribute, we need to
5044 // use the Objective-C runtime to get the class.
5045 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
5046 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
5047
Akira Hatanaka0c194462018-04-03 22:50:16 +00005048 IdentifierInfo *RuntimeName =
5049 &CGM.getContext().Idents.get(ID->getObjCRuntimeNameAsString());
5050 return EmitClassRefFromId(CGF, RuntimeName);
John McCall31168b02011-06-15 23:02:42 +00005051}
5052
John McCall882987f2013-02-28 19:01:20 +00005053llvm::Value *CGObjCMac::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00005054 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCall882987f2013-02-28 19:01:20 +00005055 return EmitClassRefFromId(CGF, II);
John McCall31168b02011-06-15 23:02:42 +00005056}
5057
John McCall7f416cc2015-09-08 08:05:57 +00005058llvm::Value *CGObjCMac::EmitSelector(CodeGenFunction &CGF, Selector Sel) {
5059 return CGF.Builder.CreateLoad(EmitSelectorAddr(CGF, Sel));
5060}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005061
John McCall7f416cc2015-09-08 08:05:57 +00005062Address CGObjCMac::EmitSelectorAddr(CodeGenFunction &CGF, Selector Sel) {
5063 CharUnits Align = CGF.getPointerAlign();
5064
5065 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005066 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005067 llvm::Constant *Casted =
Owen Andersonade90fd2009-07-29 18:54:39 +00005068 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005069 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005070 Entry = CreateMetadataVar(
5071 "OBJC_SELECTOR_REFERENCES_", Casted,
John McCall7f416cc2015-09-08 08:05:57 +00005072 "__OBJC,__message_refs,literal_pointers,no_dead_strip", Align, true);
Michael Gottesman5c205962013-02-05 23:08:45 +00005073 Entry->setExternallyInitialized(true);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005074 }
5075
John McCall7f416cc2015-09-08 08:05:57 +00005076 return Address(Entry, Align);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005077}
5078
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005079llvm::Constant *CGObjCCommonMac::GetClassName(StringRef RuntimeName) {
5080 llvm::GlobalVariable *&Entry = ClassNames[RuntimeName];
5081 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005082 Entry = CreateCStringLiteral(RuntimeName, ObjCLabelType::ClassName);
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00005083 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005084}
5085
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00005086llvm::Function *CGObjCCommonMac::GetMethodDefinition(const ObjCMethodDecl *MD) {
5087 llvm::DenseMap<const ObjCMethodDecl*, llvm::Function*>::iterator
5088 I = MethodDefinitions.find(MD);
5089 if (I != MethodDefinitions.end())
5090 return I->second;
5091
Craig Topper8a13c412014-05-21 05:09:00 +00005092 return nullptr;
Argyrios Kyrtzidis13257c52010-08-09 10:54:20 +00005093}
5094
Fariborz Jahanian01dff422009-03-05 19:17:31 +00005095/// GetIvarLayoutName - Returns a unique constant for the given
5096/// ivar layout bitmap.
5097llvm::Constant *CGObjCCommonMac::GetIvarLayoutName(IdentifierInfo *Ident,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005098 const ObjCCommonTypesHelper &ObjCTypes) {
Owen Anderson0b75f232009-07-31 20:28:54 +00005099 return llvm::Constant::getNullValue(ObjCTypes.Int8PtrTy);
Fariborz Jahanian01dff422009-03-05 19:17:31 +00005100}
5101
John McCall3fd13f062015-10-21 18:06:47 +00005102void IvarLayoutBuilder::visitRecord(const RecordType *RT,
5103 CharUnits offset) {
Daniel Dunbar15bd8882009-05-03 14:10:34 +00005104 const RecordDecl *RD = RT->getDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005105
John McCall3fd13f062015-10-21 18:06:47 +00005106 // If this is a union, remember that we had one, because it might mess
5107 // up the ordering of layout entries.
5108 if (RD->isUnion())
5109 IsDisordered = true;
5110
5111 const ASTRecordLayout *recLayout = nullptr;
5112 visitAggregate(RD->field_begin(), RD->field_end(), offset,
5113 [&](const FieldDecl *field) -> CharUnits {
5114 if (!recLayout)
5115 recLayout = &CGM.getContext().getASTRecordLayout(RD);
5116 auto offsetInBits = recLayout->getFieldOffset(field->getFieldIndex());
5117 return CGM.getContext().toCharUnitsFromBits(offsetInBits);
5118 });
Daniel Dunbar15bd8882009-05-03 14:10:34 +00005119}
5120
John McCall3fd13f062015-10-21 18:06:47 +00005121template <class Iterator, class GetOffsetFn>
Fangrui Song6907ce22018-07-30 19:24:48 +00005122void IvarLayoutBuilder::visitAggregate(Iterator begin, Iterator end,
John McCall3fd13f062015-10-21 18:06:47 +00005123 CharUnits aggregateOffset,
5124 const GetOffsetFn &getOffset) {
5125 for (; begin != end; ++begin) {
5126 auto field = *begin;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005127
John McCall3fd13f062015-10-21 18:06:47 +00005128 // Skip over bitfields.
5129 if (field->isBitField()) {
5130 continue;
5131 }
5132
5133 // Compute the offset of the field within the aggregate.
5134 CharUnits fieldOffset = aggregateOffset + getOffset(field);
5135
5136 visitField(field, fieldOffset);
5137 }
5138}
5139
5140/// Collect layout information for the given fields into IvarsInfo.
5141void IvarLayoutBuilder::visitField(const FieldDecl *field,
5142 CharUnits fieldOffset) {
5143 QualType fieldType = field->getType();
5144
5145 // Drill down into arrays.
5146 uint64_t numElts = 1;
Volodymyr Sapsai636ed472017-10-27 00:56:23 +00005147 if (auto arrayType = CGM.getContext().getAsIncompleteArrayType(fieldType)) {
5148 numElts = 0;
5149 fieldType = arrayType->getElementType();
5150 }
5151 // Unlike incomplete arrays, constant arrays can be nested.
John McCall3fd13f062015-10-21 18:06:47 +00005152 while (auto arrayType = CGM.getContext().getAsConstantArrayType(fieldType)) {
5153 numElts *= arrayType->getSize().getZExtValue();
5154 fieldType = arrayType->getElementType();
5155 }
5156
5157 assert(!fieldType->isArrayType() && "ivar of non-constant array type?");
5158
5159 // If we ended up with a zero-sized array, we've done what we can do within
5160 // the limits of this layout encoding.
5161 if (numElts == 0) return;
5162
5163 // Recurse if the base element type is a record type.
5164 if (auto recType = fieldType->getAs<RecordType>()) {
5165 size_t oldEnd = IvarsInfo.size();
5166
5167 visitRecord(recType, fieldOffset);
5168
5169 // If we have an array, replicate the first entry's layout information.
5170 auto numEltEntries = IvarsInfo.size() - oldEnd;
5171 if (numElts != 1 && numEltEntries != 0) {
5172 CharUnits eltSize = CGM.getContext().getTypeSizeInChars(recType);
5173 for (uint64_t eltIndex = 1; eltIndex != numElts; ++eltIndex) {
5174 // Copy the last numEltEntries onto the end of the array, adjusting
5175 // each for the element size.
5176 for (size_t i = 0; i != numEltEntries; ++i) {
5177 auto firstEntry = IvarsInfo[oldEnd + i];
5178 IvarsInfo.push_back(IvarInfo(firstEntry.Offset + eltIndex * eltSize,
5179 firstEntry.SizeInWords));
5180 }
5181 }
5182 }
5183
Fariborz Jahanian524bb202009-03-10 16:22:08 +00005184 return;
Fariborz Jahanian3b0f8862009-03-11 00:07:04 +00005185 }
Daniel Dunbar15bd8882009-05-03 14:10:34 +00005186
John McCall3fd13f062015-10-21 18:06:47 +00005187 // Classify the element type.
5188 Qualifiers::GC GCAttr = GetGCAttrTypeForType(CGM.getContext(), fieldType);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005189
John McCall3fd13f062015-10-21 18:06:47 +00005190 // If it matches what we're looking for, add an entry.
5191 if ((ForStrongLayout && GCAttr == Qualifiers::Strong)
5192 || (!ForStrongLayout && GCAttr == Qualifiers::Weak)) {
5193 assert(CGM.getContext().getTypeSizeInChars(fieldType)
5194 == CGM.getPointerSize());
5195 IvarsInfo.push_back(IvarInfo(fieldOffset, numElts));
5196 }
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00005197}
5198
John McCall3fd13f062015-10-21 18:06:47 +00005199/// buildBitmap - This routine does the horsework of taking the offsets of
5200/// strong/weak references and creating a bitmap. The bitmap is also
5201/// returned in the given buffer, suitable for being passed to \c dump().
5202llvm::Constant *IvarLayoutBuilder::buildBitmap(CGObjCCommonMac &CGObjC,
5203 llvm::SmallVectorImpl<unsigned char> &buffer) {
5204 // The bitmap is a series of skip/scan instructions, aligned to word
5205 // boundaries. The skip is performed first.
5206 const unsigned char MaxNibble = 0xF;
5207 const unsigned char SkipMask = 0xF0, SkipShift = 4;
5208 const unsigned char ScanMask = 0x0F, ScanShift = 0;
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00005209
John McCall3fd13f062015-10-21 18:06:47 +00005210 assert(!IvarsInfo.empty() && "generating bitmap for no data");
5211
5212 // Sort the ivar info on byte position in case we encounterred a
5213 // union nested in the ivar list.
5214 if (IsDisordered) {
5215 // This isn't a stable sort, but our algorithm should handle it fine.
5216 llvm::array_pod_sort(IvarsInfo.begin(), IvarsInfo.end());
5217 } else {
Craig Toppera3467052016-01-03 19:43:20 +00005218 assert(std::is_sorted(IvarsInfo.begin(), IvarsInfo.end()));
John McCall3fd13f062015-10-21 18:06:47 +00005219 }
5220 assert(IvarsInfo.back().Offset < InstanceEnd);
5221
5222 assert(buffer.empty());
5223
5224 // Skip the next N words.
5225 auto skip = [&](unsigned numWords) {
5226 assert(numWords > 0);
5227
5228 // Try to merge into the previous byte. Since scans happen second, we
5229 // can't do this if it includes a scan.
5230 if (!buffer.empty() && !(buffer.back() & ScanMask)) {
5231 unsigned lastSkip = buffer.back() >> SkipShift;
5232 if (lastSkip < MaxNibble) {
5233 unsigned claimed = std::min(MaxNibble - lastSkip, numWords);
5234 numWords -= claimed;
5235 lastSkip += claimed;
5236 buffer.back() = (lastSkip << SkipShift);
5237 }
5238 }
5239
5240 while (numWords >= MaxNibble) {
5241 buffer.push_back(MaxNibble << SkipShift);
5242 numWords -= MaxNibble;
5243 }
5244 if (numWords) {
5245 buffer.push_back(numWords << SkipShift);
5246 }
5247 };
5248
5249 // Scan the next N words.
5250 auto scan = [&](unsigned numWords) {
5251 assert(numWords > 0);
5252
5253 // Try to merge into the previous byte. Since scans happen second, we can
5254 // do this even if it includes a skip.
5255 if (!buffer.empty()) {
5256 unsigned lastScan = (buffer.back() & ScanMask) >> ScanShift;
5257 if (lastScan < MaxNibble) {
5258 unsigned claimed = std::min(MaxNibble - lastScan, numWords);
5259 numWords -= claimed;
5260 lastScan += claimed;
5261 buffer.back() = (buffer.back() & SkipMask) | (lastScan << ScanShift);
5262 }
5263 }
5264
5265 while (numWords >= MaxNibble) {
5266 buffer.push_back(MaxNibble << ScanShift);
5267 numWords -= MaxNibble;
5268 }
5269 if (numWords) {
5270 buffer.push_back(numWords << ScanShift);
5271 }
5272 };
5273
5274 // One past the end of the last scan.
5275 unsigned endOfLastScanInWords = 0;
5276 const CharUnits WordSize = CGM.getPointerSize();
5277
5278 // Consider all the scan requests.
5279 for (auto &request : IvarsInfo) {
5280 CharUnits beginOfScan = request.Offset - InstanceBegin;
5281
5282 // Ignore scan requests that don't start at an even multiple of the
5283 // word size. We can't encode them.
5284 if ((beginOfScan % WordSize) != 0) continue;
5285
5286 // Ignore scan requests that start before the instance start.
5287 // This assumes that scans never span that boundary. The boundary
5288 // isn't the true start of the ivars, because in the fragile-ARC case
5289 // it's rounded up to word alignment, but the test above should leave
5290 // us ignoring that possibility.
5291 if (beginOfScan.isNegative()) {
5292 assert(request.Offset + request.SizeInWords * WordSize <= InstanceBegin);
5293 continue;
5294 }
5295
5296 unsigned beginOfScanInWords = beginOfScan / WordSize;
5297 unsigned endOfScanInWords = beginOfScanInWords + request.SizeInWords;
5298
5299 // If the scan starts some number of words after the last one ended,
5300 // skip forward.
5301 if (beginOfScanInWords > endOfLastScanInWords) {
5302 skip(beginOfScanInWords - endOfLastScanInWords);
5303
5304 // Otherwise, start scanning where the last left off.
5305 } else {
5306 beginOfScanInWords = endOfLastScanInWords;
5307
5308 // If that leaves us with nothing to scan, ignore this request.
5309 if (beginOfScanInWords >= endOfScanInWords) continue;
5310 }
5311
5312 // Scan to the end of the request.
5313 assert(beginOfScanInWords < endOfScanInWords);
5314 scan(endOfScanInWords - beginOfScanInWords);
5315 endOfLastScanInWords = endOfScanInWords;
5316 }
5317
John McCallf5ea0722015-10-29 23:36:14 +00005318 if (buffer.empty())
5319 return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
5320
John McCall3fd13f062015-10-21 18:06:47 +00005321 // For GC layouts, emit a skip to the end of the allocation so that we
5322 // have precise information about the entire thing. This isn't useful
5323 // or necessary for the ARC-style layout strings.
5324 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
5325 unsigned lastOffsetInWords =
5326 (InstanceEnd - InstanceBegin + WordSize - CharUnits::One()) / WordSize;
5327 if (lastOffsetInWords > endOfLastScanInWords) {
5328 skip(lastOffsetInWords - endOfLastScanInWords);
5329 }
5330 }
5331
5332 // Null terminate the string.
5333 buffer.push_back(0);
5334
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005335 auto *Entry = CGObjC.CreateCStringLiteral(
5336 reinterpret_cast<char *>(buffer.data()), ObjCLabelType::ClassName);
John McCall3fd13f062015-10-21 18:06:47 +00005337 return getConstantGEP(CGM.getLLVMContext(), Entry, 0, 0);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005338}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005339
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005340/// BuildIvarLayout - Builds ivar layout bitmap for the class
5341/// implementation for the __strong or __weak case.
5342/// The layout map displays which words in ivar list must be skipped
5343/// and which must be scanned by GC (see below). String is built of bytes.
5344/// Each byte is divided up in two nibbles (4-bit each). Left nibble is count
5345/// of words to skip and right nibble is count of words to scan. So, each
5346/// nibble represents up to 15 workds to skip or scan. Skipping the rest is
5347/// represented by a 0x00 byte which also ends the string.
5348/// 1. when ForStrongLayout is true, following ivars are scanned:
5349/// - id, Class
5350/// - object *
5351/// - __strong anything
5352///
5353/// 2. When ForStrongLayout is false, following ivars are scanned:
5354/// - __weak anything
5355///
John McCall3fd13f062015-10-21 18:06:47 +00005356llvm::Constant *
5357CGObjCCommonMac::BuildIvarLayout(const ObjCImplementationDecl *OMD,
5358 CharUnits beginOffset, CharUnits endOffset,
John McCall460ce582015-10-22 18:38:17 +00005359 bool ForStrongLayout, bool HasMRCWeakIvars) {
5360 // If this is MRC, and we're either building a strong layout or there
5361 // are no weak ivars, bail out early.
Chris Lattnerece04092012-02-07 00:39:47 +00005362 llvm::Type *PtrTy = CGM.Int8PtrTy;
David Blaikiebbafb8a2012-03-11 07:00:24 +00005363 if (CGM.getLangOpts().getGC() == LangOptions::NonGC &&
John McCall460ce582015-10-22 18:38:17 +00005364 !CGM.getLangOpts().ObjCAutoRefCount &&
5365 (ForStrongLayout || !HasMRCWeakIvars))
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005366 return llvm::Constant::getNullValue(PtrTy);
5367
Jordy Rosea91768e2011-07-22 02:08:32 +00005368 const ObjCInterfaceDecl *OI = OMD->getClassInterface();
John McCall3fd13f062015-10-21 18:06:47 +00005369 SmallVector<const ObjCIvarDecl*, 32> ivars;
5370
5371 // GC layout strings include the complete object layout, possibly
5372 // inaccurately in the non-fragile ABI; the runtime knows how to fix this
5373 // up.
5374 //
5375 // ARC layout strings only include the class's ivars. In non-fragile
John McCallf5ea0722015-10-29 23:36:14 +00005376 // runtimes, that means starting at InstanceStart, rounded up to word
5377 // alignment. In fragile runtimes, there's no InstanceStart, so it means
John McCalld80218f2015-11-19 02:27:55 +00005378 // starting at the offset of the first ivar, rounded up to word alignment.
John McCall460ce582015-10-22 18:38:17 +00005379 //
5380 // MRC weak layout strings follow the ARC style.
John McCall3fd13f062015-10-21 18:06:47 +00005381 CharUnits baseOffset;
John McCall460ce582015-10-22 18:38:17 +00005382 if (CGM.getLangOpts().getGC() == LangOptions::NonGC) {
Fangrui Song6907ce22018-07-30 19:24:48 +00005383 for (const ObjCIvarDecl *IVD = OI->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005384 IVD; IVD = IVD->getNextIvar())
John McCall3fd13f062015-10-21 18:06:47 +00005385 ivars.push_back(IVD);
5386
5387 if (isNonFragileABI()) {
5388 baseOffset = beginOffset; // InstanceStart
John McCalld80218f2015-11-19 02:27:55 +00005389 } else if (!ivars.empty()) {
5390 baseOffset =
5391 CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivars[0]));
John McCall3fd13f062015-10-21 18:06:47 +00005392 } else {
5393 baseOffset = CharUnits::Zero();
5394 }
John McCallf5ea0722015-10-29 23:36:14 +00005395
Rui Ueyama83aa9792016-01-14 21:00:27 +00005396 baseOffset = baseOffset.alignTo(CGM.getPointerAlign());
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005397 }
5398 else {
John McCall3fd13f062015-10-21 18:06:47 +00005399 CGM.getContext().DeepCollectObjCIvars(OI, true, ivars);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005400
John McCall3fd13f062015-10-21 18:06:47 +00005401 baseOffset = CharUnits::Zero();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00005402 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005403
John McCall3fd13f062015-10-21 18:06:47 +00005404 if (ivars.empty())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005405 return llvm::Constant::getNullValue(PtrTy);
5406
John McCall3fd13f062015-10-21 18:06:47 +00005407 IvarLayoutBuilder builder(CGM, baseOffset, endOffset, ForStrongLayout);
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005408
John McCall3fd13f062015-10-21 18:06:47 +00005409 builder.visitAggregate(ivars.begin(), ivars.end(), CharUnits::Zero(),
5410 [&](const ObjCIvarDecl *ivar) -> CharUnits {
5411 return CharUnits::fromQuantity(ComputeIvarBaseOffset(CGM, OMD, ivar));
5412 });
5413
5414 if (!builder.hasBitmapData())
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005415 return llvm::Constant::getNullValue(PtrTy);
John McCall3fd13f062015-10-21 18:06:47 +00005416
5417 llvm::SmallVector<unsigned char, 4> buffer;
5418 llvm::Constant *C = builder.buildBitmap(*this, buffer);
Fangrui Song6907ce22018-07-30 19:24:48 +00005419
John McCallf5ea0722015-10-29 23:36:14 +00005420 if (CGM.getLangOpts().ObjCGCBitmapPrint && !buffer.empty()) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005421 printf("\n%s ivar layout for class '%s': ",
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005422 ForStrongLayout ? "strong" : "weak",
Ben Langmuire013bdc2014-07-11 00:43:47 +00005423 OMD->getClassInterface()->getName().str().c_str());
John McCall3fd13f062015-10-21 18:06:47 +00005424 builder.dump(buffer);
Fariborz Jahanian80c9ce22009-04-20 22:03:45 +00005425 }
Fariborz Jahanian9659f6b2010-08-04 23:55:24 +00005426 return C;
Fariborz Jahanianc559f3f2009-03-05 22:39:55 +00005427}
5428
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005429llvm::Constant *CGObjCCommonMac::GetMethodVarName(Selector Sel) {
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005430 llvm::GlobalVariable *&Entry = MethodVarNames[Sel];
Chris Lattner3def9ae2012-02-06 22:16:34 +00005431 // FIXME: Avoid std::string in "Sel.getAsString()"
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005432 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005433 Entry = CreateCStringLiteral(Sel.getAsString(), ObjCLabelType::MethodVarName);
Owen Anderson170229f2009-07-14 23:10:40 +00005434 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005435}
5436
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005437// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005438llvm::Constant *CGObjCCommonMac::GetMethodVarName(IdentifierInfo *ID) {
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005439 return GetMethodVarName(CGM.getContext().Selectors.getNullarySelector(ID));
5440}
5441
Daniel Dunbarf5c18462009-04-20 06:54:31 +00005442llvm::Constant *CGObjCCommonMac::GetMethodVarType(const FieldDecl *Field) {
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005443 std::string TypeStr;
5444 CGM.getContext().getObjCEncodingForType(Field->getType(), TypeStr, Field);
5445
5446 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005447 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005448 Entry = CreateCStringLiteral(TypeStr, ObjCLabelType::MethodVarType);
Owen Anderson170229f2009-07-14 23:10:40 +00005449 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbarcb515c82008-08-12 03:39:23 +00005450}
5451
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005452llvm::Constant *CGObjCCommonMac::GetMethodVarType(const ObjCMethodDecl *D,
5453 bool Extended) {
John McCall843dfcc2016-11-29 21:57:00 +00005454 std::string TypeStr =
5455 CGM.getContext().getObjCEncodingForMethodDecl(D, Extended);
Devang Patel4b6e4bb2009-03-04 18:21:39 +00005456
5457 llvm::GlobalVariable *&Entry = MethodVarTypes[TypeStr];
Daniel Dunbar3241fae2009-04-14 23:14:47 +00005458 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005459 Entry = CreateCStringLiteral(TypeStr, ObjCLabelType::MethodVarType);
Owen Anderson170229f2009-07-14 23:10:40 +00005460 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005461}
5462
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005463// FIXME: Merge into a single cstring creation function.
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005464llvm::Constant *CGObjCCommonMac::GetPropertyName(IdentifierInfo *Ident) {
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005465 llvm::GlobalVariable *&Entry = PropertyNames[Ident];
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005466 if (!Entry)
Saleem Abdulrasool271106c2016-09-16 23:41:13 +00005467 Entry = CreateCStringLiteral(Ident->getName(), ObjCLabelType::PropertyName);
Owen Anderson170229f2009-07-14 23:10:40 +00005468 return getConstantGEP(VMContext, Entry, 0, 0);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005469}
5470
5471// FIXME: Merge into a single cstring creation function.
Daniel Dunbar4932b362008-08-28 04:38:10 +00005472// FIXME: This Decl should be more precise.
Daniel Dunbarc2d4b622009-03-09 21:49:58 +00005473llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005474CGObjCCommonMac::GetPropertyTypeString(const ObjCPropertyDecl *PD,
5475 const Decl *Container) {
John McCall843dfcc2016-11-29 21:57:00 +00005476 std::string TypeStr =
5477 CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container);
Daniel Dunbar80a840b2008-08-23 00:19:03 +00005478 return GetPropertyName(&CGM.getContext().Idents.get(TypeStr));
5479}
5480
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005481void CGObjCCommonMac::GetNameForMethod(const ObjCMethodDecl *D,
Fariborz Jahanian0b1ccdc2009-01-21 23:34:32 +00005482 const ObjCContainerDecl *CD,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005483 SmallVectorImpl<char> &Name) {
Daniel Dunbard2386812009-10-19 01:21:19 +00005484 llvm::raw_svector_ostream OS(Name);
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +00005485 assert (CD && "Missing container decl in GetNameForMethod");
Daniel Dunbard2386812009-10-19 01:21:19 +00005486 OS << '\01' << (D->isInstanceMethod() ? '-' : '+')
5487 << '[' << CD->getName();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005488 if (const ObjCCategoryImplDecl *CID =
Daniel Dunbard2386812009-10-19 01:21:19 +00005489 dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
Benjamin Kramer2f569922012-02-07 11:57:45 +00005490 OS << '(' << *CID << ')';
Daniel Dunbard2386812009-10-19 01:21:19 +00005491 OS << ' ' << D->getSelector().getAsString() << ']';
Daniel Dunbara94ecd22008-08-16 03:19:19 +00005492}
5493
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005494void CGObjCMac::FinishModule() {
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005495 EmitModuleInfo();
5496
Daniel Dunbarc475d422008-10-29 22:36:39 +00005497 // Emit the dummy bodies for any protocols which were referenced but
5498 // never defined.
John McCall176f8922016-11-30 02:39:18 +00005499 for (auto &entry : Protocols) {
5500 llvm::GlobalVariable *global = entry.second;
5501 if (global->hasInitializer())
Daniel Dunbarc475d422008-10-29 22:36:39 +00005502 continue;
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005503
John McCall176f8922016-11-30 02:39:18 +00005504 ConstantInitBuilder builder(CGM);
5505 auto values = builder.beginStruct(ObjCTypes.ProtocolTy);
5506 values.addNullPointer(ObjCTypes.ProtocolExtensionPtrTy);
5507 values.add(GetClassName(entry.first->getName()));
5508 values.addNullPointer(ObjCTypes.ProtocolListPtrTy);
5509 values.addNullPointer(ObjCTypes.MethodDescriptionListPtrTy);
5510 values.addNullPointer(ObjCTypes.MethodDescriptionListPtrTy);
5511 values.finishAndSetAsInitializer(global);
5512 CGM.addCompilerUsedGlobal(global);
Daniel Dunbarc475d422008-10-29 22:36:39 +00005513 }
5514
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005515 // Add assembler directives to add lazy undefined symbol references
5516 // for classes which are referenced but not defined. This is
5517 // important for correct linker interaction.
Daniel Dunbard027a922009-09-07 00:20:42 +00005518 //
5519 // FIXME: It would be nice if we had an LLVM construct for this.
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005520 if ((!LazySymbols.empty() || !DefinedSymbols.empty()) &&
5521 CGM.getTriple().isOSBinFormatMachO()) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005522 SmallString<256> Asm;
Daniel Dunbard027a922009-09-07 00:20:42 +00005523 Asm += CGM.getModule().getModuleInlineAsm();
5524 if (!Asm.empty() && Asm.back() != '\n')
5525 Asm += '\n';
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005526
Daniel Dunbard027a922009-09-07 00:20:42 +00005527 llvm::raw_svector_ostream OS(Asm);
Saleem Abdulrasool39217d42016-09-16 14:24:26 +00005528 for (const auto *Sym : DefinedSymbols)
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005529 OS << "\t.objc_class_name_" << Sym->getName() << "=0\n"
5530 << "\t.globl .objc_class_name_" << Sym->getName() << "\n";
Saleem Abdulrasool39217d42016-09-16 14:24:26 +00005531 for (const auto *Sym : LazySymbols)
Saleem Abdulrasool62c07eb2016-09-12 21:15:23 +00005532 OS << "\t.lazy_reference .objc_class_name_" << Sym->getName() << "\n";
5533 for (const auto &Category : DefinedCategoryNames)
5534 OS << "\t.objc_category_name_" << Category << "=0\n"
5535 << "\t.globl .objc_category_name_" << Category << "\n";
Fariborz Jahanian9adb2e62010-06-21 22:05:18 +00005536
Daniel Dunbard027a922009-09-07 00:20:42 +00005537 CGM.getModule().setModuleInlineAsm(OS.str());
Daniel Dunbarc61d0e92008-08-25 06:02:07 +00005538 }
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005539}
5540
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005541CGObjCNonFragileABIMac::CGObjCNonFragileABIMac(CodeGen::CodeGenModule &cgm)
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00005542 : CGObjCCommonMac(cgm), ObjCTypes(cgm), ObjCEmptyCacheVar(nullptr),
5543 ObjCEmptyVtableVar(nullptr) {
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005544 ObjCABI = 2;
5545}
5546
Daniel Dunbar3ad53482008-08-11 21:35:06 +00005547/* *** */
5548
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005549ObjCCommonTypesHelper::ObjCCommonTypesHelper(CodeGen::CodeGenModule &cgm)
Craig Topper8a13c412014-05-21 05:09:00 +00005550 : VMContext(cgm.getLLVMContext()), CGM(cgm), ExternalProtocolPtrTy(nullptr)
Douglas Gregora95f9aa2012-01-17 23:38:32 +00005551{
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005552 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5553 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005554
John McCall176f8922016-11-30 02:39:18 +00005555 ShortTy = cast<llvm::IntegerType>(Types.ConvertType(Ctx.ShortTy));
5556 IntTy = CGM.IntTy;
5557 LongTy = cast<llvm::IntegerType>(Types.ConvertType(Ctx.LongTy));
Chris Lattnerece04092012-02-07 00:39:47 +00005558 Int8PtrTy = CGM.Int8PtrTy;
5559 Int8PtrPtrTy = CGM.Int8PtrPtrTy;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005560
Tim Northover238b5082014-03-29 13:42:40 +00005561 // arm64 targets use "int" ivar offset variables. All others,
5562 // including OS X x86_64 and Windows x86_64, use "long" ivar offsets.
Tim Northover40956e62014-07-23 12:32:58 +00005563 if (CGM.getTarget().getTriple().getArch() == llvm::Triple::aarch64)
Tim Northover238b5082014-03-29 13:42:40 +00005564 IvarOffsetVarTy = IntTy;
5565 else
5566 IvarOffsetVarTy = LongTy;
5567
John McCall176f8922016-11-30 02:39:18 +00005568 ObjectPtrTy =
5569 cast<llvm::PointerType>(Types.ConvertType(Ctx.getObjCIdType()));
5570 PtrObjectPtrTy =
5571 llvm::PointerType::getUnqual(ObjectPtrTy);
5572 SelectorPtrTy =
5573 cast<llvm::PointerType>(Types.ConvertType(Ctx.getObjCSelType()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005574
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005575 // I'm not sure I like this. The implicit coordination is a bit
5576 // gross. We should solve this in a reasonable fashion because this
5577 // is a pretty common task (match some runtime data structure with
5578 // an LLVM data structure).
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005579
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005580 // FIXME: This is leaked.
5581 // FIXME: Merge with rewriter code?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005582
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005583 // struct _objc_super {
5584 // id self;
5585 // Class cls;
5586 // }
Abramo Bagnara6150c882010-05-11 21:36:43 +00005587 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005588 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005589 SourceLocation(), SourceLocation(),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005590 &Ctx.Idents.get("_objc_super"));
Craig Topper8a13c412014-05-21 05:09:00 +00005591 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5592 nullptr, Ctx.getObjCIdType(), nullptr, nullptr,
5593 false, ICIS_NoInit));
5594 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5595 nullptr, Ctx.getObjCClassType(), nullptr,
5596 nullptr, false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005597 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005598
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005599 SuperCTy = Ctx.getTagDeclType(RD);
5600 SuperPtrCTy = Ctx.getPointerType(SuperCTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005601
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005602 SuperTy = cast<llvm::StructType>(Types.ConvertType(SuperCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005603 SuperPtrTy = llvm::PointerType::getUnqual(SuperTy);
5604
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005605 // struct _prop_t {
5606 // char *name;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005607 // char *attributes;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005608 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005609 PropertyTy = llvm::StructType::create("struct._prop_t", Int8PtrTy, Int8PtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005610
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005611 // struct _prop_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005612 // uint32_t entsize; // sizeof(struct _prop_t)
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005613 // uint32_t count_of_properties;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005614 // struct _prop_t prop_list[count_of_properties];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005615 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005616 PropertyListTy = llvm::StructType::create(
5617 "struct._prop_list_t", IntTy, IntTy, llvm::ArrayType::get(PropertyTy, 0));
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005618 // struct _prop_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005619 PropertyListPtrTy = llvm::PointerType::getUnqual(PropertyListTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005620
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005621 // struct _objc_method {
5622 // SEL _cmd;
5623 // char *method_type;
5624 // char *_imp;
5625 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005626 MethodTy = llvm::StructType::create("struct._objc_method", SelectorPtrTy,
5627 Int8PtrTy, Int8PtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005628
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005629 // struct _objc_cache *
Chris Lattner5ec04a52011-08-12 17:43:31 +00005630 CacheTy = llvm::StructType::create(VMContext, "struct._objc_cache");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005631 CachePtrTy = llvm::PointerType::getUnqual(CacheTy);
Fariborz Jahanian279eda62009-01-21 22:04:16 +00005632}
Daniel Dunbar7bd00bd2008-08-12 06:48:42 +00005633
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005634ObjCTypesHelper::ObjCTypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005635 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005636 // struct _objc_method_description {
5637 // SEL name;
5638 // char *types;
5639 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005640 MethodDescriptionTy = llvm::StructType::create(
5641 "struct._objc_method_description", SelectorPtrTy, Int8PtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005642
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005643 // struct _objc_method_description_list {
5644 // int count;
5645 // struct _objc_method_description[1];
5646 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005647 MethodDescriptionListTy =
5648 llvm::StructType::create("struct._objc_method_description_list", IntTy,
5649 llvm::ArrayType::get(MethodDescriptionTy, 0));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005650
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005651 // struct _objc_method_description_list *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005652 MethodDescriptionListPtrTy =
Owen Anderson9793f0e2009-07-29 22:16:19 +00005653 llvm::PointerType::getUnqual(MethodDescriptionListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005654
Daniel Dunbarb036db82008-08-13 03:21:16 +00005655 // Protocol description structures
5656
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005657 // struct _objc_protocol_extension {
5658 // uint32_t size; // sizeof(struct _objc_protocol_extension)
5659 // struct _objc_method_description_list *optional_instance_methods;
5660 // struct _objc_method_description_list *optional_class_methods;
5661 // struct _objc_property_list *instance_properties;
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005662 // const char ** extendedMethodTypes;
Manman Rence7bff52016-01-29 23:46:55 +00005663 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005664 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005665 ProtocolExtensionTy = llvm::StructType::create(
5666 "struct._objc_protocol_extension", IntTy, MethodDescriptionListPtrTy,
5667 MethodDescriptionListPtrTy, PropertyListPtrTy, Int8PtrPtrTy,
5668 PropertyListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005669
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005670 // struct _objc_protocol_extension *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005671 ProtocolExtensionPtrTy = llvm::PointerType::getUnqual(ProtocolExtensionTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005672
Daniel Dunbarc475d422008-10-29 22:36:39 +00005673 // Handle recursive construction of Protocol and ProtocolList types
Daniel Dunbarb036db82008-08-13 03:21:16 +00005674
Chris Lattnera5f58b02011-07-09 17:41:47 +00005675 ProtocolTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005676 llvm::StructType::create(VMContext, "struct._objc_protocol");
Daniel Dunbarb036db82008-08-13 03:21:16 +00005677
Chris Lattnera5f58b02011-07-09 17:41:47 +00005678 ProtocolListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005679 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Serge Guelton1d993272017-05-09 19:31:30 +00005680 ProtocolListTy->setBody(llvm::PointerType::getUnqual(ProtocolListTy), LongTy,
5681 llvm::ArrayType::get(ProtocolTy, 0));
Daniel Dunbarb036db82008-08-13 03:21:16 +00005682
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005683 // struct _objc_protocol {
5684 // struct _objc_protocol_extension *isa;
5685 // char *protocol_name;
5686 // struct _objc_protocol **_objc_protocol_list;
5687 // struct _objc_method_description_list *instance_methods;
5688 // struct _objc_method_description_list *class_methods;
5689 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005690 ProtocolTy->setBody(ProtocolExtensionPtrTy, Int8PtrTy,
5691 llvm::PointerType::getUnqual(ProtocolListTy),
Serge Guelton1d993272017-05-09 19:31:30 +00005692 MethodDescriptionListPtrTy, MethodDescriptionListPtrTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005693
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005694 // struct _objc_protocol_list *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005695 ProtocolListPtrTy = llvm::PointerType::getUnqual(ProtocolListTy);
Daniel Dunbarb036db82008-08-13 03:21:16 +00005696
Owen Anderson9793f0e2009-07-29 22:16:19 +00005697 ProtocolPtrTy = llvm::PointerType::getUnqual(ProtocolTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005698
5699 // Class description structures
5700
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005701 // struct _objc_ivar {
5702 // char *ivar_name;
5703 // char *ivar_type;
5704 // int ivar_offset;
5705 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005706 IvarTy = llvm::StructType::create("struct._objc_ivar", Int8PtrTy, Int8PtrTy,
5707 IntTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005708
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005709 // struct _objc_ivar_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005710 IvarListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005711 llvm::StructType::create(VMContext, "struct._objc_ivar_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005712 IvarListPtrTy = llvm::PointerType::getUnqual(IvarListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005713
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005714 // struct _objc_method_list *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005715 MethodListTy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005716 llvm::StructType::create(VMContext, "struct._objc_method_list");
Owen Anderson9793f0e2009-07-29 22:16:19 +00005717 MethodListPtrTy = llvm::PointerType::getUnqual(MethodListTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005718
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005719 // struct _objc_class_extension *
Serge Guelton1d993272017-05-09 19:31:30 +00005720 ClassExtensionTy = llvm::StructType::create(
5721 "struct._objc_class_extension", IntTy, Int8PtrTy, PropertyListPtrTy);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005722 ClassExtensionPtrTy = llvm::PointerType::getUnqual(ClassExtensionTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005723
Chris Lattner5ec04a52011-08-12 17:43:31 +00005724 ClassTy = llvm::StructType::create(VMContext, "struct._objc_class");
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005725
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005726 // struct _objc_class {
5727 // Class isa;
5728 // Class super_class;
5729 // char *name;
5730 // long version;
5731 // long info;
5732 // long instance_size;
5733 // struct _objc_ivar_list *ivars;
5734 // struct _objc_method_list *methods;
5735 // struct _objc_cache *cache;
5736 // struct _objc_protocol_list *protocols;
5737 // char *ivar_layout;
5738 // struct _objc_class_ext *ext;
5739 // };
Chris Lattnera5f58b02011-07-09 17:41:47 +00005740 ClassTy->setBody(llvm::PointerType::getUnqual(ClassTy),
Serge Guelton1d993272017-05-09 19:31:30 +00005741 llvm::PointerType::getUnqual(ClassTy), Int8PtrTy, LongTy,
5742 LongTy, LongTy, IvarListPtrTy, MethodListPtrTy, CachePtrTy,
5743 ProtocolListPtrTy, Int8PtrTy, ClassExtensionPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005744
Owen Anderson9793f0e2009-07-29 22:16:19 +00005745 ClassPtrTy = llvm::PointerType::getUnqual(ClassTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005746
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005747 // struct _objc_category {
5748 // char *category_name;
5749 // char *class_name;
5750 // struct _objc_method_list *instance_method;
5751 // struct _objc_method_list *class_method;
Manman Renb3736772016-01-25 22:37:47 +00005752 // struct _objc_protocol_list *protocols;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005753 // uint32_t size; // sizeof(struct _objc_category)
5754 // struct _objc_property_list *instance_properties;// category's @property
Manman Ren96df0b32016-01-29 23:45:01 +00005755 // struct _objc_property_list *class_properties;
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005756 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005757 CategoryTy = llvm::StructType::create(
5758 "struct._objc_category", Int8PtrTy, Int8PtrTy, MethodListPtrTy,
5759 MethodListPtrTy, ProtocolListPtrTy, IntTy, PropertyListPtrTy,
5760 PropertyListPtrTy);
Daniel Dunbar938a77f2008-08-22 20:34:54 +00005761
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005762 // Global metadata structures
5763
Fariborz Jahanian4b4c8262009-01-21 00:39:53 +00005764 // struct _objc_symtab {
5765 // long sel_ref_cnt;
5766 // SEL *refs;
5767 // short cls_def_cnt;
5768 // short cat_def_cnt;
5769 // char *defs[cls_def_cnt + cat_def_cnt];
5770 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005771 SymtabTy = llvm::StructType::create("struct._objc_symtab", LongTy,
5772 SelectorPtrTy, ShortTy, ShortTy,
5773 llvm::ArrayType::get(Int8PtrTy, 0));
Owen Anderson9793f0e2009-07-29 22:16:19 +00005774 SymtabPtrTy = llvm::PointerType::getUnqual(SymtabTy);
Daniel Dunbar22d82ed2008-08-21 04:36:09 +00005775
Fariborz Jahanianeee54df2009-01-22 00:37:21 +00005776 // struct _objc_module {
5777 // long version;
5778 // long size; // sizeof(struct _objc_module)
5779 // char *name;
5780 // struct _objc_symtab* symtab;
5781 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005782 ModuleTy = llvm::StructType::create("struct._objc_module", LongTy, LongTy,
5783 Int8PtrTy, SymtabPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005784
Mike Stump18bb9282009-05-16 07:57:57 +00005785 // FIXME: This is the size of the setjmp buffer and should be target
5786 // specific. 18 is what's used on 32-bit X86.
Anders Carlsson9ff22482008-09-09 10:10:21 +00005787 uint64_t SetJmpBufferSize = 18;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005788
Anders Carlsson9ff22482008-09-09 10:10:21 +00005789 // Exceptions
Chris Lattnerece04092012-02-07 00:39:47 +00005790 llvm::Type *StackPtrTy = llvm::ArrayType::get(CGM.Int8PtrTy, 4);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005791
Serge Guelton1d993272017-05-09 19:31:30 +00005792 ExceptionDataTy = llvm::StructType::create(
5793 "struct._objc_exception_data",
5794 llvm::ArrayType::get(CGM.Int32Ty, SetJmpBufferSize), StackPtrTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005795}
5796
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005797ObjCNonFragileABITypesHelper::ObjCNonFragileABITypesHelper(CodeGen::CodeGenModule &cgm)
Mike Stump11289f42009-09-09 15:08:12 +00005798 : ObjCCommonTypesHelper(cgm) {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005799 // struct _method_list_t {
5800 // uint32_t entsize; // sizeof(struct _objc_method)
5801 // uint32_t method_count;
5802 // struct _objc_method method_list[method_count];
5803 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005804 MethodListnfABITy =
Serge Guelton1d993272017-05-09 19:31:30 +00005805 llvm::StructType::create("struct.__method_list_t", IntTy, IntTy,
5806 llvm::ArrayType::get(MethodTy, 0));
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005807 // struct method_list_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005808 MethodListnfABIPtrTy = llvm::PointerType::getUnqual(MethodListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005809
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005810 // struct _protocol_t {
5811 // id isa; // NULL
5812 // const char * const protocol_name;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005813 // const struct _protocol_list_t * protocol_list; // super protocols
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005814 // const struct method_list_t * const instance_methods;
5815 // const struct method_list_t * const class_methods;
5816 // const struct method_list_t *optionalInstanceMethods;
5817 // const struct method_list_t *optionalClassMethods;
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005818 // const struct _prop_list_t * properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005819 // const uint32_t size; // sizeof(struct _protocol_t)
5820 // const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00005821 // const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00005822 // const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00005823 // const struct _prop_list_t * class_properties;
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005824 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005825
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005826 // Holder for struct _protocol_list_t *
Chris Lattnera5f58b02011-07-09 17:41:47 +00005827 ProtocolListnfABITy =
Chris Lattner5ec04a52011-08-12 17:43:31 +00005828 llvm::StructType::create(VMContext, "struct._objc_protocol_list");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005829
Serge Guelton1d993272017-05-09 19:31:30 +00005830 ProtocolnfABITy = llvm::StructType::create(
5831 "struct._protocol_t", ObjectPtrTy, Int8PtrTy,
5832 llvm::PointerType::getUnqual(ProtocolListnfABITy), MethodListnfABIPtrTy,
5833 MethodListnfABIPtrTy, MethodListnfABIPtrTy, MethodListnfABIPtrTy,
5834 PropertyListPtrTy, IntTy, IntTy, Int8PtrPtrTy, Int8PtrTy,
5835 PropertyListPtrTy);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005836
5837 // struct _protocol_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005838 ProtocolnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005839
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00005840 // struct _protocol_list_t {
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005841 // long protocol_count; // Note, this is 32/64 bit
Daniel Dunbar8de90f02009-02-15 07:36:20 +00005842 // struct _protocol_t *[protocol_count];
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005843 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005844 ProtocolListnfABITy->setBody(LongTy,
Serge Guelton1d993272017-05-09 19:31:30 +00005845 llvm::ArrayType::get(ProtocolnfABIPtrTy, 0));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005846
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005847 // struct _objc_protocol_list*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005848 ProtocolListnfABIPtrTy = llvm::PointerType::getUnqual(ProtocolListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005849
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005850 // struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00005851 // unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005852 // char *name;
5853 // char *type;
5854 // uint32_t alignment;
5855 // uint32_t size;
5856 // }
Tim Northover238b5082014-03-29 13:42:40 +00005857 IvarnfABITy = llvm::StructType::create(
5858 "struct._ivar_t", llvm::PointerType::getUnqual(IvarOffsetVarTy),
Serge Guelton1d993272017-05-09 19:31:30 +00005859 Int8PtrTy, Int8PtrTy, IntTy, IntTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005860
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005861 // struct _ivar_list_t {
5862 // uint32 entsize; // sizeof(struct _ivar_t)
5863 // uint32 count;
5864 // struct _iver_t list[count];
5865 // }
Chris Lattnera5f58b02011-07-09 17:41:47 +00005866 IvarListnfABITy =
Serge Guelton1d993272017-05-09 19:31:30 +00005867 llvm::StructType::create("struct._ivar_list_t", IntTy, IntTy,
5868 llvm::ArrayType::get(IvarnfABITy, 0));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005869
Owen Anderson9793f0e2009-07-29 22:16:19 +00005870 IvarListnfABIPtrTy = llvm::PointerType::getUnqual(IvarListnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005871
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005872 // struct _class_ro_t {
Fariborz Jahanianb15a3d52009-01-22 23:02:58 +00005873 // uint32_t const flags;
5874 // uint32_t const instanceStart;
5875 // uint32_t const instanceSize;
5876 // uint32_t const reserved; // only when building for 64bit targets
5877 // const uint8_t * const ivarLayout;
5878 // const char *const name;
5879 // const struct _method_list_t * const baseMethods;
5880 // const struct _objc_protocol_list *const baseProtocols;
5881 // const struct _ivar_list_t *const ivars;
5882 // const uint8_t * const weakIvarLayout;
5883 // const struct _prop_list_t * const properties;
5884 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005885
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005886 // FIXME. Add 'reserved' field in 64bit abi mode!
Serge Guelton1d993272017-05-09 19:31:30 +00005887 ClassRonfABITy = llvm::StructType::create(
5888 "struct._class_ro_t", IntTy, IntTy, IntTy, Int8PtrTy, Int8PtrTy,
5889 MethodListnfABIPtrTy, ProtocolListnfABIPtrTy, IvarListnfABIPtrTy,
5890 Int8PtrTy, PropertyListPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005891
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005892 // ImpnfABITy - LLVM for id (*)(id, SEL, ...)
Chris Lattnera5f58b02011-07-09 17:41:47 +00005893 llvm::Type *params[] = { ObjectPtrTy, SelectorPtrTy };
John McCall9dc0db22011-05-15 01:53:33 +00005894 ImpnfABITy = llvm::FunctionType::get(ObjectPtrTy, params, false)
5895 ->getPointerTo();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005896
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005897 // struct _class_t {
5898 // struct _class_t *isa;
5899 // struct _class_t * const superclass;
5900 // void *cache;
5901 // IMP *vtable;
5902 // struct class_ro_t *ro;
5903 // }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005904
Chris Lattner5ec04a52011-08-12 17:43:31 +00005905 ClassnfABITy = llvm::StructType::create(VMContext, "struct._class_t");
Chris Lattnera5f58b02011-07-09 17:41:47 +00005906 ClassnfABITy->setBody(llvm::PointerType::getUnqual(ClassnfABITy),
Serge Guelton1d993272017-05-09 19:31:30 +00005907 llvm::PointerType::getUnqual(ClassnfABITy), CachePtrTy,
Chris Lattnera5f58b02011-07-09 17:41:47 +00005908 llvm::PointerType::getUnqual(ImpnfABITy),
Serge Guelton1d993272017-05-09 19:31:30 +00005909 llvm::PointerType::getUnqual(ClassRonfABITy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005910
Fariborz Jahanian71394042009-01-23 23:53:38 +00005911 // LLVM for struct _class_t *
Owen Anderson9793f0e2009-07-29 22:16:19 +00005912 ClassnfABIPtrTy = llvm::PointerType::getUnqual(ClassnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005913
Fariborz Jahanian0232c052009-01-23 01:46:23 +00005914 // struct _category_t {
5915 // const char * const name;
5916 // struct _class_t *const cls;
5917 // const struct _method_list_t * const instance_methods;
5918 // const struct _method_list_t * const class_methods;
5919 // const struct _protocol_list_t * const protocols;
5920 // const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00005921 // const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00005922 // const uint32_t size;
Fariborz Jahanian5a63e4c2009-01-23 17:41:22 +00005923 // }
Serge Guelton1d993272017-05-09 19:31:30 +00005924 CategorynfABITy = llvm::StructType::create(
5925 "struct._category_t", Int8PtrTy, ClassnfABIPtrTy, MethodListnfABIPtrTy,
5926 MethodListnfABIPtrTy, ProtocolListnfABIPtrTy, PropertyListPtrTy,
5927 PropertyListPtrTy, IntTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005928
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005929 // New types for nonfragile abi messaging.
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005930 CodeGen::CodeGenTypes &Types = CGM.getTypes();
5931 ASTContext &Ctx = CGM.getContext();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005932
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005933 // MessageRefTy - LLVM for:
5934 // struct _message_ref_t {
5935 // IMP messenger;
5936 // SEL name;
5937 // };
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005938
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005939 // First the clang type for struct _message_ref_t
Abramo Bagnara6150c882010-05-11 21:36:43 +00005940 RecordDecl *RD = RecordDecl::Create(Ctx, TTK_Struct,
Daniel Dunbar0c005372010-04-29 16:29:11 +00005941 Ctx.getTranslationUnitDecl(),
Abramo Bagnara29c2d462011-03-09 14:09:51 +00005942 SourceLocation(), SourceLocation(),
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005943 &Ctx.Idents.get("_message_ref_t"));
Craig Topper8a13c412014-05-21 05:09:00 +00005944 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5945 nullptr, Ctx.VoidPtrTy, nullptr, nullptr, false,
Richard Smith2b013182012-06-10 03:12:00 +00005946 ICIS_NoInit));
Craig Topper8a13c412014-05-21 05:09:00 +00005947 RD->addDecl(FieldDecl::Create(Ctx, RD, SourceLocation(), SourceLocation(),
5948 nullptr, Ctx.getObjCSelType(), nullptr, nullptr,
5949 false, ICIS_NoInit));
Douglas Gregord5058122010-02-11 01:19:42 +00005950 RD->completeDefinition();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005951
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00005952 MessageRefCTy = Ctx.getTagDeclType(RD);
5953 MessageRefCPtrTy = Ctx.getPointerType(MessageRefCTy);
5954 MessageRefTy = cast<llvm::StructType>(Types.ConvertType(MessageRefCTy));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005955
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005956 // MessageRefPtrTy - LLVM for struct _message_ref_t*
Owen Anderson9793f0e2009-07-29 22:16:19 +00005957 MessageRefPtrTy = llvm::PointerType::getUnqual(MessageRefTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005958
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005959 // SuperMessageRefTy - LLVM for:
5960 // struct _super_message_ref_t {
5961 // SUPER_IMP messenger;
5962 // SEL name;
5963 // };
Serge Guelton1d993272017-05-09 19:31:30 +00005964 SuperMessageRefTy = llvm::StructType::create("struct._super_message_ref_t",
5965 ImpnfABITy, SelectorPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005966
Fariborz Jahanian82c72e12009-02-03 23:49:23 +00005967 // SuperMessageRefPtrTy - LLVM for struct _super_message_ref_t*
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005968 SuperMessageRefPtrTy = llvm::PointerType::getUnqual(SuperMessageRefTy);
Fangrui Song6907ce22018-07-30 19:24:48 +00005969
Daniel Dunbarb1559a42009-03-01 04:46:24 +00005970
5971 // struct objc_typeinfo {
5972 // const void** vtable; // objc_ehtype_vtable + 2
5973 // const char* name; // c++ typeinfo string
5974 // Class cls;
5975 // };
Serge Guelton1d993272017-05-09 19:31:30 +00005976 EHTypeTy = llvm::StructType::create("struct._objc_typeinfo",
5977 llvm::PointerType::getUnqual(Int8PtrTy),
5978 Int8PtrTy, ClassnfABIPtrTy);
Owen Anderson9793f0e2009-07-29 22:16:19 +00005979 EHTypePtrTy = llvm::PointerType::getUnqual(EHTypeTy);
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00005980}
5981
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005982llvm::Function *CGObjCNonFragileABIMac::ModuleInitFunction() {
Fariborz Jahanian71394042009-01-23 23:53:38 +00005983 FinishNonFragileABIModule();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005984
Craig Topper8a13c412014-05-21 05:09:00 +00005985 return nullptr;
Fariborz Jahanian71394042009-01-23 23:53:38 +00005986}
5987
Saleem Abdulrasool1e6c4062016-05-16 05:06:49 +00005988void CGObjCNonFragileABIMac::AddModuleClassList(
5989 ArrayRef<llvm::GlobalValue *> Container, StringRef SymbolName,
5990 StringRef SectionName) {
Daniel Dunbar19573e72009-05-15 21:48:48 +00005991 unsigned NumClasses = Container.size();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005992
Daniel Dunbar19573e72009-05-15 21:48:48 +00005993 if (!NumClasses)
5994 return;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00005995
Chris Lattner3def9ae2012-02-06 22:16:34 +00005996 SmallVector<llvm::Constant*, 8> Symbols(NumClasses);
Daniel Dunbar19573e72009-05-15 21:48:48 +00005997 for (unsigned i=0; i<NumClasses; i++)
Owen Andersonade90fd2009-07-29 18:54:39 +00005998 Symbols[i] = llvm::ConstantExpr::getBitCast(Container[i],
Daniel Dunbar19573e72009-05-15 21:48:48 +00005999 ObjCTypes.Int8PtrTy);
Chris Lattner3def9ae2012-02-06 22:16:34 +00006000 llvm::Constant *Init =
Owen Anderson9793f0e2009-07-29 22:16:19 +00006001 llvm::ConstantArray::get(llvm::ArrayType::get(ObjCTypes.Int8PtrTy,
Chris Lattner3def9ae2012-02-06 22:16:34 +00006002 Symbols.size()),
Daniel Dunbar19573e72009-05-15 21:48:48 +00006003 Symbols);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006004
Daniel Dunbar19573e72009-05-15 21:48:48 +00006005 llvm::GlobalVariable *GV =
Owen Andersonc10c8d32009-07-08 19:05:04 +00006006 new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00006007 llvm::GlobalValue::PrivateLinkage,
Daniel Dunbar19573e72009-05-15 21:48:48 +00006008 Init,
Owen Andersonc10c8d32009-07-08 19:05:04 +00006009 SymbolName);
Micah Villmowdd31ca12012-10-08 16:25:52 +00006010 GV->setAlignment(CGM.getDataLayout().getABITypeAlignment(Init->getType()));
Daniel Dunbar19573e72009-05-15 21:48:48 +00006011 GV->setSection(SectionName);
Rafael Espindola060062a2014-03-06 22:15:10 +00006012 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar19573e72009-05-15 21:48:48 +00006013}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006014
Fariborz Jahanian71394042009-01-23 23:53:38 +00006015void CGObjCNonFragileABIMac::FinishNonFragileABIModule() {
6016 // nonfragile abi has no module definition.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006017
Daniel Dunbar19573e72009-05-15 21:48:48 +00006018 // Build list of all implemented class addresses in array
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006019 // L_OBJC_LABEL_CLASS_$.
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006020
6021 for (unsigned i=0, NumClasses=ImplementedClasses.size(); i<NumClasses; i++) {
6022 const ObjCInterfaceDecl *ID = ImplementedClasses[i];
6023 assert(ID);
6024 if (ObjCImplementationDecl *IMP = ID->getImplementation())
6025 // We are implementing a weak imported interface. Give it external linkage
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00006026 if (ID->isWeakImported() && !IMP->isWeakImported()) {
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006027 DefinedClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
Fariborz Jahanianbc94c942014-07-15 17:14:34 +00006028 DefinedMetaClasses[i]->setLinkage(llvm::GlobalVariable::ExternalLinkage);
6029 }
Fariborz Jahanianf322f2f2014-03-11 00:25:05 +00006030 }
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006031
6032 AddModuleClassList(DefinedClasses, "OBJC_LABEL_CLASS_$",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00006033 GetSectionName("__objc_classlist",
6034 "regular,no_dead_strip"));
Rafael Espindola554256c2014-02-26 22:25:45 +00006035
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006036 AddModuleClassList(DefinedNonLazyClasses, "OBJC_LABEL_NONLAZY_CLASS_$",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00006037 GetSectionName("__objc_nlclslist",
6038 "regular,no_dead_strip"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006039
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006040 // Build list of all implemented category addresses in array
6041 // L_OBJC_LABEL_CATEGORY_$.
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006042 AddModuleClassList(DefinedCategories, "OBJC_LABEL_CATEGORY_$",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00006043 GetSectionName("__objc_catlist",
6044 "regular,no_dead_strip"));
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00006045 AddModuleClassList(DefinedNonLazyCategories, "OBJC_LABEL_NONLAZY_CATEGORY_$",
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00006046 GetSectionName("__objc_nlcatlist",
6047 "regular,no_dead_strip"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006048
Daniel Dunbar5e639272010-04-25 20:39:01 +00006049 EmitImageInfo();
Fariborz Jahanian71394042009-01-23 23:53:38 +00006050}
6051
John McCall9e8bb002011-05-14 03:10:52 +00006052/// isVTableDispatchedSelector - Returns true if SEL is not in the list of
6053/// VTableDispatchMethods; false otherwise. What this means is that
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006054/// except for the 19 selectors in the list, we generate 32bit-style
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006055/// message dispatch call for all the rest.
John McCall9e8bb002011-05-14 03:10:52 +00006056bool CGObjCNonFragileABIMac::isVTableDispatchedSelector(Selector Sel) {
6057 // At various points we've experimented with using vtable-based
6058 // dispatch for all methods.
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00006059 switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00006060 case CodeGenOptions::Legacy:
Fariborz Jahaniandfb39832010-04-19 17:53:30 +00006061 return false;
John McCall9e8bb002011-05-14 03:10:52 +00006062 case CodeGenOptions::NonLegacy:
6063 return true;
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00006064 case CodeGenOptions::Mixed:
6065 break;
6066 }
6067
6068 // If so, see whether this selector is in the white-list of things which must
6069 // use the new dispatch convention. We lazily build a dense set for this.
John McCall9e8bb002011-05-14 03:10:52 +00006070 if (VTableDispatchMethods.empty()) {
6071 VTableDispatchMethods.insert(GetNullarySelector("alloc"));
6072 VTableDispatchMethods.insert(GetNullarySelector("class"));
6073 VTableDispatchMethods.insert(GetNullarySelector("self"));
6074 VTableDispatchMethods.insert(GetNullarySelector("isFlipped"));
6075 VTableDispatchMethods.insert(GetNullarySelector("length"));
6076 VTableDispatchMethods.insert(GetNullarySelector("count"));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006077
John McCall9e8bb002011-05-14 03:10:52 +00006078 // These are vtable-based if GC is disabled.
6079 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00006080 if (CGM.getLangOpts().getGC() != LangOptions::GCOnly) {
John McCall9e8bb002011-05-14 03:10:52 +00006081 VTableDispatchMethods.insert(GetNullarySelector("retain"));
6082 VTableDispatchMethods.insert(GetNullarySelector("release"));
6083 VTableDispatchMethods.insert(GetNullarySelector("autorelease"));
6084 }
6085
6086 VTableDispatchMethods.insert(GetUnarySelector("allocWithZone"));
6087 VTableDispatchMethods.insert(GetUnarySelector("isKindOfClass"));
6088 VTableDispatchMethods.insert(GetUnarySelector("respondsToSelector"));
6089 VTableDispatchMethods.insert(GetUnarySelector("objectForKey"));
6090 VTableDispatchMethods.insert(GetUnarySelector("objectAtIndex"));
6091 VTableDispatchMethods.insert(GetUnarySelector("isEqualToString"));
6092 VTableDispatchMethods.insert(GetUnarySelector("isEqual"));
6093
6094 // These are vtable-based if GC is enabled.
6095 // Optimistically use vtable dispatch for hybrid compiles.
David Blaikiebbafb8a2012-03-11 07:00:24 +00006096 if (CGM.getLangOpts().getGC() != LangOptions::NonGC) {
John McCall9e8bb002011-05-14 03:10:52 +00006097 VTableDispatchMethods.insert(GetNullarySelector("hash"));
6098 VTableDispatchMethods.insert(GetUnarySelector("addObject"));
Fangrui Song6907ce22018-07-30 19:24:48 +00006099
John McCall9e8bb002011-05-14 03:10:52 +00006100 // "countByEnumeratingWithState:objects:count"
6101 IdentifierInfo *KeyIdents[] = {
6102 &CGM.getContext().Idents.get("countByEnumeratingWithState"),
6103 &CGM.getContext().Idents.get("objects"),
6104 &CGM.getContext().Idents.get("count")
6105 };
6106 VTableDispatchMethods.insert(
6107 CGM.getContext().Selectors.getSelector(3, KeyIdents));
6108 }
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006109 }
Daniel Dunbarfca18c1b42010-04-24 17:56:46 +00006110
John McCall9e8bb002011-05-14 03:10:52 +00006111 return VTableDispatchMethods.count(Sel);
Fariborz Jahanian5d5ed2d2009-05-11 19:25:47 +00006112}
6113
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006114/// BuildClassRoTInitializer - generate meta-data for:
6115/// struct _class_ro_t {
6116/// uint32_t const flags;
6117/// uint32_t const instanceStart;
6118/// uint32_t const instanceSize;
6119/// uint32_t const reserved; // only when building for 64bit targets
6120/// const uint8_t * const ivarLayout;
6121/// const char *const name;
6122/// const struct _method_list_t * const baseMethods;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006123/// const struct _protocol_list_t *const baseProtocols;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006124/// const struct _ivar_list_t *const ivars;
6125/// const uint8_t * const weakIvarLayout;
6126/// const struct _prop_list_t * const properties;
6127/// }
6128///
6129llvm::GlobalVariable * CGObjCNonFragileABIMac::BuildClassRoTInitializer(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006130 unsigned flags,
6131 unsigned InstanceStart,
6132 unsigned InstanceSize,
6133 const ObjCImplementationDecl *ID) {
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006134 std::string ClassName = ID->getObjCRuntimeNameAsString();
John McCall31168b02011-06-15 23:02:42 +00006135
John McCall3fd13f062015-10-21 18:06:47 +00006136 CharUnits beginInstance = CharUnits::fromQuantity(InstanceStart);
6137 CharUnits endInstance = CharUnits::fromQuantity(InstanceSize);
6138
John McCall460ce582015-10-22 18:38:17 +00006139 bool hasMRCWeak = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00006140 if (CGM.getLangOpts().ObjCAutoRefCount)
John McCallef19dbb2012-10-17 04:53:23 +00006141 flags |= NonFragileABI_Class_CompiledByARC;
John McCall460ce582015-10-22 18:38:17 +00006142 else if ((hasMRCWeak = hasMRCWeakIvars(CGM, ID)))
6143 flags |= NonFragileABI_Class_HasMRCWeakIvars;
John McCall31168b02011-06-15 23:02:42 +00006144
John McCall176f8922016-11-30 02:39:18 +00006145 ConstantInitBuilder builder(CGM);
6146 auto values = builder.beginStruct(ObjCTypes.ClassRonfABITy);
6147
6148 values.addInt(ObjCTypes.IntTy, flags);
6149 values.addInt(ObjCTypes.IntTy, InstanceStart);
6150 values.addInt(ObjCTypes.IntTy, InstanceSize);
6151 values.add((flags & NonFragileABI_Class_Meta)
6152 ? GetIvarLayoutName(nullptr, ObjCTypes)
6153 : BuildStrongIvarLayout(ID, beginInstance, endInstance));
6154 values.add(GetClassName(ID->getObjCRuntimeNameAsString()));
6155
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006156 // const struct _method_list_t * const baseMethods;
John McCall176f8922016-11-30 02:39:18 +00006157 SmallVector<const ObjCMethodDecl*, 16> methods;
John McCallef19dbb2012-10-17 04:53:23 +00006158 if (flags & NonFragileABI_Class_Meta) {
John McCall176f8922016-11-30 02:39:18 +00006159 for (const auto *MD : ID->class_methods())
6160 methods.push_back(MD);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006161 } else {
John McCall176f8922016-11-30 02:39:18 +00006162 for (const auto *MD : ID->instance_methods())
6163 methods.push_back(MD);
Aaron Ballmanf26acce2014-03-13 19:50:17 +00006164
Aaron Ballmand85eff42014-03-14 15:02:45 +00006165 for (const auto *PID : ID->property_impls()) {
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00006166 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize){
6167 ObjCPropertyDecl *PD = PID->getPropertyDecl();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006168
John McCall176f8922016-11-30 02:39:18 +00006169 if (auto MD = PD->getGetterMethodDecl())
6170 if (GetMethodDefinition(MD))
6171 methods.push_back(MD);
6172 if (auto MD = PD->getSetterMethodDecl())
6173 if (GetMethodDefinition(MD))
6174 methods.push_back(MD);
Fariborz Jahaniand27a8202009-01-28 22:46:49 +00006175 }
6176 }
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006177 }
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006178
John McCall176f8922016-11-30 02:39:18 +00006179 values.add(emitMethodList(ID->getObjCRuntimeNameAsString(),
6180 (flags & NonFragileABI_Class_Meta)
6181 ? MethodListType::ClassMethods
6182 : MethodListType::InstanceMethods,
6183 methods));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006184
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006185 const ObjCInterfaceDecl *OID = ID->getClassInterface();
6186 assert(OID && "CGObjCNonFragileABIMac::BuildClassRoTInitializer");
John McCall176f8922016-11-30 02:39:18 +00006187 values.add(EmitProtocolList("\01l_OBJC_CLASS_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006188 + OID->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006189 OID->all_referenced_protocol_begin(),
6190 OID->all_referenced_protocol_end()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006191
John McCallef19dbb2012-10-17 04:53:23 +00006192 if (flags & NonFragileABI_Class_Meta) {
John McCall176f8922016-11-30 02:39:18 +00006193 values.addNullPointer(ObjCTypes.IvarListnfABIPtrTy);
6194 values.add(GetIvarLayoutName(nullptr, ObjCTypes));
6195 values.add(EmitPropertyList(
Manman Renad0e7912016-01-29 19:22:54 +00006196 "\01l_OBJC_$_CLASS_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006197 ID, ID->getClassInterface(), ObjCTypes, true));
John McCallef19dbb2012-10-17 04:53:23 +00006198 } else {
John McCall176f8922016-11-30 02:39:18 +00006199 values.add(EmitIvarList(ID));
6200 values.add(BuildWeakIvarLayout(ID, beginInstance, endInstance, hasMRCWeak));
6201 values.add(EmitPropertyList(
Manman Renad0e7912016-01-29 19:22:54 +00006202 "\01l_OBJC_$_PROP_LIST_" + ID->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006203 ID, ID->getClassInterface(), ObjCTypes, false));
John McCallef19dbb2012-10-17 04:53:23 +00006204 }
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006205
John McCall176f8922016-11-30 02:39:18 +00006206 llvm::SmallString<64> roLabel;
6207 llvm::raw_svector_ostream(roLabel)
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006208 << ((flags & NonFragileABI_Class_Meta) ? "\01l_OBJC_METACLASS_RO_$_"
6209 : "\01l_OBJC_CLASS_RO_$_")
6210 << ClassName;
6211
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006212 llvm::GlobalVariable *CLASS_RO_GV =
John McCall176f8922016-11-30 02:39:18 +00006213 values.finishAndCreateGlobal(roLabel, CGM.getPointerAlign(),
6214 /*constant*/ false,
6215 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006216 if (CGM.getTriple().isOSBinFormatMachO())
6217 CLASS_RO_GV->setSection("__DATA, __objc_const");
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006218 return CLASS_RO_GV;
6219}
6220
John McCalldba63a72016-11-30 23:54:50 +00006221/// Build the metaclass object for a class.
6222///
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006223/// struct _class_t {
6224/// struct _class_t *isa;
6225/// struct _class_t * const superclass;
6226/// void *cache;
6227/// IMP *vtable;
6228/// struct class_ro_t *ro;
6229/// }
6230///
John McCalldba63a72016-11-30 23:54:50 +00006231llvm::GlobalVariable *
6232CGObjCNonFragileABIMac::BuildClassObject(const ObjCInterfaceDecl *CI,
6233 bool isMetaclass,
6234 llvm::Constant *IsAGV,
6235 llvm::Constant *SuperClassGV,
6236 llvm::Constant *ClassRoGV,
6237 bool HiddenVisibility) {
John McCall176f8922016-11-30 02:39:18 +00006238 ConstantInitBuilder builder(CGM);
6239 auto values = builder.beginStruct(ObjCTypes.ClassnfABITy);
6240 values.add(IsAGV);
6241 if (SuperClassGV) {
6242 values.add(SuperClassGV);
6243 } else {
6244 values.addNullPointer(ObjCTypes.ClassnfABIPtrTy);
6245 }
6246 values.add(ObjCEmptyCacheVar);
6247 values.add(ObjCEmptyVtableVar);
6248 values.add(ClassRoGV);
6249
John McCalldba63a72016-11-30 23:54:50 +00006250 llvm::GlobalVariable *GV =
6251 cast<llvm::GlobalVariable>(GetClassGlobal(CI, isMetaclass, ForDefinition));
John McCall176f8922016-11-30 02:39:18 +00006252 values.finishAndSetAsInitializer(GV);
6253
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006254 if (CGM.getTriple().isOSBinFormatMachO())
6255 GV->setSection("__DATA, __objc_data");
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006256 GV->setAlignment(
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006257 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ClassnfABITy));
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006258 if (!CGM.getTriple().isOSBinFormatCOFF())
6259 if (HiddenVisibility)
6260 GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006261 return GV;
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006262}
6263
Joe Danielsf7393d22019-02-04 23:32:55 +00006264bool CGObjCNonFragileABIMac::ImplementationIsNonLazy(
6265 const ObjCImplDecl *OD) const {
6266 return OD->getClassMethod(GetNullarySelector("load")) != nullptr ||
6267 OD->getClassInterface()->hasAttr<ObjCNonLazyClassAttr>();
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006268}
6269
Daniel Dunbar961202372009-05-03 12:57:56 +00006270void CGObjCNonFragileABIMac::GetClassSizeInfo(const ObjCImplementationDecl *OID,
Daniel Dunbar554fd792009-04-19 23:41:48 +00006271 uint32_t &InstanceStart,
6272 uint32_t &InstanceSize) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006273 const ASTRecordLayout &RL =
Daniel Dunbar9252ee12009-05-04 21:26:30 +00006274 CGM.getContext().getASTObjCImplementationLayout(OID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006275
Daniel Dunbar9b042e02009-05-04 23:23:09 +00006276 // InstanceSize is really instance end.
Ken Dyckd5090c12011-02-11 02:20:09 +00006277 InstanceSize = RL.getDataSize().getQuantity();
Daniel Dunbar9b042e02009-05-04 23:23:09 +00006278
6279 // If there are no fields, the start is the same as the end.
6280 if (!RL.getFieldCount())
6281 InstanceStart = InstanceSize;
6282 else
Ken Dyckc5ca8762011-04-14 00:43:09 +00006283 InstanceStart = RL.getFieldOffset(0) / CGM.getContext().getCharWidth();
Daniel Dunbar554fd792009-04-19 23:41:48 +00006284}
6285
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006286static llvm::GlobalValue::DLLStorageClassTypes getStorage(CodeGenModule &CGM,
6287 StringRef Name) {
6288 IdentifierInfo &II = CGM.getContext().Idents.get(Name);
6289 TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
6290 DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);
6291
6292 const VarDecl *VD = nullptr;
6293 for (const auto &Result : DC->lookup(&II))
6294 if ((VD = dyn_cast<VarDecl>(Result)))
6295 break;
6296
6297 if (!VD)
6298 return llvm::GlobalValue::DLLImportStorageClass;
6299 if (VD->hasAttr<DLLExportAttr>())
6300 return llvm::GlobalValue::DLLExportStorageClass;
6301 if (VD->hasAttr<DLLImportAttr>())
6302 return llvm::GlobalValue::DLLImportStorageClass;
6303 return llvm::GlobalValue::DefaultStorageClass;
6304}
6305
Fariborz Jahanian71394042009-01-23 23:53:38 +00006306void CGObjCNonFragileABIMac::GenerateClass(const ObjCImplementationDecl *ID) {
Fariborz Jahanian71394042009-01-23 23:53:38 +00006307 if (!ObjCEmptyCacheVar) {
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006308 ObjCEmptyCacheVar =
6309 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.CacheTy, false,
6310 llvm::GlobalValue::ExternalLinkage, nullptr,
6311 "_objc_empty_cache");
6312 if (CGM.getTriple().isOSBinFormatCOFF())
6313 ObjCEmptyCacheVar->setDLLStorageClass(getStorage(CGM, "_objc_empty_cache"));
Craig Topper8a13c412014-05-21 05:09:00 +00006314
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00006315 // Only OS X with deployment version <10.9 use the empty vtable symbol
Fariborz Jahanian42d49552013-10-24 17:40:28 +00006316 const llvm::Triple &Triple = CGM.getTarget().getTriple();
Saleem Abdulrasool4f515a62016-07-13 02:58:44 +00006317 if (Triple.isMacOSX() && Triple.isMacOSXVersionLT(10, 9))
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006318 ObjCEmptyVtableVar =
6319 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ImpnfABITy, false,
6320 llvm::GlobalValue::ExternalLinkage, nullptr,
6321 "_objc_empty_vtable");
John McCall176f8922016-11-30 02:39:18 +00006322 else
6323 ObjCEmptyVtableVar =
6324 llvm::ConstantPointerNull::get(ObjCTypes.ImpnfABITy->getPointerTo());
Fariborz Jahanian71394042009-01-23 23:53:38 +00006325 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006326
Daniel Dunbare3f5cfc2009-04-20 20:18:54 +00006327 // FIXME: Is this correct (that meta class size is never computed)?
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006328 uint32_t InstanceStart =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006329 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ClassnfABITy);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006330 uint32_t InstanceSize = InstanceStart;
John McCallef19dbb2012-10-17 04:53:23 +00006331 uint32_t flags = NonFragileABI_Class_Meta;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006332
John McCalldba63a72016-11-30 23:54:50 +00006333 llvm::Constant *SuperClassGV, *IsAGV;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006334
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006335 const auto *CI = ID->getClassInterface();
6336 assert(CI && "CGObjCNonFragileABIMac::GenerateClass - class is 0");
6337
John McCall0d54a172012-10-17 04:53:31 +00006338 // Build the flags for the metaclass.
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006339 bool classIsHidden = (CGM.getTriple().isOSBinFormatCOFF())
6340 ? !CI->hasAttr<DLLExportAttr>()
6341 : CI->getVisibility() == HiddenVisibility;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006342 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006343 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006344
6345 // FIXME: why is this flag set on the metaclass?
6346 // ObjC metaclasses have no fields and don't really get constructed.
6347 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006348 flags |= NonFragileABI_Class_HasCXXStructors;
John McCall0d54a172012-10-17 04:53:31 +00006349 if (!ID->hasNonZeroConstructors())
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006350 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
John McCall0d54a172012-10-17 04:53:31 +00006351 }
6352
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006353 if (!CI->getSuperClass()) {
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006354 // class is root
John McCallef19dbb2012-10-17 04:53:23 +00006355 flags |= NonFragileABI_Class_Root;
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006356
John McCalldba63a72016-11-30 23:54:50 +00006357 SuperClassGV = GetClassGlobal(CI, /*metaclass*/ false, NotForDefinition);
6358 IsAGV = GetClassGlobal(CI, /*metaclass*/ true, NotForDefinition);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006359 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006360 // Has a root. Current class is not a root.
Fariborz Jahanian03b300b2009-02-26 18:23:47 +00006361 const ObjCInterfaceDecl *Root = ID->getClassInterface();
6362 while (const ObjCInterfaceDecl *Super = Root->getSuperClass())
6363 Root = Super;
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006364
6365 const auto *Super = CI->getSuperClass();
John McCalldba63a72016-11-30 23:54:50 +00006366 IsAGV = GetClassGlobal(Root, /*metaclass*/ true, NotForDefinition);
6367 SuperClassGV = GetClassGlobal(Super, /*metaclass*/ true, NotForDefinition);
Fariborz Jahanian9e3ad522009-01-24 20:21:50 +00006368 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006369
6370 llvm::GlobalVariable *CLASS_RO_GV =
6371 BuildClassRoTInitializer(flags, InstanceStart, InstanceSize, ID);
6372
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006373 llvm::GlobalVariable *MetaTClass =
John McCalldba63a72016-11-30 23:54:50 +00006374 BuildClassObject(CI, /*metaclass*/ true,
6375 IsAGV, SuperClassGV, CLASS_RO_GV, classIsHidden);
Rafael Espindolab7350042018-03-01 00:35:47 +00006376 CGM.setGVProperties(MetaTClass, CI);
Fariborz Jahanian67260552009-11-17 21:37:35 +00006377 DefinedMetaClasses.push_back(MetaTClass);
Daniel Dunbar15894b72009-04-07 05:48:37 +00006378
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006379 // Metadata for the class
John McCallef19dbb2012-10-17 04:53:23 +00006380 flags = 0;
Fariborz Jahanian82208252009-01-31 00:59:10 +00006381 if (classIsHidden)
John McCallef19dbb2012-10-17 04:53:23 +00006382 flags |= NonFragileABI_Class_Hidden;
John McCall0d54a172012-10-17 04:53:31 +00006383
6384 if (ID->hasNonZeroConstructors() || ID->hasDestructors()) {
John McCallef19dbb2012-10-17 04:53:23 +00006385 flags |= NonFragileABI_Class_HasCXXStructors;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006386
John McCall0d54a172012-10-17 04:53:31 +00006387 // Set a flag to enable a runtime optimization when a class has
6388 // fields that require destruction but which don't require
6389 // anything except zero-initialization during construction. This
6390 // is most notably true of __strong and __weak types, but you can
6391 // also imagine there being C++ types with non-trivial default
6392 // constructors that merely set all fields to null.
6393 if (!ID->hasNonZeroConstructors())
6394 flags |= NonFragileABI_Class_HasCXXDestructorOnly;
6395 }
6396
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006397 if (hasObjCExceptionAttribute(CGM.getContext(), CI))
John McCallef19dbb2012-10-17 04:53:23 +00006398 flags |= NonFragileABI_Class_Exception;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006399
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006400 if (!CI->getSuperClass()) {
John McCallef19dbb2012-10-17 04:53:23 +00006401 flags |= NonFragileABI_Class_Root;
Craig Topper8a13c412014-05-21 05:09:00 +00006402 SuperClassGV = nullptr;
Chris Lattnerb433b272009-04-19 06:02:28 +00006403 } else {
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006404 // Has a root. Current class is not a root.
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006405 const auto *Super = CI->getSuperClass();
John McCalldba63a72016-11-30 23:54:50 +00006406 SuperClassGV = GetClassGlobal(Super, /*metaclass*/ false, NotForDefinition);
Fariborz Jahanian4723fb72009-01-24 21:21:53 +00006407 }
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006408
Daniel Dunbar961202372009-05-03 12:57:56 +00006409 GetClassSizeInfo(ID, InstanceStart, InstanceSize);
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006410 CLASS_RO_GV =
6411 BuildClassRoTInitializer(flags, InstanceStart, InstanceSize, ID);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006412
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006413 llvm::GlobalVariable *ClassMD =
John McCalldba63a72016-11-30 23:54:50 +00006414 BuildClassObject(CI, /*metaclass*/ false,
6415 MetaTClass, SuperClassGV, CLASS_RO_GV, classIsHidden);
Rafael Espindolab7350042018-03-01 00:35:47 +00006416 CGM.setGVProperties(ClassMD, CI);
Fariborz Jahanian279abd32009-01-30 20:55:31 +00006417 DefinedClasses.push_back(ClassMD);
Saleem Abdulrasoolbc2d9992016-07-16 22:42:04 +00006418 ImplementedClasses.push_back(CI);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006419
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006420 // Determine if this class is also "non-lazy".
6421 if (ImplementationIsNonLazy(ID))
6422 DefinedNonLazyClasses.push_back(ClassMD);
6423
Daniel Dunbar8f28d012009-04-08 04:21:03 +00006424 // Force the definition of the EHType if necessary.
John McCallef19dbb2012-10-17 04:53:23 +00006425 if (flags & NonFragileABI_Class_Exception)
John McCalldba63a72016-11-30 23:54:50 +00006426 (void) GetInterfaceEHType(CI, ForDefinition);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006427 // Make sure method definition entries are all clear for next implementation.
6428 MethodDefinitions.clear();
Fariborz Jahanian71394042009-01-23 23:53:38 +00006429}
6430
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006431/// GenerateProtocolRef - This routine is called to generate code for
6432/// a protocol reference expression; as in:
6433/// @code
6434/// @protocol(Proto1);
6435/// @endcode
6436/// It generates a weak reference to l_OBJC_PROTOCOL_REFERENCE_$_Proto1
6437/// which will hold address of the protocol meta-data.
6438///
John McCall882987f2013-02-28 19:01:20 +00006439llvm::Value *CGObjCNonFragileABIMac::GenerateProtocolRef(CodeGenFunction &CGF,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006440 const ObjCProtocolDecl *PD) {
6441
Fariborz Jahanian464423d2009-04-10 18:47:34 +00006442 // This routine is called for @protocol only. So, we must build definition
6443 // of protocol's meta-data (not a reference to it!)
6444 //
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006445 llvm::Constant *Init =
6446 llvm::ConstantExpr::getBitCast(GetOrEmitProtocol(PD),
Douglas Gregor020de322012-01-17 18:36:30 +00006447 ObjCTypes.getExternalProtocolPtrTy());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006448
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006449 std::string ProtocolName("\01l_OBJC_PROTOCOL_REFERENCE_$_");
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006450 ProtocolName += PD->getObjCRuntimeNameAsString();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006451
John McCall7f416cc2015-09-08 08:05:57 +00006452 CharUnits Align = CGF.getPointerAlign();
6453
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006454 llvm::GlobalVariable *PTGV = CGM.getModule().getGlobalVariable(ProtocolName);
6455 if (PTGV)
John McCall7f416cc2015-09-08 08:05:57 +00006456 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Saleem Abdulrasool9f83f3b2017-06-29 00:54:44 +00006457 PTGV = new llvm::GlobalVariable(CGM.getModule(), Init->getType(), false,
6458 llvm::GlobalValue::WeakAnyLinkage, Init,
6459 ProtocolName);
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00006460 PTGV->setSection(GetSectionName("__objc_protorefs",
6461 "coalesced,no_dead_strip"));
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006462 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
John McCall7f416cc2015-09-08 08:05:57 +00006463 PTGV->setAlignment(Align.getQuantity());
Saleem Abdulrasool9f83f3b2017-06-29 00:54:44 +00006464 if (!CGM.getTriple().isOSBinFormatMachO())
6465 PTGV->setComdat(CGM.getModule().getOrInsertComdat(ProtocolName));
Saleem Abdulrasoolbe2b5cb2018-01-23 19:35:51 +00006466 CGM.addUsedGlobal(PTGV);
John McCall7f416cc2015-09-08 08:05:57 +00006467 return CGF.Builder.CreateAlignedLoad(PTGV, Align);
Fariborz Jahanian097feda2009-01-30 18:58:59 +00006468}
6469
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006470/// GenerateCategory - Build metadata for a category implementation.
6471/// struct _category_t {
6472/// const char * const name;
6473/// struct _class_t *const cls;
6474/// const struct _method_list_t * const instance_methods;
6475/// const struct _method_list_t * const class_methods;
6476/// const struct _protocol_list_t * const protocols;
6477/// const struct _prop_list_t * const properties;
Manman Ren96df0b32016-01-29 23:45:01 +00006478/// const struct _prop_list_t * const class_properties;
Manman Ren42ff3902016-02-24 17:49:50 +00006479/// const uint32_t size;
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006480/// }
6481///
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006482void CGObjCNonFragileABIMac::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006483 const ObjCInterfaceDecl *Interface = OCD->getClassInterface();
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006484 const char *Prefix = "\01l_OBJC_$_CATEGORY_";
Fangrui Song6907ce22018-07-30 19:24:48 +00006485
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006486 llvm::SmallString<64> ExtCatName(Prefix);
6487 ExtCatName += Interface->getObjCRuntimeNameAsString();
6488 ExtCatName += "_$_";
6489 ExtCatName += OCD->getNameAsString();
Fangrui Song6907ce22018-07-30 19:24:48 +00006490
John McCall176f8922016-11-30 02:39:18 +00006491 ConstantInitBuilder builder(CGM);
6492 auto values = builder.beginStruct(ObjCTypes.CategorynfABITy);
6493 values.add(GetClassName(OCD->getIdentifier()->getName()));
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006494 // meta-class entry symbol
John McCalldba63a72016-11-30 23:54:50 +00006495 values.add(GetClassGlobal(Interface, /*metaclass*/ false, NotForDefinition));
John McCall176f8922016-11-30 02:39:18 +00006496 std::string listName =
Saleem Abdulrasool209150a2016-10-24 21:25:57 +00006497 (Interface->getObjCRuntimeNameAsString() + "_$_" + OCD->getName()).str();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006498
John McCall176f8922016-11-30 02:39:18 +00006499 SmallVector<const ObjCMethodDecl *, 16> instanceMethods;
6500 SmallVector<const ObjCMethodDecl *, 8> classMethods;
6501 for (const auto *MD : OCD->methods()) {
6502 if (MD->isInstanceMethod()) {
6503 instanceMethods.push_back(MD);
6504 } else {
6505 classMethods.push_back(MD);
6506 }
6507 }
Fariborz Jahanian2612e142009-01-26 22:58:07 +00006508
John McCall176f8922016-11-30 02:39:18 +00006509 values.add(emitMethodList(listName, MethodListType::CategoryInstanceMethods,
6510 instanceMethods));
6511 values.add(emitMethodList(listName, MethodListType::CategoryClassMethods,
6512 classMethods));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006513
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006514 const ObjCCategoryDecl *Category =
Fariborz Jahanian066347e2009-01-28 22:18:42 +00006515 Interface->FindCategoryDeclaration(OCD->getIdentifier());
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006516 if (Category) {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006517 SmallString<256> ExtName;
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006518 llvm::raw_svector_ostream(ExtName) << Interface->getObjCRuntimeNameAsString() << "_$_"
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006519 << OCD->getName();
John McCall176f8922016-11-30 02:39:18 +00006520 values.add(EmitProtocolList("\01l_OBJC_CATEGORY_PROTOCOLS_$_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006521 + Interface->getObjCRuntimeNameAsString() + "_$_"
6522 + Category->getName(),
John McCall176f8922016-11-30 02:39:18 +00006523 Category->protocol_begin(),
6524 Category->protocol_end()));
6525 values.add(EmitPropertyList("\01l_OBJC_$_PROP_LIST_" + ExtName.str(),
6526 OCD, Category, ObjCTypes, false));
6527 values.add(EmitPropertyList("\01l_OBJC_$_CLASS_PROP_LIST_" + ExtName.str(),
6528 OCD, Category, ObjCTypes, true));
Mike Stump658fe022009-07-30 22:28:39 +00006529 } else {
John McCall176f8922016-11-30 02:39:18 +00006530 values.addNullPointer(ObjCTypes.ProtocolListnfABIPtrTy);
6531 values.addNullPointer(ObjCTypes.PropertyListPtrTy);
6532 values.addNullPointer(ObjCTypes.PropertyListPtrTy);
Fariborz Jahaniand8fc1052009-02-13 17:52:22 +00006533 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006534
Manman Ren42ff3902016-02-24 17:49:50 +00006535 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.CategorynfABITy);
John McCall176f8922016-11-30 02:39:18 +00006536 values.addInt(ObjCTypes.IntTy, Size);
Manman Ren42ff3902016-02-24 17:49:50 +00006537
John McCall176f8922016-11-30 02:39:18 +00006538 llvm::GlobalVariable *GCATV =
6539 values.finishAndCreateGlobal(ExtCatName.str(), CGM.getPointerAlign(),
6540 /*constant*/ false,
6541 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006542 if (CGM.getTriple().isOSBinFormatMachO())
6543 GCATV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006544 CGM.addCompilerUsedGlobal(GCATV);
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006545 DefinedCategories.push_back(GCATV);
Daniel Dunbar9a017d72009-05-15 22:33:15 +00006546
6547 // Determine if this category is also "non-lazy".
6548 if (ImplementationIsNonLazy(OCD))
6549 DefinedNonLazyCategories.push_back(GCATV);
Fariborz Jahanianc0577942011-04-22 22:02:28 +00006550 // method definition entries must be clear for next implementation.
6551 MethodDefinitions.clear();
Fariborz Jahanian0c8d0602009-01-26 18:32:24 +00006552}
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006553
John McCall176f8922016-11-30 02:39:18 +00006554/// emitMethodConstant - Return a struct objc_method constant. If
6555/// forProtocol is true, the implementation will be null; otherwise,
6556/// the method must have a definition registered with the runtime.
6557///
6558/// struct _objc_method {
6559/// SEL _cmd;
6560/// char *method_type;
6561/// char *_imp;
6562/// }
6563void CGObjCNonFragileABIMac::emitMethodConstant(ConstantArrayBuilder &builder,
6564 const ObjCMethodDecl *MD,
6565 bool forProtocol) {
6566 auto method = builder.beginStruct(ObjCTypes.MethodTy);
6567 method.addBitCast(GetMethodVarName(MD->getSelector()),
6568 ObjCTypes.SelectorPtrTy);
6569 method.add(GetMethodVarType(MD));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006570
John McCall176f8922016-11-30 02:39:18 +00006571 if (forProtocol) {
6572 // Protocol methods have no implementation. So, this entry is always NULL.
6573 method.addNullPointer(ObjCTypes.Int8PtrTy);
6574 } else {
6575 llvm::Function *fn = GetMethodDefinition(MD);
6576 assert(fn && "no definition for method?");
6577 method.addBitCast(fn, ObjCTypes.Int8PtrTy);
6578 }
6579
6580 method.finishAndAddTo(builder);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006581}
6582
John McCall176f8922016-11-30 02:39:18 +00006583/// Build meta-data for method declarations.
6584///
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006585/// struct _method_list_t {
6586/// uint32_t entsize; // sizeof(struct _objc_method)
6587/// uint32_t method_count;
6588/// struct _objc_method method_list[method_count];
6589/// }
6590///
Zachary Turner41a9ee92017-10-11 23:54:34 +00006591llvm::Constant *
6592CGObjCNonFragileABIMac::emitMethodList(Twine name, MethodListType kind,
6593 ArrayRef<const ObjCMethodDecl *> methods) {
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006594 // Return null for empty list.
John McCall176f8922016-11-30 02:39:18 +00006595 if (methods.empty())
Owen Anderson0b75f232009-07-31 20:28:54 +00006596 return llvm::Constant::getNullValue(ObjCTypes.MethodListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006597
John McCall176f8922016-11-30 02:39:18 +00006598 StringRef prefix;
6599 bool forProtocol;
6600 switch (kind) {
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006601 case MethodListType::CategoryInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006602 prefix = "\01l_OBJC_$_CATEGORY_INSTANCE_METHODS_";
6603 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006604 break;
6605 case MethodListType::CategoryClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006606 prefix = "\01l_OBJC_$_CATEGORY_CLASS_METHODS_";
6607 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006608 break;
6609 case MethodListType::InstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006610 prefix = "\01l_OBJC_$_INSTANCE_METHODS_";
6611 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006612 break;
6613 case MethodListType::ClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006614 prefix = "\01l_OBJC_$_CLASS_METHODS_";
6615 forProtocol = false;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006616 break;
6617
6618 case MethodListType::ProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006619 prefix = "\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_";
6620 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006621 break;
6622 case MethodListType::ProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006623 prefix = "\01l_OBJC_$_PROTOCOL_CLASS_METHODS_";
6624 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006625 break;
6626 case MethodListType::OptionalProtocolInstanceMethods:
John McCall176f8922016-11-30 02:39:18 +00006627 prefix = "\01l_OBJC_$_PROTOCOL_INSTANCE_METHODS_OPT_";
6628 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006629 break;
6630 case MethodListType::OptionalProtocolClassMethods:
John McCall176f8922016-11-30 02:39:18 +00006631 prefix = "\01l_OBJC_$_PROTOCOL_CLASS_METHODS_OPT_";
6632 forProtocol = true;
Saleem Abdulrasoold48b0a32016-10-24 20:47:58 +00006633 break;
6634 }
6635
John McCall176f8922016-11-30 02:39:18 +00006636 ConstantInitBuilder builder(CGM);
6637 auto values = builder.beginStruct();
6638
6639 // sizeof(struct _objc_method)
6640 unsigned Size = CGM.getDataLayout().getTypeAllocSize(ObjCTypes.MethodTy);
6641 values.addInt(ObjCTypes.IntTy, Size);
6642 // method_count
6643 values.addInt(ObjCTypes.IntTy, methods.size());
6644 auto methodArray = values.beginArray(ObjCTypes.MethodTy);
6645 for (auto MD : methods) {
6646 emitMethodConstant(methodArray, MD, forProtocol);
6647 }
6648 methodArray.finishAndAddTo(values);
6649
Zachary Turner41a9ee92017-10-11 23:54:34 +00006650 auto *GV = values.finishAndCreateGlobal(prefix + name, CGM.getPointerAlign(),
John McCall176f8922016-11-30 02:39:18 +00006651 /*constant*/ false,
6652 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006653 if (CGM.getTriple().isOSBinFormatMachO())
6654 GV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006655 CGM.addCompilerUsedGlobal(GV);
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006656 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.MethodListnfABIPtrTy);
Fariborz Jahanian99113fd2009-01-26 21:38:32 +00006657}
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006658
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006659/// ObjCIvarOffsetVariable - Returns the ivar offset variable for
6660/// the given ivar.
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006661llvm::GlobalVariable *
6662CGObjCNonFragileABIMac::ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
6663 const ObjCIvarDecl *Ivar) {
6664 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006665 llvm::SmallString<64> Name("OBJC_IVAR_$_");
6666 Name += Container->getObjCRuntimeNameAsString();
6667 Name += ".";
6668 Name += Ivar->getName();
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006669 llvm::GlobalVariable *IvarOffsetGV = CGM.getModule().getGlobalVariable(Name);
6670 if (!IvarOffsetGV) {
6671 IvarOffsetGV =
6672 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.IvarOffsetVarTy,
6673 false, llvm::GlobalValue::ExternalLinkage,
6674 nullptr, Name.str());
6675 if (CGM.getTriple().isOSBinFormatCOFF()) {
6676 bool IsPrivateOrPackage =
6677 Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6678 Ivar->getAccessControl() == ObjCIvarDecl::Package;
6679
Saleem Abdulrasoolad75c7d2017-10-25 03:58:15 +00006680 const ObjCInterfaceDecl *ContainingID = Ivar->getContainingInterface();
6681
6682 if (ContainingID->hasAttr<DLLImportAttr>())
6683 IvarOffsetGV
6684 ->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
6685 else if (ContainingID->hasAttr<DLLExportAttr>() && !IsPrivateOrPackage)
6686 IvarOffsetGV
6687 ->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006688 }
6689 }
Fariborz Jahanian4e7ae062009-02-10 20:21:06 +00006690 return IvarOffsetGV;
6691}
6692
Daniel Dunbar8c7f9812010-04-02 21:14:02 +00006693llvm::Constant *
6694CGObjCNonFragileABIMac::EmitIvarOffsetVar(const ObjCInterfaceDecl *ID,
6695 const ObjCIvarDecl *Ivar,
Eli Friedman8cbca202012-11-06 22:15:52 +00006696 unsigned long int Offset) {
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006697 llvm::GlobalVariable *IvarOffsetGV = ObjCIvarOffsetVariable(ID, Ivar);
Tim Northover238b5082014-03-29 13:42:40 +00006698 IvarOffsetGV->setInitializer(
6699 llvm::ConstantInt::get(ObjCTypes.IvarOffsetVarTy, Offset));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006700 IvarOffsetGV->setAlignment(
Tim Northover238b5082014-03-29 13:42:40 +00006701 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.IvarOffsetVarTy));
Daniel Dunbarbf90b332009-04-19 00:44:02 +00006702
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00006703 if (!CGM.getTriple().isOSBinFormatCOFF()) {
6704 // FIXME: This matches gcc, but shouldn't the visibility be set on the use
6705 // as well (i.e., in ObjCIvarOffsetVariable).
6706 if (Ivar->getAccessControl() == ObjCIvarDecl::Private ||
6707 Ivar->getAccessControl() == ObjCIvarDecl::Package ||
6708 ID->getVisibility() == HiddenVisibility)
6709 IvarOffsetGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
6710 else
6711 IvarOffsetGV->setVisibility(llvm::GlobalValue::DefaultVisibility);
6712 }
6713
Erik Pilkington2ff012d2019-01-17 18:18:53 +00006714 // If ID's layout is known, then make the global constant. This serves as a
6715 // useful assertion: we'll never use this variable to calculate ivar offsets,
6716 // so if the runtime tries to patch it then we should crash.
6717 if (isClassLayoutKnownStatically(ID))
6718 IvarOffsetGV->setConstant(true);
6719
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006720 if (CGM.getTriple().isOSBinFormatMachO())
6721 IvarOffsetGV->setSection("__DATA, __objc_ivar");
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006722 return IvarOffsetGV;
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006723}
6724
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006725/// EmitIvarList - Emit the ivar list for the given
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00006726/// implementation. The return value has type
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006727/// IvarListnfABIPtrTy.
6728/// struct _ivar_t {
Tim Northover238b5082014-03-29 13:42:40 +00006729/// unsigned [long] int *offset; // pointer to ivar offset location
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006730/// char *name;
6731/// char *type;
6732/// uint32_t alignment;
6733/// uint32_t size;
6734/// }
6735/// struct _ivar_list_t {
6736/// uint32 entsize; // sizeof(struct _ivar_t)
6737/// uint32 count;
6738/// struct _iver_t list[count];
6739/// }
6740///
Daniel Dunbarf5c18462009-04-20 06:54:31 +00006741
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006742llvm::Constant *CGObjCNonFragileABIMac::EmitIvarList(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006743 const ObjCImplementationDecl *ID) {
6744
John McCall176f8922016-11-30 02:39:18 +00006745 ConstantInitBuilder builder(CGM);
6746 auto ivarList = builder.beginStruct();
6747 ivarList.addInt(ObjCTypes.IntTy,
6748 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.IvarnfABITy));
6749 auto ivarCountSlot = ivarList.addPlaceholder();
6750 auto ivars = ivarList.beginArray(ObjCTypes.IvarnfABITy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006751
Jordy Rosea91768e2011-07-22 02:08:32 +00006752 const ObjCInterfaceDecl *OID = ID->getClassInterface();
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006753 assert(OID && "CGObjCNonFragileABIMac::EmitIvarList - null interface");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006754
Fariborz Jahanian40a4bcd2009-01-28 01:05:23 +00006755 // FIXME. Consolidate this with similar code in GenerateClass.
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006756
Fangrui Song6907ce22018-07-30 19:24:48 +00006757 for (const ObjCIvarDecl *IVD = OID->all_declared_ivar_begin();
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00006758 IVD; IVD = IVD->getNextIvar()) {
Fariborz Jahanian7c809592009-06-04 01:19:09 +00006759 // Ignore unnamed bit-fields.
6760 if (!IVD->getDeclName())
6761 continue;
John McCall176f8922016-11-30 02:39:18 +00006762
6763 auto ivar = ivars.beginStruct(ObjCTypes.IvarnfABITy);
6764 ivar.add(EmitIvarOffsetVar(ID->getClassInterface(), IVD,
6765 ComputeIvarBaseOffset(CGM, ID, IVD)));
6766 ivar.add(GetMethodVarName(IVD->getIdentifier()));
6767 ivar.add(GetMethodVarType(IVD));
Chris Lattner2192fe52011-07-18 04:24:23 +00006768 llvm::Type *FieldTy =
Daniel Dunbar725dc2c2009-04-22 08:22:17 +00006769 CGM.getTypes().ConvertTypeForMem(IVD->getType());
Micah Villmowdd31ca12012-10-08 16:25:52 +00006770 unsigned Size = CGM.getDataLayout().getTypeAllocSize(FieldTy);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006771 unsigned Align = CGM.getContext().getPreferredTypeAlign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006772 IVD->getType().getTypePtr()) >> 3;
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006773 Align = llvm::Log2_32(Align);
John McCall176f8922016-11-30 02:39:18 +00006774 ivar.addInt(ObjCTypes.IntTy, Align);
Daniel Dunbarae032262009-04-20 00:33:43 +00006775 // NOTE. Size of a bitfield does not match gcc's, because of the
6776 // way bitfields are treated special in each. But I am told that
6777 // 'size' for bitfield ivars is ignored by the runtime so it does
6778 // not matter. If it matters, there is enough info to get the
6779 // bitfield right!
John McCall176f8922016-11-30 02:39:18 +00006780 ivar.addInt(ObjCTypes.IntTy, Size);
6781 ivar.finishAndAddTo(ivars);
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006782 }
6783 // Return null for empty list.
John McCall176f8922016-11-30 02:39:18 +00006784 if (ivars.empty()) {
6785 ivars.abandon();
6786 ivarList.abandon();
Owen Anderson0b75f232009-07-31 20:28:54 +00006787 return llvm::Constant::getNullValue(ObjCTypes.IvarListnfABIPtrTy);
John McCall176f8922016-11-30 02:39:18 +00006788 }
Chris Lattnere64d7ba2011-06-20 04:01:35 +00006789
John McCall176f8922016-11-30 02:39:18 +00006790 auto ivarCount = ivars.size();
6791 ivars.finishAndAddTo(ivarList);
6792 ivarList.fillPlaceholderWithInt(ivarCountSlot, ObjCTypes.IntTy, ivarCount);
6793
Fariborz Jahanian7415caa2009-01-27 19:38:51 +00006794 const char *Prefix = "\01l_OBJC_$_INSTANCE_VARIABLES_";
6795 llvm::GlobalVariable *GV =
John McCall176f8922016-11-30 02:39:18 +00006796 ivarList.finishAndCreateGlobal(Prefix + OID->getObjCRuntimeNameAsString(),
6797 CGM.getPointerAlign(), /*constant*/ false,
6798 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006799 if (CGM.getTriple().isOSBinFormatMachO())
6800 GV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006801 CGM.addCompilerUsedGlobal(GV);
Owen Andersonade90fd2009-07-29 18:54:39 +00006802 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.IvarListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006803}
6804
6805llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocolRef(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006806 const ObjCProtocolDecl *PD) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006807 llvm::GlobalVariable *&Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006808
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006809 if (!Entry) {
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006810 // We use the initializer as a marker of whether this is a forward
6811 // reference or not. At module finalization we add the empty
6812 // contents for protocols which were referenced but never defined.
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006813 llvm::SmallString<64> Protocol;
6814 llvm::raw_svector_ostream(Protocol) << "\01l_OBJC_PROTOCOL_$_"
6815 << PD->getObjCRuntimeNameAsString();
6816
6817 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABITy,
6818 false, llvm::GlobalValue::ExternalLinkage,
6819 nullptr, Protocol);
6820 if (!CGM.getTriple().isOSBinFormatMachO())
6821 Entry->setComdat(CGM.getModule().getOrInsertComdat(Protocol));
6822 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006823
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006824 return Entry;
6825}
6826
6827/// GetOrEmitProtocol - Generate the protocol meta-data:
6828/// @code
6829/// struct _protocol_t {
6830/// id isa; // NULL
6831/// const char * const protocol_name;
6832/// const struct _protocol_list_t * protocol_list; // super protocols
6833/// const struct method_list_t * const instance_methods;
6834/// const struct method_list_t * const class_methods;
6835/// const struct method_list_t *optionalInstanceMethods;
6836/// const struct method_list_t *optionalClassMethods;
6837/// const struct _prop_list_t * properties;
6838/// const uint32_t size; // sizeof(struct _protocol_t)
6839/// const uint32_t flags; // = 0
Bob Wilson5f4e3a72011-11-30 01:57:58 +00006840/// const char ** extendedMethodTypes;
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006841/// const char *demangledName;
Manman Rence7bff52016-01-29 23:46:55 +00006842/// const struct _prop_list_t * class_properties;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006843/// }
6844/// @endcode
6845///
6846
6847llvm::Constant *CGObjCNonFragileABIMac::GetOrEmitProtocol(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006848 const ObjCProtocolDecl *PD) {
John McCallf9582a72012-03-30 21:29:05 +00006849 llvm::GlobalVariable *Entry = Protocols[PD->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006850
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006851 // Early exit if a defining object has already been generated.
6852 if (Entry && Entry->hasInitializer())
6853 return Entry;
6854
Douglas Gregora715bff2012-01-01 19:51:50 +00006855 // Use the protocol definition, if there is one.
Alex Lorenzb111da12018-08-17 22:18:08 +00006856 assert(PD->hasDefinition() &&
6857 "emitting protocol metadata without definition");
6858 PD = PD->getDefinition();
Fangrui Song6907ce22018-07-30 19:24:48 +00006859
John McCall176f8922016-11-30 02:39:18 +00006860 auto methodLists = ProtocolMethodLists::get(PD);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006861
John McCall176f8922016-11-30 02:39:18 +00006862 ConstantInitBuilder builder(CGM);
6863 auto values = builder.beginStruct(ObjCTypes.ProtocolnfABITy);
Douglas Gregora9d84932011-05-27 01:19:52 +00006864
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006865 // isa is NULL
John McCall176f8922016-11-30 02:39:18 +00006866 values.addNullPointer(ObjCTypes.ObjectPtrTy);
6867 values.add(GetClassName(PD->getObjCRuntimeNameAsString()));
6868 values.add(EmitProtocolList("\01l_OBJC_$_PROTOCOL_REFS_"
6869 + PD->getObjCRuntimeNameAsString(),
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006870 PD->protocol_begin(),
John McCall176f8922016-11-30 02:39:18 +00006871 PD->protocol_end()));
6872 values.add(methodLists.emitMethodList(this, PD,
6873 ProtocolMethodLists::RequiredInstanceMethods));
6874 values.add(methodLists.emitMethodList(this, PD,
6875 ProtocolMethodLists::RequiredClassMethods));
6876 values.add(methodLists.emitMethodList(this, PD,
6877 ProtocolMethodLists::OptionalInstanceMethods));
6878 values.add(methodLists.emitMethodList(this, PD,
6879 ProtocolMethodLists::OptionalClassMethods));
6880 values.add(EmitPropertyList(
6881 "\01l_OBJC_$_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
6882 nullptr, PD, ObjCTypes, false));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006883 uint32_t Size =
Micah Villmowdd31ca12012-10-08 16:25:52 +00006884 CGM.getDataLayout().getTypeAllocSize(ObjCTypes.ProtocolnfABITy);
John McCall176f8922016-11-30 02:39:18 +00006885 values.addInt(ObjCTypes.IntTy, Size);
6886 values.addInt(ObjCTypes.IntTy, 0);
6887 values.add(EmitProtocolMethodTypes("\01l_OBJC_$_PROTOCOL_METHOD_TYPES_"
Fariborz Jahanian451b92a2014-07-16 16:16:04 +00006888 + PD->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006889 methodLists.emitExtendedTypesArray(this),
6890 ObjCTypes));
6891
Fariborz Jahanian6a9c46b2015-03-31 22:22:40 +00006892 // const char *demangledName;
John McCall176f8922016-11-30 02:39:18 +00006893 values.addNullPointer(ObjCTypes.Int8PtrTy);
Manman Rence7bff52016-01-29 23:46:55 +00006894
John McCall176f8922016-11-30 02:39:18 +00006895 values.add(EmitPropertyList(
Manman Rence7bff52016-01-29 23:46:55 +00006896 "\01l_OBJC_$_CLASS_PROP_LIST_" + PD->getObjCRuntimeNameAsString(),
John McCall176f8922016-11-30 02:39:18 +00006897 nullptr, PD, ObjCTypes, true));
Fangrui Song6907ce22018-07-30 19:24:48 +00006898
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006899 if (Entry) {
Rafael Espindola24615092014-09-12 20:14:20 +00006900 // Already created, fix the linkage and update the initializer.
6901 Entry->setLinkage(llvm::GlobalValue::WeakAnyLinkage);
John McCall176f8922016-11-30 02:39:18 +00006902 values.finishAndSetAsInitializer(Entry);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006903 } else {
John McCall176f8922016-11-30 02:39:18 +00006904 llvm::SmallString<64> symbolName;
6905 llvm::raw_svector_ostream(symbolName)
6906 << "\01l_OBJC_PROTOCOL_$_" << PD->getObjCRuntimeNameAsString();
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006907
John McCall176f8922016-11-30 02:39:18 +00006908 Entry = values.finishAndCreateGlobal(symbolName, CGM.getPointerAlign(),
6909 /*constant*/ false,
6910 llvm::GlobalValue::WeakAnyLinkage);
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006911 if (!CGM.getTriple().isOSBinFormatMachO())
John McCall176f8922016-11-30 02:39:18 +00006912 Entry->setComdat(CGM.getModule().getOrInsertComdat(symbolName));
John McCallf9582a72012-03-30 21:29:05 +00006913
6914 Protocols[PD->getIdentifier()] = Entry;
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006915 }
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006916 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasoolbe2b5cb2018-01-23 19:35:51 +00006917 CGM.addUsedGlobal(Entry);
Chris Lattnerf56501c2009-07-17 23:57:13 +00006918
Fariborz Jahanian61cd4b52009-01-29 20:10:59 +00006919 // Use this protocol meta-data to build protocol list table in section
6920 // __DATA, __objc_protolist
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006921 llvm::SmallString<64> ProtocolRef;
6922 llvm::raw_svector_ostream(ProtocolRef) << "\01l_OBJC_LABEL_PROTOCOL_$_"
6923 << PD->getObjCRuntimeNameAsString();
6924
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006925 llvm::GlobalVariable *PTGV =
6926 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ProtocolnfABIPtrTy,
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006927 false, llvm::GlobalValue::WeakAnyLinkage, Entry,
Saleem Abdulrasool9ccc7ad2016-10-25 14:50:44 +00006928 ProtocolRef);
6929 if (!CGM.getTriple().isOSBinFormatMachO())
6930 PTGV->setComdat(CGM.getModule().getOrInsertComdat(ProtocolRef));
Fariborz Jahanianc22f2362009-01-31 02:43:27 +00006931 PTGV->setAlignment(
Micah Villmowdd31ca12012-10-08 16:25:52 +00006932 CGM.getDataLayout().getABITypeAlignment(ObjCTypes.ProtocolnfABIPtrTy));
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00006933 PTGV->setSection(GetSectionName("__objc_protolist",
6934 "coalesced,no_dead_strip"));
Rafael Espindola70efc5b2014-03-06 18:54:12 +00006935 PTGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasoolbe2b5cb2018-01-23 19:35:51 +00006936 CGM.addUsedGlobal(PTGV);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006937 return Entry;
6938}
6939
6940/// EmitProtocolList - Generate protocol list meta-data:
6941/// @code
6942/// struct _protocol_list_t {
6943/// long protocol_count; // Note, this is 32/64 bit
6944/// struct _protocol_t[protocol_count];
6945/// }
6946/// @endcode
6947///
Zachary Turner41a9ee92017-10-11 23:54:34 +00006948llvm::Constant *
6949CGObjCNonFragileABIMac::EmitProtocolList(Twine Name,
6950 ObjCProtocolDecl::protocol_iterator begin,
6951 ObjCProtocolDecl::protocol_iterator end) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00006952 SmallVector<llvm::Constant *, 16> ProtocolRefs;
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006953
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006954 // Just return null for empty protocol lists
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006955 if (begin == end)
Owen Anderson0b75f232009-07-31 20:28:54 +00006956 return llvm::Constant::getNullValue(ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006957
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006958 // FIXME: We shouldn't need to do this lookup here, should we?
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00006959 SmallString<256> TmpName;
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006960 Name.toVector(TmpName);
6961 llvm::GlobalVariable *GV =
6962 CGM.getModule().getGlobalVariable(TmpName.str(), true);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006963 if (GV)
Daniel Dunbar349e6fb2009-10-18 20:48:59 +00006964 return llvm::ConstantExpr::getBitCast(GV, ObjCTypes.ProtocolListnfABIPtrTy);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006965
John McCall176f8922016-11-30 02:39:18 +00006966 ConstantInitBuilder builder(CGM);
6967 auto values = builder.beginStruct();
6968 auto countSlot = values.addPlaceholder();
6969
6970 // A null-terminated array of protocols.
6971 auto array = values.beginArray(ObjCTypes.ProtocolnfABIPtrTy);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006972 for (; begin != end; ++begin)
John McCall176f8922016-11-30 02:39:18 +00006973 array.add(GetProtocolRef(*begin)); // Implemented???
6974 auto count = array.size();
6975 array.addNullPointer(ObjCTypes.ProtocolnfABIPtrTy);
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006976
John McCall176f8922016-11-30 02:39:18 +00006977 array.finishAndAddTo(values);
6978 values.fillPlaceholderWithInt(countSlot, ObjCTypes.LongTy, count);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006979
John McCall176f8922016-11-30 02:39:18 +00006980 GV = values.finishAndCreateGlobal(Name, CGM.getPointerAlign(),
6981 /*constant*/ false,
6982 llvm::GlobalValue::PrivateLinkage);
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00006983 if (CGM.getTriple().isOSBinFormatMachO())
6984 GV->setSection("__DATA, __objc_const");
Rafael Espindola060062a2014-03-06 22:15:10 +00006985 CGM.addCompilerUsedGlobal(GV);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006986 return llvm::ConstantExpr::getBitCast(GV,
Daniel Dunbar8de90f02009-02-15 07:36:20 +00006987 ObjCTypes.ProtocolListnfABIPtrTy);
Fariborz Jahanian56b3b772009-01-29 19:24:30 +00006988}
6989
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00006990/// EmitObjCValueForIvar - Code Gen for nonfragile ivar reference.
6991/// This code gen. amounts to generating code for:
6992/// @code
6993/// (type *)((char *)base + _OBJC_IVAR_$_.ivar;
6994/// @encode
Daniel Dunbar59e476b2009-08-03 17:06:42 +00006995///
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00006996LValue CGObjCNonFragileABIMac::EmitObjCValueForIvar(
John McCall96fa4842010-05-17 21:00:27 +00006997 CodeGen::CodeGenFunction &CGF,
6998 QualType ObjectTy,
6999 llvm::Value *BaseValue,
7000 const ObjCIvarDecl *Ivar,
7001 unsigned CVRQualifiers) {
7002 ObjCInterfaceDecl *ID = ObjectTy->getAs<ObjCObjectType>()->getInterface();
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00007003 llvm::Value *Offset = EmitIvarOffset(CGF, ID, Ivar);
Daniel Dunbar9fd114d2009-04-22 07:32:20 +00007004 return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
Fariborz Jahaniancaabf1b2012-02-20 22:42:22 +00007005 Offset);
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00007006}
7007
Erik Pilkington2ff012d2019-01-17 18:18:53 +00007008llvm::Value *
7009CGObjCNonFragileABIMac::EmitIvarOffset(CodeGen::CodeGenFunction &CGF,
7010 const ObjCInterfaceDecl *Interface,
7011 const ObjCIvarDecl *Ivar) {
7012 llvm::Value *IvarOffsetValue;
7013 if (isClassLayoutKnownStatically(Interface)) {
7014 IvarOffsetValue = llvm::ConstantInt::get(
7015 ObjCTypes.IvarOffsetVarTy,
7016 ComputeIvarBaseOffset(CGM, Interface->getImplementation(), Ivar));
7017 } else {
7018 llvm::GlobalVariable *GV = ObjCIvarOffsetVariable(Interface, Ivar);
7019 IvarOffsetValue =
7020 CGF.Builder.CreateAlignedLoad(GV, CGF.getSizeAlign(), "ivar");
7021 if (IsIvarOffsetKnownIdempotent(CGF, Ivar))
7022 cast<llvm::LoadInst>(IvarOffsetValue)
7023 ->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
7024 llvm::MDNode::get(VMContext, None));
7025 }
Tim Northover238b5082014-03-29 13:42:40 +00007026
7027 // This could be 32bit int or 64bit integer depending on the architecture.
7028 // Cast it to 64bit integer value, if it is a 32bit integer ivar offset value
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00007029 // as this is what caller always expects.
Tim Northover238b5082014-03-29 13:42:40 +00007030 if (ObjCTypes.IvarOffsetVarTy == ObjCTypes.IntTy)
7031 IvarOffsetValue = CGF.Builder.CreateIntCast(
7032 IvarOffsetValue, ObjCTypes.LongTy, true, "ivar.conv");
7033 return IvarOffsetValue;
Fariborz Jahanian21fc74c2009-02-10 19:02:04 +00007034}
7035
John McCall234eac82011-05-13 23:16:18 +00007036static void appendSelectorForMessageRefTable(std::string &buffer,
7037 Selector selector) {
7038 if (selector.isUnarySelector()) {
7039 buffer += selector.getNameForSlot(0);
7040 return;
7041 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007042
John McCall234eac82011-05-13 23:16:18 +00007043 for (unsigned i = 0, e = selector.getNumArgs(); i != e; ++i) {
7044 buffer += selector.getNameForSlot(i);
7045 buffer += '_';
7046 }
7047}
7048
Eric Christopherd160c502016-01-29 01:35:53 +00007049/// Emit a "vtable" message send. We emit a weak hidden-visibility
John McCall9e8bb002011-05-14 03:10:52 +00007050/// struct, initially containing the selector pointer and a pointer to
7051/// a "fixup" variant of the appropriate objc_msgSend. To call, we
7052/// load and call the function pointer, passing the address of the
7053/// struct as the second parameter. The runtime determines whether
7054/// the selector is currently emitted using vtable dispatch; if so, it
7055/// substitutes a stub function which simply tail-calls through the
7056/// appropriate vtable slot, and if not, it substitues a stub function
7057/// which tail-calls objc_msgSend. Both stubs adjust the selector
7058/// argument to correctly point to the selector.
7059RValue
7060CGObjCNonFragileABIMac::EmitVTableMessageSend(CodeGenFunction &CGF,
7061 ReturnValueSlot returnSlot,
7062 QualType resultType,
7063 Selector selector,
7064 llvm::Value *arg0,
7065 QualType arg0Type,
7066 bool isSuper,
7067 const CallArgList &formalArgs,
7068 const ObjCMethodDecl *method) {
John McCall234eac82011-05-13 23:16:18 +00007069 // Compute the actual arguments.
7070 CallArgList args;
7071
John McCall9e8bb002011-05-14 03:10:52 +00007072 // First argument: the receiver / super-call structure.
John McCall234eac82011-05-13 23:16:18 +00007073 if (!isSuper)
John McCall9e8bb002011-05-14 03:10:52 +00007074 arg0 = CGF.Builder.CreateBitCast(arg0, ObjCTypes.ObjectPtrTy);
7075 args.add(RValue::get(arg0), arg0Type);
John McCall234eac82011-05-13 23:16:18 +00007076
John McCall9e8bb002011-05-14 03:10:52 +00007077 // Second argument: a pointer to the message ref structure. Leave
7078 // the actual argument value blank for now.
Craig Topper8a13c412014-05-21 05:09:00 +00007079 args.add(RValue::get(nullptr), ObjCTypes.MessageRefCPtrTy);
John McCall234eac82011-05-13 23:16:18 +00007080
7081 args.insert(args.end(), formalArgs.begin(), formalArgs.end());
7082
John McCalla729c622012-02-17 03:33:10 +00007083 MessageSendInfo MSI = getMessageSendInfo(method, resultType, args);
John McCall234eac82011-05-13 23:16:18 +00007084
John McCall5880fb82011-05-14 21:12:11 +00007085 NullReturnState nullReturn;
7086
John McCall9e8bb002011-05-14 03:10:52 +00007087 // Find the function to call and the mangled name for the message
7088 // ref structure. Using a different mangled name wouldn't actually
7089 // be a problem; it would just be a waste.
7090 //
7091 // The runtime currently never uses vtable dispatch for anything
7092 // except normal, non-super message-sends.
7093 // FIXME: don't use this for that.
James Y Knight9871db02019-02-05 16:42:33 +00007094 llvm::FunctionCallee fn = nullptr;
John McCall234eac82011-05-13 23:16:18 +00007095 std::string messageRefName("\01l_");
Tim Northovere77cc392014-03-29 13:28:05 +00007096 if (CGM.ReturnSlotInterferesWithArgs(MSI.CallInfo)) {
John McCall234eac82011-05-13 23:16:18 +00007097 if (isSuper) {
7098 fn = ObjCTypes.getMessageSendSuper2StretFixupFn();
7099 messageRefName += "objc_msgSendSuper2_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007100 } else {
John McCall5880fb82011-05-14 21:12:11 +00007101 nullReturn.init(CGF, arg0);
John McCall234eac82011-05-13 23:16:18 +00007102 fn = ObjCTypes.getMessageSendStretFixupFn();
7103 messageRefName += "objc_msgSend_stret_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007104 }
John McCall234eac82011-05-13 23:16:18 +00007105 } else if (!isSuper && CGM.ReturnTypeUsesFPRet(resultType)) {
7106 fn = ObjCTypes.getMessageSendFpretFixupFn();
7107 messageRefName += "objc_msgSend_fpret_fixup";
Mike Stump658fe022009-07-30 22:28:39 +00007108 } else {
John McCall234eac82011-05-13 23:16:18 +00007109 if (isSuper) {
7110 fn = ObjCTypes.getMessageSendSuper2FixupFn();
7111 messageRefName += "objc_msgSendSuper2_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007112 } else {
John McCall234eac82011-05-13 23:16:18 +00007113 fn = ObjCTypes.getMessageSendFixupFn();
7114 messageRefName += "objc_msgSend_fixup";
Chris Lattner396639d2010-08-18 16:09:06 +00007115 }
Fariborz Jahaniane4dc35d2009-02-04 20:42:28 +00007116 }
John McCall234eac82011-05-13 23:16:18 +00007117 assert(fn && "CGObjCNonFragileABIMac::EmitMessageSend");
7118 messageRefName += '_';
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007119
John McCall234eac82011-05-13 23:16:18 +00007120 // Append the selector name, except use underscores anywhere we
7121 // would have used colons.
7122 appendSelectorForMessageRefTable(messageRefName, selector);
7123
7124 llvm::GlobalVariable *messageRef
7125 = CGM.getModule().getGlobalVariable(messageRefName);
7126 if (!messageRef) {
John McCall9e8bb002011-05-14 03:10:52 +00007127 // Build the message ref structure.
John McCall176f8922016-11-30 02:39:18 +00007128 ConstantInitBuilder builder(CGM);
7129 auto values = builder.beginStruct();
James Y Knight9871db02019-02-05 16:42:33 +00007130 values.add(cast<llvm::Constant>(fn.getCallee()));
John McCall176f8922016-11-30 02:39:18 +00007131 values.add(GetMethodVarName(selector));
7132 messageRef = values.finishAndCreateGlobal(messageRefName,
7133 CharUnits::fromQuantity(16),
7134 /*constant*/ false,
7135 llvm::GlobalValue::WeakAnyLinkage);
Rafael Espindola70efc5b2014-03-06 18:54:12 +00007136 messageRef->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007137 messageRef->setSection(GetSectionName("__objc_msgrefs", "coalesced"));
John McCall234eac82011-05-13 23:16:18 +00007138 }
Fangrui Song6907ce22018-07-30 19:24:48 +00007139
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00007140 bool requiresnullCheck = false;
David Blaikiebbafb8a2012-03-11 07:00:24 +00007141 if (CGM.getLangOpts().ObjCAutoRefCount && method)
David Majnemer59f77922016-06-24 04:05:48 +00007142 for (const auto *ParamDecl : method->parameters()) {
Fariborz Jahanianc93fa982012-01-30 23:39:30 +00007143 if (ParamDecl->hasAttr<NSConsumedAttr>()) {
7144 if (!nullReturn.NullBB)
7145 nullReturn.init(CGF, arg0);
7146 requiresnullCheck = true;
7147 break;
7148 }
7149 }
Fangrui Song6907ce22018-07-30 19:24:48 +00007150
John McCall7f416cc2015-09-08 08:05:57 +00007151 Address mref =
7152 Address(CGF.Builder.CreateBitCast(messageRef, ObjCTypes.MessageRefPtrTy),
7153 CGF.getPointerAlign());
John McCall234eac82011-05-13 23:16:18 +00007154
John McCall9e8bb002011-05-14 03:10:52 +00007155 // Update the message ref argument.
Yaxun Liu5b330e82018-03-15 15:25:19 +00007156 args[1].setRValue(RValue::get(mref.getPointer()));
John McCall234eac82011-05-13 23:16:18 +00007157
7158 // Load the function to call from the message ref table.
John McCall7f416cc2015-09-08 08:05:57 +00007159 Address calleeAddr =
7160 CGF.Builder.CreateStructGEP(mref, 0, CharUnits::Zero());
John McCallb92ab1a2016-10-26 23:46:34 +00007161 llvm::Value *calleePtr = CGF.Builder.CreateLoad(calleeAddr, "msgSend_fn");
John McCall234eac82011-05-13 23:16:18 +00007162
John McCallb92ab1a2016-10-26 23:46:34 +00007163 calleePtr = CGF.Builder.CreateBitCast(calleePtr, MSI.MessengerType);
7164 CGCallee callee(CGCalleeInfo(), calleePtr);
John McCall234eac82011-05-13 23:16:18 +00007165
John McCalla729c622012-02-17 03:33:10 +00007166 RValue result = CGF.EmitCall(MSI.CallInfo, callee, returnSlot, args);
Kuba Mracekbce5cea2017-06-30 16:28:15 +00007167 return nullReturn.complete(CGF, returnSlot, result, resultType, formalArgs,
Craig Topper8a13c412014-05-21 05:09:00 +00007168 requiresnullCheck ? method : nullptr);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00007169}
7170
7171/// Generate code for a message send expression in the nonfragile abi.
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007172CodeGen::RValue
7173CGObjCNonFragileABIMac::GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00007174 ReturnValueSlot Return,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007175 QualType ResultType,
7176 Selector Sel,
7177 llvm::Value *Receiver,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007178 const CallArgList &CallArgs,
David Chisnall01aa4672010-04-28 19:33:36 +00007179 const ObjCInterfaceDecl *Class,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007180 const ObjCMethodDecl *Method) {
John McCall9e8bb002011-05-14 03:10:52 +00007181 return isVTableDispatchedSelector(Sel)
7182 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007183 Receiver, CGF.getContext().getObjCIdType(),
John McCall9e8bb002011-05-14 03:10:52 +00007184 false, CallArgs, Method)
7185 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00007186 EmitSelector(CGF, Sel),
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007187 Receiver, CGF.getContext().getObjCIdType(),
John McCall1e3157b2015-09-10 22:27:50 +00007188 false, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian3d9296e2009-02-04 00:22:57 +00007189}
7190
John McCalldba63a72016-11-30 23:54:50 +00007191llvm::Constant *
7192CGObjCNonFragileABIMac::GetClassGlobal(const ObjCInterfaceDecl *ID,
7193 bool metaclass,
7194 ForDefinition_t isForDefinition) {
7195 auto prefix =
7196 (metaclass ? getMetaclassSymbolPrefix() : getClassSymbolPrefix());
7197 return GetClassGlobal((prefix + ID->getObjCRuntimeNameAsString()).str(),
7198 isForDefinition,
7199 ID->isWeakImported(),
7200 !isForDefinition
7201 && CGM.getTriple().isOSBinFormatCOFF()
7202 && ID->hasAttr<DLLImportAttr>());
7203}
7204
7205llvm::Constant *
7206CGObjCNonFragileABIMac::GetClassGlobal(StringRef Name,
7207 ForDefinition_t IsForDefinition,
7208 bool Weak, bool DLLImport) {
Rafael Espindola554256c2014-02-26 22:25:45 +00007209 llvm::GlobalValue::LinkageTypes L =
7210 Weak ? llvm::GlobalValue::ExternalWeakLinkage
7211 : llvm::GlobalValue::ExternalLinkage;
7212
John McCalldba63a72016-11-30 23:54:50 +00007213 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Erik Pilkington92d8a292018-10-12 17:22:10 +00007214 if (!GV || GV->getType() != ObjCTypes.ClassnfABITy->getPointerTo()) {
7215 auto *NewGV = new llvm::GlobalVariable(ObjCTypes.ClassnfABITy, false, L,
7216 nullptr, Name);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00007217
John McCalldba63a72016-11-30 23:54:50 +00007218 if (DLLImport)
Erik Pilkington92d8a292018-10-12 17:22:10 +00007219 NewGV->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
7220
7221 if (GV) {
7222 GV->replaceAllUsesWith(
7223 llvm::ConstantExpr::getBitCast(NewGV, GV->getType()));
7224 GV->eraseFromParent();
7225 }
7226 GV = NewGV;
7227 CGM.getModule().getGlobalList().push_back(GV);
John McCalldba63a72016-11-30 23:54:50 +00007228 }
7229
Rafael Espindola554256c2014-02-26 22:25:45 +00007230 assert(GV->getLinkage() == L);
Daniel Dunbarc6928bb2009-03-01 04:40:10 +00007231 return GV;
7232}
7233
John McCalldba63a72016-11-30 23:54:50 +00007234llvm::Value *
7235CGObjCNonFragileABIMac::EmitClassRefFromId(CodeGenFunction &CGF,
7236 IdentifierInfo *II,
7237 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00007238 CharUnits Align = CGF.getPointerAlign();
John McCall31168b02011-06-15 23:02:42 +00007239 llvm::GlobalVariable *&Entry = ClassReferences[II];
Fangrui Song6907ce22018-07-30 19:24:48 +00007240
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007241 if (!Entry) {
John McCalldba63a72016-11-30 23:54:50 +00007242 llvm::Constant *ClassGV;
7243 if (ID) {
7244 ClassGV = GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition);
7245 } else {
7246 ClassGV = GetClassGlobal((getClassSymbolPrefix() + II->getName()).str(),
7247 NotForDefinition);
7248 }
7249
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007250 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
7251 false, llvm::GlobalValue::PrivateLinkage,
7252 ClassGV, "OBJC_CLASSLIST_REFERENCES_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007253 Entry->setAlignment(Align.getQuantity());
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007254 Entry->setSection(GetSectionName("__objc_classrefs",
7255 "regular,no_dead_strip"));
Rafael Espindola060062a2014-03-06 22:15:10 +00007256 CGM.addCompilerUsedGlobal(Entry);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007257 }
John McCall7f416cc2015-09-08 08:05:57 +00007258 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007259}
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007260
John McCall882987f2013-02-28 19:01:20 +00007261llvm::Value *CGObjCNonFragileABIMac::EmitClassRef(CodeGenFunction &CGF,
John McCall31168b02011-06-15 23:02:42 +00007262 const ObjCInterfaceDecl *ID) {
Douglas Gregor24ae22c2016-04-01 23:23:52 +00007263 // If the class has the objc_runtime_visible attribute, we need to
7264 // use the Objective-C runtime to get the class.
7265 if (ID->hasAttr<ObjCRuntimeVisibleAttr>())
7266 return EmitClassRefViaRuntime(CGF, ID, ObjCTypes);
7267
John McCalldba63a72016-11-30 23:54:50 +00007268 return EmitClassRefFromId(CGF, ID->getIdentifier(), ID);
John McCall31168b02011-06-15 23:02:42 +00007269}
7270
7271llvm::Value *CGObjCNonFragileABIMac::EmitNSAutoreleasePoolClassRef(
John McCall882987f2013-02-28 19:01:20 +00007272 CodeGenFunction &CGF) {
John McCall31168b02011-06-15 23:02:42 +00007273 IdentifierInfo *II = &CGM.getContext().Idents.get("NSAutoreleasePool");
John McCalldba63a72016-11-30 23:54:50 +00007274 return EmitClassRefFromId(CGF, II, nullptr);
John McCall31168b02011-06-15 23:02:42 +00007275}
7276
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007277llvm::Value *
John McCall882987f2013-02-28 19:01:20 +00007278CGObjCNonFragileABIMac::EmitSuperClassRef(CodeGenFunction &CGF,
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007279 const ObjCInterfaceDecl *ID) {
John McCall7f416cc2015-09-08 08:05:57 +00007280 CharUnits Align = CGF.getPointerAlign();
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007281 llvm::GlobalVariable *&Entry = SuperClassReferences[ID->getIdentifier()];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007282
Daniel Dunbar508a7dd2009-04-18 08:51:00 +00007283 if (!Entry) {
John McCalldba63a72016-11-30 23:54:50 +00007284 auto ClassGV = GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007285 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
7286 false, llvm::GlobalValue::PrivateLinkage,
7287 ClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007288 Entry->setAlignment(Align.getQuantity());
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007289 Entry->setSection(GetSectionName("__objc_superrefs",
7290 "regular,no_dead_strip"));
Rafael Espindola060062a2014-03-06 22:15:10 +00007291 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007292 }
John McCall7f416cc2015-09-08 08:05:57 +00007293 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007294}
7295
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007296/// EmitMetaClassRef - Return a Value * of the address of _class_t
7297/// meta-data
7298///
John McCall882987f2013-02-28 19:01:20 +00007299llvm::Value *CGObjCNonFragileABIMac::EmitMetaClassRef(CodeGenFunction &CGF,
Fariborz Jahanian0b3bc242014-06-10 17:08:04 +00007300 const ObjCInterfaceDecl *ID,
7301 bool Weak) {
John McCall7f416cc2015-09-08 08:05:57 +00007302 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007303 llvm::GlobalVariable * &Entry = MetaClassReferences[ID->getIdentifier()];
Rafael Espindola21039aa2014-02-27 16:26:32 +00007304 if (!Entry) {
John McCalldba63a72016-11-30 23:54:50 +00007305 auto MetaClassGV = GetClassGlobal(ID, /*metaclass*/ true, NotForDefinition);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007306
Rafael Espindola21039aa2014-02-27 16:26:32 +00007307 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.ClassnfABIPtrTy,
Rafael Espindola5179a4e2014-02-27 19:01:11 +00007308 false, llvm::GlobalValue::PrivateLinkage,
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007309 MetaClassGV, "OBJC_CLASSLIST_SUP_REFS_$_");
John McCall7f416cc2015-09-08 08:05:57 +00007310 Entry->setAlignment(Align.getQuantity());
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007311
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007312 Entry->setSection(GetSectionName("__objc_superrefs",
7313 "regular,no_dead_strip"));
Rafael Espindola060062a2014-03-06 22:15:10 +00007314 CGM.addCompilerUsedGlobal(Entry);
Rafael Espindola21039aa2014-02-27 16:26:32 +00007315 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007316
John McCall7f416cc2015-09-08 08:05:57 +00007317 return CGF.Builder.CreateAlignedLoad(Entry, Align);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007318}
7319
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007320/// GetClass - Return a reference to the class for the given interface
7321/// decl.
John McCall882987f2013-02-28 19:01:20 +00007322llvm::Value *CGObjCNonFragileABIMac::GetClass(CodeGenFunction &CGF,
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007323 const ObjCInterfaceDecl *ID) {
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00007324 if (ID->isWeakImported()) {
John McCalldba63a72016-11-30 23:54:50 +00007325 auto ClassGV = GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition);
Nick Lewycky9a441642014-02-27 00:36:00 +00007326 (void)ClassGV;
John McCalldba63a72016-11-30 23:54:50 +00007327 assert(!isa<llvm::GlobalVariable>(ClassGV) ||
7328 cast<llvm::GlobalVariable>(ClassGV)->hasExternalWeakLinkage());
Fariborz Jahanian95ace552009-11-17 22:42:00 +00007329 }
Fangrui Song6907ce22018-07-30 19:24:48 +00007330
John McCall882987f2013-02-28 19:01:20 +00007331 return EmitClassRef(CGF, ID);
Fariborz Jahanian33f66e62009-02-05 20:41:40 +00007332}
7333
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007334/// Generates a message send where the super is the receiver. This is
7335/// a message send to self with special delivery semantics indicating
7336/// which class's method should be called.
7337CodeGen::RValue
7338CGObjCNonFragileABIMac::GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
John McCall78a15112010-05-22 01:48:05 +00007339 ReturnValueSlot Return,
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007340 QualType ResultType,
7341 Selector Sel,
7342 const ObjCInterfaceDecl *Class,
7343 bool isCategoryImpl,
7344 llvm::Value *Receiver,
7345 bool IsClassMessage,
Daniel Dunbaraff9fca2009-09-17 04:01:22 +00007346 const CodeGen::CallArgList &CallArgs,
7347 const ObjCMethodDecl *Method) {
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007348 // ...
7349 // Create and init a super structure; this is a (receiver, class)
7350 // pair we will pass to objc_msgSendSuper.
John McCall7f416cc2015-09-08 08:05:57 +00007351 Address ObjCSuper =
7352 CGF.CreateTempAlloca(ObjCTypes.SuperTy, CGF.getPointerAlign(),
7353 "objc_super");
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007354
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007355 llvm::Value *ReceiverAsObject =
7356 CGF.Builder.CreateBitCast(Receiver, ObjCTypes.ObjectPtrTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007357 CGF.Builder.CreateStore(
7358 ReceiverAsObject,
John McCall7f416cc2015-09-08 08:05:57 +00007359 CGF.Builder.CreateStructGEP(ObjCSuper, 0, CharUnits::Zero()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007360
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007361 // If this is a class message the metaclass is passed as the target.
Fariborz Jahanianbac73ac2009-02-28 20:07:56 +00007362 llvm::Value *Target;
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007363 if (IsClassMessage)
Fariborz Jahanian85b99da2014-08-28 17:05:17 +00007364 Target = EmitMetaClassRef(CGF, Class, Class->isWeakImported());
Fariborz Jahanian27678b02012-10-10 23:11:18 +00007365 else
John McCall882987f2013-02-28 19:01:20 +00007366 Target = EmitSuperClassRef(CGF, Class);
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007367
Mike Stump18bb9282009-05-16 07:57:57 +00007368 // FIXME: We shouldn't need to do this cast, rectify the ASTContext and
7369 // ObjCTypes types.
Chris Lattner2192fe52011-07-18 04:24:23 +00007370 llvm::Type *ClassTy =
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007371 CGM.getTypes().ConvertType(CGF.getContext().getObjCClassType());
7372 Target = CGF.Builder.CreateBitCast(Target, ClassTy);
David Blaikie1ed728c2015-04-05 22:45:47 +00007373 CGF.Builder.CreateStore(
John McCall7f416cc2015-09-08 08:05:57 +00007374 Target, CGF.Builder.CreateStructGEP(ObjCSuper, 1, CGF.getPointerSize()));
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007375
John McCall9e8bb002011-05-14 03:10:52 +00007376 return (isVTableDispatchedSelector(Sel))
7377 ? EmitVTableMessageSend(CGF, Return, ResultType, Sel,
John McCall7f416cc2015-09-08 08:05:57 +00007378 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall9e8bb002011-05-14 03:10:52 +00007379 true, CallArgs, Method)
7380 : EmitMessageSend(CGF, Return, ResultType,
John McCall882987f2013-02-28 19:01:20 +00007381 EmitSelector(CGF, Sel),
John McCall7f416cc2015-09-08 08:05:57 +00007382 ObjCSuper.getPointer(), ObjCTypes.SuperPtrCTy,
John McCall1e3157b2015-09-10 22:27:50 +00007383 true, CallArgs, Method, Class, ObjCTypes);
Fariborz Jahanian6b7cd6e2009-02-06 20:09:23 +00007384}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007385
John McCall882987f2013-02-28 19:01:20 +00007386llvm::Value *CGObjCNonFragileABIMac::EmitSelector(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007387 Selector Sel) {
7388 Address Addr = EmitSelectorAddr(CGF, Sel);
7389
7390 llvm::LoadInst* LI = CGF.Builder.CreateLoad(Addr);
Fangrui Song6907ce22018-07-30 19:24:48 +00007391 LI->setMetadata(CGM.getModule().getMDKindID("invariant.load"),
John McCall7f416cc2015-09-08 08:05:57 +00007392 llvm::MDNode::get(VMContext, None));
7393 return LI;
7394}
7395
7396Address CGObjCNonFragileABIMac::EmitSelectorAddr(CodeGenFunction &CGF,
7397 Selector Sel) {
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007398 llvm::GlobalVariable *&Entry = SelectorReferences[Sel];
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007399
John McCall7f416cc2015-09-08 08:05:57 +00007400 CharUnits Align = CGF.getPointerAlign();
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007401 if (!Entry) {
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007402 llvm::Constant *Casted =
7403 llvm::ConstantExpr::getBitCast(GetMethodVarName(Sel),
7404 ObjCTypes.SelectorPtrTy);
Rafael Espindola8b27bdb2014-11-06 13:30:38 +00007405 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.SelectorPtrTy,
7406 false, llvm::GlobalValue::PrivateLinkage,
7407 Casted, "OBJC_SELECTOR_REFERENCES_");
Michael Gottesman5c205962013-02-05 23:08:45 +00007408 Entry->setExternallyInitialized(true);
Saleem Abdulrasool13d73d52017-06-03 16:18:09 +00007409 Entry->setSection(GetSectionName("__objc_selrefs",
7410 "literal_pointers,no_dead_strip"));
John McCall7f416cc2015-09-08 08:05:57 +00007411 Entry->setAlignment(Align.getQuantity());
Rafael Espindola060062a2014-03-06 22:15:10 +00007412 CGM.addCompilerUsedGlobal(Entry);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007413 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007414
John McCall7f416cc2015-09-08 08:05:57 +00007415 return Address(Entry, Align);
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007416}
John McCall7f416cc2015-09-08 08:05:57 +00007417
Fariborz Jahanian06292952009-02-16 22:52:32 +00007418/// EmitObjCIvarAssign - Code gen for assigning to a __strong object.
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007419/// objc_assign_ivar (id src, id *dst, ptrdiff_t)
Fariborz Jahanian06292952009-02-16 22:52:32 +00007420///
7421void CGObjCNonFragileABIMac::EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
Mike Stump11289f42009-09-09 15:08:12 +00007422 llvm::Value *src,
John McCall7f416cc2015-09-08 08:05:57 +00007423 Address dst,
Fariborz Jahanian7a95d722009-09-24 22:25:38 +00007424 llvm::Value *ivarOffset) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007425 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007426 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007427 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007428 assert(Size <= 8 && "does not support size > 8");
7429 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7430 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007431 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7432 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007433 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7434 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007435 llvm::Value *args[] = { src, dst.getPointer(), ivarOffset };
John McCall882987f2013-02-28 19:01:20 +00007436 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignIvarFn(), args);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007437}
7438
7439/// EmitObjCStrongCastAssign - Code gen for assigning to a __strong cast object.
7440/// objc_assign_strongCast (id src, id *dst)
7441///
7442void CGObjCNonFragileABIMac::EmitObjCStrongCastAssign(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007443 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007444 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007445 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007446 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007447 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007448 assert(Size <= 8 && "does not support size > 8");
7449 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007450 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007451 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7452 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007453 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7454 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007455 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007456 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignStrongCastFn(),
7457 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007458}
7459
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007460void CGObjCNonFragileABIMac::EmitGCMemmoveCollectable(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007461 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007462 Address DestPtr,
7463 Address SrcPtr,
Fariborz Jahanian021510e2010-06-15 22:44:06 +00007464 llvm::Value *Size) {
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007465 SrcPtr = CGF.Builder.CreateBitCast(SrcPtr, ObjCTypes.Int8PtrTy);
7466 DestPtr = CGF.Builder.CreateBitCast(DestPtr, ObjCTypes.Int8PtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007467 llvm::Value *args[] = { DestPtr.getPointer(), SrcPtr.getPointer(), Size };
John McCall882987f2013-02-28 19:01:20 +00007468 CGF.EmitNounwindRuntimeCall(ObjCTypes.GcMemmoveCollectableFn(), args);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00007469}
7470
Fariborz Jahanian06292952009-02-16 22:52:32 +00007471/// EmitObjCWeakRead - Code gen for loading value of a __weak
7472/// object: objc_read_weak (id *src)
7473///
7474llvm::Value * CGObjCNonFragileABIMac::EmitObjCWeakRead(
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007475 CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007476 Address AddrWeakObj) {
7477 llvm::Type *DestTy = AddrWeakObj.getElementType();
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007478 AddrWeakObj = CGF.Builder.CreateBitCast(AddrWeakObj, ObjCTypes.PtrObjectPtrTy);
John McCall882987f2013-02-28 19:01:20 +00007479 llvm::Value *read_weak =
7480 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcReadWeakFn(),
John McCall7f416cc2015-09-08 08:05:57 +00007481 AddrWeakObj.getPointer(), "weakread");
Eli Friedmana374b682009-03-07 03:57:15 +00007482 read_weak = CGF.Builder.CreateBitCast(read_weak, DestTy);
Fariborz Jahanian06292952009-02-16 22:52:32 +00007483 return read_weak;
7484}
7485
7486/// EmitObjCWeakAssign - Code gen for assigning to a __weak object.
7487/// objc_assign_weak (id src, id *dst)
7488///
7489void CGObjCNonFragileABIMac::EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007490 llvm::Value *src, Address dst) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007491 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007492 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007493 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007494 assert(Size <= 8 && "does not support size > 8");
7495 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7496 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007497 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7498 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007499 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7500 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007501 llvm::Value *args[] = { src, dst.getPointer() };
John McCall882987f2013-02-28 19:01:20 +00007502 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignWeakFn(),
7503 args, "weakassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007504}
7505
7506/// EmitObjCGlobalAssign - Code gen for assigning to a __strong object.
7507/// objc_assign_global (id src, id *dst)
7508///
7509void CGObjCNonFragileABIMac::EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +00007510 llvm::Value *src, Address dst,
Fariborz Jahanian217af242010-07-20 20:30:03 +00007511 bool threadlocal) {
Chris Lattner2192fe52011-07-18 04:24:23 +00007512 llvm::Type * SrcTy = src->getType();
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007513 if (!isa<llvm::PointerType>(SrcTy)) {
Micah Villmowdd31ca12012-10-08 16:25:52 +00007514 unsigned Size = CGM.getDataLayout().getTypeAllocSize(SrcTy);
Fariborz Jahanianaedcfa42009-03-23 19:10:40 +00007515 assert(Size <= 8 && "does not support size > 8");
7516 src = (Size == 4 ? CGF.Builder.CreateBitCast(src, ObjCTypes.IntTy)
7517 : CGF.Builder.CreateBitCast(src, ObjCTypes.LongTy));
Fariborz Jahanian1b074a32009-03-13 00:42:52 +00007518 src = CGF.Builder.CreateIntToPtr(src, ObjCTypes.Int8PtrTy);
7519 }
Fariborz Jahanian06292952009-02-16 22:52:32 +00007520 src = CGF.Builder.CreateBitCast(src, ObjCTypes.ObjectPtrTy);
7521 dst = CGF.Builder.CreateBitCast(dst, ObjCTypes.PtrObjectPtrTy);
John McCall7f416cc2015-09-08 08:05:57 +00007522 llvm::Value *args[] = { src, dst.getPointer() };
Fariborz Jahanian217af242010-07-20 20:30:03 +00007523 if (!threadlocal)
John McCall882987f2013-02-28 19:01:20 +00007524 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignGlobalFn(),
7525 args, "globalassign");
Fariborz Jahanian217af242010-07-20 20:30:03 +00007526 else
John McCall882987f2013-02-28 19:01:20 +00007527 CGF.EmitNounwindRuntimeCall(ObjCTypes.getGcAssignThreadLocalFn(),
7528 args, "threadlocalassign");
Fariborz Jahanian06292952009-02-16 22:52:32 +00007529}
Fariborz Jahanian74b77222009-02-11 20:51:17 +00007530
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007531void
John McCallbd309292010-07-06 01:34:17 +00007532CGObjCNonFragileABIMac::EmitSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
7533 const ObjCAtSynchronizedStmt &S) {
James Y Knight9871db02019-02-05 16:42:33 +00007534 EmitAtSynchronizedStmt(CGF, S, ObjCTypes.getSyncEnterFn(),
7535 ObjCTypes.getSyncExitFn());
John McCallbd309292010-07-06 01:34:17 +00007536}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007537
John McCall2ca705e2010-07-24 00:37:23 +00007538llvm::Constant *
Fariborz Jahanian831f0fc2011-06-23 19:00:08 +00007539CGObjCNonFragileABIMac::GetEHType(QualType T) {
John McCall2ca705e2010-07-24 00:37:23 +00007540 // There's a particular fixed type info for 'id'.
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007541 if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
7542 auto *IDEHType = CGM.getModule().getGlobalVariable("OBJC_EHTYPE_id");
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007543 if (!IDEHType) {
John McCall2ca705e2010-07-24 00:37:23 +00007544 IDEHType =
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007545 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy, false,
7546 llvm::GlobalValue::ExternalLinkage, nullptr,
7547 "OBJC_EHTYPE_id");
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007548 if (CGM.getTriple().isOSBinFormatCOFF())
7549 IDEHType->setDLLStorageClass(getStorage(CGM, "OBJC_EHTYPE_id"));
7550 }
John McCall2ca705e2010-07-24 00:37:23 +00007551 return IDEHType;
7552 }
7553
7554 // All other types should be Objective-C interface pointer types.
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007555 const ObjCObjectPointerType *PT = T->getAs<ObjCObjectPointerType>();
John McCall2ca705e2010-07-24 00:37:23 +00007556 assert(PT && "Invalid @catch type.");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007557
John McCall2ca705e2010-07-24 00:37:23 +00007558 const ObjCInterfaceType *IT = PT->getInterfaceType();
7559 assert(IT && "Invalid @catch type.");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007560
John McCalldba63a72016-11-30 23:54:50 +00007561 return GetInterfaceEHType(IT->getDecl(), NotForDefinition);
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007562}
John McCall2ca705e2010-07-24 00:37:23 +00007563
John McCallbd309292010-07-06 01:34:17 +00007564void CGObjCNonFragileABIMac::EmitTryStmt(CodeGen::CodeGenFunction &CGF,
7565 const ObjCAtTryStmt &S) {
James Y Knight9871db02019-02-05 16:42:33 +00007566 EmitTryCatchStmt(CGF, S, ObjCTypes.getObjCBeginCatchFn(),
7567 ObjCTypes.getObjCEndCatchFn(),
7568 ObjCTypes.getExceptionRethrowFn());
Daniel Dunbar0b0dcd92009-02-24 07:47:38 +00007569}
7570
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007571/// EmitThrowStmt - Generate code for a throw statement.
7572void CGObjCNonFragileABIMac::EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007573 const ObjCAtThrowStmt &S,
7574 bool ClearInsertionPoint) {
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007575 if (const Expr *ThrowExpr = S.getThrowExpr()) {
John McCall248512a2011-10-01 10:32:24 +00007576 llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
Benjamin Kramer76399eb2011-09-27 21:06:10 +00007577 Exception = CGF.Builder.CreateBitCast(Exception, ObjCTypes.ObjectPtrTy);
James Y Knight3933add2019-01-30 02:54:28 +00007578 llvm::CallBase *Call =
7579 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionThrowFn(), Exception);
7580 Call->setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007581 } else {
James Y Knight3933add2019-01-30 02:54:28 +00007582 llvm::CallBase *Call =
7583 CGF.EmitRuntimeCallOrInvoke(ObjCTypes.getExceptionRethrowFn());
7584 Call->setDoesNotReturn();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007585 }
7586
John McCall17afe452010-10-16 08:21:07 +00007587 CGF.Builder.CreateUnreachable();
Fariborz Jahanian1eab0522013-01-10 19:02:56 +00007588 if (ClearInsertionPoint)
7589 CGF.Builder.ClearInsertionPoint();
Anders Carlsson9ab53d12009-02-16 22:59:18 +00007590}
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007591
John McCall2ca705e2010-07-24 00:37:23 +00007592llvm::Constant *
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007593CGObjCNonFragileABIMac::GetInterfaceEHType(const ObjCInterfaceDecl *ID,
John McCalldba63a72016-11-30 23:54:50 +00007594 ForDefinition_t IsForDefinition) {
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007595 llvm::GlobalVariable * &Entry = EHTypeReferences[ID->getIdentifier()];
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007596 StringRef ClassName = ID->getObjCRuntimeNameAsString();
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007597
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007598 // If we don't need a definition, return the entry if found or check
7599 // if we use an external reference.
John McCalldba63a72016-11-30 23:54:50 +00007600 if (!IsForDefinition) {
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007601 if (Entry)
7602 return Entry;
Daniel Dunbard7beeea2009-04-07 06:43:45 +00007603
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007604 // If this type (or a super class) has the __objc_exception__
7605 // attribute, emit an external reference.
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007606 if (hasObjCExceptionAttribute(CGM.getContext(), ID)) {
7607 std::string EHTypeName = ("OBJC_EHTYPE_$_" + ClassName).str();
7608 Entry = new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.EHTypeTy,
7609 false, llvm::GlobalValue::ExternalLinkage,
7610 nullptr, EHTypeName);
Rafael Espindolab7350042018-03-01 00:35:47 +00007611 CGM.setGVProperties(Entry, ID);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007612 return Entry;
7613 }
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007614 }
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007615
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007616 // Otherwise we need to either make a new entry or fill in the initializer.
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007617 assert((!Entry || !Entry->hasInitializer()) && "Duplicate EHType definition");
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007618
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007619 std::string VTableName = "objc_ehtype_vtable";
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007620 auto *VTableGV = CGM.getModule().getGlobalVariable(VTableName);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007621 if (!VTableGV) {
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007622 VTableGV =
7623 new llvm::GlobalVariable(CGM.getModule(), ObjCTypes.Int8PtrTy, false,
7624 llvm::GlobalValue::ExternalLinkage, nullptr,
7625 VTableName);
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007626 if (CGM.getTriple().isOSBinFormatCOFF())
7627 VTableGV->setDLLStorageClass(getStorage(CGM, VTableName));
7628 }
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007629
Chris Lattnerece04092012-02-07 00:39:47 +00007630 llvm::Value *VTableIdx = llvm::ConstantInt::get(CGM.Int32Ty, 2);
John McCall176f8922016-11-30 02:39:18 +00007631 ConstantInitBuilder builder(CGM);
7632 auto values = builder.beginStruct(ObjCTypes.EHTypeTy);
Ahmed Bougacha5d0199a2017-11-17 19:46:47 +00007633 values.add(
7634 llvm::ConstantExpr::getInBoundsGetElementPtr(VTableGV->getValueType(),
7635 VTableGV, VTableIdx));
John McCalldba63a72016-11-30 23:54:50 +00007636 values.add(GetClassName(ClassName));
7637 values.add(GetClassGlobal(ID, /*metaclass*/ false, NotForDefinition));
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007638
John McCalldba63a72016-11-30 23:54:50 +00007639 llvm::GlobalValue::LinkageTypes L = IsForDefinition
Rafael Espindola554256c2014-02-26 22:25:45 +00007640 ? llvm::GlobalValue::ExternalLinkage
7641 : llvm::GlobalValue::WeakAnyLinkage;
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007642 if (Entry) {
John McCall176f8922016-11-30 02:39:18 +00007643 values.finishAndSetAsInitializer(Entry);
7644 Entry->setAlignment(CGM.getPointerAlign().getQuantity());
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007645 } else {
John McCall176f8922016-11-30 02:39:18 +00007646 Entry = values.finishAndCreateGlobal("OBJC_EHTYPE_$_" + ClassName,
7647 CGM.getPointerAlign(),
7648 /*constant*/ false,
7649 L);
Rafael Espindolab7350042018-03-01 00:35:47 +00007650 if (hasObjCExceptionAttribute(CGM.getContext(), ID))
7651 CGM.setGVProperties(Entry, ID);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007652 }
Rafael Espindola554256c2014-02-26 22:25:45 +00007653 assert(Entry->getLinkage() == L);
Daniel Dunbar8f28d012009-04-08 04:21:03 +00007654
Saleem Abdulrasool7093e212016-07-17 22:27:44 +00007655 if (!CGM.getTriple().isOSBinFormatCOFF())
7656 if (ID->getVisibility() == HiddenVisibility)
7657 Entry->setVisibility(llvm::GlobalValue::HiddenVisibility);
Saleem Abdulrasoole5f3eae2016-07-17 22:27:38 +00007658
John McCalldba63a72016-11-30 23:54:50 +00007659 if (IsForDefinition)
Saleem Abdulrasool3c628af2016-10-25 21:43:28 +00007660 if (CGM.getTriple().isOSBinFormatMachO())
7661 Entry->setSection("__DATA,__objc_const");
Daniel Dunbarb1559a42009-03-01 04:46:24 +00007662
7663 return Entry;
7664}
Daniel Dunbar59e476b2009-08-03 17:06:42 +00007665
Daniel Dunbar8b8683f2008-08-12 00:12:39 +00007666/* *** */
7667
Daniel Dunbarb036db82008-08-13 03:21:16 +00007668CodeGen::CGObjCRuntime *
7669CodeGen::CreateMacObjCRuntime(CodeGen::CodeGenModule &CGM) {
John McCall5fb5df92012-06-20 06:18:46 +00007670 switch (CGM.getLangOpts().ObjCRuntime.getKind()) {
7671 case ObjCRuntime::FragileMacOSX:
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007672 return new CGObjCMac(CGM);
John McCall5fb5df92012-06-20 06:18:46 +00007673
7674 case ObjCRuntime::MacOSX:
7675 case ObjCRuntime::iOS:
Tim Northover756447a2015-10-30 16:30:36 +00007676 case ObjCRuntime::WatchOS:
John McCall5fb5df92012-06-20 06:18:46 +00007677 return new CGObjCNonFragileABIMac(CGM);
7678
David Chisnallb601c962012-07-03 20:49:52 +00007679 case ObjCRuntime::GNUstep:
7680 case ObjCRuntime::GCC:
John McCall775086e2012-07-12 02:07:58 +00007681 case ObjCRuntime::ObjFW:
John McCall5fb5df92012-06-20 06:18:46 +00007682 llvm_unreachable("these runtimes are not Mac runtimes");
7683 }
7684 llvm_unreachable("bad runtime");
Daniel Dunbar303e2c22008-08-11 02:45:11 +00007685}